Alternate Exchange Rate

Alternate Exchange Rate - Get

HTTP Request

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

Interactive Demo

📋 Description: Retrieves the alternate exchange rate details for a specified financial entity within the organizational structure, enabling users to understand currency valuation impacts on financial hierarchies.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAlternateExchangeRateDto

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",
    "referenceCurrency": "string"
  }
}

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

Alternate Exchange Rate - Update

HTTP Request

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

Interactive Demo

📋 Description: Updates the alternate exchange rate for a specified financial entity within the organization’s structure, ensuring accurate currency conversion in hierarchical financial operations.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	AlternateExchangeRateDto	true	Request body containing the updated alternate exchange rate data, including the financial entity identifier and relevant hierarchical attributes for the organization structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAlternateExchangeRateDto

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",
    "referenceCurrency": "string"
  }
}

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

Alternate Exchange Rate - Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes a specified alternate exchange rate 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

Alternate Exchange Rate - Delete Or Decommission

HTTP Request

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

Interactive Demo

📋 Description: Removes a specified alternate exchange rate from the financial organization structure, ensuring accurate representation of currency values within the hierarchy of financial entities.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

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

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

Alternate Exchange Rate - Delete Or Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Removes multiple alternate exchange rates in bulk for specified financial entities within the organizational structure, ensuring accurate financial reporting and compliance.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of financial entity identifiers for the bulk removal of alternate 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

Alternate Exchange Rate - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions an alternate exchange rate identified by the specified ID within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures the integrity and accuracy of exchange rate data in the 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	ResponseAlternateExchangeRateDto

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",
    "referenceCurrency": "string"
  }
}

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

Alternate Exchange Rate - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Decommissions alternate exchange rates that were modified before the specified date, ensuring the financial organization structure remains up-to-date and aligned with current operational needs. This operation helps maintain 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 alternate exchange rates within the financial organization structure, ensuring that only rates modified before this date are affected.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAlternateExchangeRateDto

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",
      "referenceCurrency": "string"
    }
  ]
}

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

Alternate Exchange Rate - Decommission Before Now

HTTP Request

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

Interactive Demo

📋 Description: Decommissions alternate exchange rates that were modified before the current timestamp, ensuring the financial organization structure remains up-to-date and accurate. This operation is essential for maintaining the integrity of financial data within the organizational hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAlternateExchangeRateDto

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",
      "referenceCurrency": "string"
    }
  ]
}

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

Alternate Exchange Rate - Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Decommissions multiple alternate exchange rates in bulk for a specified financial entity within the organizational structure, ensuring accurate hierarchy management and compliance with financial regulations.

Parameters

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

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAlternateExchangeRateDto

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",
      "referenceCurrency": "string"
    }
  ]
}

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

Alternate Exchange Rate - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 Description: Updates or creates multiple alternate exchange rates for financial entities within the organization’s structure, ensuring accurate currency conversions across the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	AlternateExchangeRateDto	true	Request body containing bulk data for creating or updating alternate exchange rates, including relevant financial entity identifiers and hierarchical structure details.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAlternateExchangeRateDto

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",
      "referenceCurrency": "string"
    }
  ]
}

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

Alternate Exchange Rate - Create Or Update

HTTP Request

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

Interactive Demo

📋 Description: Creates or updates alternate exchange rates 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	AlternateExchangeRateDto	true	Request body containing the financial entity’s alternate exchange rate data, including relevant organizational hierarchy details for effective structure management.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAlternateExchangeRateDto

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",
    "referenceCurrency": "string"
  }
}

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

Alternate Exchange Rate - Bulk Update

HTTP Request

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

Interactive Demo

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

Parameters

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

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAlternateExchangeRateDto

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",
      "referenceCurrency": "string"
    }
  ]
}

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

Alternate Exchange Rate - Bulk Create

HTTP Request

POST /api/v1/alternate-exchange-rates/bulk

Interactive Demo

📋 Description: Submits bulk alternate exchange rates for multiple financial entities within the organization’s structure, facilitating efficient updates to currency valuation across the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	AlternateExchangeRateDto	true	Request body containing bulk alternate exchange rate data for financial entities within the organizational structure, including relevant currency pairs and rates.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAlternateExchangeRateDto

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",
      "referenceCurrency": "string"
    }
  ]
}

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

Alternate Exchange Rate - Bulk Delete

HTTP Request

DELETE /api/v1/alternate-exchange-rates/bulk

Interactive Demo

📋 Description: Deletes multiple alternate exchange rates in bulk for a specified financial entity within the organizational structure, ensuring efficient management of financial data.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers for the bulk deletion of alternate 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

Alternate Exchange Rate - Search

HTTP Request

POST /api/v1/alternate-exchange-rates/search

Interactive Demo

📋 Description: Submits a request to search for alternate exchange rates within the financial organization structure, enabling users to identify rates applicable to specific financial entities and 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	AlternateExchangeRateDtoFilter	false	Request body containing the financial entity details and hierarchical structure parameters necessary for retrieving alternate exchange rates within the organization.

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",
  "referenceCurrencyLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageAlternateExchangeRateDto

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

Alternate Exchange Rate - Find All

HTTP Request

GET /api/v1/alternate-exchange-rates

Interactive Demo

📋 Description: Retrieves alternate exchange rates for financial entities within the organization structure, enabling users to assess currency values across different hierarchical levels.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing users to retrieve alternate exchange rates in a structured manner that aligns with the financial organization’s hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageAlternateExchangeRateDto

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

Alternate Exchange Rate - Create

HTTP Request

POST /api/v1/alternate-exchange-rates

Interactive Demo

📋 Description: Submits alternate exchange rates for a specified financial entity within the organizational structure, enabling accurate currency conversion across hierarchical levels.

Parameters

Name	In	Type	Required	Description
body	body	AlternateExchangeRateDto	true	Request body containing the alternate exchange rate data for financial entities, including organization hierarchy and structural details.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAlternateExchangeRateDto

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",
    "referenceCurrency": "string"
  }
}

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

Alternate Exchange Rate - Get Metadata

HTTP Request

GET /api/v1/alternate-exchange-rates/meta

Interactive Demo

📋 Description: Retrieves metadata related to alternate 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

[
  "REFERENCE_CURRENCY"
]

Response Schema

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

Alternate Exchange Rate - Find All By System ID

HTTP Request

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

Interactive Demo

📋 Description: Retrieves alternate exchange rates for a specified ERP system, enabling financial entities to access and manage currency valuation within their organizational structure.

Parameters

Name	In	Type	Required	Description
systemId	path	integer(int64)	true	Unique identifier for the system
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing users to efficiently retrieve alternate exchange rates within the specified financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageAlternateExchangeRateDto

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

---