Exchange Rate

Exchange Rate - Get

HTTP Request

GET /api/v1/exchange-rates/{id}

Interactive Demo

📋 Description: Retrieves the exchange rate details for a specified financial entity within the organization’s structure, facilitating informed decision-making regarding currency transactions.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseExchangeRateDto

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",
    "validFrom": "2019-08-24",
    "rate": 0,
    "fromFactor": 0,
    "toFactor": 0,
    "indirectExchangeRate": 0,
    "indirectFromFactor": 0,
    "indirectToFactor": 0,
    "exchangeRateType": "string",
    "alternateExchangeRateType": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string"
  }
}

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

Exchange Rate - Update

HTTP Request

PUT /api/v1/exchange-rates/{id}

Interactive Demo

📋 Description: Updates the exchange rate details for a specified financial entity within the organizational structure, ensuring accurate representation of currency values in hierarchical financial reporting.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ExchangeRateDto	true	Request body containing the updated exchange rate information, including the financial entity’s identifier, effective date, and applicable currency details, to ensure accurate representation within the organizational structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "validFrom": "2019-08-24",
  "rate": 0,
  "fromFactor": 0,
  "toFactor": 0,
  "indirectExchangeRate": 0,
  "indirectFromFactor": 0,
  "indirectToFactor": 0,
  "exchangeRateType": "string",
  "alternateExchangeRateType": "string",
  "fromCurrencyId": 0,
  "fromCurrencyDisplayId": "string",
  "toCurrencyId": 0,
  "toCurrencyDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseExchangeRateDto

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",
    "validFrom": "2019-08-24",
    "rate": 0,
    "fromFactor": 0,
    "toFactor": 0,
    "indirectExchangeRate": 0,
    "indirectFromFactor": 0,
    "indirectToFactor": 0,
    "exchangeRateType": "string",
    "alternateExchangeRateType": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string"
  }
}

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

Exchange Rate - Delete

HTTP Request

DELETE /api/v1/exchange-rates/{id}

Interactive Demo

📋 Description: Deletes a specified exchange rate from the financial organization structure, ensuring the integrity of the hierarchy and data management 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

Exchange Rate - Delete Or Decommission

HTTP Request

PUT /api/v1/exchange-rates/remove/{id}

Interactive Demo

📋 Description: Removes a specified exchange rate from the financial organization structure, ensuring the integrity of the hierarchy within the financial entity. This operation is essential for maintaining accurate and up-to-date financial data management.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Exchange Rate - Delete Or Decommission All

HTTP Request

PUT /api/v1/exchange-rates/remove/bulk

Interactive Demo

📋 Description: Removes multiple exchange rates from the financial organization structure, allowing for streamlined management of financial entities within the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers for bulk removal of exchange rates within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Exchange Rate - Decommission

HTTP Request

PUT /api/v1/exchange-rates/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified exchange rate within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that outdated or irrelevant exchange rates are no longer utilized in financial transactions.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseExchangeRateDto

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",
    "validFrom": "2019-08-24",
    "rate": 0,
    "fromFactor": 0,
    "toFactor": 0,
    "indirectExchangeRate": 0,
    "indirectFromFactor": 0,
    "indirectToFactor": 0,
    "exchangeRateType": "string",
    "alternateExchangeRateType": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string"
  }
}

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

Exchange Rate - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/exchange-rates/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions exchange rates that have been modified before the specified date, ensuring the financial organization structure remains current and accurate. This operation aids in maintaining the integrity of financial entity hierarchies by removing outdated data.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning exchange rates, allowing financial entities to manage their organizational structure and hierarchy effectively.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListExchangeRateDto

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",
      "validFrom": "2019-08-24",
      "rate": 0,
      "fromFactor": 0,
      "toFactor": 0,
      "indirectExchangeRate": 0,
      "indirectFromFactor": 0,
      "indirectToFactor": 0,
      "exchangeRateType": "string",
      "alternateExchangeRateType": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string"
    }
  ]
}

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

Exchange Rate - Decommission Before Now

