Depreciation Area

Depreciation Area - Get

HTTP Request

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

Interactive Demo

📋 Description: Retrieves detailed information about a specific depreciation area within the financial organization structure, identified by the provided ID. This operation supports the management of financial entities by facilitating access to hierarchical data related to asset depreciation.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDepreciationAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "currencyId": 0,
    "currencyDisplayId": "string",
    "companyId": 0
  }
}

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

Depreciation Area - Update

HTTP Request

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

Interactive Demo

📋 Description: Updates the details of a specified depreciation area within the financial organization structure, allowing for adjustments to align with the entity’s hierarchical and structural requirements.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	DepreciationAreaDto	true	Request body containing updated information for a specific depreciation area, including attributes such as name, description, and financial hierarchy details relevant to the organization’s structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "chartOfDepreciationId": 0,
  "chartOfDepreciationDisplayId": "string",
  "currencyId": 0,
  "currencyDisplayId": "string",
  "companyId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDepreciationAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "currencyId": 0,
    "currencyDisplayId": "string",
    "companyId": 0
  }
}

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

Depreciation Area - Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes a specified depreciation area from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective financial management.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

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

Depreciation Area - Delete Or Decommission

HTTP Request

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

Interactive Demo

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

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Depreciation Area - Delete Or Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Removes multiple depreciation areas from the financial organization structure, facilitating the management of financial entities and their hierarchical organization.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of identifiers for multiple depreciation areas to be removed from the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Depreciation Area - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions a specified depreciation area within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that outdated or unnecessary depreciation areas are no longer considered in financial reporting and analysis.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDepreciationAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "currencyId": 0,
    "currencyDisplayId": "string",
    "companyId": 0
  }
}

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

Depreciation Area - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Decommissions depreciation areas within the financial organization structure that were modified before the specified date, ensuring the hierarchy remains up-to-date and aligned with current organizational needs.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDepreciationAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "currencyId": 0,
      "currencyDisplayId": "string",
      "companyId": 0
    }
  ]
}

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

Depreciation Area - Decommission Before Now

HTTP Request

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

Interactive Demo

📋 Description: Updates the status of depreciation areas within the financial organization structure that were modified before the current date, facilitating effective management of financial entities and their hierarchical structures.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDepreciationAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "currencyId": 0,
      "currencyDisplayId": "string",
      "companyId": 0
    }
  ]
}

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

Depreciation Area - Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Updates the status of multiple depreciation areas to ‘decommissioned’ in bulk, facilitating efficient management of financial entities within the organizational structure.

Parameters

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

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDepreciationAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "currencyId": 0,
      "currencyDisplayId": "string",
      "companyId": 0
    }
  ]
}

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

Depreciation Area - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 Description: Updates or creates multiple depreciation areas within the financial organization structure, allowing for efficient management of asset hierarchies and ensuring accurate financial reporting.

Parameters

Name	In	Type	Required	Description
body	body	DepreciationAreaDto	true	Request body containing bulk data for creating or updating depreciation areas within the financial organization structure, including relevant attributes and hierarchy details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "currencyId": 0,
    "currencyDisplayId": "string",
    "companyId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDepreciationAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "currencyId": 0,
      "currencyDisplayId": "string",
      "companyId": 0
    }
  ]
}

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

Depreciation Area - Create Or Update

HTTP Request

PUT /api/v1/depreciation-areas/createOrUpdate

Interactive Demo

📋 Description: Creates or updates depreciation areas within the financial organization structure, ensuring alignment with the hierarchical framework of the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	DepreciationAreaDto	true	Request body containing the details of the depreciation area, including its attributes and hierarchy within the financial organization structure, for creation or update purposes.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "chartOfDepreciationId": 0,
  "chartOfDepreciationDisplayId": "string",
  "currencyId": 0,
  "currencyDisplayId": "string",
  "companyId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDepreciationAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "currencyId": 0,
    "currencyDisplayId": "string",
    "companyId": 0
  }
}

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

