Get Currencies
Purpose
To get all the available currencies in your organization.
Request Details
Request URL
{api-domain}/crm/v2/org/currencies
To get a specific currency:
{api-domain}/crm/v2/org/currencies/{currency_ID}
Header
Authorization: Zoho-oauthtoken 100xx.d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.currencies.{operation_type}
Possible operation types
READ - Get currencies data
Sample Request
Copiedcurl "https://zylkercorp.zohoplatform.com/crm/v2/org/currencies"
-X GET
-H "Authorization: Zoho-oauthtoken 100xx.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copied//Get instance of CurrenciesOperations Class
let currenciesOperations = new ZCRM.Currency.Operations();
//Call getCurrencies method
let response = await currenciesOperations.getCurrencies();
Copiedvar listener = 0;
class GetCurrencies {
async getCurrencies() {
var url = "https://zylkercorp.zohoplatform.com/crm/v2/org/currencies"
var parameters = new Map()
var headers = new Map()
var token = {
clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl:"http://127.0.0.1:5500/redirect.html",
scope:"ZohoCRM.settings.currencies.UPDATE,ZohoCRM.settings.currencies.Read,ZohoCRM.settings.currencies.CREATE,ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
}
var accesstoken = await new GetCurrencies().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
var requestMethod = "GET"
var reqBody = null
var params = "";
parameters.forEach(function(value, key) {
if (parameters.has(key)) {
if (params) {
params = params + key + '=' + value + '&';
}
else {
params = key + '=' + value + '&';
}
}
});
var apiHeaders = {};
if(headers) {
headers.forEach(function(value, key) {
apiHeaders[key] = value;
});
}
if (params.length > 0){
url = url + '?' + params.substring(0, params.length - 1);
}
var requestObj = {
uri : url,
method : requestMethod,
headers : apiHeaders,
body : JSON.stringify(reqBody),
encoding: "utf8",
allowGetBody : true,
throwHttpErrors : false
};
var result = await new GetCurrencies().makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
}
async getCurrency() {
var url = "https://zylkercorp.zohoplatform.com/crm/v2/org/currencies/34770617368016"
var parameters = new Map()
var headers = new Map()
var token = {
clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl:"http://127.0.0.1:5500/redirect.html",
scope:"ZohoCRM.settings.currencies.UPDATE,ZohoCRM.settings.currencies.Read,ZohoCRM.settings.currencies.CREATE,ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
}
var accesstoken = await new GetCurrencies().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
var requestMethod = "GET"
var reqBody = null
var params = "";
parameters.forEach(function(value, key) {
if (parameters.has(key)) {
if (params) {
params = params + key + '=' + value + '&';
}
else {
params = key + '=' + value + '&';
}
}
});
var apiHeaders = {};
if(headers) {
headers.forEach(function(value, key) {
apiHeaders[key] = value;
});
}
if (params.length > 0){
url = url + '?' + params.substring(0, params.length - 1);
}
var requestObj = {
uri : url,
method : requestMethod,
headers : apiHeaders,
body : JSON.stringify(reqBody),
encoding: "utf8",
allowGetBody : true,
throwHttpErrors : false
};
var result = await new GetCurrencies().makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
}
async getToken(token) {
if(listener == 0) {
window.addEventListener("storage", function(reponse) {
if(reponse.key === "access_token" && (reponse.oldValue != reponse.newValue || reponse.oldValue == null)){
location.reload();
}
if(reponse.key === "access_token"){
sessionStorage.removeItem("__auth_process");
}
}, false);
listener = 1;
if(sessionStorage.getItem("__auth_process")) {
sessionStorage.removeItem("__auth_process");
}
}
["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
var isKeyExists = localStorage.hasOwnProperty(k);
if(isKeyExists) {
sessionStorage.setItem(k, localStorage[k]);
}
localStorage.removeItem(k);
});
var valueInStore = sessionStorage.getItem("access_token");
var tokenInit = sessionStorage.getItem("__token_init");
if(tokenInit != null && valueInStore != null && Date.now() >= parseInt(tokenInit) + 59 * 60 * 1000){ // check after 59th minute
valueInStore = null;
sessionStorage.removeItem("access_token");
}
var auth_process = sessionStorage.getItem("__auth_process");
if ((valueInStore == null && auth_process == null) || (valueInStore == 'undefined' && (auth_process == null || auth_process == "true"))) {
var accountsUrl = "https://zylkercorp.zohoplatform.com/oauth/v2/auth"
var clientId;
var scope;
var redirectUrl;
if(token != null) {
clientId = token.clientId;
scope = token.scope;
redirectUrl = token.redirectUrl;
}
var fullGrant = sessionStorage.getItem("full_grant");
var grantedForSession = sessionStorage.getItem("granted_for_session");
if(sessionStorage.getItem("__token_init") != null && ((fullGrant != null && "true" == full_grant) || (grantedForSession != null && "true" == grantedForSession))) {
accountsUrl += '/refresh';
}
if (clientId && scope) {
sessionStorage.setItem("__token_init", Date.now());
sessionStorage.removeItem("access_token");
sessionStorage.setItem("__auth_process", "true");
window.open(accountsUrl + "?" + "scope" + "=" + scope + "&"+ "client_id" +"=" + clientId + "&response_type=token&state=zohocrmclient&redirect_uri=" + redirectUrl);
["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
var isKeyExists = localStorage.hasOwnProperty(k);
if(isKeyExists){
sessionStorage.setItem(k, localStorage[k]);
}
localStorage.removeItem(k);
});
valueInStore = sessionStorage.getItem("access_token");
}
}
if(token != null && valueInStore != 'undefined'){
token.accessToken = valueInStore;
}
return token.accessToken;
}
async makeAPICall(requestDetails) {
return new Promise(function (resolve, reject) {
var body, xhr, i;
body = requestDetails.body || null;
xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.open(requestDetails.method, requestDetails.uri, true);
for (i in requestDetails.headers) {
xhr.setRequestHeader(i, requestDetails.headers[i]);
}
xhr.send(body);
xhr.onreadystatechange = function() {
if(xhr.readyState == 4) {
resolve(xhr);
}
}
})
}
}
Copiedresponse = invokeurl
[
url: "https://zylkercorp.zohoplatform.com/crm/v2/org/currencies"
type: GET
connection:"crm_oauth_connection"
];
info response;
Response JSON Keys
- symbolstring
Represents the symbol of the current currency. For instance, '₹'.
- created_timestring
Represents the date and time at which the currency was created.
- is_activeboolean
Represents if the currency is active.
true: The currency is active.
false: The currency is inactive. - exchange_ratedouble
Represents the exchange rate of the currency.
- formatJSON object
Represents the format of the currency with details like decimal_separator, thousand_separator, and decimal_places.
- created_byJSON object
Represents name and ID of the user who created the currency.
- prefix_symbolboolean
Represents if the currency has a prefix symbol.
true: The currency has a prefix symbol.
false: The currency does not have a prefix symbol. - is_baseboolean
Represents if the currency is the base currency.
true: The current currency is the base currency.
false: The current currency is not the base currency. - modified_timestring
Represents the date and time at which the currency was last modified.
- namestring
Represents the name of the currency.
- modified_byJSON object
Represents the name and ID of the user who last modified the currency details.
- idstring
Represents the unique ID of the currency.
- iso_codestring
Represents the ISO code of the currency.
Possible Errors
- INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL has syntactical errors. - CURRENCIES_NOT_ENABLEDHTTP 403
Multi currency is not enabled
Resolution: You have not enabled other currencies for your organization. Goto Setup> Company Details> Currencies and enable it. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.settings.currencies.READ scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to read
Resolution: The user does not have permission to read currencies data. Contact your system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to read currencies data.
Resolution: The user does not have the permission to read currencies data. Contact your system administrator.
Sample Response
Copied{
"currencies": [
{
"symbol": "DA",
"created_time": "2019-11-08T14:24:56+05:30",
"is_active": true,
"exchange_rate": "3.000000000",
"format": {
"decimal_separator": "Period",
"thousand_separator": "Comma",
"decimal_places": "2"
},
"created_by": {
"name": "Patricia Boyle",
"id": "4150868000000225013"
},
"prefix_symbol": true,
"is_base": true,
"modified_time": "2019-11-08T14:48:03+05:30",
"name": "Algerian Dinar - DZD",
"modified_by": {
"name": "Patricia Boyle",
"id": "4150868000000225013"
},
"id": "4150868000000780002",
"iso_code": "DZD"
},
{
"symbol": "₹",
"created_time": "2019-11-08T14:29:22+05:30",
"is_active": true,
"exchange_rate": "1.000000000",
"format": {
"decimal_separator": "Period",
"thousand_separator": "Comma",
"decimal_places": "2"
},
"created_by": {
"name": "Patricia Boyle",
"id": "4150868000000225013"
},
"prefix_symbol": true,
"is_base": false,
"modified_time": "2019-11-08T14:29:22+05:30",
"name": "Indian Rupee - INR",
"modified_by": {
"name": "Patricia Boyle",
"id": "4150868000000225013"
},
"id": "4150868000000779003",
"iso_code": "INR"
},
{
"symbol": "$",
"created_time": "2019-11-08T14:45:26+05:30",
"is_active": true,
"exchange_rate": "3.000000000",
"format": {
"decimal_separator": "Period",
"thousand_separator": "Comma",
"decimal_places": "2"
},
"created_by": {
"name": "Patricia Boyle",
"id": "4150868000000225013"
},
"prefix_symbol": true,
"is_base": false,
"modified_time": "2019-11-08T14:53:02+05:30",
"name": "US Dollar - USD",
"modified_by": {
"name": "Patricia Boyle",
"id": "4150868000000225013"
},
"id": "4150868000000780008",
"iso_code": "USD"
}
]
}