HTTP Request

PUT /api/v1/exchange-rates/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions exchange rates that were modified before the current date, ensuring the financial organization structure remains up-to-date and aligned with hierarchical changes within the entity.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListExchangeRateDto

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",
      "validFrom": "2019-08-24",
      "rate": 0,
      "fromFactor": 0,
      "toFactor": 0,
      "indirectExchangeRate": 0,
      "indirectFromFactor": 0,
      "indirectToFactor": 0,
      "exchangeRateType": "string",
      "alternateExchangeRateType": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string"
    }
  ]
}

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

Exchange Rate - Decommission All

HTTP Request

PUT /api/v1/exchange-rates/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple exchange rates in bulk for a specified financial organization, ensuring the integrity 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 entity identifiers and associated decommissioning details for bulk processing within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListExchangeRateDto

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",
      "validFrom": "2019-08-24",
      "rate": 0,
      "fromFactor": 0,
      "toFactor": 0,
      "indirectExchangeRate": 0,
      "indirectFromFactor": 0,
      "indirectToFactor": 0,
      "exchangeRateType": "string",
      "alternateExchangeRateType": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string"
    }
  ]
}

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

Exchange Rate - Create Or Update Bulk

HTTP Request

PUT /api/v1/exchange-rates/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple exchange rate entries in bulk for financial entities within the organizational structure, ensuring accurate and consistent financial data across the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	ExchangeRateDto	true	Request body containing a bulk array of exchange rate data for financial entities, including relevant identifiers and values to facilitate the creation or update of organizational financial structures.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "validFrom": "2019-08-24",
    "rate": 0,
    "fromFactor": 0,
    "toFactor": 0,
    "indirectExchangeRate": 0,
    "indirectFromFactor": 0,
    "indirectToFactor": 0,
    "exchangeRateType": "string",
    "alternateExchangeRateType": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListExchangeRateDto

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",
      "validFrom": "2019-08-24",
      "rate": 0,
      "fromFactor": 0,
      "toFactor": 0,
      "indirectExchangeRate": 0,
      "indirectFromFactor": 0,
      "indirectToFactor": 0,
      "exchangeRateType": "string",
      "alternateExchangeRateType": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string"
    }
  ]
}

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

Exchange Rate - Create Or Update

HTTP Request

PUT /api/v1/exchange-rates/createOrUpdate

Interactive Demo

📋 Description: Updates or creates exchange rate entries within the financial organization structure, ensuring accurate representation of currency values across the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ExchangeRateDto	true	Request body containing the exchange rate data, including financial entity identifiers and hierarchical structure details for creating or updating exchange rates within the organization.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "validFrom": "2019-08-24",
  "rate": 0,
  "fromFactor": 0,
  "toFactor": 0,
  "indirectExchangeRate": 0,
  "indirectFromFactor": 0,
  "indirectToFactor": 0,
  "exchangeRateType": "string",
  "alternateExchangeRateType": "string",
  "fromCurrencyId": 0,
  "fromCurrencyDisplayId": "string",
  "toCurrencyId": 0,
  "toCurrencyDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseExchangeRateDto

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",
    "validFrom": "2019-08-24",
    "rate": 0,
    "fromFactor": 0,
    "toFactor": 0,
    "indirectExchangeRate": 0,
    "indirectFromFactor": 0,
    "indirectToFactor": 0,
    "exchangeRateType": "string",
    "alternateExchangeRateType": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string"
  }
}

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

Exchange Rate - Bulk Update

HTTP Request

PUT /api/v1/exchange-rates/bulk

Interactive Demo

