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

OK

ResponseCostCenterDto

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

CostCenterDto

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.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseCostCenterDto

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

OK

ResponseVoid

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

OK

ResponseVoid

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.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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

OK

ResponseCostCenterDto

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

OK

ResponseListCostCenterDto

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

OK

ResponseListCostCenterDto

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.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListCostCenterDto

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

CostCenterDto

true

Request body containing bulk data for creating or updating cost centers within the financial organization structure, including relevant identifiers and hierarchical relationships.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListCostCenterDto

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

CostCenterDto

true

Request body containing the cost center details, including identifiers, financial attributes, and hierarchical relationships essential for managing the organizationโ€™s financial structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseCostCenterDto

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

CostCenterDto

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.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListCostCenterDto

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

CostCenterDto

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.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListCostCenterDto

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.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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

CostCenterDto

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.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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

CostCenterDto

true

Request body containing the identifiers and details necessary to detach a profit center from its associated cost centers within the financial organization structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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

CostCenterDto

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.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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

CostCenterDto

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.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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

CostCenterDto

true

Request body containing the details necessary to associate a tax jurisdiction with a cost center, including relevant identifiers and organizational hierarchy information.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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

CostCenterDto

true

Request body containing the cost center details to be associated with the specified profit center, including relevant identifiers and financial attributes.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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

CostCenterDto

true

Request body containing the financial entity data necessary to associate a cost center with a specified controlling area within the organizational structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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

CostCenterDto

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.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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

Pageable

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

OK

PageCostCenterDto

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

CostCenterDto

true

Request body containing the details of the cost center, including its name, description, and hierarchical relationship within the financial organization structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseCostCenterDto

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

Pageable

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

OK

PageCostCenterDto

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

Pageable

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

OK

PageCostCenterDto

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

OK

Inline

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

Pageable

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

OK

PageCostCenterDto

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

Pageable

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

OK

PageCostCenterDto