Currency

Get A Resource By ID

HTTP Request

GET /api/v1/currencies/{id}

📋 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

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "decimalPoints": 0,
22    "depreciationAreaId": 0
23  }
24}

Update A Resource

HTTP Request

PUT /api/v1/currencies/{id}

📋 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

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "decimalPoints": 0,
 9  "depreciationAreaId": 0
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseCurrencyDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "decimalPoints": 0,
22    "depreciationAreaId": 0
23  }
24}

Delete

HTTP Request

DELETE /api/v1/currencies/{id}

📋 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

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Delete Or Decommission

HTTP Request

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

📋 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

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Delete Or Decommission All

HTTP Request

PUT /api/v1/currencies/remove/bulk

📋 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

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Decommission

HTTP Request

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

📋 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

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "decimalPoints": 0,
22    "depreciationAreaId": 0
23  }
24}

Decommission By Modification Date Before

HTTP Request

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

📋 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

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "decimalPoints": 0,
23      "depreciationAreaId": 0
24    }
25  ]
26}

Decommission Before Now

HTTP Request

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

📋 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

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "decimalPoints": 0,
23      "depreciationAreaId": 0
24    }
25  ]
26}

Decommission All

HTTP Request

PUT /api/v1/currencies/decommission/bulk

📋 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

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListCurrencyDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "decimalPoints": 0,
23      "depreciationAreaId": 0
24    }
25  ]
26}

Bulk Create-Or-Update Resources

HTTP Request

PUT /api/v1/currencies/createOrUpdate/bulk

📋 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

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "decimalPoints": 0,
10    "depreciationAreaId": 0
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListCurrencyDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "decimalPoints": 0,
23      "depreciationAreaId": 0
24    }
25  ]
26}

Create Or Update A Resource

HTTP Request

PUT /api/v1/currencies/createOrUpdate

📋 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

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "decimalPoints": 0,
 9  "depreciationAreaId": 0
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseCurrencyDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "decimalPoints": 0,
22    "depreciationAreaId": 0
23  }
24}

Bulk-Update Resources

HTTP Request

PUT /api/v1/currencies/bulk

📋 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

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "decimalPoints": 0,
10    "depreciationAreaId": 0
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListCurrencyDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "decimalPoints": 0,
23      "depreciationAreaId": 0
24    }
25  ]
26}

Bulk Create

HTTP Request

POST /api/v1/currencies/bulk

📋 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

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "decimalPoints": 0,
10    "depreciationAreaId": 0
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListCurrencyDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "decimalPoints": 0,
23      "depreciationAreaId": 0
24    }
25  ]
26}

Bulk Delete

HTTP Request

DELETE /api/v1/currencies/bulk

📋 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

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Search Resources

HTTP Request

POST /api/v1/currencies/search

📋 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

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "statusEqual": "CREATED",
16  "statusIn": [
17    "CREATED"
18  ],
19  "displayIdIn": [
20    "string"
21  ],
22  "displayIdLike": "string",
23  "erpSystemIdEqual": 0,
24  "erpSystemIdIn": [
25    0
26  ],
27  "erpSystemDisplayIdLike": "string",
28  "uiSelector": "string",
29  "nameLike": "string",
30  "decimalPointsEqual": 0,
31  "depreciationAreaIdEqual": 0
32}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageCurrencyDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "decimalPoints": 0,
27      "depreciationAreaId": 0
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}

List All Resources

HTTP Request

GET /api/v1/currencies

📋 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

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "decimalPoints": 0,
27      "depreciationAreaId": 0
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}

Create

HTTP Request

POST /api/v1/currencies

📋 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

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "decimalPoints": 0,
 9  "depreciationAreaId": 0
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseCurrencyDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "decimalPoints": 0,
22    "depreciationAreaId": 0
23  }
24}

Get Metadata

HTTP Request

GET /api/v1/currencies/meta

📋 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

1[
2  "NAME"
3]

Response Schema

Find All By System ID

HTTP Request

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

📋 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

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "decimalPoints": 0,
27      "depreciationAreaId": 0
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}

Get All By Depreciation Area

HTTP Request

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

📋 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

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "decimalPoints": 0,
27      "depreciationAreaId": 0
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}