API Docs
/
No Results Found
Taxes

Taxes

Your businessโ€™ financials are affected by regulatory taxes and each organization has different country specific taxes to adhere to.

End Points
Create a tax
List taxes
Update a tax
Get a tax
Delete a tax
Update a tax group
Get a tax group
Delete a tax group
Create a tax group
Create a tax authority [US and CA Edition only]
List tax authorities [US Edition only]
Update a tax authority [US and CA Edition only]
Get a tax authority [US and CA Edition only]
Delete a tax authority [US and CA Edition only]
Create a tax exemption [US Edition only]
List tax exemptions [US Edition only]
Update a tax exemption [US Edition only]
Get a tax exemption [US Edition only]
Delete a tax exemption [US Edition only]

Attribute

tax_id
string
ID of the Tax
tax_name
string
Name of the Tax
tax_percentage
double
Number of Percentage Taxable.
tax_type
string
Type to determine whether it is a simple or compound tax. Allowed Values: tax and compound_tax
tax_authority_id
string
๐Ÿ‡บ๐Ÿ‡ธ United States
only
ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
tax_authority_name
string
Name of the Tax Authority
is_value_added
boolean
Check if Tax is Value Added
tax_specific_type
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Type of Tax For Indian Edition. Allowed Values : igst ,cgst ,sgst ,nil, cess
country
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe ๐ŸŒŽ Global
only
Country to which the tax belongs.
country_code
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe GCC ๐ŸŒŽ Global
only
Two letter country code for the EU country to which the tax belongs.
purchase_tax_expense_account_id
long
๐Ÿ‡ฆ๐Ÿ‡บ Australia
, ๐Ÿ‡จ๐Ÿ‡ฆ Canada
only
Account ID in which Purchase Tax will be Computed

Example

[ { "tax_id": "982000000566009", "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_authority_id": "460000000066001", "tax_authority_name": "Illinois Department of Revenue", "is_value_added": false, "tax_specific_type": "string", "country": "string", "country_code": "UK", "purchase_tax_expense_account_id": 0 } ]

Create a tax

Create a tax which can be associated with an item.
oauthscope : ZohoBooks.settings.CREATE

Arguments

tax_name
string
Name of the Tax
tax_percentage
double
Number of Percentage Taxable.
tax_type
string
Type to determine whether it is a simple or compound tax. Allowed Values: tax and compound_tax
tax_specific_type
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Type of Tax For Indian Edition. Allowed Values : igst ,cgst ,sgst ,nil, cess
tax_authority_name
string
Name of the Tax Authority
tax_authority_id
string
๐Ÿ‡บ๐Ÿ‡ธ United States
only
ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
country_code
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe GCC ๐ŸŒŽ Global
only
Two letter country code for the EU country to which the tax belongs.
purchase_tax_expense_account_id
long
๐Ÿ‡ฆ๐Ÿ‡บ Australia
, ๐Ÿ‡จ๐Ÿ‡ฆ Canada
only
Account ID in which Purchase Tax will be Computed
is_value_added
boolean
Check if Tax is Value Added
update_recurring_invoice
boolean
Check if recurring invoice should be updated
update_recurring_expense
boolean
Check if recurring expenses should be updated
update_draft_invoice
boolean
Check if Draft Invoices should be updated
update_recurring_bills
boolean
Check if Recurring Bills should be updated
update_draft_so
boolean
Check if Draft Sales Orders should be updated
update_subscription
boolean
Check if Subscriptions should be updated
update_project
boolean
Check if Projects should be updated
is_editable
boolean
Check if tax is editable

Request Example

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

Body Parameters

Click to copy
{ "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_specific_type": "string", "tax_authority_name": "Illinois Department of Revenue", "tax_authority_id": "460000000066001", "country_code": "UK", "purchase_tax_expense_account_id": 0, "is_value_added": false, "update_recurring_invoice": false, "update_recurring_expense": false, "update_draft_invoice": false, "update_recurring_bills": false, "update_draft_so": false, "update_subscription": false, "update_project": false, "is_editable": true }

