API

System APIs

POST system/exchange-rate-sources/{localExchangeRateSourceId}/exchange-rates

Add a new exchange rate to the provided local rate source.

HTTP method POST
URI https://api.rambase.net/system/exchange-rate-sources/{localExchangeRateSourceId}/exchange-rates
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {localExchangeRateSourceId} Local rate source identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 6935, version 8

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<ExchangeRate>
2
     <Date
Date

Date there this exchange rate is valid from

This field is optional.

>{Date}</Date>
3
     <Period
Period

Period this exchange rate is active for

Minimum value: 190000

Maximum value: 299900

This field is optional.

>{Integer}</Period>
4
     <Rate
Rate

Required/mandatory field

Exchange rate for provided exchange rate source and date and currency

Minimum value: 0

>{Decimal}</Rate>
5
     <Currency
Currency

Required/mandatory field

Three-letter alphabetic code of the Currency in the ISO 4217 standard for the local rate source's exchange rate

>
6
          <Code
Code

Required/mandatory field

Three character code following the ISO 4217 standard

>{String}</Code>
7
     </Currency>
8
</ExchangeRate>
1
{
2
     "exchangeRate": {
3
          "date
Date

Date there this exchange rate is valid from

This field is optional.

": "{Date}",
4
          "period
Period

Period this exchange rate is active for

Minimum value: 190000

Maximum value: 299900

This field is optional.

": "{Integer}",
5
          "rate
Rate

Required/mandatory field

Exchange rate for provided exchange rate source and date and currency

Minimum value: 0

": "{Decimal}",
6
          "currency
Currency

Required/mandatory field

Three-letter alphabetic code of the Currency in the ISO 4217 standard for the local rate source's exchange rate

": {
7
               "code
Code

Required/mandatory field

Three character code following the ISO 4217 standard

": "{String}"
8
          }
9
     }
10
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ExchangeRate>
2
     <ExchangeRateId
ExchangeRateId

Exchange rate identifier

>{Integer}</ExchangeRateId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
4
     <Rate
Rate

Exchange rate for provided exchange rate source and date and currency

>{Decimal}</Rate>
5
     <Date
Date

Date there this exchange rate is valid from

>{Date}</Date>
6
     <Currency
Currency

Three-letter alphabetic code of the Currency in the ISO 4217 standard for the local rate source's exchange rate

>
7
          <Code
Code

Three character code following the ISO 4217 standard

>{String}</Code>
8
          <Name
Name

Name/description of currency

>{String}</Name>
9
     </Currency>
10
</ExchangeRate>
1
{
2
     "exchangeRate": {
3
          "exchangeRateId
ExchangeRateId

Exchange rate identifier

": "{Integer}",
4
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
5
          "rate
Rate

Exchange rate for provided exchange rate source and date and currency

": "{Decimal}",
6
          "date
Date

Date there this exchange rate is valid from

": "{Date}",
7
          "currency
Currency

Three-letter alphabetic code of the Currency in the ISO 4217 standard for the local rate source's exchange rate

": {
8
               "code
Code

Three character code following the ISO 4217 standard

": "{String}",
9
               "name
Name

Name/description of currency

": "{String}"
10
          }
11
     }
12
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100184 HTTP 404 Accounting period not found
Error 101420 HTTP 404 Setting definition not found
Error 109877 HTTP 400 Exchange rate is required
Error 103927 HTTP 404 Currency not found
Error 109821 HTTP 400 Exchange rate source already exists
Error 109822 HTTP 400 Effective date cannot be set earlier than tomorrow for local rate source not used for unrealized agio.
Error 109899 HTTP 400 Unrealized agio exchange rates can only created for the past.
Error 109898 HTTP 400 Agio has already been calculated for this period, so you can't save a new unrealized agio exchange rate to it.