Asset

Asset - Get

HTTP Request

GET /api/v1/assets/{id}

Interactive Demo

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

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAssetDto

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",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
}

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

Asset - Update

HTTP Request

PUT /api/v1/assets/{id}

Interactive Demo

📋 Description: Updates the details of a specific financial entity within the organizational structure by modifying the asset identified by the provided ID. This operation ensures that the hierarchy and structure of the financial organization remain accurate and up-to-date.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	AssetDto	true	Request body containing the updated financial entity details, including organization hierarchy and structural attributes for the specified asset.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "usefulLifeYears": 0,
  "usefulLifePeriods": 0,
  "scrapValue": 0,
  "quantity": 0,
  "agreementNumber": "string",
  "companyId": 0,
  "companyDisplayId": "string",
  "assetClassId": 0,
  "assetClassDisplayId": "string",
  "locationId": 0,
  "locationDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAssetDto

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",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
}

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

Asset - Delete

HTTP Request

DELETE /api/v1/assets/{id}

Interactive Demo

📋 Description: Deletes a specified asset from the financial organization 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

Asset - Delete Or Decommission

HTTP Request

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

Interactive Demo

📋 Description: Removes a specified asset from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective management of financial entities.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Asset - Delete Or Decommission All

HTTP Request

PUT /api/v1/assets/remove/bulk

Interactive Demo

📋 Description: Removes multiple assets from the financial organization structure in a single operation, streamlining the management of the hierarchy within the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of asset identifiers to be removed in bulk from the financial organization’s structure, ensuring efficient management of the entity’s hierarchical resources.

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

Asset - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions a specified financial asset within the organization’s structure, effectively removing it from the active hierarchy and ensuring accurate representation of the financial entity’s resources.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAssetDto

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",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
}

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

Asset - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Updates the status of financial assets within the organization structure that were modified before the specified date, facilitating effective asset management and compliance within the financial entity hierarchy.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning assets modified before the given date, facilitating the management of the financial organization’s structure and hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAssetDto

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",
      "usefulLifeYears": 0,
      "usefulLifePeriods": 0,
      "scrapValue": 0,
      "quantity": 0,
      "agreementNumber": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "assetClassId": 0,
      "assetClassDisplayId": "string",
      "locationId": 0,
      "locationDisplayId": "string"
    }
  ]
}

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

Asset - Decommission Before Now

HTTP Request

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

Interactive Demo

📋 Description: Updates the status of financial assets within the organization’s structure that have been modified before the current date, facilitating effective management of the financial entity’s hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAssetDto

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",
      "usefulLifeYears": 0,
      "usefulLifePeriods": 0,
      "scrapValue": 0,
      "quantity": 0,
      "agreementNumber": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "assetClassId": 0,
      "assetClassDisplayId": "string",
      "locationId": 0,
      "locationDisplayId": "string"
    }
  ]
}

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

Asset - Decommission All

HTTP Request

PUT /api/v1/assets/decommission/bulk

Interactive Demo

📋 Description: Updates the status of multiple financial assets to ‘decommissioned’ in bulk, facilitating efficient management of the organization’s financial structure and hierarchy.

Parameters

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

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAssetDto

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",
      "usefulLifeYears": 0,
      "usefulLifePeriods": 0,
      "scrapValue": 0,
      "quantity": 0,
      "agreementNumber": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "assetClassId": 0,
      "assetClassDisplayId": "string",
      "locationId": 0,
      "locationDisplayId": "string"
    }
  ]
}

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

Asset - Create Or Update Bulk

HTTP Request

PUT /api/v1/assets/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple financial entities within the organizational structure in a single operation, ensuring efficient management of hierarchy and asset data.

Parameters

Name	In	Type	Required	Description
body	body	AssetDto	true	Request body containing bulk asset data for creating or updating financial entities within the organizational structure and hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAssetDto

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",
      "usefulLifeYears": 0,
      "usefulLifePeriods": 0,
      "scrapValue": 0,
      "quantity": 0,
      "agreementNumber": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "assetClassId": 0,
      "assetClassDisplayId": "string",
      "locationId": 0,
      "locationDisplayId": "string"
    }
  ]
}

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

Asset - Create Or Update

HTTP Request

PUT /api/v1/assets/createOrUpdate

Interactive Demo

