API Docs
/
No Results Found
Taxes

Taxes

A tax entity allows you to maintain details of a tax.(Not supported for US Version)

End Points

Attribute

tax_id
long
Unique ID for tax generated by the server. This is used as an identifier.
tax_name
string
Name of the tax.
tax_percentage
double
Tax percentage.
tax_type
string
Type of tax. Possible values are tax or compound_tax or tax_group.
is_value_added
boolean
🇨🇦 Canada
only
Whether it is a value added tax. It can either be true or false.
tax_authority_id
long
🇨🇦 Canada
only
Unique Id of the Tax Agency.
tax_authority_name
string
🇨🇦 Canada
only
Name of the Tax Agency.

Example

{ "tax_id": "16367000000086009", "tax_name": "Vat", "tax_percentage": 7, "tax_type": "tax", "is_value_added": true, "tax_authority_id": "17455000000076047", "tax_authority_name": "Canada Revenue Agency" }

Create a tax

Create a tax.

Arguments

tax_name
string
(Required)
Name of the tax.
tax_percentage
double
(Required)
Tax percentage.
tax_type
string
Type of tax. Possible values are tax or compound_tax or tax_group.
is_value_added
boolean
🇨🇦 Canada
only
Whether it is a value added tax. It can either be true or false.
tax_authority_name
string
(Required)
🇨🇦 Canada
only
Name of the Tax Agency.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/settings/taxes -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
{ "tax_name": "Vat", "tax_percentage": 7, "tax_type": "tax", "is_value_added": true, "tax_authority_name": "Canada Revenue Agency" }

Response Example

{ "code": 0, "message": "The tax has been created.", "tax": { "tax_id": "16367000000086009", "tax_name": "Vat", "tax_percentage": 7, "tax_type": "tax", "is_value_added": true, "tax_authority_id": "17455000000076047", "tax_authority_name": "Canada Revenue Agency" } }

Retrieve list of taxes

Details of all existing taxes.

Request Example

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

Response Example

{ "code": 0, "message": "success", "taxes": [ { "tax_id": "16367000000086009", "tax_name": "Vat", "tax_percentage": 7, "tax_type": "tax", "is_value_added": true, "tax_authority_id": "17455000000076047", "tax_authority_name": "Canada Revenue Agency" }, {...}, {...} ] }

Update details of a tax

Update the details of an existing tax.

Arguments

tax_name
string
Name of the tax.
tax_percentage
double
Tax percentage.
tax_type
string
Type of tax. Possible values are tax or compound_tax or tax_group.
is_value_added
boolean
🇨🇦 Canada
only
Whether it is a value added tax. It can either be true or false.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/settings/taxes/{tax_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
{ "tax_name": "Vat", "tax_percentage": 7, "tax_type": "tax", "is_value_added": true }

Response Example

{ "code": 0, "message": "The tax details has been updated.", "tax": { "tax_id": "16367000000086009", "tax_name": "Vat", "tax_percentage": 7, "tax_type": "tax", "is_value_added": true } }

Retrieve details of a tax

Details of an existing tax.

Request Example

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

Response Example

{ "code": 0, "message": "success", "tax": { "tax_id": "16367000000086009", "tax_name": "Vat", "tax_percentage": 7, "tax_type": "tax", "is_value_added": true } }

Delete a tax

Delete an existing tax.

Request Example

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

Response Example

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

Retrieve details of a tax group

Details of an existing tax group.

Request Example

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

Response Example

{ "code": 0, "message": "success", "tax_group": { "tax_group_id": "27927000000681015", "tax_group_name": "Saviour group", "tax_group_percentage": 7, "taxes": [ { "tax_id": "16367000000086009", "tax_name": "Vat", "tax_percentage": 7, "tax_type": "tax" } ] } }