Create a file with currency reference rates

To set the reference rates for currencies, you must create a file containing the rates in JSON format. Below, you will find the file's structure, an explanation of its parameters, and a sample file with exchange rates for multiple currencies.

File structure

Here, you will find a JSON file structure.

{
  "rates": [
    {
      "baseCurrencyCode": "EUR",
      "quoteCurrencyCode": "AUD",
      "quotationTime": "2024-12-05T12:30:00Z",
      "rateType": "REPORTING",
      "rateSource": "ECB",
      "rate": 1.6377
    }
  ],
  "skipConfirm": false
}

File parameters

Below, you will find explanations about parameters in the currency reference rates file in JSON format.

  • baseCurrencyCode: The base currency code is the reporting currency, formatted as ISO 4217, e.g., EUR.

  • quoteCurrencyCode: The transaction currency other than reporting currency, formatted as ISO 4217, e.g., AUD.

  • quotationTime: The date the currency rate is between the reporting and transaction currency is applicable, formatted as ISO 8601 DateTime, e.g., 2024-12-05T12:30:00Z.

  • rateType: The parameter defining the rate purpose in the Tuum. The value in the current context must be REPORTING.

  • rateSource: The name or the identification of the entity that has defined the rate quote, e.g., ECB.

  • rate: The exchange rate of the reporting currency to the transaction currency.

  • skipConfirm: The boolean value indicates whether the uploaded exchange rates need confirmation. A value of true means confirmation is not required, while false means it is required.

Sample file

A sample file with the reference rates for multiple currencies is below.

Sample file with all ECB quoted currencies

Last updated

Was this helpful?