v1

latestOpenAPI 3.0.0CoreStack Inc License2026-07-248001,5071.7 MB
CurrencyExchangeConfiguration

Create Currency Exchange Configuration

Create Currency Exchange Configuration.

post/v1/currency_exchange_configuration/create

Request body

sysIdstring

ID of the Currency Configuration component

created_atstring date-time

Created datetime for the component

updated_atstring date-time

Updated datetime for the component

created_bystring

Created by user name

updated_bystring

Updated by user name

master_account_idstring

Master account ID

tenant_idsstring[]
namestring required

Name of Currency Exchange Configuration

descriptionstring

Description of Currency Exchange Configuration

conversion_type'CustomExchangeRate' | 'DynamicExchangeRate' | 'CsvFileCustomExchangeRate' required

Conversion type of currency exchange configuration.

target_currency'AED' | 'ALL' | 'ARS' | 'AUD' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BRL' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MOP' | 'MVR' | 'MXN' | 'MYR' | 'NOK' | 'NZD' | 'OMR' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'USD' | 'VND' | 'ZAR' required

Target Currency for Exchange Configuration

is_enabledboolean required

Is currency exchange enabled

scope'Account' | 'Tenant' required

Scope of currency exchange configuration.

Example request

{
  "configurations": [
    {
      "currency_rate": [
        {
          "source_currency": "AED"
        }
      ]
    }
  ],
  "conversion_type": "CustomExchangeRate",
  "target_currency": "AED",
  "scope": "Account"
}

Response

Created successfully

sysIdstring

ID of the Currency Configuration component

created_atstring date-time

Created datetime for the component

updated_atstring date-time

Updated datetime for the component

created_bystring

Created by user name

updated_bystring

Updated by user name

master_account_idstring

Master account ID

tenant_idsstring[]
namestring required

Name of Currency Exchange Configuration

descriptionstring

Description of Currency Exchange Configuration

conversion_type'CustomExchangeRate' | 'DynamicExchangeRate' | 'CsvFileCustomExchangeRate' required

Conversion type of currency exchange configuration.

target_currency'AED' | 'ALL' | 'ARS' | 'AUD' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BRL' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MOP' | 'MVR' | 'MXN' | 'MYR' | 'NOK' | 'NZD' | 'OMR' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'USD' | 'VND' | 'ZAR' required

Target Currency for Exchange Configuration

is_enabledboolean required

Is currency exchange enabled

scope'Account' | 'Tenant' required

Scope of currency exchange configuration.

Example response

{
  "configurations": [
    {
      "currency_rate": [
        {
          "source_currency": "AED"
        }
      ]
    }
  ],
  "conversion_type": "CustomExchangeRate",
  "target_currency": "AED",
  "scope": "Account"
}