📋 Description: Updates multiple exchange rates in bulk for financial entities within the organization’s structure, ensuring accurate and consistent currency values across the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	ExchangeRateDto	true	Request body containing a bulk update of exchange rate data for financial entities within the organizational structure, including currency pairs and their corresponding rates.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "validFrom": "2019-08-24",
    "rate": 0,
    "fromFactor": 0,
    "toFactor": 0,
    "indirectExchangeRate": 0,
    "indirectFromFactor": 0,
    "indirectToFactor": 0,
    "exchangeRateType": "string",
    "alternateExchangeRateType": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListExchangeRateDto

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",
      "validFrom": "2019-08-24",
      "rate": 0,
      "fromFactor": 0,
      "toFactor": 0,
      "indirectExchangeRate": 0,
      "indirectFromFactor": 0,
      "indirectToFactor": 0,
      "exchangeRateType": "string",
      "alternateExchangeRateType": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string"
    }
  ]
}

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

Exchange Rate - Bulk Create

HTTP Request

POST /api/v1/exchange-rates/bulk

Interactive Demo

📋 Description: Submits a bulk request to update or create exchange rates for multiple financial entities within the organizational structure, ensuring accurate currency conversion across the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	ExchangeRateDto	true	Request body containing a collection of exchange rate data for multiple financial entities within the organizational structure, facilitating bulk updates to the hierarchy of financial transactions.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "validFrom": "2019-08-24",
    "rate": 0,
    "fromFactor": 0,
    "toFactor": 0,
    "indirectExchangeRate": 0,
    "indirectFromFactor": 0,
    "indirectToFactor": 0,
    "exchangeRateType": "string",
    "alternateExchangeRateType": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListExchangeRateDto

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",
      "validFrom": "2019-08-24",
      "rate": 0,
      "fromFactor": 0,
      "toFactor": 0,
      "indirectExchangeRate": 0,
      "indirectFromFactor": 0,
      "indirectToFactor": 0,
      "exchangeRateType": "string",
      "alternateExchangeRateType": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "string"
    }
  ]
}

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

Exchange Rate - Bulk Delete

HTTP Request

DELETE /api/v1/exchange-rates/bulk

Interactive Demo

📋 Description: Deletes multiple exchange rate entries in bulk for a specified financial entity within the organizational structure, ensuring streamlined management of financial data.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing identifiers for multiple exchange rates to be deleted, relevant to the financial organization’s hierarchical structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Exchange Rate - Search

HTTP Request

POST /api/v1/exchange-rates/search

Interactive Demo

📋 Description: Submits a request to search for exchange rates within the financial organization structure, allowing users to identify rates relevant to specific entities or hierarchies.

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	ExchangeRateDtoFilter	false	Request body containing the search criteria for exchange rates, including parameters related to the financial organization structure and hierarchy.

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",
  "validFromGreaterThanOrEqual": "2019-08-24",
  "validFromLessThanOrEqual": "2019-08-24",
  "validFromEqual": "2019-08-24",
  "rateLike": "string",
  "fromFactorLike": "string",
  "toFactorLike": "string",
  "indirectExchangeRateLike": "string",
  "indirectFromFactorLike": "string",
  "indirectToFactorLike": "string",
  "exchangeRateTypeLike": "string",
  "alternateExchangeRateTypeLike": "string",
  "fromCurrencyIdEqual": 0,
  "fromCurrencyDisplayIdLike": "string",
  "toCurrencyIdEqual": 0,
  "toCurrencyDisplayIdLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageExchangeRateDto

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",
      "validFrom": "2019-08-24",
      "rate": 0,
      "fromFactor": 0,
      "toFactor": 0,
      "indirectExchangeRate": 0,
      "indirectFromFactor": 0,
      "indirectToFactor": 0,
      "exchangeRateType": "string",
      "alternateExchangeRateType": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "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

Exchange Rate - Detach To Currency

HTTP Request

POST /api/v1/exchange-rates/detach/to-currency/{to_currency_id}

Interactive Demo

📋 Description: Detaches a specified currency from the financial organization structure, facilitating the management of exchange rates within the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
to_currency_id	path	integer(int64)	true	Unique identifier for the target currency in the financial organization structure, used to detach exchange rate associations.
body	body	ExchangeRateDto	true	Request body containing the financial entity details necessary to detach the specified currency from the organization’s exchange rate hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "validFrom": "2019-08-24",
    "rate": 0,
    "fromFactor": 0,
    "toFactor": 0,
    "indirectExchangeRate": 0,
    "indirectFromFactor": 0,
    "indirectToFactor": 0,
    "exchangeRateType": "string",
    "alternateExchangeRateType": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "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

