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) | 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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters.
Response Data
Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved currency |
code | String | The code of the currency |
| prefix | String | The prefix symbol for the specified currency |
| suffix | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state of the retrieved currency which can be EFFECTIVE or NOT_EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Log Information Object | The log information related with the retrieved currency |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"data": {
"decimal_part_name": null,
"code": "WRK",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-06-23T08:14:41",
"updated_date": "2016-06-23T08:15:13",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": "-/",
"id": "9867",
"suffix": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
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 |
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
Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved currency |
code | String | The code of the currency |
| prefix | String | The prefix symbol for the specified currency |
| suffix | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state of the retrieved currency which can be EFFECTIVE or NOT_EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Log Information Object | The log information related with the retrieved currency |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"data": [
{
"decimal_part_name": null,
"code": "JMD",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-27T09:28:15",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "20",
"suffix": null
},
{
"decimal_part_name": null,
"code": "FJD",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-27T09:28:15",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "93",
"suffix": null
},
{
"decimal_part_name": null,
"code": "MAD",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "126",
"suffix": null
},
{
"decimal_part_name": null,
"code": "MWK",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "36",
"suffix": null
},
{
"decimal_part_name": null,
"code": "PHP",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "172",
"suffix": null
},
{
"decimal_part_name": null,
"code": "MKD",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "131",
"suffix": null
},
{
"decimal_part_name": null,
"code": "DEM",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "85",
"suffix": null
},
{
"decimal_part_name": null,
"code": "AON",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "50",
"suffix": null
},
{
"decimal_part_name": null,
"code": "FRF",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "94",
"suffix": null
},
{
"decimal_part_name": null,
"code": "GTQ",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "12",
"suffix": null
},
{
"decimal_part_name": null,
"code": "SGD",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "132",
"suffix": null
},
{
"decimal_part_name": null,
"code": "SYP",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "38",
"suffix": null
},
{
"decimal_part_name": null,
"code": "BEF",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "60",
"suffix": null
},
{
"decimal_part_name": null,
"code": "CUP",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "81",
"suffix": null
},
{
"decimal_part_name": null,
"code": "MDL",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "130",
"suffix": null
},
{
"decimal_part_name": null,
"code": "XAF",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "161",
"suffix": null
},
{
"decimal_part_name": null,
"code": "MUR",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "35",
"suffix": null
},
{
"decimal_part_name": null,
"code": "WST",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:52",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "160",
"suffix": null
},
{
"decimal_part_name": null,
"code": "DZD",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:53",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "89",
"suffix": null
},
{
"decimal_part_name": null,
"code": "PLN",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:53",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "174",
"suffix": null
},
{
"decimal_part_name": null,
"code": "RWF",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:53",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "25",
"suffix": null
},
{
"decimal_part_name": null,
"code": "EGP",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:53",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "91",
"suffix": null
},
{
"decimal_part_name": null,
"code": "NLG",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:53",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "44",
"suffix": null
},
{
"decimal_part_name": null,
"code": "AFA",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:53",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "46",
"suffix": null
},
{
"decimal_part_name": null,
"code": "MRO",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:53",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "34",
"suffix": null
},
{
"decimal_part_name": null,
"code": "IRR",
"integer_part_name": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": null,
"updated_date": "2016-06-23T08:17:53",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"prefix": null,
"id": "104",
"suffix": null
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
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": ""
}
}
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) | 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:
|
Restrictions
- 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 |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"data": {
"converted_value": 4.6,
"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": ""
}
}