API Docs
/
No Results Found
Currency

Currency

In case your organization sells products or provides services to customer from different countries, you can add those currencies and exchange rates you deal with, to your Zoho Books account.

Attribute

currency_id
string
A unique ID for the currency.
currency_code
string
A unique standard code for the currency. Max-len [100]
currency_name
string
The name for the currency.
currency_symbol
string
A unique symbol for the currency. Max-len [4]
price_precision
integer
The precision for the price
currency_format
string
The format for the currency to be displayed. Max-len [100]
is_base_currency
boolean
Is it the base currency of the organization.

Example

{ "currency_id": "982000000004012", "currency_code": "AUD", "currency_name": "AUD- Australian Dollar", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89", "is_base_currency": false }

Create a Currency

Create a currency for transaction.
oauthscope : ZohoBooks.settings.CREATE

Arguments

currency_code
string
(Required)
A unique standard code for the currency. Max-len [100]
currency_symbol
string
A unique symbol for the currency. Max-len [4]
price_precision
integer
The precision for the price
currency_format
string
(Required)
The format for the currency to be displayed. Max-len [100]

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/currencies -X POST -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "currency_code": "AUD", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89" }

Response Example

{ "code": 0, "message": "The currency has been added.", "currency": { "currency_id": "982000000004012", "currency_code": "AUD", "currency_name": "AUD- Australian Dollar", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89", "is_base_currency": false } }

List Currencies

Get list of currencies configured.
oauthscope : ZohoBooks.settings.READ

Query Parameters

filter_by
Filter currencies excluding base currency. Allowed Values: Currencies.ExcludeBaseCurrency

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/currencies -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "currencies": [ { "currency_id": "982000000004012", "currency_code": "AUD", "currency_name": "AUD- Australian Dollar", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89", "is_base_currency": false, "exchange_rate": 1, "effective_date": "2013-09-04" }, {...}, {...} ] }

Update a Currency

Update the details of a currency.
oauthscope : ZohoBooks.settings.UPDATE

Arguments

currency_code
string
(Required)
A unique standard code for the currency. Max-len [100]
currency_symbol
string
A unique symbol for the currency. Max-len [4]
price_precision
integer
The precision for the price
currency_format
string
(Required)
The format for the currency to be displayed. Max-len [100]

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/currencies/{currency_id} -X PUT -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "currency_code": "AUD", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89" }

Response Example

{ "code": 0, "message": "Currency information has been saved.", "currency": { "currency_id": "982000000004012", "currency_code": "AUD", "currency_name": "AUD- Australian Dollar", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89", "is_base_currency": false } }

Get a Currency

Get the details of a currency.
oauthscope : ZohoBooks.settings.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/currencies/{currency_id}

Response Example

{ "code": 0, "message": "success", "currency": { "currency_id": "982000000004012", "currency_code": "AUD", "currency_name": "AUD- Australian Dollar", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89", "is_base_currency": false } }

Delete a currency

Delete a currency. Currency that is associated to transactions cannot be deleted.
oauthscope : ZohoBooks.settings.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/currencies/{currency_id} -X DELETE

Response Example

{ "code": 0, "message": "The currency has been deleted." }

Create an exchange rate

Create an exchange rate for the specified currency.
oauthscope : ZohoBooks.settings.CREATE

Arguments

effective_date
string
Date which the exchange rate is applicable for the currency.
rate
double
Rate of exchange for the currency with respect to base currency.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/currencies/{currency_id}/exchangerates -X POST -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "effective_date": "2013-09-04", "rate": 1.23 }

Response Example

{ "code": 0, "message": "The exchange rate has been added.", "exchange_rate": 1 }

List exchange rates

List of exchange rates configured for the currency.
oauthscope : ZohoBooks.settings.READ

Query Parameters

from_date
Returns the exchange rate details from the given date or from previous closest match in the absence of the exchange rate on the given date.
is_current_date
To return the exchange rate only if available for current date.
sort_column
Sorts the exchange rate according to this column. Allowed Values : effective_date

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/currencies/{currency_id}/exchangerates -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "exchange_rates": [ { "exchange_rate_id": "460000000038035", "currency_id": "982000000004012", "currency_code": "AUD", "effective_date": "2013-09-04", "rate": 1.23 }, {...}, {...} ] }

Update an exchange rate

Update the details of exchange rate for a currency.
oauthscope : ZohoBooks.settings.UPDATE

Arguments

effective_date
string
Date which the exchange rate is applicable for the currency.
rate
double
Rate of exchange for the currency with respect to base currency.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/currencies/{currency_id}/exchangerates/{exchange_rate_id} -X PUT -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "effective_date": "2013-09-04", "rate": 1.23 }

Response Example

{ "code": 0, "message": "The exchange rate has been updated." }

Get an exchange rate.

Get the details of an exchange rate that has been asscoiated to the currency.
oauthscope : ZohoBooks.settings.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/currencies/{currency_id}/exchangerates/{exchange_rate_id} -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "exchange_rate": 1 }

Delete an exchage rate

Delete an exchange rate for the specified currency.
oauthscope : ZohoBooks.settings.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/currencies/{currency_id}/exchangerates/{exchange_rate_id} -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "Exchange rate successfully deleted" }