API Documentation
Introduction

Introduction

API Root Endpoint

https://inventory.zoho.com/api/v1

The Zoho Inventory API allows you to perform all the operations that you do with our web client.

Zoho Inventory API is built using REST principles which ensures predictable URLs that makes writing applications easy. This API follows HTTP rules, enabling a wide range of HTTP clients which can be used to interact with the API.

Every resource is exposed as a URL. The URL of each resource can be obtained by accessing the API Root Endpoint.

Getting Started

Example

$ curl https://inventory.zoho.com/api/v1/organizations?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

To use our API you must satisfy these prerequistes

  1. A valid Zoho username and password.
  2. An Authentication Token - authtoken in short!

Authentication

All Zoho Inventory API need to be authenticated using an authtoken.

You can obtain an authtoken in any one of the following ways:

  1. Through a URL in your browser.
  2. Programmatically using the Zoho Accounts API.

Sample Success Response

# #Fri Apr 11 06:14:13 PST 2016 AUTHTOKEN=ba4604e8e433g9c892e360d53463oec5 RESULT=TRUE

Sample Error Response

# #Fri Apr 11 06:32:13 PST 2016 CAUSE=INVALID_API_AUTHTOKEN_SCOPE RESULT=FALSE

In your browser

Obtaining an authtoken in your browser is very simple. Login to your Zoho Account and go to the URL below.

https://accounts.zoho.com/apiauthtoken/create?SCOPE=ZohoInventory/inventoryapi

Programmatically using the API

If you have chosen to obtain your authtoken via an API, please follow the instructions given below:

Submit an HTTP POST request to the below URL.

https://accounts.zoho.com/apiauthtoken/nb/create.

The POST body should include a string in the below format.

?SCOPE=ZohoInventory/inventoryapi&EMAIL_ID=[ZohoID/EmailID]&PASSWORD=[Password]

Below are the mandatory case sensitive fields to be passed in the URL.

Parameter Description
SCOPE ZohoInventory/inventoryapi
EMAIL_ID Your Zoho ID or Email ID.
PASSWORD Your Zoho password or your TFA*

* To know more about TFA and creating application password click here.

Points To Note

Organization ID

Request Example

$ curl https://inventory.zoho.com/api/v1/organizations?authtoken=ba4604e8e433g9c892e360d53463oec5

Response Example

HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "organizations": [ { "organization_id": "10234695", "name": "Zillum", "contact_name": "John Smith", "email": "johnsmith@zillum.com", "is_default_org": false, "language_code": "en", "fiscal_year_start_month": 0, "account_created_date": "2016-02-18", "time_zone": "PST", "is_org_active": true, "currency_id": "460000000000097", "currency_code": "USD", "currency_symbol": "$", "currency_format": "###,##0.00", "price_precision": 2 }, {...}, {...} ]

In Zoho Inventory, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Inventory Organization with it’s own organization ID, base currency, time zone, language, contacts, reports, etc.

The parameter organization_id along with the organization ID should be sent in with every API request to identify the organization.

The organization_id can be obtained from the GET /organizations API’s JSON response. Alternatively, it can be obtained from the Manage Organizations page in the admin console:

Login to the Zoho Inventory admin console. Click the drop down with organization’s name as the label and click Manage Organizations.

Manage Organizations

Now you’ll be able to find Organization IDs for each of your organizations.

Organization ID

HTTP Methods

Using GET method, you can get the list of resources or details of a particular instance of a resource.
 To get a list of contacts
 
$ curl https://inventory.zoho.com/api/v1/contacts?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

 To get the details of a contact referred to by a specified contact_id
 
$ curl https://inventory.zoho.com/api/v1/contacts/903000000000099?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Zoho Inventory API uses appropriate HTTP verbs for every action.

Method Description
GET Used for retrieving resources.
POST Used for creating resources and performing resource actions.
PUT Used for updating resources.
DELETE Used for deleting resources.

Response

Response Structure

The response structure for the invoice API follows the below format.
{ "code" : 0, "message" : "success", "invoice" : { "invoice_id" : "..." } }

Request Example

$ curl https://inventory.zoho.com/api/v1/invoices/7000000079426?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -H 'Accept: application/pdf'
OR
$ curl https://inventory.zoho.com/api/v1/invoices/7000000079426?accept=pdf \ '&authtoken=ba4604e8e433g9c892e360d53463oec5' \ '&organization_id=10234695'

Responses will be in the JSON format.

Node Name Description
code Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error.
message Message for the invoked API.
resource name Comprises the invoked API’s Data.

Response Header Example

HTTP/1.1 200 OK Content-Disposition: attachment; filename="INV-384.pdf" Content-Type: application/pdf;charset=UTF-8


Other Formats

Certain APIs support csv and pdf formats as well for which the required response format needs to be specified in the respective request’s Accept header or accept query parameter.



















Date

All timestamps are returned in the ISO 8601 format - YYYY-MM-DDThh:mm:ssTZD.

Example: 2016-06-11T17:38:06-0700

Errors

Request Example

$ curl https://inventory.zoho.com/api/v1/invoices/700000007942?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

HTTP/1.1 404 Not Found Content-Type: application/json;charset=UTF-8 { "code": 1002, "message": "Invoice does not exist." }

Zoho Inventory uses HTTP status codes to indicate success or failure of an API call. In general, status codes in the 2xx range means success, 4xx range means there was an error in the provided information, and those in the 5xx range indicate server side errors. Commonly used HTTP status codes are listed below.

HTTP Status Codes

Status Code Description
200 SuccessThe request was successfully completed.
201 CreatedThe request was a success and one or more resources have been created.
400 Bad requestThe request cannot be performed. Usually because of malformed parameter or missing parameter.
401 Unauthorized (Invalid AuthToken)Request was rejected because of invalid AuthToken.
404 URL Not Found The URL you’ve sent is wrong. It’s possible that the resource you’ve requested has been moved to another URL.
405 Method Not AllowedThe requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
429 Too many requests Too many requests within a certain time frame. To know more about api call limits, click here.
500 Server errorZoho Inventory server encountered an error which prevents it from fulfilling the request. Although this rarely happens, we recommend you to contact us at support@zoho-inventory.com if you receive this error.

Pagination

Example

$ curl https://inventory.zoho.com/api/v1/contacts?page=2&per_page=25 { "code": 0, "message": "success", "contacts": [ {...}, {...} ], "page_context": { "page": 2, "per_page": 25, "has_more_page": false } }

Zoho Inventory provides APIs to retrieve lists of contacts, plans and other resources - paginated to 200 items by default. The pagination information will be included in the list API response under the node name page_context.

API Call Limit

API calls are limited to provide better quality of service and availability to all the users. The limits on total calls are illustrated below:

Organizations

An Organisation represents a company or an institution running a business.

Example

{}

Attribute

Create an organization

Create an organization.

POST /organizations

Request Example

  
$ curl https://inventory.zoho.com/api/v1/organizations?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "name": "Zillium Inc", "fiscal_year_start_month": "january", "currency_code": "USD", "time_zone": "PST", "date_format": "dd MMM yyyy", "field_separator": " ", "language_code": "en", "industry_type": "Services", "industry_size": " ", "portal_name": "zilluminc", "org_address": " ", "remit_to_address": " ", "address": [ { "street_address1": " ", "street_address2": " ", "city": " ", "state": " ", "country": "U.S.A", "zip": "U.S.A" } ] }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "organization": { "organization_id": "10229182", "name": "Zillium Inc", "is_logo_uploaded": " ", "is_default_org": false, "user_role": " ", "account_created_date": "2012-02-15", "time_zone": "PST", "language_code": "en", "date_format": "dd MMM yyyy", "field_separator": " ", "fiscal_year_start_month": 0, "tax_group_enabled": true, "user_status": " ", "contact_name": "John Smith", "industry_type": "Services", "address": [ { "street_address1": " ", "street_address2": " ", "city": " ", "state": " ", "country": "U.S.A", "zip": "U.S.A" } ] } }

ARGUMENTS

name
Required
Name of the project.
fiscal_year_start_month
Optional
Fiscal or financial starting year of your business. Allowed Values: january, february, march, april, may, june, july, august, september, october, november and december
currency_code
Required
Standard code for currency.
time_zone
Required
Time zone in with the organization is located geographically.
date_format
Optional
Format for representing the date.
field_separator
Optional
Field separator for components in date.
language_code
Optional
language code for organization.For instance en represents english.
industry_type
Optional
Business type
industry_size
Optional
The size of the industry. The possibe values could be "small scale", "medium scale", "large scale"
fiscal_year_start_month
Optional
Fiscal or financial starting year of your business. Allowed Values: january, february, march, april, may, june, july, august, september, october, november and december
portal_name
Required
Poratal name for the organisation. Length of the portal name should be greater than 4 and less than 31. Allowed chars [a-z][A-Z][0-9]
org_address
Optional
Billing address of the organisation
remit_to_address
Optional
Shipping address of the organisation
Optional
Billing address of the organisation
street_address1
Optional
Street name of the Billing address of the Organisation
street_address2
Optional
Continyed billing address of the organisation
city
Optional
City of the organisation
state
Optional
State where the organisation is located
country
Optional
Country of the Organisation
zip
Optional
ZIP/Postal code of the organisation's location

Update an organization

Update the details of an organization.

PUT /organizations/:organization_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/organizations/:organization_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "name": "Zillium Inc", "fiscal_year_start_month": "january", "is_logo_uploaded": true, "time_zone": "PST", "date_format": "dd MMM yyyy", "field_separator": " ", "language_code": "en", "org_address": " ", "remit_to_address": " ", "address": [ { "street_address1": " ", "street_address2": " ", "city": " ", "state": " ", "country": "U.S.A", "zip": "U.S.A" } ], "contact_name": "John Smith", "phone": " ", "fax": " ", "website": " ", "email": "johndavid@zilliuminc.com", "currency_id": "982000000000190", "companyid_label": " ", "companyid_value": " ", "taxid_label": " ", "taxid_value": " ", "custom_fields": [ { "index": 1, "value": " ", "label": " " } ] }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "organization": { "organization_id": "10229182", "name": "Zillium Inc", "is_default_org": false, "account_created_date": "2012-02-15", "time_zone": "PST", "language_code": "en", "date_format": "dd MMM yyyy", "field_separator": " ", "fiscal_year_start_month": 0, "contact_name": "John Smith", "industry_type": "Services", "industry_size": " ", "company_id_label": "Company ID", "company_id_value": " ", "tax_id_label": "Tax ID", "tax_id_value": " ", "currency_id": "982000000000190", "currency_code": "USD", "currency_symbol": "$", "currency_format": "###,##0.00", "price_precision": 2, "org_address": " ", "remit_to_address": " ", "phone": " ", "fax": " ", "website": " ", "email": "johndavid@zilliuminc.com", "is_org_active": true, "address": [ { "street_address1": " ", "street_address2": " ", "city": " ", "state": " ", "country": "U.S.A", "zip": "U.S.A" } ], "custom_fields": [ { "index": 1, "value": " ", "label": " " } ] } }

ARGUMENTS

name
Optional
Name of the project.
fiscal_year_start_month
Optional
Fiscal or financial starting year of your business. Allowed Values: january, february, march, april, may, june, july, august, september, october, november and december
is_logo_uploaded
Optional
To determine whether logo is uploaded.
time_zone
Optional
Time zone in with the organization is located geographically.
date_format
Optional
Format for representing the date.
field_separator
Optional
Field separator for components in date.
language_code
Optional
language code for organization.For instance en represents english.
org_address
Optional
Billing address of the organisation
remit_to_address
Optional
Shipping address of the organisation
Optional
Billing address of the organisation
street_address1
Optional
Street name of the Billing address of the Organisation
street_address2
Optional
Continyed billing address of the organisation
city
Optional
City of the organisation
state
Optional
State where the organisation is located
country
Optional
Country of the Organisation
zip
Optional
ZIP/Postal code of the organisation's location
contact_name
Optional
Name of the contact person of the organisation
phone
Optional
Contact number of the organisation
fax
Optional
FAX number of the organisation
website
Optional
Organisation's website
email
Optional
email ID of the contact person of the organisation
currency_id
Optional
ID of the organisation curreency
companyid_label
Optional
Label " Company ID "
companyid_value
Optional
value in field "company ID"
taxid_label
Optional
Label "tax ID"
taxid_value
Optional
Value in "tax ID"
custom_fields
Optional
Additional fields to describe an organisation
index
Optional
Index used to list
value
Optional
Value of the list
label
Optional
Label of each column

List organizations

Get the list of organizations.

GET /organizations

Request Example

  
$ curl https://inventory.zoho.com/api/v1/organizations?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "organizations": [ { "organization_id": "10229182", "name": "Zillium Inc", "contact_name": "John Smith", "email": "johndavid@zilliuminc.com", "is_default_org": false, "plan_type": 130, "tax_group_enabled": true, "zi_migration_status": 0, "plan_name": "PROFESSIONAL", "plan_period": "Monthly", "language_code": "en", "fiscal_year_start_month": 0, "account_created_date": "2012-02-15", "account_created_date_formatted": "15 Feb 2012", "time_zone": "PST", "is_org_active": true, "currency_id": "982000000000190", "currency_code": "USD", "currency_symbol": "$", "currency_format": "###,##0.00", "price_precision": 2 }, {...}, {...} ] }

Get an organization

Get the details of an organization.

GET /organizations/:organization_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/organizations/:organization_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "organization": { "organization_id": "10229182", "name": "Zillium Inc", "is_default_org": false, "account_created_date": "2012-02-15", "time_zone": "PST", "language_code": "en", "date_format": "dd MMM yyyy", "field_separator": " ", "fiscal_year_start_month": 0, "contact_name": "John Smith", "industry_type": "Services", "industry_size": " ", "company_id_label": "Company ID", "company_id_value": " ", "tax_id_label": "Tax ID", "tax_id_value": " ", "currency_id": "982000000000190", "currency_code": "USD", "currency_symbol": "$", "currency_format": "###,##0.00", "price_precision": 2, "org_address": " ", "remit_to_address": " ", "phone": " ", "fax": " ", "website": " ", "email": "johndavid@zilliuminc.com", "is_org_active": true, "address": [ { "street_address1": " ", "street_address2": " ", "city": " ", "state": " ", "country": "U.S.A", "zip": "U.S.A" } ], "custom_fields": [ { "index": 1, "value": " ", "label": " " } ] } }

Contacts

A contact is either a customer or vendor. A contact can be an individual or a business in general.

Example

{ "contact_name": "Bowman and Co", "company_name": "Bowman and Co", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "facebook": "zoho", "twitter": "zoho", "language_code": "en", "billing_address": { "street": "Harrington Bay Street", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A" }, "shipping_address": { "street": "Harrington Bay Street", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A" }, "contact_persons": [ { "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true } ] }

Attribute

contact_name
string
Name of the contact. This can be the name of an organisation or the name of an individual. Maximum length [200]
company_name
string
Name of the conact's company. Maximum length [200]
first_name
string
First name of the contact. Maximum length [100]
last_name
string
Last name of the contact. Maximum length [100]
email
string
Search contacts by email id of the contact person. Variants: address_startswith and address_contains
phone
string
Search contacts by phone number of the contact person. Variants: phone_startswith and phone_contains
facebook
string
Facebook profile account of the contact. Maximum length [100]
twitter
string
Twitter account of the contact. MAximum length [100]
language_code
string
language of a contact. allowed values de,en,es,fr,it,ja,nl,pt,sv,zh
billing_address
object
Billing address of the contact.
street
string
Street of the customer’s billing address.
city
string
City of the customer’s billing address.
state
string
State of the customer’s billing address.
zip
string
Zip code of the customer’s billing address.
country
string
Country of the customer’s billing address.
shipping_address
object
Customer's shipping address to which the goods must be delivered.
street
string
Street of the customer’s billing address.
city
string
City of the customer’s billing address.
state
string
State of the customer’s billing address.
zip
string
Zip code of the customer’s billing address.
country
string
Country of the customer’s billing address.
contact_persons
list
Person/Individual who represents a company
salutation
string
Salutation for the contact
first_name
string
First name of the contact. Maximum length [100]
last_name
string
Last name of the contact. Maximum length [100]
email
string
Search contacts by email id of the contact person. Variants: address_startswith and address_contains
phone
string
Search contacts by phone number of the contact person. Variants: phone_startswith and phone_contains
mobile
string
Search contacts by mobile number of the contact person.
is_primary_contact
boolean
To mark contact person as primary for contact. Allowed value is true only.

Create a Contact

Create a contact with given information.

POST /contacts

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "contact_name": "Bowman and Co", "company_name": "Bowman and Co", "payment_terms": 15, "currency_id": 460000000000097, "website": "www.bowmanfurniture.com", "custom_fields": [ { "value": "GBGD078", "index": 1 } ], "billing_address": { "street": "Harrington Bay Street", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A" }, "shipping_address": { "street": "Harrington Bay Street", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A" }, "contact_persons": [ { "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true } ], "default_templates": { "invoice_template_id": 460000000052069, "invoice_template_name": "Custom Classic", "estimate_template_id": 460000000000179, "estimate_template_name": "Service - Professional", "creditnote_template_id": 460000000000211, "creditnote_template_name": "Fixed Cost - Professional", "invoice_email_template_id": 460000000052071, "invoice_email_template_name": "Custom Invoice Notification", "estimate_email_template_id": 460000000052073, "estimate_email_template_name": "Custom Estimate Notification", "creditnote_email_template_id": 460000000052075, "creditnote_email_template_name": "Custom Credit Note Notification" }, "language_code": "en", "notes": "Payment option : Through check", "tax_exemption_id": 11149000000061054, "tax_authority_id": 11149000000061052, "tax_id": 11149000000061058, "is_taxable": true, "facebook": "zoho", "twitter": "zoho" }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The contact has been created", "contact": { "contact_id": 460000000026049, "contact_name": "Bowman and Co", "company_name": "Bowman and Co", "has_transaction": true, "contact_type": "customer", "is_linked_with_zohocrm": false, "website": "www.bowmanfurniture.com", "primary_contact_id": 460000000026051, "payment_terms": 15, "payment_terms_label": "Net 15", "currency_id": 460000000000097, "currency_code": "USD", "currency_symbol": "$", "language_code": "en", "outstanding_receivable_amount": 250, "outstanding_receivable_amount_bcy": 250, "unused_credits_receivable_amount": 1369.66, "unused_credits_receivable_amount_bcy": 1369.66, "status": "active", "payment_reminder_enabled": true, "custom_fields": [ { "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "billing_address": { "street": "Harrington Bay Street", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A" }, "shipping_address": { "street": "Harrington Bay Street", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A" }, "facebook": "zoho", "twitter": "zoho", "contact_persons": [ { "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true } ], "default_templates": { "invoice_template_id": 460000000052069, "invoice_template_name": "Custom Classic", "estimate_template_id": 460000000000179, "estimate_template_name": "Service - Professional", "creditnote_template_id": 460000000000211, "creditnote_template_name": "Fixed Cost - Professional", "invoice_email_template_id": 460000000052071, "invoice_email_template_name": "Custom Invoice Notification", "estimate_email_template_id": 460000000052073, "estimate_email_template_name": "Custom Estimate Notification", "creditnote_email_template_id": 460000000052075, "creditnote_email_template_name": "Custom Credit Note Notification" }, "notes": "Payment option : Through check", "created_time": "2013-08-05T12:06:10+0530", "last_modified_time": "2013-10-07T18:24:51+0530" } }

ARGUMENTS

contact_name
Required
Name of the contact. This can be the name of an organisation or the name of an individual. Maximum length [200]
company_name
Optional
Name of the conact's company. Maximum length [200]
payment_terms
Optional
Net payment term for the customer.
currency_id
Optional
Currency ID of the customer's currency.
website
Optional
Website of the contact.
custom_fields
Optional
Custom fields or Additional of the contact which we can create to add more information.
value
Optional
Value of the custom field.
index
Optional
Index of the custom field. It can hold any value from 1 to 10.
billing_address
Optional
Billing address of the contact.
street
Optional
Street of the customer’s billing address.
city
Optional
City of the customer’s billing address.
state
Optional
State of the customer’s billing address.
zip
Optional
Zip code of the customer’s billing address.
country
Optional
Country of the customer’s billing address.
shipping_address
Optional
Customer's shipping address to which the goods must be delivered.
street
Optional
Street of the customer’s billing address.
city
Optional
City of the customer’s billing address.
state
Optional
State of the customer’s billing address.
zip
Optional
Zip code of the customer’s billing address.
country
Optional
Country of the customer’s billing address.
contact_persons
Optional
Person/Individual who represents a company
salutation
Optional
Salutation for the contact
first_name
Optional
First name of the contact. Maximum length [100]
last_name
Optional
Last name of the contact. Maximum length [100]
email
Optional
Search contacts by email id of the contact person. Variants: address_startswith and address_contains
phone
Optional
Search contacts by phone number of the contact person. Variants: phone_startswith and phone_contains
mobile
Optional
Search contacts by mobile number of the contact person.
is_primary_contact
Optional
To mark contact person as primary for contact. Allowed value is true only.
default_templates
Optional
invoice_template_id
Optional
ID of the Invoice template used
invoice_template_name
Optional
Name of the invoice template used
estimate_template_id
Optional
ID of the estimate template used
estimate_template_name
Optional
Name of the estimate template used
creditnote_template_id
Optional
ID of teh credit note template used
creditnote_template_name
Optional
Name of the credit note template used
invoice_email_template_id
Optional
ID of the invoice email tempalte used
invoice_email_template_name
Optional
Name of the Invoice email template used
estimate_email_template_id
Optional
ID of the estimate email template used
estimate_email_template_name
Optional
Name of the estimate email template used
creditnote_email_template_id
Optional
ID of the credit note email template
creditnote_email_template_name
Optional
Name of the credit note email template
language_code
Optional
language of a contact. allowed values de,en,es,fr,it,ja,nl,pt,sv,zh
notes
Optional
Commennts about the payment made by the contact.
vat_reg_no
UK Edition $ Avalara integration only
Optional
For UK Edition: VAT Registration number of a contact with VAT treatment as eu_vat_registered. Length should be between 2 and 12 characters.(This node is only available for EU VAT registered contacts.)
For Avalara: If you are doing sales in the European Union (EU) then provide VAT Registration Number of your customers here. This is used to calculate VAT for B2B sales, from Avalara.
country_code
UK Edition $ Avalara integration only
Optional
For UK Edition: Two letter country code of a contact with VAT treatment as eu_vat_registered.(This node is only available for EU VAT registered contacts.)
For Avalara: Two letter country code for the customer country, if your customer is not in US. Refer [AvaTax Codes for Countries and States][2].
vat_treatment
UK edition only
Optional
VAT treatment of the contact.Allowed Values: uk, eu_vat_not_registered, eu_vat_registered and non_eu.
avatax_exempt_no
Avalara integration only
Optional
Exemption certificate number of the customer.
avatax_use_code
Avalara integration only
Optional
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code.
tax_exemption_id
US edition only
Optional
ID of the tax exemption.
tax_authority_id
US edition only
Optional
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_id
US edition only
Optional
ID of the tax or tax group that can be collected from the contact. Tax can be given only if is_taxable is true.
is_taxable
US edition only
Optional
Boolean to track the taxability of the customer.
facebook
Optional
Facebook profile account of the contact. Maximum length [100]
twitter
Optional
Twitter account of the contact. MAximum length [100]

Update a contact

Update an existing contact. To delete a contact person remove it from the contact_persons list.

PUT /contacts/{contact_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{contact_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "contact_name": "Bowman and Co", "company_name": "Bowman and Co", "payment_terms": 15, "currency_id": 460000000000097, "website": "www.bowmanfurniture.com", "custom_fields": [ { "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "billing_address": { "street": "Harrington Bay Street", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A" }, "shipping_address": { "street": "Harrington Bay Street", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A" }, "contact_persons": [ { "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true } ], "default_templates": { "invoice_template_id": 460000000052069, "invoice_template_name": "Custom Classic", "estimate_template_id": 460000000000179, "estimate_template_name": "Service - Professional", "creditnote_template_id": 460000000000211, "creditnote_template_name": "Fixed Cost - Professional", "invoice_email_template_id": 460000000052071, "invoice_email_template_name": "Custom Invoice Notification", "estimate_email_template_id": 460000000052073, "estimate_email_template_name": "Custom Estimate Notification", "creditnote_email_template_id": 460000000052075, "creditnote_email_template_name": "Custom Credit Note Notification" }, "language_code": "en", "notes": "Payment option : Through check", "tax_exemption_id": 11149000000061054, "tax_authority_id": 11149000000061052, "tax_id": 11149000000061058, "is_taxable": true, "facebook": "zoho", "twitter": "zoho" }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Contact has been updated successfully", "contact": { "contact_id": 460000000026049, "contact_name": "Bowman and Co", "company_name": "Bowman and Co", "has_transaction": true, "contact_type": "customer", "is_linked_with_zohocrm": false, "website": "www.bowmanfurniture.com", "primary_contact_id": 460000000026051, "payment_terms": 15, "payment_terms_label": "Net 15", "currency_id": 460000000000097, "currency_code": "USD", "currency_symbol": "$", "language_code": "en", "outstanding_receivable_amount": 250, "outstanding_receivable_amount_bcy": 250, "unused_credits_receivable_amount": 1369.66, "unused_credits_receivable_amount_bcy": 1369.66, "status": "active", "payment_reminder_enabled": true, "custom_fields": [ { "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "billing_address": { "street": "Harrington Bay Street", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A" }, "shipping_address": { "street": "Harrington Bay Street", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A" }, "facebook": "zoho", "twitter": "zoho", "contact_persons": [ { "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true } ], "default_templates": { "invoice_template_id": 460000000052069, "invoice_template_name": "Custom Classic", "estimate_template_id": 460000000000179, "estimate_template_name": "Service - Professional", "creditnote_template_id": 460000000000211, "creditnote_template_name": "Fixed Cost - Professional", "invoice_email_template_id": 460000000052071, "invoice_email_template_name": "Custom Invoice Notification", "estimate_email_template_id": 460000000052073, "estimate_email_template_name": "Custom Estimate Notification", "creditnote_email_template_id": 460000000052075, "creditnote_email_template_name": "Custom Credit Note Notification" }, "notes": "Payment option : Through check", "created_time": "2013-08-05T12:06:10+0530", "last_modified_time": "2013-10-07T18:24:51+0530" } }

ARGUMENTS

contact_name
Required
Name of the contact. This can be the name of an organisation or the name of an individual. Maximum length [200]
company_name
Optional
Name of the conact's company. Maximum length [200]
payment_terms
Optional
Net payment term for the customer.
currency_id
Optional
Currency ID of the customer's currency.
website
Optional
Website of the contact.
custom_fields
Optional
Custom fields or Additional of the contact which we can create to add more information.
value
Optional
Value of the custom field.
index
Optional
Index of the custom field. It can hold any value from 1 to 10.
label
Optional
Label of the custom field.
billing_address
Optional
Billing address of the contact.
street
Optional
Street of the customer’s billing address.
city
Optional
City of the customer’s billing address.
state
Optional
State of the customer’s billing address.
zip
Optional
Zip code of the customer’s billing address.
country
Optional
Country of the customer’s billing address.
shipping_address
Optional
Customer's shipping address to which the goods must be delivered.
street
Optional
Street of the customer’s billing address.
city
Optional
City of the customer’s billing address.
state
Optional
State of the customer’s billing address.
zip
Optional
Zip code of the customer’s billing address.
country
Optional
Country of the customer’s billing address.
contact_persons
Optional
Person/Individual who represents a company
salutation
Optional
Salutation for the contact
first_name
Optional
First name of the contact. Maximum length [100]
last_name
Optional
Last name of the contact. Maximum length [100]
email
Optional
Search contacts by email id of the contact person. Variants: address_startswith and address_contains
phone
Optional
Search contacts by phone number of the contact person. Variants: phone_startswith and phone_contains
mobile
Optional
Search contacts by mobile number of the contact person.
is_primary_contact
Optional
To mark contact person as primary for contact. Allowed value is true only.
default_templates
Optional
invoice_template_id
Optional
ID of the Invoice template used
invoice_template_name
Optional
Name of the invoice template used
estimate_template_id
Optional
ID of the estimate template used
estimate_template_name
Optional
Name of the estimate template used
creditnote_template_id
Optional
ID of teh credit note template used
creditnote_template_name
Optional
Name of the credit note template used
invoice_email_template_id
Optional
ID of the invoice email tempalte used
invoice_email_template_name
Optional
Name of the Invoice email template used
estimate_email_template_id
Optional
ID of the estimate email template used
estimate_email_template_name
Optional
Name of the estimate email template used
creditnote_email_template_id
Optional
ID of the credit note email template
creditnote_email_template_name
Optional
Name of the credit note email template
language_code
Optional
language of a contact. allowed values de,en,es,fr,it,ja,nl,pt,sv,zh
notes
Optional
Commennts about the payment made by the contact.
vat_reg_no
UK Edition $ Avalara integration only
Optional
For UK Edition: VAT Registration number of a contact with VAT treatment as eu_vat_registered. Length should be between 2 and 12 characters.(This node is only available for EU VAT registered contacts.)
For Avalara: If you are doing sales in the European Union (EU) then provide VAT Registration Number of your customers here. This is used to calculate VAT for B2B sales, from Avalara.
country_code
UK Edition $ Avalara integration only
Optional
For UK Edition: Two letter country code of a contact with VAT treatment as eu_vat_registered.(This node is only available for EU VAT registered contacts.)
For Avalara: Two letter country code for the customer country, if your customer is not in US. Refer [AvaTax Codes for Countries and States][2].
vat_treatment
UK edition only
Optional
VAT treatment of the contact.Allowed Values: uk, eu_vat_not_registered, eu_vat_registered and non_eu.
avatax_exempt_no
Avalara integration only
Optional
Exemption certificate number of the customer.
avatax_use_code
Avalara integration only
Optional
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code.
tax_exemption_id
US edition only
Optional
ID of the tax exemption.
tax_authority_id
US edition only
Optional
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_id
US edition only
Optional
ID of the tax or tax group that can be collected from the contact. Tax can be given only if is_taxable is true.
is_taxable
US edition only
Optional
Boolean to track the taxability of the customer.
facebook
Optional
Facebook profile account of the contact. Maximum length [100]
twitter
Optional
Twitter account of the contact. MAximum length [100]

List contacts

List all contacts with pagination.

GET /contacts

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "contacts": [ { "contact_id": 460000000026049, "contact_name": "Bowman and Co", "company_name": "Bowman and Co", "contact_type": "customer", "status": "active", "payment_terms": 15, "payment_terms_label": "Net 15", "currency_id": 460000000000097, "currency_code": "USD", "outstanding_receivable_amount": 250, "unused_credits_receivable_amount": 1369.66, "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "created_time": "2013-08-05T12:06:10+0530", "last_modified_time": "2013-10-07T18:24:51+0530" }, {...}, {...} ] }

Query Params

contact_name
Optional
Search contacts by contact name. Maximum length [100] Variants: contact_name_startswith and contact_name_contains. Maximum length [100]
company_name
Optional
Search contacts by company name. Maximum length [100] Variants: company_name_startswith and company_name_contains
first_name
Optional
Search contacts by first name of the contact person. Maximum length [100] Variants: first_name_startswith and first_name_contains
last_name
Optional
Search contacts by last name of the contact person. Maximum length [100] Variants: last_name_startswith and last_name_contains
address
Optional
Search contacts by any of the address fields. Maximum length [100] Variants: address_startswith and address_contains
email
Optional
Search contacts by email of the contact person. Maximum length [100] Variants: email_startswith and email_contains
phone
Optional
Search contacts by phone number of the contact person. Maximum length [100] Variants: phone_startswith and phone_contains
filter_by
Optional
Filter contacts by status. Allowed Values: Status.All, Status.Active, Status.Inactive, Status.Duplicate and Status.Crm
search_text
Optional
Search contacts by contact name or notes. Maximum length [100]
sort_column
Optional
Sort contacts. Allowed Values: contact_name, first_name, last_name, email, outstanding_receivable_amount, created_time and last_modified_time

Get contact

Get details of a contact.

GET /contacts/{:contacts_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{:contacts_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "contact": { "contact_id": 460000000026049, "contact_name": "Bowman and Co", "company_name": "Bowman and Co", "has_transaction": true, "contact_type": "customer", "is_linked_with_zohocrm": false, "website": "www.bowmanfurniture.com", "primary_contact_id": 460000000026051, "payment_terms": 15, "payment_terms_label": "Net 15", "currency_id": 460000000000097, "currency_code": "USD", "currency_symbol": "$", "outstanding_receivable_amount": 250, "outstanding_receivable_amount_bcy": 250, "unused_credits_receivable_amount": 1369.66, "unused_credits_receivable_amount_bcy": 1369.66, "status": "active", "facebook": "zoho", "twitter": "zoho", "payment_reminder_enabled": true, "custom_fields": [ { "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "billing_address": { "street": "Harrington Bay Street", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A" }, "shipping_address": { "street": "Harrington Bay Street", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A" }, "contact_persons": [ { "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true } ], "default_templates": { "invoice_template_id": 460000000052069, "invoice_template_name": "Custom Classic", "estimate_template_id": 460000000000179, "estimate_template_name": "Service - Professional", "creditnote_template_id": 460000000000211, "creditnote_template_name": "Fixed Cost - Professional", "invoice_email_template_id": 460000000052071, "invoice_email_template_name": "Custom Invoice Notification", "estimate_email_template_id": 460000000052073, "estimate_email_template_name": "Custom Estimate Notification", "creditnote_email_template_id": 460000000052075, "creditnote_email_template_name": "Custom Credit Note Notification" }, "notes": "Payment option : Through check", "created_time": "2013-08-05T12:06:10+0530", "last_modified_time": "2013-10-07T18:24:51+0530" } }

Delete a contact

Delete an existing contact.

DELETE /contacts/{:contact_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The contact has been deleted." }

Mark as active

Mark a contact as active.

POST /contact/{:contact_id}/active

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contact/{:contact_id}/active?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The contact has been marked as active." }

Mark as Inactive

Mark a contact as inactive.

POST /contacts/{:contact_id}/inactive

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/inactive?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The contact has been marked as inactive." }

Enable portal access

Enable portal access for a contact

POST /contacts/{:contact_id}/portal/enable

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/portal/enable?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "contact_persons": [ { "contact_person_id": 460000000026051 } ] }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Client Portal preferences have been updated" }

ARGUMENTS

contact_persons
Required
Person/Individual who represents a company
contact_person_id
Optional
The ID of the contact person

Enable payment reminders

Enable automated payment reminders for a contact.

POST /contacts/{:contact_id}/paymentreminder/enable

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/paymentreminder/enable?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "All reminders associated with this contact have been enabled." }

Disable payment reminders

Disable automated payment reminders for a contact.

POST /contacts/{:contact_id}/paymentreminder/disable

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/paymentreminder/disable?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "All reminders associated with this contact have been stopped." }

Email statement

Email statement to the contact. If JSONString is not inputted, mail will be sent with the default mail content.

POST /contacts/{:contact_id}/statements/email

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/statements/email?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "send_from_org_email_id": true, "to_mail_ids": [ "willsmith@bowmanfurniture.com" ], "cc_mail_ids": [ "peterparker@bowmanfurniture.com" ], "subject": "Statement of transactions with Zillium Inc", "body": "Dear Customer, <br/>We have attached with this email a list of all your transactions with us for the period 01 Sep 2013 to 30 Sep 2013. You can write to us or call us if you need any assistance or clarifications. <br/>Thanks for your business.<br/>Regards<br/>Zillium Inc" }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Statement has been sent to the customer." }

ARGUMENTS

send_from_org_email_id
Optional
Boolean to trigger the email from the organization's email address
to_mail_ids
Required
Array of email addresses of the recipients.
cc_mail_ids
Optional
Array of email addresses of the recipients to be CC'd.
subject
Required
Subject of an email that has to be sent. Maximum length to be allowed [1000]
body
Required
Body/content of the email to be sent. Maximum length [5000]

Query Params

start_date
Optional
If start_date and end_date are not given, current month's statement will be sent to contact. Date format [yyyy-mm-dd]
end_date
Optional
End date for the statement. Date format [yyyy-mm-dd]
multipart_or_formdata
Optional
Files to be attached along with the statement.

Get Statement mail content

Get the mail content of a contacts billing statement.

GET /contacts/{:contact_id}/statements/email

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/statements/email?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "body": "Dear Customer, <br/>We have attached with this email a list of all your transactions with us for the period 01 Sep 2013 to 30 Sep 2013. You can write to us or call us if you need any assistance or clarifications. <br/>Thanks for your business.<br/>Regards<br/>Zillium Inc", "subject": "Statement of transactions with Zillium Inc", "to_contacts": [ { "first_name": "Will", "selected": true, "phone": "+1-925-921-9201", "email": "willsmith@bowmanfurniture.com", "contact_person_id": 460000000026051, "last_name": "Smith", "salutation": "Mr", "mobile": "+1-4054439562" } ], "file_name": "statement_BowmanandCo.pdf", "from_emails": [ { "user_name": "John Smith", "selected": true, "email": "willsmith@bowmanfurniture.com" } ], "contact_id": 460000000026049 }

Query Params

start_date
Optional
If start_date and end_date are not given, current month's statement will be sent to contact. Date format [yyyy-mm-dd]
end_date
Optional
End date for the statement. Date format [yyyy-mm-dd]

Email contact

Send email to contact.

POST /contacts/{:contact_id}/email

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/email?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "to_mail_ids": [ "willsmith@bowmanfurniture.com" ], "subject": "Welcome to Zillium Inc .", "body": "Dear Customer, <br/>We have attached with this email a list of all your transactions with us for the period 01 Sep 2013 to 30 Sep 2013. You can write to us or call us if you need any assistance or clarifications. <br/>Thanks for your business.<br/>Regards<br/>Zillium Inc" }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Email has been sent." }

ARGUMENTS

to_mail_ids
Required
Array of email addresses of the recipients.
subject
Required
Subject of an email has to be sent. Maximum length [1000]
body
Required
Body/content of the email to be sent. Maximum length [5000]
attachments
Optional
Files to be attached to the email. It has to be sent in multipart/formdata

Query Params

send_customer_statement
Optional
Send customer statement pdf with email.

List Comments

List recent activities of a contact.

GET /contacts/{:contact_id}/comments

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/comments?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "contact_comments": [ { "contact_comments": [ { "comment_id": 460000000053131, "contact_id": 460000000026049, "contact_name": "Bowman and Co", "description": "", "commented_by_id": 460000000024003, "commented_by": "David Sujin", "date": "2013-11-19", "date_description": "4 days ago", "time": "6:03 PM", "transaction_id": 460000000053123, "transaction_type": "customer_payment", "is_entity_deleted": false, "operation_type": "added" } ] }, {...}, {...} ] }

List Refunds

List the refund history of a contact.

GET /contacts/{:contact_id}/refunds

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/refunds?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "creditnote_refunds": [ { "creditnote_refund_id": 982000000567158, "creditnote_id": 982000000567134, "date": "2013-11-19", "refund_mode": "cash", "reference_number": 782364, "creditnote_number": "CN-00001", "customer_name": "Bowman & Co", "description": "", "amount_bcy": 57.15, "amount_fcy": 57.15 } ] }

Contact Persons

A contact person is an individual who acts as a representative of an organisation for communication purpose. For example, a Manager can be a contact person for an organisation.

Example

{ "contact_id": 460000000026049, "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "skype": "zoho", "designation": "Sales Engineer", "department": "Sales" }

Attribute

contact_id
string
ID of the contact person
first_name
string
First Name of the contact. Maximum length allowed [100]
last_name
string
Last Name of the contact. Maximum length allowed [100]
email
string
Email ID of the contact person. Maximum length allowed [100]
skype
string
skype address of the contact person. Maximum length [50]
designation
string
designation of the contact person in the organisation. Maximum length [50]
department
string
department to which the contact person belongs. Maximum length [50]

Create a contact person

Create a contact person for contact.

POST /contacts/contactpersons

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/contactpersons?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "contact_id": 460000000026049, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "skype": "zoho", "designation": "Sales Engineer", "department": "Sales", "enable_portal": true }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The contact person has been Created", "contact_person": [ { "contact_id": 460000000026049, "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true, "skype": "zoho", "designation": "Sales Engineer", "department": "Sales", "is_added_in_portal": true } ] }

