Company

Company - Get

HTTP Request

GET /api/v1/companies/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific financial entity within the organizational structure by its unique identifier, facilitating insights into the hierarchy and relationships of the company.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCompanyDto

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",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
}

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

Company - Update

HTTP Request

PUT /api/v1/companies/{id}

Interactive Demo

📋 Description: Updates the details of a specified financial entity within the organizational structure, allowing for modifications to its hierarchy and attributes.

Parameters

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

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "countryId": 0,
  "countryDisplayId": "string",
  "postingPeriodVariantId": 0,
  "name": "string",
  "postingPeriodVariantDisplayId": "string",
  "controllingAreaId": 0,
  "controllingAreaDisplayId": "string",
  "chartOfAccountId": 0,
  "chartOfAccountDisplayId": "string",
  "fiscalVariantId": 0,
  "fiscalVariantDisplayId": "string",
  "chartOfDepreciationId": 0,
  "chartOfDepreciationDisplayId": "string",
  "purchasingOrganizationId": 0,
  "assetId": 0,
  "exchangeRateTypeId": 0,
  "plantId": 0,
  "incrementalBorrowingRateId": 0,
  "businessUnitId": 0,
  "projectId": 0,
  "transferVariantId": 0,
  "partnerId": 0,
  "departmentId": 0,
  "accountingStandardId": 0,
  "generalLedgerAccountId": 0,
  "consumerPriceIndexCategoryId": 0,
  "costCenterId": 0,
  "costCenterRelationValidFrom": "2019-08-24",
  "costCenterRelationValidTo": "2019-08-24"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCompanyDto

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",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
}

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

Company - Delete

HTTP Request

DELETE /api/v1/companies/{id}

Interactive Demo

📋 Description: Deletes a specified financial entity from the organization’s structure, ensuring the hierarchy remains accurate and up-to-date.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	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

Company - Delete Or Decommission

HTTP Request

PUT /api/v1/companies/remove/{id}

Interactive Demo

📋 Description: Removes a specified financial entity from the organization’s hierarchy, ensuring the updated structure reflects the current operational 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

Company - Delete Or Decommission All

HTTP Request

PUT /api/v1/companies/remove/bulk

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of company identifiers to facilitate the bulk removal of financial entities from 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

Company - Decommission

HTTP Request

PUT /api/v1/companies/decommission/{id}

Interactive Demo

📋 Description: Decommissions a financial entity within the organization structure by updating its status, effectively removing it from the active hierarchy. This operation ensures accurate representation of the organization’s structure and compliance with financial regulations.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCompanyDto

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",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
}

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

Company - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/companies/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions financial entities within the organization structure that were modified before the specified date, ensuring the hierarchy remains current and compliant with operational standards.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning financial entities within the organization structure, allowing for targeted updates based on modification timestamps.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ]
}

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

Company - Decommission Before Now

HTTP Request

PUT /api/v1/companies/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions financial entities within the organization structure that were modified before the current date, ensuring the hierarchy remains up-to-date and aligned with business objectives.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ]
}

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

Company - Decommission All

HTTP Request

PUT /api/v1/companies/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple financial entities within the organizational structure in a single operation, streamlining the management of hierarchical changes in the financial organization.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of financial entity identifiers and their corresponding decommissioning details for bulk processing within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ]
}

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

Company - Create Or Update Bulk

HTTP Request

PUT /api/v1/companies/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple financial entities in the organizational structure simultaneously, ensuring the hierarchy is accurately maintained and reflecting any changes in the company’s structure.

Parameters

Name	In	Type	Required	Description
body	body	CompanyDto	true	Request body containing a bulk array of financial entity data, including organization structure and hierarchy details for creating or updating multiple companies.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ]
}

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

Company - Create Or Update

HTTP Request

PUT /api/v1/companies/createOrUpdate

Interactive Demo