Exchange Rate - Detach From Currency

HTTP Request

POST /api/v1/exchange-rates/detach/from-currency/{currency_id}

Interactive Demo

📋 Description: Detaches the specified currency from the financial organization’s exchange rate hierarchy, allowing for adjustments in the organizational structure of financial entities. This operation is essential for maintaining accurate and relevant currency relationships within the organization’s financial framework.

Parameters

Name	In	Type	Required	Description
currency_id	path	integer(int64)	true	Unique identifier for the currency to be detached from the financial organization’s structure, facilitating the management of exchange rates within the hierarchy.
body	body	ExchangeRateDto	true	Request body containing the details required to detach a specified currency from the financial organization’s exchange rate structure, including relevant identifiers and metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "validFrom": "2019-08-24",
    "rate": 0,
    "fromFactor": 0,
    "toFactor": 0,
    "indirectExchangeRate": 0,
    "indirectFromFactor": 0,
    "indirectToFactor": 0,
    "exchangeRateType": "string",
    "alternateExchangeRateType": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "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

Exchange Rate - Attach To Currency

HTTP Request

POST /api/v1/exchange-rates/attach/to-currency/{to_currency_id}

Interactive Demo

📋 Description: Attaches exchange rate information to a specified currency within the financial organization structure, facilitating accurate currency conversion and financial reporting across the entity’s hierarchy.

Parameters

Name	In	Type	Required	Description
to_currency_id	path	integer(int64)	true	Unique identifier for the target currency in the financial organization structure, used to specify the currency for which exchange rates are being attached.
body	body	ExchangeRateDto	true	Request body containing the exchange rate details to be attached to the specified currency, including relevant financial entity identifiers and hierarchical structure information.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "validFrom": "2019-08-24",
    "rate": 0,
    "fromFactor": 0,
    "toFactor": 0,
    "indirectExchangeRate": 0,
    "indirectFromFactor": 0,
    "indirectToFactor": 0,
    "exchangeRateType": "string",
    "alternateExchangeRateType": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "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

Exchange Rate - Attach From Currency

HTTP Request

POST /api/v1/exchange-rates/attach/from-currency/{from_currency_id}

Interactive Demo

📋 Description: Attaches exchange rate data to a specified currency within the financial organization structure, enabling accurate currency conversion and reporting across the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
from_currency_id	path	integer(int64)	true	Unique identifier for the originating currency in the financial organization structure, used to specify the currency from which exchange rates are derived.
body	body	ExchangeRateDto	true	Request body containing the exchange rate attachment data, including the financial entity details and hierarchical structure associated with the specified ‘from_currency_id’.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "validFrom": "2019-08-24",
    "rate": 0,
    "fromFactor": 0,
    "toFactor": 0,
    "indirectExchangeRate": 0,
    "indirectFromFactor": 0,
    "indirectToFactor": 0,
    "exchangeRateType": "string",
    "alternateExchangeRateType": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "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

Exchange Rate - Find All

HTTP Request

GET /api/v1/exchange-rates

Interactive Demo

📋 Description: Retrieves current exchange rates for financial entities within the organization’s structure, enabling users to assess currency values in relation to the hierarchical financial framework.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating the retrieval of exchange rate data in a structured manner for efficient financial analysis within the organization.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageExchangeRateDto

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",
      "validFrom": "2019-08-24",
      "rate": 0,
      "fromFactor": 0,
      "toFactor": 0,
      "indirectExchangeRate": 0,
      "indirectFromFactor": 0,
      "indirectToFactor": 0,
      "exchangeRateType": "string",
      "alternateExchangeRateType": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "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

Exchange Rate - Create

HTTP Request

POST /api/v1/exchange-rates

Interactive Demo

