Get Currencies

Purpose

To get all the available currencies in your organization.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/org/currencies

To get 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

READ - Get currencies data

Sample Request

Curl Java PHP Csharp Python Node JS Ruby Deluge

Copiedcurl "https://www.zohoapis.com/crm/v2.1/org/currencies"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

3.0.08.0

Copied//Get instance of CurrenciesOperations Class
CurrenciesOperations currenciesOperations = new CurrenciesOperations();

//Call getCurrencies method 
APIResponse < ResponseHandler > response = currenciesOperations.getCurrencies();

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.HttpGet;
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.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
public class GetCurrencies 
{
	private static void getCurrencies()
	{
		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 HttpGet(uriBuilder.build());
			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();
		}
	}
	private static void getCurrency()
	{
		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/34770615657003");
			HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
			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) 
	{
		getCurrencies();
		getCurrency();
	}
}

4.0.04.x

Copied//Get instance of CurrenciesOperations Class
$currenciesOperations = new CurrenciesOperations();
//Call getCurrencies method
$response = $currenciesOperations->getCurrencies();


//Get instance of CurrenciesOperations Class
$currenciesOperations = new CurrenciesOperations();
//Call getCurrency method
$response = $currenciesOperations->getCurrency($currencyId);

Copied<?php
class GetCurrencies{
    
    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] = "GET";
        $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 GetCurrencies())->execute();

3.0.08.x

Copied//Get instance of CurrenciesOperations Class
CurrenciesOperations currenciesOperations = new CurrenciesOperations();
//Call GetCurrencies method 
APIResponse<ResponseHandler> response = currenciesOperations.GetCurrencies();

Copiedusing System;
using System.IO;
using System.Net;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Currencies
{
    public class CurrenciesData
    {
        public static void GetCurrencies()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/org/currencies");
            request.Method = "GET";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            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 GetCurrency()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/org/currencies/347706105657003");
            request.Method = "GET";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            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);
        }
    }
}

3.0.03.x.x

Copied# Get instance of CurrenciesOperations Class
currencies_operations = CurrenciesOperations()
# Call get_currencies method
response = currencies_operations.get_currencies()


# Get instance of CurrenciesOperations Class
currencies_operations = CurrenciesOperations()
# Call get_currency method that takes currency_id as parameter
response = currencies_operations.get_currency(currency_id)

Copieddef get_currencies():
    import requests

    url = 'https://www.zohoapis.com/crm/v2.1/org/currencies'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.1fc2da2144ba0f8931261a0a78e51a4e.7d2b34de8647be16a27b68c71cfa04dd'
    }

    response = requests.get(url=url, headers=headers)

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())

get_currencies()


def get_currency():
    import requests

    url = 'https://www.zohoapis.com/crm/v2.1/org/currencies/3409643000002293001'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.1fc2da2144ba0f8931261a0a78e51a4e.7d2b34de8647be16a27b68c71cfa04dd'
    }

    response = requests.get(url=url, headers=headers)

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())

get_currency()

1.0.010.x

Copied//Get instance of CurrenciesOperations Class
let currenciesOperations = new CurrenciesOperations();
//Call getCurrencies method
let response = await currenciesOperations.getCurrencies();

Copiedasync function getCurrencies() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2.1/org/currencies'
    let headers = {
        Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
    }

    let requestDetails = {
        method : "GET",
        headers : headers,
        throwHttpErrors : false
    }
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    }
}
getCurrencies()

async function getCurrency() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2.1/org/currencies/3409643000002293001'
    let headers = {
        Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
    }

    let requestDetails = {
        method : "GET",
        headers : headers,
        throwHttpErrors : false
    }
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    }
}

getCurrency()

2.1.0

Copied# Get instance of CurrenciesOperations Class
co = Currencies::CurrenciesOperations.new
# Call get_currencies method
response = co.get_currencies


# Get instance of CurrenciesOperations Class
co = Currencies::CurrenciesOperations.new
# Call get_currency method that takes currency_id as parameter
response = co.get_currency(current_id)

Copiedrequire 'net/http'
require 'json'

class GetCurrencies 

    def execute
        parameters ={}
        parameters["fields"]="id"
        parameters["page"]="1"
        parameters["per_page"]="10"
        query_string = parameters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join('&')
        url= "https://www.zohoapis.com/crm/v2.1/org/currencies"
        url += '?' + query_string if !query_string.nil? && (query_string.strip != '')
        url = URI(url)
        req = Net::HTTP::Get.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) }
        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
GetCurrencies.new.execute

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v2.1/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.
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.
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"
        }
    ]
}