| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
GET currencies/show
This method returns information related with a currency. A single currency is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
(mandatory)
...
String
...
The token retrieved from the login method
...
currency_identifier
(mandatory)
...
The identifier of the currency that should be returned as a result. The allowed currency identifier fields are the following:
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Restrictions
- It is mandatory to specify one of the semi-optional parameters.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request:
Response:
|
GET currencies/list
This method returns information regarding all Currencies which are configured in CRM.COM to be set as an accounts receivable's currency. Multiple currencies are returned by each call.
Resource URL
Parameters
Name | Type | Description | ||
token (mandatory) | String | The token retrieved from the login method | ||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request:
Response:
|
GET currencies/convert_to_default_currency
This method accepts a value (price rate, amount) in a currency and converts it into CRM.COM's default currency value. The method uses the effective currency period rate in order to convert the value into the default currency.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
(mandatory)
...
String
...
The token retrieved from the login method
...
value
(mandatory)
...
currency_identifier
(mandatory)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters.
Response Data
...
Name
...
Type
...
Description
value
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request:
Response:
|
GET currencies/convert_from_default_currency
This method accepts a value (price rate, amount) in CRM.COM's default currency and converts it into another currency value. The method uses the effective currency period rate in order to convert the value from the default currency to the required currency.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
(mandatory)
...
String
...
The token retrieved from the login method
...
value
(mandatory)
...
currency_identifier
(mandatory)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters.
Response Data
...
Name
...
Type
...
Description
value
...
Examples
| Expand | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Code Block | ||||||
| ||||||
| Panel | ||||||
| ||||||
|