📋 Description: Creates or updates a financial organization structure by providing the relevant details of a company, ensuring accurate representation of its hierarchy and relationships within the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	CompanyDto	true	Request body containing the financial entity details, including organization structure and hierarchy information, for creating or updating a company record.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "countryId": 0,
  "countryDisplayId": "string",
  "postingPeriodVariantId": 0,
  "name": "string",
  "postingPeriodVariantDisplayId": "string",
  "controllingAreaId": 0,
  "controllingAreaDisplayId": "string",
  "chartOfAccountId": 0,
  "chartOfAccountDisplayId": "string",
  "fiscalVariantId": 0,
  "fiscalVariantDisplayId": "string",
  "chartOfDepreciationId": 0,
  "chartOfDepreciationDisplayId": "string",
  "purchasingOrganizationId": 0,
  "assetId": 0,
  "exchangeRateTypeId": 0,
  "plantId": 0,
  "incrementalBorrowingRateId": 0,
  "businessUnitId": 0,
  "projectId": 0,
  "transferVariantId": 0,
  "partnerId": 0,
  "departmentId": 0,
  "accountingStandardId": 0,
  "generalLedgerAccountId": 0,
  "consumerPriceIndexCategoryId": 0,
  "costCenterId": 0,
  "costCenterRelationValidFrom": "2019-08-24",
  "costCenterRelationValidTo": "2019-08-24"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCompanyDto

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",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
}

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

Company - Bulk Update

HTTP Request

PUT /api/v1/companies/bulk

Interactive Demo

📋 Description: Updates the financial organization structure by allowing bulk modifications of company entities, enabling efficient management of hierarchical relationships within the financial entity framework.

Parameters

Name	In	Type	Required	Description
body	body	CompanyDto	true	Request body containing a bulk update of financial organization structure data, including details on hierarchy and relationships among financial entities.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ]
}

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

Company - Bulk Create

HTTP Request

POST /api/v1/companies/bulk

Interactive Demo

📋 Description: Creates multiple financial entities within the organization’s structure in a single request, allowing for efficient management of hierarchical relationships and organizational data.

Parameters

Name	In	Type	Required	Description
body	body	CompanyDto	true	Request body containing a structured array of financial entity data for bulk creation or updating of organizational hierarchies within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ]
}

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

Company - Bulk Delete

HTTP Request

DELETE /api/v1/companies/bulk

Interactive Demo

📋 Description: Deletes multiple financial entities from the organization’s structure in a single operation, streamlining the management of the hierarchy within the financial organization.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of financial entity identifiers for bulk deletion within the organization’s hierarchical 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

Company - Search

HTTP Request

POST /api/v1/companies/search

Interactive Demo

📋 Description: Submits a request to search for companies 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	CompanyDtoExtendedFilter	false	Request body containing search criteria and filters for identifying financial entities within the organizational structure and hierarchy.

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",
  "countryIdEqual": 0,
  "countryDisplayIdLike": "string",
  "postingPeriodVariantIdEqual": 0,
  "nameLike": "string",
  "postingPeriodVariantDisplayIdLike": "string",
  "controllingAreaIdEqual": 0,
  "controllingAreaDisplayIdLike": "string",
  "chartOfAccountIdEqual": 0,
  "chartOfAccountDisplayIdLike": "string",
  "fiscalVariantIdEqual": 0,
  "fiscalVariantDisplayIdLike": "string",
  "chartOfDepreciationIdEqual": 0,
  "chartOfDepreciationDisplayIdLike": "string",
  "purchasingOrganizationIdEqual": 0,
  "assetIdEqual": 0,
  "exchangeRateTypeIdEqual": 0,
  "plantIdEqual": 0,
  "incrementalBorrowingRateIdEqual": 0,
  "businessUnitIdEqual": 0,
  "projectIdEqual": 0,
  "transferVariantIdEqual": 0,
  "partnerIdEqual": 0,
  "departmentIdEqual": 0,
  "accountingStandardIdEqual": 0,
  "generalLedgerAccountIdEqual": 0,
  "consumerPriceIndexCategoryIdEqual": 0,
  "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",
  "leaseAreaIdInOrNull": [
    0
  ],
  "businessUnitIdInOrNull": [
    0
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ],
  "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

Company - Detach Posting Period Variant From Companies

HTTP Request

POST /api/v1/companies/detach/posting-period-variant/{posting_period_variant_id}

Interactive Demo