Depreciation Area - Bulk Update

HTTP Request

PUT /api/v1/depreciation-areas/bulk

Interactive Demo

📋 Description: Updates multiple depreciation areas within the financial organization structure in a single request, allowing for efficient management of asset hierarchies across financial entities.

Parameters

Name	In	Type	Required	Description
body	body	DepreciationAreaDto	true	Request body containing a collection of depreciation area data, including attributes and configurations necessary for updating the financial organization structure within the hierarchy of the financial entity.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "currencyId": 0,
    "currencyDisplayId": "string",
    "companyId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDepreciationAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "currencyId": 0,
      "currencyDisplayId": "string",
      "companyId": 0
    }
  ]
}

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

Depreciation Area - Bulk Create

HTTP Request

POST /api/v1/depreciation-areas/bulk

Interactive Demo

📋 Description: Creates multiple depreciation areas in bulk for a financial organization, facilitating efficient management of asset depreciation within the organizational structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	DepreciationAreaDto	true	Request body containing a list of depreciation area entries, each specifying attributes necessary for defining financial entities within the organizational structure and hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "currencyId": 0,
    "currencyDisplayId": "string",
    "companyId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDepreciationAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "currencyId": 0,
      "currencyDisplayId": "string",
      "companyId": 0
    }
  ]
}

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

Depreciation Area - Bulk Delete

HTTP Request

DELETE /api/v1/depreciation-areas/bulk

Interactive Demo

📋 Description: Deletes multiple depreciation areas within the financial organization structure, allowing for streamlined management of financial entities and their hierarchical configurations.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of depreciation area identifiers to be deleted in bulk from the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Depreciation Area - Search

HTTP Request

POST /api/v1/depreciation-areas/search

Interactive Demo

📋 Description: Submits a search request for depreciation areas within the financial organization structure, allowing users to identify and analyze specific financial entities based on hierarchical criteria.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	DepreciationAreaDtoFilter	false	Request body containing the criteria for searching depreciation areas within the financial organization structure, including relevant identifiers and hierarchical relationships.

Default Values

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

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "erpSystemIdEqual": 0,
  "erpSystemIdIn": [
    0
  ],
  "erpSystemDisplayIdLike": "string",
  "uiSelector": "string",
  "nameLike": "string",
  "chartOfDepreciationIdEqual": 0,
  "chartOfDepreciationDisplayIdLike": "string",
  "currencyIdEqual": 0,
  "currencyDisplayIdLike": "string",
  "companyIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDepreciationAreaDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "currencyId": 0,
      "currencyDisplayId": "string",
      "companyId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

Depreciation Area - Detach Currency

HTTP Request

POST /api/v1/depreciation-areas/detach/currency/{currency_id}

Interactive Demo

📋 Description: Detaches a specified currency from the designated depreciation area within the financial organization structure, facilitating the management of financial entities and their hierarchical configurations.

Parameters

Name	In	Type	Required	Description
currency_id	path	integer(int64)	true	Unique identifier for the currency associated with the depreciation area, facilitating the financial organization structure within the entity’s hierarchy.
body	body	DepreciationAreaDto	true	Request body containing the details of the financial entity’s depreciation area to be detached from the specified currency, including relevant identifiers and metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "currencyId": 0,
    "currencyDisplayId": "string",
    "companyId": 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

Depreciation Area - Detach Chart Of Depreciation

HTTP Request

POST /api/v1/depreciation-areas/detach/chartofdepreciation/{relation_id}

Interactive Demo

📋 Description: Detaches a specified chart of depreciation from a financial organization structure, identified by the relation ID, to facilitate adjustments in the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
relation_id	path	integer(int64)	true	Unique identifier for the specific relationship within the financial organization structure that is being detached from the chart of depreciation.
body	body	DepreciationAreaDto	true	Request body containing the details necessary to detach a chart of depreciation from a specified financial entity within the organizational structure, including relevant identifiers and metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "currencyId": 0,
    "currencyDisplayId": "string",
    "companyId": 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

