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) | Number | The value that will be converted into CRM.COM default currency value | |||||||||
currency_identifier (mandatory) | Currency Identifier | The identifier of the provided value's related currency. The allowed currency identifier fields are the following:
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters.
Response Data
Name | Type | Description |
value | Number | The value that was converted into CRM.COM default currency value |
| converted_value | Number | The value converted into default currency value |
| default_currency | Currency Object | CRM.COM's default currency as this is defined in General Settings |
| currency_period_rate | Currency Period Rate Object | The Currency Rate Period which was used in order to convert the provided value into default currency value. |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"data": {
"converted_value": 0.46000000834465027,
"currency_period_rate": {
"from_date": "C7D7ED57F21B47028144967E015DCBE5",
"to_date": 2.3,
"rate": 2.3,
"inverse_rate": 0.23000000417232513,
"currency": {
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"prefix": "£",
"id": "9",
"suffix": null
},
"id": "C7D7ED57F21B47028144967E015DCBE5"
},
"default_currency": {
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"prefix": "€",
"id": "2",
"suffix": null
},
"value": "2"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}