📋 Description: Detaches a specified posting period variant from the financial organization structure, enabling the reconfiguration of the hierarchy within the financial entity. This operation ensures that the organization can adapt its financial reporting periods as needed.

Parameters

Name	In	Type	Required	Description
posting_period_variant_id	path	integer(int64)	true	Unique identifier for the posting period variant within the financial organization structure, used to detach specific variants from the company’s hierarchy.
body	body	CompanyDto	true	Request body containing the financial entity’s posting period variant details to facilitate the detachment process within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Detach Fiscal Variant From Companies

HTTP Request

POST /api/v1/companies/detach/fiscal-variant/{fiscal_variant_id}

Interactive Demo

📋 Description: Detaches a specified fiscal variant from the financial organization structure, allowing for adjustments in the hierarchy and organization of financial entities. This operation ensures that the fiscal variant is no longer associated with the current organizational framework.

Parameters

Name	In	Type	Required	Description
fiscal_variant_id	path	integer(int64)	true	Unique identifier for the fiscal variant within the financial organization structure, used to detach it from the specified company.
body	body	CompanyDto	true	Request body containing the details necessary to detach a fiscal variant from the financial organization structure, including relevant identifiers and metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Detach Country

HTTP Request

POST /api/v1/companies/detach/country/{country_id}

Interactive Demo

📋 Description: Detaches a specified country from the financial organization structure, facilitating updates to the hierarchy of financial entities. This operation ensures accurate representation of organizational relationships and compliance with structural changes.

Parameters

Name	In	Type	Required	Description
country_id	path	integer(int64)	true	Unique identifier for the country within the financial organization structure, used to detach a specified country from the company’s hierarchy.
body	body	CompanyDto	true	Request body containing the financial entity details to detach a company from the specified country within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Detach Cost Center

HTTP Request

POST /api/v1/companies/detach/cost-center/{cost_center_id}

Interactive Demo

📋 Description: Detaches a specified cost center from the financial organization structure, facilitating updates to the hierarchy of financial entities within the organization. This operation ensures accurate representation of organizational resources and responsibilities.

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 detach it from the specified company hierarchy.
body	body	CompanyDto	true	Request body containing the details required to detach a specified cost center from the financial organization structure, including relevant identifiers and metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Detach Controlling Area From Companies

HTTP Request

POST /api/v1/companies/detach/controlling-area/{controlling_area_id}

Interactive Demo

📋 Description: Detaches a specified controlling area from the financial organization structure, allowing for adjustments in the hierarchy of financial entities. This operation is essential for maintaining accurate organizational relationships within the financial 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 detach a specified financial entity from its hierarchical context.
body	body	CompanyDto	true	Request body containing the details of the financial entity’s organization structure to detach the specified controlling area from its hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Detach Chart Of Depreciation From Companies

HTTP Request

POST /api/v1/companies/detach/chart-of-depreciation/{chart_of_depreciation_id}

Interactive Demo

📋 Description: Detaches the specified chart of depreciation from the financial organization structure, facilitating the reorganization of financial entities within the hierarchy. This operation ensures that the chart of depreciation is no longer associated with the designated company.

Parameters

Name	In	Type	Required	Description
chart_of_depreciation_id	path	integer(int64)	true	Unique identifier for the chart of depreciation, used to detach it from the financial organization structure within the specified entity.
body	body	CompanyDto	true	Request body containing the financial entity details necessary to detach a specific chart of depreciation from the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Detach Chart Of Account From Companies

HTTP Request

POST /api/v1/companies/detach/chart-of-account/{chart_of_account_id}

Interactive Demo

📋 Description: Detaches a specified chart of accounts from a financial organization structure, facilitating the reorganization of financial entities within the hierarchy. This operation ensures that the selected chart of accounts is no longer associated with the designated company.

Parameters

Name	In	Type	Required	Description
chart_of_account_id	path	integer(int64)	true	Unique identifier for the chart of accounts within the financial organization structure, used to detach a specific account from the company’s hierarchy.
body	body	CompanyDto	true	Request body containing the financial entity details necessary to detach a specified chart of account from the organization’s structure and hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Detach Business Unit

