Update Currencies
Purpose
To update currency details.
Request Details
Request URL
To update home currency:
{api-domain}/crm/{version}/org/currencies/actions/enable
To update currencies other than home currency:
{api-domain}/crm/{version}/org/currencies
To update a specific currency:
{api-domain}/crm/{version}/org/currencies/{currency_ID}
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.currencies.{operation_type}
Possible operation types
UPDATE - Update currencies data
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2.1/org/currencies/actions/enable"
-X PUT
-d input.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copied//Get instance of CurrenciesOperations Class
CurrenciesOperations currenciesOperations = new CurrenciesOperations();
//Get instance of BodyWrapper Class that will contain the request body
BodyWrapper bodyWrapper = new BodyWrapper();
//List of Currency instances
List < com.zoho.crm.api.currencies.Currency > currencies = new ArrayList < com.zoho.crm.api.currencies.Currency > ();
//Get instance of Currency Class
com.zoho.crm.api.currencies.Currency currency = new com.zoho.crm.api.currencies.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 currency Id
currency.setId(3477061000006040001 L);
//To set the rate at which the currency has to be exchanged for home currency.
currency.setExchangeRate("5.0000000");
//To set the status of the currency.
//true: The currency is active.
//false: The currency is inactive.
currency.setIsActive(true);
Format format = new Format();
//It can be a Period or Comma, depending on the currency.
format.setDecimalSeparator(new Choice < String > ("Period"));
//It can be a Period, Comma, or Space, depending on the currency.
format.setThousandSeparator(new Choice < String > ("Comma"));
//To set the number of decimal places allowed for the currency. It can be 0, 2, or 3.
format.setDecimalPlaces(new Choice < String > ("2"));
//Add Format instance to the list
currency.setFormat(format);
//Add currency instances to the list
currencies.add(currency);
//Set the list to Currency in BodyWrapper instance
bodyWrapper.setCurrencies(currencies);
//Call updateCurrencies method that takes BodyWrapper instance as parameter
APIResponse < ActionHandler > response = currenciesOperations.updateCurrencies(bodyWrapper);
Copiedpackage com.zoho.crm.api.sample.restapi.currencies;
import javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.protocol.HTTP;
import org.apache.http.util.EntityUtils;
import org.json.JSONArray;
import org.json.JSONObject;
public class UpdateCurrencies
{
@SuppressWarnings("deprecation")
private static void updateCurrencies()
{
try
{
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2.1/org/currencies");
HttpUriRequest requestObj = new HttpPut(uriBuilder.build());
HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
JSONObject requestBody = new JSONObject();
JSONArray recordArray = new JSONArray();
JSONObject recordObject = new JSONObject();
recordObject.put("id", "34770616008002");
recordObject.put("is_active", false);
recordArray.put(recordObject);
recordObject = new JSONObject();
recordObject.put("id", "34770616011001");
recordObject.put("is_active", false);
recordArray.put(recordObject);
requestBody.put("currencies", recordArray);
requestBase.setEntity(new StringEntity(requestBody.toString(), HTTP.UTF_8));
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
HttpResponse response = httpclient.execute(requestObj);
HttpEntity responseEntity = response.getEntity();
System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
if(responseEntity != null)
{
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
System.out.println(responseString);
}
}
catch(Exception ex)
{
ex.printStackTrace();
}
}
@SuppressWarnings("deprecation")
private static void updateCurrency()
{
try
{
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2.1/org/currencies/34770616008002");
HttpUriRequest requestObj = new HttpPut(uriBuilder.build());
HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
JSONObject requestBody = new JSONObject();
JSONArray recordArray = new JSONArray();
JSONObject recordObject = new JSONObject();
recordObject.put("is_active", true);
recordArray.put(recordObject);
requestBody.put("currencies", recordArray);
requestBase.setEntity(new StringEntity(requestBody.toString(), HTTP.UTF_8));
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
HttpResponse response = httpclient.execute(requestObj);
HttpEntity responseEntity = response.getEntity();
System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
if(responseEntity != null)
{
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
System.out.println(responseString);
}
}
catch(Exception ex)
{
ex.printStackTrace();
}
}
@SuppressWarnings("deprecation")
private static void updateHomeCurrency()
{
try
{
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2.1/org/currencies/actions/enable");
HttpUriRequest requestObj = new HttpPut(uriBuilder.build());
HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
JSONObject requestBody = new JSONObject();
JSONObject recordObject = new JSONObject();
recordObject.put("prefix_symbol", true);
recordObject.put("id", "34770615657003");
requestBody.put("base_currency", recordObject);
requestBase.setEntity(new StringEntity(requestBody.toString(), HTTP.UTF_8));
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
HttpResponse response = httpclient.execute(requestObj);
HttpEntity responseEntity = response.getEntity();
System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
if(responseEntity != null)
{
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
System.out.println(responseString);
}
}
catch(Exception ex)
{
ex.printStackTrace();
}
}
public static void main(String[] args)
{
updateCurrencies();
updateCurrency();
updateHomeCurrency();
}
}
Copied//Get instance of CurrenciesOperations Class
$currenciesOperations = new CurrenciesOperations();
//Get instance of BodyWrapper Class that will contain the request body
$bodyWrapper = new BodyWrapper();
//List of Currency instances
$currencies = array();
$currencyClass = "com\zoho\crm\api\currencies\Currency";
//Get instance of Currency Class
$currency = new $currencyClass();
//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 currency Id
$currency->setId("34770616040001");
//To set the rate at which the currency has to be exchanged for home currency.
$currency->setExchangeRate("5.00");
//To set the status of the currency.
//true: The currency is active.
//false: The currency is inactive.
$currency->setIsActive(true);
$format = new 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);
array_push($currencies, $currency);
//Set the list to Currency in BodyWrapper instance
$bodyWrapper->setCurrencies($currencies);
//Call updateCurrencies method that takes BodyWrapper instance as parameter
$response = $currenciesOperations->updateCurrencies($bodyWrapper);
//Get instance of CurrenciesOperations Class
$currenciesOperations = new CurrenciesOperations();
//Get instance of BodyWrapper Class that will contain the request body
$bodyWrapper = new BodyWrapper();
//List of Currency instances
$currencies = array();
$currencyClass = "com\zoho\crm\api\currencies\Currency";
//Get instance of Currency Class
$currency = new $currencyClass();
//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 rate at which the currency has to be exchanged for home currency.
$currency->setExchangeRate("5.00");
//To set the status of the currency.
//true: The currency is active.
//false: The currency is inactive.
$currency->setIsActive(true);
$format = new 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);
array_push($currencies, $currency);
//Set the list to Currency in BodyWrapper instance
$bodyWrapper->setCurrencies($currencies);
//Call addCurrencies method that takes BodyWrapper instance as parameter
$response = $currenciesOperations->updateCurrency($currencyId,$bodyWrapper);
Copied<?php
class UpdateCurrencies
{
public function execute(){
$curl_pointer = curl_init();
$curl_options = array();
$url = "https://www.zohoapis.com/crm/v2.1/org/currencies";
$curl_options[CURLOPT_URL] =$url;
$curl_options[CURLOPT_RETURNTRANSFER] = true;
$curl_options[CURLOPT_HEADER] = 1;
$curl_options[CURLOPT_CUSTOMREQUEST] = "PUT";
$requestBody = array();
$recordArray = array();
$recordObject = array();
$recordObject["id"]="3477061000006008002";
$recordArray[] = $recordObject;
$requestBody["currencies"] =$recordArray;
$curl_options[CURLOPT_POSTFIELDS]= json_encode($requestBody);
$headersArray = array();
$headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " . "1000.30f3a589XXXXXXXXXXXXXXXXXXX4077.dc5XXXXXXXXXXXXXXXXXXXee9e7c171c";
$curl_options[CURLOPT_HTTPHEADER]=$headersArray;
curl_setopt_array($curl_pointer, $curl_options);
$result = curl_exec($curl_pointer);
$responseInfo = curl_getinfo($curl_pointer);
curl_close($curl_pointer);
list ($headers, $content) = explode("\r\n\r\n", $result, 2);
if(strpos($headers," 100 Continue")!==false){
list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
}
$headerArray = (explode("\r\n", $headers, 50));
$headerMap = array();
foreach ($headerArray as $key) {
if (strpos($key, ":") != false) {
$firstHalf = substr($key, 0, strpos($key, ":"));
$secondHalf = substr($key, strpos($key, ":") + 1);
$headerMap[$firstHalf] = trim($secondHalf);
}
}
$jsonResponse = json_decode($content, true);
if ($jsonResponse == null && $responseInfo['http_code'] != 204) {
list ($headers, $content) = explode("\r\n\r\n", $content, 2);
$jsonResponse = json_decode($content, true);
}
var_dump($headerMap);
var_dump($jsonResponse);
var_dump($responseInfo['http_code']);
}
}
(new UpdateCurrencies())->execute();
Copied//Get instance of CurrenciesOperations Class
CurrenciesOperations currenciesOperations = new CurrenciesOperations();
//Get instance of BodyWrapper Class that will contain the request body
BodyWrapper bodyWrapper = new BodyWrapper();
//List of Currency instances
List<Com.Zoho.Crm.API.Currencies.Currency> currencies = new List<Com.Zoho.Crm.API.Currencies.Currency>();
//Get instance of Currency Class
Com.Zoho.Crm.API.Currencies.Currency currency = new Com.Zoho.Crm.API.Currencies.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.PrefixSymbol = true;
//To set currency Id
//currency.Id = 3477061000006040001;
//To set the rate at which the currency has to be exchanged for home currency.
currency.ExchangeRate = "5.0000000";
//To set the status of the currency.
//true: The currency is active.
//false: The currency is inactive.
currency.IsActive = true;
Format format = new Format();
//It can be a Period or Comma, depending on the currency.
format.DecimalSeparator = new Choice<string>("Period");
//It can be a Period, Comma, or Space, depending on the currency.
format.ThousandSeparator = new Choice<string>("Comma");
//To set the number of decimal places allowed for the currency. It can be 0, 2, or 3.
format.DecimalPlaces = new Choice<string>("2");
//To set the format of the currency
currency.Format = format;
//Add Currency instance to the list
currencies.Add(currency);
//Set the list to Currency in BodyWrapper instance
bodyWrapper.Currencies = currencies;
//Call UpdateCurrencies method that takes BodyWrapper instance as parameter
APIResponse<ActionHandler> response = currenciesOperations.UpdateCurrencies(bodyWrapper);
Copiedusing System;
using System.IO;
using System.Net;
using System.Text;
using Newtonsoft.Json.Linq;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Currencies
{
public class UpdateCurrencies
{
public static void UpdateCurrenciesOtherThanHomeCurrency()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/org/currencies");
request.Method = "PUT";
request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
JObject requestBody = new JObject();
JArray recordArray = new JArray();
JObject recordObject = new JObject();
recordObject.Add("id", "34770616008002");
recordObject.Add("is_active", false);
recordArray.Add(recordObject);
recordObject = new JObject();
recordObject.Add("id", "3477061011001");
recordObject.Add("is_active", false);
recordArray.Add(recordObject);
requestBody.Add("currencies", recordArray);
string dataString = requestBody.ToString();
var data = Encoding.UTF8.GetBytes(dataString);
int dataLength = data.Length;
request.ContentLength = dataLength;
using (var writer = request.GetRequestStream())
{
writer.Write(data, 0, dataLength);
}
request.KeepAlive = true;
HttpWebResponse response;
try
{
response = (HttpWebResponse)request.GetResponse();
}
catch (WebException e)
{
if (e.Response == null) { throw; }
response = (HttpWebResponse)e.Response;
}
HttpWebResponse responseEntity = response;
Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
responseEntity.Close();
Console.WriteLine(responsestring);
}
public static void UpdateCurrency()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/org/currencies/3477061008002");
request.Method = "PUT";
request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
JObject requestBody = new JObject();
JArray recordArray = new JArray();
JObject recordObject = new JObject();
recordObject.Add("is_active", true);
recordArray.Add(recordObject);
requestBody.Add("currencies", recordArray);
string dataString = requestBody.ToString();
var data = Encoding.UTF8.GetBytes(dataString);
int dataLength = data.Length;
request.ContentLength = dataLength;
using (var writer = request.GetRequestStream())
{
writer.Write(data, 0, dataLength);
}
request.KeepAlive = true;
HttpWebResponse response;
try
{
response = (HttpWebResponse)request.GetResponse();
}
catch (WebException e)
{
if (e.Response == null) { throw; }
response = (HttpWebResponse)e.Response;
}
HttpWebResponse responseEntity = response;
Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
responseEntity.Close();
Console.WriteLine(responsestring);
}
public static void UpdateHomeCurrency()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/org/currencies/actions/enable");
request.Method = "PUT";
request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
JObject requestBody = new JObject();
JObject recordObject = new JObject();
recordObject.Add("prefix_symbol", true);
recordObject.Add("id", "3477061657003");
requestBody.Add("base_currency", recordObject);
string dataString = requestBody.ToString();
var data = Encoding.UTF8.GetBytes(dataString);
int dataLength = data.Length;
request.ContentLength = dataLength;
using (var writer = request.GetRequestStream())
{
writer.Write(data, 0, dataLength);
}
request.KeepAlive = true;
HttpWebResponse response;
try
{
response = (HttpWebResponse)request.GetResponse();
}
catch (WebException e)
{
if (e.Response == null) { throw; }
response = (HttpWebResponse)e.Response;
}
HttpWebResponse responseEntity = response;
Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
responseEntity.Close();
Console.WriteLine(responsestring);
}
}
}
Copied//Get instance of CurrenciesOperations Class
let currenciesOperations = new CurrenciesOperations();
//Get instance of BodyWrapper Class that will contain the request body
let request = new BodyWrapper();
//Array to hold Currency instances
let currencies = [];
//Get instance of Currency Class
let currency = new Currency();
//To set currency Id
currency.setId(3409643000002293037n);
//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 rate at which the currency has to be exchanged for home currency.
currency.setExchangeRate("10.000000000");
//To set the status of the currency.
//true: The currency is active.
//false: The currency is inactive.
currency.setIsActive(true);
let format = new 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("Space"));
//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);
//Add Currency instance to the array
currencies.push(currency);
//Set the array to Currency in BodyWrapper instance
request.setCurrencies(currencies);
//Call updateCurrencies method that takes BodyWrapper instance as parameter
let response = await currenciesOperations.updateCurrencies(request);
Copiedasync function updateCurrencies() {
const got = require("got");
let url = 'https://www.zohoapis.com/crm/v2.1/org/currencies'
let headers = {
Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
let requestBody = {}
let recordArray = []
let recordObject1 = {}
let recordObject2 = {}
recordObject1['id'] = '3409643000002293037'
recordObject1['is_active'] = false
recordArray.push(recordObject1)
recordObject1['id'] = '3409643000002296001'
recordObject1['is_active'] = true
recordArray.push(recordObject2)
requestBody['currencies'] = recordArray
let requestDetails = {
method : "PUT",
headers : headers,
body : JSON.stringify(requestBody),
encoding: "utf8",
throwHttpErrors : false
};
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
console.log(response.body);
}
}
updateCurrencies()
async function updateCurrency() {
const got = require("got");
let url = 'https://www.zohoapis.com/crm/v2.1/org/currencies/3409643000002293037'
let headers = {
Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
let requestBody = {}
let recordArray = []
let recordObject = {}
recordObject['is_active'] = false
recordObject['exchange_rate'] = '30.000000'
recordArray.push(recordObject)
requestBody['currencies'] = recordArray
let requestDetails = {
method : "PUT",
headers : headers,
body : JSON.stringify(requestBody),
encoding: "utf8",
throwHttpErrors : false
};
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
console.log(response.body);
}
}
updateCurrency()
async function updateHomeCurrency() {
const got = require("got");
let url = 'https://www.zohoapis.com/crm/v2.1/org/currencies/actions/enable'
let headers = {
Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
let requestBody = {}
let recordObject = {}
let formatObject = {}
formatObject['decimal_separator'] = 'Period'
formatObject['thousand_separator'] = 'Comma'
formatObject['decimal_places'] = '3'
recordObject['id'] = '3409643000002293001'
recordObject['format'] = formatObject
recordObject['prefix_symbol'] = true
requestBody['base_currency'] = recordObject
let requestDetails = {
method : "PUT",
headers : headers,
body : JSON.stringify(requestBody),
encoding: "utf8",
throwHttpErrors : false
};
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
console.log(response.body);
}
}
updateHomeCurrency()
Copied# Get instance of CurrenciesOperations Class
currencies_operations = CurrenciesOperations()
# Get instance of BodyWrapper Class that will contain the request body
request = BodyWrapper()
# List to hold Currency instances
currencies_list = []
# Get instance of Currency Class
currency = ZCRMCurrency()
# To set currency Id
currency.set_id(3409643000002293037)
# 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.set_prefix_symbol(True)
# To set the rate at which the currency has to be exchanged for home currency.
currency.set_exchange_rate("28.000000000")
# To set the status of the currency.
# True: The currency is active.
# False: The currency is inactive.
currency.set_is_active(True)
format = Format()
# It can be a Period or Comma, depending on the currency.
format.set_decimal_separator(Choice('Period'))
# It can be a Period, Comma, or Space, depending on the currency.
format.set_thousand_separator(Choice('Comma'))
# To set the number of decimal places allowed for the currency. It can be 0, 2, or 3.
format.set_decimal_places(Choice('2'))
# To set the format of the currency
currency.set_format(format)
currencies_list.append(currency)
# Set the list to Currency in BodyWrapper instance
request.set_currencies(currencies_list)
# Call update_currencies method that takes BodyWrapper instance as parameter
response = currencies_operations.update_currencies(request)
# Get instance of CurrenciesOperations Class
currencies_operations = CurrenciesOperations()
# Get instance of BodyWrapper Class that will contain the request body
request = BodyWrapper()
# List to hold Currency instances
currencies_list = []
# Get instance of Currency Class
currency = ZCRMCurrency()
# 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.set_prefix_symbol(True)
# To set the rate at which the currency has to be exchanged for home currency.
currency.set_exchange_rate("28.000000000")
# To set the status of the currency.
# True: The currency is active.
# False: The currency is inactive.
currency.set_is_active(True)
format = Format()
# It can be a Period or Comma, depending on the currency.
format.set_decimal_separator(Choice('Period'))
# It can be a Period, Comma, or Space, depending on the currency.
format.set_thousand_separator(Choice('Comma'))
# To set the number of decimal places allowed for the currency. It can be 0, 2, or 3.
format.set_decimal_places(Choice('2'))
# To set the format of the currency
currency.set_format(format)
currencies_list.append(currency)
# Set the list to Currency in BodyWrapper instance
request.set_currencies(currencies_list)
# Call update_currencies method that takes BodyWrapper instance as parameter
response = currencies_operations.update_currency(currency_id, request)
Copieddef update_currencies():
import requests
import json
url = 'https://www.zohoapis.com/crm/v2.1/org/currencies'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.1fc2da2144ba0f8931261a0a78e51a4e.7d2b34de8647be16a27b68c71cfa04dd'
}
request_body = dict()
record_list = list()
record_object_1 = dict()
record_object_2 = dict()
record_object_1['id'] = '3409643000002293037'
record_object_1['is_active'] = False
record_list.append(record_object_1)
record_object_2['id'] = '3409643000002296001'
record_object_2['is_active'] = True
record_list.append(record_object_2)
request_body['currencies'] = record_list
response = requests.put(url=url, headers=headers, data=json.dumps(request_body).encode('utf-8'))
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
print(response.json())
update_currencies()
def update_currency():
import requests
import json
url = 'https://www.zohoapis.com/crm/v2.1/org/currencies/3409643000002293037'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.1fc2da2144ba0f8931261a0a78e51a4e.7d2b34de8647be16a27b68c71cfa04dd'
}
request_body = dict()
record_list = list()
record_object = dict()
record_object['is_active'] = False
record_object['exchange_rate'] = '30.000000'
record_list.append(record_object)
request_body['currencies'] = record_list
response = requests.put(url=url, headers=headers, data=json.dumps(request_body).encode('utf-8'))
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
print(response.json())
update_currency()
Copied# Get instance of CurrenciesOperations Class
co = Currencies::CurrenciesOperations.new
# Get instance of BodyWrapper Class that will contain the request body
bw = Currencies::BodyWrapper.new
# Get instance of Currency Class
currency = Currencies::Currency.new
currency.prefix_symbol = true
# To set the name of the currency.
currency.name = 'Angolan Kwanza - AOA'
# 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.iso_code = 'DZD'
# To set the ISO code of the currency.
# currency.set_iso_code("AOA")
# To set ID of the currency.
currency.id = 3_524_033_000_002_007_001
# To set the symbol of the currency.
currency.symbol = 'Kz'
# To set the rate at which the currency has to be exchanged for home currency
currency.exchange_rate = '20.000000000'
# To set the status of the currency.
# True: The currency is active.
# False: The currency is inactive.
currency.is_active = true
format = Currencies::Format.new
# It can be a Period or Comma, depending on the currency.
format.decimal_separator = Util::Choice.new('Period')
# It can be a Period, Comma, or Space, depending on the currency.
format.thousand_separator = Util::Choice.new('Comma')
# To set the number of decimal places allowed for the currency. It can be 0, 2, or 3
format.decimal_places = Util::Choice.new('2')
# To set the format of the currency
# currency.set_format(format)
currency.format = format
# List to hold Currency instances
currencies = [currency]
# Set the list to Currency in BodyWrapper instance
bw.currencies = currencies
# Call update_currencies method that takes BodyWrapper instance as parameter
response = co.update_currencies(bw)
# Get instance of CurrenciesOperations Class
co = Currencies::CurrenciesOperations.new
# Get instance of BodyWrapper Class that will contain the request body
bw = Currencies::BodyWrapper.new
# Get instance of Currency Class
currency = Currencies::Currency.new
currency.prefix_symbol = true
# To set the name of the currency.
currency.name = 'Angolan Kwanza - AOA'
# 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.iso_code = 'DZD'
# To set the ISO code of the currency.
# currency.set_iso_code("AOA")
# To set the symbol of the currency.
currency.symbol = 'Kz'
# To set the rate at which the currency has to be exchanged for home currency
currency.exchange_rate = '20.000000000'
# To set the status of the currency.
# True: The currency is active.
# False: The currency is inactive.
currency.is_active = true
format = Currencies::Format.new
# It can be a Period or Comma, depending on the currency.
format.decimal_separator = Util::Choice.new('Period')
# It can be a Period, Comma, or Space, depending on the currency.
format.thousand_separator = Util::Choice.new('Comma')
# To set the number of decimal places allowed for the currency. It can be 0, 2, or 3
format.decimal_places = Util::Choice.new('2')
# To set the format of the currency
# currency.set_format(format)
currency.format = format
# List to hold Currency instances
currencies = [currency]
# Set the list to Currency in BodyWrapper instance
bw.currencies = currencies
# Call update_currencies method that takes BodyWrapper instance as parameter
response = co.update_currency(current_id,bw)
Copiedrequire 'net/http'
require 'json'
class UpdateCurrencies
def execute
url ="https://www.zohoapis.com/crm/v2.1/org/currencies"
url = URI(url)
req = Net::HTTP::Put.new(url.request_uri)
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
headers={}
headers["Authorization"]="Zoho-oauthtoken 1000.dfa7XXXXXXXXXXXXXXXXXX84f9665840.c176aeXXXXXXXXXXXX13f3d37a84d"
headers&.each { |key, value| req.add_field(key, value) }
request_body = {};
record_array = [];
record_object = {};
record_object["id"]="3524033000006019011";
record_array = [record_object];
request_body["currencies"] =record_array;
request_json = request_body.to_json
req.body = request_json.to_s
response=http.request(req)
status_code = response.code.to_i
headers = response.each_header.to_h
print status_code
print headers
unless response.body.nil?
print response.body
end
end
end
UpdateCurrencies.new.execute
In the request, "@input.json" contains the sample input data.
The name and ISO code of the currencies are defined and cannot be updated.
Request JSON
- idstring, mandatory
Specify the unique ID of the currency. Refer to Get Currencies API for more details.
- 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, optional
Represents the name of the currency.
- iso_codestring, optional
Represents the ISO code of the currency.
- symbolstring, optional
Represents the symbol of the currency.
- exchange_ratestring, optional
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{
"base_currency": {
"symbol": "Af",
"format": {
"decimal_separator": "Period",
"thousand_separator": "Comma",
"decimal_places": "3"
},
"prefix_symbol": true,
"id": "111113000000038990",
"exchange_rate": "1.0000000"
}
}
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. - INVALID_DATAHTTP 400
ID is invalid
Resolution: You have specified an invalid currency ID. - INVALID_DATAHTTP 400
Currency symbol is invalid.
Resolution: You have specified an invalid currency symbol. - FEATURE_NOT_SUPPORTEDHTTP 403
The multi-currency feature is not available except the Enterprise and higher editions.
Resolution: The multi-currency feature is only available in Enterprise and Ultimate editions. - FEATURE_NOT_ENABLEDHTTP 403
The multi-currency feature is not enabled.
Resolution: You can update currencies only after enabling the multi-currency feature. Refer to Enable Multi-Currency. - NOT_ALLOWEDHTTP 400
Thousand separator and decimal separator should not be equal
Resolution: Specify different separators for thousands and decimals. - NOT_ALLOWEDHTTP 400
Base currency ID is not allowed here
Resolution: You cannot update the base currency values. - MANDATORY_NOT_FOUNDHTTP 400
Required field not found.
Resolution: Specify the unique ID of the currency in the input. Refer to Get Currencies API to get the unique ID of a currency. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.settings.currencies.UPDATE scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to update
Resolution: The user does not have permission to update 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 update currencies.
Resolution: The user does not have the permission to update currencies. Contact your system administrator.
Sample Response
Copied{
"base_currency": {
"code": "SUCCESS",
"details": {
"id": "4150868000000780002"
},
"message": "The currency updated successfully",
"status": "success"
}
}