Profit Center

Profit Center - Get

HTTP Request

GET /api/v1/profit-centers/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific profit center within the financial organization structure, identified by its unique ID, to support organizational hierarchy and financial entity management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseProfitCenterDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "validTo": "2019-08-24",
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Update

HTTP Request

PUT /api/v1/profit-centers/{id}

Interactive Demo

📋 Description: Updates the details of a specified profit center within the financial organization structure, allowing for modifications to its hierarchy and attributes as needed for effective financial management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ProfitCenterDto	true	Request body containing the updated financial entity details for the specified profit center, including organizational structure and hierarchy information.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "validTo": "2019-08-24",
  "costCenterId": 0,
  "costCenterRelationValidFrom": "2019-08-24",
  "costCenterRelationValidTo": "2019-08-24",
  "controllingAreaId": 0,
  "controllingAreaDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseProfitCenterDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "validTo": "2019-08-24",
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Delete

HTTP Request

DELETE /api/v1/profit-centers/{id}

Interactive Demo

📋 Description: Deletes a specified profit center from the financial organization structure, thereby removing it from the hierarchy 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	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Delete Or Decommission

HTTP Request

PUT /api/v1/profit-centers/remove/{id}

Interactive Demo

📋 Description: Removes a specified profit center from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date within the entity’s organizational framework.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Delete Or Decommission All

HTTP Request

PUT /api/v1/profit-centers/remove/bulk

Interactive Demo

📋 Description: Removes multiple profit centers from the financial organization structure, allowing for streamlined management of the organizational hierarchy and ensuring accurate representation of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of profit center identifiers to be removed in bulk from the financial organization structure, ensuring alignment with the overall hierarchy of the financial entity.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Decommission

HTTP Request

PUT /api/v1/profit-centers/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified profit center within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that organizational changes are accurately reflected in the system.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseProfitCenterDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "validTo": "2019-08-24",
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/profit-centers/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions profit centers within the financial organization structure that were modified before the specified date, ensuring the hierarchy remains streamlined and aligned with current business objectives.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning profit centers that were modified before the given date, ensuring alignment with the organization’s financial hierarchy and structural integrity.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListProfitCenterDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "validTo": "2019-08-24",
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Decommission Before Now

HTTP Request

PUT /api/v1/profit-centers/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions profit centers that have been modified before the current date, enabling organizations to maintain an accurate financial structure and hierarchy within their operational framework.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListProfitCenterDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "validTo": "2019-08-24",
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Decommission All

HTTP Request

PUT /api/v1/profit-centers/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple profit centers within the financial organization structure, allowing for efficient management of organizational hierarchy and alignment with strategic business objectives.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of profit center identifiers and their associated decommissioning details for bulk processing within the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListProfitCenterDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "validTo": "2019-08-24",
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Create Or Update Bulk

HTTP Request

PUT /api/v1/profit-centers/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple profit centers within the financial organization structure, enabling efficient management of the organization’s hierarchy and financial entities in bulk.

Parameters

Name	In	Type	Required	Description
body	body	ProfitCenterDto	true	Request body containing a bulk array of profit center data, including attributes necessary for creating or updating financial entities within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "validTo": "2019-08-24",
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListProfitCenterDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "validTo": "2019-08-24",
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Create Or Update

HTTP Request

PUT /api/v1/profit-centers/createOrUpdate

Interactive Demo

📋 Description: Creates or updates profit center details within the financial organization structure, ensuring accurate representation of the entity’s hierarchy and organizational framework.

Parameters

Name	In	Type	Required	Description
body	body	ProfitCenterDto	true	Request body containing the financial entity details necessary for creating or updating profit centers within the organizational structure and hierarchy.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "validTo": "2019-08-24",
  "costCenterId": 0,
  "costCenterRelationValidFrom": "2019-08-24",
  "costCenterRelationValidTo": "2019-08-24",
  "controllingAreaId": 0,
  "controllingAreaDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseProfitCenterDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "validTo": "2019-08-24",
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Bulk Update

HTTP Request

PUT /api/v1/profit-centers/bulk

Interactive Demo

📋 Description: Updates multiple profit 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	ProfitCenterDto	true	Request body containing an array of profit center data, including identifiers and hierarchical relationships, to facilitate bulk updates within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "validTo": "2019-08-24",
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListProfitCenterDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "validTo": "2019-08-24",
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Bulk Create

HTTP Request

POST /api/v1/profit-centers/bulk

Interactive Demo

📋 Description: Creates multiple profit centers in a single operation, enabling efficient management of financial entities within the organizational structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	ProfitCenterDto	true	Request body containing a bulk array of profit center definitions, including hierarchical relationships and organizational attributes essential for structuring financial entities.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "validTo": "2019-08-24",
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListProfitCenterDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "validTo": "2019-08-24",
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Bulk Delete

HTTP Request

DELETE /api/v1/profit-centers/bulk

Interactive Demo

📋 Description: Deletes multiple profit centers from the financial organization structure, enabling efficient management of the hierarchy within the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of identifiers for profit centers to be deleted from the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Search

HTTP Request

POST /api/v1/profit-centers/search

Interactive Demo