Response Example

{ "code": 0, "message": "The tax has been added.", "tax": [ { "tax_id": "982000000566009", "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_authority_id": "460000000066001", "tax_authority_name": "Illinois Department of Revenue", "is_value_added": false, "tax_specific_type": "string", "country": "string", "country_code": "UK", "purchase_tax_expense_account_id": 0 }, {...}, {...} ] }

List taxes

List of simple and compound taxes with pagination.
oauthscope : ZohoBooks.settings.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/taxes

Response Example

{ "code": 0, "message": "success", "taxes": [ { "tax_id": "982000000566009", "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_specific_type": "string", "tax_authority_id": "460000000066001", "tax_authority_name": "Illinois Department of Revenue", "is_value_added": false, "is_default_tax": true, "is_editable": true }, {...}, {...} ], "page_context": { "page": 1, "per_page": 200, "has_more_page": false, "report_name": "Taxes", "applied_filter": "Status.All", "sort_column": "created_time", "sort_order": "D" } }

Update a tax

Update the details of a simple or compound tax.
oauthscope : ZohoBooks.settings.UPDATE

Arguments

tax_id
string
ID of the Tax
tax_name
string
Name of the Tax
tax_percentage
double
Number of Percentage Taxable.
tax_type
string
Type to determine whether it is a simple or compound tax. Allowed Values: tax and compound_tax
tax_specific_type
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Type of Tax For Indian Edition. Allowed Values : igst ,cgst ,sgst ,nil, cess
tax_authority_name
string
Name of the Tax Authority
tax_authority_id
string
๐Ÿ‡บ๐Ÿ‡ธ United States
only
ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
country_code
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
, Europe GCC ๐ŸŒŽ Global
only
Two letter country code for the EU country to which the tax belongs.
purchase_tax_expense_account_id
long
๐Ÿ‡ฆ๐Ÿ‡บ Australia
, ๐Ÿ‡จ๐Ÿ‡ฆ Canada
only
Account ID in which Purchase Tax will be Computed
is_value_added
boolean
Check if Tax is Value Added
update_recurring_invoice
boolean
Check if recurring invoice should be updated
update_recurring_expense
boolean
Check if recurring expenses should be updated
update_draft_invoice
boolean
Check if Draft Invoices should be updated
update_recurring_bills
boolean
Check if Recurring Bills should be updated
update_draft_so
boolean
Check if Draft Sales Orders should be updated
update_subscription
boolean
Check if Subscriptions should be updated
update_project
boolean
Check if Projects should be updated
is_editable
boolean
Check if tax is editable

Request Example

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

Body Parameters

Click to copy
{ "tax_id": "982000000566009", "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_specific_type": "string", "tax_authority_name": "Illinois Department of Revenue", "tax_authority_id": "460000000066001", "country_code": "UK", "purchase_tax_expense_account_id": 0, "is_value_added": false, "update_recurring_invoice": false, "update_recurring_expense": false, "update_draft_invoice": false, "update_recurring_bills": false, "update_draft_so": false, "update_subscription": false, "update_project": false, "is_editable": true }

Response Example

{ "code": 0, "message": "Tax information has been saved.", "tax": [ { "tax_id": "982000000566009", "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_authority_id": "460000000066001", "tax_authority_name": "Illinois Department of Revenue", "is_value_added": false, "tax_specific_type": "string", "country": "string", "country_code": "UK", "purchase_tax_expense_account_id": 0 }, {...}, {...} ] }

Get a tax

Get the details of a simple or compound tax.
oauthscope : ZohoBooks.settings.READ

Request Example

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

Response Example

{ "code": 0, "message": "success", "tax": [ { "tax_id": "982000000566009", "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_authority_id": "460000000066001", "tax_authority_name": "Illinois Department of Revenue", "is_value_added": false, "tax_specific_type": "string", "country": "string", "country_code": "UK", "purchase_tax_expense_account_id": 0 }, {...}, {...} ] }

