Controlling Area

Controlling Area - Get

HTTP Request

GET /api/v1/controlling-areas/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific controlling area within the financial organization structure, identified by the provided ID, to facilitate understanding of the organization’s 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	ResponseControllingAreaDto

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",
    "companyId": 0,
    "costCenterId": 0,
    "profitCenterId": 0,
    "internalOrderId": 0,
    "workBreakdownStructureId": 0
  }
}

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

Controlling Area - Update

HTTP Request

PUT /api/v1/controlling-areas/{id}

Interactive Demo

📋 Description: Updates the details of a specified controlling area within the financial organization structure, allowing for modifications to the hierarchy and organization of financial entities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ControllingAreaDto	true	Request body containing the updated financial organization structure data for the specified controlling area, including hierarchy details and relevant attributes.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "companyId": 0,
  "costCenterId": 0,
  "profitCenterId": 0,
  "internalOrderId": 0,
  "workBreakdownStructureId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseControllingAreaDto

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",
    "companyId": 0,
    "costCenterId": 0,
    "profitCenterId": 0,
    "internalOrderId": 0,
    "workBreakdownStructureId": 0
  }
}

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

Controlling Area - Delete

HTTP Request

DELETE /api/v1/controlling-areas/{id}

Interactive Demo

📋 Description: Deletes a specified controlling area from the financial organization structure, ensuring the integrity of the hierarchy within the financial entity.

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

Controlling Area - Delete Or Decommission

HTTP Request

PUT /api/v1/controlling-areas/remove/{id}

Interactive Demo

📋 Description: Removes a specified controlling area from the financial organization structure, ensuring the hierarchy reflects the current organizational needs. This operation is essential for maintaining accurate financial entity configurations.

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

Controlling Area - Delete Or Decommission All

HTTP Request

PUT /api/v1/controlling-areas/remove/bulk

Interactive Demo

📋 Description: Removes multiple controlling areas from the financial organization structure in a single operation, streamlining the management of organizational hierarchy within financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of financial entity identifiers for the bulk removal of controlling areas within the organizational 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

Controlling Area - Decommission

HTTP Request

PUT /api/v1/controlling-areas/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified controlling area within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures accurate representation and management of organizational resources.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseControllingAreaDto

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",
    "companyId": 0,
    "costCenterId": 0,
    "profitCenterId": 0,
    "internalOrderId": 0,
    "workBreakdownStructureId": 0
  }
}

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

Controlling Area - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/controlling-areas/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions controlling areas within the financial organization structure that have been modified before the specified date, ensuring an updated and accurate hierarchy of financial entities. This operation helps maintain the integrity of organizational data by removing outdated structures.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning controlling areas in the financial organization structure, ensuring that only those modified before this date are processed.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListControllingAreaDto

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",
      "companyId": 0,
      "costCenterId": 0,
      "profitCenterId": 0,
      "internalOrderId": 0,
      "workBreakdownStructureId": 0
    }
  ]
}

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

Controlling Area - Decommission Before Now

HTTP Request

PUT /api/v1/controlling-areas/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions controlling areas in the financial organization structure that have been modified before the current date, ensuring the hierarchy remains up-to-date and aligned with organizational changes.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListControllingAreaDto

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",
      "companyId": 0,
      "costCenterId": 0,
      "profitCenterId": 0,
      "internalOrderId": 0,
      "workBreakdownStructureId": 0
    }
  ]
}

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

Controlling Area - Decommission All

HTTP Request

PUT /api/v1/controlling-areas/decommission/bulk

Interactive Demo

📋 Description: Updates the status of multiple controlling areas to ‘decommissioned’ in bulk, facilitating the management of financial organization structures and ensuring accurate hierarchy representation within the financial entity.

Parameters

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

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListControllingAreaDto

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",
      "companyId": 0,
      "costCenterId": 0,
      "profitCenterId": 0,
      "internalOrderId": 0,
      "workBreakdownStructureId": 0
    }
  ]
}

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