📋 Description: Submits a request to search for profit centers within the financial organization structure, allowing users to identify and analyze hierarchical relationships among financial entities.

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	ProfitCenterDtoFilter	false	Request body containing search criteria and filters for identifying specific profit centers within the financial organization structure.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "erpSystemIdEqual": 0,
  "erpSystemIdIn": [
    0
  ],
  "erpSystemDisplayIdLike": "string",
  "uiSelector": "string",
  "nameLike": "string",
  "validToGreaterThanOrEqual": "2019-08-24",
  "validToLessThanOrEqual": "2019-08-24",
  "validToEqual": "2019-08-24",
  "costCenterIdEqual": 0,
  "costCenterRelationValidFromEqual": "2019-08-24",
  "costCenterRelationValidFromGreaterThanOrEqual": "2019-08-24",
  "costCenterRelationValidFromLessThanOrEqual": "2019-08-24",
  "costCenterRelationValidToEqual": "2019-08-24",
  "costCenterRelationValidToGreaterThanOrEqual": "2019-08-24",
  "costCenterRelationValidToLessThanOrEqual": "2019-08-24",
  "controllingAreaIdEqual": 0,
  "controllingAreaDisplayIdLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageProfitCenterDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "validTo": "2019-08-24",
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Detach Cost Center

HTTP Request

POST /api/v1/profit-centers/detach/cost-center/{cost_center_id}

Interactive Demo

📋 Description: Detaches a specified cost center from its associated profit centers within the financial organization structure, facilitating adjustments to the organizational hierarchy and enhancing financial entity management.

Parameters

Name	In	Type	Required	Description
cost_center_id	path	integer(int64)	true	Unique identifier for the cost center being detached from the profit center within the financial organization structure.
body	body	ProfitCenterDto	true	Request body containing the cost center details to be detached from the specified profit center, ensuring alignment within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "validTo": "2019-08-24",
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Detach Controlling Area

HTTP Request

POST /api/v1/profit-centers/detach/controlling-area/{controlling_area_id}

Interactive Demo

📋 Description: Detaches a specified profit center from the designated controlling area, thereby updating the financial organization structure and hierarchy within the enterprise. This operation is essential for maintaining accurate financial entity relationships and ensuring effective organizational management.

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 profit centers from their associated hierarchy.
body	body	ProfitCenterDto	true	Request body containing the financial entity details necessary to detach a profit center from the specified controlling area, including relevant identifiers and hierarchical information.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "validTo": "2019-08-24",
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Attach Cost Center

HTTP Request

POST /api/v1/profit-centers/attach/cost-center/{cost_center_id}

Interactive Demo

📋 Description: Attaches a specified cost center to a profit center within the financial organization structure, facilitating enhanced visibility and management of financial entities and their hierarchical relationships.

Parameters

Name	In	Type	Required	Description
cost_center_id	path	integer(int64)	true	Unique identifier for the cost center within the financial organization structure, used to associate it with a profit center during the attachment process.
body	body	ProfitCenterDto	true	Request body containing the financial entity details required to associate a cost center with a specified profit center within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "validTo": "2019-08-24",
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Attach Controlling Area

HTTP Request

POST /api/v1/profit-centers/attach/controlling-area/{controlling_area_id}

Interactive Demo

📋 Description: Attaches a specified profit center to a controlling area within the financial organization structure, facilitating the alignment of financial entities within the hierarchical framework.

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 profit centers with their respective hierarchical entities.
body	body	ProfitCenterDto	true	Request body containing the financial entity details necessary to attach a profit center to a specified controlling area within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "validTo": "2019-08-24",
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Find All

HTTP Request

GET /api/v1/profit-centers

Interactive Demo

📋 Description: Retrieves a list of profit centers within the financial organization structure, providing insights into the hierarchy and organization of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the profit centers query should be returned in a paginated format, facilitating efficient navigation through the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageProfitCenterDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "validTo": "2019-08-24",
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Create

HTTP Request

POST /api/v1/profit-centers

Interactive Demo

📋 Description: Creates a new profit center within the financial organization structure, enabling the establishment of a hierarchical framework for managing financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ProfitCenterDto	true	Request body containing the financial entity details required to establish a new profit center within the organizational structure and hierarchy.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "validTo": "2019-08-24",
  "costCenterId": 0,
  "costCenterRelationValidFrom": "2019-08-24",
  "costCenterRelationValidTo": "2019-08-24",
  "controllingAreaId": 0,
  "controllingAreaDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseProfitCenterDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "validTo": "2019-08-24",
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Get Metadata

HTTP Request

GET /api/v1/profit-centers/meta

Interactive Demo

📋 Description: Retrieves metadata for profit centers within the financial organization structure, providing insights into the hierarchy and organization of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NAME"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Find All By System ID

HTTP Request

GET /api/v1/profit-centers/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves detailed information about a specific profit center within the financial organization structure, identified by the provided ERP system ID, to facilitate effective management and analysis of financial entities.

Parameters

Name	In	Type	Required	Description
systemId	path	integer(int64)	true	Unique identifier for the system
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure of profit centers within the specified ERP system.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageProfitCenterDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "validTo": "2019-08-24",
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Get All By Cost Center

HTTP Request

GET /api/v1/profit-centers/cost-center/{controlling_area_id}

Interactive Demo

📋 Description: Retrieves cost center details associated with a specified controlling area within the financial organization structure, enabling users to understand the hierarchy and organization of financial entities.

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 retrieve associated profit centers and cost center details.
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure of profit centers within a specified controlling area.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageProfitCenterDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "validTo": "2019-08-24",
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Profit Center - Get All By Controlling Area

HTTP Request

GET /api/v1/profit-centers/controlling-area/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific profit center within the financial organization structure, identified by the controlling area ID, to support organizational hierarchy and financial entity management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
pageable	query	Pageable	true	Indicates whether the results of the profit centers within the specified controlling area should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageProfitCenterDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "validTo": "2019-08-24",
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---