Zoho Inventory contacts API
Contacts Module
Zoho Inventory contacts API is one of 37 APIs that Zoho Inventory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include contacts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 12 operations across 8 paths, and defines 132 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
12 operations
8 paths
132 schemas
1 DELETE5 GET5 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho Inventory contacts API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 12
Across 8 paths, the API surfaces 12 operations — 1 DELETE, 5 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
contacts 12
Contacts Module
POST
/contacts
Create a Contact
GET
/contacts
List contacts
PUT
/contacts/{contact_id}
Update a contact
GET
/contacts/{contact_id}
Get contact
DELETE
/contacts/{contact_id}
Delete a contact
GET
/contacts/{contact_id}/address
Get contact address
POST
/contacts/{contact_id}/active
Mark as active
POST
/contacts/{contact_id}/inactive
Mark as Inactive
POST
/contacts/{contact_id}/statements/email
Email statement
GET
/contacts/{contact_id}/statements/email
Get Statement mail content
POST
/contacts/{contact_id}/email
Email contact
GET
/contacts/{contact_id}/comments
List Comments
Schemas 132
The contract defines 132 schemas that model the data the API accepts and returns. The most detailed are contact-response (49 properties), update-a-contact-request (35 properties), create-a-contact-request (35 properties), default_templates (12 properties). Each schema is shown below with its type and property counts.
estimate_email_template_id
string
ID of the estimate email template used
transaction_id
string
The ID of the transaction made
email-statement-response
object
2 properties
unused_credits_receivable_amount_bcy
integer
receivable unused credits in base currency
outstanding_receivable_amount_bcy
integer
outstanding receivable in base currency
is_primary_contact
boolean
To mark contact person as primary for contact. Allowed value is true only.
zip
string
Zip code of the customer's billing address.
mark-as-active-response
object
2 properties
user_name
string
The appropriate user name who is sending the email
get-contact-address-response
object
3 properties
avatax_exempt_no
string
Exemption certificate number of the customer.
is_sms_enabled
boolean
Used to check if SMS communication preference is enabled for the contact person.
date
string
Date when the credit note was created
custom_fields
array
Custom fields or Additional of the contact which we can create to add more information.
creditnote_template_name
string
Name of the credit note template used
contact_comments
array
Comments added by a contact
list-contacts-response
object
3 properties
value
string
Value of the custom field.
to_mail_ids
array
Array of email addresses of the recipients.
currency_symbol
string
Symbol of the currency of the contacttype
language_code
string
language of a contact. allowed values de,en,es,fr,it,ja,nl,pt,sv,zh
to_contacts
array
Recepients of the mail
list-comments-response
object
3 properties
payment_terms
integer
Net payment term for the customer.
body
string
Body/content of the email to be sent. Maximum length [5000]
tax_regime
string
Tax Regime of the contact.Allowed Values: generallegalperson , legalentitiesnonprofit , residentabroad , productioncooperativesocieties , agriculturallivestock…
update-a-contact-response
object
3 properties
email-contact-response
object
2 properties
mark-as-inactive-response
object
2 properties
email-statement-request
object
5 properties
3 required
attachments
string
Files to be attached to the email. It has to be sent in multipart/formdata
country
string
Country of the customer's billing address.
vat_treatment
string
VAT treatment of the contact.Allowed Values: uk (A business that is located in the UK.), euvatregistered (A business that is reg for VAT and trade goods betwee…
tax_reg_no
string
12 digit Tax Registration number of a contact with Tax treatment as homecountrymexico , borderregionmexico , nonmexico . Consumers generic RFC: XAXX010101000 ,…
cc_mail_ids
array
Array of email addresses of the recipients to be CC'd.
status
string
The status of the contact.
label
string
Label of the custom field.
phone
string
Search contacts by phone number of the contact person. Variants: phonestartswith and phonecontains
payment_terms_label
string
Label for the paymet due details.
transaction_type
string
The type of the trasnaction made
contact_id
string
Contact ID of the contact
attention
string
Intended recipient at given address
contact-response
object
49 properties
billing_address
object
Billing address of the contact.
7 properties
tax_percentage
number
Percentage of the tax
twitter
string
Twitter account of the contact. MAximum length [100]
estimate_email_template_name
string
Name of the estimate email template used
outstanding_receivable_amount
integer
Outsatnding amount with the contact, which is due for receipt
gst_treatment
string
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are businessgst , businessnone , overseas , consumer .
communication_preference
object
Preferred modes of communication for the contact person.
2 properties
delete-a-contact-response
object
2 properties
index
integer
Index of the custom field. It can hold any value from 1 to 10.
time
string
The time of the comment
currency_id
string
Currency ID of the customer's currency.
comment_id
string
The ID of the comment
location_id
string
Location ID
send_from_org_email_id
boolean
Boolean to trigger the email from the organization's email address
create-a-contact-request
object
35 properties
1 required
email-contact-request
object
4 properties
3 required
has_transaction
boolean
Boolean to check if the customer has a history of transaction
operation_type
string
The type of operation carried out
description
string
A short note on the purpose/reason for the credit note
mobile
string
Search contacts by mobile number of the contact person.
invoice_email_template_id
string
ID of the invoice email tempalte used
date_description
string
Specifies the number of days since the comment was made
notes
string
Commennts about the payment made by the contact.
currency_code
string
Currency code of the currency in which the customer wants to pay. If currencycode is not specified here, the currency chosen in your Zoho Subscriptions organiz…
address_id
string
Address ID of the contact
last_modified_time
string
Time at which the contact was last modified
address
string
Street address of the contact. Maximum length allowed [500]
contact_name
string
Name of the contact. This can be the name of an organisation or the name of an individual. Maximum length [200]
create-a-contact-response
object
3 properties
commented_by
string
The name of the individual who entered the comment
shipping_address
object
Customer's shipping address to which the goods must be delivered.
7 properties
vat_reg_no
string
For UK Edition: VAT Registration number of a contact with length should be between 2 and 12 characters. For Avalara: If you are doing sales in the European Uni…
is_entity_deleted
boolean
Boolean check to check entity availability
contact_type
string
Type of the contact. Allowed values are customer and vendor
street2
string
Additional Street address of the contact. Maximum length allowed [255]
email
string
Search contacts by email id of the contact person. Variants: addressstartswith and addresscontains
tax_treatment
string
VAT treatment of the contact.Allowed Values: vatregistered , vatnotregistered , gccvatnotregistered , gccvatregistered , nongcc , dzvatregistered and dzvatnotr…
contact_persons
array
Person/Individual who represents a company
primary_contact_id
string
Primary contact ID for a contact. This can be a contact person's ID as well.
get-contact-response
object
3 properties
is_taxable
boolean
Boolean to track the taxability of the customer.
place_of_contact
string
Location of the contact. (This node identifies the place of supply and source of supply when invoices/bills are raised for the customer/vendor respectively. Th…
unused_credits_receivable_amount
integer
Our Unused credits with the vendor which is receivable
exchange_rate
number
Exchange rate for the opening balance.
opening_balances
array
List of opening balances
estimate_template_name
string
Name of the estimate template used
fax
string
Customer's fax number.
last_name
string
Last name of the contact. Maximum length [100]
created_time
string
Time at which the contact was created.
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person.
company_name
string
Name of the conact's company. Maximum length [200]
creditnote_template_id
string
ID of teh credit note template used
commented_by_id
string
Id of the commented by individual
tax_exemption_code
string
Enter tax exemption code
tax_exemption_id
string
ID of the tax exemption.
subject
string
Subject of an email that has to be sent. Maximum length to be allowed [1000]
country_code
string
For UK Edition: Two letter country code of a contact. For Avalara: Two letter country code for the customer country, if your customer is not in US. Refer [AvaT…
default_templates
object
12 properties
from_emails
array
Received emails
first_name
string
First name of the contact. Maximum length [100]
file_name
string
The appropriate name of the file to be attached
tax_id
boolean
ID of the tax or tax group that can be collected from the contact. Tax can be given only if istaxable is true .
invoice_template_name
string
Name of the invoice template used
is_linked_with_zohocrm
boolean
To check if the customer account is linked to the crm
payment_reminder_enabled
boolean
To check if a payment reminder service is enabled for the contact
location_name
string
Name of the location
estimate_template_id
string
ID of the estimate template used
invoice_template_id
string
ID of the Invoice template used
facebook
string
Facebook profile account of the contact. Maximum length [100]
salutation
string
Salutation for the contact
city
string
City of the customer's billing address.
is_tds_registered
boolean
Boolean to check if tax is registered.
invoice_email_template_name
string
Name of the Invoice email template used
get-statement-mail-content-response
object
8 properties
creditnote_email_template_id
string
ID of the credit note email template
selected
boolean
Boolean to check for selection
opening_balance_amount
number
Opening balance amount for a contact.
avatax_use_code
string
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…
creditnote_email_template_name
string
Name of the credit note email template
tax_authority_name
string
Name of the Tax Authority
legal_name
string
Legal Name of the contact.
state
string
State of the customer's billing address.
tax_authority_id
string
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…
state_code
string
State code of the customer's billing address.
gst_no
string
15 digit GST identification number of the customer/vendor.
contact_person_id
string
The ID of the contact person
tax_name
string
Name of the tax
website
string
Website of the contact.
update-a-contact-request
object
35 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zoho Inventory 12
Other APIs Zoho Inventory publishes across the network.
Zoho Inventory batches API
Zoho Inventory bills API
Zoho Inventory compositeitems API
Zoho Inventory contact-persons API
Zoho Inventory credit-notes API
Zoho Inventory currency API
Zoho Inventory customer-payments API
Zoho Inventory delivery-challans API
Zoho Inventory inventoryadjustments API
Zoho Inventory invoices API
Zoho Inventory itemgroups API
Zoho Inventory items API
#contacts