Currency

Currency - Get

HTTP Request

GET /api/v1/currencies/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific currency within the financial organization structure, identified by its unique ID, to support hierarchical and organizational analysis of financial entities.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCurrencyDto

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

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

Currency - Update

HTTP Request

PUT /api/v1/currencies/{id}

Interactive Demo

📋 Description: Updates the details of a specific currency within the financial organization structure, allowing for adjustments to its attributes as needed to reflect changes in the hierarchy or organizational requirements.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	CurrencyDto	true	Request body containing the updated currency details, including attributes such as name, symbol, and exchange rate, essential for maintaining the financial organization structure and hierarchy.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCurrencyDto

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

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

Currency - Delete

HTTP Request

DELETE /api/v1/currencies/{id}

Interactive Demo

📋 Description: Deletes a specified currency from the financial organization structure, ensuring the integrity of the entity’s hierarchy and organizational framework.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Currency - Delete Or Decommission

HTTP Request

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

Interactive Demo

📋 Description: Removes a specified currency from the financial organization structure, ensuring that the hierarchy reflects only the active 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

Currency - Delete Or Decommission All

HTTP Request

PUT /api/v1/currencies/remove/bulk

Interactive Demo

📋 Description: Removes multiple currency entries from the financial organization structure, ensuring accurate hierarchy management within the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of currency identifiers to be removed in bulk from the financial organization structure, ensuring accurate hierarchy management.

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

Currency - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions a specified currency within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that outdated or unnecessary currencies are no longer utilized in financial transactions and reporting.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCurrencyDto

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

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

Currency - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Decommissions financial entities in the organization structure that have been modified before the specified date, ensuring the hierarchy remains current and aligned with business needs.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning currencies that were modified before the given date, ensuring alignment with the organization’s financial structure and hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCurrencyDto

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

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

Currency - Decommission Before Now

HTTP Request

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

Interactive Demo

📋 Description: Decommissions currencies within the financial organization structure that were modified before the current timestamp, ensuring the hierarchy remains up-to-date and aligned with organizational standards.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCurrencyDto

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

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

Currency - Decommission All

HTTP Request

PUT /api/v1/currencies/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple currency entries in the financial organization structure, ensuring the integrity of the hierarchy and facilitating accurate financial reporting.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of currency identifiers and associated metadata for the bulk decommissioning of financial entities within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCurrencyDto

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

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

Currency - Create Or Update Bulk

HTTP Request

PUT /api/v1/currencies/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple currency records in the financial organization structure, allowing for efficient management of currency data within the entity’s hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	CurrencyDto	true	Request body containing a bulk array of currency data for creating or updating financial entities within the organizational structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCurrencyDto

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

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

Currency - Create Or Update

HTTP Request

PUT /api/v1/currencies/createOrUpdate

Interactive Demo

📋 Description: Creates or updates currency information within the financial organization structure, ensuring accurate representation of financial entities in the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	CurrencyDto	true	Request body containing the financial entity’s currency details, including attributes for creation or updates within the organizational structure and hierarchy.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCurrencyDto

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

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

Currency - Bulk Update

HTTP Request

PUT /api/v1/currencies/bulk

Interactive Demo

📋 Description: Updates multiple currency records in the financial organization structure, allowing for efficient management of currency hierarchies within the entity.

Parameters

Name	In	Type	Required	Description
body	body	CurrencyDto	true	Request body containing a bulk update of currency information, including details on organizational structure and hierarchy for financial entities.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCurrencyDto

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

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

Currency - Bulk Create

HTTP Request

POST /api/v1/currencies/bulk

Interactive Demo

📋 Description: Submits a bulk upload of currency data to the financial organization structure, enabling efficient management of multiple currencies within the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	CurrencyDto	true	Request body containing a collection of currency data for multiple financial entities, structured to facilitate bulk updates within the organization’s financial hierarchy.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCurrencyDto

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

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

Currency - Bulk Delete

HTTP Request

DELETE /api/v1/currencies/bulk

Interactive Demo

📋 Description: Deletes multiple currency entries from the financial organization structure, allowing for streamlined management of currency data within the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of currency identifiers to be deleted from the financial organization’s structure, facilitating the management of the entity’s hierarchical currency configuration.

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

Currency - Search

HTTP Request

POST /api/v1/currencies/search

Interactive Demo

📋 Description: Submits a request to search for currencies within the financial organization structure, enabling users to identify and retrieve relevant currency data based on specified 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	CurrencyDtoFilter	false	Request body containing search criteria for financial entities within the organization’s structure and hierarchy, including parameters such as currency type and region.

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCurrencyDto

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",
      "decimalPoints": 0,
      "depreciationAreaId": 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

Currency - Find All

HTTP Request

GET /api/v1/currencies

Interactive Demo

📋 Description: Retrieves a list of available currencies within the financial organization structure, providing insights into the hierarchical relationships and classifications of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the currency retrieval request should be paginated, facilitating efficient data management within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCurrencyDto

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",
      "decimalPoints": 0,
      "depreciationAreaId": 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

Currency - Create

HTTP Request

POST /api/v1/currencies

Interactive Demo

📋 Description: Creates a new currency entry within the financial organization structure, enabling the establishment of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	CurrencyDto	true	Request body containing the financial entity details necessary for establishing or updating the organizational currency structure within the hierarchy.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCurrencyDto

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

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

Currency - Get Metadata

HTTP Request

GET /api/v1/currencies/meta

Interactive Demo

📋 Description: Retrieves metadata for available currencies within the financial organization structure, providing essential information to support hierarchical and organizational financial entity management.

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

Currency - Find All By System ID

HTTP Request

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

Interactive Demo

📋 Description: Retrieves the currency details associated with a specified ERP system, providing insights into the financial organization structure and hierarchy relevant to the designated 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 results should be returned in a paginated format, facilitating efficient retrieval of financial entity data within the organizational structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCurrencyDto

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",
      "decimalPoints": 0,
      "depreciationAreaId": 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

Currency - Get All By Depreciation Area

HTTP Request

GET /api/v1/currencies/depreciation-area/{id}

Interactive Demo

📋 Description: Retrieves the depreciation area details for a specified financial entity within the organizational structure, providing insights into asset management and financial 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 navigation through the financial organization structure’s depreciation areas.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCurrencyDto

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",
      "decimalPoints": 0,
      "depreciationAreaId": 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

---