Depreciation Area - Attach Currency

HTTP Request

POST /api/v1/depreciation-areas/attach/currency/{currency_id}

Interactive Demo

📋 Description: Attaches a specified currency to a designated depreciation area within the financial organization structure, facilitating accurate financial reporting and analysis across the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
currency_id	path	integer(int64)	true	Unique identifier for the currency associated with the depreciation area, facilitating the organization and hierarchy of financial entities within the system.
body	body	DepreciationAreaDto	true	Request body containing the details necessary to associate a specified currency with a depreciation area within the financial organization structure, including relevant identifiers and attributes.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "currencyId": 0,
    "currencyDisplayId": "string",
    "companyId": 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

Depreciation Area - Attach Chart Of Depreciation

HTTP Request

POST /api/v1/depreciation-areas/attach/chartofdepreciation/{relation_id}

Interactive Demo

📋 Description: Attaches a specified chart of depreciation to a financial entity within the organizational structure, facilitating the alignment of asset management strategies with the entity’s hierarchy. This operation ensures that depreciation calculations are accurately reflected in the financial reporting of the organization.

Parameters

Name	In	Type	Required	Description
relation_id	path	integer(int64)	true	Unique identifier for the specific relationship within the financial organization structure, used to attach a chart of depreciation to the designated entity.
body	body	DepreciationAreaDto	true	Request body containing the details of the chart of depreciation to be attached to the specified financial organization structure, identified by the relation ID.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "currencyId": 0,
    "currencyDisplayId": "string",
    "companyId": 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

Depreciation Area - Find All

HTTP Request

GET /api/v1/depreciation-areas

Interactive Demo

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

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDepreciationAreaDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "currencyId": 0,
      "currencyDisplayId": "string",
      "companyId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

Depreciation Area - Create

HTTP Request

POST /api/v1/depreciation-areas

Interactive Demo

📋 Description: Creates a new depreciation area within the financial organization structure, enabling the establishment of hierarchical financial entities for effective asset management.

Parameters

Name	In	Type	Required	Description
body	body	DepreciationAreaDto	true	Request body containing the details of the depreciation areas, including their attributes and hierarchical relationships within the financial organization structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "chartOfDepreciationId": 0,
  "chartOfDepreciationDisplayId": "string",
  "currencyId": 0,
  "currencyDisplayId": "string",
  "companyId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDepreciationAreaDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "chartOfDepreciationId": 0,
    "chartOfDepreciationDisplayId": "string",
    "currencyId": 0,
    "currencyDisplayId": "string",
    "companyId": 0
  }
}

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

Depreciation Area - Get Metadata

HTTP Request

GET /api/v1/depreciation-areas/meta

Interactive Demo

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

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

Depreciation Area - Find All By System ID

HTTP Request

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

Interactive Demo

📋 Description: Retrieves the depreciation areas associated with a specified ERP system, providing insights into the financial organization structure and hierarchy of the entity.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDepreciationAreaDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "currencyId": 0,
      "currencyDisplayId": "string",
      "companyId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

Depreciation Area - Get All By Currency

HTTP Request

GET /api/v1/depreciation-areas/currency/{id}

Interactive Demo

📋 Description: Retrieves the currency details associated with a specified depreciation area within the financial organization structure, facilitating effective management of financial entities and their hierarchical relationships.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDepreciationAreaDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "currencyId": 0,
      "currencyDisplayId": "string",
      "companyId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

Depreciation Area - Get All By Chart Of Depreciation

HTTP Request

GET /api/v1/depreciation-areas/chartofdepreciation/{id}

Interactive Demo

📋 Description: Retrieves the chart of depreciation for a specified financial entity, allowing users to understand the organization’s asset depreciation structure within its hierarchy.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDepreciationAreaDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string",
      "chartOfDepreciationId": 0,
      "chartOfDepreciationDisplayId": "string",
      "currencyId": 0,
      "currencyDisplayId": "string",
      "companyId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

---