Delete a tax

Delete a simple or compound tax.
oauthscope : ZohoBooks.settings.DELETE

Request Example

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

Response Example

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

Update a tax group

Update the details of the tax group.
oauthscope : ZohoBooks.settings.UPDATE

Arguments

tax_group_name
string
Name of the tax group to be created.
taxes
string
Comma Seperated list of tax IDs that are to be associated to the tax group.

Request Example

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

Body Parameters

Click to copy
{ "tax_group_name": "Sales Group", "taxes": "982000000566009" }

Response Example

{ "code": 0, "message": "success", "tax_group": { "tax_group_id": "982000000566009", "tax_group_name": "Sales Group", "tax_group_percentage": 10.5, "taxes": [ { "tax_id": "982000000566009", "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_authority_id": "460000000066001", "tax_authority_name": "Illinois Department of Revenue" } ] } }

Get a tax group

Get the details of a tax group.
oauthscope : ZohoBooks.settings.READ

Request Example

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

Response Example

{ "code": 0, "message": "success", "tax_group": { "tax_group_id": "982000000566009", "tax_group_name": "Sales Group", "tax_group_percentage": 10.5, "taxes": [ { "tax_id": "982000000566009", "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_authority_id": "460000000066001", "tax_authority_name": "Illinois Department of Revenue" } ] } }

Delete a tax group

Delete a tax group. Tax group 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/taxgroups/{tax_group_id} -X DELETE

Response Example

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

Create a tax group

Create a tax group associating multiple taxes.
oauthscope : ZohoBooks.settings.CREATE

Arguments

tax_group_name
string
Name of the tax group to be created.
taxes
string
Comma Seperated list of tax IDs that are to be associated to the tax group.

Request Example

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

Body Parameters

Click to copy
{ "tax_group_name": "Sales Group", "taxes": "982000000566009" }

Response Example

{ "code": 0, "message": "success", "tax_group": { "tax_group_id": "982000000566009", "tax_group_name": "Sales Group", "tax_group_percentage": 10.5, "taxes": [ { "tax_id": "982000000566009", "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_authority_id": "460000000066001", "tax_authority_name": "Illinois Department of Revenue" } ] } }

Create a tax authority [US and CA Edition only]

Create a tax authority.
oauthscope : ZohoBooks.settings.CREATE

Arguments

tax_authority_name
string
(Required)
Name of the Tax Authority
description
string
Description.
registration_number
string
๐Ÿ‡จ๐Ÿ‡ฆ Canada
only
Registration Number of the Tax Authority
registration_number_label
string
๐Ÿ‡จ๐Ÿ‡ฆ Canada
only

Request Example

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

Body Parameters

Click to copy
{ "tax_authority_name": "Illinois Department of Revenue", "description": "The New York State Department of Taxation and Finance", "registration_number": "string", "registration_number_label": "string" }

Response Example

{ "code": 0, "message": "Tax Authority has been added.", "tax_authority": { "tax_authority_id": "460000000066001", "tax_authority_name": "Illinois Department of Revenue", "description": "The New York State Department of Taxation and Finance", "registration_number": "string", "registration_number_label": "string" } }

List tax authorities [US Edition only]

List of tax authorities.
oauthscope : ZohoBooks.settings.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/taxauthorities

Response Example

{ "code": 0, "message": "success", "tax_authorities": [ { "tax_authority_id": "460000000066001", "tax_authority_name": "Illinois Department of Revenue", "description": "The New York State Department of Taxation and Finance", "registration_number": "string", "registration_number_label": "string" }, {...}, {...} ] }

Update a tax authority [US and CA Edition only]

Update the details of a tax authority.
oauthscope : ZohoBooks.settings.UPDATE

Arguments

