Profile¶
Profile - Get¶
HTTP Request
GET /api/v1/profiles/{id}
📋 Description: Retrieves the profile details of a specific financial entity within the organization structure, identified by the unique profile ID, to facilitate understanding of the entity’s hierarchical position and attributes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "name": "string",
18 "leaseAreaListType": "ALL",
19 "leaseAreaList": [
20 {
21 "id": 0,
22 "status": "CREATED",
23 "displayId": "string",
24 "name": "string",
25 "businessUnitId": 0
26 }
27 ],
28 "businessUnitListType": "ALL",
29 "businessUnitList": [
30 {
31 "id": 0,
32 "status": "CREATED",
33 "displayId": "string",
34 "name": "string",
35 "leaseAreaId": 0,
36 "companyId": 0
37 }
38 ],
39 "companyListType": "ALL",
40 "companyList": [
41 {
42 "id": 0,
43 "status": "CREATED",
44 "displayId": "string",
45 "erpSystemId": 0,
46 "erpSystemDisplayId": "string",
47 "countryId": 0,
48 "countryDisplayId": "string",
49 "postingPeriodVariantId": 0,
50 "name": "string",
51 "postingPeriodVariantDisplayId": "string",
52 "controllingAreaId": 0,
53 "controllingAreaDisplayId": "string",
54 "chartOfAccountId": 0,
55 "chartOfAccountDisplayId": "string",
56 "fiscalVariantId": 0,
57 "fiscalVariantDisplayId": "string",
58 "chartOfDepreciationId": 0,
59 "chartOfDepreciationDisplayId": "string",
60 "purchasingOrganizationId": 0,
61 "assetId": 0,
62 "exchangeRateTypeId": 0,
63 "plantId": 0,
64 "incrementalBorrowingRateId": 0,
65 "businessUnitId": 0,
66 "projectId": 0,
67 "transferVariantId": 0,
68 "partnerId": 0,
69 "departmentId": 0,
70 "accountingStandardId": 0,
71 "generalLedgerAccountId": 0,
72 "consumerPriceIndexCategoryId": 0,
73 "costCenterId": 0,
74 "costCenterRelationValidFrom": "2019-08-24",
75 "costCenterRelationValidTo": "2019-08-24"
76 }
77 ],
78 "rowNumber": 0,
79 "rowIdentifier": "string",
80 "errors": [
81 "string"
82 ],
83 "linkedErrors": [
84 "string"
85 ],
86 "warnings": [
87 "string"
88 ],
89 "remarks": [
90 "string"
91 ],
92 "skipMessage": "string"
93 }
94}
Profile - Update¶
HTTP Request
PUT /api/v1/profiles/{id}
📋 Description: Updates the profile of a specified financial entity within the organizational structure, allowing for modifications to key hierarchical attributes and details.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated profile information for the specified financial entity, including organizational structure and hierarchy details. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "name": "string",
5 "leaseAreaListType": "ALL",
6 "leaseAreaList": [
7 {
8 "id": 0,
9 "status": "CREATED",
10 "displayId": "string",
11 "name": "string",
12 "businessUnitId": 0
13 }
14 ],
15 "businessUnitListType": "ALL",
16 "businessUnitList": [
17 {
18 "id": 0,
19 "status": "CREATED",
20 "displayId": "string",
21 "name": "string",
22 "leaseAreaId": 0,
23 "companyId": 0
24 }
25 ],
26 "companyListType": "ALL",
27 "companyList": [
28 {
29 "id": 0,
30 "status": "CREATED",
31 "displayId": "string",
32 "erpSystemId": 0,
33 "erpSystemDisplayId": "string",
34 "countryId": 0,
35 "countryDisplayId": "string",
36 "postingPeriodVariantId": 0,
37 "name": "string",
38 "postingPeriodVariantDisplayId": "string",
39 "controllingAreaId": 0,
40 "controllingAreaDisplayId": "string",
41 "chartOfAccountId": 0,
42 "chartOfAccountDisplayId": "string",
43 "fiscalVariantId": 0,
44 "fiscalVariantDisplayId": "string",
45 "chartOfDepreciationId": 0,
46 "chartOfDepreciationDisplayId": "string",
47 "purchasingOrganizationId": 0,
48 "assetId": 0,
49 "exchangeRateTypeId": 0,
50 "plantId": 0,
51 "incrementalBorrowingRateId": 0,
52 "businessUnitId": 0,
53 "projectId": 0,
54 "transferVariantId": 0,
55 "partnerId": 0,
56 "departmentId": 0,
57 "accountingStandardId": 0,
58 "generalLedgerAccountId": 0,
59 "consumerPriceIndexCategoryId": 0,
60 "costCenterId": 0,
61 "costCenterRelationValidFrom": "2019-08-24",
62 "costCenterRelationValidTo": "2019-08-24"
63 }
64 ],
65 "rowNumber": 0,
66 "rowIdentifier": "string",
67 "errors": [
68 "string"
69 ],
70 "linkedErrors": [
71 "string"
72 ],
73 "warnings": [
74 "string"
75 ],
76 "remarks": [
77 "string"
78 ],
79 "skipMessage": "string"
80}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "name": "string",
18 "leaseAreaListType": "ALL",
19 "leaseAreaList": [
20 {
21 "id": 0,
22 "status": "CREATED",
23 "displayId": "string",
24 "name": "string",
25 "businessUnitId": 0
26 }
27 ],
28 "businessUnitListType": "ALL",
29 "businessUnitList": [
30 {
31 "id": 0,
32 "status": "CREATED",
33 "displayId": "string",
34 "name": "string",
35 "leaseAreaId": 0,
36 "companyId": 0
37 }
38 ],
39 "companyListType": "ALL",
40 "companyList": [
41 {
42 "id": 0,
43 "status": "CREATED",
44 "displayId": "string",
45 "erpSystemId": 0,
46 "erpSystemDisplayId": "string",
47 "countryId": 0,
48 "countryDisplayId": "string",
49 "postingPeriodVariantId": 0,
50 "name": "string",
51 "postingPeriodVariantDisplayId": "string",
52 "controllingAreaId": 0,
53 "controllingAreaDisplayId": "string",
54 "chartOfAccountId": 0,
55 "chartOfAccountDisplayId": "string",
56 "fiscalVariantId": 0,
57 "fiscalVariantDisplayId": "string",
58 "chartOfDepreciationId": 0,
59 "chartOfDepreciationDisplayId": "string",
60 "purchasingOrganizationId": 0,
61 "assetId": 0,
62 "exchangeRateTypeId": 0,
63 "plantId": 0,
64 "incrementalBorrowingRateId": 0,
65 "businessUnitId": 0,
66 "projectId": 0,
67 "transferVariantId": 0,
68 "partnerId": 0,
69 "departmentId": 0,
70 "accountingStandardId": 0,
71 "generalLedgerAccountId": 0,
72 "consumerPriceIndexCategoryId": 0,
73 "costCenterId": 0,
74 "costCenterRelationValidFrom": "2019-08-24",
75 "costCenterRelationValidTo": "2019-08-24"
76 }
77 ],
78 "rowNumber": 0,
79 "rowIdentifier": "string",
80 "errors": [
81 "string"
82 ],
83 "linkedErrors": [
84 "string"
85 ],
86 "warnings": [
87 "string"
88 ],
89 "remarks": [
90 "string"
91 ],
92 "skipMessage": "string"
93 }
94}
Profile - Delete¶
HTTP Request
DELETE /api/v1/profiles/{id}
📋 Description: Deletes a specified financial entity profile from the organizational structure, ensuring the hierarchy remains accurate and up-to-date.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Profile - Create Or Update Bulk¶
HTTP Request
PUT /api/v1/profiles/createOrUpdate/bulk
📋 Description: Updates or creates multiple financial organization profiles in bulk, enabling efficient management of organizational structure and hierarchy within financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk data for creating or updating financial organization profiles, including hierarchical structure and entity details. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "name": "string",
6 "leaseAreaListType": "ALL",
7 "leaseAreaList": [
8 {
9 "id": 0,
10 "status": "CREATED",
11 "displayId": "string",
12 "name": "string",
13 "businessUnitId": 0
14 }
15 ],
16 "businessUnitListType": "ALL",
17 "businessUnitList": [
18 {
19 "id": 0,
20 "status": "CREATED",
21 "displayId": "string",
22 "name": "string",
23 "leaseAreaId": 0,
24 "companyId": 0
25 }
26 ],
27 "companyListType": "ALL",
28 "companyList": [
29 {
30 "id": 0,
31 "status": "CREATED",
32 "displayId": "string",
33 "erpSystemId": 0,
34 "erpSystemDisplayId": "string",
35 "countryId": 0,
36 "countryDisplayId": "string",
37 "postingPeriodVariantId": 0,
38 "name": "string",
39 "postingPeriodVariantDisplayId": "string",
40 "controllingAreaId": 0,
41 "controllingAreaDisplayId": "string",
42 "chartOfAccountId": 0,
43 "chartOfAccountDisplayId": "string",
44 "fiscalVariantId": 0,
45 "fiscalVariantDisplayId": "string",
46 "chartOfDepreciationId": 0,
47 "chartOfDepreciationDisplayId": "string",
48 "purchasingOrganizationId": 0,
49 "assetId": 0,
50 "exchangeRateTypeId": 0,
51 "plantId": 0,
52 "incrementalBorrowingRateId": 0,
53 "businessUnitId": 0,
54 "projectId": 0,
55 "transferVariantId": 0,
56 "partnerId": 0,
57 "departmentId": 0,
58 "accountingStandardId": 0,
59 "generalLedgerAccountId": 0,
60 "consumerPriceIndexCategoryId": 0,
61 "costCenterId": 0,
62 "costCenterRelationValidFrom": "2019-08-24",
63 "costCenterRelationValidTo": "2019-08-24"
64 }
65 ],
66 "rowNumber": 0,
67 "rowIdentifier": "string",
68 "errors": [
69 "string"
70 ],
71 "linkedErrors": [
72 "string"
73 ],
74 "warnings": [
75 "string"
76 ],
77 "remarks": [
78 "string"
79 ],
80 "skipMessage": "string"
81 }
82]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "displayId": "string",
18 "name": "string",
19 "leaseAreaListType": "ALL",
20 "leaseAreaList": [
21 {
22 "id": 0,
23 "status": "CREATED",
24 "displayId": "string",
25 "name": "string",
26 "businessUnitId": 0
27 }
28 ],
29 "businessUnitListType": "ALL",
30 "businessUnitList": [
31 {
32 "id": 0,
33 "status": "CREATED",
34 "displayId": "string",
35 "name": "string",
36 "leaseAreaId": 0,
37 "companyId": 0
38 }
39 ],
40 "companyListType": "ALL",
41 "companyList": [
42 {
43 "id": 0,
44 "status": "CREATED",
45 "displayId": "string",
46 "erpSystemId": 0,
47 "erpSystemDisplayId": "string",
48 "countryId": 0,
49 "countryDisplayId": "string",
50 "postingPeriodVariantId": 0,
51 "name": "string",
52 "postingPeriodVariantDisplayId": "string",
53 "controllingAreaId": 0,
54 "controllingAreaDisplayId": "string",
55 "chartOfAccountId": 0,
56 "chartOfAccountDisplayId": "string",
57 "fiscalVariantId": 0,
58 "fiscalVariantDisplayId": "string",
59 "chartOfDepreciationId": 0,
60 "chartOfDepreciationDisplayId": "string",
61 "purchasingOrganizationId": 0,
62 "assetId": 0,
63 "exchangeRateTypeId": 0,
64 "plantId": 0,
65 "incrementalBorrowingRateId": 0,
66 "businessUnitId": 0,
67 "projectId": 0,
68 "transferVariantId": 0,
69 "partnerId": 0,
70 "departmentId": 0,
71 "accountingStandardId": 0,
72 "generalLedgerAccountId": 0,
73 "consumerPriceIndexCategoryId": 0,
74 "costCenterId": 0,
75 "costCenterRelationValidFrom": "2019-08-24",
76 "costCenterRelationValidTo": "2019-08-24"
77 }
78 ],
79 "rowNumber": 0,
80 "rowIdentifier": "string",
81 "errors": [
82 "string"
83 ],
84 "linkedErrors": [
85 "string"
86 ],
87 "warnings": [
88 "string"
89 ],
90 "remarks": [
91 "string"
92 ],
93 "skipMessage": "string"
94 }
95 ]
96}
Profile - Create Or Update¶
HTTP Request
PUT /api/v1/profiles/createOrUpdate
📋 Description: Updates or creates a financial entity profile within the organization’s structure, ensuring that the hierarchy reflects the most current information. This operation allows for efficient management of organizational data related to financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial entity profile data, including organization structure and hierarchy details for creation or update purposes. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "name": "string",
5 "leaseAreaListType": "ALL",
6 "leaseAreaList": [
7 {
8 "id": 0,
9 "status": "CREATED",
10 "displayId": "string",
11 "name": "string",
12 "businessUnitId": 0
13 }
14 ],
15 "businessUnitListType": "ALL",
16 "businessUnitList": [
17 {
18 "id": 0,
19 "status": "CREATED",
20 "displayId": "string",
21 "name": "string",
22 "leaseAreaId": 0,
23 "companyId": 0
24 }
25 ],
26 "companyListType": "ALL",
27 "companyList": [
28 {
29 "id": 0,
30 "status": "CREATED",
31 "displayId": "string",
32 "erpSystemId": 0,
33 "erpSystemDisplayId": "string",
34 "countryId": 0,
35 "countryDisplayId": "string",
36 "postingPeriodVariantId": 0,
37 "name": "string",
38 "postingPeriodVariantDisplayId": "string",
39 "controllingAreaId": 0,
40 "controllingAreaDisplayId": "string",
41 "chartOfAccountId": 0,
42 "chartOfAccountDisplayId": "string",
43 "fiscalVariantId": 0,
44 "fiscalVariantDisplayId": "string",
45 "chartOfDepreciationId": 0,
46 "chartOfDepreciationDisplayId": "string",
47 "purchasingOrganizationId": 0,
48 "assetId": 0,
49 "exchangeRateTypeId": 0,
50 "plantId": 0,
51 "incrementalBorrowingRateId": 0,
52 "businessUnitId": 0,
53 "projectId": 0,
54 "transferVariantId": 0,
55 "partnerId": 0,
56 "departmentId": 0,
57 "accountingStandardId": 0,
58 "generalLedgerAccountId": 0,
59 "consumerPriceIndexCategoryId": 0,
60 "costCenterId": 0,
61 "costCenterRelationValidFrom": "2019-08-24",
62 "costCenterRelationValidTo": "2019-08-24"
63 }
64 ],
65 "rowNumber": 0,
66 "rowIdentifier": "string",
67 "errors": [
68 "string"
69 ],
70 "linkedErrors": [
71 "string"
72 ],
73 "warnings": [
74 "string"
75 ],
76 "remarks": [
77 "string"
78 ],
79 "skipMessage": "string"
80}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "name": "string",
18 "leaseAreaListType": "ALL",
19 "leaseAreaList": [
20 {
21 "id": 0,
22 "status": "CREATED",
23 "displayId": "string",
24 "name": "string",
25 "businessUnitId": 0
26 }
27 ],
28 "businessUnitListType": "ALL",
29 "businessUnitList": [
30 {
31 "id": 0,
32 "status": "CREATED",
33 "displayId": "string",
34 "name": "string",
35 "leaseAreaId": 0,
36 "companyId": 0
37 }
38 ],
39 "companyListType": "ALL",
40 "companyList": [
41 {
42 "id": 0,
43 "status": "CREATED",
44 "displayId": "string",
45 "erpSystemId": 0,
46 "erpSystemDisplayId": "string",
47 "countryId": 0,
48 "countryDisplayId": "string",
49 "postingPeriodVariantId": 0,
50 "name": "string",
51 "postingPeriodVariantDisplayId": "string",
52 "controllingAreaId": 0,
53 "controllingAreaDisplayId": "string",
54 "chartOfAccountId": 0,
55 "chartOfAccountDisplayId": "string",
56 "fiscalVariantId": 0,
57 "fiscalVariantDisplayId": "string",
58 "chartOfDepreciationId": 0,
59 "chartOfDepreciationDisplayId": "string",
60 "purchasingOrganizationId": 0,
61 "assetId": 0,
62 "exchangeRateTypeId": 0,
63 "plantId": 0,
64 "incrementalBorrowingRateId": 0,
65 "businessUnitId": 0,
66 "projectId": 0,
67 "transferVariantId": 0,
68 "partnerId": 0,
69 "departmentId": 0,
70 "accountingStandardId": 0,
71 "generalLedgerAccountId": 0,
72 "consumerPriceIndexCategoryId": 0,
73 "costCenterId": 0,
74 "costCenterRelationValidFrom": "2019-08-24",
75 "costCenterRelationValidTo": "2019-08-24"
76 }
77 ],
78 "rowNumber": 0,
79 "rowIdentifier": "string",
80 "errors": [
81 "string"
82 ],
83 "linkedErrors": [
84 "string"
85 ],
86 "warnings": [
87 "string"
88 ],
89 "remarks": [
90 "string"
91 ],
92 "skipMessage": "string"
93 }
94}
Profile - Bulk Update¶
HTTP Request
PUT /api/v1/profiles/bulk
📋 Description: Updates multiple financial organization profiles in bulk, allowing for efficient management of the organization’s structure and hierarchy within a financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of profile updates for financial entities, including organizational structure and hierarchy details. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "name": "string",
6 "leaseAreaListType": "ALL",
7 "leaseAreaList": [
8 {
9 "id": 0,
10 "status": "CREATED",
11 "displayId": "string",
12 "name": "string",
13 "businessUnitId": 0
14 }
15 ],
16 "businessUnitListType": "ALL",
17 "businessUnitList": [
18 {
19 "id": 0,
20 "status": "CREATED",
21 "displayId": "string",
22 "name": "string",
23 "leaseAreaId": 0,
24 "companyId": 0
25 }
26 ],
27 "companyListType": "ALL",
28 "companyList": [
29 {
30 "id": 0,
31 "status": "CREATED",
32 "displayId": "string",
33 "erpSystemId": 0,
34 "erpSystemDisplayId": "string",
35 "countryId": 0,
36 "countryDisplayId": "string",
37 "postingPeriodVariantId": 0,
38 "name": "string",
39 "postingPeriodVariantDisplayId": "string",
40 "controllingAreaId": 0,
41 "controllingAreaDisplayId": "string",
42 "chartOfAccountId": 0,
43 "chartOfAccountDisplayId": "string",
44 "fiscalVariantId": 0,
45 "fiscalVariantDisplayId": "string",
46 "chartOfDepreciationId": 0,
47 "chartOfDepreciationDisplayId": "string",
48 "purchasingOrganizationId": 0,
49 "assetId": 0,
50 "exchangeRateTypeId": 0,
51 "plantId": 0,
52 "incrementalBorrowingRateId": 0,
53 "businessUnitId": 0,
54 "projectId": 0,
55 "transferVariantId": 0,
56 "partnerId": 0,
57 "departmentId": 0,
58 "accountingStandardId": 0,
59 "generalLedgerAccountId": 0,
60 "consumerPriceIndexCategoryId": 0,
61 "costCenterId": 0,
62 "costCenterRelationValidFrom": "2019-08-24",
63 "costCenterRelationValidTo": "2019-08-24"
64 }
65 ],
66 "rowNumber": 0,
67 "rowIdentifier": "string",
68 "errors": [
69 "string"
70 ],
71 "linkedErrors": [
72 "string"
73 ],
74 "warnings": [
75 "string"
76 ],
77 "remarks": [
78 "string"
79 ],
80 "skipMessage": "string"
81 }
82]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "displayId": "string",
18 "name": "string",
19 "leaseAreaListType": "ALL",
20 "leaseAreaList": [
21 {
22 "id": 0,
23 "status": "CREATED",
24 "displayId": "string",
25 "name": "string",
26 "businessUnitId": 0
27 }
28 ],
29 "businessUnitListType": "ALL",
30 "businessUnitList": [
31 {
32 "id": 0,
33 "status": "CREATED",
34 "displayId": "string",
35 "name": "string",
36 "leaseAreaId": 0,
37 "companyId": 0
38 }
39 ],
40 "companyListType": "ALL",
41 "companyList": [
42 {
43 "id": 0,
44 "status": "CREATED",
45 "displayId": "string",
46 "erpSystemId": 0,
47 "erpSystemDisplayId": "string",
48 "countryId": 0,
49 "countryDisplayId": "string",
50 "postingPeriodVariantId": 0,
51 "name": "string",
52 "postingPeriodVariantDisplayId": "string",
53 "controllingAreaId": 0,
54 "controllingAreaDisplayId": "string",
55 "chartOfAccountId": 0,
56 "chartOfAccountDisplayId": "string",
57 "fiscalVariantId": 0,
58 "fiscalVariantDisplayId": "string",
59 "chartOfDepreciationId": 0,
60 "chartOfDepreciationDisplayId": "string",
61 "purchasingOrganizationId": 0,
62 "assetId": 0,
63 "exchangeRateTypeId": 0,
64 "plantId": 0,
65 "incrementalBorrowingRateId": 0,
66 "businessUnitId": 0,
67 "projectId": 0,
68 "transferVariantId": 0,
69 "partnerId": 0,
70 "departmentId": 0,
71 "accountingStandardId": 0,
72 "generalLedgerAccountId": 0,
73 "consumerPriceIndexCategoryId": 0,
74 "costCenterId": 0,
75 "costCenterRelationValidFrom": "2019-08-24",
76 "costCenterRelationValidTo": "2019-08-24"
77 }
78 ],
79 "rowNumber": 0,
80 "rowIdentifier": "string",
81 "errors": [
82 "string"
83 ],
84 "linkedErrors": [
85 "string"
86 ],
87 "warnings": [
88 "string"
89 ],
90 "remarks": [
91 "string"
92 ],
93 "skipMessage": "string"
94 }
95 ]
96}
Profile - Bulk Delete¶
HTTP Request
DELETE /api/v1/profiles/bulk
📋 Description: Deletes multiple profiles within the financial organization structure, allowing for efficient management of organizational hierarchy and entity relationships.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of profile identifiers for the bulk deletion of financial entity structures within the organization hierarchy. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Profile - Search¶
HTTP Request
POST /api/v1/profiles/search
📋 Description: Submits a search request to retrieve profiles of financial entities within the organization structure, enabling users to identify and analyze hierarchical relationships effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing search criteria for financial organization profiles, including parameters to define the structure and hierarchy of financial entities. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "nameOrDisplayIdLike": "string",
16 "displayIdIn": [
17 "string"
18 ],
19 "displayIdLike": "string",
20 "nameLike": "string",
21 "leaseAreaIdEqual": 0,
22 "businessUnitIdEqual": 0,
23 "companyIdEqual": 0
24}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "displayId": "string",
22 "name": "string",
23 "leaseAreaListType": "ALL",
24 "leaseAreaList": [
25 {
26 "id": 0,
27 "status": "CREATED",
28 "displayId": "string",
29 "name": "string",
30 "businessUnitId": 0
31 }
32 ],
33 "businessUnitListType": "ALL",
34 "businessUnitList": [
35 {
36 "id": 0,
37 "status": "CREATED",
38 "displayId": "string",
39 "name": "string",
40 "leaseAreaId": 0,
41 "companyId": 0
42 }
43 ],
44 "companyListType": "ALL",
45 "companyList": [
46 {
47 "id": 0,
48 "status": "CREATED",
49 "displayId": "string",
50 "erpSystemId": 0,
51 "erpSystemDisplayId": "string",
52 "countryId": 0,
53 "countryDisplayId": "string",
54 "postingPeriodVariantId": 0,
55 "name": "string",
56 "postingPeriodVariantDisplayId": "string",
57 "controllingAreaId": 0,
58 "controllingAreaDisplayId": "string",
59 "chartOfAccountId": 0,
60 "chartOfAccountDisplayId": "string",
61 "fiscalVariantId": 0,
62 "fiscalVariantDisplayId": "string",
63 "chartOfDepreciationId": 0,
64 "chartOfDepreciationDisplayId": "string",
65 "purchasingOrganizationId": 0,
66 "assetId": 0,
67 "exchangeRateTypeId": 0,
68 "plantId": 0,
69 "incrementalBorrowingRateId": 0,
70 "businessUnitId": 0,
71 "projectId": 0,
72 "transferVariantId": 0,
73 "partnerId": 0,
74 "departmentId": 0,
75 "accountingStandardId": 0,
76 "generalLedgerAccountId": 0,
77 "consumerPriceIndexCategoryId": 0,
78 "costCenterId": 0,
79 "costCenterRelationValidFrom": "2019-08-24",
80 "costCenterRelationValidTo": "2019-08-24"
81 }
82 ],
83 "rowNumber": 0,
84 "rowIdentifier": "string",
85 "errors": [
86 "string"
87 ],
88 "linkedErrors": [
89 "string"
90 ],
91 "warnings": [
92 "string"
93 ],
94 "remarks": [
95 "string"
96 ],
97 "skipMessage": "string"
98 }
99 ],
100 "number": 0,
101 "sort": {
102 "unsorted": true,
103 "sorted": true,
104 "empty": true
105 },
106 "first": true,
107 "last": true,
108 "empty": true
109}
Profile - Find All¶
HTTP Request
GET /api/v1/profiles
📋 Description: Retrieves the organizational profiles of financial entities, providing insights into their structure and hierarchy within the financial organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the response should be paginated, allowing users to efficiently navigate through the financial organization structure profiles. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "displayId": "string",
22 "name": "string",
23 "leaseAreaListType": "ALL",
24 "leaseAreaList": [
25 {
26 "id": 0,
27 "status": "CREATED",
28 "displayId": "string",
29 "name": "string",
30 "businessUnitId": 0
31 }
32 ],
33 "businessUnitListType": "ALL",
34 "businessUnitList": [
35 {
36 "id": 0,
37 "status": "CREATED",
38 "displayId": "string",
39 "name": "string",
40 "leaseAreaId": 0,
41 "companyId": 0
42 }
43 ],
44 "companyListType": "ALL",
45 "companyList": [
46 {
47 "id": 0,
48 "status": "CREATED",
49 "displayId": "string",
50 "erpSystemId": 0,
51 "erpSystemDisplayId": "string",
52 "countryId": 0,
53 "countryDisplayId": "string",
54 "postingPeriodVariantId": 0,
55 "name": "string",
56 "postingPeriodVariantDisplayId": "string",
57 "controllingAreaId": 0,
58 "controllingAreaDisplayId": "string",
59 "chartOfAccountId": 0,
60 "chartOfAccountDisplayId": "string",
61 "fiscalVariantId": 0,
62 "fiscalVariantDisplayId": "string",
63 "chartOfDepreciationId": 0,
64 "chartOfDepreciationDisplayId": "string",
65 "purchasingOrganizationId": 0,
66 "assetId": 0,
67 "exchangeRateTypeId": 0,
68 "plantId": 0,
69 "incrementalBorrowingRateId": 0,
70 "businessUnitId": 0,
71 "projectId": 0,
72 "transferVariantId": 0,
73 "partnerId": 0,
74 "departmentId": 0,
75 "accountingStandardId": 0,
76 "generalLedgerAccountId": 0,
77 "consumerPriceIndexCategoryId": 0,
78 "costCenterId": 0,
79 "costCenterRelationValidFrom": "2019-08-24",
80 "costCenterRelationValidTo": "2019-08-24"
81 }
82 ],
83 "rowNumber": 0,
84 "rowIdentifier": "string",
85 "errors": [
86 "string"
87 ],
88 "linkedErrors": [
89 "string"
90 ],
91 "warnings": [
92 "string"
93 ],
94 "remarks": [
95 "string"
96 ],
97 "skipMessage": "string"
98 }
99 ],
100 "number": 0,
101 "sort": {
102 "unsorted": true,
103 "sorted": true,
104 "empty": true
105 },
106 "first": true,
107 "last": true,
108 "empty": true
109}