Currencies

Endpoints

Get currencies

POST/api/RPC.common.Api.Currencies.get?token=<TOKEN>

Key Currencies.get · Open page

Parameters

6 body parameters inside data[]
FieldTypeDescription
idIntegerCurrency ID
coderequiredStringCurrency code
namerequiredStringCurrency name
get_allBooleanGet all
offsetNumberOffset
limitNumberLimit

Request example

Search By Id:
{
   "data" : [
      {
         "id" : 2980893
      }
   ]
}
Search By Code:
{
   "data" : [
      {
         "code" : "GBP"
      }
   ]
}
Search By Name:
{
   "data" : [
      {
         "name" : "British pound"
      }
   ]
}
Search By All Params:
{
   "data" : [
      {
         "id" : 2980893,
         "name" : "British pound",
         "code" : "GBP"
      }
   ]
}
Get All:
{
	"data":[
		{}
	],
	"get_all":1,
	"limit":10000,
	"offset":0
}

cURL

Search By Id:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "id" : 2980893      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Currencies.get?token=<TOKEN>"
Search By Code:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "code" : "GBP"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Currencies.get?token=<TOKEN>"
Search By Name:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "name" : "British pound"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Currencies.get?token=<TOKEN>"
Search By All Params:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "id" : 2980893,         "name" : "British pound",         "code" : "GBP"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Currencies.get?token=<TOKEN>"
Curl example Get All:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{	"data":[		{}	],	"get_all":1,	"limit":10000,	"offset":0}	' "https://<DOMAIN_NAME>/api/RPC.common.Api.Currencies.get?token=<TOKEN>"

Response example

    HTTP/1.1 200 OK
{
   "result" : [
      {
         "name" : "British pound",
         "id" : 2980893,
         "code" : "GBP"
      }
   ],
   "total_count" : 1,
   "count" : 1
}