📋 Description: Creates or updates financial entities within the organizational structure, ensuring accurate representation of the hierarchy and relationships within the financial organization.

Parameters

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

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "usefulLifeYears": 0,
  "usefulLifePeriods": 0,
  "scrapValue": 0,
  "quantity": 0,
  "agreementNumber": "string",
  "companyId": 0,
  "companyDisplayId": "string",
  "assetClassId": 0,
  "assetClassDisplayId": "string",
  "locationId": 0,
  "locationDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAssetDto

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",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
}

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

Asset - Bulk Update

HTTP Request

PUT /api/v1/assets/bulk

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	AssetDto	true	Request body containing a bulk update of financial entity assets, including their hierarchical structure and organizational details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAssetDto

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",
      "usefulLifeYears": 0,
      "usefulLifePeriods": 0,
      "scrapValue": 0,
      "quantity": 0,
      "agreementNumber": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "assetClassId": 0,
      "assetClassDisplayId": "string",
      "locationId": 0,
      "locationDisplayId": "string"
    }
  ]
}

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

Asset - Bulk Create

HTTP Request

POST /api/v1/assets/bulk

Interactive Demo

📋 Description: Submits a bulk upload of financial assets to establish or update the organization’s financial structure and hierarchy within the system.

Parameters

Name	In	Type	Required	Description
body	body	AssetDto	true	Request body containing a bulk upload of financial entity asset data, structured to reflect the organization’s hierarchy and organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAssetDto

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",
      "usefulLifeYears": 0,
      "usefulLifePeriods": 0,
      "scrapValue": 0,
      "quantity": 0,
      "agreementNumber": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "assetClassId": 0,
      "assetClassDisplayId": "string",
      "locationId": 0,
      "locationDisplayId": "string"
    }
  ]
}

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

Asset - Bulk Delete

HTTP Request

DELETE /api/v1/assets/bulk

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of asset identifiers to be deleted from the financial organization structure, facilitating the management of organizational hierarchy.

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

Asset - Search

HTTP Request

POST /api/v1/assets/search

Interactive Demo

📋 Description: Submits a search request to locate financial entities within the organizational structure, allowing users to efficiently navigate and analyze the hierarchy of assets.

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	AssetDtoFilter	false	Request body containing search criteria and filters to retrieve financial entity assets within the organization’s hierarchical structure.

Default Values

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

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "erpSystemIdEqual": 0,
  "erpSystemIdIn": [
    0
  ],
  "erpSystemDisplayIdLike": "string",
  "nameLike": "string",
  "usefulLifeYearsLike": "string",
  "usefulLifePeriodsLike": "string",
  "scrapValueLike": "string",
  "quantityLike": "string",
  "agreementNumberLike": "string",
  "companyIdEqual": 0,
  "companyDisplayIdLike": "string",
  "assetClassIdEqual": 0,
  "assetClassDisplayIdLike": "string",
  "locationIdEqual": 0,
  "locationDisplayIdLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageAssetDto

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",
      "usefulLifeYears": 0,
      "usefulLifePeriods": 0,
      "scrapValue": 0,
      "quantity": 0,
      "agreementNumber": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "assetClassId": 0,
      "assetClassDisplayId": "string",
      "locationId": 0,
      "locationDisplayId": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

Asset - Detach Location From Assets

HTTP Request

POST /api/v1/assets/detach/location/{locationId}

Interactive Demo

📋 Description: Detaches a specified financial entity from its associated location within the organizational structure, facilitating updates to the hierarchy and ensuring accurate representation of asset allocation.

Parameters

Name	In	Type	Required	Description
locationId	path	integer(int64)	true	Unique identifier for the location
body	body	AssetDto	true	Request body containing the asset detachment details, including the financial entity identifier and relevant metadata for the specified location within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Asset - Detach Company

HTTP Request

POST /api/v1/assets/detach/company/{companyId}

Interactive Demo

📋 Description: Detaches a specified financial entity from the organizational structure associated with the given company ID, facilitating updates to the hierarchy of assets within the financial organization.

Parameters

Name	In	Type	Required	Description
companyId	path	integer(int64)	true	Unique identifier for the company
body	body	AssetDto	true	Request body containing the asset detachment details, including the financial entity identifiers and relevant hierarchy information for the specified company.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Asset - Detach Asset Class From Assets

HTTP Request

