Asset Class

Asset Class - Get

HTTP Request

GET /api/v1/asset-classes/{id}

Interactive Demo

📋 Description: Fetches detailed information about a specific asset class within the financial organization structure, identified by the provided ID, to support hierarchical analysis and organizational decision-making.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAssetClassDto

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",
    "assetId": 0
  }
}

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

Asset Class - Update

HTTP Request

PUT /api/v1/asset-classes/{id}

Interactive Demo

📋 Description: Updates the details of a specific asset class within the financial organization structure, enabling users to modify attributes associated with the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	AssetClassDto	true	Request body containing the updated asset class information, including attributes such as name, description, and hierarchy level within the financial organization structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "assetId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAssetClassDto

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",
    "assetId": 0
  }
}

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

Asset Class - Delete

HTTP Request

DELETE /api/v1/asset-classes/{id}

Interactive Demo

📋 Description: Deletes a specified asset class 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

Asset Class - Delete Or Decommission

HTTP Request

PUT /api/v1/asset-classes/remove/{id}

Interactive Demo

📋 Description: Removes a specified asset class from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date within the entity.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

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 Class - Delete Or Decommission All

HTTP Request

PUT /api/v1/asset-classes/remove/bulk

Interactive Demo

📋 Description: Removes multiple asset classes 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 class identifiers to be removed in bulk from the financial organization’s structure, ensuring efficient management of the 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 Class - Decommission

HTTP Request

PUT /api/v1/asset-classes/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified asset class within the financial organization structure, effectively removing it from the active hierarchy and ensuring it is no longer utilized in financial operations.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAssetClassDto

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",
    "assetId": 0
  }
}

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

Asset Class - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/asset-classes/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions asset classes in the financial organization structure that were modified before the specified date, ensuring the hierarchy remains up-to-date and aligned with organizational changes.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning asset classes, allowing the financial organization to manage its structure and hierarchy effectively.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAssetClassDto

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",
      "assetId": 0
    }
  ]
}

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

Asset Class - Decommission Before Now

HTTP Request

PUT /api/v1/asset-classes/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions asset classes that were modified before the current date within the financial organization structure, ensuring the hierarchy remains aligned with operational requirements.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAssetClassDto

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",
      "assetId": 0
    }
  ]
}

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

Asset Class - Decommission All

HTTP Request

PUT /api/v1/asset-classes/decommission/bulk

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of asset class identifiers and their corresponding decommissioning details to facilitate bulk updates within the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAssetClassDto

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",
      "assetId": 0
    }
  ]
}

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

Asset Class - Create Or Update Bulk

HTTP Request

PUT /api/v1/asset-classes/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple asset classes within the financial organization structure, enabling efficient management of hierarchical relationships and classifications for financial entities.

Parameters

Name	In	Type	Required	Description
body	body	AssetClassDto	true	Request body containing a bulk array of asset class definitions, including identifiers and attributes, to facilitate the creation or update of financial entity structures within the organization.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "assetId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAssetClassDto

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",
      "assetId": 0
    }
  ]
}

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

Asset Class - Create Or Update

HTTP Request

PUT /api/v1/asset-classes/createOrUpdate

Interactive Demo

📋 Description: Creates or updates asset class information within the financial organization structure, ensuring alignment with the entity’s hierarchy and organizational needs.

Parameters

Name	In	Type	Required	Description
body	body	AssetClassDto	true	Request body containing the asset class details, including identifiers and attributes necessary for creating or updating the financial entity’s organizational structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "assetId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAssetClassDto

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",
    "assetId": 0
  }
}

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

Asset Class - Bulk Update

HTTP Request

PUT /api/v1/asset-classes/bulk

Interactive Demo

📋 Description: Updates multiple asset classes within the financial organization structure, allowing for efficient management and alignment of hierarchical financial entities.

Parameters

Name	In	Type	Required	Description
body	body	AssetClassDto	true	Request body containing a bulk update of asset class information, including identifiers, attributes, and hierarchical relationships relevant to the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "assetId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAssetClassDto

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",
      "assetId": 0
    }
  ]
}

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

Asset Class - Bulk Create

HTTP Request

POST /api/v1/asset-classes/bulk

Interactive Demo

📋 Description: Creates multiple asset classes in bulk for the financial organization structure, enabling efficient management and organization of financial entities within the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	AssetClassDto	true	Request body containing a bulk upload of asset class data, including hierarchical relationships and attributes relevant to the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "assetId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAssetClassDto

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",
      "assetId": 0
    }
  ]
}

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

Asset Class - Bulk Delete

HTTP Request

DELETE /api/v1/asset-classes/bulk

Interactive Demo

📋 Description: Deletes multiple asset classes within the financial organization structure, allowing for efficient management of the hierarchy and organization of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of asset class identifiers to be deleted from the financial organization structure, ensuring the integrity of the entity 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 Class - Search

HTTP Request

POST /api/v1/asset-classes/search

Interactive Demo

📋 Description: Submits a search query to retrieve asset classes within the financial organization structure, enabling users to explore the hierarchy of financial entities effectively.

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	AssetClassDtoFilter	false	Request body containing search criteria for asset classes, including parameters that define the organizational structure and hierarchy of financial entities.

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",
  "assetIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageAssetClassDto

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",
      "assetId": 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

Asset Class - Find All

HTTP Request

GET /api/v1/asset-classes

Interactive Demo

📋 Description: Retrieves a list of asset classes within the financial organization structure, providing insights into the hierarchical classification of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the asset classes retrieval should be paginated, facilitating efficient navigation through the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageAssetClassDto

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",
      "assetId": 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

Asset Class - Create

HTTP Request

POST /api/v1/asset-classes

Interactive Demo

📋 Description: Creates a new asset class within the financial organization structure, enabling the classification and hierarchy management of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	AssetClassDto	true	Request body containing the asset class details, including classification attributes and hierarchical relationships within the financial organization structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "assetId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAssetClassDto

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",
    "assetId": 0
  }
}

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

Asset Class - Get Metadata

HTTP Request

GET /api/v1/asset-classes/meta

Interactive Demo

📋 Description: Retrieves metadata for asset classes within the financial organization structure, providing insights into the hierarchy and classification of financial entities.

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 Class - Find All By System ID

HTTP Request

GET /api/v1/asset-classes/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves detailed information about asset classes associated with a specified ERP system, facilitating insights into the organization’s financial structure and hierarchy.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageAssetClassDto

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",
      "assetId": 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

---