ARGUMENTS

contact_id
Optional
ID of the contact person
salutation
Optional
Salutation for the contact. Maximum length allowed [25]
first_name
Required
First Name of the contact. Maximum length allowed [100]
last_name
Optional
Last Name of the contact. Maximum length allowed [100]
email
Optional
Email ID of the contact person. Maximum length allowed [100]
phone
Optional
Phone number of the contact person. Maximum length [50]
mobile
Optional
Mobile/Cell number of the contact person. Maximum length [50]
skype
Optional
skype address of the contact person. Maximum length [50]
designation
Optional
designation of the contact person in the organisation. Maximum length [50]
department
Optional
department to which the contact person belongs. Maximum length [50]
enable_portal
Optional
option to enable or disable portal access the contact person. allowed values true,false

Update a contact person

Update details of an existing contact person.

PUT /contacts/contactpersons/{:contact_person_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/contactpersons/{:contact_person_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "contact_id": 460000000026049, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "skype": "zoho", "designation": "Sales Engineer", "department": "Sales", "enable_portal": true }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The contactperson details has been updated.", "contact_person": [ { "contact_id": 460000000026049, "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true, "skype": "zoho", "designation": "Sales Engineer", "department": "Sales", "is_added_in_portal": true } ] }

ARGUMENTS

contact_id
Required
ID of the contact person
salutation
Optional
Salutation for the contact. Maximum length allowed [25]
first_name
Required
First Name of the contact. Maximum length allowed [100]
last_name
Optional
Last Name of the contact. Maximum length allowed [100]
email
Optional
Email ID of the contact person. Maximum length allowed [100]
phone
Optional
Phone number of the contact person. Maximum length [50]
mobile
Optional
Mobile/Cell number of the contact person. Maximum length [50]
skype
Optional
skype address of the contact person. Maximum length [50]
designation
Optional
designation of the contact person in the organisation. Maximum length [50]
department
Optional
department to which the contact person belongs. Maximum length [50]
enable_portal
Optional
option to enable or disable portal access the contact person. allowed values true,false

List contact persons

List all contacts with pagination.

