Cost Centerยถ
Cost Center - Getยถ
HTTP Request
GET /api/v1/cost-centers/{id}
๐ Description: Retrieves detailed information about a specific cost center within the financial organization structure, identified by its unique ID, to facilitate effective management and analysis of financial entities.
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 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "name": "string",
21 "blocked": true,
22 "taxJurisdictionId": 0,
23 "taxJurisdictionDisplayId": "string",
24 "controllingAreaId": 0,
25 "controllingAreaDisplayId": "string",
26 "profitCenterId": 0,
27 "profitCenterRelationValidFrom": "2019-08-24",
28 "profitCenterRelationValidTo": "2019-08-24",
29 "companyId": 0,
30 "companyRelationValidFrom": "2019-08-24",
31 "companyRelationValidTo": "2019-08-24"
32 }
33}
Cost Center - Updateยถ
HTTP Request
PUT /api/v1/cost-centers/{id}
๐ Description: Updates the details of a specified cost center within the financial organization structure, allowing for modifications to its hierarchy and attributes to reflect changes in the business entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated details of the cost center, including its name, budget allocation, and associated financial entity information within the organizational hierarchy. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "name": "string",
8 "blocked": true,
9 "taxJurisdictionId": 0,
10 "taxJurisdictionDisplayId": "string",
11 "controllingAreaId": 0,
12 "controllingAreaDisplayId": "string",
13 "profitCenterId": 0,
14 "profitCenterRelationValidFrom": "2019-08-24",
15 "profitCenterRelationValidTo": "2019-08-24",
16 "companyId": 0,
17 "companyRelationValidFrom": "2019-08-24",
18 "companyRelationValidTo": "2019-08-24"
19}
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 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "name": "string",
21 "blocked": true,
22 "taxJurisdictionId": 0,
23 "taxJurisdictionDisplayId": "string",
24 "controllingAreaId": 0,
25 "controllingAreaDisplayId": "string",
26 "profitCenterId": 0,
27 "profitCenterRelationValidFrom": "2019-08-24",
28 "profitCenterRelationValidTo": "2019-08-24",
29 "companyId": 0,
30 "companyRelationValidFrom": "2019-08-24",
31 "companyRelationValidTo": "2019-08-24"
32 }
33}
Cost Center - Deleteยถ
HTTP Request
DELETE /api/v1/cost-centers/{id}
๐ Description: Deletes a specified cost center from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective financial management.
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}
Cost Center - Delete Or Decommissionยถ
HTTP Request
PUT /api/v1/cost-centers/remove/{id}
๐ Description: Removes a specified cost center from the financial organization structure, ensuring the hierarchy reflects the current operational needs of the entity.
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}
Cost Center - Delete Or Decommission Allยถ
HTTP Request
PUT /api/v1/cost-centers/remove/bulk
๐ Description: Removes multiple cost centers from the financial organization structure in a single operation, streamlining the management of the organizationโs hierarchy and ensuring accurate representation of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of cost center identifiers to be removed in bulk from the financial organization structure, ensuring efficient management of the entityโs 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}
Cost Center - Decommissionยถ
HTTP Request
PUT /api/v1/cost-centers/decommission/{id}
๐ Description: Decommissions a specified cost center within the financial organization structure, effectively removing it from the active hierarchy and ensuring it is no longer utilized in financial reporting and analysis.
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 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "name": "string",
21 "blocked": true,
22 "taxJurisdictionId": 0,
23 "taxJurisdictionDisplayId": "string",
24 "controllingAreaId": 0,
25 "controllingAreaDisplayId": "string",
26 "profitCenterId": 0,
27 "profitCenterRelationValidFrom": "2019-08-24",
28 "profitCenterRelationValidTo": "2019-08-24",
29 "companyId": 0,
30 "companyRelationValidFrom": "2019-08-24",
31 "companyRelationValidTo": "2019-08-24"
32 }
33}
Cost Center - Decommission By Modification Date Beforeยถ
HTTP Request
PUT /api/v1/cost-centers/decommission/modified-before/{modified_before}
๐ Description: Decommissions cost centers within the financial organization structure that have been modified before the specified date, ensuring the hierarchy remains streamlined and aligned with current business needs.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
modified_before |
path |
string(date-time) |
true |
Specifies the date and time before which cost centers must have been modified to be eligible for decommissioning within the financial organization structure. |
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 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "name": "string",
22 "blocked": true,
23 "taxJurisdictionId": 0,
24 "taxJurisdictionDisplayId": "string",
25 "controllingAreaId": 0,
26 "controllingAreaDisplayId": "string",
27 "profitCenterId": 0,
28 "profitCenterRelationValidFrom": "2019-08-24",
29 "profitCenterRelationValidTo": "2019-08-24",
30 "companyId": 0,
31 "companyRelationValidFrom": "2019-08-24",
32 "companyRelationValidTo": "2019-08-24"
33 }
34 ]
35}
Cost Center - Decommission Before Nowยถ
HTTP Request
PUT /api/v1/cost-centers/decommission/modified-before-now
๐ Description: Decommissions cost centers that have been modified before the current date, ensuring the financial organization structure remains up-to-date and aligned with business objectives.
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 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "name": "string",
22 "blocked": true,
23 "taxJurisdictionId": 0,
24 "taxJurisdictionDisplayId": "string",
25 "controllingAreaId": 0,
26 "controllingAreaDisplayId": "string",
27 "profitCenterId": 0,
28 "profitCenterRelationValidFrom": "2019-08-24",
29 "profitCenterRelationValidTo": "2019-08-24",
30 "companyId": 0,
31 "companyRelationValidFrom": "2019-08-24",
32 "companyRelationValidTo": "2019-08-24"
33 }
34 ]
35}
Cost Center - Decommission Allยถ
HTTP Request
PUT /api/v1/cost-centers/decommission/bulk
๐ Description: Decommissions multiple cost centers within the financial organization structure, allowing for efficient management of organizational hierarchy and financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of cost center identifiers and associated metadata for bulk decommissioning within the financial organization structure. |
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 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "name": "string",
22 "blocked": true,
23 "taxJurisdictionId": 0,
24 "taxJurisdictionDisplayId": "string",
25 "controllingAreaId": 0,
26 "controllingAreaDisplayId": "string",
27 "profitCenterId": 0,
28 "profitCenterRelationValidFrom": "2019-08-24",
29 "profitCenterRelationValidTo": "2019-08-24",
30 "companyId": 0,
31 "companyRelationValidFrom": "2019-08-24",
32 "companyRelationValidTo": "2019-08-24"
33 }
34 ]
35}
Cost Center - Create Or Update Bulkยถ
HTTP Request
PUT /api/v1/cost-centers/createOrUpdate/bulk
๐ Description: Creates or updates multiple cost centers in the financial organization structure, ensuring alignment with the current hierarchy of the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk data for creating or updating cost centers within the financial organization structure, including relevant identifiers and hierarchical relationships. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "blocked": true,
10 "taxJurisdictionId": 0,
11 "taxJurisdictionDisplayId": "string",
12 "controllingAreaId": 0,
13 "controllingAreaDisplayId": "string",
14 "profitCenterId": 0,
15 "profitCenterRelationValidFrom": "2019-08-24",
16 "profitCenterRelationValidTo": "2019-08-24",
17 "companyId": 0,
18 "companyRelationValidFrom": "2019-08-24",
19 "companyRelationValidTo": "2019-08-24"
20 }
21]
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 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "name": "string",
22 "blocked": true,
23 "taxJurisdictionId": 0,
24 "taxJurisdictionDisplayId": "string",
25 "controllingAreaId": 0,
26 "controllingAreaDisplayId": "string",
27 "profitCenterId": 0,
28 "profitCenterRelationValidFrom": "2019-08-24",
29 "profitCenterRelationValidTo": "2019-08-24",
30 "companyId": 0,
31 "companyRelationValidFrom": "2019-08-24",
32 "companyRelationValidTo": "2019-08-24"
33 }
34 ]
35}
Cost Center - Create Or Updateยถ
HTTP Request
PUT /api/v1/cost-centers/createOrUpdate
๐ Description: Creates or updates cost center information within the financial organization structure, ensuring accurate representation of the hierarchy and organizational entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the cost center details, including identifiers, financial attributes, and hierarchical relationships essential for managing the organizationโs financial structure. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "name": "string",
8 "blocked": true,
9 "taxJurisdictionId": 0,
10 "taxJurisdictionDisplayId": "string",
11 "controllingAreaId": 0,
12 "controllingAreaDisplayId": "string",
13 "profitCenterId": 0,
14 "profitCenterRelationValidFrom": "2019-08-24",
15 "profitCenterRelationValidTo": "2019-08-24",
16 "companyId": 0,
17 "companyRelationValidFrom": "2019-08-24",
18 "companyRelationValidTo": "2019-08-24"
19}
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 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "name": "string",
21 "blocked": true,
22 "taxJurisdictionId": 0,
23 "taxJurisdictionDisplayId": "string",
24 "controllingAreaId": 0,
25 "controllingAreaDisplayId": "string",
26 "profitCenterId": 0,
27 "profitCenterRelationValidFrom": "2019-08-24",
28 "profitCenterRelationValidTo": "2019-08-24",
29 "companyId": 0,
30 "companyRelationValidFrom": "2019-08-24",
31 "companyRelationValidTo": "2019-08-24"
32 }
33}
Cost Center - Bulk Updateยถ
HTTP Request
PUT /api/v1/cost-centers/bulk
๐ Description: Updates multiple cost centers within the financial organization structure, allowing for efficient management of organizational hierarchy and financial entities in bulk.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of cost center data, including identifiers, attributes, and hierarchical relationships, to facilitate bulk updates within the financial organization structure. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "blocked": true,
10 "taxJurisdictionId": 0,
11 "taxJurisdictionDisplayId": "string",
12 "controllingAreaId": 0,
13 "controllingAreaDisplayId": "string",
14 "profitCenterId": 0,
15 "profitCenterRelationValidFrom": "2019-08-24",
16 "profitCenterRelationValidTo": "2019-08-24",
17 "companyId": 0,
18 "companyRelationValidFrom": "2019-08-24",
19 "companyRelationValidTo": "2019-08-24"
20 }
21]
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 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "name": "string",
22 "blocked": true,
23 "taxJurisdictionId": 0,
24 "taxJurisdictionDisplayId": "string",
25 "controllingAreaId": 0,
26 "controllingAreaDisplayId": "string",
27 "profitCenterId": 0,
28 "profitCenterRelationValidFrom": "2019-08-24",
29 "profitCenterRelationValidTo": "2019-08-24",
30 "companyId": 0,
31 "companyRelationValidFrom": "2019-08-24",
32 "companyRelationValidTo": "2019-08-24"
33 }
34 ]
35}
Cost Center - Bulk Createยถ
HTTP Request
POST /api/v1/cost-centers/bulk
๐ Description: Creates multiple cost centers in a single operation, allowing for efficient management of the financial organization structure and hierarchy within the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of cost center definitions, including attributes such as name, code, and hierarchy level, to facilitate the bulk creation of financial entities within the organizational structure. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "blocked": true,
10 "taxJurisdictionId": 0,
11 "taxJurisdictionDisplayId": "string",
12 "controllingAreaId": 0,
13 "controllingAreaDisplayId": "string",
14 "profitCenterId": 0,
15 "profitCenterRelationValidFrom": "2019-08-24",
16 "profitCenterRelationValidTo": "2019-08-24",
17 "companyId": 0,
18 "companyRelationValidFrom": "2019-08-24",
19 "companyRelationValidTo": "2019-08-24"
20 }
21]
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 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "name": "string",
22 "blocked": true,
23 "taxJurisdictionId": 0,
24 "taxJurisdictionDisplayId": "string",
25 "controllingAreaId": 0,
26 "controllingAreaDisplayId": "string",
27 "profitCenterId": 0,
28 "profitCenterRelationValidFrom": "2019-08-24",
29 "profitCenterRelationValidTo": "2019-08-24",
30 "companyId": 0,
31 "companyRelationValidFrom": "2019-08-24",
32 "companyRelationValidTo": "2019-08-24"
33 }
34 ]
35}
Cost Center - Bulk Deleteยถ
HTTP Request
DELETE /api/v1/cost-centers/bulk
๐ Description: Deletes multiple cost centers within the financial organization structure, enabling efficient management of the hierarchy and streamlining the financial entityโs operational framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing a list of cost center identifiers to be deleted, reflecting changes in the financial organization structure and 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}
Cost Center - Searchยถ
HTTP Request
POST /api/v1/cost-centers/search
๐ Description: Submits a search request for cost centers within the financial organization structure, enabling users to identify and retrieve relevant financial entities based on specified criteria.
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 cost centers within the financial organization structure, including parameters for organization hierarchy and entity classification. |
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 "statusEqual": "CREATED",
16 "statusIn": [
17 "CREATED"
18 ],
19 "displayIdIn": [
20 "string"
21 ],
22 "displayIdLike": "string",
23 "erpSystemIdEqual": 0,
24 "erpSystemIdIn": [
25 0
26 ],
27 "erpSystemDisplayIdLike": "string",
28 "uiSelector": "string",
29 "nameLike": "string",
30 "blockedEqual": true,
31 "taxJurisdictionIdEqual": 0,
32 "taxJurisdictionDisplayIdLike": "string",
33 "controllingAreaIdEqual": 0,
34 "controllingAreaDisplayIdLike": "string",
35 "profitCenterIdEqual": 0,
36 "profitCenterRelationValidFromGreaterThanOrEqual": "2019-08-24",
37 "profitCenterRelationValidFromLessThanOrEqual": "2019-08-24",
38 "profitCenterRelationValidFromEqual": "2019-08-24",
39 "profitCenterRelationValidToGreaterThanOrEqual": "2019-08-24",
40 "profitCenterRelationValidToLessThanOrEqual": "2019-08-24",
41 "profitCenterRelationValidToEqual": "2019-08-24",
42 "companyIdEqual": 0,
43 "companyRelationValidFromGreaterThanOrEqual": "2019-08-24",
44 "companyRelationValidFromLessThanOrEqual": "2019-08-24",
45 "companyRelationValidFromEqual": "2019-08-24",
46 "companyRelationValidToGreaterThanOrEqual": "2019-08-24",
47 "companyRelationValidToLessThanOrEqual": "2019-08-24",
48 "companyRelationValidToEqual": "2019-08-24"
49}
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 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "name": "string",
26 "blocked": true,
27 "taxJurisdictionId": 0,
28 "taxJurisdictionDisplayId": "string",
29 "controllingAreaId": 0,
30 "controllingAreaDisplayId": "string",
31 "profitCenterId": 0,
32 "profitCenterRelationValidFrom": "2019-08-24",
33 "profitCenterRelationValidTo": "2019-08-24",
34 "companyId": 0,
35 "companyRelationValidFrom": "2019-08-24",
36 "companyRelationValidTo": "2019-08-24"
37 }
38 ],
39 "number": 0,
40 "sort": {
41 "unsorted": true,
42 "sorted": true,
43 "empty": true
44 },
45 "first": true,
46 "last": true,
47 "empty": true
48}
Cost Center - Detach Tax Jurisdiction From Cost Centersยถ
HTTP Request
POST /api/v1/cost-centers/detach/tax-jurisdiction/{tax_jurisdiction_id}
๐ Description: Detaches a specified tax jurisdiction from a cost center within the financial organization structure, facilitating adjustments to the organizational hierarchy and ensuring accurate financial reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
tax_jurisdiction_id |
path |
integer(int64) |
true |
Unique identifier for the tax jurisdiction being detached from the cost center within the financial organization structure. |
body |
body |
true |
Request body containing the details required to detach a tax jurisdiction from a cost center within the financial organization structure, including relevant identifiers and metadata. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "blocked": true,
10 "taxJurisdictionId": 0,
11 "taxJurisdictionDisplayId": "string",
12 "controllingAreaId": 0,
13 "controllingAreaDisplayId": "string",
14 "profitCenterId": 0,
15 "profitCenterRelationValidFrom": "2019-08-24",
16 "profitCenterRelationValidTo": "2019-08-24",
17 "companyId": 0,
18 "companyRelationValidFrom": "2019-08-24",
19 "companyRelationValidTo": "2019-08-24"
20 }
21]
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}
Cost Center - Detach Profit Center From Cost Centersยถ
HTTP Request
POST /api/v1/cost-centers/detach/profit-center/{profit_center_id}
๐ Description: Detaches a specified profit center from its associated cost centers within the financial organization structure, facilitating updates to the organizational hierarchy. This operation is essential for maintaining accurate financial entity relationships.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
profit_center_id |
path |
integer(int64) |
true |
Unique identifier for the profit center within the financial organization structure, used to detach it from a specified cost center. |
body |
body |
true |
Request body containing the identifiers and details necessary to detach a profit center from its associated cost centers within the financial organization structure. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "blocked": true,
10 "taxJurisdictionId": 0,
11 "taxJurisdictionDisplayId": "string",
12 "controllingAreaId": 0,
13 "controllingAreaDisplayId": "string",
14 "profitCenterId": 0,
15 "profitCenterRelationValidFrom": "2019-08-24",
16 "profitCenterRelationValidTo": "2019-08-24",
17 "companyId": 0,
18 "companyRelationValidFrom": "2019-08-24",
19 "companyRelationValidTo": "2019-08-24"
20 }
21]
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}
Cost Center - Detach Controlling Areaยถ
HTTP Request
POST /api/v1/cost-centers/detach/controlling-area/{controlling_area_id}
๐ Description: Detaches a specified cost center from the designated controlling area, thereby updating the financial organization structure and hierarchy within the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
controlling_area_id |
path |
integer(int64) |
true |
Unique identifier for the controlling area within the financial organization structure, used to detach cost centers from their associated hierarchy. |
body |
body |
true |
Request body containing the details of the cost center to be detached from the specified controlling area, including relevant identifiers and metadata for accurate processing within the financial organization structure. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "blocked": true,
10 "taxJurisdictionId": 0,
11 "taxJurisdictionDisplayId": "string",
12 "controllingAreaId": 0,
13 "controllingAreaDisplayId": "string",
14 "profitCenterId": 0,
15 "profitCenterRelationValidFrom": "2019-08-24",
16 "profitCenterRelationValidTo": "2019-08-24",
17 "companyId": 0,
18 "companyRelationValidFrom": "2019-08-24",
19 "companyRelationValidTo": "2019-08-24"
20 }
21]
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}
Cost Center - Detach Companyยถ
HTTP Request
POST /api/v1/cost-centers/detach/company/{companyId}
๐ Description: Detaches a specified company from its associated cost centers within the financial organization structure, facilitating adjustments to the organizational hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
companyId |
path |
integer(int64) |
true |
Unique identifier for the company |
body |
body |
true |
Request body containing the details necessary to detach a cost center from a specified company, including relevant identifiers and metadata to maintain the integrity of the financial organization structure. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "blocked": true,
10 "taxJurisdictionId": 0,
11 "taxJurisdictionDisplayId": "string",
12 "controllingAreaId": 0,
13 "controllingAreaDisplayId": "string",
14 "profitCenterId": 0,
15 "profitCenterRelationValidFrom": "2019-08-24",
16 "profitCenterRelationValidTo": "2019-08-24",
17 "companyId": 0,
18 "companyRelationValidFrom": "2019-08-24",
19 "companyRelationValidTo": "2019-08-24"
20 }
21]
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}
Cost Center - Attach Tax Jurisdiction To Cost Centersยถ
HTTP Request
POST /api/v1/cost-centers/attach/tax-jurisdiction/{tax_jurisdiction_id}
๐ Description: Attaches a specified tax jurisdiction to a cost center within the financial organization structure, facilitating compliance with local tax regulations and enhancing the hierarchical management of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
tax_jurisdiction_id |
path |
integer(int64) |
true |
Unique identifier for the tax jurisdiction, used to associate a specific tax framework with a cost center within the financial organization structure. |
body |
body |
true |
Request body containing the details necessary to associate a tax jurisdiction with a cost center, including relevant identifiers and organizational hierarchy information. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "blocked": true,
10 "taxJurisdictionId": 0,
11 "taxJurisdictionDisplayId": "string",
12 "controllingAreaId": 0,
13 "controllingAreaDisplayId": "string",
14 "profitCenterId": 0,
15 "profitCenterRelationValidFrom": "2019-08-24",
16 "profitCenterRelationValidTo": "2019-08-24",
17 "companyId": 0,
18 "companyRelationValidFrom": "2019-08-24",
19 "companyRelationValidTo": "2019-08-24"
20 }
21]
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}
Cost Center - Attach Profit Center To Cost Centersยถ
HTTP Request
POST /api/v1/cost-centers/attach/profit-center/{profit_center_id}
๐ Description: Attaches a specified profit center to a cost center within the financial organization structure, facilitating enhanced visibility and alignment of financial entities within the organizational hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
profit_center_id |
path |
integer(int64) |
true |
Unique identifier for the profit center within the financial organization structure, used to associate cost centers during the attachment process. |
body |
body |
true |
Request body containing the cost center details to be associated with the specified profit center, including relevant identifiers and financial attributes. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "blocked": true,
10 "taxJurisdictionId": 0,
11 "taxJurisdictionDisplayId": "string",
12 "controllingAreaId": 0,
13 "controllingAreaDisplayId": "string",
14 "profitCenterId": 0,
15 "profitCenterRelationValidFrom": "2019-08-24",
16 "profitCenterRelationValidTo": "2019-08-24",
17 "companyId": 0,
18 "companyRelationValidFrom": "2019-08-24",
19 "companyRelationValidTo": "2019-08-24"
20 }
21]
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}
Cost Center - Attach Controlling Areaยถ
HTTP Request
POST /api/v1/cost-centers/attach/controlling-area/{controlling_area_id}
๐ Description: Attaches a specified cost center to a controlling area within the financial organization structure, facilitating the alignment of financial entities within the organizational hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
controlling_area_id |
path |
integer(int64) |
true |
Unique identifier for the controlling area within the financial organization structure, used to associate cost centers with the specified financial entity. |
body |
body |
true |
Request body containing the financial entity data necessary to associate a cost center with a specified controlling area within the organizational structure. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "blocked": true,
10 "taxJurisdictionId": 0,
11 "taxJurisdictionDisplayId": "string",
12 "controllingAreaId": 0,
13 "controllingAreaDisplayId": "string",
14 "profitCenterId": 0,
15 "profitCenterRelationValidFrom": "2019-08-24",
16 "profitCenterRelationValidTo": "2019-08-24",
17 "companyId": 0,
18 "companyRelationValidFrom": "2019-08-24",
19 "companyRelationValidTo": "2019-08-24"
20 }
21]
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}
Cost Center - Attach Companyยถ
HTTP Request
POST /api/v1/cost-centers/attach/company/{companyId}
๐ Description: Attaches a specified company to a cost center within the financial organization structure, facilitating the alignment of financial entities within the organizational hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
companyId |
path |
integer(int64) |
true |
Unique identifier for the company |
body |
body |
true |
Request body containing the details of the cost center to be attached to the specified company, including relevant identifiers and hierarchical attributes for effective financial organization structure management. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "name": "string",
9 "blocked": true,
10 "taxJurisdictionId": 0,
11 "taxJurisdictionDisplayId": "string",
12 "controllingAreaId": 0,
13 "controllingAreaDisplayId": "string",
14 "profitCenterId": 0,
15 "profitCenterRelationValidFrom": "2019-08-24",
16 "profitCenterRelationValidTo": "2019-08-24",
17 "companyId": 0,
18 "companyRelationValidFrom": "2019-08-24",
19 "companyRelationValidTo": "2019-08-24"
20 }
21]
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}
Cost Center - Find Allยถ
HTTP Request
GET /api/v1/cost-centers
๐ Description: Retrieves a comprehensive list of cost centers within the financial organization structure, providing insights into the hierarchical arrangement of financial entities.
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 of cost centers. |
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 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "name": "string",
26 "blocked": true,
27 "taxJurisdictionId": 0,
28 "taxJurisdictionDisplayId": "string",
29 "controllingAreaId": 0,
30 "controllingAreaDisplayId": "string",
31 "profitCenterId": 0,
32 "profitCenterRelationValidFrom": "2019-08-24",
33 "profitCenterRelationValidTo": "2019-08-24",
34 "companyId": 0,
35 "companyRelationValidFrom": "2019-08-24",
36 "companyRelationValidTo": "2019-08-24"
37 }
38 ],
39 "number": 0,
40 "sort": {
41 "unsorted": true,
42 "sorted": true,
43 "empty": true
44 },
45 "first": true,
46 "last": true,
47 "empty": true
48}
Cost Center - Createยถ
HTTP Request
POST /api/v1/cost-centers
๐ Description: Creates a new cost center within the financial organization structure, enabling the establishment of a hierarchical framework for effective resource allocation and financial management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of the cost center, including its name, description, and hierarchical relationship within the financial organization structure. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "name": "string",
8 "blocked": true,
9 "taxJurisdictionId": 0,
10 "taxJurisdictionDisplayId": "string",
11 "controllingAreaId": 0,
12 "controllingAreaDisplayId": "string",
13 "profitCenterId": 0,
14 "profitCenterRelationValidFrom": "2019-08-24",
15 "profitCenterRelationValidTo": "2019-08-24",
16 "companyId": 0,
17 "companyRelationValidFrom": "2019-08-24",
18 "companyRelationValidTo": "2019-08-24"
19}
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 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "name": "string",
21 "blocked": true,
22 "taxJurisdictionId": 0,
23 "taxJurisdictionDisplayId": "string",
24 "controllingAreaId": 0,
25 "controllingAreaDisplayId": "string",
26 "profitCenterId": 0,
27 "profitCenterRelationValidFrom": "2019-08-24",
28 "profitCenterRelationValidTo": "2019-08-24",
29 "companyId": 0,
30 "companyRelationValidFrom": "2019-08-24",
31 "companyRelationValidTo": "2019-08-24"
32 }
33}
Cost Center - Get All By Tax Jurisdictionยถ
HTTP Request
GET /api/v1/cost-centers/tax-jurisdiction/{id}
๐ Description: Retrieves detailed information about a specific tax jurisdiction associated with a cost center within the financial organization structure. This operation facilitates the understanding of tax implications for financial entities by providing hierarchical context.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the response should be paginated, facilitating efficient retrieval of tax jurisdiction data within the financial organization structure. |
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 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "name": "string",
26 "blocked": true,
27 "taxJurisdictionId": 0,
28 "taxJurisdictionDisplayId": "string",
29 "controllingAreaId": 0,
30 "controllingAreaDisplayId": "string",
31 "profitCenterId": 0,
32 "profitCenterRelationValidFrom": "2019-08-24",
33 "profitCenterRelationValidTo": "2019-08-24",
34 "companyId": 0,
35 "companyRelationValidFrom": "2019-08-24",
36 "companyRelationValidTo": "2019-08-24"
37 }
38 ],
39 "number": 0,
40 "sort": {
41 "unsorted": true,
42 "sorted": true,
43 "empty": true
44 },
45 "first": true,
46 "last": true,
47 "empty": true
48}
Cost Center - Get All By Profit Centerยถ
HTTP Request
GET /api/v1/cost-centers/profit-center/{id}
๐ Description: Retrieves detailed information about a specific profit center within the financial organization structure, identified by its unique ID, to facilitate effective management of organizational hierarchy and financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure of cost centers and profit centers. |
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 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "name": "string",
26 "blocked": true,
27 "taxJurisdictionId": 0,
28 "taxJurisdictionDisplayId": "string",
29 "controllingAreaId": 0,
30 "controllingAreaDisplayId": "string",
31 "profitCenterId": 0,
32 "profitCenterRelationValidFrom": "2019-08-24",
33 "profitCenterRelationValidTo": "2019-08-24",
34 "companyId": 0,
35 "companyRelationValidFrom": "2019-08-24",
36 "companyRelationValidTo": "2019-08-24"
37 }
38 ],
39 "number": 0,
40 "sort": {
41 "unsorted": true,
42 "sorted": true,
43 "empty": true
44 },
45 "first": true,
46 "last": true,
47 "empty": true
48}
Cost Center - Get Metadataยถ
HTTP Request
GET /api/v1/cost-centers/meta
๐ Description: Retrieves metadata related to cost centers within the financial organization structure, providing insights into the hierarchy and organization of financial entities. This operation supports effective management and analysis of financial resources.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "NAME"
3]
Response Schema
Cost Center - Find All By System IDยถ
HTTP Request
GET /api/v1/cost-centers/erp-system/{systemId}
๐ Description: Retrieves the details of cost centers associated with a specified ERP system, providing insights into the financial organization structure and hierarchy of the entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
systemId |
path |
integer(int64) |
true |
Unique identifier for the system |
pageable |
query |
true |
Indicates whether the response should be paginated, allowing users to efficiently retrieve cost center data within the financial organization structure. |
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 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "name": "string",
26 "blocked": true,
27 "taxJurisdictionId": 0,
28 "taxJurisdictionDisplayId": "string",
29 "controllingAreaId": 0,
30 "controllingAreaDisplayId": "string",
31 "profitCenterId": 0,
32 "profitCenterRelationValidFrom": "2019-08-24",
33 "profitCenterRelationValidTo": "2019-08-24",
34 "companyId": 0,
35 "companyRelationValidFrom": "2019-08-24",
36 "companyRelationValidTo": "2019-08-24"
37 }
38 ],
39 "number": 0,
40 "sort": {
41 "unsorted": true,
42 "sorted": true,
43 "empty": true
44 },
45 "first": true,
46 "last": true,
47 "empty": true
48}
Cost Center - Get All By Controlling Areaยถ
HTTP Request
GET /api/v1/cost-centers/controlling-area/{id}
๐ Description: Retrieves detailed information about a specific cost center within a controlling area, providing insights into the organizationโs financial structure and hierarchy. This operation is essential for understanding the allocation of resources and financial management within the entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure of cost centers within a specified controlling area. |
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 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "name": "string",
26 "blocked": true,
27 "taxJurisdictionId": 0,
28 "taxJurisdictionDisplayId": "string",
29 "controllingAreaId": 0,
30 "controllingAreaDisplayId": "string",
31 "profitCenterId": 0,
32 "profitCenterRelationValidFrom": "2019-08-24",
33 "profitCenterRelationValidTo": "2019-08-24",
34 "companyId": 0,
35 "companyRelationValidFrom": "2019-08-24",
36 "companyRelationValidTo": "2019-08-24"
37 }
38 ],
39 "number": 0,
40 "sort": {
41 "unsorted": true,
42 "sorted": true,
43 "empty": true
44 },
45 "first": true,
46 "last": true,
47 "empty": true
48}