Currency
A currency is a generally accepted form of money issued by the government. Each country had its own different currency.
End Points
Create a Currency
List Currencies
Update a Currency
Get a Currency
Delete a currency
Create an exchange rate
List exchange rates
Update an exchange rate
Get an exchange rate.
Delete an exchage rate
Attribute
currency_id
string
A unique ID for the currency.
currency_code
string
A unique code for the currency.
Maximum length [100] currency_name
string
The name for the currency.
currency_symbol
string
A unique symbol for the currency.
Maximum length [4] price_precision
integer
The precision for the price in decimals
currency_format
string
The format for the currency to be displayed.
Maximum length [100] is_base_currency
boolean
If the specified currency is the base currency of the organization or not.
[
{
"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 : ZohoInvoice.settings.CREATE
Arguments
currency_code
string
(Required)
A unique code for the currency.
Maximum length [100] currency_symbol
string
(Required)
A unique symbol for the currency.
Maximum length [4] price_precision
integer
The precision for the price in decimals
currency_format
string
The format for the currency to be displayed.
Maximum length [100]$ curl https://invoice.zoho.com/api/v3/settings/currencies
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"currency_code": "AUD",
"currency_symbol": "$",
"price_precision": 2,
"currency_format": "1,234,567.89"
}
{
"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
},
{...},
{...}
]
}
List Currencies
Get list of currencies configured. oauthscope : ZohoInvoice.settings.READ
Query Parameters
filter_by
Filter currencies excluding base currency. Allowed Values:
Currencies.ExcludeBaseCurrency$ curl https://invoice.zoho.com/api/v3/settings/currencies
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"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": 0,
"effective_date": "2016-06-05"
},
{...},
{...}
]
}
Update a Currency
Update the details of a currency. oauthscope : ZohoInvoice.settings.UPDATE
Arguments
currency_code
string
(Required)
Unique code representing a currency
currency_symbol
string
(Required)
A unique symbol for the currency.
Maximum length [4] price_precision
integer
The precision for the price in decimals
currency_format
string
The format for the currency to be displayed.
Maximum length [100]$ curl https://invoice.zoho.com/api/v3/settings/currencies/{currency_id}
-X PUT
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"currency_code": "CAD",
"currency_symbol": "$",
"price_precision": 2,
"currency_format": "1,234,567.89"
}
{
"code": 0,
"message": "success.",
"currency": [
{
"currency_id": "982000000004006",
"currency_code": "CAD",
"currency_name": "CAD- Canadian 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 : ZohoInvoice.settings.READ
$ curl https://invoice.zoho.com/api/v3/settings/currencies/{currency_id}
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"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 any transaction cannot be deleted. oauthscope : ZohoInvoice.settings.DELETE
$ curl https://invoice.zoho.com/api/v3/settings/currencies/{currency_id}
-X DELETE
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "The currency has been deleted."
}
Create an exchange rate
Create an exchange rate for the specified currency. oauthscope : ZohoInvoice.settings.CREATE
Arguments
effective_date
string
Date from when the currency will be in effect.
rate
double
Rate of exchange for the currency with respect to base currency.
$ curl https://invoice.zoho.com/api/v3/settings/currencies/{currency_id}/exchangerates
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"effective_date": "2016-06-05",
"rate": 1.23
}
{
"code": 0,
"message": "The exchange rate has been added.",
"exchange_rate": 0
}
List exchange rates
List of exchange rates configured for the currency. oauthscope : ZohoInvoice.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$ curl https://invoice.zoho.com/api/v3/settings/currencies/{currency_id}/exchangerates
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success",
"exchange_rates": [
{
"exchange_rate_id": "460000000038035",
"currency_id": "982000000004012",
"currency_code": "AUD",
"effective_date": "2016-06-05",
"rate": 1.23
},
{...},
{...}
]
}
Update an exchange rate
Update the details of exchange rate for a currency. oauthscope : ZohoInvoice.settings.UPDATE
Arguments
effective_date
string
Date from when the currency will be in effect.
rate
double
Rate of exchange for the currency with respect to base currency.
$ curl https://invoice.zoho.com/api/v3/settings/currencies/{currency_id}/exchangerates/{exchange_rate_id}
-X PUT
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"effective_date": "2016-06-05",
"rate": 1.23
}
{
"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 : ZohoInvoice.settings.READ
$ curl https://invoice.zoho.com/api/v3/settings/currencies/{currency_id}/exchangerates/{exchange_rate_id}
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success",
"exchange_rate": 0
}
Delete an exchage rate
Delete an exchange rate for the specified currency. oauthscope : ZohoInvoice.settings.DELETE
$ curl https://invoice.zoho.com/api/v3/settings/currencies/{currency_id}/exchangerates/{exchange_rate_id}
-X DELETE
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "Exchange rate successfully deleted"
}