GET /contacts/{:contact_id}/contactpersons

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/contactpersons?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "contact_persons": [ { "contact_id": 460000000026049, "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true, "skype": "zoho", "designation": "Sales Engineer", "department": "Sales", "is_added_in_portal": true }, {...}, {...} ] }

Get a contact person

Get the details of a contact person.

GET /contacts/{:contact_id}/contactpersons/{:contact_person_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/contactpersons/{:contact_person_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "contact_person": { "contact_id": 460000000026049, "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true, "skype": "zoho", "designation": "Sales Engineer", "department": "Sales", "is_added_in_portal": true } }

Delete a contact person

Delete an existing contact person.

DELETE /contacts/contactpersons/{:contact_person_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/contactpersons/{:contact_person_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The contact person has been deleted." }

Mark as primary contact person

Mark a contact person as primary for contact.

POST /contacts/contactpersons/{:contact_person_id}/primary

Request Example

  
$ curl https://inventory.zoho.com/api/v1/contacts/contactpersons/{:contact_person_id}/primary?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "This contact person has been marked as your primary contact person." }

Item Groups

Item Group are the products that you sell or services that you render to various clients and can be purchased from various vendors in a business. Create and manage the item groups your business deals with and also create price lists for specific item and clients.

Example

{ "group_id": 4815000000044220, "group_name": "Bags", "brand": "Brand", "manufacturer": "Bagstore", "unit": "qty", "description": "description", "is_taxable": true, "tax_id": 4815000000044043, "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "image_type": "jpg", "items": [ { "item_id": 4815000000044208, "name": "Bags-small", "status": "active", "rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "sku": "SK1234", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "image_type": "jpg" } ], "attributes": [ { "id": 4815000000044112, "name": "Bags-small", "options": [ { "id": 4815000000044112, "name": "Bags-small" } ] } ] }

Attribute

group_id
long
Unique ID generated by the server. This is used an a unique identifier.
group_name
string
Name of the Item Group.
brand
string
Brand of the Item Group.
manufacturer
string
Manufacturer of Item Group.
unit
string
Unit of measurement of the Item Group.
description
string
Description of the Item Group.
is_taxable
boolean
Boolean to track the taxability of the item.
tax_id
long
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
tax_name
string
Name of the tax applied on the Item Group.
tax_percentage
double
Percentage of the Tax
tax_type
string
Type of the Tax.
attribute_id1
long
Unique ID used by the server. This is used as an identifier.
attribute_name1
string
Name of the attribute present in the Item Group.
status
string
Status of the Item Group.
source
string
The source of the Item Group.
image_id
string
Unique ID generated by the server for the Item image. This is used as an identifier.
image_name
string
Name of the Item image.
image_type
string
Type of the image i.e., its file format.
list
The items present in the Item Group.
item_id
long
Unique ID generated by the server for the Item. This is used as an identifier.
name
string
Name of the Item.
status
string
Status of the Item Group.
rate
double
Sales price of the Item.
purchase_rate
double
Purchase price of the Item.
reorder_level
double
Reorder level of the item.
initial_stock
double
The opening stock of the item.
initial_stock_rate
double
The opening stock value of the item.
vendor_id
long
Unique ID generated by the server for the Vendor. This is used as an identifier.
vendor_name
string
Name of the preferred Vendor for purchasing this item.
stock_on_hand
double
Stock available for a particular item.
sku
string
The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory.
upc
long
The 12 digit Unique Product Code (UPC) of the item.
ean
long
Unique EAN value for the Item.
isbn
string
Unique ISBN value for the Item.
part_number
string
Part Number of the Item.
attribute_option_id1
long
Unique ID generated by the server for the attribute's options. This is used as an identifier.
attribute_option_name1
long
Name of the attribute's option.
image_id
string
Unique ID generated by the server for the Item image. This is used as an identifier.
image_name
string
Name of the Item image.
image_type
string
Type of the image i.e., its file format.
list
All the attributes present in the Item Group. Each attribute will have its own option.
id
long
Unique ID generated by the server for the attribute. This is used as an identifier.
name
string
Name of the Item.
options
list
The options present for each attribute.

Create an Item Group

A new Item Group can a be created. While creating items, user can attach image for product group by passing form-data parameter: image i.e., -F image=bag_s.jpg.

POST /itemgroups

Request Example

  
$ curl https://inventory.zoho.com/api/v1/itemgroups?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "group_name": "Bags", "brand": "Brand", "manufacturer": "Bagstore", "unit": "qty", "description": "description", "tax_id": 4815000000044043, "attribute_name1": "Small", "items": [ { "name": "Bags-small", "rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "sku": "SK1234", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_name1": "Small" } ], "attributes": [ { "id": 4815000000044112, "name": "Bags-small", "options": [ { "id": 4815000000044112, "name": "Bags-small" } ] } ] }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The Item Group has been created.", "items": { "item_id": 4815000000044208, "name": "Bags-small", "status": "active", "rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "sku": "SK1234", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "image_type": "jpg", "actual_available_stock": 2, "available_stock": 2 }, "tax_type": "Service Tax", "description": "description", "group_name": "Bags", "unit": "qty", "attribute_id1": 4815000000044112, "tax_percentage": 12, "is_taxable": true, "image_name": "bag_s.jpg", "image_type": "jpg", "tax_id": 4815000000044043, "attributes": { "id": 4815000000044112, "name": "Bags-small", "options": { "id": 4815000000044112, "name": "Bags-small" } }, "tax_name": "Sales", "image_id": 2077500000000002000, "documents": [ {...} ], "brand": "Brand", "attribute_name1": "Small", "group_id": 4815000000044220, "status": "active", "manufacturer": "Bagstore" }

ARGUMENTS

group_name
Required
Name of the Item Group.
brand
Optional
Brand of the Item Group.
manufacturer
Optional
Manufacturer of Item Group.
unit
Required
Unit of measurement of the Item Group.
description
Optional
Description of the Item Group.
tax_id
Optional
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
attribute_name1
Optional
Name of the attribute present in the Item Group.
Optional
The items present in the Item Group.
name
Required
Name of the Item.
rate
Required
Sales price of the Item.
purchase_rate
Required
Purchase price of the Item.
reorder_level
Optional
Reorder level of the item.
initial_stock
Optional
The opening stock of the item.
initial_stock_rate
Optional
The opening stock value of the item.
vendor_id
Optional
Unique ID generated by the server for the Vendor. This is used as an identifier.
sku
Optional
The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory.
upc
Optional
The 12 digit Unique Product Code (UPC) of the item.
ean
Optional
Unique EAN value for the Item.
isbn
Optional
Unique ISBN value for the Item.
part_number
Optional
Part Number of the Item.
attribute_option_name1
Optional
Name of the attribute's option.
Optional
All the attributes present in the Item Group. Each attribute will have its own option.
id
Optional
Unique ID generated by the server for the attribute. This is used as an identifier.
name
Required
Name of the Item.
Optional
The options present for each attribute.
id
Optional
Unique ID generated by the server for the attribute. This is used as an identifier.
name
Required
Name of the Item.

Retrieve an Item Group

Fetches the details for an existing Item Group.

GET /itemgroups/{itemgroup_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "items": { "item_id": 4815000000044208, "name": "Bags-small", "status": "active", "rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "sku": "SK1234", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "image_type": "jpg" }, "tax_type": "Service Tax", "description": "description", "group_name": "Bags", "unit": "qty", "attribute_id1": 4815000000044112, "tax_percentage": 12, "is_taxable": true, "image_name": "bag_s.jpg", "image_type": "jpg", "options": { "id": 4815000000044112, "name": "Bags-small" }, "tax_id": 4815000000044043, "attributes": { "id": 4815000000044112, "name": "Bags-small", "options": { "id": 4815000000044112, "name": "Bags-small" } }, "tax_name": "Sales", "image_id": 2077500000000002000, "brand": "Brand", "attribute_name1": "Small", "group_id": 4815000000044220, "status": "active", "manufacturer": "Bagstore" }

Update an Item Group

Updates the details of an existing Item Group.

PUT /itemgroups/{itemgroup_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "group_name": "Bags", "brand": "Brand", "manufacturer": "Bagstore", "unit": "qty", "description": "description", "tax_id": 4815000000044043, "attribute_name1": "Small" }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The Item Group details have been updated.", "group_id": 4815000000044220, "group_name": "Bags", "brand": "Brand", "manufacturer": "Bagstore", "unit": "qty", "description": "description", "is_taxable": true, "tax_id": 4815000000044043, "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "image_type": "jpg" }

ARGUMENTS

group_name
Required
Name of the Item Group.
brand
Optional
Brand of the Item Group.
manufacturer
Optional
Manufacturer of Item Group.
unit
Required
Unit of measurement of the Item Group.
description
Optional
Description of the Item Group.
tax_id
Optional
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
attribute_name1
Optional
Name of the attribute present in the Item Group.

Delete an Item Group

Deletes an existing Item Group from Zoho Inventory.

DELETE /itemgroups/{itemgroup_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Whooooosh! The item group and all its items have been deleted." }

List all Item Groups

Lists all the Item Groups that are present in the Zoho Inventory organization.

GET /itemgroups

Request Example

  
$ curl https://inventory.zoho.com/api/v1/itemgroups?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "itemgroups": [ { "group_id": 4815000000044220, "group_name": "Bags", "product_type": "goods", "brand": "Brand", "manufacturer": "Bagstore", "unit": "qty", "description": "description", "is_taxable": true, "tax_id": 4815000000044043, "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "tax_exemption_id": null, "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "image_type": "jpg", "items": { "item_id": 4815000000044208, "name": "Bags-small", "status": "active", "rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "sku": "SK1234", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "image_type": "jpg", "available_stock": 2, "actual_available_stock": 2 }, "created_time": "2013-01-24T12:03:25+0530", "last_modified_time": "2013-01-24T12:03:25+0530" }, {...}, {...} ] }

Mark as Active

Marks an Item group as Active.

POST /itemgroups/{itemgroup_id}/active

Request Example

  
$ curl https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}/active?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Back to business! The item group and all its items have been marked as active." }

Mark as Inactive.

Marks as Item Group as Inactive.

POST /itemgroups/{itemgroup_id}/inactive

Request Example

  
$ curl https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}/inactive?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The item group and all its items have been marked as inactive." }

Items

An item is the product that is offered for sale. Nature of the product could be physical or digital. Based on the type of your business, you can offer one or more goods/services. Your product can be either fixed priced or a subscription service. Each of this may fall under a separate pricing category or have add ons associated to them.

Example

{ "group_id": 4815000000044220, "group_name": "Bags", "unit": "qty", "item_type": "inventory", "product_type": "goods", "is_taxable": true, "tax_id": 4815000000044043, "description": "description", "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "purchase_account_id": 4815000000035003, "purchase_account_name": "Cost of Goods Sold", "account_id": 4815000000000388, "account_name": "Sales", "inventory_account_id": 4815000000035001, "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "item_id": 4815000000044208, "name": "Bags-small", "rate": 6, "pricebook_rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "purchase_description": "Purchase description", "image_type": "jpg" }

Attribute

group_id
string
Unique ID generated by the server for the group to which the item belongs, if any. This is used as an identifier.
group_name
string
Name of product group
unit
string
Unit of measurement for the item.
item_type
string
Item type can be inventory, sales, purchases or sales_and_purchases. If item is associated with a group, then type should be inventory.
product_type
string
Type of the product. It can be goods or service
is_taxable
boolean
Boolean to track the taxability of the item.
tax_id
long
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
description
string
Description of the Item.
tax_name
string
Name of the tax applied on the Item Group.
tax_percentage
double
Percentage of the Tax
tax_type
string
Type of the Tax.
purchase_account_id
long
Unique ID generated by the server for the Purchase account.
purchase_account_name
string
Name of the Purchase Account
account_id
long
Unique ID generated by the server for the Sales account.
account_name
string
Name of the Sales Account.
inventory_account_id
long
Uniquq ID generated by the server for the Inventory account.
attribute_id1
long
Unique ID used by the server. This is used as an identifier.
attribute_name1
string
Name of the attribute present in the Item Group.
status
string
Status of the Item Group.
source
string
The source of the Item Group.
item_id
long
Unique ID generated by the server for the Item. This is used as an identifier.
name
string
Name of the Item.
rate
double
Sales price of the Item.
pricebook_rate
double
Pricelist rate applied on the item.
purchase_rate
double
Purchase price of the Item.
reorder_level
double
Reorder level of the item.
initial_stock
double
The opening stock of the item.
initial_stock_rate
double
The opening stock value of the item.
vendor_id
long
Unique ID generated by the server for the Vendor. This is used as an identifier.
vendor_name
string
Name of the preferred Vendor for purchasing this item.
stock_on_hand
double
Stock available for a particular item.
sku
string
The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory.
upc
long
The 12 digit Unique Product Code (UPC) of the item.
ean
long
Unique EAN value for the Item.
isbn
string
Unique ISBN value for the Item.
part_number
string
Part Number of the Item.
attribute_option_id1
long
Unique ID generated by the server for the attribute's options. This is used as an identifier.
attribute_option_name1
long
Name of the attribute's option.
image_id
long
Unique ID generated by the server for the item image. This is used as an identifier.
image_name
string
Image name of the Item.
purchase_description
string
The description for the purchase information. This will be displayed to the vendor in your purchase order.
image_type
string
Type of the image i.e., its file format.

Create an item

Creates a new item in Zoho Inventory.

POST /items

Request Example

  
$ curl https://inventory.zoho.com/api/v1/items?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "group_id": 4815000000044220, "group_name": "Bags", "unit": "qty", "item_type": "inventory", "product_type": "goods", "is_taxable": true, "tax_id": 4815000000044043, "description": "description", "purchase_account_id": 4815000000035003, "inventory_account_id": 4815000000035001, "attribute_name1": "Small", "name": "Bags-small", "rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_name1": "Small", "purchase_description": "Purchase description" }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The item has been added.", "item": { "group_id": 4815000000044220, "group_name": "Bags", "item_id": 4815000000044208, "name": "Bags-small", "unit": "qty", "item_type": "inventory", "product_type": "goods", "is_taxable": true, "tax_id": 4815000000044043, "description": "description", "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "purchase_account_id": 4815000000035003, "purchase_account_name": "Cost of Goods Sold", "account_name": "Sales", "inventory_account_id": 4815000000035001, "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "rate": 6, "pricebook_rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "available_stock": 2, "actual_available_stock": 2, "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "purchase_description": "Purchase description", "image_type": "jpg" } }

ARGUMENTS

group_id
Optional
Unique ID generated by the server for the group to which the item belongs, if any. This is used as an identifier.
group_name
Optional
Name of product group
unit
Optional
Unit of measurement for the item.
documents
Optional
List of all the documents associated with the item
item_type
Optional
Item type can be inventory, sales, purchases or sales_and_purchases. If item is associated with a group, then type should be inventory.
product_type
Optional
Type of the product. It can be goods or service
is_taxable
Optional
Boolean to track the taxability of the item.
tax_id
Optional
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
description
Optional
Description of the Item.
purchase_account_id
Optional
Unique ID generated by the server for the Purchase account.
inventory_account_id
Optional
Uniquq ID generated by the server for the Inventory account.
attribute_name1
Optional
Name of the attribute present in the Item Group.
name
Required
Name of the Item.
rate
Optional
Sales price of the Item.
purchase_rate
Optional
Purchase price of the Item.
reorder_level
Optional
Reorder level of the item.
initial_stock
Optional
The opening stock of the item.
initial_stock_rate
Optional
The opening stock value of the item.
vendor_id
Optional
Unique ID generated by the server for the Vendor. This is used as an identifier.
vendor_name
Optional
Name of the preferred Vendor for purchasing this item.
sku
Optional
The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory.
upc
Optional
The 12 digit Unique Product Code (UPC) of the item.
ean
Optional
Unique EAN value for the Item.
isbn
Optional
Unique ISBN value for the Item.
part_number
Optional
Part Number of the Item.
attribute_option_name1
Optional
Name of the attribute's option.
purchase_description
Optional
The description for the purchase information. This will be displayed to the vendor in your purchase order.

Retrieve an item

Fetches the details for an existing item.

GET /items/{item_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/items/{item_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "item": { "group_id": 4815000000044220, "group_name": "Bags", "item_id": 4815000000044208, "name": "Bags-small", "unit": "qty", "item_type": "inventory", "product_type": "goods", "is_taxable": true, "tax_id": 4815000000044043, "description": "description", "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "purchase_account_id": 4815000000035003, "purchase_account_name": "Cost of Goods Sold", "account_name": "Sales", "inventory_account_id": 4815000000035001, "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "rate": 6, "pricebook_rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "purchase_description": "Purchase description", "image_type": "jpg" } }

Update an item

Update the details of an item.

PUT /items/{item_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/items/{item_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "group_id": 4815000000044220, "group_name": "Bags", "unit": "qty", "item_type": "inventory", "product_type": "goods", "is_taxable": true, "tax_id": 4815000000044043, "description": "description", "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "purchase_account_id": 4815000000035003, "purchase_account_name": "Cost of Goods Sold", "account_name": "Sales", "inventory_account_id": 4815000000035001, "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "name": "Bags-small", "rate": 6, "pricebook_rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "purchase_description": "Purchase description", "image_type": "jpg" }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Item details have been updated", "item": { "group_id": 4815000000044220, "group_name": "Bags", "item_id": 4815000000044208, "name": "Bags-small", "unit": "qty", "item_type": "inventory", "product_type": "goods", "is_taxable": true, "tax_id": 4815000000044043, "description": "description", "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "purchase_account_id": 4815000000035003, "purchase_account_name": "Cost of Goods Sold", "account_name": "Sales", "inventory_account_id": 4815000000035001, "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "rate": 6, "pricebook_rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "available_stock": 2, "actual_available_stock": 2, "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "purchase_description": "Purchase description", "image_type": "jpg" } }

ARGUMENTS

group_id
Optional
Unique ID generated by the server for the group to which the item belongs, if any. This is used as an identifier.
group_name
Optional
Name of product group
unit
Optional
Unit of measurement for the item.
item_type
Optional
Item type can be inventory, sales, purchases or sales_and_purchases. If item is associated with a group, then type should be inventory.
product_type
Optional
Type of the product. It can be goods or service
is_taxable
Optional
Boolean to track the taxability of the item.
tax_id
Optional
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
description
Optional
Description of the Item.
tax_name
Optional
Name of the tax applied on the Item Group.
tax_percentage
Optional
Percentage of the Tax
tax_type
Optional
Type of the Tax.
purchase_account_id
Optional
Unique ID generated by the server for the Purchase account.
purchase_account_name
Optional
Name of the Purchase Account
account_name
Optional
Name of the Sales Account.
inventory_account_id
Optional
Uniquq ID generated by the server for the Inventory account.
attribute_id1
Optional
Unique ID used by the server. This is used as an identifier.
attribute_name1
Optional
Name of the attribute present in the Item Group.
status
Optional
Status of the Item Group.
source
Optional
The source of the Item Group.
name
Required
Name of the Item.
rate
Optional
Sales price of the Item.
pricebook_rate
Optional
Pricelist rate applied on the item.
purchase_rate
Optional
Purchase price of the Item.
reorder_level
Optional
Reorder level of the item.
initial_stock
Optional
The opening stock of the item.
initial_stock_rate
Optional
The opening stock value of the item.
vendor_id
Optional
Unique ID generated by the server for the Vendor. This is used as an identifier.
vendor_name
Optional
Name of the preferred Vendor for purchasing this item.
stock_on_hand
Optional
Stock available for a particular item.
sku
Optional
The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory.
upc
Optional
The 12 digit Unique Product Code (UPC) of the item.
ean
Optional
Unique EAN value for the Item.
isbn
Optional
Unique ISBN value for the Item.
part_number
Optional
Part Number of the Item.
attribute_option_id1
Optional
Unique ID generated by the server for the attribute's options. This is used as an identifier.
attribute_option_name1
Optional
Name of the attribute's option.
image_id
Optional
Unique ID generated by the server for the item image. This is used as an identifier.
image_name
Optional
Image name of the Item.
purchase_description
Optional
The description for the purchase information. This will be displayed to the vendor in your purchase order.
image_type
Optional
Type of the image i.e., its file format.

Delete an item

Deletes an existing item from Zoho Inventory.

DELETE /items/{item_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/items/{item_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The item has been deleted." }

Delete an item image

Deletes the image associated for an item in Zoho Inventory.

DELETE /items/{item_id}/image

Request Example

  
$ curl https://inventory.zoho.com/api/v1/items/{item_id}/image?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The item image has been deleted." }

List all the items

Lists all the items present in Zoho Inventory.

GET /items

Request Example

  
$ curl https://inventory.zoho.com/api/v1/items?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "items": [ { "group_id": 4815000000044220, "group_name": "Bags", "item_id": 4815000000044208, "name": "Bags-small", "status": "active", "is_linked_with_zohocrm": false, "item_type": "inventory", "description": "description", "rate": 6, "is_taxable": true, "tax_id": 4815000000044043, "tax_name": "Sales", "tax_percentage": 12, "purchase_description": "Purchase description", "purchase_rate": 6, "is_combo_product": false, "product_type": "goods", "attribute_id1": 4815000000044112, "attribute_name1": "Small", "reorder_level": 5, "stock_on_hand": 50, "available_stock": 2, "actual_available_stock": 2, "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_name": "bag_s.jpg", "image_type": "jpg", "created_time": "2013-01-24T12:03:25+0530", "last_modified_time": "2013-01-24T12:03:25+0530" }, {...}, {...} ] }

Mark as active

Changes the status of an item to active.

POST /items/{item_id}/active

Request Example

  
$ curl https://inventory.zoho.com/api/v1/items/{item_id}/active?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The item has been marked as Active." }

Mark as inactive

Mark an item as inactive.

POST /items/{item_id}/inactive

Request Example

  
$ curl https://inventory.zoho.com/api/v1/items/{item_id}/inactive?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The item has been marked as Inactive." }

Composite Items

A form or version of an composite item that differs in some respect from other forms of the same or from a standard. You can create your composite items by associating multiple items and their respective quantities.

Example

{ "name": "Combo of Apple IPhone and Smartwatch", "sku": "SKUIS", "unit": "units", "description": "Composite Item sales description", "purchase_description": "Composite item purchase description", "composite_item_id": 504366000000053250, "rate": 85000, "pricebook_rate": 85000, "initial_stock": 2, "initial_stock_rate": 30000, "upc": 746325287436, "ean": 5789414385764, "isbn": 368302334, "part_number": "JHFKE7GK7", "status": "active", "is_combo_product": true, "item_type": "inventory", "is_taxable": true, "reorder_level": 1, "vendor_id": 504366000000053250, "line_item_id": 504366000000053250, "quantity": 1, "item_id": 504366000000053200, "tax_id": 504366000000053100, "tax_name": "VAT", "tax_percentage": 13, "tax_type": "tax", "custom_fields": [ { "custom_field_id": 504366000000053400, "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "available_stock": 2, "actual_available_stock": 2, "stock_on_hand": 2, "mapped_items": [ { "line_item_id": 504366000000053250, "item_id": 504366000000053200, "name": "Combo of Apple IPhone and Smartwatch", "rate": 85000, "purchase_rate": 30000, "sku": "SKUIS", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "image_type": "jpg", "unit": "units", "is_combo_product": true, "description": "Composite Item sales description", "quantity": 1, "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2 } ] }

Attribute

name
string
Name of the composite item
sku
string
Stock Keeping Unit value of the item. It should be unique throughout the product
unit
string
Unit of Item
description
string
Description of the item
purchase_description
string
Purchase description of the item
composite_item_id
long
Unique ID generated for the composite item by the server. This is used as identifier
rate
double
Selling price of the item
pricebook_rate
double
Price list applied on the item's selling price.
initial_stock
double
Initial stock of item
initial_stock_rate
double
Average purchase price of initial stock. This is required for FIFO cost lot tracking and inventory valuation
upc
long
Unique Product Code, 12 digit unique code of the item
ean
long
European Article Number, 13 digit barcode number of the item
isbn
long
International Standard Book Number, 13 digit unique commercial book identifier barcode of the item
part_number
string
MPN - Manufacturing Part Number, unambiguously identifies a part design
status
string
Status of the Item
is_combo_product
boolean
Defines whether the item is composite or not true for composite items
item_type
string
Type of item Always inventory
is_taxable
boolean
To check if the item is taxable or not true if the item is taxable, else false
reorder_level
double
Reorder point of the item
vendor_id
long
Unique ID generated by the server for preferred vendor to buy this composite item
line_item_id
long
Unique ID generated by the server for mapping the associated item with composite item
quantity
double
Quantity of item associated with the composite item
item_id
long
Unique ID of the associated item
tax_id
long
Unique ID generated by the server for the tax .
tax_name
string
Name of the tax applied on selling this item
tax_percentage
double
Percentage at which the item is taxed
tax_type
string
Type of tax. It can either Tax or Group Tax
custom_fields
list
Custom fields are used to add more information about the item
custom_field_id
long
Unique ID generated by the server for the custom field.
value
string
Value of the custom field.
index
Integer
Index of the custom field. It can hold any value from 1 to 10.
label
string
Label of the custom field.
available_stock
decimal
Stock based on Shipments and Receives
actual_available_stock
decimal
Stock based on Shipments and Receives minus ordered stock
stock_on_hand
decimal
Stock based on Invoices and Bills
asset_value
decimal
value of the composite items based on purchase rate
mapped_items
list
Items that are associated with the composite item
line_item_id
long
Unique ID generated by the server for mapping the associated item with composite item
item_id
long
Unique ID of the associated item
name
string
Name of the composite item
rate
double
Selling price of the item
purchase_rate
double
Buying price of the item
sku
string
Stock Keeping Unit value of the item. It should be unique throughout the product
image_id
long
Unique identifier generated by the server for item image
image_name
string
Name of the image
purchase_description
string
Purchase description of the item
image_type
string
Type of the image Only images with gif,png,jpeg,jpg,bmp extensions are allowed
unit
string
Unit of Item
is_combo_product
boolean
Defines whether the item is composite or not true for composite items
description
string
Description of the item
quantity
double
Quantity of item associated with the composite item
stock_on_hand
decimal
Stock based on Invoices and Bills
available_stock
decimal
Stock based on Shipments and Receives
actual_available_stock
decimal
Stock based on Shipments and Receives minus ordered stock

Creating a Composite Item

A new composite item can be created after creating items that we want to associcate with composite item. User can attach image for composite item by calling Different API 'https://inventory.zoho.com/api/v1/compositeitems/{composite_item_id}/image', passing form-data parameter image i.e. -F image=bag_s.jpg

POST /compositeitems

Request Example

  
$ curl https://inventory.zoho.com/api/v1/compositeitems?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "name": "Combo of Apple IPhone and Smartwatch", "mapped_items": [ { "quantity": 1, "item_id": 504366000000053200, "line_item_id": 504366000000053250 } ], "description": "Composite Item sales description", "is_combo_product": true, "vendor_id": 504366000000053250, "purchase_rate": 30000, "purchase_description": "Composite item purchase description", "initial_stock": 2, "initial_stock_rate": 30000, "tax_id": 504366000000053100, "sku": "SKUIS", "isbn": 368302334, "ean": 5789414385764, "part_number": "JHFKE7GK7", "reorder_level": 1, "unit": "units", "upc": 746325287436, "item_type": "inventory", "rate": 85000, "custom_fields": [ { "custom_field_id": 504366000000053400, "value": "GBGD078" } ], "account_id": 504366000000000400, "purchase_account_id": 504366000000034000, "inventory_account_id": 504366000000034000 }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The item has been added.", "composite_item": { "composite_item_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "unit": "units", "tax_id": 504366000000053100, "description": "Composite Item sales description", "tax_name": "VAT", "tax_percentage": 13, "tax_type": "tax", "purchase_account_id": 504366000000034000, "purchase_account_name": "Cost of Goods Sold", "account_id": 504366000000000400, "account_name": "sales", "inventory_account_id": 504366000000034000, "inventory_account_name": "Inventory Asset", "status": "active", "source": "user", "is_combo_product": true, "item_type": "inventory", "rate": 85000, "pricebook_rate": 85000, "purchase_rate": 30000, "reorder_level": 1, "initial_stock": 2, "initial_stock_rate": 30000, "vendor_id": 504366000000053250, "vendor_name": "Mr. vendor combo", "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2, "sku": "SKUIS", "upc": 746325287436, "ean": 5789414385764, "isbn": 368302334, "part_number": "JHFKE7GK7", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "custom_fields": [ { "custom_field_id": 504366000000053400, "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "mapped_items": [ { "line_item_id": 504366000000053250, "item_id": 504366000000053200, "name": "Combo of Apple IPhone and Smartwatch", "rate": 85000, "purchase_rate": 30000, "sku": "SKUIS", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "image_type": "jpg", "unit": "units", "is_combo_product": true, "description": "Composite Item sales description", "quantity": 1, "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2 } ] } }

ARGUMENTS

name
Required
Name of the composite item
mapped_items
Required
Items that are associated with the composite item
quantity
Optional
Quantity of item associated with the composite item
item_id
Required
Unique ID of the associated item
line_item_id
Optional
Unique ID generated by the server for mapping the associated item with composite item
description
Optional
Description of the item
is_combo_product
Optional
Defines whether the item is composite or not true for composite items
vendor_id
Optional
Unique ID generated by the server for preferred vendor to buy this composite item
purchase_rate
Optional
Buying price of the item
purchase_description
Optional
Purchase description of the item
initial_stock
Optional
Initial stock of item
initial_stock_rate
Optional
Average purchase price of initial stock. This is required for FIFO cost lot tracking and inventory valuation
tax_id
Optional
Unique ID generated by the server for the tax .
sku
Required
Stock Keeping Unit value of the item. It should be unique throughout the product
isbn
Optional
International Standard Book Number, 13 digit unique commercial book identifier barcode of the item
ean
Optional
European Article Number, 13 digit barcode number of the item
part_number
Optional
MPN - Manufacturing Part Number, unambiguously identifies a part design
reorder_level
Optional
Reorder point of the item
unit
Optional
Unit of Item
upc
Optional
Unique Product Code, 12 digit unique code of the item
item_type
Required
Type of item Always inventory
rate
Required
Selling price of the item
custom_fields
Optional
Custom fields are used to add more information about the item
custom_field_id
Optional
Unique ID generated by the server for the custom field.
value
Optional
Value of the custom field.
account_id
Optional
Unique ID generated by the server for the type of sale of this item
purchase_account_id
Optional
Unique ID generated by the server for the type of purchase
inventory_account_id
Optional
Unique ID generated by the server for the type of inventory for this item

Retrieving a Composite Item

Retrieving details of an existing compostie item

GET /compositeitems/{:composite_item_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/compositeitems/{:composite_item_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "purchase_account_name": "Cost of Goods Sold", "reorder_level": 1, "tax_type": "tax", "purchase_description": "Composite item purchase description", "source": "user", "description": "Composite Item sales description", "initial_stock": 2, "composite_item_id": 504366000000053250, "unit": "units", "stock_on_hand": 2, "tax_percentage": 13, "image_name": "img1.jpg", "available_stock": 2, "item_type": "inventory", "part_number": "JHFKE7GK7", "inventory_account_id": 504366000000034000, "account_id": 504366000000000400, "mapped_items": [ { "line_item_id": 504366000000053250, "item_id": 504366000000053200, "name": "Combo of Apple IPhone and Smartwatch", "rate": 85000, "purchase_rate": 30000, "sku": "SKUIS", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "image_type": "jpg", "unit": "units", "is_combo_product": true, "description": "Composite Item sales description", "quantity": 1, "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2 } ], "vendor_name": "Mr. vendor combo", "initial_stock_rate": 30000, "isbn": 368302334, "tax_id": 504366000000053100, "upc": 746325287436, "tax_name": "VAT", "is_combo_product": true, "purchase_account_id": 504366000000034000, "rate": 85000, "vendor_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "custom_fields": [ { "custom_field_id": 504366000000053400, "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "image_id": 8408722000000019000, "inventory_account_name": "Inventory Asset", "pricebook_rate": 85000, "purchase_rate": 30000, "status": "active", "sku": "SKUIS", "account_name": "sales", "ean": 5789414385764, "actual_available_stock": 2 }

Updating a composite item

Updating details of an existing composite item

PUT /compositeitems/{:composite_item_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/compositeitems/{:composite_item_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "composite_item_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "unit": "units", "tax_id": 504366000000053100, "description": "Composite Item sales description", "tax_name": "VAT", "tax_percentage": 13, "tax_type": "tax", "purchase_account_id": 504366000000034000, "purchase_account_name": "Cost of Goods Sold", "account_id": 504366000000000400, "account_name": "sales", "inventory_account_id": 504366000000034000, "inventory_account_name": "Inventory Asset", "status": "active", "source": "user", "is_combo_product": true, "item_type": "inventory", "rate": 85000, "pricebook_rate": 85000, "purchase_rate": 30000, "reorder_level": 1, "initial_stock": 2, "initial_stock_rate": 30000, "vendor_id": 504366000000053250, "vendor_name": "Mr. vendor combo", "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2, "sku": "SKUIS", "upc": 746325287436, "ean": 5789414385764, "isbn": 368302334, "part_number": "JHFKE7GK7", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "custom_fields": [ { "custom_field_id": 504366000000053400, "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "mapped_items": [ { "line_item_id": 504366000000053250, "item_id": 504366000000053200, "name": "Combo of Apple IPhone and Smartwatch", "rate": 85000, "purchase_rate": 30000, "sku": "SKUIS", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "image_type": "jpg", "unit": "units", "is_combo_product": true, "description": "Composite Item sales description", "quantity": 1, "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2 } ] }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Item details have been saved.", "composite_item": { "composite_item_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "unit": "units", "tax_id": 504366000000053100, "description": "Composite Item sales description", "tax_name": "VAT", "tax_percentage": 13, "tax_type": "tax", "purchase_account_id": 504366000000034000, "purchase_account_name": "Cost of Goods Sold", "account_id": 504366000000000400, "account_name": "sales", "inventory_account_id": 504366000000034000, "inventory_account_name": "Inventory Asset", "status": "active", "source": "user", "is_combo_product": true, "item_type": "inventory", "rate": 85000, "pricebook_rate": 85000, "purchase_rate": 30000, "reorder_level": 1, "initial_stock": 2, "initial_stock_rate": 30000, "vendor_id": 504366000000053250, "vendor_name": "Mr. vendor combo", "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2, "sku": "SKUIS", "upc": 746325287436, "ean": 5789414385764, "isbn": 368302334, "part_number": "JHFKE7GK7", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "custom_fields": [ { "custom_field_id": 504366000000053400, "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "mapped_items": [ { "line_item_id": 504366000000053250, "item_id": 504366000000053200, "name": "Combo of Apple IPhone and Smartwatch", "rate": 85000, "purchase_rate": 30000, "sku": "SKUIS", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "image_type": "jpg", "unit": "units", "is_combo_product": true, "description": "Composite Item sales description", "quantity": 1, "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2 } ] } }

ARGUMENTS

composite_item_id
Optional
Unique ID generated for the composite item by the server. This is used as identifier
name
Required
Name of the composite item
unit
Optional
Unit of Item
tax_id
Optional
Unique ID generated by the server for the tax .
description
Optional
Description of the item
tax_name
Optional
Name of the tax applied on selling this item
tax_percentage
Optional
Percentage at which the item is taxed
tax_type
Optional
Type of tax. It can either Tax or Group Tax
purchase_account_id
Optional
Unique ID generated by the server for the type of purchase
purchase_account_name
Optional
Type of purchase under which the composite item was bought
account_id
Optional
Unique ID generated by the server for the type of sale of this item
account_name
Optional
Type of sale under which the composite item is sold
inventory_account_id
Optional
Unique ID generated by the server for the type of inventory for this item
inventory_account_name
Optional
Name of inventory type
status
Optional
Status of the Item
source
Optional
source
is_combo_product
Optional
Defines whether the item is composite or not true for composite items
item_type
Required
Type of item Always inventory
rate
Required
Selling price of the item
pricebook_rate
Optional
Price list applied on the item's selling price.
purchase_rate
Optional
Buying price of the item
reorder_level
Optional
Reorder point of the item
initial_stock
Optional
Initial stock of item
initial_stock_rate
Optional
Average purchase price of initial stock. This is required for FIFO cost lot tracking and inventory valuation
vendor_id
Optional
Unique ID generated by the server for preferred vendor to buy this composite item
vendor_name
Optional
Name of the preferred vendor
stock_on_hand
Optional
Stock based on Invoices and Bills
asset_value
Optional
value of the composite items based on purchase rate
available_stock
Optional
Stock based on Shipments and Receives
actual_available_stock
Optional
Stock based on Shipments and Receives minus ordered stock
sku
Required
Stock Keeping Unit value of the item. It should be unique throughout the product
upc
Optional
Unique Product Code, 12 digit unique code of the item
ean
Optional
European Article Number, 13 digit barcode number of the item
isbn
Optional
International Standard Book Number, 13 digit unique commercial book identifier barcode of the item
part_number
Optional
MPN - Manufacturing Part Number, unambiguously identifies a part design
image_id
Optional
Unique identifier generated by the server for item image
image_name
Optional
Name of the image
purchase_description
Optional
Purchase description of the item
custom_fields
Optional
Custom fields are used to add more information about the item
custom_field_id
Optional
Unique ID generated by the server for the custom field.
value
Optional
Value of the custom field.
index
Optional
Index of the custom field. It can hold any value from 1 to 10.
label
Optional
Label of the custom field.
mapped_items
Required
Items that are associated with the composite item
line_item_id
Optional
Unique ID generated by the server for mapping the associated item with composite item
item_id
Optional
Unique ID of the associated item
name
Required
Name of the composite item
rate
Required
Selling price of the item
purchase_rate
Optional
Buying price of the item
sku
Required
Stock Keeping Unit value of the item. It should be unique throughout the product
image_id
Optional
Unique identifier generated by the server for item image
image_name
Optional
Name of the image
purchase_description
Optional
Purchase description of the item
image_type
Optional
Type of the image Only images with gif,png,jpeg,jpg,bmp extensions are allowed
unit
Optional
Unit of Item
is_combo_product
Optional
Defines whether the item is composite or not true for composite items
description
Optional
Description of the item
quantity
Optional
Quantity of item associated with the composite item
stock_on_hand
Optional
Stock based on Invoices and Bills
available_stock
Optional
Stock based on Shipments and Receives
actual_available_stock
Optional
Stock based on Shipments and Receives minus ordered stock

Deleting a Composite Item

Deleting an existing Composite Item

DELETE /compositeitems/{:composite_item_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/compositeitems/{:composite_item_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The item has been deleted." }

Mark as Active

Changing status of an existing composite item to active

POST /compositeitems/{composite_item_id}/active

Request Example

  
$ curl https://inventory.zoho.com/api/v1/compositeitems/{composite_item_id}/active?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Re-activation complete! The item is back in business!" }

Mark as Inactive

Changing status of an existing composite item to inactive

POST /compositeitems/{:composite_item_id}/inactive

Request Example

  
$ curl https://inventory.zoho.com/api/v1/compositeitems/{:composite_item_id}/inactive?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The item has been marked as inactive." }

List All Composite Items

List of all composite items

GET /compositeitems

Request Example

  
$ curl https://inventory.zoho.com/api/v1/compositeitems?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "composite_items": [ { "composite_item_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "status": "active", "source": "user", "description": "Composite Item sales description", "rate": 85000, "tax_id": 504366000000053100, "tax_name": "VAT", "tax_percentage": 13, "purchase_description": "Composite item purchase description", "purchase_rate": 30000, "is_combo_product": true, "item_type": "inventory", "product_type": "goods", "is_taxable": true, "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2, "sku": "SKUIS", "upc": 746325287436, "ean": 5789414385764, "isbn": 368302334, "part_number": "JHFKE7GK7", "reorder_level": 1, "image_id": 8408722000000019000, "image_name": "img1.jpg", "created_time": "2013-08-05T12:06:10+0530" }, {...}, {...} ] }

Query Params

page
Optional
Page Number
per_page
Optional
Items to be displayed per page
sort_column
Optional
column to be used for sorting. Allowed values: name,sku,rate,tax_name,purchase_rate,created_time,last_modified_time,reorder_level
sort_order
Optional
order used for sorting
filter_by
Optional
Filter items by status. Allowed values: Status.All,Status.Active,Inactive,Lowstock
usestate
Optional
Whether current filter needs to be saved
response_option
Optional
response format number

Boxing/Unboxing

Boxing is the process of putting together different inventory items in desired quantities and thus producing a composite item while Unboxing is the act of taking it apart to get back the constituents.

POST /compositeitems/{:composite_item_id}/boxing

Request Example

  
$ curl https://inventory.zoho.com/api/v1/compositeitems/{:composite_item_id}/boxing?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "date": "2017-01-05", "quantity": -1 }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Item details have been saved." }

ARGUMENTS

date
Required
The date on which boxing is done
quantity
Required
Quantity of items to be boxed or unboxed. Value is Positive for boxing and Negative for unboxing

Sales Orders

A sales order is a financial document that confirms an impending sale. It details the exact quantity, price and delivery details of the products or services being sold. Perform the simple operations mentioned below to create and manage your Sales Orders.

Example

{ "salesorder_id": 4815000000044895, "salesorder_number": "SO-00003", "date": "2015-05-28T00:00:00.000Z", "status": "fulfilled", "shipment_date": "2015-06-02T00:00:00.000Z", "reference_number": "REF-S-00003", "customer_id": 4815000000044080, "customer_name": "Molly", "contact_persons": {}, "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "discount_amount": 0, "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "estimate_id": 4815000000045091, "delivery_method": "FedEx", "delivery_method_id": 4815000000044822, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "rate": 122, "quantity_invoiced": 2, "quantity_packed": 2, "quantity_shipped": 2, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "is_invoiced": true, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "shipping_charge": 7, "adjustment": 0, "adjustment_description": "Just an example description.", "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29.28 } ], "price_precision": 2, "pricebook_id": 4815000000044054, "is_emailed": true, "packages": [ { "package_id": 4815000000044905, "package_number": "PK-00004", "status": "fulfilled", "detailed_status": "Delivered", "status_message": "Delivered", "shipment_id": 4815000000044917, "shipment_number": "SH-00004", "shipment_status": 3, "carrier": "FedEx", "service": "SMART_POST", "tracking_number": "TRK214124124", "shipment_date": "2015-06-02T00:00:00.000Z", "delivery_days": 12, "delivery_guarantee": true } ], "invoices": [ { "invoice_id": 4815000000045091, "invoice_number": "INV-001", "status": "fulfilled", "date": "2015-05-28T00:00:00.000Z", "due_date": "2015-06-13T00:00:00.000Z", "total": 350, "balance": 0 } ], "shipping_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "billing_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z", "attachment_name": "sample.pdf", "can_send_in_mail": true, "salesperson_id": 4815000000044762, "salesperson_name": "Lara", "documents": [ { "can_send_in_mail": true, "file_name": "sample.pdf", "file_type": "pdf", "file_size_formatted": "116.8 KB", "attachment_order": 1, "document_id": 16115000000096068, "file_size": 11957 } ] }

Attribute

salesorder_id
long
Unique ID generated by the server for the Sales Order. This is used as identifier.
salesorder_number
string
The Sales Order number. This is unique for each sales order.
date
string
The date for the Sales Order.
status
string
The current status of the Sales Order.
shipment_date
string
Shipment date of the Sales Order.
reference_number
string
Reference number of the Sales Order
customer_id
long
Unique ID generated for the customer. This is used as an identifier.
customer_name
string
Name of the customer.
contact_persons
object
Array of contact person IDs.
currency_id
long
Unique ID generated by the server for the currency. This is used as an identifier.
currency_code
string
Currency code.
currency_symbol
string
The symbol for the selected currency.
exchange_rate
double
Exchange rate of the currency, with respect to the base currency.
discount_amount
double
Discount to be applied on the Sales Order.
discount
double
The percentage of Discount applied.
is_discount_before_tax
boolean
Used to check whether the discount is applied before tax or after tax.
discount_type
string
Type of discount
estimate_id
long
Unique ID generated by the server from the Estimate created in Zoho Books. This is used as an identifier.
delivery_method
string
Delivery method of the shipment.
delivery_method_id
long
Unique ID generated by the server for the delivery method. This is used as an identifier.
list
A sales order can contain multiple line items. Each line item contains line_item_id,item_id,name,description,item_order,bcy_rate,rate,quantity,quantity_invoiced,quantity_packed,quantity_shipped,unit,discount,tax_id,tax_name,tax_type,tax_percentage,item_total,is_invoiced,image_id,image_name,image_type.
item_id
long
Unique ID generated by the server for the item. This is used as an identifier.
line_item_id
long
Unique ID generated by the server for each line item. This is used as an identifier.
name
string
Name of the line item.
description
string
Description of the line item.
item_order
int
The order of the line items, starts from 0 by default.
bcy_rate
double
Item rate in the organization's base currency.
rate
double
Rate / Selling Price of the line item.
quantity_invoiced
double
Quantity invoiced of the line item.
quantity_packed
double
Quantity packed of the line item.
quantity_shipped
double
Quantity shipped of the line item.
unit
string
Unit of line item.
tax_id
long
Unique ID generated by the server for the tax. This is used as an identifier.
tax_name
string
Name of the tax applied on the line item.
tax_type
string
Denotes the type of the tax. This can either be a single tax or a tax group.
tax_percentage
double
Percentage of the tax.
item_total
double
Total of line item.
is_invoiced
boolean
Checks whether the Sales Order has been invoiced or not.
image_id
double
Unique ID generated by the server for the item image. This is used an identifier.
image_name
string
Name of the image of the line item.
image_type
string
The type (file format) of the image.
shipping_charge
double
Shipping charges that can be applied to the Sales Order.
adjustment
double
Adjustment on the Sales Order's total.
adjustment_description
string
Description for the adjustment.
sub_total
double
Sub total of the Sales Order.
tax_total
double
Tax total of the Sales Order.
total
double
Total amount of the Sales Order.
list
Number of taxes applied on sales order. Each tax contains: tax_name and tax_amount.
tax_name
string
Name of the tax applied on the line item.
tax_amount
double
Amount of the tax.
price_precision
integer
The precision level for the price's decimal point in a Sales Order.
pricebook_id
string
Unique ID generated by the server for the Pricebook. This is used as an identifier.
is_emailed
boolean
Checks whether the Sales Order has been emailed to the customer or not.
list
These are the packages created for Sales Orders. Each package contains - package_id,package_number,status,detailed_status,status_message,shipment_id,shipment_number,shipment_status,carrier,service,tracking_number,shipment_date,delivery_days and delivery_guarantee.
package_id
long
Unique ID generated by the server for the package. This is used as an identifier.
package_number
string
Package number of the Sales Order.
status
string
The current status of the Sales Order.
detailed_status
string
Detailed status.
status_message
string
Status message of package.
shipment_id
long
Unique ID generated by the server for the shipment. This is used as an identifier.
shipment_number
string
Shipment number of the package.
shipment_status
string
Shipment status of the package.
carrier
string
Name of the shipping carrier.
service
string
Name of the service provided by the carrier.
tracking_number
string
Tracking number of shipment.
shipment_date
string
Shipment date of the Sales Order.
delivery_days
string
The expected days to be taken for the delivery.
delivery_guarantee
boolean
Delivery guarantee of the shipment can be true or false.
list
Invoices created for the Sales Order. Each invoice contains - invoice_id, invoice_number, status, date, due_date, total, balance.
invoice_id
long
Unique ID generated by the server for the invoice. This is used as an identifier.
invoice_number
string
The number of the Invoice.
status
string
The current status of the Sales Order.
date
string
The date for the Sales Order.
due_date
string
Due date for the Invoice.
total
double
Total amount of the Sales Order.
balance
double
Balance due for the invoice.
shipping_address
list
Customer's shipping address. It contains - address, city, state, zip, country and fax.
address
string
Name of the street of the customer’s shipping address.
city
string
Name of the city of the customer’s shipping address.
state
string
Name of the state of the customer's shipping address.
zip
string
Zip code of the customer’s shipping address.
country
string
Name of the country of the customer’s shipping address.
fax
string
Fax number of the customer’s shipping address.
billing_address
list
Customer's billing address. It contains - address, city, state, zip, country and fax.
address
string
Name of the street of the customer’s shipping address.
city
string
Name of the city of the customer’s shipping address.
state
string
Name of the state of the customer's shipping address.
zip
string
Zip code of the customer’s shipping address.
country
string
Name of the country of the customer’s shipping address.
fax
string
Fax number of the customer’s shipping address.
notes
string
Notes for the Sales Order.
terms
string
Terms for the Sales Order.
template_id
long
Unique ID generated by the server for the Template. This is used as an identifier.
template_name
string
Name of the template used for the Sales Order.
template_type
string
Type of the template.
created_time
string
Time at which the Sales Order was created.
last_modified_time
string
Time at which the sales order details were last modified.
attachment_name
string
Name of attached file with Sales Order.
can_send_in_mail
boolean
Checks whether the sales order can be sent as a mail or not.
salesperson_id
string
Unique ID generated by the server for the sales person. This is used as an identifier.
salesperson_name
string
Name of the Sales Person.
list
Sales order can have files attached to them. Each attachment has the following attributes can_send_in_mail, file_name, file_type, file_size_formatted, attachment_order, document_id, file_size.
can_send_in_mail
boolean
Checks whether the sales order can be sent as a mail or not.
file_name
string
This indicates the name of the file.
file_type
string
This indicates the type of the file.
file_size_formatted
string
This indicates the size of the formatted file.
attachment_order
int
This indicates the chronological number of the attachment.
document_id
long
Unique ID generated by the server for the document. This is used as an identifier.
file_size
long
this indicates the size of the attached file.

Create a Sales Order

Creates a new Sales Order in Zoho Inventory. Description about extra parameter ignore_auto_number_generation : Ignore auto sales order number generation for this sales order. This mandates the Sales Order number to be entered. Allowed Values: true and false.

POST /salesorders?ignore_auto_number_generation={boolean}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/salesorders?ignore_auto_number_generation={boolean}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "salesorder_number": "SO-00003", "date": "2015-05-28T00:00:00.000Z", "shipment_date": "2015-06-02T00:00:00.000Z", "custom_fields": [ {} ], "reference_number": "REF-S-00003", "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "rate": 122, "quantity_invoiced": 2, "quantity_packed": 2, "quantity_shipped": 2, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "is_invoiced": true, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "shipping_charge": 7, "delivery_method": "FedEx", "adjustment": 0, "pricebook_id": 4815000000044054, "salesperson_id": 4815000000044762, "adjustment_description": "Just an example description.", "is_inclusive_tax": false, "exchange_rate": 1, "template_id": 4815000000017003, "documents": [ { "can_send_in_mail": true, "file_name": "sample.pdf", "file_type": "pdf", "file_size_formatted": "116.8 KB", "attachment_order": 1, "document_id": 16115000000096068, "file_size": 11957 } ], "billing_address_id": 4815000000017005, "shipping_address_id": 4815000000017005 }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "sales_order": { "salesorder_id": 4815000000044895, "salesorder_number": "SO-00003", "date": "2015-05-28T00:00:00.000Z", "status": "fulfilled", "shipment_date": "2015-06-02T00:00:00.000Z", "reference_number": "REF-S-00003", "customer_id": 4815000000044080, "customer_name": "Molly", "contact_persons": {...}, "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "discount_amount": 0, "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "estimate_id": 4815000000045091, "delivery_method": "FedEx", "delivery_method_id": 4815000000044822, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "rate": 122, "quantity_invoiced": 2, "quantity_packed": 2, "quantity_shipped": 2, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "is_invoiced": true, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "shipping_charge": 7, "adjustment": 0, "adjustment_description": "Just an example description.", "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29.28 } ], "price_precision": 2, "pricebook_id": 4815000000044054, "packages": [ { "package_id": 4815000000044905, "package_number": "PK-00004", "status": "fulfilled", "detailed_status": "Delivered", "status_message": "Delivered", "shipment_id": 4815000000044917, "shipment_number": "SH-00004", "shipment_status": 3, "carrier": "FedEx", "service": "SMART_POST", "tracking_number": "TRK214124124", "shipment_date": "2015-06-02T00:00:00.000Z", "delivery_days": 12, "delivery_guarantee": true } ], "invoices": [ { "invoice_id": 4815000000045091, "invoice_number": "INV-001", "status": "fulfilled", "date": "2015-05-28T00:00:00.000Z", "due_date": "2015-06-13T00:00:00.000Z", "total": 350, "balance": 0 } ], "shipping_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "billing_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z", "salesperson_id": 4815000000044762, "salesperson_name": "Lara", "documents": [ { "can_send_in_mail": true, "file_name": "sample.pdf", "file_type": "pdf", "file_size_formatted": "116.8 KB", "attachment_order": 1, "document_id": 16115000000096068, "file_size": 11957 } ] } }

ARGUMENTS

salesorder_number
Required
The Sales Order number. This is unique for each sales order.
date
Optional
The date for the Sales Order.
shipment_date
Optional
Shipment date of the Sales Order.
custom_fields
Optional
custom_field_id
Optional
index
Optional
Index of the custom field
label
Optional
Label of the Custom Field
value
Optional
Value of the Custom Field
reference_number
Optional
Reference number of the Sales Order
Required
A sales order can contain multiple line items. Each line item contains line_item_id,item_id,name,description,item_order,bcy_rate,rate,quantity,quantity_invoiced,quantity_packed,quantity_shipped,unit,discount,tax_id,tax_name,tax_type,tax_percentage,item_total,is_invoiced,image_id,image_name,image_type.
item_id
Optional
Unique ID generated by the server for the item. This is used as an identifier.
line_item_id
Optional
Unique ID generated by the server for each line item. This is used as an identifier.
name
Optional
Name of the line item.
description
Optional
Description of the line item.
item_order
Optional
The order of the line items, starts from 0 by default.
bcy_rate
Optional
Item rate in the organization's base currency.
rate
Optional
Rate / Selling Price of the line item.
quantity_invoiced
Optional
Quantity invoiced of the line item.
quantity_packed
Optional
Quantity packed of the line item.
quantity_shipped
Optional
Quantity shipped of the line item.
unit
Optional
Unit of line item.
tax_id
Optional
Unique ID generated by the server for the tax. This is used as an identifier.
tax_name
Optional
Name of the tax applied on the line item.
tax_type
Optional
Denotes the type of the tax. This can either be a single tax or a tax group.
tax_percentage
Optional
Percentage of the tax.
item_total
Optional
Total of line item.
is_invoiced
Optional
Checks whether the Sales Order has been invoiced or not.
image_id
Optional
Unique ID generated by the server for the item image. This is used an identifier.
image_name
Optional
Name of the image of the line item.
image_type
Optional
The type (file format) of the image.
notes
Optional
Notes for the Sales Order.
terms
Optional
Terms for the Sales Order.
discount
Optional
The percentage of Discount applied.
is_discount_before_tax
Optional
Used to check whether the discount is applied before tax or after tax.
discount_type
Optional
Type of discount
shipping_charge
Optional
Shipping charges that can be applied to the Sales Order.
delivery_method
Optional
Delivery method of the shipment.
adjustment
Optional
Adjustment on the Sales Order's total.
pricebook_id
Optional
Unique ID generated by the server for the Pricebook. This is used as an identifier.
salesperson_id
Optional
Unique ID generated by the server for the sales person. This is used as an identifier.
adjustment_description
Optional
Description for the adjustment.
is_inclusive_tax
Optional
Used to specify whether the line item rates are inclusive or exclusive of tax.
exchange_rate
Optional
Exchange rate of the currency, with respect to the base currency.
template_id
Optional
Unique ID generated by the server for the Template. This is used as an identifier.
Optional
Sales order can have files attached to them. Each attachment has the following attributes can_send_in_mail, file_name, file_type, file_size_formatted, attachment_order, document_id, file_size.
can_send_in_mail
Optional
Checks whether the sales order can be sent as a mail or not.
file_name
Optional
This indicates the name of the file.
file_type
Optional
This indicates the type of the file.
file_size_formatted
Optional
This indicates the size of the formatted file.
attachment_order
Optional
This indicates the chronological number of the attachment.
document_id
Optional
Unique ID generated by the server for the document. This is used as an identifier.
file_size
Optional
this indicates the size of the attached file.
billing_address_id
Optional
Unique Id generated by the server for address in contacts page. To add a billing address to sales order, send the address_id using this node. Else, the default billing address for that contact is used
shipping_address_id
Optional
Unique Id generated by the server for address in contacts page. To add a shipping address to sales order, send the address_id using this node. Else, the default shipping address for that contact is used

Retrieve a Sales Order

Retrieves the details for an existing Sales Order

GET /salesorders/{salesorder_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/salesorders/{salesorder_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "sales_order": { "salesorder_id": 4815000000044895, "documents": [ { "can_send_in_mail": true, "file_name": "sample.pdf", "file_type": "pdf", "file_size_formatted": "116.8 KB", "attachment_order": 1, "document_id": 16115000000096068, "file_size": 11957 } ], "salesorder_number": "SO-00003", "date": "2015-05-28T00:00:00.000Z", "status": "fulfilled", "shipment_date": "2015-06-02T00:00:00.000Z", "reference_number": "REF-S-00003", "customer_id": 4815000000044080, "customer_name": "Molly", "contact_persons": {...}, "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "discount_amount": 0, "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "estimate_id": 4815000000045091, "delivery_method": "FedEx", "delivery_method_id": 4815000000044822, "is_inclusive_tax": false, "sales_channel": "direct_sales", "is_dropshipped": false, "is_backordered": false, "is_backorder_allowed": false, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "rate": 122, "quantity_invoiced": 2, "quantity_packed": 2, "quantity_shipped": 2, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "is_invoiced": true, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "shipping_charge": 7, "adjustment": 0, "pricebook_id": 4815000000044054, "adjustment_description": "Just an example description.", "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29.28 } ], "price_precision": 2, "is_emailed": true, "has_unconfirmed_line_item": true, "packages": [ { "package_id": 4815000000044905, "package_number": "PK-00004", "status": "fulfilled", "detailed_status": "Delivered", "status_message": "Delivered", "shipment_id": 4815000000044917, "shipment_number": "SH-00004", "shipment_status": 3, "carrier": "FedEx", "service": "SMART_POST", "tracking_number": "TRK214124124", "shipment_date": "2015-06-02T00:00:00.000Z", "delivery_days": 12, "delivery_guarantee": true } ], "invoices": [ { "invoice_id": 4815000000045091, "invoice_number": "INV-001", "status": "fulfilled", "date": "2015-05-28T00:00:00.000Z", "due_date": "2015-06-13T00:00:00.000Z", "total": 350, "balance": 0 } ], "billing_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "shipping_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "custom_fields": [ {...} ], "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z", "attachment_name": "sample.pdf", "can_send_in_mail": true, "salesperson_id": 4815000000044762, "salesperson_name": "Lara" } }

Update a Sales Order

Updates a new Sales Order in Zoho Inventory. Description about extra parameter ignore_auto_number_generation : Ignore auto sales order number generation for this sales order. This mandates the Sales Order number to be entered. Allowed Values: true and false.

PUT /salesorders/{salesorder_id}?ignore_auto_number_generation={boolean}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/salesorders/{salesorder_id}?ignore_auto_number_generation={boolean}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "salesorder_number": "SO-00003", "date": "2015-05-28T00:00:00.000Z", "shipment_date": "2015-06-02T00:00:00.000Z", "custom_fields": [ {} ], "reference_number": "REF-S-00003", "customer_id": 4815000000044080, "contact_persons": {}, "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "delivery_method": "FedEx", "shipping_charge": 7, "adjustment": 0, "adjustment_description": "Just an example description.", "pricebook_id": 4815000000044054, "notes": "Sample Note", "salesperson_name": "Lara", "terms": "Terms and Conditions", "exchange_rate": 1, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "rate": 122, "quantity_invoiced": 2, "quantity_packed": 2, "quantity_shipped": 2, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "is_invoiced": true, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "billing_address_id": 4815000000017005, "shipping_address_id": 4815000000017005 }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Sales Order has been updated.", "sales_order": { "salesorder_id": 4815000000044895, "salesorder_number": "SO-00003", "date": "2015-05-28T00:00:00.000Z", "status": "fulfilled", "shipment_date": "2015-06-02T00:00:00.000Z", "reference_number": "REF-S-00003", "customer_id": 4815000000044080, "customer_name": "Molly", "contact_persons": {...}, "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "discount_amount": 0, "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "estimate_id": 4815000000045091, "delivery_method": "FedEx", "delivery_method_id": 4815000000044822, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "rate": 122, "quantity_invoiced": 2, "quantity_packed": 2, "quantity_shipped": 2, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "is_invoiced": true, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "shipping_charge": 7, "adjustment": 0, "adjustment_description": "Just an example description.", "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29.28 } ], "price_precision": 2, "pricebook_id": 4815000000044054, "packages": [ { "package_id": 4815000000044905, "package_number": "PK-00004", "status": "fulfilled", "detailed_status": "Delivered", "status_message": "Delivered", "shipment_id": 4815000000044917, "shipment_number": "SH-00004", "shipment_status": 3, "carrier": "FedEx", "service": "SMART_POST", "tracking_number": "TRK214124124", "shipment_date": "2015-06-02T00:00:00.000Z", "delivery_days": 12, "delivery_guarantee": true } ], "invoices": [ { "invoice_id": 4815000000045091, "invoice_number": "INV-001", "status": "fulfilled", "date": "2015-05-28T00:00:00.000Z", "due_date": "2015-06-13T00:00:00.000Z", "total": 350, "balance": 0 } ], "shipping_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "billing_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z", "attachment_name": "sample.pdf", "can_send_in_mail": true, "salesperson_id": 4815000000044762, "salesperson_name": "Lara" } }

ARGUMENTS

salesorder_number
Required
The Sales Order number. This is unique for each sales order.
date
Optional
The date for the Sales Order.
shipment_date
Optional
Shipment date of the Sales Order.
custom_fields
Optional
custom_field_id
Optional
index
Optional
Index of the custom field
label
Optional
Label of the Custom Field
value
Optional
Value of the Custom Field
reference_number
Optional
Reference number of the Sales Order
customer_id
Required
Unique ID generated for the customer. This is used as an identifier.
contact_persons
Optional
Array of contact person IDs.
discount
Optional
The percentage of Discount applied.
is_discount_before_tax
Optional
Used to check whether the discount is applied before tax or after tax.
discount_type
Optional
Type of discount
delivery_method
Optional
Delivery method of the shipment.
shipping_charge
Optional
Shipping charges that can be applied to the Sales Order.
adjustment
Optional
Adjustment on the Sales Order's total.
adjustment_description
Optional
Description for the adjustment.
pricebook_id
Optional
Unique ID generated by the server for the Pricebook. This is used as an identifier.
notes
Optional
Notes for the Sales Order.
salesperson_name
Optional
Name of the Sales Person.
terms
Optional
Terms for the Sales Order.
exchange_rate
Optional
Exchange rate of the currency, with respect to the base currency.
Required
A sales order can contain multiple line items. Each line item contains line_item_id,item_id,name,description,item_order,bcy_rate,rate,quantity,quantity_invoiced,quantity_packed,quantity_shipped,unit,discount,tax_id,tax_name,tax_type,tax_percentage,item_total,is_invoiced,image_id,image_name,image_type.
item_id
Optional
Unique ID generated by the server for the item. This is used as an identifier.
line_item_id
Optional
Unique ID generated by the server for each line item. This is used as an identifier.
name
Optional
Name of the line item.
description
Optional
Description of the line item.
item_order
Optional
The order of the line items, starts from 0 by default.
bcy_rate
Optional
Item rate in the organization's base currency.
rate
Optional
Rate / Selling Price of the line item.
quantity_invoiced
Optional
Quantity invoiced of the line item.
quantity_packed
Optional
Quantity packed of the line item.
quantity_shipped
Optional
Quantity shipped of the line item.
unit
Optional
Unit of line item.
tax_id
Optional
Unique ID generated by the server for the tax. This is used as an identifier.
tax_name
Optional
Name of the tax applied on the line item.
tax_type
Optional
Denotes the type of the tax. This can either be a single tax or a tax group.
tax_percentage
Optional
Percentage of the tax.
item_total
Optional
Total of line item.
is_invoiced
Optional
Checks whether the Sales Order has been invoiced or not.
image_id
Optional
Unique ID generated by the server for the item image. This is used an identifier.
image_name
Optional
Name of the image of the line item.
image_type
Optional
The type (file format) of the image.
billing_address_id
Optional
Unique Id generated by the server for address in contacts page. To add a billing address to sales order, send the address_id using this node. Else, the default billing address for that contact is used
shipping_address_id
Optional
Unique Id generated by the server for address in contacts page. To add a shipping address to sales order, send the address_id using this node. Else, the default shipping address for that contact is used

Delete a Sales Order

Deletes an existing Sales Order from Zoho Inventory.

DELETE /salesorders/{salesorder_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/salesorders/{salesorder_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The Sales Order has been deleted." }

List all Sales Orders

Lists all the available Sales Orders in Zoho Inventory.

GET /salesorders

Request Example

  
$ curl https://inventory.zoho.com/api/v1/salesorders?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "salesorders": [ { "salesorder_id": 4815000000044895, "customer_name": "Molly", "customer_id": 4815000000044080, "status": "fulfilled", "salesorder_number": "SO-00003", "reference_number": "REF-S-00003", "date": "2015-05-28T00:00:00.000Z", "shipment_date": "2015-06-02T00:00:00.000Z", "shipment_days": 2, "quantity": 2, "quantity_invoiced": 2, "quantity_packed": 2, "quantity_shipped": 2, "currency_code": "USD", "total": 350, "bcy_total": 33, "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z", "is_emailed": true, "is_drop_shipment": false, "is_backorder": false, "sales_channel": "direct_sales", "custom_fields": [ {...} ] }, {...}, {...} ] }

Mark as Void

Changes the status of a Sales Order to Void.

POST /salesorders/{salesorder_id}/status/void

Request Example

  
$ curl https://inventory.zoho.com/api/v1/salesorders/{salesorder_id}/status/void?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The status of the Sales Order has been changed to void." }

Invoices

An invoice is a statement of items sold by a seller. It includes all the details of sale including units of goods, price of goods sold, shipping details, etc.

Example

{ "invoice_number": "INV-00003", "item_name": "Desktop Units", "item_id": 982000000030049, "recurring_invoice_id": " ", "custom_field": " ", "search_text": " ", "sort_column": "created_time", "invoice_id": 982000000567114, "customer_name": "Bowman & Co", "customer_id": 982000000567001, "status": "draft", "reference_number": " ", "date": "2013-11-17", "due_date": "2013-12-03", "due_days": "Due in 14 day(s)", "currency_id": 982000000000190, "currency_code": "USD", "total": 40.6, "balance": 40.6, "created_time": "2013-11-18T02:17:40-0800", "is_emailed": false, "reminders_sent": 1, "payment_expected_date": " ", "last_payment_date": " " }

Attribute

invoice_number
string
An unique number given to the invoice. Maximum length [100]
item_name
string
item name.Maximum length [100]
item_id
string
Unique item id.
recurring_invoice_id
string
ID of the recurring invoice from which the invoice is created.
email
contact's email id. Maximum length [100]
custom_field
string
custom fields for invoice.
search_text
string
Search invoices by invoice number or purchase order or customer name. Maximum length [100]
sort_column
string
Sort invoices.Allowed Values: customer_name, invoice_number, date, due_date, total, balance and created_time
invoice_id
string
The ID of the invoice
customer_name
string
The name of the customer. Maximum length [100]
customer_id
string
ID of the customer the invoice has to be created.
status
string
Search invoices by invoice status.Allowed Values: sent, draft, overdue, paid, void, unpaid, partially_paid and viewed
invoice_number
string
An unique number given to the invoice. Maximum length [100]
reference_number
string
The reference number of the invoice
date
string
invoice date. Default date format is yyyy-mm-dd.
due_date
string
due date of the invoices. Default date format is yyyy-mm-dd.
due_days
string
Specifies the number of day in which the invoice would become overdue
currency_id
string
The currenct id of the currency
currency_code
string
The currency code in which the invoice is created.
total
string
The total amount to be paid
balance
string
The unpaid amount
created_time
string
The time of creation of the invoices
is_emailed
boolean
Boolean check to see if the mail has been sent
reminders_sent
integer
The number of reminders sent
payment_expected_date
string
The expected date of payment
last_payment_date
string
The last payment date of the invoice

Create an invoice

Create an invoice for your customer.

POST /invoices

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "customer_id": 982000000567001, "contact_persons": [ { "contact_person_id": 982000000567003, "salutation": "Mr", "first_name": "David", "last_name": "Sujin", "phone": "+1-925-921-9201", "mobile": "+1-4054439562" } ], "invoice_number": "INV-00003", "reference_number": " ", "template_id": 982000000000143, "date": "2013-11-17", "payment_terms": 15, "payment_terms_label": "Net 15", "due_date": "2013-12-03", "discount": 0, "is_discount_before_tax": true, "discount_type": "item_level", "is_inclusive_tax": false, "exchange_rate": 1, "recurring_invoice_id": " ", "invoiced_estimate_id": " ", "salesperson_name": " ", "custom_fields": [ { "index": 1, "show_on_pdf": false, "value": "The value of the custom field", "label": "Delivery Date" } ], "project_id": " ", "line_items": [ { "line_item_id": 982000000567021, "item_id": 982000000030049, "project_id": " ", "time_entry_ids": " ", "expense_id": " ", "name": "Hard Drive", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "item_order": 1, "bcy_rate": 120, "rate": 120, "quantity": 1, "unit": " ", "discount_amount": 0, "discount": 0, "tax_id": 982000000557028, "tax_name": "VAT", "tax_type": "tax", "tax_percentage": 12.5, "item_total": 120 } ], "payment_options": { "payment_gateways": [ { "configured": true, "additional_field1": "standard", "gateway_name": "paypal" } ] }, "allow_partial_payments": true, "custom_body": " ", "custom_subject": " ", "notes": "Looking forward for your business.", "terms": "Terms & Conditions apply", "shipping_charge": 0, "adjustment": 0, "adjustment_description": " ", "reason": " ", "tax_authority_id": 11149000000061052, "tax_exemption_id": 11149000000061054, "billing_address_id": 4815000000017005, "shipping_address_id": 4815000000017005 }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The invoice has been created.", "invoice": { "invoice_id": 982000000567114, "ach_payment_initiated": false, "invoice_number": "INV-00003", "date": "2013-11-17", "status": "draft", "payment_terms": 15, "payment_terms_label": "Net 15", "due_date": "2013-12-03", "payment_expected_date": " ", "last_payment_date": " ", "reference_number": " ", "customer_id": 982000000567001, "customer_name": "Bowman & Co", "contact_persons": [ { "contact_person_id": 982000000567003, "salutation": "Mr", "first_name": "David", "last_name": "Sujin", "phone": "+1-925-921-9201", "mobile": "+1-4054439562" } ], "currency_id": 982000000000190, "currency_code": "USD", "exchange_rate": 1, "discount": 0, "is_discount_before_tax": true, "discount_type": "item_level", "is_inclusive_tax": false, "recurring_invoice_id": " ", "is_viewed_by_client": false, "has_attachment": false, "client_viewed_time": "", "line_items": [ { "line_item_id": 982000000567021, "item_id": 982000000030049, "project_id": " ", "time_entry_ids": " ", "expense_id": " ", "name": "Hard Drive", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "item_order": 1, "bcy_rate": 120, "rate": 120, "quantity": 1, "unit": " ", "discount_amount": 0, "discount": 0, "tax_id": 982000000557028, "tax_name": "VAT", "tax_type": "tax", "tax_percentage": 12.5, "item_total": 120 } ], "shipping_charge": 0, "adjustment": 0, "adjustment_description": " ", "sub_total": 153, "tax_total": 22.6, "total": 40.6, "taxes": [ { "tax_name": "VAT", "tax_amount": 19.13 } ], "payment_reminder_enabled": true, "payment_made": 26.91, "credits_applied": 22.43, "tax_amount_withheld": 0, "balance": 40.6, "write_off_amount": 0, "allow_partial_payments": true, "price_precision": 2, "payment_options": { "payment_gateways": [ { "configured": true, "additional_field1": "standard", "gateway_name": "paypal" } ] }, "is_emailed": false, "reminders_sent": 1, "last_reminder_sent_date": " ", "billing_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "shipping_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "notes": "Looking forward for your business.", "terms": "Terms & Conditions apply", "custom_fields": [ { "index": 1, "show_on_pdf": false, "value": "The value of the custom field", "label": "Delivery Date" } ], "template_id": 982000000000143, "template_name": "Service - Classic", "created_time": "2013-11-18T02:17:40-0800", "last_modified_time": "2013-11-18T02:02:51-0800", "attachment_name": " ", "can_send_in_mail": true, "salesperson_id": " ", "salesperson_name": " ", "invoice_url": "https://invoice.zoho.com/SecurePayment?CInvoiceID=23d84d0cf64f9a72ea0c66fded25a08c8bafd0ab508aff05323a9f80e2cd03fdc5dd568d3d6407bbda969d3e870d740b6fce549a9438c4ea" } }

ARGUMENTS

customer_id
Required
ID of the customer the invoice has to be created.
contact_persons
Optional
contact_person_id
Optional
Unique ID of the contact person
salutation
Optional
Salutation to the contact
first_name
Optional
First name of the contact
last_name
Optional
Last name of the contact
email
Optional
contact's email id. Maximum length [100]
phone
Optional
Phone number of the contact
mobile
Optional
Mobile number of the contact person
is_primary_contact
Optional
To mark contact person as primary for contact
invoice_number
Optional
An unique number given to the invoice. Maximum length [100]
reference_number
Optional
The reference number of the invoice
template_id
Optional
ID of the pdf template associated with the invoice.
date
Optional
invoice date. Default date format is yyyy-mm-dd.
payment_terms
Optional
Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this. Maximum length [100]
payment_terms_label
Optional
Used to override the default payment terms label. Default value for 15 days is "Net 15 Days". Maximum length [100]
due_date
Optional
due date of the invoices. Default date format is yyyy-mm-dd.
discount
Optional
Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190. Maximum length [100]
is_discount_before_tax
Optional
Check if discount is exclusive of tax
discount_type
Optional
Type of discount
is_inclusive_tax
Optional
To check if discount is inclusive of tax
exchange_rate
Optional
Exchange rate of the currency.
recurring_invoice_id
Optional
ID of the recurring invoice from which the invoice is created.
invoiced_estimate_id
Optional
ID of the invoice from which the invoice is created.
salesperson_name
Optional
Name of the salesperson. Maximum length [200]
custom_fields
Optional
Custom fields for an invoice.
index
Optional
The index of the custom field
show_on_pdf
Optional
Boolean value to check if the custom field is to be dispplayed on the pdf.
value
Optional
Value of the custom field like VAT Id etc.
label
Optional
The label of the custom field.
project_id
Optional
Unique ID of the projet associated to an invoice
Required
Line items of an invoice.
line_item_id
Optional
The line item ID
item_id
Optional
Unique item id.
project_id
Optional
Unique ID of the projet associated to an invoice
time_entry_ids
Optional
Unique ID's of all the time entries associated to the linked project
expense_id
Optional
Unique ID of the expenses associated
expense_receipt_name
Optional
Name of the expense receipt associated
name
Optional
The name of the line item. Maximum length [100]
description
Optional
The description of the line items. Maximum length [2000]
item_order
Optional
The order of the line item_order
bcy_rate
Optional
base currency rate
rate
Optional
Rate of the line item.
quantity
Optional
The quantity of line item
unit
Optional
Unit of the line item e.g. kgs, Nos. Maximum length [100]
discount_amount
Optional
The discount amount on the line item
discount
Optional
Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190. Maximum length [100]
tax_id
US edition only
Optional
ID of the tax or tax group applied to the estimate
tax_name
Optional
The name of the tax
tax_type
Optional
The type of the tax
tax_percentage
Optional
The percentage of tax levied
item_total
Optional
The total amount of the line items
payment_options
Optional
Payment options for the invoice, online payment gateways and bank accounts. Will be displayed in the pdf.
payment_gateways
Optional
Online payment gateways through which payment can be made.
configured
Optional
Boolean check to see if a payment gateway has been configured
additional_field1
Optional
Paypal payment method. Allowed Values: standard and adaptive
gateway_name
Optional
Name of the payment gateway associated with the invoice. E.g. paypal, stripe.Allowed Values: paypal, authorize_net, payflow_pro, stripe, 2checkout and braintree
allow_partial_payments
Optional
Boolean to check if partial payments are allowed for the contact
custom_body
Optional
Customized email content
custom_subject
Optional
Customized Subject line
notes
Optional
The notes added below expressing gratitude or for conveying some information.
terms
Optional
The terms added below expressing gratitude or for conveying some information.
shipping_charge
Optional
Shipping charges applied to the invoice. Maximum length [100]
adjustment
Optional
Adjustments made to the invoice.
adjustment_description
Optional
Customize the adjustment description. E.g. Rounding off.
reason
Optional
Description of the attachment
tax_authority_id
US edition only
Optional
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_exemption_id
US edition only
Optional
ID of the tax exemption.
avatax_use_code
Avalara integration only
Optional
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Maximum length [25]
avatax_exempt_no
Avalara integration only
Optional
Exemption certificate number of the customer. Maximum length [25]
vat_treatment
UK edition only
Optional
VAT treatment for the invoice. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the customer is in a EU country & if he is VAT registered then his VAT treatment is eu_vat_registered, if he resides in EU & if he is not VAT registered then his VAT treatment is eu_vat_not_registered and if he resides outside the EU then his VAT treatment is non_eu .
billing_address_id
Optional
Unique Id generated by the server for address in contacts page. To add a billing address to invoice, send the address_id using this node. Else, the default billing address for that contact is used
shipping_address_id
Optional
Unique Id generated by the server for address in contacts page. To add a shipping address to invoice, send the address_id using this node. Else, the default shipping address for that contact is used

Query Params

send
Optional
Send the invoice to the contact person(s) associated with the invoice. Allowed values true and false.
ignore_auto_number_generation
Optional
Ignore auto invoice number generation for this invoice. This mandates the invoice number. Allowed values true and false

Update an invoice

Update an existing invoice. To delete a line item just remove it from the line_items list.

PUT /invoices/:invoice_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/:invoice_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "customer_id": 982000000567001, "contact_persons": [ { "contact_person_id": 982000000567003, "salutation": "Mr", "first_name": "David", "last_name": "Sujin", "phone": "+1-925-921-9201", "mobile": "+1-4054439562" } ], "invoice_number": "INV-00003", "reference_number": " ", "template_id": 982000000000143, "date": "2013-11-17", "payment_terms": 15, "payment_terms_label": "Net 15", "due_date": "2013-12-03", "discount": 0, "is_discount_before_tax": true, "discount_type": "item_level", "is_inclusive_tax": false, "exchange_rate": 1, "recurring_invoice_id": " ", "invoiced_estimate_id": " ", "salesperson_name": " ", "custom_fields": [ { "index": 1, "show_on_pdf": false, "value": "The value of the custom field", "label": "Delivery Date" } ], "project_id": " ", "line_items": [ { "line_item_id": 982000000567021, "item_id": 982000000030049, "project_id": " ", "time_entry_ids": " ", "expense_id": " ", "name": "Hard Drive", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "item_order": 1, "bcy_rate": 120, "rate": 120, "quantity": 1, "unit": " ", "discount_amount": 0, "discount": 0, "tax_id": 982000000557028, "tax_name": "VAT", "tax_type": "tax", "tax_percentage": 12.5, "item_total": 120 } ], "payment_options": { "payment_gateways": [ { "configured": true, "additional_field1": "standard", "gateway_name": "paypal" } ] }, "allow_partial_payments": true, "custom_body": " ", "custom_subject": " ", "notes": "Looking forward for your business.", "terms": "Terms & Conditions apply", "shipping_charge": 0, "adjustment": 0, "adjustment_description": " ", "reason": " ", "tax_authority_id": 11149000000061052, "tax_exemption_id": 11149000000061054, "billing_address_id": 4815000000017005, "shipping_address_id": 4815000000017005 }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Invoice information has been updated.", "invoice": { "invoice_id": 982000000567114, "ach_payment_initiated": false, "invoice_number": "INV-00003", "date": "2013-11-17", "status": "draft", "payment_terms": 15, "payment_terms_label": "Net 15", "due_date": "2013-12-03", "payment_expected_date": " ", "last_payment_date": " ", "reference_number": " ", "customer_id": 982000000567001, "customer_name": "Bowman & Co", "contact_persons": [ { "contact_person_id": 982000000567003, "salutation": "Mr", "first_name": "David", "last_name": "Sujin", "phone": "+1-925-921-9201", "mobile": "+1-4054439562" } ], "currency_id": 982000000000190, "currency_code": "USD", "exchange_rate": 1, "discount": 0, "is_discount_before_tax": true, "discount_type": "item_level", "is_inclusive_tax": false, "recurring_invoice_id": " ", "is_viewed_by_client": false, "has_attachment": false, "client_viewed_time": "", "line_items": [ { "line_item_id": 982000000567021, "item_id": 982000000030049, "project_id": " ", "time_entry_ids": " ", "expense_id": " ", "name": "Hard Drive", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "item_order": 1, "bcy_rate": 120, "rate": 120, "quantity": 1, "unit": " ", "discount_amount": 0, "discount": 0, "tax_id": 982000000557028, "tax_name": "VAT", "tax_type": "tax", "tax_percentage": 12.5, "item_total": 120 } ], "shipping_charge": 0, "adjustment": 0, "adjustment_description": " ", "sub_total": 153, "tax_total": 22.6, "total": 40.6, "taxes": [ { "tax_name": "VAT", "tax_amount": 19.13 } ], "payment_reminder_enabled": true, "payment_made": 26.91, "credits_applied": 22.43, "tax_amount_withheld": 0, "balance": 40.6, "write_off_amount": 0, "allow_partial_payments": true, "price_precision": 2, "payment_options": { "payment_gateways": [ { "configured": true, "additional_field1": "standard", "gateway_name": "paypal" } ] }, "is_emailed": false, "reminders_sent": 1, "last_reminder_sent_date": " ", "billing_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "shipping_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "notes": "Looking forward for your business.", "terms": "Terms & Conditions apply", "custom_fields": [ { "index": 1, "show_on_pdf": false, "value": "The value of the custom field", "label": "Delivery Date" } ], "template_id": 982000000000143, "template_name": "Service - Classic", "created_time": "2013-11-18T02:17:40-0800", "last_modified_time": "2013-11-18T02:02:51-0800", "attachment_name": " ", "can_send_in_mail": true, "salesperson_id": " ", "salesperson_name": " ", "invoice_url": "https://invoice.zoho.com/SecurePayment?CInvoiceID=23d84d0cf64f9a72ea0c66fded25a08c8bafd0ab508aff05323a9f80e2cd03fdc5dd568d3d6407bbda969d3e870d740b6fce549a9438c4ea" } }

ARGUMENTS

customer_id
Required
ID of the customer the invoice has to be created.
contact_persons
Optional
contact_person_id
Optional
Unique ID of the contact person
salutation
Optional
Salutation to the contact
first_name
Optional
First name of the contact
last_name
Optional
Last name of the contact
email
Optional
contact's email id. Maximum length [100]
phone
Optional
Phone number of the contact
mobile
Optional
Mobile number of the contact person
is_primary_contact
Optional
To mark contact person as primary for contact
invoice_number
Optional
An unique number given to the invoice. Maximum length [100]
reference_number
Optional
The reference number of the invoice
template_id
Optional
ID of the pdf template associated with the invoice.
date
Optional
invoice date. Default date format is yyyy-mm-dd.
payment_terms
Optional
Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this. Maximum length [100]
payment_terms_label
Optional
Used to override the default payment terms label. Default value for 15 days is "Net 15 Days". Maximum length [100]
due_date
Optional
due date of the invoices. Default date format is yyyy-mm-dd.
discount
Optional
Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190. Maximum length [100]
is_discount_before_tax
Optional
Check if discount is exclusive of tax
discount_type
Optional
Type of discount
is_inclusive_tax
Optional
To check if discount is inclusive of tax
exchange_rate
Optional
Exchange rate of the currency.
recurring_invoice_id
Optional
ID of the recurring invoice from which the invoice is created.
invoiced_estimate_id
Optional
ID of the invoice from which the invoice is created.
salesperson_name
Optional
Name of the salesperson. Maximum length [200]
custom_fields
Optional
Custom fields for an invoice.
index
Optional
The index of the custom field
show_on_pdf
Optional
Boolean value to check if the custom field is to be dispplayed on the pdf.
value
Optional
Value of the custom field like VAT Id etc.
label
Optional
The label of the custom field.
project_id
Optional
Unique ID of the projet associated to an invoice
Required
Line items of an invoice.
line_item_id
Optional
The line item ID
item_id
Optional
Unique item id.
project_id
Optional
Unique ID of the projet associated to an invoice
time_entry_ids
Optional
Unique ID's of all the time entries associated to the linked project
expense_id
Optional
Unique ID of the expenses associated
expense_receipt_name
Optional
Name of the expense receipt associated
name
Optional
The name of the line item. Maximum length [100]
description
Optional
The description of the line items. Maximum length [2000]
item_order
Optional
The order of the line item_order
bcy_rate
Optional
base currency rate
rate
Optional
Rate of the line item.
quantity
Optional
The quantity of line item
unit
Optional
Unit of the line item e.g. kgs, Nos. Maximum length [100]
discount_amount
Optional
The discount amount on the line item
discount
Optional
Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190. Maximum length [100]
tax_id
US edition only
Optional
ID of the tax or tax group applied to the estimate
tax_name
Optional
The name of the tax
tax_type
Optional
The type of the tax
tax_percentage
Optional
The percentage of tax levied
item_total
Optional
The total amount of the line items
payment_options
Optional
Payment options for the invoice, online payment gateways and bank accounts. Will be displayed in the pdf.
payment_gateways
Optional
Online payment gateways through which payment can be made.
configured
Optional
Boolean check to see if a payment gateway has been configured
additional_field1
Optional
Paypal payment method. Allowed Values: standard and adaptive
gateway_name
Optional
Name of the payment gateway associated with the invoice. E.g. paypal, stripe.Allowed Values: paypal, authorize_net, payflow_pro, stripe, 2checkout and braintree
allow_partial_payments
Optional
Boolean to check if partial payments are allowed for the contact
custom_body
Optional
Customized email content
custom_subject
Optional
Customized Subject line
notes
Optional
The notes added below expressing gratitude or for conveying some information.
terms
Optional
The terms added below expressing gratitude or for conveying some information.
shipping_charge
Optional
Shipping charges applied to the invoice. Maximum length [100]
adjustment
Optional
Adjustments made to the invoice.
adjustment_description
Optional
Customize the adjustment description. E.g. Rounding off.
reason
Optional
Description of the attachment
tax_authority_id
US edition only
Optional
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_exemption_id
US edition only
Optional
ID of the tax exemption.
avatax_use_code
Avalara integration only
Optional
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Maximum length [25]
avatax_exempt_no
Avalara integration only
Optional
Exemption certificate number of the customer. Maximum length [25]
vat_treatment
UK edition only
Optional
VAT treatment for the invoice. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the customer is in a EU country & if he is VAT registered then his VAT treatment is eu_vat_registered, if he resides in EU & if he is not VAT registered then his VAT treatment is eu_vat_not_registered and if he resides outside the EU then his VAT treatment is non_eu .
billing_address_id
Optional
Unique Id generated by the server for address in contacts page. To add a billing address to invoice, send the address_id using this node. Else, the default billing address for that contact is used
shipping_address_id
Optional
Unique Id generated by the server for address in contacts page. To add a shipping address to invoice, send the address_id using this node. Else, the default shipping address for that contact is used

Query Params

ignore_auto_number_generation
Optional
Ignore auto invoice number generation for this invoice. This mandates the invoice number. Allowed values true and false

Get an invoice

Get the details of an invoice.

GET /invoices/:invoice_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/:invoice_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "invoice": { "invoice_id": 982000000567114, "ach_payment_initiated": false, "invoice_number": "INV-00003", "date": "2013-11-17", "status": "draft", "payment_terms": 15, "payment_terms_label": "Net 15", "due_date": "2013-12-03", "payment_expected_date": " ", "last_payment_date": " ", "reference_number": " ", "customer_id": 982000000567001, "customer_name": "Bowman & Co", "contact_persons": [ { "contact_person_id": 982000000567003, "salutation": "Mr", "first_name": "David", "last_name": "Sujin", "phone": "+1-925-921-9201", "mobile": "+1-4054439562" } ], "currency_id": 982000000000190, "currency_code": "USD", "exchange_rate": 1, "discount": 0, "is_discount_before_tax": true, "discount_type": "item_level", "is_inclusive_tax": false, "recurring_invoice_id": " ", "is_viewed_by_client": false, "has_attachment": false, "client_viewed_time": "", "line_items": [ { "line_item_id": 982000000567021, "item_id": 982000000030049, "project_id": " ", "time_entry_ids": " ", "expense_id": " ", "name": "Hard Drive", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "item_order": 1, "bcy_rate": 120, "rate": 120, "quantity": 1, "unit": " ", "discount_amount": 0, "discount": 0, "tax_id": 982000000557028, "tax_name": "VAT", "tax_type": "tax", "tax_percentage": 12.5, "item_total": 120 } ], "shipping_charge": 0, "adjustment": 0, "adjustment_description": " ", "sub_total": 153, "tax_total": 22.6, "total": 40.6, "taxes": [ { "tax_name": "VAT", "tax_amount": 19.13 } ], "payment_reminder_enabled": true, "payment_made": 26.91, "credits_applied": 22.43, "tax_amount_withheld": 0, "balance": 40.6, "write_off_amount": 0, "allow_partial_payments": true, "price_precision": 2, "payment_options": { "payment_gateways": [ { "configured": true, "additional_field1": "standard", "gateway_name": "paypal" } ] }, "is_emailed": false, "reminders_sent": 1, "last_reminder_sent_date": " ", "billing_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "shipping_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600" }, "notes": "Looking forward for your business.", "terms": "Terms & Conditions apply", "custom_fields": [ { "index": 1, "show_on_pdf": false, "value": "The value of the custom field", "label": "Delivery Date" } ], "template_id": 982000000000143, "template_name": "Service - Classic", "created_time": "2013-11-18T02:17:40-0800", "last_modified_time": "2013-11-18T02:02:51-0800", "attachment_name": " ", "can_send_in_mail": true, "salesperson_id": " ", "salesperson_name": " ", "invoice_url": "https://invoice.zoho.com/SecurePayment?CInvoiceID=23d84d0cf64f9a72ea0c66fded25a08c8bafd0ab508aff05323a9f80e2cd03fdc5dd568d3d6407bbda969d3e870d740b6fce549a9438c4ea" } }

Query Params

print
Optional
Print the exported pdf.
accept
Optional
Get the details of a particular invoice in formats such as json/ pdf/ html. Default format is json. Allowed values json pdf and html

List invoices

List all invoices with pagination.

GET /invoices

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "invoices": [ { "invoice_id": 982000000567114, "ach_payment_initiated": false, "customer_name": "Bowman & Co", "customer_id": 982000000567001, "status": "draft", "invoice_number": "INV-00003", "reference_number": " ", "date": "2013-11-17", "due_date": "2013-12-03", "due_days": "Due in 14 day(s)", "currency_id": 982000000000190, "schedule_time": "", "currency_code": "USD", "is_viewed_by_client": false, "has_attachment": false, "client_viewed_time": "", "total": 40.6, "balance": 40.6, "created_time": "2013-11-18T02:17:40-0800", "last_modified_time": "2013-11-18T02:02:51-0800", "is_emailed": false, "reminders_sent": 1, "last_reminder_sent_date": " ", "payment_expected_date": " ", "last_payment_date": " ", "custom_fields": [ { "index": 1, "show_on_pdf": false, "value": "The value of the custom field", "label": "Delivery Date" } ], "documents": "", "salesperson_id": " ", "salesperson_name": " ", "shipping_charge": 0, "adjustment": 0, "write_off_amount": 0, "exchange_rate": 1 }, {...}, {...} ] }

Query Params

invoice_number
Optional
An unique number given to the invoice. Maximum length [100]
item_name
Optional
item name.Variants: item_name_startswith and item_name_contains. Maximum length [100]
item_id
Optional
Unique item id.
item_description
Optional
Search invoices by item description.Variants: item_description_startswith and item_description_contains. Maximum length [100]
reference_number
Optional
The reference number of the invoice
customer_name
Optional
The name of the customer. Maximum length [100]
recurring_invoice_id
Optional
ID of the recurring invoice from which the invoice is created.
email
Optional
contact's email id. Maximum length [100]
total
Optional
The total amount to be paid
balance
Optional
The unpaid amount
custom_field
Optional
custom fields for invoice. Variants: custom_field_startswith and custom_field_contains
date
Optional
invoice date. Default date format is yyyy-mm-dd. Variants: due_date_start, due_date_end, due_date_before and due_date_after.
due_date
Optional
due date of the invoices. Default date format is yyyy-mm-dd. Variants: due_date_start, due_date_end, due_date_before and due_date_after
status
Optional
Search invoices by invoice status.Allowed Values: sent, draft, overdue, paid, void, unpaid, partially_paid and viewed
customer_id
Optional
ID of the customer the invoice has to be created.
filter_by
Optional
Filter invoices by any status or payment expected date.Allowed Values: Status.All, Status.Sent, Status.Draft, Status.OverDue, Status.Paid, Status.Void, Status.Unpaid, Status.PartiallyPaid, Status.Viewed and Date.PaymentExpectedDate
search_text
Optional
Search invoices by invoice number or purchase order or customer name. Maximum length [100]
sort_column
Optional
Sort invoices.Allowed Values: customer_name, invoice_number, date, due_date, total, balance and created_time

Delete an invoice

Delete an existing invoice. Invoices which have payment or credits note applied cannot be deleted.

DELETE /invoices/:invoice_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/:invoice_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The invoice has been deleted." }

Mark an invoice as sent

Mark a draft invoice as sent.

POST /invoices/:invoice_id/status/sent

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/:invoice_id/status/sent?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Invoice status has been changed to Sent." }

Void an invoice

Mark an invoice status as void. Upon voiding, the payments and credits associated with the invoices will be unassociated and will be under customer credits.

POST /invoices/:invoice_id/status/void

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/:invoice_id/status/void?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Invoice status has been changed to Void." }

Mark as draft

Mark a voided invoice as draft.

POST /invoices/:invoice_id/status/draft

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/:invoice_id/status/draft?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Status of invoice changed from void to draft" }

Email an invoice

Email an invoice to the customer. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content.

POST /invoices/:invoice_id/email

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/:invoice_id/email?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "send_from_org_email_id": false, "to_mail_ids": [ "willsmith@bowmanfurniture.com" ], "cc_mail_ids": [ "peterparker@bowmanfurniture.com" ], "subject": "Invoice from Zillium Inc (Invoice#: INV-00001)", "body": "Dear Customer, <br><br><br><br>Thanks for your business. <br><br><br><br>The invoice INV-00001 is attached with this email. You can choose the easy way out and <a href= https://invoice.zoho.com/SecurePayment?CInvoiceID=b9800228e011ae86abe71227bdacb3c68e1af685f647dcaed747812e0b9314635e55ac6223925675b371fcbd2d5ae3dc >pay online for this invoice.</a> <br><br>Here's an overview of the invoice for your reference. <br><br><br><br>Invoice Overview: <br><br>Invoice : INV-00001 <br><br>Date : 05 Aug 2013 <br><br>Amount : $541.82 <br><br><br><br>It was great working with you. Looking forward to working with you again.<br><br><br>\\nRegards<br>\\nZillium Inc<br>\\n\"," }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Your invoice has been sent." }

ARGUMENTS

send_from_org_email_id
Optional
Boolean to trigger the email from the organization's email address
to_mail_ids
Required
Array of email addresses of the recipients.
cc_mail_ids
Optional
Array of email addresses of the recipients to be CC'd.
subject
Optional
The subject of the mail
body
Optional
The body/content of the mail

Query Params

send_customer_statement
Optional
Send customer statement pdf a with email.
send_attachment
Optional
Send the invoice attachment a with the email.
attachments
Optional
Files to be attached to the email

Email invoices

Send invoices to your customers by email. Maximum of 10 invoices can be sent at once.

POST /invoices/email

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/email?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Mission accomplished! We've sent all the invoices." }

Query Params

invoice_ids
Required
Comma separated invoice ids which are to be emailed.

Get invoice email content

Get the email content of an invoice.

GET /invoices/{:invoice_id}/email

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/email?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "data": { "bcc_mails": [ {...} ], "gateways_configured": true, "gateways_associated": true, "bcc_mails_str": "", "body": "Dear Customer, <br><br><br><br>Thanks for your business. <br><br><br><br>The invoice INV-00001 is attached with this email. You can choose the easy way out and <a href= https://invoice.zoho.com/SecurePayment?CInvoiceID=b9800228e011ae86abe71227bdacb3c68e1af685f647dcaed747812e0b9314635e55ac6223925675b371fcbd2d5ae3dc >pay online for this invoice.</a> <br><br>Here's an overview of the invoice for your reference. <br><br><br><br>Invoice Overview: <br><br>Invoice : INV-00001 <br><br>Date : 05 Aug 2013 <br><br>Amount : $541.82 <br><br><br><br>It was great working with you. Looking forward to working with you again.<br><br><br>\\nRegards<br>\\nZillium Inc<br>\\n\",", "documents": "", "customer_name": "Bowman & Co", "attach_pdf": true, "entity_id": "2000000007037", "cc_mails_list": [ { "user_name": "David Sujin" } ], "file_name_without_extension": "INV-000004", "to_mails_str": "", "cc_mails_str": "", "from_email": "", "from_address": "", "deprecated_placeholders_used": [ {...} ], "error_list": [ {...} ], "subject": "Invoice from Zillium Inc (Invoice#: INV-00001)", "emailtemplates": [ { "selected": true, "name": "Hard Drive" } ], "emailtemplate_documents": [ {...} ], "to_contacts": [ { "first_name": "David", "selected": true, "phone": "+1-925-921-9201", "last_name": "Sujin", "salutation": "Mr", "contact_person_id": 982000000567003, "mobile": "+1-4054439562" } ], "attachment_name": " ", "file_name": "INV-00001.pdf", "from_emails": [ { "user_name": "David Sujin", "selected": true, "organization_contact_id": "2000000002266", "is_org_email_id": true } ], "customer_id": 982000000567001 } }

Query Params

email_template_id
Optional
Get the email content based on a specific email template. If this param is not inputted, then the content will be based on the email template associated with the customer. If no template is associated with the customer, then default template will be used.

Remind Customer

Remind your customer about an unpaid invoice by email. Reminder will be sent, only for the invoices which are in open or overdue status.

POST /invoices/{:invoice_id}/paymentreminder

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/paymentreminder?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "to_mail_ids": [ "willsmith@bowmanfurniture.com" ], "cc_mail_ids": [ "peterparker@bowmanfurniture.com" ], "subject": "Invoice from Zillium Inc (Invoice#: INV-00001)", "body": "<br>Dear Mr. Sujin,&nbsp;<br><br>You might have missed the payment date and the invoice is now overdue by&nbsp;1&nbsp;days.<br><br>----------------------------------------------------------------------------------------<br><h2>Invoice# : INV-000004 </h2>Dated : 23 Dec 2016<br>----------------------------------------------------------------------------------------<br><b>&nbsp;Due Date &nbsp; &nbsp; &nbsp; &nbsp; : &nbsp;&nbsp;23 Dec 2016</b><br><b>&nbsp;Amount &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; : &nbsp;&nbsp;$139.65</b><br>----------------------------------------------------------------------------------------<br><br><span>Not to worry at all !&nbsp;</span>View your invoice and take the easy way out by making an&nbsp;<a href=\"https://invoice.zoho.com/portal/Zillium Inc/index#/invoices/invoice/2000000007037 \">online payment</a>.<br><br>If you have already paid, please accept our apologies and kindly ignore this payment reminder.<br><br><br>Regards,<br><br>David Sujin<br>Zillium Inc<br><br><br>", "send_from_org_email_id": false }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Your payment reminder has been sent." }

ARGUMENTS

to_mail_ids
Optional
Array of email addresses of the recipients.
cc_mail_ids
Required
Array of email addresses of the recipients to be CC'd.
subject
Optional
The subject of the mail
body
Optional
content of the email
send_from_org_email_id
Optional
Boolean to trigger the email from the organization's email address

Query Params

send_customer_statement
Optional
Send customer statement pdf a with email.
attachments
Optional
Files to be attached to the email

Bulk invoice reminder

Remind your customer about an unpaid invoices by email. Reminder mail will be send, only for the invoices is in open or overdue status. Maximum 10 invoices can be reminded at once.

POST /invoices/paymentreminder

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/paymentreminder?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "info": { "email_success_info": { "message": "The reminders were successfully sent", "sent_count": 2 }, "email_errors_info": [ { "message": "The reminders were successfully sent", "ids": [ {...} ] } ], "code": 4083 } }

Query Params

invoice_ids
Required
Array of invoice ids for which the reminder has to be sent.

Get payment reminder mail content

Get the mail content of the payment reminder.

GET /invoices/{:invoice_id}/paymentreminder

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/paymentreminder?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "data": { "bcc_mails": [ {...} ], "gateways_configured": true, "gateways_associated": true, "bcc_mails_str": "", "body": "<br>Dear Mr. Sujin,&nbsp;<br><br>You might have missed the payment date and the invoice is now overdue by&nbsp;1&nbsp;days.<br><br>----------------------------------------------------------------------------------------<br><h2>Invoice# : INV-000004 </h2>Dated : 23 Dec 2016<br>----------------------------------------------------------------------------------------<br><b>&nbsp;Due Date &nbsp; &nbsp; &nbsp; &nbsp; : &nbsp;&nbsp;23 Dec 2016</b><br><b>&nbsp;Amount &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; : &nbsp;&nbsp;$139.65</b><br>----------------------------------------------------------------------------------------<br><br><span>Not to worry at all !&nbsp;</span>View your invoice and take the easy way out by making an&nbsp;<a href=\"https://invoice.zoho.com/portal/Zillium Inc/index#/invoices/invoice/2000000007037 \">online payment</a>.<br><br>If you have already paid, please accept our apologies and kindly ignore this payment reminder.<br><br><br>Regards,<br><br>David Sujin<br>Zillium Inc<br><br><br>", "documents": "", "customer_name": "Bowman & Co", "attach_pdf": true, "entity_id": "2000000007037", "cc_mails_list": [ { "user_name": "David Sujin" } ], "file_name_without_extension": "INV-000004", "to_mails_str": "", "cc_mails_str": "", "from_email": "", "from_address": "", "deprecated_placeholders_used": [ {...} ], "error_list": [ {...} ], "subject": "Invoice from Zillium Inc (Invoice#: INV-00001)", "emailtemplates": [ { "selected": true, "name": "Hard Drive" } ], "emailtemplate_documents": [ {...} ], "to_contacts": [ { "first_name": "David", "selected": true, "phone": "+1-925-921-9201", "last_name": "Sujin", "salutation": "Mr", "contact_person_id": 982000000567003, "mobile": "+1-4054439562" } ], "attachment_name": " ", "file_name": "INV-00001.pdf", "from_emails": [ { "user_name": "David Sujin", "selected": true, "organization_contact_id": "2000000002266", "is_org_email_id": true } ], "customer_id": 982000000567001 } }

Bulk export Invoices

Maximum of 25 invoices can be exported in a single pdf.

GET /invoices/pdf

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/pdf?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success" }

Query Params

invoice_ids
Required
Comma separated invoice ids which are to be export as pdf.

Bulk print invoices

Export invoices as pdf and print them. Maximum of 25 invoices can be printed.

GET /invoices/print

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/print?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success" }

Query Params

invoice_ids
Required
Export invoices as pdf and print them. Maximum of 25 invoices can be printed.

Disable payment reminder

Disable automated payment reminders for an invoice.

POST /invoices/{:invoice_id}/paymentreminder/disable

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/paymentreminder/disable?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Reminders stopped." }

Enable payment reminder

Enable automated payment reminders for an invoice.

POST /invoices/{:invoice_id}/paymentreminder/enable

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/paymentreminder/enable?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Reminders enabled." }

Write off invoice

Write off the invoice balance amount of an invoice.

POST /invoices/{:invoice_id}/writeoff

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/writeoff?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Invoice has been written off" }

Cancel write off

Cancel the write off amount of an invoice.

POST /invoices/{:invoice_id}/writeoff/cancel

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/writeoff/cancel?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The write off done for this invoice has been cancelled." }

Update billing address

Updates the billing address for this invoice alone.

PUT /invoices/{:invoice_id}/address/billing

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/address/billing?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "address": "B-1104, 11F, \nHorizon International Tower, \nNo. 6, ZhiChun Road, HaiDian District", "city": "Beijing", "state": "Beijing", "zip": 1000881, "fax": "+86-10-82637827" }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Billing address updated" }

ARGUMENTS

address
Optional
Billing address of the customer
city
Optional
City of the customer's billing address
state
Optional
State of the customer's billing address
zip
Optional
ZIP code of the contact's billing address
country
Optional
Country of the contact's billing address
fax
Optional
FAX number of the customer

Update shipping address

Updates the shipping address for this invoice alone.

PUT /invoices/{:invoice_id}/address/shipping

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/address/shipping?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "address": "4900 Hopyard Rd, Suit 310", "city": "Pleasanton", "state": "CA", "zip": 945881, "country": "USA", "fax": "+1-925-924-9600" }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Shipping address updated" }

ARGUMENTS

address
Optional
Shipping address of the customer
city
Optional
City of the contact's shipping address
state
Optional
State of the Contact's shipping address
zip
Optional
ZIP code of the contact's shipping address
country
Optional
Contact's country for the given shipping address
fax
Optional
FAX number of the contact

List invoice templates

Get all invoice pdf templates.

Get /invoices/templates

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/templates?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "templates": [ { "template_name": "Service - Classic", "template_id": 982000000000143, "template_type": "classic" } ] }

Update invoice template

Update the pdf template associated with the invoice.

PUT /invoices/{:invoice_id}/templates/{:template_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/templates/{:template_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Invoice information has been updated." }

List invoice payments

Get the list of payments made for an invoice.

GET /invoices/{:invoice_id}/payments

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/payments?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "payments": [ { "payment_id": 982000000567190, "payment_number": 7, "invoice_id": 982000000567114, "invoice_payment_id": 982000000567192, "payment_mode": "cash", "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "date": "2013-11-17", "reference_number": " ", "exchange_rate": 1, "amount": 10.57, "tax_amount_withheld": 0, "online_transaction_id": "", "is_single_invoice_payment": true } ] }

List credits applied

Get the list of credits applied for an invoice.

GET /invoices/{:invoice_id}/creditsapplied

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/creditsapplied?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "credits": [ { "creditnote_id": 982000000567134, "creditnotes_invoice_id": "982000000567172", "creditnotes_number": "CN-00001", "credited_date": "2013-11-18", "amount_applied": 12.2 }, {...}, {...} ] }

Apply credits

Apply the customer credits either from credit notes or excess customer payments to an invoice. Multiple credits can be applied at once.

POST /invoices/{:invoice_id}/credits

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/credits?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "invoice_payments": [ { "payment_id": 982000000567190, "amount_applied": 12.2 } ], "apply_creditnotes": [ { "creditnote_id": 982000000567134, "amount_applied": 12.2 } ] }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Credits have been applied to the invoice(s)." }

ARGUMENTS

invoice_payments
Optional
Invoice payment list
payment_id
Optional
The ID of the payment
amount_applied
Optional
The amount applied to a creditnote
apply_creditnotes
Optional
Apply existing credit note of a customer against the invoice
creditnote_id
Optional
The ID of creditnote
amount_applied
Optional
The amount applied to a creditnote

Delete a payment

Delete a payment made to an invoice.

DELETE /invoices/{:invoice_id}/payments/{:invoice_payment_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/payments/{:invoice_payment_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The payment has been deleted." }

Delete applied credit

Delete a particular credit applied to an invoice.

DELETE /invoices/{:invoice_id}/creditsapplied/{:creditnotes_invoice_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/creditsapplied/{:creditnotes_invoice_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Credits applied to an invoice have been deleted." }

Get an invoice attachment

Returns the file attached to the invoice.

GET /invoices/{:invoice_id}/attachment

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/attachment?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success" }

Query Params

preview
Optional
Get the thumbnail of the attachment.

Add attachment to an invoice

Attach a file to an invoice.

POST /invoices/{:invoice_id}/attachment

Request Example

  
$ curl https://inventory.zoho.com/api/v1 /invoices/{:invoice_id}/attachment?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Your file has been successfully attached to the invoice." }

Query Params

can_send_in_mail
Optional
True to send the attachment with the invoice when emailed.
attachment
Optional
The file to be attached.Allowed Extensions: gif, png, jpeg, jpg, bmp and pdf

Update attachment preference

Set whether you want to send the attached file while emailing the invoice.

PUT /invoices/{:invoice_id}/attachment

Request Example

  
$ curl https://inventory.zoho.com/api/v1 /invoices/{:invoice_id}/attachment?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Invoice information has been updated." }

Query Params

can_send_in_mail
Required
Boolean to send the attachment with the invoice when emailed.

Delete an attachment

Delete the file attached to the invoice.

DELETE /invoices/{:invoice_id}/attachment

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/attachment?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Your file is no longer attached to the invoice." }

Delete the expense receipt

Delete the expense receipts attached to an invoice which is raised from an expense.

DELETE /invoices/expenses/{:expense_id}/receipt

Request Example

  
$ curl https://inventory.zoho.com/api/v1 /invoices/expenses/{:expense_id}/receipt?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The attached expense receipt has been deleted." }

List invoice comments & history

Get the complete history and comments of an invoice.

GET /invoices/{:invoice_id}/comments

Request Example

  
$ curl https://inventory.zoho.com/api/v1 /invoices/{:invoice_id}/comments?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "comments": [ { "comment_id": 982000000567019, "invoice_id": 982000000567114, "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "commented_by_id": 982000000554041, "commented_by": "John David", "comment_type": "system", "operation_type": "Added", "date": "2013-11-17", "date_description": "yesterday", "time": "2:02 AM", "transaction_id": " ", "transaction_type": "invoice" } ] }

Add comment

Add a comment for an invoice.

POST /invoices/{:invoice_id}/comments

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/comments?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Comments added." }

Query Params

description
Optional
A short note added
payment_expected_date
Optional
Expected date pf payment
show_comment_to_clients
Optional
Boolean to check if the comment to be shown to the clients

Update comment

Update an existing comment of an invoice.

PUT /invoices/{:invoice_id}/comments/:comment_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/comments/:comment_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "comment_id": 982000000567019, "invoice_id": 982000000567114, "description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.", "commented_by_id": 982000000554041, "commented_by": "John David", "date": "2013-11-17", "date_description": "yesterday", "time": "2:02 AM", "comment_type": "system" }

Query Params

description
Optional
The comment on a invoice
show_comment_to_clients
Optional
Boolean to check if the comment to be shown to the clients

Delete a comment

Delete an invoice comment.

DELETE /invoices/{:invoice_id}/comments/{:comment_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/invoices/{:invoice_id}/comments/{:comment_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The comment has been deleted." }

Purchase Orders

A purchase order is an official document that you issue to your vendors, indicating relevant information about what you want to buy, the quantity, the price agreed for that particular product or service.

Example

{ "purchaseorder_id": 4815000000044972, "purchaseorder_number": "PO-00002", "date": "2015-05-28T00:00:00.000Z", "expected_delivery_date": "2015-05-28T00:00:00.000Z", "reference_number": "REF-P-00002", "status": "Partially_Received", "vendor_id": 4815000000044080, "vendor_name": "Molly", "contact_persons": [ "460000000026051" ], "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "delivery_date": "2015-06-01T00:00:00.000Z", "is_emailed": true, "salesorder_id": 4815000000044936, "is_drop_shipment": true, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "purchaseorder_item_id": 4815000000044892, "account_id": 4815000000035003, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "purchase_rate": 122, "quantity": 2, "quantity_received": 2, "unit": "qty", "item_total": 244, "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29 } ], "price_precision": 2, "pricebook_id": 4815000000044054, "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "ship_via": "FedEx", "ship_via_id": 4815000000044822, "attention": "Tony", "delivery_org_address_id": 4815000000044077, "delivery_customer_id": 4815000000044066, "delivery_customer_name": "Tony", "delivery_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "attachment_name": "sample.pdf", "can_send_in_mail": true, "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z", "can_mark_as_bill": true, "can_mark_as_unbill": false, "purchasereceives": [ { "receive_id": 4815000000045035, "receive_number": "PR-00002", "date": "2015-05-28T00:00:00.000Z", "notes": "Sample Note" } ], "bills": [ { "bill_id": 4815000000045067, "bill_number": "BL-00002", "status": "Partially_Received", "date": "2015-05-28T00:00:00.000Z", "due_date": "2015-06-28T00:00:00.000Z", "total": 350, "balance": 100 } ] }

Attribute

purchaseorder_id
long
Unique ID generated by the server for the Purchase Order.
purchaseorder_number
string
Purchase Order number.
date
string
Date of Purchase Order
expected_delivery_date
string
Expected date of delivery for the items ordered.
reference_number
string
Reference number of purchase order.
status
string
Status of Purchase Order.
vendor_id
long
Unique ID generated by the server for the vendor.
vendor_name
string
Name of the vendor.
contact_persons
array
Array of contact person IDs.
currency_id
long
Unique ID generated by the server for the currency. This is used as an identifier.
currency_code
string
Currency code.
currency_symbol
string
The symbol for the selected currency.
exchange_rate
double
Exchange rate of the currency, with respect to the base currency.
delivery_date
string
Date of delivery of the product.
is_emailed
boolean
Checks whether the purchase order has been emailed or not.
salesorder_id
long
Sales Order ID, in case of Drop Shipment.
is_drop_shipment
boolean
Default is FALSE, in case of drop shipment value must be TRUE.
list
Purchase order contains multiple line items. Each item contains item_id, line_item_id, purchaseorder_item_id, account_id, name, description, item_order, bcy_rate, purchase_rate, quantity, quantity_received, unit, item_total, tax_id, tax_name, tax_type, tax_percentage, image_id, image_name, image_type.
item_id
long
Unique ID generated by the server for the item. This is used as an identifier.
line_item_id
long
Unique ID generated by the server for each line item. This is used as an identifier.
purchaseorder_item_id
long
Purchase Order item ID.
account_id
long
Account ID of the item.
name
string
Name of the line item.
description
string
Description of the line item.
item_order
int
The order of the line items, starts from 0 by default.
bcy_rate
double
Item rate in the organization's base currency.
purchase_rate
double
Purchase Price of the line item.
quantity
double
Quantity of the line item.
quantity_received
double
Quantity invoiced of the line item.
unit
string
Unit of line item.
item_total
double
Total of line item.
tax_id
long
Unique ID generated by the server for the tax. This is used as an identifier.
tax_name
string
Name of the tax applied on the line item.
tax_type
string
Denotes the type of the tax. This can either be a single tax or a tax group.
tax_percentage
double
Percentage of the tax.
image_id
double
Unique ID generated by the server for the item image. This is used an identifier.
image_name
string
Name of the image of the line item.
image_type
string
The type (file format) of the image.
sub_total
double
Sub total of the Purchase Order.
tax_total
double
Tax total of the Purchase Order.
total
double
Total amount of the Purchase Order.
list
Number of taxes applied on the Purchase Order. Each tax contains: tax_name and tax_amount.
tax_name
string
Name of the tax applied on the line item.
tax_amount
double
Amount of the tax.
price_precision
integer
The precision level for the price's decimal point in a Purchase Order.
pricebook_id
string
Unique ID generated by the server for the Pricebook. This is used as an identifier.
billing_address
list
Customer's billing address. It contains - address, city, state, zip, country and fax.
address
string
Name of the street of the customer’s billing address.
city
string
Name of the city of the customer’s billing address.
state
string
Name of the state of the customer's billing address.
zip
string
Zip code of the customer’s billing address.
country
string
Name of the country of the customer’s billing address.
fax
string
Fax number of the customer’s billing address.
notes
string
Notes for the Purchase Order.
terms
string
Terms for the Purchase Order.
ship_via
string
Shipping method for the Purchase Order.
ship_via_id
long
Unique ID generated by the server. This is used as identifier.
attention
string
Name of the person, whose attention is required.
delivery_org_address_id
long
Unique ID generated by the server. This is used as identifier.
delivery_customer_id
long
Customer ID for delivery address
delivery_customer_name
string
Customer's name at the delivery address.
delivery_address
list
Customer's delivery address. It contains - address, city, state, zip, country and fax.
address
string
Name of the street of the customer’s billing address.
city
string
Name of the city of the customer’s billing address.
state
string
Name of the state of the customer's billing address.
zip
string
Zip code of the customer’s billing address.
country
string
Name of the country of the customer’s billing address.
fax
string
Fax number of the customer’s billing address.
attachment_name
string
Name of attached file with Purchase Order.
can_send_in_mail
boolean
Checks whether it can be sent in a mail or not.
template_id
long
Unique ID generated by the server for the Template. This is used as an identifier.
template_name
string
Name of the template used for the Purchase Order.
template_type
string
Type of Template used to create Purchase Order.
created_time
string
Time at which the Purchase Order was created.
last_modified_time
string
Time at which the Purchase Order details were last modified.
can_mark_as_bill
boolean
Checks whether a Purchase Order can be converted to a Bill or not.
can_mark_as_unbill
boolean
Checks whether a Purchase Order can be unbilled or not.
purchasereceives
list
Purchase receives for purchase order. Each Recieve contains- receive_id, receive_number, date and note.
receive_id
long
Unique ID generated by the server for the Purchase Receive. This is used as identifier.
receive_number
string
Number of the Purchase Receive.
date
string
Date of Purchase Order
notes
string
Notes for the Purchase Order.
list
Bills raised for purchase order. Each bill contains these fields: bill_id, bill_number, status, date, due_date, total, balance.
bill_id
long
Unique ID generated by the server. This is used as identifier.
bill_number
string
Bill number of Purchase Order.
status
string
Status of Purchase Order.
date
string
Date of Purchase Order
due_date
string
Due date of the Bill.
total
double
Total amount of the Purchase Order.
balance
double
Balance amount for the Bill.

Create a Purchase Order

Creates a new Sales Order in Zoho Inventory. Description about extra parameter ignore_auto_number_generation : Ignore auto sales order number generation for this Purchase order. This mandates the Purchase Order number to be entered. Allowed Values: true and false.

POST /purchaseorders?ignore_auto_number_generation={boolean}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/purchaseorders?ignore_auto_number_generation={boolean}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "purchaseorder_number": "PO-00002", "date": "2015-05-28T00:00:00.000Z", "delivery_date": "2015-06-01T00:00:00.000Z", "reference_number": "REF-P-00002", "ship_via": "FedEx", "vendor_id": 4815000000044080, "salesorder_id": 4815000000044936, "is_drop_shipment": true, "is_inclusive_tax": false, "is_backorder": false, "template_id": 4815000000017003, "contact_persons": [ "460000000026051" ], "attention": "Tony", "delivery_org_address_id": 4815000000044077, "delivery_customer_id": 4815000000044066, "notes": "Sample Note", "terms": "Terms and Conditions", "exchange_rate": 1, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "purchaseorder_item_id": 4815000000044892, "account_id": 4815000000035003, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "purchase_rate": 122, "quantity": 2, "quantity_received": 2, "unit": "qty", "item_total": 244, "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "documents": [ { "can_send_in_mail": true, "file_name": "sample.pdf", "file_type": "pdf", "file_size_formatted": "116.8 KB", "attachment_order": 1, "document_id": 16115000000096068, "file_size": 11957 } ] }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "purchase_order": { "purchaseorder_id": 4815000000044972, "documents": [ { "can_send_in_mail": true, "file_name": "sample.pdf", "file_type": "pdf", "file_size_formatted": "116.8 KB", "attachment_order": 1, "document_id": 16115000000096068, "file_size": 11957 } ], "purchaseorder_number": "PO-00002", "date": "2015-05-28T00:00:00.000Z", "expected_delivery_date": "2015-05-28T00:00:00.000Z", "date_formatted": "2015/05/28", "expected_delivery_date_formatted": "2015/05/28", "delivery_date_formatted": "2015/05/28", "status_formatted": "Draft", "billed_status": 1, "is_emailed": true, "is_inclusive_tax": false, "is_backorder": false, "reference_number": "REF-P-00002", "status": "Partially_Received", "vendor_id": 4815000000044080, "vendor_name": "Molly", "contact_persons": [ "460000000026051" ], "comments": [ { "comment_id": 16115000000097016, "purchaseorder_id": 4815000000044972, "commented_by": "John", "date_description": "few seconds ago", "time": "2:18 PM", "operation_type": "Updated", "transaction_id": 1232423434, "transaction_type": "purchaseorder" } ], "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "delivery_date": "2015-06-01T00:00:00.000Z", "salesorder_id": 4815000000044936, "is_drop_shipment": true, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "purchaseorder_item_id": 4815000000044892, "account_id": 4815000000035003, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "purchase_rate": 122, "quantity": 2, "quantity_received": 2, "unit": "qty", "item_total": 244, "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29 } ], "price_precision": 2, "pricebook_id": 4815000000044054, "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "ship_via": "FedEx", "ship_via_id": 4815000000044822, "attention": "Tony", "delivery_org_address_id": 4815000000044077, "delivery_customer_id": 4815000000044066, "delivery_customer_name": "Tony", "delivery_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "attachment_name": "sample.pdf", "can_send_in_mail": true, "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z", "purchasereceives": [ { "receive_id": 4815000000045035, "receive_number": "PR-00002", "date": "2015-05-28T00:00:00.000Z", "notes": "Sample Note" } ], "bills": [ { "bill_id": 4815000000045067, "bill_number": "BL-00002", "status": "Partially_Received", "date": "2015-05-28T00:00:00.000Z", "due_date": "2015-06-28T00:00:00.000Z", "total": 350, "balance": 100 } ] } }

ARGUMENTS

purchaseorder_number
Required
Purchase Order number.
date
Optional
Date of Purchase Order
delivery_date
Optional
Date of delivery of the product.
reference_number
Optional
Reference number of purchase order.
ship_via
Optional
Shipping method for the Purchase Order.
vendor_id
Required
Unique ID generated by the server for the vendor.
salesorder_id
Optional
Sales Order ID, in case of Drop Shipment.
is_drop_shipment
Optional
Default is FALSE, in case of drop shipment value must be TRUE.
is_inclusive_tax
Optional
This indicates whether the tax is inclusive or not.
is_backorder
Optional
This indicates whether it is a Back order or not.
template_id
Optional
Unique ID generated by the server for the Template. This is used as an identifier.
contact_persons
Optional
Array of contact person IDs.
attention
Optional
Name of the person, whose attention is required.
delivery_org_address_id
Optional
Unique ID generated by the server. This is used as identifier.
delivery_customer_id
Optional
Customer ID for delivery address
notes
Optional
Notes for the Purchase Order.
terms
Optional
Terms for the Purchase Order.
exchange_rate
Optional
Exchange rate of the currency, with respect to the base currency.
Required
Purchase order contains multiple line items. Each item contains item_id, line_item_id, purchaseorder_item_id, account_id, name, description, item_order, bcy_rate, purchase_rate, quantity, quantity_received, unit, item_total, tax_id, tax_name, tax_type, tax_percentage, image_id, image_name, image_type.
item_id
Optional
Unique ID generated by the server for the item. This is used as an identifier.
line_item_id
Optional
Unique ID generated by the server for each line item. This is used as an identifier.
purchaseorder_item_id
Optional
Purchase Order item ID.
account_id
Optional
Account ID of the item.
name
Optional
Name of the line item.
description
Optional
Description of the line item.
item_order
Optional
The order of the line items, starts from 0 by default.
bcy_rate
Optional
Item rate in the organization's base currency.
purchase_rate
Optional
Purchase Price of the line item.
quantity
Optional
Quantity of the line item.
quantity_received
Optional
Quantity invoiced of the line item.
unit
Optional
Unit of line item.
item_total
Optional
Total of line item.
tax_id
Optional
Unique ID generated by the server for the tax. This is used as an identifier.
tax_name
Optional
Name of the tax applied on the line item.
tax_type
Optional
Denotes the type of the tax. This can either be a single tax or a tax group.
tax_percentage
Optional
Percentage of the tax.
image_id
Optional
Unique ID generated by the server for the item image. This is used an identifier.
image_name
Optional
Name of the image of the line item.
image_type
Optional
The type (file format) of the image.
Optional
Purchase order can have files attached to them. Each attachment has the following attributes can_send_in_mail, file_name, file_type, file_size_formatted, attachment_order, document_id, file_size.
can_send_in_mail
Optional
Checks whether it can be sent in a mail or not.
file_name
Optional
This indicates the name of the file.
file_type
Optional
This indicates the type of the file.
file_size_formatted
Optional
This indicates the size of the formatted file.
attachment_order
Optional
This indicates the chronological number of the attachment.
document_id
Optional
Unique ID generated by the server for the document. This is used as an identifier.
file_size
Optional
this indicates the size of the attached file.

Retrieve a Purchase Order

Retrieves the details for an existing Purchase Order

GET /purchaseorders/{purchaseorder_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/purchaseorders/{purchaseorder_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "purchase_order": { "purchaseorder_id": 4815000000044972, "purchaseorder_number": "PO-00002", "date": "2015-05-28T00:00:00.000Z", "expected_delivery_date": "2015-05-28T00:00:00.000Z", "reference_number": "REF-P-00002", "status": "Partially_Received", "vendor_id": 4815000000044080, "vendor_name": "Molly", "contact_persons": [ "460000000026051" ], "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "delivery_date": "2015-06-01T00:00:00.000Z", "salesorder_id": 4815000000044936, "is_drop_shipment": true, "is_backorder": false, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "purchaseorder_item_id": 4815000000044892, "account_id": 4815000000035003, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "purchase_rate": 122, "quantity": 2, "quantity_received": 2, "unit": "qty", "item_total": 244, "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29 } ], "price_precision": 2, "pricebook_id": 4815000000044054, "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "ship_via": "FedEx", "ship_via_id": 4815000000044822, "attention": "Tony", "delivery_org_address_id": 4815000000044077, "delivery_customer_id": 4815000000044066, "delivery_customer_name": "Tony", "delivery_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "attachment_name": "sample.pdf", "can_send_in_mail": true, "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z", "purchasereceives": [ { "receive_id": 4815000000045035, "receive_number": "PR-00002", "date": "2015-05-28T00:00:00.000Z", "notes": "Sample Note" } ], "bills": [ { "bill_id": 4815000000045067, "bill_number": "BL-00002", "status": "Partially_Received", "date": "2015-05-28T00:00:00.000Z", "due_date": "2015-06-28T00:00:00.000Z", "total": 350, "balance": 100 } ] } }

Update a Purchase Order

Updates a new Sales Order in Zoho Inventory. Description about extra parameter ignore_auto_number_generation : Ignore auto Purchase order number generation for this Purchase Order. This mandates the Purchase Order number to be entered. Allowed Values: true and false.

PUT /purchaseorders/{purchaseorder_id}?ignore_auto_number_generation={boolean}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/purchaseorders/{purchaseorder_id}?ignore_auto_number_generation={boolean}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "purchaseorder_number": "PO-00002", "date": "2015-05-28T00:00:00.000Z", "expected_delivery_date": "2015-05-28T00:00:00.000Z", "reference_number": "REF-P-00002", "ship_via": "FedEx", "vendor_id": 4815000000044080, "salesorder_id": 4815000000044936, "is_drop_shipment": true, "contact_persons": [ "460000000026051" ], "attention": "Tony", "delivery_org_address_id": 4815000000044077, "delivery_customer_id": 4815000000044066, "notes": "Sample Note", "terms": "Terms and Conditions", "exchange_rate": 1, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "purchaseorder_item_id": 4815000000044892, "account_id": 4815000000035003, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "purchase_rate": 122, "quantity": 2, "quantity_received": 2, "unit": "qty", "item_total": 244, "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ] }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "purchase_order": { "purchaseorder_id": 4815000000044972, "purchaseorder_number": "PO-00002", "date": "2015-05-28T00:00:00.000Z", "expected_delivery_date": "2015-05-28T00:00:00.000Z", "reference_number": "REF-P-00002", "status": "Partially_Received", "vendor_id": 4815000000044080, "vendor_name": "Molly", "contact_persons": [ "460000000026051" ], "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "delivery_date": "2015-06-01T00:00:00.000Z", "salesorder_id": 4815000000044936, "is_drop_shipment": true, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "purchaseorder_item_id": 4815000000044892, "account_id": 4815000000035003, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "purchase_rate": 122, "quantity": 2, "quantity_received": 2, "unit": "qty", "item_total": 244, "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29 } ], "price_precision": 2, "pricebook_id": 4815000000044054, "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "ship_via": "FedEx", "ship_via_id": 4815000000044822, "attention": "Tony", "delivery_org_address_id": 4815000000044077, "delivery_customer_id": 4815000000044066, "delivery_customer_name": "Tony", "delivery_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "attachment_name": "sample.pdf", "can_send_in_mail": true, "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z", "purchasereceives": [ { "receive_id": 4815000000045035, "receive_number": "PR-00002", "date": "2015-05-28T00:00:00.000Z", "notes": "Sample Note" } ], "bills": [ { "bill_id": 4815000000045067, "bill_number": "BL-00002", "status": "Partially_Received", "date": "2015-05-28T00:00:00.000Z", "due_date": "2015-06-28T00:00:00.000Z", "total": 350, "balance": 100 } ] } }

ARGUMENTS

purchaseorder_number
Required
Purchase Order number.
date
Optional
Date of Purchase Order
expected_delivery_date
Optional
Expected date of delivery for the items ordered.
reference_number
Optional
Reference number of purchase order.
ship_via
Optional
Shipping method for the Purchase Order.
vendor_id
Required
Unique ID generated by the server for the vendor.
salesorder_id
Optional
Sales Order ID, in case of Drop Shipment.
is_drop_shipment
Optional
Default is FALSE, in case of drop shipment value must be TRUE.
contact_persons
Optional
Array of contact person IDs.
attention
Optional
Name of the person, whose attention is required.
delivery_org_address_id
Optional
Unique ID generated by the server. This is used as identifier.
delivery_customer_id
Optional
Customer ID for delivery address
notes
Optional
Notes for the Purchase Order.
terms
Optional
Terms for the Purchase Order.
exchange_rate
Optional
Exchange rate of the currency, with respect to the base currency.
Required
Purchase order contains multiple line items. Each item contains item_id, line_item_id, purchaseorder_item_id, account_id, name, description, item_order, bcy_rate, purchase_rate, quantity, quantity_received, unit, item_total, tax_id, tax_name, tax_type, tax_percentage, image_id, image_name, image_type.
item_id
Optional
Unique ID generated by the server for the item. This is used as an identifier.
line_item_id
Optional
Unique ID generated by the server for each line item. This is used as an identifier.
purchaseorder_item_id
Optional
Purchase Order item ID.
account_id
Optional
Account ID of the item.
name
Optional
Name of the line item.
description
Optional
Description of the line item.
item_order
Optional
The order of the line items, starts from 0 by default.
bcy_rate
Optional
Item rate in the organization's base currency.
purchase_rate
Optional
Purchase Price of the line item.
quantity
Optional
Quantity of the line item.
quantity_received
Optional
Quantity invoiced of the line item.
unit
Optional
Unit of line item.
item_total
Optional
Total of line item.
tax_id
Optional
Unique ID generated by the server for the tax. This is used as an identifier.
tax_name
Optional
Name of the tax applied on the line item.
tax_type
Optional
Denotes the type of the tax. This can either be a single tax or a tax group.
tax_percentage
Optional
Percentage of the tax.
image_id
Optional
Unique ID generated by the server for the item image. This is used an identifier.
image_name
Optional
Name of the image of the line item.
image_type
Optional
The type (file format) of the image.

Delete a Purchase Order

Deletes a Purchase Order from Zoho Inventory.

DELETE /purchaseorders/{purchaseorder_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/purchaseorders/{purchaseorder_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The Purchase Order has been deleted." }

List all Purchase Orders

Lists all the Purchase Orders present in Zoho Inventory.

GET /purchaseorders

Request Example

  
$ curl https://inventory.zoho.com/api/v1/purchaseorders?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "purchase_order": { "purchaseorder_id": 4815000000044972, "purchaseorder_number": "PO-00002", "date": "2015-05-28T00:00:00.000Z", "expected_delivery_date": "2015-05-28T00:00:00.000Z", "reference_number": "REF-P-00002", "status": "Partially_Received", "vendor_id": 4815000000044080, "vendor_name": "Molly", "contact_persons": [ "460000000026051" ], "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "delivery_date": "2015-06-01T00:00:00.000Z", "salesorder_id": 4815000000044936, "is_drop_shipment": true, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "purchaseorder_item_id": 4815000000044892, "account_id": 4815000000035003, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "purchase_rate": 122, "quantity": 2, "quantity_received": 2, "unit": "qty", "item_total": 244, "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29 } ], "price_precision": 2, "pricebook_id": 4815000000044054, "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "ship_via": "FedEx", "ship_via_id": 4815000000044822, "attention": "Tony", "delivery_org_address_id": 4815000000044077, "delivery_customer_id": 4815000000044066, "delivery_customer_name": "Tony", "delivery_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "attachment_name": "sample.pdf", "can_send_in_mail": true, "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z", "purchasereceives": [ { "receive_id": 4815000000045035, "receive_number": "PR-00002", "date": "2015-05-28T00:00:00.000Z", "notes": "Sample Note" } ], "bills": [ { "bill_id": 4815000000045067, "bill_number": "BL-00002", "status": "Partially_Received", "date": "2015-05-28T00:00:00.000Z", "due_date": "2015-06-28T00:00:00.000Z", "total": 350, "balance": 100 } ] } }

Mark as Issued

Marks a Purchase Order as Issued.

POST /purchaseorders/{purchaseorder_id}/status/issued

Request Example

  
$ curl https://inventory.zoho.com/api/v1/purchaseorders/{purchaseorder_id}/status/issued?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The purchase order has been marked as issued." }

Mark as Cancelled

Marks a Purchase Order as Cancelled.

POST /purchaseorders/{purchaseorder_id}/status/cancelled

Request Example

  
$ curl https://inventory.zoho.com/api/v1/purchaseorders/{purchaseorder_id}/status/cancelled?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The purchase order has been marked as cancelled." }

Purchase Receives

A new purchase receive can a be created.To create Purchase receive, URL parameter purchaseorder_id is needed.

Example

{ "purchaseorder_id": 4815000000044972, "purchaseorder_number": "PO-00002", "receive_id": 4815000000045035, "receive_number": "PR-00002", "date": "2015-05-28T00:00:00.000Z", "vendor_id": 4815000000044080, "vendor_name": "Molly", "contact_persons": {}, "notes": "Sample Note.", "line_items": [ { "line_item_id": 4815000000044897, "item_id": 4815000000044100, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "quantity": 2, "unit": "qty" } ], "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "shipping_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z" }

Attribute

purchaseorder_id
long
Unique ID generated by the server for the Purchase Order.
purchaseorder_number
string
Purchase Order number.
receive_id
long
Unique ID generated by the server for the Purchase Receive. This is used as identifier.
receive_number
string
Number of the Purchase Receive.
date
string
Date of Purchase Order
vendor_id
long
Unique ID generated by the server for the vendor.
vendor_name
string
Name of the vendor.
contact_persons
object
Array of contact person IDs.
notes
string
Purchase Receive notes.
list
Number of line items for purchase receive. Each line item contains line_item_id, item_id, name, description, item_order, quantity and unit.
line_item_id
long
Unique ID generated by the server for each line item. This is used as an identifier.
item_id
long
Unique ID generated by the server for the item. This is used as an identifier.
name
string
Name of the line item.
description
string
Description of the line item.
item_order
int
The order of the line items, starts from 0 by default.
quantity
double
Quantity of the line item.
unit
string
Unit of line item.
billing_address
list
Customer's billing address. It contains - address, city, state, zip, country and fax.
address
string
Name of the street of the customer’s billing address.
city
string
Name of the city of the customer’s billing address.
state
string
Name of the state of the customer's billing address.
zip
string
Zip code of the customer’s billing address.
country
string
Name of the country of the customer’s billing address.
fax
string
Fax number of the customer’s billing address.
shipping_address
list
Customer's shipping address. It contains - address, city, state, zip, country and fax.
address
string
Name of the street of the customer’s billing address.
city
string
Name of the city of the customer’s billing address.
state
string
Name of the state of the customer's billing address.
zip
string
Zip code of the customer’s billing address.
country
string
Name of the country of the customer’s billing address.
fax
string
Fax number of the customer’s billing address.
created_time
string
Time at which the Purchase Receive was created.
last_modified_time
string
Time at which the Purchase Order details were last modified.

Create a purchase receive

A new purchase receive can a be created.To create Purchase receive, URL parameter purchaseorder_id is needed.

POST /purchasereceives

Request Example

  
$ curl https://inventory.zoho.com/api/v1/purchasereceives?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "receive_number": "PR-00002", "date": "2015-05-28T00:00:00.000Z", "notes": "Sample Note.", "line_items": [ { "line_item_id": 4815000000044897, "item_id": 4815000000044100, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "quantity": 2, "unit": "qty" } ] }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "purchase_receive": { "purchaseorder_id": 4815000000044972, "purchaseorder_number": "PO-00002", "receive_id": 4815000000045035, "receive_number": "PR-00002", "date": "2015-05-28T00:00:00.000Z", "vendor_id": 4815000000044080, "vendor_name": "Molly", "contact_persons": {...}, "notes": "Sample Note.", "line_items": [ { "line_item_id": 4815000000044897, "item_id": 4815000000044100, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "quantity": 2, "unit": "qty" } ], "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "shipping_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z" } }

ARGUMENTS

receive_number
Required
Number of the Purchase Receive.
date
Optional
Date of Purchase Order
notes
Optional
Purchase Receive notes.
Required
Number of line items for purchase receive. Each line item contains line_item_id, item_id, name, description, item_order, quantity and unit.
line_item_id
Optional
Unique ID generated by the server for each line item. This is used as an identifier.
item_id
Optional
Unique ID generated by the server for the item. This is used as an identifier.
name
Optional
Name of the line item.
description
Optional
Description of the line item.
item_order
Optional
The order of the line items, starts from 0 by default.
quantity
Optional
Quantity of the line item.
unit
Optional
Unit of line item.

Retrieve a Purchase Receive

Fetches a Purchase Receive from Zoho Inventory.

GET /purchasereceives/{purchasereceive_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/purchasereceives/{purchasereceive_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "purchase_receive": { "purchaseorder_id": 4815000000044972, "purchaseorder_number": "PO-00002", "receive_id": 4815000000045035, "receive_number": "PR-00002", "date": "2015-05-28T00:00:00.000Z", "vendor_id": 4815000000044080, "vendor_name": "Molly", "contact_persons": {...}, "notes": "Sample Note.", "line_items": [ { "line_item_id": 4815000000044897, "item_id": 4815000000044100, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "quantity": 2, "unit": "qty" } ], "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "shipping_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z" } }

Delete a Purchase Receive

Deletes a Purchase Receive from Zoho Inventory

DELETE /purchasereceives/{purchasereceive_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/purchasereceives/{purchasereceive_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The Purchase Receive has been deleted." }

Bills

When your vendor supplies goods/services to you on credit, you’re sent an invoice that details the amount of money you owe him. You can record this as a bill in Zoho Inventory and track it until it’s paid.

Example

{ "bill_id": 4815000000045067, "purchaseorder_id": 4815000000044972, "vendor_id": 4815000000044080, "vendor_name": "Molly", "unused_credits_payable_amount": 0, "status": "paid", "bill_number": "BL-00002", "date": "2015-05-29T00:00:00.000Z", "due_date": "2015-05-29T00:00:00.000Z", "reference_number": "PO-00003", "due_by_days": 69, "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "price_precision": 2, "exchange_rate": 1, "is_item_level_tax_calc": true, "line_items": [ { "purchaseorder_item_id": 4815000000045245, "receive_item_id": 4815000000044131, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "account_id": 4815000000035003, "account_name": "Inventory Asset", "description": "Sample Description", "bcy_rate": 122, "rate": 6, "quantity": 5, "tax_id": 4815000000044043, "tax_name": "Purchase tax", "tax_type": "Tax group", "tax_percentage": 12, "item_total": 290, "item_order": 0, "unit": "qty", "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "taxes": [ { "tax_name": "Purchase tax", "tax_amount": 29 } ], "vendor_credits_applied": 24, "sub_total": 30, "tax_total": 2, "balance": 0, "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "payments": [ { "payment_id": 4815000000046039, "bill_id": 4815000000045067, "bill_payment_id": 4815000000046041, "payment_mode": "Cash", "payment_number": 2, "description": "Sample Description", "date": "2015-05-29T00:00:00.000Z", "reference_number": "PO-00003", "exchange_rate": 1, "amount": 234, "paid_through_account_id": 4815000000000361, "paid_through_account_name": "Petty Cash", "is_single_bill_payment": true } ], "vendor_credits": [ {} ], "created_time": "2015-05-29T00:36:13.110Z", "last_modified_time": "2015-05-29T00:37:54.110Z", "reference_id": 4815000000000342, "notes": "Sample Note", "terms": "Term & Conditions", "attachment_name": "sample-attachments", "open_purchaseorders_count": 4 }

Attribute

bill_id
long
Unique ID generated by the server. This is used as identifier.
purchaseorder_id
long
Unique ID generated by the server for the Purchase Order.
vendor_id
long
Unique ID generated by the server for the vendor.
vendor_name
string
Name of the vendor.
unused_credits_payable_amount
double
Unused credit payable amount.
status
string
Status of the Bill.
bill_number
string
Bill number of Purchase Order.
date
string
Date of the Bill.
due_date
string
Due date for the Bill.
reference_number
string
Reference number for the Bill.
due_by_days
integer
Number of days by which the Bill is due.
currency_id
long
Unique ID generated by the server for the currency. This is used as an identifier.
currency_code
string
Currency code.
currency_symbol
string
The symbol for the selected currency.
price_precision
integer
The precision level for the price's decimal point in a Bill.
exchange_rate
double
Exchange rate of the currency, with respect to the base currency.
is_item_level_tax_calc
boolean
Checks whether item level tax is calculated or not.
list
The line items for a Bill.
purchaseorder_item_id
long
Unique ID generated for a line item in the Purchase Order.
receive_item_id
long
Unique ID generated by the server for the receive.
line_item_id
long
Unique ID generated by the server for each line item. This is used as an identifier.
name
string
Name of the line item.
account_id
long
Account ID of the item.
account_name
string
Name of the account.
description
string
Description for the line item.
bcy_rate
double
Item rate in the organization's base currency.
rate
double
Item's Puchase Price.
quantity
double
Quantity of the Item.
tax_id
long
Unique ID of the tax applied on the line item.
tax_name
string
Name of the tax.
tax_type
string
Type of the tax
tax_percentage
double
Percentage of the tax applied.
item_total
double
The total for the items.
item_order
double
Order of the line item, starting from 0.
unit
string
Unit of the item.
image_id
double
Unique ID generated by the server for the item image. This is used an identifier.
image_name
string
Name of the image of the line item.
image_type
string
The type (file format) of the image.
list
Number of taxes applied on the Purchase Order. Each tax contains: tax_name and tax_amount.
tax_name
string
Name of the tax.
tax_amount
double
Amount of the tax.
vendor_credits_applied
double
Vendor credits applied to the Bill.
sub_total
double
Sub Total of the Bill.
tax_total
double
The total of the Tax.
balance
double
Remaining balance of the Bill.
billing_address
list
Customer's billing address. It contains - address, city, state, zip, country and fax.
address
string
Name of the street of the customer’s billing address.
city
string
Name of the city of the customer’s billing address.
state
string
Name of the state of the customer's billing address.
zip
string
Zip code of the customer’s billing address.
country
string
Name of the country of the customer’s billing address.
fax
string
Fax number of the customer’s billing address.
list
Payment details for the Bill.
payment_id
long
Unique ID generated by the server. This is used as identifier.
bill_id
long
Unique ID generated by the server. This is used as identifier.
bill_payment_id
long
Bill payment ID
payment_mode
string
Mode of payment for the Bill.
payment_number
string
Number of the payment.
description
string
Description for the line item.
date
string
Date of the Bill.
reference_number
string
Reference number for the Bill.
exchange_rate
double
Exchange rate of the currency, with respect to the base currency.
amount
double
Amount paid for the payment.
paid_through_account_id
long
ID for the account through which the payment is made.
paid_through_account_id
long
ID for the account through which the payment is made.
paid_through_account_name
string
Name of the account.
is_single_bill_payment
boolean
Checks whether the payment is for single bills or multiple bills.
vendor_credits
list
The available Vendor Credits.
created_time
string
Time at which the Bill details were last created.
last_modified_time
string
Time at which the bill details were last Modified.
reference_id
long
Unique ID generated by the server for the reference.
notes
string
Notes for the Bill.
terms
string
Terms and conditions.
attachment_name
string
Name of the attached file.
open_purchaseorders_count
integer
Number of Purchase Orders that are associated with this Bill and open.

Create a Bill

Creates a Bill in Zoho Inventory. Description about the extra parameter attachment : Allowed extensions are gif, png, jpeg, jpg, bmp and pdf.

POST /bills

Request Example

  
$ curl https://inventory.zoho.com/api/v1/bills?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "purchaseorder_id": 4815000000044972, "vendor_id": 4815000000044080, "bill_number": "BL-00002", "date": "2015-05-29T00:00:00.000Z", "due_date": "2015-05-29T00:00:00.000Z", "reference_number": "PO-00003", "currency_id": 4815000000000097, "exchange_rate": 1, "is_item_level_tax_calc": true, "notes": "Sample Note", "terms": "Term & Conditions", "is_inclusive_tax": false, "line_items": [ { "purchaseorder_item_id": 4815000000045245, "receive_item_id": 4815000000044131, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "account_id": 4815000000035003, "account_name": "Inventory Asset", "description": "Sample Description", "bcy_rate": 122, "rate": 6, "quantity": 5, "tax_id": 4815000000044043, "tax_name": "Purchase tax", "tax_type": "Tax group", "tax_percentage": 12, "item_total": 290, "item_order": 0, "unit": "qty", "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ] }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The Bill has been created.", "bill": { "bill_id": 4815000000045067, "purchaseorder_id": 4815000000044972, "vendor_id": 4815000000044080, "vendor_name": "Molly", "unused_credits_payable_amount": 0, "status": "paid", "bill_number": "BL-00002", "date": "2015-05-29T00:00:00.000Z", "due_date": "2015-05-29T00:00:00.000Z", "reference_number": "PO-00003", "due_by_days": 69, "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "price_precision": 2, "exchange_rate": 1, "is_item_level_tax_calc": true, "line_items": [ { "purchaseorder_item_id": 4815000000045245, "receive_item_id": 4815000000044131, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "account_id": 4815000000035003, "account_name": "Inventory Asset", "description": "Sample Description", "bcy_rate": 122, "rate": 6, "quantity": 5, "tax_id": 4815000000044043, "tax_name": "Purchase tax", "tax_type": "Tax group", "tax_percentage": 12, "item_total": 290, "item_order": 0, "unit": "qty", "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "taxes": [ { "tax_name": "Purchase tax", "tax_amount": 29 } ], "vendor_credits_applied": 24, "sub_total": 30, "tax_total": 2, "balance": 0, "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "payments": [ { "payment_id": 4815000000046039, "bill_id": 4815000000045067, "bill_payment_id": 4815000000046041, "payment_mode": "Cash", "payment_number": 2, "description": "Sample Description", "date": "2015-05-29T00:00:00.000Z", "reference_number": "PO-00003", "exchange_rate": 1, "amount": 234, "paid_through_account_id": 4815000000000361, "paid_through_account_name": "Petty Cash", "is_single_bill_payment": true } ], "vendor_credits": [ {...} ], "created_time": "2015-05-29T00:36:13.110Z", "last_modified_time": "2015-05-29T00:37:54.110Z", "reference_id": 4815000000000342, "notes": "Sample Note", "terms": "Term & Conditions", "attachment_name": "sample-attachments", "open_purchaseorders_count": 4 } }

ARGUMENTS

purchaseorder_id
Optional
Unique ID generated by the server for the Purchase Order.
vendor_id
Required
Unique ID generated by the server for the vendor.
bill_number
Required
Bill number of Purchase Order.
date
Required
Date of the Bill.
due_date
Required
Due date for the Bill.
reference_number
Optional
Reference number for the Bill.
currency_id
Optional
Unique ID generated by the server for the currency. This is used as an identifier.
exchange_rate
Optional
Exchange rate of the currency, with respect to the base currency.
is_item_level_tax_calc
Optional
Checks whether item level tax is calculated or not.
notes
Optional
Notes for the Bill.
terms
Optional
Terms and conditions.
is_inclusive_tax
Optional
Indicates whether the item rates are tax inclusive or exclusive
Required
The line items for a Bill.
purchaseorder_item_id
Optional
Unique ID generated for a line item in the Purchase Order.
receive_item_id
Optional
Unique ID generated by the server for the receive.
line_item_id
Optional
Unique ID generated by the server for each line item. This is used as an identifier.
name
Optional
Name of the line item.
account_id
Optional
Account ID of the item.
account_name
Optional
Name of the account.
description
Optional
Description for the line item.
bcy_rate
Optional
Item rate in the organization's base currency.
rate
Optional
Item's Puchase Price.
quantity
Optional
Quantity of the Item.
tax_id
Optional
Unique ID of the tax applied on the line item.
tax_name
Optional
Name of the tax.
tax_type
Optional
Type of the tax
tax_percentage
Optional
Percentage of the tax applied.
item_total
Optional
The total for the items.
item_order
Optional
Order of the line item, starting from 0.
unit
Optional
Unit of the item.
image_id
Optional
Unique ID generated by the server for the item image. This is used an identifier.
image_name
Optional
Name of the image of the line item.
image_type
Optional
The type (file format) of the image.

Retrieve a Bill

Fetches the details of a Bill.

GET /bills/{bill_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/bills/{bill_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "bill": { "bill_id": 4815000000045067, "purchaseorder_id": 4815000000044972, "vendor_id": 4815000000044080, "vendor_name": "Molly", "unused_credits_payable_amount": 0, "status": "paid", "bill_number": "BL-00002", "date": "2015-05-29T00:00:00.000Z", "due_date": "2015-05-29T00:00:00.000Z", "reference_number": "PO-00003", "due_by_days": 69, "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "price_precision": 2, "exchange_rate": 1, "is_item_level_tax_calc": true, "line_items": [ { "purchaseorder_item_id": 4815000000045245, "receive_item_id": 4815000000044131, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "account_id": 4815000000035003, "account_name": "Inventory Asset", "description": "Sample Description", "bcy_rate": 122, "rate": 6, "quantity": 5, "tax_id": 4815000000044043, "tax_name": "Purchase tax", "tax_type": "Tax group", "tax_percentage": 12, "item_total": 290, "item_order": 0, "unit": "qty", "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "taxes": [ { "tax_name": "Purchase tax", "tax_amount": 29 } ], "vendor_credits_applied": 24, "sub_total": 30, "tax_total": 2, "balance": 0, "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "payments": [ { "payment_id": 4815000000046039, "bill_id": 4815000000045067, "bill_payment_id": 4815000000046041, "payment_mode": "Cash", "payment_number": 2, "description": "Sample Description", "date": "2015-05-29T00:00:00.000Z", "reference_number": "PO-00003", "exchange_rate": 1, "amount": 234, "paid_through_account_id": 4815000000000361, "paid_through_account_name": "Petty Cash", "is_single_bill_payment": true } ], "vendor_credits": [ {...} ], "created_time": "2015-05-29T00:36:13.110Z", "last_modified_time": "2015-05-29T00:37:54.110Z", "reference_id": 4815000000000342, "notes": "Sample Note", "terms": "Term & Conditions", "attachment_name": "sample-attachments", "open_purchaseorders_count": 4 } }

Update a Bill

Updates the details of an existing Bill.

PUT /bills/{bill_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/bills/{bill_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "purchaseorder_id": 4815000000044972, "vendor_id": 4815000000044080, "bill_number": "BL-00002", "date": "2015-05-29T00:00:00.000Z", "due_date": "2015-05-29T00:00:00.000Z", "reference_number": "PO-00003", "currency_id": 4815000000000097, "exchange_rate": 1, "is_item_level_tax_calc": true, "notes": "Sample Note", "terms": "Term & Conditions", "is_inclusive_tax": false, "line_items": [ { "purchaseorder_item_id": 4815000000045245, "receive_item_id": 4815000000044131, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "account_id": 4815000000035003, "account_name": "Inventory Asset", "description": "Sample Description", "bcy_rate": 122, "rate": 6, "quantity": 5, "tax_id": 4815000000044043, "tax_name": "Purchase tax", "tax_type": "Tax group", "tax_percentage": 12, "item_total": 290, "item_order": 0, "unit": "qty", "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ] }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The Bill has been updated.", "bill": { "bill_id": 4815000000045067, "purchaseorder_id": 4815000000044972, "vendor_id": 4815000000044080, "vendor_name": "Molly", "unused_credits_payable_amount": 0, "status": "paid", "bill_number": "BL-00002", "date": "2015-05-29T00:00:00.000Z", "due_date": "2015-05-29T00:00:00.000Z", "reference_number": "PO-00003", "due_by_days": 69, "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "price_precision": 2, "exchange_rate": 1, "is_item_level_tax_calc": true, "line_items": [ { "purchaseorder_item_id": 4815000000045245, "receive_item_id": 4815000000044131, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "account_id": 4815000000035003, "account_name": "Inventory Asset", "description": "Sample Description", "bcy_rate": 122, "rate": 6, "quantity": 5, "tax_id": 4815000000044043, "tax_name": "Purchase tax", "tax_type": "Tax group", "tax_percentage": 12, "item_total": 290, "item_order": 0, "unit": "qty", "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "taxes": [ { "tax_name": "Purchase tax", "tax_amount": 29 } ], "vendor_credits_applied": 24, "sub_total": 30, "tax_total": 2, "balance": 0, "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "payments": [ { "payment_id": 4815000000046039, "bill_id": 4815000000045067, "bill_payment_id": 4815000000046041, "payment_mode": "Cash", "payment_number": 2, "description": "Sample Description", "date": "2015-05-29T00:00:00.000Z", "reference_number": "PO-00003", "exchange_rate": 1, "amount": 234, "paid_through_account_id": 4815000000000361, "paid_through_account_name": "Petty Cash", "is_single_bill_payment": true } ], "vendor_credits": [ {...} ], "created_time": "2015-05-29T00:36:13.110Z", "last_modified_time": "2015-05-29T00:37:54.110Z", "reference_id": 4815000000000342, "notes": "Sample Note", "terms": "Term & Conditions", "attachment_name": "sample-attachments", "open_purchaseorders_count": 4 } }

ARGUMENTS

purchaseorder_id
Optional
Unique ID generated by the server for the Purchase Order.
vendor_id
Required
Unique ID generated by the server for the vendor.
bill_number
Required
Bill number of Purchase Order.
date
Required
Date of the Bill.
due_date
Required
Due date for the Bill.
reference_number
Optional
Reference number for the Bill.
currency_id
Optional
Unique ID generated by the server for the currency. This is used as an identifier.
exchange_rate
Optional
Exchange rate of the currency, with respect to the base currency.
is_item_level_tax_calc
Optional
Checks whether item level tax is calculated or not.
notes
Optional
Notes for the Bill.
terms
Optional
Terms and conditions.
is_inclusive_tax
Optional
Indicates whether the item rates are tax inclusive or exclusive
Required
The line items for a Bill.
purchaseorder_item_id
Optional
Unique ID generated for a line item in the Purchase Order.
receive_item_id
Optional
Unique ID generated by the server for the receive.
line_item_id
Optional
Unique ID generated by the server for each line item. This is used as an identifier.
name
Optional
Name of the line item.
account_id
Optional
Account ID of the item.
account_name
Optional
Name of the account.
description
Optional
Description for the line item.
bcy_rate
Optional
Item rate in the organization's base currency.
rate
Optional
Item's Puchase Price.
quantity
Optional
Quantity of the Item.
tax_id
Optional
Unique ID of the tax applied on the line item.
tax_name
Optional
Name of the tax.
tax_type
Optional
Type of the tax
tax_percentage
Optional
Percentage of the tax applied.
item_total
Optional
The total for the items.
item_order
Optional
Order of the line item, starting from 0.
unit
Optional
Unit of the item.
image_id
Optional
Unique ID generated by the server for the item image. This is used an identifier.
image_name
Optional
Name of the image of the line item.
image_type
Optional
The type (file format) of the image.

Delete a Bill.

Deletes a Bill from Zoho Inventory.

DELETE /bills/{bill_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/bills/{bill_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The Bill has been deleted." }

List all Bills.

Lists all the Bills in Zoho Inventory.

GET /bills

Request Example

  
$ curl https://inventory.zoho.com/api/v1/bills?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "bill": { "bill_id": 4815000000045067, "purchaseorder_id": 4815000000044972, "vendor_id": 4815000000044080, "vendor_name": "Molly", "unused_credits_payable_amount": 0, "status": "paid", "bill_number": "BL-00002", "date": "2015-05-29T00:00:00.000Z", "due_date": "2015-05-29T00:00:00.000Z", "reference_number": "PO-00003", "due_by_days": 69, "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "price_precision": 2, "exchange_rate": 1, "is_item_level_tax_calc": true, "line_items": [ { "purchaseorder_item_id": 4815000000045245, "receive_item_id": 4815000000044131, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "account_id": 4815000000035003, "account_name": "Inventory Asset", "description": "Sample Description", "bcy_rate": 122, "rate": 6, "quantity": 5, "tax_id": 4815000000044043, "tax_name": "Purchase tax", "tax_type": "Tax group", "tax_percentage": 12, "item_total": 290, "item_order": 0, "unit": "qty", "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg" } ], "taxes": [ { "tax_name": "Purchase tax", "tax_amount": 29 } ], "vendor_credits_applied": 24, "sub_total": 30, "tax_total": 2, "balance": 0, "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "payments": [ { "payment_id": 4815000000046039, "bill_id": 4815000000045067, "bill_payment_id": 4815000000046041, "payment_mode": "Cash", "payment_number": 2, "description": "Sample Description", "date": "2015-05-29T00:00:00.000Z", "reference_number": "PO-00003", "exchange_rate": 1, "amount": 234, "paid_through_account_id": 4815000000000361, "paid_through_account_name": "Petty Cash", "is_single_bill_payment": true } ], "vendor_credits": [ {...} ], "created_time": "2015-05-29T00:36:13.110Z", "last_modified_time": "2015-05-29T00:37:54.110Z", "reference_id": 4815000000000342, "notes": "Sample Note", "terms": "Term & Conditions", "attachment_name": "sample-attachments", "open_purchaseorders_count": 4 } }

Mark as Open

Marks a Bill as Open.

POST /bills/{bill_id}/status/open

Request Example

  
$ curl https://inventory.zoho.com/api/v1/bills/{bill_id}/status/open?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The bill has been marked as open." }

Mark as Void

Marks a Bill as Void.

POST /bills/{bill_id}/status/void

Request Example

  
$ curl https://inventory.zoho.com/api/v1/bills/{bill_id}/status/void?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The bill has been marked as Void." }

Customer Payments

A payment object describes details regarding a particular customer payment. There can be multiple payments for a single invoice. Multiple invoices can be paid in a single payment as well.

Example

{ "payment_id": "9030000079467", "payment_mode": "cash", "amount": 450, "amount_refunded": 50, "date": "2016-06-05", "status": "success", "reference_number": "INV-384", "description": "Payment has been added to INV-384", "customer_id": "903000000000099", "customer_name": "Bowman Furniture", "email": "benjamin.george@bowmanfurniture.com", "invoices": [ { "invoice_id": "90300000079426", "invoice_number": "INV-384", "date": "2016-06-05", "invoice_amount": 450, "amount_applied": 450, "balance_amount": 0, "tax_amount_withheld": 0 } ], "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "bank_charges": 10, "custom_fields": [ { "value": 129890, "label": "label", "data_type": "text" } ] }

Attribute

payment_id
string
Unique ID of the payment generated by the server. Maximum length allowed [2000]
payment_mode
string
Mode through which payment is made. This can be check, cash, creditcard, banktransfer, bankremittance, autotransaction or others. Maximum length [100]
amount
double
Amount paid in the respective payment.
amount_refunded
double
Amount that is refunded. Refunds are applicable only for payments whose payment_mode is autotransaction. Refunds would be made to the respective card provided by the customer.
date
string
Date on which payment is made. Date Format [yyyy-mm-dd]
status
string
Status of the payment. It can either be success or failure.
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Maximum length of the reference number [100]
description
string
Description about the payment.
customer_id
string
Customer ID of the customer involved in the payment.
customer_name
string
Name of the customer to whom the invoice is raised. Maximum length [100]
email
string
Email address of the customer involved in the payment.
list
List of invoices associated with the payment. Each invoice object contains invoice_id, invoice_number, date, invoice_amount, amount_applied and balance_amount.
invoice_id
string
Invoice ID of the required invoice.
invoice_number
string
Unique ID (starts with INV) of an invoice.
date
string
Date on which payment is made. Date Format [yyyy-mm-dd]
invoice_amount
double
Total amount raised for the invoice.
amount_applied
double
Amount paid for the invoice.
balance_amount
double
Unpaid amount of the invoice.
tax_amount_withheld
double
Amount withheld for tax.
currency_code
string
Currency code in which the payment is made.
currency_symbol
string
Customer's currency symbol.
exchange_rate
double
Exchange rate for the currency used in the invoices and customer's currency. The payment amount would be the multiplicative product of the original amount and the exchange rate.
bank_charges
double
Denotes any additional bank charges.
custom_fields
list
Additional fields for the payments.
value
string
Value of the custom field.
label
string
Label of the custom field.
data_type
string
Data type of the custom field.

Create a payment

Create a new payment.

POST /customerpayments

Request Example

  
$ curl https://inventory.zoho.com/api/v1/customerpayments?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "customer_id": "903000000000099", "payment_mode": "cash", "amount": 450, "date": "2016-06-05", "reference_number": "INV-384", "description": "Payment has been added to INV-384", "invoices": [ { "invoice_id": "90300000079426", "amount_applied": 450, "tax_amount_withheld": 0 } ], "exchange_rate": 1, "bank_charges": 10, "account_id": "450000000000353", "tax_account_id": "", "custom_fields": [ { "label": "label", "value": 129890 } ] }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The payment has been created.", "payment": { "payment_id": "9030000079467", "payment_mode": "cash", "amount": 450, "amount_refunded": 50, "bank_charges": 10, "date": "2016-06-05", "status": "success", "reference_number": "INV-384", "description": "Payment has been added to INV-384", "customer_id": "903000000000099", "customer_name": "Bowman Furniture", "email": "benjamin.george@bowmanfurniture.com", "tax_amount_withheld": 0, "invoices": [ { "invoice_id": "90300000079426", "invoice_number": "INV-384", "date": "2016-06-05", "invoice_amount": 450, "amount_applied": 450, "balance_amount": 0 } ], "exchange_rate": 1, "currency_id": "3000000002321", "currency_code": "USD", "currency_symbol": "$", "account_id": "450000000000353", "account_name": "Petty Cash", "tax_account_id": "", "tax_account_name": "", "unused_amount": 0, "last_four_digits": 1111, "custom_fields": [ { "index": 1, "value": 129890, "label": "label", "data_type": "text" } ] } }

ARGUMENTS

customer_id
Required
Customer ID of the customer involved in the payment.
payment_mode
Required
Mode through which payment is made. This can be check, cash, creditcard, banktransfer, bankremittance, autotransaction or others. Maximum length [100]
amount
Required
Amount paid in the respective payment.
date
Optional
Date on which payment is made. Date Format [yyyy-mm-dd]
reference_number
Optional
Reference number generated for the payment. A string of your choice can also be used as the reference number. Maximum length of the reference number [100]
description
Optional
Description about the payment.
Required
List of invoices associated with the payment. Each invoice object contains invoice_id, invoice_number, date, invoice_amount, amount_applied and balance_amount.
invoice_id
Required
Invoice ID of the required invoice.
amount_applied
Required
Amount paid for the invoice.
tax_amount_withheld
Optional
Amount withheld for tax.
exchange_rate
Optional , default is 1
Exchange rate for the currency used in the invoices and customer's currency. The payment amount would be the multiplicative product of the original amount and the exchange rate.
bank_charges
Optional
Denotes any additional bank charges.
account_id
Optional
ID of the cash/ bank account the payment has to be deposited.
tax_account_id
Optional
ID of the tax account, in case of withholding tax.
custom_fields
Optional
Additional fields for the payments.
label
Optional
Label of the custom field.
value
Optional
Value of the custom field.

Update a payment

Update an existing payment information.

PUT /customerpayments/{payment_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/customerpayments/{payment_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "customer_id": "903000000000099", "payment_mode": "cash", "amount": 450, "date": "2016-06-05", "reference_number": "INV-384", "description": "Payment has been added to INV-384", "invoices": [ { "invoice_id": "90300000079426", "amount_applied": 450, "tax_amount_withheld": 0 } ], "exchange_rate": 1, "bank_charges": 10, "account_id": "450000000000353", "tax_account_id": "", "custom_fields": [ { "label": "label", "value": 129890 } ] }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The payment details have been updated.", "payment": { "payment_id": "9030000079467", "payment_mode": "cash", "amount": 450, "amount_refunded": 50, "bank_charges": 10, "date": "2016-06-05", "status": "success", "reference_number": "INV-384", "description": "Payment has been added to INV-384", "customer_id": "903000000000099", "customer_name": "Bowman Furniture", "email": "benjamin.george@bowmanfurniture.com", "tax_amount_withheld": 0, "invoices": [ { "invoice_id": "90300000079426", "invoice_number": "INV-384", "date": "2016-06-05", "invoice_amount": 450, "amount_applied": 450, "balance_amount": 0 } ], "exchange_rate": 1, "currency_id": "3000000002321", "currency_code": "USD", "currency_symbol": "$", "account_id": "450000000000353", "account_name": "Petty Cash", "tax_account_id": "", "tax_account_name": "", "unused_amount": 0, "last_four_digits": 1111, "custom_fields": [ { "index": 1, "value": 129890, "label": "label", "data_type": "text" } ] } }

ARGUMENTS

customer_id
Required
Customer ID of the customer involved in the payment.
payment_mode
Required
Mode through which payment is made. This can be check, cash, creditcard, banktransfer, bankremittance, autotransaction or others. Maximum length [100]
amount
Required
Amount paid in the respective payment.
date
Optional
Date on which payment is made. Date Format [yyyy-mm-dd]
reference_number
Optional
Reference number generated for the payment. A string of your choice can also be used as the reference number. Maximum length of the reference number [100]
description
Optional
Description about the payment.
Required
List of invoices associated with the payment. Each invoice object contains invoice_id, invoice_number, date, invoice_amount, amount_applied and balance_amount.
invoice_id
Required
Invoice ID of the required invoice.
amount_applied
Required
Amount paid for the invoice.
tax_amount_withheld
Optional
Amount withheld for tax.
exchange_rate
Optional , default is 1
Exchange rate for the currency used in the invoices and customer's currency. The payment amount would be the multiplicative product of the original amount and the exchange rate.
bank_charges
Optional
Denotes any additional bank charges.
account_id
Optional
ID of the cash/ bank account the payment has to be deposited.
tax_account_id
Optional
ID of the tax account, in case of withholding tax.
custom_fields
Optional
Additional fields for the payments.
label
Optional
Label of the custom field.
value
Optional
Value of the custom field.

Retrieve a payment

Details of an existing payment.

GET /customerpayments/{payment_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/customerpayments/{payment_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "payment": { "payment_id": "9030000079467", "payment_mode": "cash", "amount": 450, "amount_refunded": 50, "bank_charges": 10, "date": "2016-06-05", "status": "success", "reference_number": "INV-384", "description": "Payment has been added to INV-384", "customer_id": "903000000000099", "customer_name": "Bowman Furniture", "email": "benjamin.george@bowmanfurniture.com", "tax_amount_withheld": 0, "invoices": [ { "invoice_id": "90300000079426", "invoice_number": "INV-384", "date": "2016-06-05", "invoice_amount": 450, "amount_applied": 450, "balance_amount": 0 } ], "exchange_rate": 1, "currency_id": "3000000002321", "currency_code": "USD", "currency_symbol": "$", "account_id": "450000000000353", "account_name": "Petty Cash", "tax_account_id": "", "tax_account_name": "", "unused_amount": 0, "last_four_digits": 1111, "custom_fields": [ { "index": 1, "value": 129890, "label": "label", "data_type": "text" } ] } }

List Customer Payments

List all the payments made by your customer

GET /customerpayments

Request Example

  
$ curl https://inventory.zoho.com/api/v1/customerpayments?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "customerpayments": [ { "payment_id": "9030000079467", "payment_number": "2", "invoice_number": "INV-384", "date": "2016-06-05", "payment_mode": "cash", "amount": 450, "bcy_amount": 450, "unused_amount": 0, "account_id": "450000000000353", "account_name": "Petty Cash", "description": "Payment has been added to INV-384", "reference_number": "INV-384", "customer_id": "903000000000099", "customer_name": "Bowman Furniture" }, {...}, {...} ] }

Query Params

customer_name
Optional
Search payments by customer name. Variants: customer_name_startswith and customer_name_contains. Maximum length [100]
reference_number
Optional
Search payments by reference number. Variants: reference_number_startswith and reference_number_contains. Maximum length [100]
date
Optional
Date on which payment is made. Date Format [yyyy-mm-dd]
amount
Optional
Search payments by payment amount. Variants: amount_less_than, amount_less_equals, amount_greater_than and amount_greater_equals
notes
Optional
Search payments by customer notes. Variants: notes_startswith and notes_contains
payment_mode
Optional
Search payments by payment mode. Variants: payment_mode_startswith and payment_mode_contains
filter_by
Optional
Filter payments by mode.Allowed Values: PaymentMode.All, PaymentMode.Check, PaymentMode.Cash, PaymentMode.BankTransfer, PaymentMode.Paypal, PaymentMode.CreditCard, PaymentMode.GoogleCheckout, PaymentMode.Credit, PaymentMode.Authorizenet, PaymentMode.BankRemittance, PaymentMode.Payflowpro, PaymentMode.Stripe, PaymentMode.TwoCheckout, PaymentMode.Braintree,/code> and PaymentMode.Others
sort_column
Optional
Sort based on selected column
search_text
Optional
Search payments by reference number or customer name or payment description. Maximum length [100]

Delete a payment

Delete an existing payment.

DELETE /customerpayments/{payment_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/customerpayments/{payment_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The payment has been deleted." }

Shipment Orders

A document used by an organization to specify what items or packages are to be transferred from a storage location or warehouse to what person and to what new location is called a shipment order. It is typically sent along with a shipment of goods so that the person receiving them(your customer) can verify that the document correctly reflects the items that they actually received.

Example

{ "salesorder_id": 4815000000044895, "salesorder_number": "SO-00003", "shipment_id": 4815000000044917, "shipment_number": "SH-00004", "date": "2017-01-11T00:00:00.000Z", "status": "shipped", "detailed_status": "Reached a courier facility near Toronto.", "status_message": "Shipped", "carrier": "FedEx", "service": "FEDEX_2_DAY", "delivery_days": 2, "delivery_guarantee": true, "reference_number": "TKG424242", "customer_id": 504366000000062000, "customer_name": "Peter James", "contact_persons": {}, "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "discount_amount": 0, "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "estimate_id": 4815000000045091, "delivery_method": "FedEx", "delivery_method_id": 4815000000044822, "tracking_number": "TRK214124124", "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "rate": 122, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "is_invoiced": true } ], "shipping_charge": 7, "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29.28 } ], "price_precision": 2, "is_emailed": true, "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "shipping_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "notes": "notes", "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z" }

Attribute

salesorder_id
long
Unique ID generated by the server for the Sales Order. This is used as identifier.
salesorder_number
string
The Sales Order number. This is unique for each sales order.
shipment_id
long
Unique ID generated by the server for the shipment. This is used as an identifier.
shipment_number
string
Shipment number of the package.
date
string
Date on which package is prepared
status
string
Status of the Shipment Order
detailed_status
string
Detailed shipment details received from the courier
status_message
string
Status message of the shipment.
carrier
string
Carrier used for shipment.
service
string
Type of service selected for shipment
delivery_days
integer
Number of days taken by the courier for delivering in package
delivery_guarantee
boolean
guarantee assured by the courier. For guaranteed on-time deliveries, it is true else it is false
reference_number
string
Tracking number for the Shipment.
customer_id
long
Unique ID generated by the for the customer
customer_name
string
Name of the customer
contact_persons
object
Array of contact person IDs.
currency_id
long
Unique ID generated by the server for the currency. This is used as an identifier.
currency_code
string
Currency code.
currency_symbol
string
The symbol for the selected currency.
exchange_rate
double
Exchange rate of the currency, with respect to the base currency.
discount_amount
double
Discount to be applied on the Sales Order.
discount
double
The percentage of Discount applied.
is_discount_before_tax
boolean
Used to check whether the discount is applied before tax or after tax.
discount_type
string
Type of discount
estimate_id
long
Unique ID generated by the server from the Estimate created in Zoho Books. This is used as an identifier.
delivery_method
string
Delivery method of the shipment.
delivery_method_id
long
Unique ID generated by the server for the delivery method. This is used as an identifier.
tracking_number
string
Tracking number of shipment.
list
List of items in a package. Each line item contains line_item_id,item_id,name,description,item_order,bcy_rate,rate,quantity,unit,tax_id,tax_name,tax_type,tax_percentage,item_total,is_invoiced.
item_id
long
Unique ID generated by the server for the item. This is used as an identifier.
line_item_id
long
Unique ID generated by the server for each line item. This is used as an identifier.
name
string
Name of the line item.
description
string
Description of the line item.
item_order
int
The order of the line items, starts from 0 by default.
bcy_rate
double
Item rate in the organization's base currency.
rate
double
Rate / Selling Price of the line item.
unit
string
Unit of line item.
tax_id
long
Unique ID generated by the server for the tax. This is used as an identifier.
tax_name
string
Name of the tax applied on the line item.
tax_type
string
Denotes the type of the tax. This can either be a single tax or a tax group.
tax_percentage
double
Percentage of the tax.
item_total
double
Total of line item.
is_invoiced
boolean
Checks whether the Sales Order has been invoiced or not.
shipping_charge
double
Shipping charges that are applied to the Shipment.
sub_total
double
Sub total of the Sales Order.
tax_total
double
Tax total of the Sales Order.
total
double
Total amount of the Sales Order.
list
Number of taxes applied on sales order. Each tax contains: tax_name and tax_amount.
tax_name
string
Name of the tax applied on the line item.
tax_amount
double
Amount of the tax.
price_precision
integer
The precision level for the price's decimal point in a Shipment.
is_emailed
boolean
Checks whether the Package has been emailed to the customer or not.
billing_address
list
Customer's billing address. It contains - address, city, state, zip, country and fax.
address
string
Name of the street of the customer’s billing address.
city
string
Name of the city of the customer’s billing address.
state
string
Name of the state of the customer's billing address.
zip
string
Zip code of the customer’s billing address.
country
string
Name of the country of the customer’s billing address.
fax
string
Fax number of the customer’s billing address.
shipping_address
list
Customer's shipping address. It contains - address, city, state, zip, country and fax.
address
string
Name of the street of the customer’s billing address.
city
string
Name of the city of the customer’s billing address.
state
string
Name of the state of the customer's billing address.
zip
string
Zip code of the customer’s billing address.
country
string
Name of the country of the customer’s billing address.
fax
string
Fax number of the customer’s billing address.
template_id
long
Unique ID generated by the server for the Template. This is used as an identifier.
template_name
string
Name of the template used for the Shipment.
template_type
string
Type of the template.
notes
string
Notes for package
created_time
string
Time at which the Shipment Details was created.
last_modified_time
string
Time at which the Shipment Details details were last modified.

Create a Shipment Order

A new shipment order can a be created. To create shipment, URL parameter package_ids and salesorder_id are needed.

POST /shipmentorders?package_ids={package_ids}&salesorder_id={salesorder_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/shipmentorders?package_ids={package_ids}&salesorder_id={salesorder_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "shipment_number": "SH-00004", "date": "2017-01-11T00:00:00.000Z", "reference_number": "TKG424242", "contact_persons": {}, "delivery_method": "FedEx", "tracking_number": "TRK214124124", "shipping_charge": 7, "exchange_rate": 1, "template_id": 4815000000017003, "notes": "notes" }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Shipment created successfully.", "shipment_order": { "salesorder_id": 4815000000044895, "salesorder_number": "SO-00003", "shipment_id": 4815000000044917, "shipment_number": "SH-00004", "date": "2017-01-11T00:00:00.000Z", "status": "shipped", "detailed_status": "Reached a courier facility near Toronto.", "status_message": "Shipped", "carrier": "FedEx", "service": "FEDEX_2_DAY", "delivery_days": 2, "delivery_guarantee": true, "reference_number": "TKG424242", "customer_id": 504366000000062000, "customer_name": "Peter James", "contact_persons": {...}, "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "discount_amount": 0, "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "estimate_id": 4815000000045091, "delivery_method": "FedEx", "delivery_method_id": 4815000000044822, "tracking_number": "TRK214124124", "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "rate": 122, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "is_invoiced": true } ], "shipping_charge": 7, "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29.28 } ], "price_precision": 2, "is_emailed": true, "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "shipping_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "notes": "notes", "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z" } }

ARGUMENTS

shipment_number
Required
Shipment number of the package.
date
Required
Date on which package is prepared
reference_number
Optional
Tracking number for the Shipment.
contact_persons
Optional
Array of contact person IDs.
delivery_method
Required
Delivery method of the shipment.
tracking_number
Required
Tracking number of shipment.
shipping_charge
Optional
Shipping charges that are applied to the Shipment.
exchange_rate
Optional
Exchange rate of the currency, with respect to the base currency.
template_id
Optional
Unique ID generated by the server for the Template. This is used as an identifier.
notes
Optional
Notes for package

Retrieve a Shipment Order

Retrieves details for an existing Shipment Orders.

GET /shipmentorders/{shipmentorder_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/shipmentorders/{shipmentorder_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "shipment_order": { "salesorder_id": 4815000000044895, "salesorder_number": "SO-00003", "shipment_id": 4815000000044917, "shipment_number": "SH-00004", "date": "2017-01-11T00:00:00.000Z", "status": "shipped", "detailed_status": "Reached a courier facility near Toronto.", "status_message": "Shipped", "carrier": "FedEx", "service": "FEDEX_2_DAY", "delivery_days": 2, "delivery_guarantee": true, "reference_number": "TKG424242", "customer_id": 504366000000062000, "customer_name": "Peter James", "contact_persons": {...}, "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "discount_amount": 0, "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "estimate_id": 4815000000045091, "delivery_method": "FedEx", "delivery_method_id": 4815000000044822, "tracking_number": "TRK214124124", "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "rate": 122, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "is_invoiced": true } ], "shipping_charge": 7, "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29.28 } ], "price_precision": 2, "is_emailed": true, "billing_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "shipping_address": [ { "address": "No:234,90 Church Street", "city": "New York City", "state": "New York", "zip": 10048, "country": "U.S.A", "fax": "324-524242" } ], "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "notes": "notes", "created_time": "2015-05-28T23:37:00.110Z", "last_modified_time": "2015-05-28T23:53:31.110Z" } }

Delete a Shipment Order

Deletes an existing Shipment Order.

DELETE /shipmentorders/{shipmentorder_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/shipmentorders/{shipmentorder_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The Shipment Order has been deleted." }

Mark as Delivered

Change the status of the Shipment to delivered.

POST /shipmentorders/{shipmentorder_id}/status/delivered

Request Example

  
$ curl https://inventory.zoho.com/api/v1/shipmentorders/{shipmentorder_id}/status/delivered?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The Shipment Order has been marked as Delivered." }

Packages

Zoho Inventory brings to you, the feature ‘Packages’ with which you can create and assign package slip numbers to the line items in your sales orders and keep track of your packages when they are shipped.

Example

{ "billing_address": { "address": "432, Bayside, Queens", "city": "New York City", "state": "New York", "country": "U.S.A", "zip": 11364, "phone": "+1 (999)999-9999", "fax": "416-765-9871" }, "carrier": "FedEx", "contact_persons": [ { "contact_person_id": 504366000000062000 } ], "created_time": "2017-01-11T16:28:08.053Z", "customer_id": 504366000000062000, "customer_name": "Peter James", "date": "2017-01-11T00:00:00.000Z", "delivery_days": 2, "delivery_guarantee": true, "delivery_method": "LocalCourier", "delivery_method_id": 14954000000086028, "detailed_status": "Reached a courier facility near Toronto", "email": "jamespeter@pete.com", "is_emailed": false, "last_modified_time": "2017-01-11T16:28:08.053Z", "line_items": [ { "description": "Mobile Sales description", "is_invoiced": false, "item_custom_fields": [ { "customfield_id": 504366000000053100, "data_type": "check_box", "index": 1, "is_active": null, "label": "VAT ID", "placeholder": "cf-504366000000053126", "show_in_all_pdf": null, "show_on_pdf": null, "value": "GBGD078" } ], "item_id": 504366000000053200, "item_order": null, "line_item_id": 504366000000062100, "name": "Apple Iphone", "quantity": 2, "so_line_item_id": 504366000000062000, "sku": "SKUM", "unit": "units" } ], "mobile": "+1 (999)999-9999", "notes": "notes", "package_id": 504366000000062100, "package_number": "PA-00001", "phone": "+1 (999)999-9999", "salesorder_id": 504366000000062000, "salesorder_number": "SO-00001", "service": "FEDEX_2_DAY", "shipment_id": 14954000000086344, "shipment_number": "SN-00001", "shipment_order": { "carrier": "FedEx", "delivery_days": 2, "delivery_guarantee": true, "delivery_method": "LocalCourier", "delivery_method_id": 14954000000086028, "detailed_status": "Reached a courier facility near Toronto", "notes": "notes", "service": "FEDEX_2_DAY", "shipment_id": 14954000000086344, "shipment_number": "SN-00001", "shipment_rate": 52, "shipping_date": "2017-01-13T00:00:00.000Z", "status": "shipped", "tracking_number": "794656855217" }, "shipping_address": { "address": "432, Bayside, Queens", "city": "New York City", "state": "New York", "country": "U.S.A", "zip": 11364, "phone": "+1 (999)999-9999", "fax": "416-765-9871" }, "shipping_date": "2017-01-13T00:00:00.000Z", "status": "shipped", "template_id": 14954000000072020, "template_name": "Standard Template", "template_type": "standard", "total_quantity": 1, "tracking_number": "794656855217" }

Attribute

billing_address
object
Customer billing address
address
string
Name of the street of the customer address
city
string
Name of the city of the customer address
state
string
Name of the state of the customer address
country
string
Name of the country of the customer address
zip
string
Zipcode of the customer address
phone
string
Phone number of the customer
fax
string
Fax number of the customer address
carrier
string
Carrier used for shipment of package
contact_persons
list
Array of contact persons for the customers
contact_person_id
long
Unique ID generated by the server for contact person
created_time
date
Time at which the package was created
customer_id
long
Unique ID generated by the for the customer
customer_name
string
Name of the customer
date
string
Date on which package is prepared
delivery_days
integer
Number of days taken by the courier for delivering in package
delivery_guarantee
boolean
guarantee assured by the courier. For guaranteed on-time deliveries, it is true else it is false
delivery_method
string
Custom delivery option created for the manual shipment
delivery_method_id
long
Unique ID generated by the server for delivery method
detailed_status
string
Detailed shipment details received from the courier
email
string
Email of contact person
is_emailed
boolean
Package is emailed to the customer or not
last_modified_time
date
Time at which the package details were last modified.
list
Details of the items in this package
description
string
Description of the item in package
is_invoiced
boolean
Sales order item is invoiced to the customer or not
item_custom_fields
list
Custom field of the item in package
item_id
long
Unique ID generated by the server of the item in package
item_order
line_item_id
long
Unique value generated by the server for an item of sales order in package
name
string
Name of the packaged item
quantity
decimal
Number of quantity of line items in sales order
so_line_item_id
long
Unique ID generated by the server for items in sales order
sku
string
Stock keeping unit of the item in package
unit
string
Unit of the item in package
mobile
string
Mobile number of the customer
notes
string
Notes for package
package_id
long
Unique ID generated by the server for the package
package_number
string
Name of the package
phone
string
Phone number of the customer
salesorder_id
long
Unique ID generated by the server for sales order
salesorder_number
string
Name of the sales order for which package is created
service
string
Type of service selected for shipment
shipment_id
long
Unique ID generated by the server for the shipment
shipment_number
string
shipment number for the package
shipment_order
object
Shipment details of the package
carrier
string
Carrier used for shipment of package
delivery_days
integer
Number of days taken by the courier for delivering in package
delivery_guarantee
boolean
guarantee assured by the courier. For guaranteed on-time deliveries, it is true else it is false
delivery_method
string
Custom delivery option created for the manual shipment
delivery_method_id
long
Unique ID generated by the server for delivery method
detailed_status
string
Detailed shipment details received from the courier
notes
string
Notes for package
service
string
Type of service selected for shipment
shipment_id
long
Unique ID generated by the server for the shipment
shipment_number
string
shipment number for the package
shipment_rate
decimal
Costs involved for shipment
shipping_date
date
Date on which package is shipped
status
string
status of the shipment order
tracking_number
string
Tracking number of the shipment
shipping_address
object
Customer shipping address
address
string
Name of the street of the customer address
city
string
Name of the city of the customer address
state
string
Name of the state of the customer address
country
string
Name of the country of the customer address
zip
string
Zipcode of the customer address
phone
string
Phone number of the customer
fax
string
Fax number of the customer address
shipping_date
date
Date on which package is shipped
status
string
status of the shipment order
template_id
long
Unique ID generated by the server for the template used for package
template_name
string
Name of the template
template_type
string
Type of template
total_quantity
string
Total quantity in the package
tracking_number
string
Tracking number of the shipment

Creating a package

A new package can be created. To create package, URL parameter salesorder_id also needed.

POST /packages

Request Example

  
$ curl https://inventory.zoho.com/api/v1/packages?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "package_number": "PA-00001", "date": "2017-01-11T00:00:00.000Z", "line_items": [ { "so_line_item_id": 504366000000062000, "quantity": 2 } ], "notes": "notes" }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Package created successfully. It's now time to ship!", "package": [ { "billing_address": { "address": "432, Bayside, Queens", "city": "New York City", "state": "New York", "country": "U.S.A", "zip": 11364, "phone": "+1 (999)999-9999", "fax": "416-765-9871" }, "contact_persons": [ { "contact_person_id": 504366000000062000 } ], "created_time": "2017-01-11T16:28:08.053Z", "customer_id": 504366000000062000, "customer_name": "Peter James", "date": "2017-01-11T00:00:00.000Z", "email": "jamespeter@pete.com", "is_emailed": false, "last_modified_time": "2017-01-11T16:28:08.053Z", "line_items": [ { "description": "Mobile Sales description", "is_invoiced": false, "item_custom_fields": [ { "customfield_id": 504366000000053100, "data_type": "check_box", "index": 1, "is_active": null, "label": "VAT ID", "placeholder": "cf-504366000000053126", "show_in_all_pdf": null, "show_on_pdf": null, "value": "GBGD078" } ], "item_id": 504366000000053200, "item_order": null, "line_item_id": 504366000000062100, "name": "Apple Iphone", "quantity": 2, "so_line_item_id": 504366000000062000, "sku": "SKUM", "unit": "units" } ], "mobile": "+1 (999)999-9999", "notes": "notes", "package_id": 504366000000062100, "package_number": "PA-00001", "phone": "+1 (999)999-9999", "salesorder_id": 504366000000062000, "salesorder_number": "SO-00001", "shipment_order": { "carrier": "FedEx", "delivery_days": 2, "delivery_guarantee": true, "delivery_method": "LocalCourier", "delivery_method_id": 14954000000086028, "detailed_status": "Reached a courier facility near Toronto", "notes": "notes", "service": "FEDEX_2_DAY", "shipment_id": 14954000000086344, "shipment_number": "SN-00001", "shipment_rate": 52, "shipping_date": "2017-01-13T00:00:00.000Z", "status": "shipped", "tracking_number": "794656855217" }, "shipping_address": { "address": "432, Bayside, Queens", "city": "New York City", "state": "New York", "country": "U.S.A", "zip": 11364, "phone": "+1 (999)999-9999", "fax": "416-765-9871" }, "template_id": 14954000000072020, "template_name": "Standard Template", "template_type": "standard", "total_quantity": 1 } ] }

ARGUMENTS

package_number
Optional
Name of the package
date
Required
Date on which package is prepared
Required
Details of the items in this package
so_line_item_id
Optional
Unique ID generated by the server for items in sales order
quantity
Optional
Number of quantity of line items in sales order
notes
Optional
Notes for package

Query Params

salesorder_id
Required
Unique ID generated by the server for sales order

Retrieving a package

Retrieving details of existing package

GET /packages/{:package_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/packages/{:package_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "package": [ { "billing_address": { "address": "432, Bayside, Queens", "city": "New York City", "state": "New York", "country": "U.S.A", "zip": 11364, "phone": "+1 (999)999-9999", "fax": "416-765-9871" }, "contact_persons": [ { "contact_person_id": 504366000000062000 } ], "created_time": "2017-01-11T16:28:08.053Z", "customer_id": 504366000000062000, "customer_name": "Peter James", "date": "2017-01-11T00:00:00.000Z", "email": "jamespeter@pete.com", "is_emailed": false, "last_modified_time": "2017-01-11T16:28:08.053Z", "line_items": [ { "description": "Mobile Sales description", "is_invoiced": false, "item_custom_fields": [ { "customfield_id": 504366000000053100, "data_type": "check_box", "index": 1, "is_active": null, "label": "VAT ID", "placeholder": "cf-504366000000053126", "show_in_all_pdf": null, "show_on_pdf": null, "value": "GBGD078" } ], "item_id": 504366000000053200, "item_order": null, "line_item_id": 504366000000062100, "name": "Apple Iphone", "quantity": 2, "so_line_item_id": 504366000000062000, "sku": "SKUM", "unit": "units" } ], "mobile": "+1 (999)999-9999", "notes": "notes", "package_id": 504366000000062100, "package_number": "PA-00001", "phone": "+1 (999)999-9999", "salesorder_id": 504366000000062000, "salesorder_number": "SO-00001", "shipment_order": { "carrier": "FedEx", "delivery_days": 2, "delivery_guarantee": true, "delivery_method": "LocalCourier", "delivery_method_id": 14954000000086028, "detailed_status": "Reached a courier facility near Toronto", "notes": "notes", "service": "FEDEX_2_DAY", "shipment_id": 14954000000086344, "shipment_number": "SN-00001", "shipment_rate": 52, "shipping_date": "2017-01-13T00:00:00.000Z", "status": "shipped", "tracking_number": "794656855217" }, "shipping_address": { "address": "432, Bayside, Queens", "city": "New York City", "state": "New York", "country": "U.S.A", "zip": 11364, "phone": "+1 (999)999-9999", "fax": "416-765-9871" }, "template_id": 14954000000072020, "template_name": "Standard Template", "template_type": "standard", "total_quantity": 1 } ] }

Updating a package

Updating details of existing package

PUT /packages/{:package_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/packages/{:package_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "package_number": "PA-00001", "date": "2017-01-11T00:00:00.000Z", "line_items": [ { "line_item_id": 504366000000062100, "so_line_item_id": 504366000000062000, "quantity": 2 } ], "notes": "notes" }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Package Updated Successfully.", "package": [ { "billing_address": { "address": "432, Bayside, Queens", "city": "New York City", "state": "New York", "country": "U.S.A", "zip": 11364, "phone": "+1 (999)999-9999", "fax": "416-765-9871" }, "contact_persons": [ { "contact_person_id": 504366000000062000 } ], "created_time": "2017-01-11T16:28:08.053Z", "customer_id": 504366000000062000, "customer_name": "Peter James", "date": "2017-01-11T00:00:00.000Z", "email": "jamespeter@pete.com", "is_emailed": false, "last_modified_time": "2017-01-11T16:28:08.053Z", "line_items": [ { "description": "Mobile Sales description", "is_invoiced": false, "item_custom_fields": [ { "customfield_id": 504366000000053100, "data_type": "check_box", "index": 1, "is_active": null, "label": "VAT ID", "placeholder": "cf-504366000000053126", "show_in_all_pdf": null, "show_on_pdf": null, "value": "GBGD078" } ], "item_id": 504366000000053200, "item_order": null, "line_item_id": 504366000000062100, "name": "Apple Iphone", "quantity": 2, "so_line_item_id": 504366000000062000, "sku": "SKUM", "unit": "units" } ], "mobile": "+1 (999)999-9999", "notes": "notes", "package_id": 504366000000062100, "package_number": "PA-00001", "phone": "+1 (999)999-9999", "salesorder_id": 504366000000062000, "salesorder_number": "SO-00001", "shipment_order": { "carrier": "FedEx", "delivery_days": 2, "delivery_guarantee": true, "delivery_method": "LocalCourier", "delivery_method_id": 14954000000086028, "detailed_status": "Reached a courier facility near Toronto", "notes": "notes", "service": "FEDEX_2_DAY", "shipment_id": 14954000000086344, "shipment_number": "SN-00001", "shipment_rate": 52, "shipping_date": "2017-01-13T00:00:00.000Z", "status": "shipped", "tracking_number": "794656855217" }, "shipping_address": { "address": "432, Bayside, Queens", "city": "New York City", "state": "New York", "country": "U.S.A", "zip": 11364, "phone": "+1 (999)999-9999", "fax": "416-765-9871" }, "template_id": 14954000000072020, "template_name": "Standard Template", "template_type": "standard", "total_quantity": 1 } ] }

ARGUMENTS

package_number
Optional
Name of the package
date
Required
Date on which package is prepared
Required
Details of the items in this package
line_item_id
Optional
Unique value generated by the server for an item of sales order in package
so_line_item_id
Optional
Unique ID generated by the server for items in sales order
quantity
Optional
Number of quantity of line items in sales order
notes
Optional
Notes for package

Deleting a package

Deleting an existing package

DELETE /packages/{:package_id}

Request Example

  
$ curl https://inventory.zoho.com/api/v1/packages/{:package_id}?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Whooooosh! Package Deleted Successfully." }

List all packages

GET /packages

Request Example

  
$ curl https://inventory.zoho.com/api/v1/packages?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "package": [ { "billing_address": { "address": "432, Bayside, Queens", "city": "New York City", "state": "New York", "country": "U.S.A", "zip": 11364, "phone": "+1 (999)999-9999", "fax": "416-765-9871" }, "contact_persons": [ { "contact_person_id": 504366000000062000 } ], "created_time": "2017-01-11T16:28:08.053Z", "customer_id": 504366000000062000, "customer_name": "Peter James", "date": "2017-01-11T00:00:00.000Z", "email": "jamespeter@pete.com", "is_emailed": false, "last_modified_time": "2017-01-11T16:28:08.053Z", "line_items": [ { "description": "Mobile Sales description", "is_invoiced": false, "item_custom_fields": [ { "customfield_id": 504366000000053100, "data_type": "check_box", "index": 1, "is_active": null, "label": "VAT ID", "placeholder": "cf-504366000000053126", "show_in_all_pdf": null, "show_on_pdf": null, "value": "GBGD078" } ], "item_id": 504366000000053200, "item_order": null, "line_item_id": 504366000000062100, "name": "Apple Iphone", "quantity": 2, "so_line_item_id": 504366000000062000, "sku": "SKUM", "unit": "units" } ], "mobile": "+1 (999)999-9999", "notes": "notes", "package_id": 504366000000062100, "package_number": "PA-00001", "phone": "+1 (999)999-9999", "salesorder_id": 504366000000062000, "salesorder_number": "SO-00001", "shipment_order": { "carrier": "FedEx", "delivery_days": 2, "delivery_guarantee": true, "delivery_method": "LocalCourier", "delivery_method_id": 14954000000086028, "detailed_status": "Reached a courier facility near Toronto", "notes": "notes", "service": "FEDEX_2_DAY", "shipment_id": 14954000000086344, "shipment_number": "SN-00001", "shipment_rate": 52, "shipping_date": "2017-01-13T00:00:00.000Z", "status": "shipped", "tracking_number": "794656855217" }, "shipping_address": { "address": "432, Bayside, Queens", "city": "New York City", "state": "New York", "country": "U.S.A", "zip": 11364, "phone": "+1 (999)999-9999", "fax": "416-765-9871" }, "template_id": 14954000000072020, "template_name": "Standard Template", "template_type": "standard", "total_quantity": 1 } ] }

Query Params

sort_column
Optional
sorting column. it can have values as tracking_number|salesorder_number|package_number|date|created_time|last_modified_time|customer_name|customer_id|shipment_date|quantity|delivery_method
search_text
Optional
search the packages by text
filter_by
Optional
filter the packages by status. Status can be All|NotShipped|Shipped|Delivered For example: Status.All
packing_number_startswith
Optional
Used for searching package_id which starts with given number in advanced search option
packing_number_contains
Optional
Used for searching package_id which contains given number in advanced search option
salesorder_number_startswith
Optional
Used for searching salesorder_id which starts with given number in advanced search option
salesorder_number_contains
Optional
Used for searching salesorder_id which contains given number in advanced search option
date_start
Optional
Used for searching packages from specified date Use the node as date_after if specified date is not to be considered
date_end
Optional
Used for searching packages till specified date Use the node as date_before if specified date is not to be considered
shipment_date_start
Optional
Used for searching shipments from specified date Use the node as shipment_date_after if specified date is not to be considered
shipment_date_end
Optional
Used for searching shipments till specified date Use the node as shipment_date_before if specified date is not to be considered
customer_name_startswith
Optional
Used for searching salesorder_id which starts with given number in advanced search option
customer_name_contains
Optional
Used for searching salesorder_id which contains given number in advanced search option
delivery_method_startswith
Optional
Used for searching delivery_method which starts with given string in advanced search option
delivery_method_contains
Optional
Used for searching delivery_method which contains given string in advanced search option
status
Optional
status of the shipment order
customer_id
Optional
Unique ID generated by the for the customer

Bulk print packages

GET /packages/print

Request Example

  
$ curl https://inventory.zoho.com/api/v1/packages/print?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success" }

Query Params

package_ids
Required
Export packages as pdf and print them. List of package ids separated by comma

Users

Users are various individuals/entities that are a part of an organisation. Each user will have a different role to play, like admin, staff etc., .

Example

{ "name": "David Sujin", "email": "johndavid@zilliuminc.com" }

Attribute

name
string
name of the user
email
string
email address of the user

Create a user

Create a user for your organization.

POST /users

Request Example

  
$ curl https://inventory.zoho.com/api/v1/users?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "name": "David Sujin", "email": "johndavid@zilliuminc.com", "user_role": "admin" }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Your invitation has been sent." }

ARGUMENTS

name
Required
name of the user
email
Required
email address of the user
user_role
Optional

Update a user

Update the details of a user.

PUT /users/:user_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/users/:user_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "name": "David Sujin", "email": "johndavid@zilliuminc.com", "user_role": "admin" }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The user information has been updated." }

ARGUMENTS

name
Required
name of the user
email
Required
email address of the user
user_role
Optional

List Users

Get the list of all users in the organization.

GET /users

Request Example

  
$ curl https://inventory.zoho.com/api/v1/users?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "users": [ { "user_id": "982000000554041", "role_id": "982000000006005", "name": "David Sujin", "email": "johndavid@zilliuminc.com", "user_role": "admin", "user_type": "zoho", "status": "active", "is_current_user": true, "photo_url": "https://contacts.zoho.com/file?ID=d27344a22bad8bb83a03722b4aa5bc6967c3135f24307fe40db8572782432fd6aae0110f8bb9c4c79e8e0f0cca5904aecfacbf079f13b48c295bacc89ae91fca&fs=thumb" }, {...}, {...} ] }

Query Params

filter_by
Optional
Criteria used to filter
sort_column
Optional
Sort users. Allowed Values: name, email, user_role and status

Get a user

Get the details of a user.

GET /users/:user_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/users/:user_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "user": { "user_id": "982000000554041", "name": "David Sujin", "email_ids": [ { "email": "johndavid@zilliuminc.com", "is_selected": true } ], "status": "active", "user_role": "admin", "user_type": "zoho", "role_id": "982000000006005", "photo_url": "https://contacts.zoho.com/file?ID=d27344a22bad8bb83a03722b4aa5bc6967c3135f24307fe40db8572782432fd6aae0110f8bb9c4c79e8e0f0cca5904aecfacbf079f13b48c295bacc89ae91fca&fs=thumb", "is_claimant": true, "created_time": "2016-06-05T02:30:08-0700", "custom_fields": "" } }

Get current user

Get the details of the current user.

GET /users/me

Request Example

  
$ curl https://inventory.zoho.com/api/v1/users/me?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "user": { "user_id": "982000000554041", "name": "David Sujin", "email_ids": [ { "email": "johndavid@zilliuminc.com", "is_selected": true } ], "status": "active", "user_role": "admin", "user_type": "zoho", "role_id": "982000000006005", "photo_url": "https://contacts.zoho.com/file?ID=d27344a22bad8bb83a03722b4aa5bc6967c3135f24307fe40db8572782432fd6aae0110f8bb9c4c79e8e0f0cca5904aecfacbf079f13b48c295bacc89ae91fca&fs=thumb", "is_claimant": true, "created_time": "2016-06-05T02:30:08-0700", "custom_fields": "" } }

Delete a user

Delete a user associated to the organization.

DELETE /users/:user_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/users/:user_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The user has been removed from your organization." }

Invite a user

Send invitation email to a person, you wish to add as a user to your organisation. For example- an accountant.

POST /users/:user_id/invite

Request Example

  
$ curl https://inventory.zoho.com/api/v1/users/:user_id/invite?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Your invitation has been sent." }

Mark user as active

Mark an inactive user as active.

POST /users/:user_id/active

Request Example

  
$ curl https://inventory.zoho.com/api/v1/users/:user_id/active?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The user has been marked as active." }

Mark user as inactive

Mark an active user as inactive.

POST /users/:user_id/inactive

Request Example

  
$ curl https://inventory.zoho.com/api/v1/users/:user_id/inactive?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The user has been marked as inactive." }

Taxes

Taxes are collected by the government to manage state expenses. A company and an individual must pay multiple taxes and disclose the income details.

Example

{ "tax_id": "982000000566009", "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_group_id": "982000000566009", "tax_group_name": "Sales Group", "tax_group_percentage": 10.5 }

Attribute

tax_id
string
Unique ID of the tax
tax_name
string
Name of the tax to be created.
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_group_id
string
the id of the tax group
tax_group_name
string
Name of the tax group to be created.
tax_group_percentage
double
Number of percentage taxable.

Create a tax

Create a tax which can be associated with an item.

POST /settings/taxes

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/taxes?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_authority_id": "6863420423859038", "country_code": "UK" }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "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": "6863420423859038", "tax_authority_name": "Illinois Department of Revenue", "is_value_added": false } }

ARGUMENTS

tax_name
Optional
Name of the tax to be created.
tax_percentage
Optional
Number of percentage taxable.
tax_type
Optional
Type to determine whether it is a simple or compound tax. Allowed Values: tax and compound_tax
tax_authority_id
US Edition only
Optional
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
UK Edition only
Optional
Two letter country code for the EU country to which the tax belongs.

Update a tax

Update the details of a simple or compound tax.

PUT /settings/taxes/:tax_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/taxes/:tax_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_authority_id": "6863420423859038", "country_code": "UK" }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "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": "6863420423859038", "tax_authority_name": "Illinois Department of Revenue", "is_value_added": false } }

ARGUMENTS

tax_name
Optional
Name of the tax to be created.
tax_percentage
Optional
Number of percentage taxable.
tax_type
Optional
Type to determine whether it is a simple or compound tax. Allowed Values: tax and compound_tax
tax_authority_id
US Edition only
Optional
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
UK Edition only
Optional
Two letter country code for the EU country to which the tax belongs.

List taxes

List of simple and compound taxes with pagination.

GET /settings/taxes

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/taxes?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "taxes": [ { "tax_id": "982000000566009", "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_authority_id": "6863420423859038", "tax_authority_name": "Illinois Department of Revenue", "is_value_added": false, "is_default_tax": true, "is_editable": true }, {...}, {...} ] }

Get a tax

Get the details of a simple or compound tax.

GET /settings/taxes/:tax_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/taxes/:tax_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "success", "tax": { "tax_id": "982000000566009", "tax_name": "Sales Group", "tax_percentage": 10.5, "tax_type": "tax", "tax_authority_id": "6863420423859038", "tax_authority_name": "Illinois Department of Revenue", "is_value_added": false } }

Delete a tax

Delete a simple or compound tax.

DELETE /settings/taxes/:tax_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/taxes/:tax_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The record has been deleted." }

Get a tax group

Get the details of a tax group.

GET /settings/taxgroups/:tax_group_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/taxgroups/:tax_group_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "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" } ] } }

Create a tax group

Create a tax group associating multiple taxes..

POST /settings/taxgroups

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/taxgroups?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "tax_group_name": "Sales Group", "taxes": "VAT" }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "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" } ] } }

ARGUMENTS

tax_group_name
Optional
Name of the tax group to be created.
taxes
Optional
List of tax IDs that are to be associated to the tax group.

Update a tax group

Update the details of the tax group.

PUT /settings/taxgroups/:tax_group_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/taxgroups/:tax_group_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "tax_group_name": "Sales Group", "taxes": "VAT" }'

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "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" } ] } }

ARGUMENTS

tax_group_name
Optional
Name of the tax group to be created.
taxes
Optional
List of tax IDs that are to be associated to the tax group.

Delete a tax group

Delete a tax group. Tax group that is associated to transactions cannot be deleted.

DELETE /settings/taxgroups/:tax_group_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/taxgroups/:tax_group_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The tax group has been deleted." }

Currency

A currency is a generally accepted form of money issued by the government. Each country had its own different currency.

Example

{ "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" }

Attribute

currency_id
string
A unique ID for the currency.
currency_code
string
A unique code for the currency. Maximum length [100]
currency_name
sring
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.
exchange_rate
double
Foreign Exchange rate for the currency.
effective_date
string
Date from when the currency will be in effect.

Create a Currency

Create a currency for transaction.

POST /settings/currencies

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/currencies?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "currency_code": "AUD", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89" }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The currency has been added.", "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 } ] }

ARGUMENTS

currency_code
Required
A unique code for the currency. Maximum length [100]
currency_symbol
Required
A unique symbol for the currency. Maximum length [4]
price_precision
Optional
The precision for the price in decimals
currency_format
Optional
The format for the currency to be displayed. Maximum length [100]

Update a Currency

Update the details of a currency.

PUT /settings/currencies/:currency_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/currencies/:currency_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695 -d JSONString='{ "currency_code": "CAD", "currency_symbol": "$", "price_precision": 2, "currency_format": "1,234,567.89" }'

Response Example

  
HTTP/1.1 201 Created Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "Currency information has been saved.", "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 } ] }

ARGUMENTS

currency_code
Required
Unique code representing a currency
currency_symbol
Required
A unique symbol for the currency. Maximum length [4]
price_precision
Optional
The precision for the price in decimals
currency_format
Optional
The format for the currency to be displayed. Maximum length [100]

List Currency

Get list of currencies configured.

GET /settings/currencies

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/currencies?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "List of all currencies are displayed successfully.", "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" }, {...}, {...} ] }

Query Params

filter_by
Optional
Filter used to get view

Get a Currency

Get the details of a currency.

GET /settings/currencies/:currency_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/currencies/:currency_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "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.

DELETE /settings/currencies/:currency_id

Request Example

  
$ curl https://inventory.zoho.com/api/v1/settings/currencies/:currency_id?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695

Response Example

  
HTTP/1.1 200 OK Content-Type:application/json;charset=UTF-8 { "code": 0, "message": "The currency has been deleted." }