Controlling Area - Create Or Update Bulk

HTTP Request

PUT /api/v1/controlling-areas/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple controlling areas within the financial organization structure, enabling efficient management of organizational hierarchy and financial entities in bulk.

Parameters

Name	In	Type	Required	Description
body	body	ControllingAreaDto	true	Request body containing a bulk array of controlling area data, including identifiers and 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",
    "companyId": 0,
    "costCenterId": 0,
    "profitCenterId": 0,
    "internalOrderId": 0,
    "workBreakdownStructureId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListControllingAreaDto

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",
      "companyId": 0,
      "costCenterId": 0,
      "profitCenterId": 0,
      "internalOrderId": 0,
      "workBreakdownStructureId": 0
    }
  ]
}

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

Controlling Area - Create Or Update

HTTP Request

PUT /api/v1/controlling-areas/createOrUpdate

Interactive Demo

📋 Description: Creates or updates controlling areas within the financial organization structure, allowing for the effective management of organizational hierarchy and financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ControllingAreaDto	true	Request body containing the financial entity’s organizational structure data, including details for creating or updating controlling areas within the hierarchy.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "companyId": 0,
  "costCenterId": 0,
  "profitCenterId": 0,
  "internalOrderId": 0,
  "workBreakdownStructureId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseControllingAreaDto

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",
    "companyId": 0,
    "costCenterId": 0,
    "profitCenterId": 0,
    "internalOrderId": 0,
    "workBreakdownStructureId": 0
  }
}

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

Controlling Area - Bulk Update

HTTP Request

PUT /api/v1/controlling-areas/bulk

Interactive Demo

📋 Description: Updates multiple controlling areas within the financial organization structure, allowing for efficient management of organizational hierarchy and financial entity configurations.

Parameters

Name	In	Type	Required	Description
body	body	ControllingAreaDto	true	Request body containing a bulk update of controlling area data, including organizational hierarchy and financial entity attributes essential for maintaining the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "companyId": 0,
    "costCenterId": 0,
    "profitCenterId": 0,
    "internalOrderId": 0,
    "workBreakdownStructureId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListControllingAreaDto

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",
      "companyId": 0,
      "costCenterId": 0,
      "profitCenterId": 0,
      "internalOrderId": 0,
      "workBreakdownStructureId": 0
    }
  ]
}

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

Controlling Area - Bulk Create

HTTP Request

POST /api/v1/controlling-areas/bulk

Interactive Demo

📋 Description: Creates multiple controlling areas within the financial organization structure, enabling the establishment of hierarchical relationships and organizational frameworks for financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ControllingAreaDto	true	Request body containing a bulk array of controlling area definitions, including attributes essential for establishing the financial organization structure and hierarchy within the financial entity.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "companyId": 0,
    "costCenterId": 0,
    "profitCenterId": 0,
    "internalOrderId": 0,
    "workBreakdownStructureId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListControllingAreaDto

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",
      "companyId": 0,
      "costCenterId": 0,
      "profitCenterId": 0,
      "internalOrderId": 0,
      "workBreakdownStructureId": 0
    }
  ]
}

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

Controlling Area - Bulk Delete

HTTP Request

DELETE /api/v1/controlling-areas/bulk

Interactive Demo

📋 Description: Deletes multiple controlling areas within the financial organization structure, allowing for efficient management of organizational hierarchies and entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of identifiers for the controlling areas to be deleted, reflecting changes in 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

Controlling Area - Search

HTTP Request

POST /api/v1/controlling-areas/search

Interactive Demo