📋 Description: Submits new exchange rate data for financial entities within the organization’s structure, enabling accurate currency conversions and financial reporting across the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	ExchangeRateDto	true	Request body containing the exchange rate data, including the financial entity identifiers and hierarchical structure necessary for accurate currency conversion within the organization.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "validFrom": "2019-08-24",
  "rate": 0,
  "fromFactor": 0,
  "toFactor": 0,
  "indirectExchangeRate": 0,
  "indirectFromFactor": 0,
  "indirectToFactor": 0,
  "exchangeRateType": "string",
  "alternateExchangeRateType": "string",
  "fromCurrencyId": 0,
  "fromCurrencyDisplayId": "string",
  "toCurrencyId": 0,
  "toCurrencyDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseExchangeRateDto

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",
    "validFrom": "2019-08-24",
    "rate": 0,
    "fromFactor": 0,
    "toFactor": 0,
    "indirectExchangeRate": 0,
    "indirectFromFactor": 0,
    "indirectToFactor": 0,
    "exchangeRateType": "string",
    "alternateExchangeRateType": "string",
    "fromCurrencyId": 0,
    "fromCurrencyDisplayId": "string",
    "toCurrencyId": 0,
    "toCurrencyDisplayId": "string"
  }
}

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

Exchange Rate - Get All By To Currency

HTTP Request

GET /api/v1/exchange-rates/to-currency/{to_currency_id}

Interactive Demo

📋 Description: Retrieves the current exchange rate for a specified currency, facilitating financial transactions and reporting within the organizational structure.

Parameters

Name	In	Type	Required	Description
to_currency_id	path	integer(int64)	true	Unique identifier for the target currency in the exchange rate retrieval process, facilitating accurate financial transactions within the organization’s structure.
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating the retrieval of exchange rates in a structured manner for financial entities within the organization.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageExchangeRateDto

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",
      "validFrom": "2019-08-24",
      "rate": 0,
      "fromFactor": 0,
      "toFactor": 0,
      "indirectExchangeRate": 0,
      "indirectFromFactor": 0,
      "indirectToFactor": 0,
      "exchangeRateType": "string",
      "alternateExchangeRateType": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "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

Exchange Rate - Get Metadata

HTTP Request

GET /api/v1/exchange-rates/meta

Interactive Demo

📋 Description: Retrieves metadata related to exchange rates within the financial organization structure, providing insights into the hierarchy and relationships of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "VALID_FROM"
]

Response Schema

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

Exchange Rate - Get All By From Currency

HTTP Request

GET /api/v1/exchange-rates/from-currency/{currency_id}

Interactive Demo

📋 Description: Retrieves the current exchange rates for a specified currency, enabling financial entities to assess currency values within their organizational structure and hierarchy.

Parameters

Name	In	Type	Required	Description
currency_id	path	integer(int64)	true	Unique identifier for the currency from which exchange rates are retrieved, facilitating accurate financial transactions within the organizational structure.
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing users to efficiently retrieve exchange rate data for a specified currency within the financial organization’s structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageExchangeRateDto

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",
      "validFrom": "2019-08-24",
      "rate": 0,
      "fromFactor": 0,
      "toFactor": 0,
      "indirectExchangeRate": 0,
      "indirectFromFactor": 0,
      "indirectToFactor": 0,
      "exchangeRateType": "string",
      "alternateExchangeRateType": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "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

Exchange Rate - Find All By System ID

HTTP Request

GET /api/v1/exchange-rates/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves the current exchange rates for a specified ERP system, facilitating financial entity operations within the organization’s 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 of the exchange rates query should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageExchangeRateDto

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",
      "validFrom": "2019-08-24",
      "rate": 0,
      "fromFactor": 0,
      "toFactor": 0,
      "indirectExchangeRate": 0,
      "indirectFromFactor": 0,
      "indirectToFactor": 0,
      "exchangeRateType": "string",
      "alternateExchangeRateType": "string",
      "fromCurrencyId": 0,
      "fromCurrencyDisplayId": "string",
      "toCurrencyId": 0,
      "toCurrencyDisplayId": "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

---