API Docs
/
No Results Found
Currencies

Currencies

A currency entity allows you to maintain details of a currency.

Attribute

currency_id
long
Unique ID for currency generated by the server. This is used as an identifier.
currency_code
string
Currency code.
currency_name
string
Name of the currency.
currency_symbol
string
Symbol for the currency.
price_precision
integer
Precise amount upto n decimal points.
currency_format
string
Currency format.
is_base_currency
boolean
Whether it is the base currency. It can either be true or false.

Example

{ "currency_id": "16367000000000097", "currency_code": "USD", "currency_name": "USD- US Dollar", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89", "is_base_currency": false }

Create a currency

Create a currency.

Arguments

currency_code
string
(Required)
Currency code.
currency_name
string
Name of the currency.
currency_symbol
string
Symbol for the currency.
price_precision
integer
Precise amount upto n decimal points.
currency_format
string
(Required)
Currency format.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/settings/currencies -X POST -H "X-com-zoho-expense-organizationid: 10234695" -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
{ "currency_code": "USD", "currency_name": "USD- US Dollar", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89" }

Response Example

{ "code": 0, "message": "The currency has been created.", "currency": { "currency_id": "16367000000000097", "currency_code": "USD", "currency_name": "USD- US Dollar", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89", "is_base_currency": false } }

Retrieve list of currencies

Details of all existing currencies.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/settings/currencies -H "X-com-zoho-expense-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "currencies": [ { "currency_id": "16367000000000097", "currency_code": "USD", "currency_name": "USD- US Dollar", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89", "is_base_currency": false, "exchange_rate": 20.780488, "effective_date": "2009-01-27" }, {...}, {...} ] }

Update details of a currency

Update the details of an existing currency.

Arguments

currency_symbol
string
Symbol for the currency.
price_precision
integer
Precise amount upto n decimal points.
currency_format
string
(Required)
Currency format.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/settings/currencies/{currency_id} -X PUT -H "X-com-zoho-expense-organizationid: 10234695" -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
{ "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89" }

Response Example

{ "code": 0, "message": "The currency details have been updated.", "currency": { "currency_id": "16367000000000097", "currency_code": "USD", "currency_name": "USD- US Dollar", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89" } }

Retrieve details of a currency

Details of an existing currency.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/settings/currencies/{currency_id} -H "X-com-zoho-expense-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success.", "currency": { "currency_id": "16367000000000097", "currency_code": "USD", "currency_name": "USD- US Dollar", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89", "is_base_currency": false } }

Delete a currency

Delete an existing currency.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/settings/currencies/{currency_id} -X DELETE -H "X-com-zoho-expense-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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