Sales APIs
Creates a new exchange rate agreement for customer
| HTTP method | POST |
| URI | https://api.rambase.net/sales/customers/{customerId}/exchange-rate-agreements |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {customerId} |
Customer identifier
Integer, minimum 10000 |
| Successful HTTP status code | 201 |
| API resource identifier | 2237, version 1 |
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.
SalesCurrency
Required/mandatory field
This exchange rate agreement applies when the customer is ordering/quoting in this currency
Input must match the following regular expression pattern: ^[A-Z]{3}$
>{String}</SalesCurrency>PurchaseCurrency
Required/mandatory field
This exchange rate agreement applies when the company is purchasing in this currency
Input must match the following regular expression pattern: ^[A-Z]{3}$
>{String}</PurchaseCurrency>ExchangeRate
Required/mandatory field
The fixed exchange rate for the exchange rate agreeement. This exchange rate will be used as default for all sales orders, sales invoices and sales objects for the given customer, sales currency and purchase currency.
>{Decimal}</ExchangeRate>SalesCurrency
Required/mandatory field
This exchange rate agreement applies when the customer is ordering/quoting in this currency
Input must match the following regular expression pattern: ^[A-Z]{3}$
": "{String}",PurchaseCurrency
Required/mandatory field
This exchange rate agreement applies when the company is purchasing in this currency
Input must match the following regular expression pattern: ^[A-Z]{3}$
": "{String}",ExchangeRate
Required/mandatory field
The fixed exchange rate for the exchange rate agreeement. This exchange rate will be used as default for all sales orders, sales invoices and sales objects for the given customer, sales currency and purchase currency.
": "{Decimal}"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.
ExchangeRateAgreementId
Exchange rate agreement identifier
>{Integer}</ExchangeRateAgreementId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>SalesCurrency
This exchange rate agreement applies when the customer is ordering/quoting in this currency
>{String}</SalesCurrency>PurchaseCurrency
This exchange rate agreement applies when the company is purchasing in this currency
>{String}</PurchaseCurrency>ExchangeRate
The fixed exchange rate for the exchange rate agreeement. This exchange rate will be used as default for all sales orders, sales invoices and sales objects for the given customer, sales currency and purchase currency.
>{Decimal}</ExchangeRate>ExchangeRateAgreementId
Exchange rate agreement identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",SalesCurrency
This exchange rate agreement applies when the customer is ordering/quoting in this currency
": "{String}",PurchaseCurrency
This exchange rate agreement applies when the company is purchasing in this currency
": "{String}",ExchangeRate
The fixed exchange rate for the exchange rate agreeement. This exchange rate will be used as default for all sales orders, sales invoices and sales objects for the given customer, sales currency and purchase currency.
": "{Decimal}"
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 102057 HTTP 400 | Sales currency and purchase currency can not be equal |
| Error 101997 HTTP 400 | The sales currency is not supported by this customer |
| Error 101998 HTTP 400 | An exchange rate agreement, with this combination of currencies, already exists. |
| Error 101995 HTTP 400 | Exchange rate is required |