POST customexchangerates

Add a custom exchange rate

Request Information

URI Parameters

None.

Body Parameters

The parameters required to create a new custom exchange rate

ExchangeRateCreateUpdateModel
NameDescriptionTypeAdditional information
From The ISO currency code to convert from string Required
To The ISO currency code to convert to string Required
CustomRate The exchange rate, can be altered per account decimal number Required Range: inclusive between 0 and 1000000
OverheadPercent The overhead percentage cost decimal number Required Range: inclusive between 0 and 1000000

Request Formats

application/json, text/json

Sample: 
{
  "From": "GBP",
  "To": "DKK",
  "CustomRate": 34.1,
  "OverheadPercent": 2.0
}

application/xml, text/xml

Sample: 
<ExchangeRateCreateUpdateModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <From>GBP</From>
  <To>DKK</To>
  <CustomRate>34.1</CustomRate>
  <OverheadPercent>2</OverheadPercent>
</ExchangeRateCreateUpdateModel>

Response Information

Resource Description

Add a custom exchange rate

ExchangeRateModel
NameDescriptionTypeAdditional information
ID The ID of the exchange rate integer None.
CurrencyCodeFrom The ISO currency code being converted from string None.
CurrencyCodeTo The ISO currency code being converted to string None.
CurrencyFrom The currency being converted from string None.
CurrencyTo The currency being converted to string None.
CustomRate The user defined exchange rate decimal number None.
Rate The system exchange rate decimal number None.
LastUpdated The last time the exchange rate was updated via external API date None.
OverheadPercent Optional extra percentage cost that can be applied decimal number None.

Response Formats

application/json, text/json

Sample: 
{
  "ID": 1,
  "CurrencyCodeFrom": "GBP",
  "CurrencyCodeTo": "DKK",
  "CurrencyFrom": "British Pound",
  "CurrencyTo": "Danish Krone",
  "CustomRate": 14.3,
  "Rate": 8.43,
  "LastUpdated": "2024-11-21T08:00:52.0638255+00:00",
  "OverheadPercent": 1.3
}

application/xml, text/xml

Sample: 
<ExchangeRateModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <CurrencyCodeFrom>GBP</CurrencyCodeFrom>
  <CurrencyCodeTo>DKK</CurrencyCodeTo>
  <CurrencyFrom>British Pound</CurrencyFrom>
  <CurrencyTo>Danish Krone</CurrencyTo>
  <CustomRate>14.3</CustomRate>
  <Rate>8.43</Rate>
  <LastUpdated>2024-11-21T08:00:52.0638255+00:00</LastUpdated>
  <OverheadPercent>1.3</OverheadPercent>
</ExchangeRateModel>