tax_authority_name
string
Name of the Tax Authority
description
string
Description.
registration_number
string
๐Ÿ‡จ๐Ÿ‡ฆ Canada
only
Registration Number of the Tax Authority
registration_number_label
string
๐Ÿ‡จ๐Ÿ‡ฆ Canada
only

Request Example

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

Body Parameters

Click to copy
{ "tax_authority_name": "Illinois Department of Revenue", "description": "The New York State Department of Taxation and Finance", "registration_number": "string", "registration_number_label": "string" }

Response Example

{ "code": 0, "message": "Tax Authority information has been updated.", "tax_authority": { "tax_authority_id": "460000000066001", "tax_authority_name": "Illinois Department of Revenue", "description": "The New York State Department of Taxation and Finance", "registration_number": "string", "registration_number_label": "string" } }

Get a tax authority [US and CA Edition only]

Get the details of a tax authority.
oauthscope : ZohoBooks.settings.READ

Request Example

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

Response Example

{ "code": 0, "message": "success", "tax_authority": { "tax_authority_id": "460000000066001", "tax_authority_name": "Illinois Department of Revenue", "description": "The New York State Department of Taxation and Finance", "registration_number": "string", "registration_number_label": "string" } }

Delete a tax authority [US and CA Edition only]

Delete a tax authority.
oauthscope : ZohoBooks.settings.DELETE

Request Example

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

Response Example

{ "code": 0, "message": "Tax authority has been deleted." }

Create a tax exemption [US Edition only]

Create a tax exemption.
oauthscope : ZohoBooks.settings.CREATE

Arguments

tax_exemption_code
string
(Required)
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Code of the Tax Exemption
description
string
Description
type
string
(Required)
Type of the tax exemption, can be customer or item.

Request Example

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

Body Parameters

Click to copy
{ "tax_exemption_code": "RESELLER", "description": "Tax exempted because the contact is a reseller.", "type": "customer" }

Response Example

{ "code": 0, "message": "Tax Exemption has been added.", "tax_exemption": { "tax_exemption_id": "460000000076002", "tax_exemption_code": "RESELLER", "description": "Tax exempted because the contact is a reseller.", "type": "customer" } }

List tax exemptions [US Edition only]

List of tax exemptions.
oauthscope : ZohoBooks.settings.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/settings/taxexemptions

Response Example

{ "code": 0, "message": "success", "tax_exemptions": [ { "tax_exemption_id": "460000000076002", "tax_exemption_code": "RESELLER", "description": "Tax exempted because the contact is a reseller.", "type": "customer" }, {...}, {...} ] }

Update a tax exemption [US Edition only]

Update the details of a tax exemption.
oauthscope : ZohoBooks.settings.UPDATE

Arguments

tax_exemption_code
string
(Required)
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Code of the Tax Exemption
description
string
Description
type
string
(Required)
Type of the tax exemption, can be customer or item.

Request Example

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

Body Parameters

Click to copy
{ "tax_exemption_code": "RESELLER", "description": "Tax exempted because the contact is a reseller.", "type": "customer" }

Response Example

{ "code": 0, "message": "Tax Exemption has been updated.", "tax_exemption": { "tax_exemption_id": "460000000076002", "tax_exemption_code": "RESELLER", "description": "Tax exempted because the contact is a reseller.", "type": "customer" } }

Get a tax exemption [US Edition only]

Get the details of a tax exemption.
oauthscope : ZohoBooks.settings.READ

Request Example

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

Response Example

{ "code": 0, "message": "success", "tax_exemption": { "tax_exemption_id": "460000000076002", "tax_exemption_code": "RESELLER", "description": "Tax exempted because the contact is a reseller.", "type": "customer" } }

Delete a tax exemption [US Edition only]

Delete a tax exemption.
oauthscope : ZohoBooks.settings.DELETE

Request Example

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

Response Example

{ "code": 0, "message": "Tax exemption has been deleted successfully." }