Skip to content

Currency rates

Currency rates allow you to define internal exchange rates between different currencies in use.

Operations

Upload list of currency rates

Request

POST https://api.zoined.com/currencyRates?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
source_currencystringrequired

Source currency as ISO 4217 currency code.

Example:"EUR"
target_currencystringrequired

Target currency as ISO 4217 currency code.

Example:"GBP"
valid_fromstringrequired

First day when the exchange rate is valid

Example:"2017-01-01"
valid_tostringrequired

Last day when the exchange rate is valid

Example:"2017-12-31"
ratenumberrequired

Exchange rate to from source to target currency

Example:0.89
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/currencyRates?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "source_currency": "EUR",
    "target_currency": "GBP",
    "valid_from": "2017-01-01",
    "valid_to": "2017-12-31",
    "rate": 0.89,
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
statusstringrequired

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}