| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
...
Parameters
Name | Type | Description | ||||||
token (mandatory) | String | The token retrieved from the login method | ||||||
currency_identifier (mandatory) | Currency Identifier | 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 |
...
- It is mandatory to specify one of the semi-optional parameters.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
...
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 |
...
- It is mandatory to specify one of the semi-optional parameters.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
...
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:
|
...
- 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. |
...
Parameters
Name | Type | Description | ||||||
token (mandatory) | String | The token retrieved from the login method | ||||||
value (mandatory) | Number | The value in CRM.COM's default currency that will be converted into another currency's value | ||||||
currency_identifier (mandatory) | Currency Identifier | The identifier of the currency to which value will be converted to. The allowed currency identifier fields are the following:
|
...
- It is mandatory to specify one of the semi-optional parameters.
Response Data
Name | Type | Description |
value | Number | The value in the default currency |
| converted_value | Number | The converted value into the required currency |
| 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 of the Currency to which the value in the default currency was converted |
...