Add New Currencies
Purpose
To add new currencies to your organization.
Endpoints
Request Details
Request URL
{api-domain}/crm/v2/org/currencies
Header
Authorization: Zoho-oauthtoken 100xx.d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.currencies.{operation_type}
Possible operation types
CREATE - Create currencies
Sample Request
Copiedcurl "https://zylkercorp.zohoplatform.com/crm/v2/org/currencies"
-X POST
-d input.json
-H "Authorization: Zoho-oauthtoken 100xx.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copied//Get instance of CurrenciesOperations Class
let currenciesOperations = new ZCRM.Currency.Operations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new ZCRM.Currency.Model.BodyWrapper();
//Array to hold Currency instances
let currencies = [];
//Get instance of Currency Class
let currency = new ZCRM.Currency.Model.Currency();
//To set the position of the ISO code in the currency.
//true: Display ISO code before the currency value.
//false: Display ISO code after the currency value.
currency.setPrefixSymbol(true);
//To set the name of the currency.
currency.setName("Angolan Kwanza - AOA");
//To set the ISO code of the currency.
currency.setIsoCode("AOA");
//To set the symbol of the currency.
currency.setSymbol("Kz");
//To set the rate at which the currency has to be exchanged for home currency.
currency.setExchangeRate("20.000000000");
//To set the status of the currency.
//true: The currency is active.
//false: The currency is inactive.
currency.setIsActive(true);
let format = new ZCRM.Currency.Model.Format();
//It can be a Period or Comma, depending on the currency.
format.setDecimalSeparator(new Choice("Period"));
//It can be a Period, Comma, or Space, depending on the currency.
format.setThousandSeparator(new Choice("Comma"));
//To set the number of decimal places allowed for the currency. It can be 0, 2, or 3.
format.setDecimalPlaces(new Choice("2"));
//To set the format of the currency
currency.setFormat(format);
currencies.push(currency);
//Set the array to Currency in BodyWrapper instance
request.setCurrencies(currencies);
//Call addCurrencies method that takes BodyWrapper instance as parameter
let response = await currenciesOperations.addCurrencies(request);Copiedvar listener = 0;
class UpdateCurrencies{
async updateCurrencies() {
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 UpdateCurrencies().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
var requestMethod = "PUT"
var reqBody = {
"currencies":[ {
"symbol": "Af",
"format": {
"decimal_separator": "Period",
"thousand_separator": "Comma",
"decimal_places": "3"
},
"prefix_symbol": true,
"id": "34770617368016",
"exchange_rate": "1.0000000"
}]
}
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 UpdateCurrencies().makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
}
async updateCurrency() {
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.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 UpdateCurrencies().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
var requestMethod = "PUT"
var reqBody = {"currencies":[
{
"symbol":"\u20b9",
"is_active":true,
"exchange_rate":"1.000000000",
"format":{"decimal_separator":"Period","thousand_separator":"Comma","decimal_places":"2"},
"prefix_symbol":true,
"is_base":true,
"name":"Indian Rupee - INR","iso_code":"INR"}]}
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 UpdateCurrencies().makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
}
async updateHomeCurrency() {
var url = "https://zylkercorp.zohoplatform.com/crm/v2/org/currencies/actions/enable"
var parameters = new Map()
var headers = new Map()
var token = {
clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl:"http://127.0.0.1:5500/redirect.html",
scope:"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 UpdateCurrencies().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
var requestMethod = "PUT"
var reqBody = {
"base_currency": {
"symbol": "Af",
"format": {
"decimal_separator": "Period",
"thousand_separator": "Comma",
"decimal_places": "3"
},
"prefix_symbol": true,
"id": "111113000000038990",
"exchange_rate": "1.0000000"
}
}
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 UpdateCurrencies().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);
}
}
})
}
}Copiedcurrency1Format = Map();
currency1Format.put("decimal_separator", "Period");
currency1Format.put("thousand_separator", "Comma");
currency1Format.put("decimal_places", "2");
currency1 = Map();
currency1.put("format", currency1Format);
currency1.put("prefix_symbol", true);
currency1.put("name", "Algerian Dinar-ADN");
currency1.put("iso_code", "DZD");
currency1.put("symbol", "Af");
currency1.put("exchange_rate", "1.0000000");
currency1.put("is_active", "true");
currenciesList = List();
currenciesList.add(currency1);
params = Map();
params.put("currencies", currenciesList);
response = invokeurl
[
url :"https://zylkercorp.zohoplatform.com/crm/v2/org/currencies"
type :POST
parameters: params.toString()
connection:"crm_oauth_connection"
];
info response;In the request, "@input.json" contains the sample input data.
Request JSON Keys
- prefix_symbolboolean, optional
Represents the position of the ISO code in the currency.
Possible Values:
true: Display ISO code before the currency value.
false:Display ISO code after the currency value. - namestring, mandatory
Represents the name of the currency.
- iso_codestring, mandatory
Represents the ISO code of the currency.
- symbolstring, optional
Represents the symbol of the currency.
- exchange_ratestring, mandatory
Represents the rate at which the currency has to be exchanged for home currency.
- is_activeboolean, optional
Represents the status of the currency.
Possible Values:
true: The currency is active.
false:The currency is inactive. - formatJSON object, optional
Represents the format of the base currency with details like decimal_separator, thousand_separator, and decimal_places.
Keys to be specified in format JSON Object
- decimal_separatorstring, optional
The decimal separator separates the integer part of the currency from its fractional part. It can be a Period or Comma, depending on the currency.
- thousand_separatorstring, optional
The thousand separator separates groups of thousands in a currency. It can be a Period, Comma, or Space, depending on the currency.
- decimal_placesinteger, optional
Represents the number of decimal places allowed for the currency. It can be 0, 2, or 3.
Sample Input
Copied{
"currencies": [
{
"format": {
"decimal_separator": "Period",
"thousand_separator": "Comma",
"decimal_places": "2"
},
"prefix_symbol": true,
"name": "Saudi Riyal - SAR",
"iso_code": "SAR",
"symbol": "SR",
"exchange_rate": "1.0000000",
"is_active": true
}
]
}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. - ACTIVE_STATE_LIMIT_EXCEEDEDHTTP 400
Allowed active currency limit 10 reached. Please deactivate any one of the existing active currencies to create this currency
Resolution: You already have ten active currencies. - INVALID_DATAHTTP 400
Currency name is invalid
Resolution: You have specified an invalid currency name. Go to setup> Company Details> Under Currencies tab> Click Add> The Currency picklist will have valid currency names and ISO codes. - INVALID_DATAHTTP 400
ISO code is invalid
Resolution: You have specified an invalid ISO code. Go to setup> Company Details> Under Currencies tab> Click Add> The Currency picklist will have valid currency names and ISO codes. - INVALID_DATAHTTP 400
Currency symbol is invalid.
Resolution: You have specified an invalid currency symbol. - DUPLICATE_DATAHTTP 400
Duplicate value given for \"Isocode\" parameter.
Resolution: The currency specified in the input JSON is already present. Even if the status of the currency is inactive, it will still be present in the list. - MANDATORY_NOT_FOUNDHTTP 400
Required field not found.
Resolution: Refer to Request JSON section above and specify all the mandatory keys in the input. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.settings.currencies.CREATE scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to create
Resolution: The user does not have permission to add currencies. 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 add currencies.
Resolution: The user does not have the permission to add currencies. Contact your system administrator.
Sample Response
Copied{
"currencies": [
{
"code": "SUCCESS",
"details": {
"id": "4150868000000780026"
},
"message": "The currency created successfully.",
"status": "success"
}
]
}