POST /api/v1/assets/detach/asset-class/{assetClassId}

Interactive Demo

📋 Description: Detaches a specified asset class from the financial organization structure, enabling the reorganization of assets within the hierarchy of the financial entity. This operation facilitates the management and restructuring of financial assets to align with organizational objectives.

Parameters

Name	In	Type	Required	Description
assetClassId	path	integer(int64)	true	Unique identifier for the asset class
body	body	AssetDto	true	Request body containing the asset detachment details, including the asset identifier and relevant financial entity information, to facilitate the reorganization of the financial hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Asset - Attach Location To Assets

HTTP Request

POST /api/v1/assets/attach/location/{locationId}

Interactive Demo

📋 Description: Attaches a specified asset to a designated location within the financial organization structure, facilitating the alignment of resources to the appropriate hierarchical entity.

Parameters

Name	In	Type	Required	Description
locationId	path	integer(int64)	true	Unique identifier for the location
body	body	AssetDto	true	Request body containing the asset attachment details, including the financial entity’s location ID and associated metadata for organizational structure alignment.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Asset - Attach Company

HTTP Request

POST /api/v1/assets/attach/company/{companyId}

Interactive Demo

📋 Description: Attaches financial assets to a specified company within the organizational structure, enabling enhanced hierarchy management and financial entity integration.

Parameters

Name	In	Type	Required	Description
companyId	path	integer(int64)	true	Unique identifier for the company
body	body	AssetDto	true	Request body containing the asset attachment details, including relevant identifiers and metadata, to associate financial entities within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Asset - Attach Asset Class To Assets

HTTP Request

POST /api/v1/assets/attach/asset-class/{assetClassId}

Interactive Demo

📋 Description: Attaches a specified asset class to the financial organization structure, facilitating the alignment of organizational hierarchy with financial entities.

Parameters

Name	In	Type	Required	Description
assetClassId	path	integer(int64)	true	Unique identifier for the asset class
body	body	AssetDto	true	Request body containing the asset attachment details, including relevant identifiers and metadata necessary for associating the asset with the specified asset class within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Asset - Find All

HTTP Request

GET /api/v1/assets

Interactive Demo

📋 Description: Retrieves a comprehensive list of financial entities within the organizational structure, allowing users to understand the hierarchy and relationships among various assets.

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 data.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageAssetDto

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",
      "usefulLifeYears": 0,
      "usefulLifePeriods": 0,
      "scrapValue": 0,
      "quantity": 0,
      "agreementNumber": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "assetClassId": 0,
      "assetClassDisplayId": "string",
      "locationId": 0,
      "locationDisplayId": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

Asset - Create

HTTP Request

POST /api/v1/assets

Interactive Demo

📋 Description: Creates a new financial entity within the organizational structure, enabling the establishment of a hierarchical framework for asset management.

Parameters

Name	In	Type	Required	Description
body	body	AssetDto	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",
  "name": "string",
  "usefulLifeYears": 0,
  "usefulLifePeriods": 0,
  "scrapValue": 0,
  "quantity": 0,
  "agreementNumber": "string",
  "companyId": 0,
  "companyDisplayId": "string",
  "assetClassId": 0,
  "assetClassDisplayId": "string",
  "locationId": 0,
  "locationDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAssetDto

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",
    "usefulLifeYears": 0,
    "usefulLifePeriods": 0,
    "scrapValue": 0,
    "quantity": 0,
    "agreementNumber": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "assetClassId": 0,
    "assetClassDisplayId": "string",
    "locationId": 0,
    "locationDisplayId": "string"
  }
}

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

Asset - Get Metadata

HTTP Request

GET /api/v1/assets/meta

Interactive Demo

📋 Description: Retrieves metadata related to the financial organization structure, providing insights into the hierarchy and relationships of financial entities within 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

Asset - Find All By System ID

HTTP Request

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

Interactive Demo

📋 Description: Retrieves the details of a specific ERP system identified by the systemId, providing insights into the financial organization structure and hierarchy of the associated financial entity.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageAssetDto

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",
      "usefulLifeYears": 0,
      "usefulLifePeriods": 0,
      "scrapValue": 0,
      "quantity": 0,
      "agreementNumber": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "assetClassId": 0,
      "assetClassDisplayId": "string",
      "locationId": 0,
      "locationDisplayId": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

---