📋 Description: Submits a search request for controlling areas within the financial organization structure, enabling 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	ControllingAreaDtoFilter	false	Request body containing search criteria for identifying specific controlling areas within the financial organization structure, including relevant attributes and filters.

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",
  "nameLike": "string",
  "companyIdEqual": 0,
  "costCenterIdEqual": 0,
  "profitCenterIdEqual": 0,
  "internalOrderIdEqual": 0,
  "workBreakdownStructureIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageControllingAreaDto

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",
      "companyId": 0,
      "costCenterId": 0,
      "profitCenterId": 0,
      "internalOrderId": 0,
      "workBreakdownStructureId": 0
    }
  ],
  "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

Controlling Area - Detach Company From Controlling Area

HTTP Request

POST /api/v1/controlling-areas/detach/company/{company_id}

Interactive Demo

📋 Description: Detaches a specified company from its associated controlling area within the financial organization structure, facilitating the reorganization of financial entities and their hierarchical relationships.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organizational structure, used to detach a controlling area from the specified company.

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

Controlling Area - Attach Company To Controlling Area

HTTP Request

POST /api/v1/controlling-areas/attach/company/{company_id}/{controlling_area_id}

Interactive Demo

📋 Description: Attaches a specified controlling area to a designated company within the financial organization structure, facilitating the establishment of hierarchical relationships essential for effective financial management.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organization, used to associate a controlling area with a specific company in the financial organization structure.
controlling_area_id	path	integer(int64)	true	Unique identifier for the controlling area within the financial organization structure, used to associate it with a specified company.

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

Controlling Area - Find All

HTTP Request

GET /api/v1/controlling-areas

Interactive Demo

📋 Description: Retrieves a list of controlling areas within the financial organization structure, providing insights into the hierarchical relationships and organization of financial entities. This operation supports effective management and analysis of financial data across the organization.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the financial organization structure query should be returned in a paginated format, facilitating efficient data retrieval for large hierarchies.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageControllingAreaDto

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",
      "companyId": 0,
      "costCenterId": 0,
      "profitCenterId": 0,
      "internalOrderId": 0,
      "workBreakdownStructureId": 0
    }
  ],
  "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

Controlling Area - Create

HTTP Request

POST /api/v1/controlling-areas

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	ControllingAreaDto	true	Request body containing the details for creating a new controlling area within the financial organization structure, including attributes such as name, hierarchy level, and associated financial entity.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "companyId": 0,
  "costCenterId": 0,
  "profitCenterId": 0,
  "internalOrderId": 0,
  "workBreakdownStructureId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseControllingAreaDto

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",
    "companyId": 0,
    "costCenterId": 0,
    "profitCenterId": 0,
    "internalOrderId": 0,
    "workBreakdownStructureId": 0
  }
}

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

Controlling Area - Get Metadata

HTTP Request

GET /api/v1/controlling-areas/meta

Interactive Demo

📋 Description: Retrieves metadata for controlling areas within the financial organization structure, providing insights into the hierarchy and organization of financial entities. This operation supports effective management and analysis of financial data.

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

Controlling Area - Find All By System ID

HTTP Request

GET /api/v1/controlling-areas/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves the controlling area details for a specified ERP system, enabling users to understand the organizational structure and hierarchy within the financial entity.

Parameters

Name	In	Type	Required	Description
systemId	path	integer(int64)	true	Unique identifier for the system
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of financial organization structure data within the specified ERP system.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageControllingAreaDto

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",
      "companyId": 0,
      "costCenterId": 0,
      "profitCenterId": 0,
      "internalOrderId": 0,
      "workBreakdownStructureId": 0
    }
  ],
  "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

Controlling Area - Get All By Company

HTTP Request

GET /api/v1/controlling-areas/company/{companyId}

Interactive Demo

📋 Description: Retrieves the controlling areas associated with a specified company, providing insights into the organizational structure and hierarchy of the financial entity. This operation facilitates effective management and analysis of financial organization structures.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageControllingAreaDto

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",
      "companyId": 0,
      "costCenterId": 0,
      "profitCenterId": 0,
      "internalOrderId": 0,
      "workBreakdownStructureId": 0
    }
  ],
  "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

---