API Docs
/
No Results Found
Items

Items

A product is the item offered for sale. It can be a commodity. Based on the type of your business, you can offer one or more goods.

Possible error codes:
Error CodeMessage
1000The item name already exist
2006Item does not exist
2049Items which are a part of other transactions cannot be deleted. Instead, mark them as inactive
2076Product type cannot be changed for Items having transactions

Attribute

item_id
string
Unique ID generated by the server for an item.
name
string
Name of the item. Maximum length of the name [100]
status
string
Status of the item. It can be active or inactive. It tells whether the Item is available for transactions.
description
string
Description for the item. Maximum characters to be used for describing the item [2000]
rate
double
Per unit price of an item.
unit
string
Quantifying the amount of an item, using a measurement unit.
tax_id
string
ID of the tax to be associated to the item.
tax_name
string
Name of te Tax Included
tax_percentage
string
Percent of the tax.
tax_type
string
Type of the tax.
sku
string
SKU or the Stock Keeping Unit value of an item, should be unique throughout the product
product_type
string
Specify the type of an item. It can be either goods or service
hsn_or_sac
string
🇮🇳 India
only
HSN Code
item_tax_preferences
array
Show Sub-Attributes arrow
tax_id
string
ID of the tax to be associated to the item.
tax_specification
string
🇮🇳 India
only
Set whether the tax type is intra/interstate

Example

{ "item_id": 903000000045027, "name": "Hard Drive", "status": "active", "description": "500GB", "rate": 120, "unit": "100GB", "tax_id": 982000000037049, "tax_name": "Sales Tax", "tax_percentage": "70%", "tax_type": "Service Tax", "sku": "s12345", "product_type": "goods", "hsn_or_sac": "string", "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ] }

Create an Item

Create a new item.
oauthscope : ZohoInvoice.settings.CREATE

Arguments

name
string
(Required)
Name of the item. Maximum length of the name [100]
rate
double
(Required)
Per unit price of an item.
description
string
Description for the item. Maximum characters to be used for describing the item [2000]
tax_id
string
ID of the tax to be associated to the item.
sku
string
SKU or the Stock Keeping Unit value of an item, should be unique throughout the product
product_type
string
Specify the type of an item. It can be either goods or service
is_taxable
boolean
🇺🇸 United States
, 🇨🇦 Canada
, 🇮🇳 India
only
Boolean to track the taxability of the item.
tax_exemption_id
string
🇺🇸 United States
, 🇨🇦 Canada
, 🇮🇳 India
only
ID of the tax exemption applied. Mandatory, if is_taxable is false.
hsn_or_sac
string
🇮🇳 India
only
HSN Code
item_tax_preferences
array
Show Sub-Attributes arrow
tax_id
string
ID of the tax to be associated to the item.
tax_specification
string
🇮🇳 India
only
Set whether the tax type is intra/interstate

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/items -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"}'

Body Parameters

Click to copy
{ "name": "Hard Drive", "rate": 120, "description": "500GB", "tax_id": 982000000037049, "sku": "s12345", "product_type": "goods", "is_taxable": true, "tax_exemption_id": "string", "hsn_or_sac": "string", "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ] }

Response Example

{ "code": 0, "message": "The item has been added.", "item": { "item_id": 903000000045027, "name": "Hard Drive", "status": "active", "description": "500GB", "rate": 120, "unit": "100GB", "tax_id": 982000000037049, "tax_name": "Sales Tax", "tax_percentage": "70%", "tax_type": "Service Tax", "sku": "s12345", "product_type": "goods", "hsn_or_sac": "string", "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ] } }

List items

Get the list of all active items with pagination.
oauthscope : ZohoInvoice.settings.READ

Query Parameters

name
Search items by name. Maximum length [100]. Variants: name_startswith and name_contains
description
Search items by description. Maximum length [100]. Variants: description_startswith and description_contains
rate
Search items by rate. Variants: rate_less_than, rate_less_equals, rate_greater_than and rate_greater_equals
tax_id
Search items by tax id.
filter_by
Filter items by status. Allowed Values: Status.All, Status.Active and Status.Inactive
search_text
Search items by name or description. Maximum length [100]
sort_column
Sort items. Allowed Values: name, rate and tax_name

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/items -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "items": [ { "item_id": 903000000045027, "name": "Hard Drive", "status": "active", "description": "500GB", "rate": 120, "unit": "100GB", "tax_id": 982000000037049, "tax_name": "Sales Tax", "tax_percentage": "70%", "tax_type": "Service Tax", "sku": "s12345", "product_type": "goods" }, {...}, {...} ] }

Update an item

Update the details of an existing item.
oauthscope : ZohoInvoice.settings.UPDATE

Arguments

name
string
(Required)
Name of the item. Maximum length of the name [100]
rate
double
(Required)
Per unit price of an item.
description
string
Description for the item. Maximum characters to be used for describing the item [2000]
tax_id
string
ID of the tax to be associated to the item.
sku
string
SKU or the Stock Keeping Unit value of an item, should be unique throughout the product
product_type
string
Specify the type of an item. It can be either goods or service
is_taxable
boolean
🇺🇸 United States
, 🇨🇦 Canada
, 🇮🇳 India
only
Boolean to track the taxability of the item.
tax_exemption_id
string
🇺🇸 United States
, 🇨🇦 Canada
, 🇮🇳 India
only
ID of the tax exemption applied. Mandatory, if is_taxable is false.
hsn_or_sac
string
🇮🇳 India
only
HSN Code
item_tax_preferences
array
Show Sub-Attributes arrow
tax_id
string
ID of the tax to be associated to the item.
tax_specification
string
🇮🇳 India
only
Set whether the tax type is intra/interstate

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/items/{item_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"}'

Body Parameters

Click to copy
{ "name": "Hard Drive", "rate": 120, "description": "500GB", "tax_id": 982000000037049, "sku": "s12345", "product_type": "goods", "is_taxable": true, "tax_exemption_id": "string", "hsn_or_sac": "string", "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ] }

Response Example

{ "code": 0, "message": "Item details have been saved.", "item": { "item_id": 903000000045027, "name": "Hard Drive", "status": "active", "description": "500GB", "rate": 120, "unit": "100GB", "tax_id": 982000000037049, "tax_name": "Sales Tax", "tax_percentage": "70%", "tax_type": "Service Tax", "sku": "s12345", "product_type": "goods", "hsn_or_sac": "string", "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ] } }

Retrieve an item

Fetch details of an existing item.
oauthscope : ZohoInvoice.settings.READ

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/items/{item_id} -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "item": { "item_id": 903000000045027, "name": "Hard Drive", "status": "active", "description": "500GB", "rate": 120, "unit": "100GB", "tax_id": 982000000037049, "tax_name": "Sales Tax", "tax_percentage": "70%", "tax_type": "Service Tax", "sku": "s12345", "product_type": "goods", "hsn_or_sac": "string", "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ] } }

Delete an item

Delete an existing item. Items that are part of a transaction cannot be deleted.
oauthscope : ZohoInvoice.settings.DELETE

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/items/{item_id} -X DELETE -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Mark as active

Mark an inactive item as active.
oauthscope : ZohoInvoice.settings.CREATE

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/items/{item_id}/active -X POST -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The item has been marked Active." }

Mark as inactive

Mark an active item as inactive.
oauthscope : ZohoInvoice.settings.CREATE

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/items/{item_id}/inactive -X POST -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The item has been marked Inactive." }