HTTP Request

POST /api/v1/companies/detach/business-unit/{business_unit_id}

Interactive Demo

📋 Description: Detaches a specified business unit from the financial organization structure, effectively updating the hierarchy of the entity. This operation is essential for maintaining accurate organizational alignment and resource allocation.

Parameters

Name	In	Type	Required	Description
business_unit_id	path	integer(int64)	true	Unique identifier for the business unit to be detached from the financial organization structure.
body	body	CompanyDto	true	Request body containing the details required to detach a specified business unit from the financial organization structure, including relevant identifiers and metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Attach Posting Period Variant To Companies

HTTP Request

POST /api/v1/companies/attach/posting-period-variant/{posting_period_variant_id}

Interactive Demo

📋 Description: Attaches a specified posting period variant to a financial organization structure, facilitating the alignment of financial entities within the organizational hierarchy.

Parameters

Name	In	Type	Required	Description
posting_period_variant_id	path	integer(int64)	true	Unique identifier for the posting period variant within the financial organization structure, facilitating the attachment of specific posting periods to a financial entity.
body	body	CompanyDto	true	Request body containing the financial entity details and associated metadata required to attach a posting period variant within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Attach Fiscal Variant To Companies

HTTP Request

POST /api/v1/companies/attach/fiscal-variant/{fiscal_variant_id}

Interactive Demo

📋 Description: Attaches a specified fiscal variant to a financial organization structure, enabling the alignment of organizational hierarchy with financial entity requirements.

Parameters

Name	In	Type	Required	Description
fiscal_variant_id	path	integer(int64)	true	Unique identifier for the fiscal variant associated with the financial entity, used to establish its position within the organizational structure and hierarchy.
body	body	CompanyDto	true	Request body containing the financial entity details necessary to associate a specified fiscal variant with the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Attach Country

HTTP Request

POST /api/v1/companies/attach/country/{country_id}

Interactive Demo

📋 Description: Attaches a specified country to a financial organization structure, enabling the alignment of organizational hierarchy and compliance with regional regulations.

Parameters

Name	In	Type	Required	Description
country_id	path	integer(int64)	true	Unique identifier for the country associated with the financial entity being attached to the organizational structure.
body	body	CompanyDto	true	Request body containing the financial entity details to be associated with the specified country, including organizational hierarchy and structural attributes.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Attach Cost Center

HTTP Request

POST /api/v1/companies/attach/cost-center/{cost_center_id}

Interactive Demo

📋 Description: Attaches a specified cost center to a financial organization structure, facilitating the alignment of financial entities within the organizational hierarchy.

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 the specified company during the attachment process.
body	body	CompanyDto	true	Request body containing the financial entity’s organizational structure data, including cost center details and associated hierarchy information.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Attach Controlling Area To Companies

HTTP Request

POST /api/v1/companies/attach/controlling-area/{controlling_area_id}

Interactive Demo

📋 Description: Attaches a specified controlling area to a financial organization structure, enabling the alignment of organizational hierarchy and enhancing the management 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 associate a financial entity with its hierarchical organization.
body	body	CompanyDto	true	Request body containing the financial entity details necessary to associate a company with a specified controlling area within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Attach Chart Of Depreciation To Companies

HTTP Request

POST /api/v1/companies/attach/chart-of-depreciation/{chart_of_depreciation_id}

Interactive Demo

📋 Description: Attaches a specified chart of depreciation to a financial entity within the organizational structure, facilitating accurate asset management and financial reporting. This operation ensures that the hierarchy of financial data is maintained effectively.

Parameters

Name	In	Type	Required	Description
chart_of_depreciation_id	path	integer(int64)	true	Unique identifier for the chart of depreciation associated with a financial entity, used to attach relevant depreciation data within the organization’s structure.
body	body	CompanyDto	true	Request body containing the financial entity details required to attach a specified chart of depreciation to the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Attach Chart Of Account To Companies

HTTP Request

POST /api/v1/companies/attach/chart-of-account/{chart_of_account_id}

Interactive Demo

📋 Description: Attaches a specified chart of accounts to a financial entity within the organizational structure, facilitating the alignment of financial reporting and hierarchy management.

Parameters

Name	In	Type	Required	Description
chart_of_account_id	path	integer(int64)	true	Unique identifier for the chart of accounts associated with a financial entity, used to establish the organizational structure and hierarchy within the system.
body	body	CompanyDto	true	Request body containing the financial entity details required to associate a specified chart of accounts with the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Attach Business Unit

HTTP Request

POST /api/v1/companies/attach/business-unit/{business_unit_id}

Interactive Demo

📋 Description: Attaches a specified business unit to a financial organization structure, facilitating the alignment of organizational hierarchy and enhancing the management of financial entities.

Parameters

Name	In	Type	Required	Description
business_unit_id	path	integer(int64)	true	Unique identifier for the business unit within the financial organization structure, used to associate it with a company during the attachment process.
body	body	CompanyDto	true	Request body containing the financial entity details to be associated with the specified business unit, including relevant organizational hierarchy information.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
]

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

Company - Find All

HTTP Request

GET /api/v1/companies

Interactive Demo

📋 Description: Retrieves a list of financial organizations, providing insights into their structure and hierarchy within the financial entity framework.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating the retrieval of financial organization structure data in manageable segments.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ],
  "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

Company - Create

HTTP Request

POST /api/v1/companies

Interactive Demo

📋 Description: Creates a new financial entity within the organizational structure, enabling the establishment of a hierarchical framework for managing company relationships and operations.

Parameters

Name	In	Type	Required	Description
body	body	CompanyDto	true	Request body containing the financial entity’s organizational structure data, including hierarchy details and associated attributes.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "countryId": 0,
  "countryDisplayId": "string",
  "postingPeriodVariantId": 0,
  "name": "string",
  "postingPeriodVariantDisplayId": "string",
  "controllingAreaId": 0,
  "controllingAreaDisplayId": "string",
  "chartOfAccountId": 0,
  "chartOfAccountDisplayId": "string",
  "fiscalVariantId": 0,
  "fiscalVariantDisplayId": "string",
  "chartOfDepreciationId": 0,
  "chartOfDepreciationDisplayId": "string",
  "purchasingOrganizationId": 0,
  "assetId": 0,
  "exchangeRateTypeId": 0,
  "plantId": 0,
  "incrementalBorrowingRateId": 0,
  "businessUnitId": 0,
  "projectId": 0,
  "transferVariantId": 0,
  "partnerId": 0,
  "departmentId": 0,
  "accountingStandardId": 0,
  "generalLedgerAccountId": 0,
  "consumerPriceIndexCategoryId": 0,
  "costCenterId": 0,
  "costCenterRelationValidFrom": "2019-08-24",
  "costCenterRelationValidTo": "2019-08-24"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCompanyDto

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",
    "countryId": 0,
    "countryDisplayId": "string",
    "postingPeriodVariantId": 0,
    "name": "string",
    "postingPeriodVariantDisplayId": "string",
    "controllingAreaId": 0,
    "controllingAreaDisplayId": "string",
    "chartOfAccountId": 0,
    "chartOfAccountDisplayId": "string",
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "purchasingOrganizationId": 0,
    "assetId": 0,
    "exchangeRateTypeId": 0,
    "plantId": 0,
    "incrementalBorrowingRateId": 0,
    "businessUnitId": 0,
    "projectId": 0,
    "transferVariantId": 0,
    "partnerId": 0,
    "departmentId": 0,
    "accountingStandardId": 0,
    "generalLedgerAccountId": 0,
    "consumerPriceIndexCategoryId": 0,
    "costCenterId": 0,
    "costCenterRelationValidFrom": "2019-08-24",
    "costCenterRelationValidTo": "2019-08-24"
  }
}

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

Company - Get All By Posting Period Variant

HTTP Request

GET /api/v1/companies/posting-period-variant/{posting_period_variant_id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific posting period variant within the financial organization structure, identified by the provided posting_period_variant_id. This operation supports the management of organizational hierarchy and financial entity configurations.

Parameters

Name	In	Type	Required	Description
posting_period_variant_id	path	integer(int64)	true	Unique identifier for the posting period variant within the financial organization structure, facilitating the retrieval of specific posting period configurations for the associated financial entity.
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of company posting period variants within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ],
  "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

Company - Get All By Partner

HTTP Request

GET /api/v1/companies/partner/{partner_id}

Interactive Demo

Parameters

Name	In	Type	Required	Description
partner_id	path	integer(int64)	true	none
pageable	query	Pageable	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ],
  "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

Company - Get Metadata

HTTP Request

GET /api/v1/companies/meta

Interactive Demo

📋 Description: Retrieves metadata related to the organizational structure and hierarchy of financial entities, providing insights into the relationships and classifications within the company framework.

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

Company - Get All By Fiscal Variant

HTTP Request

GET /api/v1/companies/fiscal-variant/{fiscal_variant_id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific fiscal variant within the financial organization structure, identified by the provided fiscal_variant_id. This operation supports the management of organizational hierarchies and financial entities.

Parameters

Name	In	Type	Required	Description
fiscal_variant_id	path	integer(int64)	true	Unique identifier for the fiscal variant within the financial organization structure, enabling retrieval of specific fiscal configurations related to the company’s hierarchy.
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing users to efficiently navigate through the hierarchical structure of financial entities associated with the specified fiscal variant.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ],
  "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

Company - Find All By System ID

HTTP Request

GET /api/v1/companies/erp-system/{systemId}

Interactive Demo

📋 Description: Fetches the details of a specific ERP system within the financial organization structure, identified by the provided system ID, to facilitate understanding of the organization’s hierarchy and operational framework.

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 for efficient retrieval of financial entities within the organizational structure hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ],
  "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

Company - Get All By Controlling Area

HTTP Request

GET /api/v1/companies/controlling-area/{controlling_area_id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific controlling area within the financial organization structure, identified by the provided controlling_area_id, to facilitate effective management of organizational hierarchy and 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, facilitating the retrieval of hierarchical data related to the specified financial entity.
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing users to efficiently navigate through the financial organization structure associated with the specified controlling area.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ],
  "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

Company - Get All By Chart Of Depreciation

HTTP Request

GET /api/v1/companies/chart-of-depreciation/{chart_of_depreciation_id}

Interactive Demo

📋 Description: Retrieves the chart of depreciation details for a specified financial entity, providing insights into the organization’s asset depreciation structure within its hierarchy.

Parameters

Name	In	Type	Required	Description
chart_of_depreciation_id	path	integer(int64)	true	Unique identifier for the chart of depreciation within the financial organization structure, used to retrieve specific depreciation details for a financial entity.
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating the retrieval of hierarchical financial data related to the specified chart of depreciation.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ],
  "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

Company - Get All By Chart Of Account

HTTP Request

GET /api/v1/companies/chart-of-account/{chart_of_account_id}

Interactive Demo

📋 Description: Retrieves the chart of accounts for a specified financial entity, providing insights into the organization’s financial structure and hierarchy.

Parameters

Name	In	Type	Required	Description
chart_of_account_id	path	integer(int64)	true	Unique identifier for the chart of accounts within a financial organization, facilitating access to its hierarchical structure and associated details.
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of hierarchical financial entity data within the specified chart of accounts.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCompanyDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "postingPeriodVariantId": 0,
      "name": "string",
      "postingPeriodVariantDisplayId": "string",
      "controllingAreaId": 0,
      "controllingAreaDisplayId": "string",
      "chartOfAccountId": 0,
      "chartOfAccountDisplayId": "string",
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "purchasingOrganizationId": 0,
      "assetId": 0,
      "exchangeRateTypeId": 0,
      "plantId": 0,
      "incrementalBorrowingRateId": 0,
      "businessUnitId": 0,
      "projectId": 0,
      "transferVariantId": 0,
      "partnerId": 0,
      "departmentId": 0,
      "accountingStandardId": 0,
      "generalLedgerAccountId": 0,
      "consumerPriceIndexCategoryId": 0,
      "costCenterId": 0,
      "costCenterRelationValidFrom": "2019-08-24",
      "costCenterRelationValidTo": "2019-08-24"
    }
  ],
  "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

---