API Docs
/
No Results Found
Contacts

Attribute

contact_id
string
ID of the contact
contact_name
string
Display Name of the contact. Max-length [200]
company_name
string
Company Name of the contact. Max-length [200]
has_transaction
boolean
unavailable
contact_type
string
Contact type of the contact
customer_sub_type
string
Type of the customer
credit_limit
double
Credit limit for a customer
is_portal_enabled
boolean
To enable client portal for the contact. Allowed value is true and false.
language_code
string
language of a contact. allowed values de,en,es,fr,it,ja,nl,pt,pt_br,sv,zh,en_gb
is_taxable
boolean
🇺🇸 United States
, 🇨🇦 Canada
, 🇦🇺 Australia
, 🇮🇳 India
only
Boolean to track the taxability of the customer.
tax_id
string
🇮🇳 India
, 🇺🇸 United States
only
ID of the tax or tax group that can be collected from the contact. Tax can be given only if is_taxable is true.
tax_name
string
🇮🇳 India
only
Enter tax name
tax_percentage
double
Enter tax percentage.
tax_authority_id
string
🇺🇸 United States
only
ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
tax_exemption_id
string
🇺🇸 United States
, 🇨🇦 Canada
, 🇦🇺 Australia
, 🇮🇳 India
only
ID of the tax exemption.
tax_authority_name
string
Enter tax authority name.
tax_exemption_code
string
🇺🇸 United States
, 🇨🇦 Canada
, 🇦🇺 Australia
, 🇮🇳 India
only
Enter tax exemption code
place_of_contact
string
🇮🇳 India
only
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. This is not applicable for Overseas contacts)
gst_no
string
🇮🇳 India
only
15 digit GST identification number of the customer/vendor.
vat_treatment
string
🇬🇧 United Kingdom
only
VAT treatment of the contact.Allowed Values:
uk (A business that is located in the UK.),
eu_vat_registered (A business that is reg for VAT and trade goods between Northern Ireland and EU. This node is available only for organizations enabled for NI protocal in VAT Settings.) and
overseas (A business that is located outside UK. Pre Brexit, this was split as eu_vat_registered, eu_vat_not_registered and non_eu ).
tax_treatment
string
GCC only
VAT treatment of the contact.Allowed Values: vat_registered,vat_not_registered,gcc_vat_not_registered,gcc_vat_registered,non_gcc,dz_vat_registered and dz_vat_not_registered.
gst_treatment
string
🇮🇳 India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
is_linked_with_zohocrm
boolean
unavailable
website
string
Website of the contact.
owner_id
string
For Customer Only : If a contact is assigned to any particular user, that user can manage transactions for the contact.
primary_contact_id
string
unavailable
payment_terms
integer
Net payment term for the customer.
payment_terms_label
string
Label for the paymet due details.
currency_id
string
Currency ID of the customer's currency.
currency_code
string
Currency code of the currency in which the customer wants to pay. If currency_code is not specified here, the currency chosen in your Zoho Subscriptions organization will be used for billing. currency_id and currency_symbol are set automatically in accordance to the currency_code.
currency_symbol
string
Symbol of the currency of the contact_type
opening_balance_amount
double
Opening balance amount for a contact.
exchange_rate
double
Exchange rate for the opening balance.
outstanding_receivable_amount
integer
defintion unavailable
outstanding_receivable_amount_bcy
integer
defintion unavailable
unused_credits_receivable_amount
integer
defintion unavailable
unused_credits_receivable_amount_bcy
integer
defintion unavailable
status
string
The status of the contact.
payment_reminder_enabled
boolean
defintion unavailable
custom_fields
array
Show Sub-Attributes arrow
index
integer
Index of the custom field. It can hold any value from 1 to 10.
value
string
Value of the custom field.
label
string
Label of the custom field.
billing_address
object
Billing address of the contact.
Show Sub-Attributes arrow
attention
string
address
string
Max-length [500]
street2
string
state_code
string
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.
fax
string
Customer's fax number.
phone
string
Search contacts by phone number of the contact person. Variants: phone_startswith and phone_contains
shipping_address
object
Customer's shipping address object.
Show Sub-Attributes arrow
attention
string
address
string
Max-length [500]
street2
string
state_code
string
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.
fax
string
Customer's fax number.
phone
string
Search contacts by phone number of the contact person. Variants: phone_startswith and phone_contains
facebook
string
Facebook profile account. max-length [100]
twitter
string
Twitter account. max-length [100]
contact_persons
array
Show Sub-Attributes arrow
contact_person_id
string
ID of the contact person
salutation
string
Salutation for the contact
first_name
string
Max-length [100]
last_name
string
Max-length [100]
email
string
Email address of the contact person.
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.
designation
string
Designation for the contact person.
department
string
Department for the contact person.
skype
string
Skype details for the contact person.
is_primary_contact
boolean
To mark contact person as primary for contact. Allowed value is true only.
enable_portal
boolean
To enable client portal for the primary contact. Allowed value is true and false.
default_templates
object
Show Sub-Attributes arrow
invoice_template_id
string
Default invoice template id used for this contact while creating invoice.
estimate_template_id
string
Default estimate template id used for this contact while creating estimate.
creditnote_template_id
string
Default credit note template id used for this contact while creating credit note.
purchaseorder_template_id
string
Default purchase order template id used for this contact while creating purchase order(for Vendors only).
salesorder_template_id
string
Default sales order template id used for this contact while creating sales order.
retainerinvoice_template_id
string
Default retainer invoice template id used for this contact while creating retainer invoice.
paymentthankyou_template_id
string
Default payment thankyou template id used for this contact while sending payment thankyou note.
retainerinvoice_paymentthankyou_template_id
string
Default retainer invoice paymnet thankyou template id used for this contact while sending payment thankyou note for retainer invoice.
invoice_email_template_id
string
Default invoice email template id used for this contact while sending invoices.
estimate_email_template_id
string
Default estimate email template id used for this contact while sending estimates.
creditnote_email_template_id
string
Default credit note email template id used for this contact while sending credit notes.
purchaseorder_email_template_id
string
Default purchase order template id used for this contact while creating purchase order(for Vendors only).
salesorder_email_template_id
string
Default sales order template id used for this contact while creating sales order.
retainerinvoice_email_template_id
string
Default retainer invoice template id used for this contact while creating retainer invoice.
paymentthankyou_email_template_id
string
Default payment thankyou template id used for this contact while sending payment thankyou note.
retainerinvoice_paymentthankyou_email_template_id
string
Default retainer invoice paymnet thankyou template id used for this contact while sending payment thankyou note for retainer invoice.
notes
string
Commennts about the payment made by the contact.
created_time
string
Time at which the contact was created.
last_modified_time
string
Time at which the contact was modified

Example

{ "contact_id": 460000000026049, "contact_name": "Bowman and Co", "company_name": "Bowman and Co", "has_transaction": true, "contact_type": "customer", "customer_sub_type": "business", "credit_limit": 1000, "is_portal_enabled": true, "language_code": "string", "is_taxable": true, "tax_id": 11149000000061058, "tax_name": "CGST", "tax_percentage": 12, "tax_authority_id": 11149000000061052, "tax_exemption_id": 11149000000061054, "tax_authority_name": "string", "tax_exemption_code": "string", "place_of_contact": "TN", "gst_no": "22AAAAA0000A1Z5", "vat_treatment": "string", "tax_treatment": "string", "gst_treatment": "business_gst", "is_linked_with_zohocrm": false, "website": "www.bowmanfurniture.com", "owner_id": 460000000016051, "primary_contact_id": 460000000026051, "payment_terms": 15, "payment_terms_label": "Net 15", "currency_id": 460000000000097, "currency_code": "USD", "currency_symbol": "$", "opening_balance_amount": 1200, "exchange_rate": 1, "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": [ { "index": 1, "value": "GBGD078", "label": "VAT ID" } ], "billing_address": { "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "state_code": "CA", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }, "shipping_address": { "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "state_code": "CA", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }, "facebook": "zoho", "twitter": "zoho", "contact_persons": [ { "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "designation": "Sales Executive", "department": "Sales and Marketing", "skype": "Zoho", "is_primary_contact": true, "enable_portal": true } ], "default_templates": { "invoice_template_id": 460000000052069, "estimate_template_id": 460000000000179, "creditnote_template_id": 460000000000211, "purchaseorder_template_id": 460000000000213, "salesorder_template_id": 460000000000214, "retainerinvoice_template_id": 460000000000215, "paymentthankyou_template_id": 460000000000216, "retainerinvoice_paymentthankyou_template_id": 460000000000217, "invoice_email_template_id": 460000000052071, "estimate_email_template_id": 460000000052073, "creditnote_email_template_id": 460000000052075, "purchaseorder_email_template_id": 460000000000218, "salesorder_email_template_id": 460000000000219, "retainerinvoice_email_template_id": 460000000000220, "paymentthankyou_email_template_id": 460000000000221, "retainerinvoice_paymentthankyou_email_template_id": 460000000000222 }, "notes": "Payment option : Through check", "created_time": "2013-08-05T12:06:10+0530", "last_modified_time": "2013-10-07T18:24:51+0530" }

Create a Contact

Create a contact with given information.
oauthscope : ZohoBooks.contacts.CREATE

Arguments

contact_name
string
(Required)
Display Name of the contact. Max-length [200]
company_name
string
Company Name of the contact. Max-length [200]
website
string
Website of the contact.
language_code
string
language of a contact. allowed values de,en,es,fr,it,ja,nl,pt,pt_br,sv,zh,en_gb
contact_type
string
Contact type of the contact
customer_sub_type
string
Type of the customer
credit_limit
double
Credit limit for a customer
tags
array
Filter all your reports based on the tag
Show Sub-Attributes arrow
tag_id
string
ID of the reporting tag
tag_option_id
string
ID of the reporting tag's option
is_portal_enabled
boolean
To enable client portal for the contact. Allowed value is true and false.
currency_id
string
Currency ID of the customer's currency.
payment_terms
integer
Net payment term for the customer.
payment_terms_label
string
Label for the paymet due details.
notes
string
Commennts about the payment made by the contact.
billing_address
object
Billing address of the contact.
Show Sub-Attributes arrow
attention
string
address
string
Max-length [500]
street2
string
state_code
string
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.
fax
string
Customer's fax number.
phone
string
Search contacts by phone number of the contact person. Variants: phone_startswith and phone_contains
shipping_address
object
Customer's shipping address object.
Show Sub-Attributes arrow
attention
string
address
string
Max-length [500]
street2
string
state_code
string
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.
fax
string
Customer's fax number.
phone
string
Search contacts by phone number of the contact person. Variants: phone_startswith and phone_contains
contact_persons
array
, default is Contact persons of a contact.
Show Sub-Attributes arrow
salutation
string
Salutation for the contact
first_name
string
Max-length [100]
last_name
string
Max-length [100]
email
string
Email address of the contact person.
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.
designation
string
Designation for the contact person.
department
string
Department for the contact person.
skype
string
Skype details for the contact person.
is_primary_contact
boolean
To mark contact person as primary for contact. Allowed value is true only.
enable_portal
boolean
To enable client portal for the primary contact. Allowed value is true and false.
default_templates
object
Show Sub-Attributes arrow
invoice_template_id
string
Default invoice template id used for this contact while creating invoice.
estimate_template_id
string
Default estimate template id used for this contact while creating estimate.
creditnote_template_id
string
Default credit note template id used for this contact while creating credit note.
purchaseorder_template_id
string
Default purchase order template id used for this contact while creating purchase order(for Vendors only).
salesorder_template_id
string
Default sales order template id used for this contact while creating sales order.
retainerinvoice_template_id
string
Default retainer invoice template id used for this contact while creating retainer invoice.
paymentthankyou_template_id
string
Default payment thankyou template id used for this contact while sending payment thankyou note.
retainerinvoice_paymentthankyou_template_id
string
Default retainer invoice paymnet thankyou template id used for this contact while sending payment thankyou note for retainer invoice.
invoice_email_template_id
string
Default invoice email template id used for this contact while sending invoices.
estimate_email_template_id
string
Default estimate email template id used for this contact while sending estimates.
creditnote_email_template_id
string
Default credit note email template id used for this contact while sending credit notes.
purchaseorder_email_template_id
string
Default purchase order template id used for this contact while creating purchase order(for Vendors only).
salesorder_email_template_id
string
Default sales order template id used for this contact while creating sales order.
retainerinvoice_email_template_id
string
Default retainer invoice template id used for this contact while creating retainer invoice.
paymentthankyou_email_template_id
string
Default payment thankyou template id used for this contact while sending payment thankyou note.
retainerinvoice_paymentthankyou_email_template_id
string
Default retainer invoice paymnet thankyou template id used for this contact while sending payment thankyou note for retainer invoice.
custom_fields
array
Custom fields of the contact.
Show Sub-Attributes arrow
index
integer
Index of the custom field. It can hold any value from 1 to 10.
value
string
Value of the custom field.
opening_balance_amount
double
Opening balance amount for a contact.
exchange_rate
double
Exchange rate for the opening balance.
vat_reg_no
string
🇬🇧 United Kingdom
, Avalara Integration only
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 Union (EU) then provide VAT Registration Number of your customers here. This is used to calculate VAT for B2B sales, from Avalara.
owner_id
string
For Customer Only : If a contact is assigned to any particular user, that user can manage transactions for the contact.
tax_reg_no
string
GCC only
15 digit Tax Registration number of a contact with Tax treatment as vat_registered,gcc_vat_registered,dz_vat_registered.
country_code
string
🇬🇧 United Kingdom
, GCC Avalara Integration only
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 [AvaTax Codes for Countries and States][2].
For GCC Editions : Two Letter country code for the GCC Country or the UAE emirate of the contact which will be considered as place of supply.
Supported codes for UAE emirates are :
Abu Dhabi - AB,
Ajman - AJ,
Dubai - DU,
Fujairah - FU,
Ras al-Khaimah - RA,
Sharjah - SH,
Umm al-Quwain - UM.
Supported codes for the GCC countries are :
United Arab Emirates - AE,
Saudi Arabia - SA,
Bahrain - BH,
Kuwait - KW,
Oman - OM,
Qatar - QA.
vat_treatment
string
🇬🇧 United Kingdom
only
VAT treatment of the contact.Allowed Values:
uk (A business that is located in the UK.),
eu_vat_registered (A business that is reg for VAT and trade goods between Northern Ireland and EU. This node is available only for organizations enabled for NI protocal in VAT Settings.) and
overseas (A business that is located outside UK. Pre Brexit, this was split as eu_vat_registered, eu_vat_not_registered and non_eu ).
tax_treatment
string
GCC only
VAT treatment of the contact.Allowed Values: vat_registered,vat_not_registered,gcc_vat_not_registered,gcc_vat_registered,non_gcc,dz_vat_registered and dz_vat_not_registered.
place_of_contact
string
🇮🇳 India
only
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. This is not applicable for Overseas contacts)
gst_no
string
🇮🇳 India
only
15 digit GST identification number of the customer/vendor.
gst_treatment
string
🇮🇳 India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
tax_authority_name
string
Enter tax authority name.
avatax_exempt_no
string
Avalara Integration only
Exemption certificate number of the customer.
avatax_use_code
string
Avalara Integration only
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
string
🇺🇸 United States
, 🇨🇦 Canada
, 🇦🇺 Australia
, 🇮🇳 India
only
ID of the tax exemption.
tax_exemption_code
string
🇺🇸 United States
, 🇨🇦 Canada
, 🇦🇺 Australia
, 🇮🇳 India
only
Enter tax exemption code
tax_authority_id
string
🇺🇸 United States
only
ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
tax_id
string
🇮🇳 India
, 🇺🇸 United States
only
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
boolean
🇺🇸 United States
, 🇨🇦 Canada
, 🇦🇺 Australia
, 🇮🇳 India
only
Boolean to track the taxability of the customer.
facebook
string
Facebook profile account. max-length [100]
twitter
string
Twitter account. max-length [100]
track_1099
boolean
🇺🇸 United States
only
Boolean to track a contact for 1099 reporting.
tax_id_type
string
🇺🇸 United States
only
Tax ID type of the contact, it can be SSN, ATIN, ITIN or EIN.
tax_id_value
string
🇺🇸 United States
only
Tax ID of the contact.

Request Example

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

Body Parameters

Click to copy
{ "contact_name": "Bowman and Co", "company_name": "Bowman and Co", "website": "www.bowmanfurniture.com", "language_code": "string", "contact_type": "customer", "customer_sub_type": "business", "credit_limit": 1000, "tags": [ { "tag_id": 462000000009070, "tag_option_id": 462000000002670 } ], "is_portal_enabled": true, "currency_id": 460000000000097, "payment_terms": 15, "payment_terms_label": "Net 15", "notes": "Payment option : Through check", "billing_address": { "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "state_code": "CA", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }, "shipping_address": { "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "state_code": "CA", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }, "contact_persons": "Contact persons of a contact.", "default_templates": { "invoice_template_id": 460000000052069, "estimate_template_id": 460000000000179, "creditnote_template_id": 460000000000211, "purchaseorder_template_id": 460000000000213, "salesorder_template_id": 460000000000214, "retainerinvoice_template_id": 460000000000215, "paymentthankyou_template_id": 460000000000216, "retainerinvoice_paymentthankyou_template_id": 460000000000217, "invoice_email_template_id": 460000000052071, "estimate_email_template_id": 460000000052073, "creditnote_email_template_id": 460000000052075, "purchaseorder_email_template_id": 460000000000218, "salesorder_email_template_id": 460000000000219, "retainerinvoice_email_template_id": 460000000000220, "paymentthankyou_email_template_id": 460000000000221, "retainerinvoice_paymentthankyou_email_template_id": 460000000000222 }, "custom_fields": [ { "index": 1, "value": "GBGD078" } ], "opening_balance_amount": 1200, "exchange_rate": 1, "vat_reg_no": "string", "owner_id": 460000000016051, "tax_reg_no": 12345678912345, "country_code": "string", "vat_treatment": "string", "tax_treatment": "string", "place_of_contact": "TN", "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "tax_authority_name": "string", "avatax_exempt_no": "string", "avatax_use_code": "string", "tax_exemption_id": 11149000000061054, "tax_exemption_code": "string", "tax_authority_id": 11149000000061052, "tax_id": 11149000000061058, "is_taxable": true, "facebook": "zoho", "twitter": "zoho", "track_1099": true, "tax_id_type": "string", "tax_id_value": "string" }

Response Example

{ "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", "customer_sub_type": "business", "credit_limit": 1000, "is_portal_enabled": true, "language_code": "string", "is_taxable": true, "tax_id": 11149000000061058, "tax_name": "CGST", "tax_percentage": 12, "tax_authority_id": 11149000000061052, "tax_exemption_id": 11149000000061054, "tax_authority_name": "string", "tax_exemption_code": "string", "place_of_contact": "TN", "gst_no": "22AAAAA0000A1Z5", "vat_treatment": "string", "tax_treatment": "string", "gst_treatment": "business_gst", "is_linked_with_zohocrm": false, "website": "www.bowmanfurniture.com", "owner_id": 460000000016051, "primary_contact_id": 460000000026051, "payment_terms": 15, "payment_terms_label": "Net 15", "currency_id": 460000000000097, "currency_code": "USD", "currency_symbol": "$", "opening_balance_amount": 1200, "exchange_rate": 1, "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": [ { "index": 1, "value": "GBGD078", "label": "VAT ID" } ], "billing_address": { "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "state_code": "CA", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }, "shipping_address": { "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "state_code": "CA", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }, "facebook": "zoho", "twitter": "zoho", "contact_persons": [ { "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "designation": "Sales Executive", "department": "Sales and Marketing", "skype": "Zoho", "is_primary_contact": true, "enable_portal": true } ], "default_templates": { "invoice_template_id": 460000000052069, "estimate_template_id": 460000000000179, "creditnote_template_id": 460000000000211, "purchaseorder_template_id": 460000000000213, "salesorder_template_id": 460000000000214, "retainerinvoice_template_id": 460000000000215, "paymentthankyou_template_id": 460000000000216, "retainerinvoice_paymentthankyou_template_id": 460000000000217, "invoice_email_template_id": 460000000052071, "estimate_email_template_id": 460000000052073, "creditnote_email_template_id": 460000000052075, "purchaseorder_email_template_id": 460000000000218, "salesorder_email_template_id": 460000000000219, "retainerinvoice_email_template_id": 460000000000220, "paymentthankyou_email_template_id": 460000000000221, "retainerinvoice_paymentthankyou_email_template_id": 460000000000222 }, "notes": "Payment option : Through check", "created_time": "2013-08-05T12:06:10+0530", "last_modified_time": "2013-10-07T18:24:51+0530" } }

List Contacts

List all contacts with pagination.
oauthscope : ZohoBooks.contacts.READ

Query Parameters

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

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "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" }, {...}, {...} ], "page_context": { "page": 1, "per_page": 200, "has_more_page": false, "applied_filter": "Status.All", "sort_column": "contact_name", "sort_order": "D" } }

Update a Contact

Update an existing contact. To delete a contact person, remove it from the contact_persons list.
oauthscope : ZohoBooks.contacts.UPDATE

Arguments

contact_name
string
(Required)
Display Name of the contact. Max-length [200]
company_name
string
Company Name of the contact. Max-length [200]
payment_terms
integer
Net payment term for the customer.
payment_terms_label
string
Label for the paymet due details.
contact_type
string
Contact type of the contact
customer_sub_type
string
Type of the customer
currency_id
string
Currency ID of the customer's currency.
opening_balance_amount
double
Opening balance amount for a contact.
exchange_rate
double
Exchange rate for the opening balance.
credit_limit
double
Credit limit for a customer
tags
array
Filter all your reports based on the tag
Show Sub-Attributes arrow
tag_id
string
ID of the reporting tag
tag_option_id
string
ID of the reporting tag's option
website
string
Website of the contact.
owner_id
string
For Customer Only : If a contact is assigned to any particular user, that user can manage transactions for the contact.
custom_fields
array
Show Sub-Attributes arrow
index
integer
Index of the custom field. It can hold any value from 1 to 10.
value
string
Value of the custom field.
label
string
Label of the custom field.
billing_address
object
Billing address of the contact.
Show Sub-Attributes arrow
attention
string
address
string
Max-length [500]
street2
string
state_code
string
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.
fax
string
Customer's fax number.
phone
string
Search contacts by phone number of the contact person. Variants: phone_startswith and phone_contains
shipping_address
object
Customer's shipping address object.
Show Sub-Attributes arrow
attention
string
address
string
Max-length [500]
street2
string
state_code
string
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.
fax
string
Customer's fax number.
phone
string
Search contacts by phone number of the contact person. Variants: phone_startswith and phone_contains
contact_persons
array
Show Sub-Attributes arrow
contact_person_id
string
ID of the contact person. For an existing contact person, pass the contact_person_id.
salutation
string
Salutation for the contact
first_name
string
Max-length [100]
last_name
string
Max-length [100]
email
string
Email address of the contact person.
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.
designation
string
Designation for the contact person.
department
string
Department for the contact person.
skype
string
Skype details for the contact person.
is_primary_contact
boolean
To mark contact person as primary for contact. Allowed value is true only.
enable_portal
boolean
To enable client portal for the primary contact. Allowed value is true and false.
default_templates
object
Show Sub-Attributes arrow
invoice_template_id
string
Default invoice template id used for this contact while creating invoice.
estimate_template_id
string
Default estimate template id used for this contact while creating estimate.
creditnote_template_id
string
Default credit note template id used for this contact while creating credit note.
purchaseorder_template_id
string
Default purchase order template id used for this contact while creating purchase order(for Vendors only).
salesorder_template_id
string
Default sales order template id used for this contact while creating sales order.
retainerinvoice_template_id
string
Default retainer invoice template id used for this contact while creating retainer invoice.
paymentthankyou_template_id
string
Default payment thankyou template id used for this contact while sending payment thankyou note.
retainerinvoice_paymentthankyou_template_id
string
Default retainer invoice paymnet thankyou template id used for this contact while sending payment thankyou note for retainer invoice.
invoice_email_template_id
string
Default invoice email template id used for this contact while sending invoices.
estimate_email_template_id
string
Default estimate email template id used for this contact while sending estimates.
creditnote_email_template_id
string
Default credit note email template id used for this contact while sending credit notes.
purchaseorder_email_template_id
string
Default purchase order template id used for this contact while creating purchase order(for Vendors only).
salesorder_email_template_id
string
Default sales order template id used for this contact while creating sales order.
retainerinvoice_email_template_id
string
Default retainer invoice template id used for this contact while creating retainer invoice.
paymentthankyou_email_template_id
string
Default payment thankyou template id used for this contact while sending payment thankyou note.
retainerinvoice_paymentthankyou_email_template_id
string
Default retainer invoice paymnet thankyou template id used for this contact while sending payment thankyou note for retainer invoice.
notes
string
Commennts about the payment made by the contact.
vat_reg_no
string
🇬🇧 United Kingdom
, Avalara Integration only
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 Union (EU) then provide VAT Registration Number of your customers here. This is used to calculate VAT for B2B sales, from Avalara.
tax_reg_no
string
GCC only
15 digit Tax Registration number of a contact with Tax treatment as vat_registered,gcc_vat_registered,dz_vat_registered.
country_code
string
🇬🇧 United Kingdom
, GCC Avalara Integration only
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 [AvaTax Codes for Countries and States][2].
For GCC Editions : Two Letter country code for the GCC Country or the UAE emirate of the contact which will be considered as place of supply.
Supported codes for UAE emirates are :
Abu Dhabi - AB,
Ajman - AJ,
Dubai - DU,
Fujairah - FU,
Ras al-Khaimah - RA,
Sharjah - SH,
Umm al-Quwain - UM.
Supported codes for the GCC countries are :
United Arab Emirates - AE,
Saudi Arabia - SA,
Bahrain - BH,
Kuwait - KW,
Oman - OM,
Qatar - QA.
tax_treatment
string
GCC only
VAT treatment of the contact.Allowed Values: vat_registered,vat_not_registered,gcc_vat_not_registered,gcc_vat_registered,non_gcc,dz_vat_registered and dz_vat_not_registered.
vat_treatment
string
🇬🇧 United Kingdom
only
VAT treatment of the contact.Allowed Values:
uk (A business that is located in the UK.),
eu_vat_registered (A business that is reg for VAT and trade goods between Northern Ireland and EU. This node is available only for organizations enabled for NI protocal in VAT Settings.) and
overseas (A business that is located outside UK. Pre Brexit, this was split as eu_vat_registered, eu_vat_not_registered and non_eu ).
place_of_contact
string
🇮🇳 India
only
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. This is not applicable for Overseas contacts)
gst_no
string
🇮🇳 India
only
15 digit GST identification number of the customer/vendor.
gst_treatment
string
🇮🇳 India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
tax_authority_name
string
Enter tax authority name.
avatax_exempt_no
string
Avalara Integration only
Exemption certificate number of the customer.
avatax_use_code
string
Avalara Integration only
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
string
🇺🇸 United States
, 🇨🇦 Canada
, 🇦🇺 Australia
, 🇮🇳 India
only
ID of the tax exemption.
tax_exemption_code
string
🇺🇸 United States
, 🇨🇦 Canada
, 🇦🇺 Australia
, 🇮🇳 India
only
Enter tax exemption code
tax_authority_id
string
🇺🇸 United States
only
ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
tax_id
string
🇮🇳 India
, 🇺🇸 United States
only
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
boolean
🇺🇸 United States
, 🇨🇦 Canada
, 🇦🇺 Australia
, 🇮🇳 India
only
Boolean to track the taxability of the customer.
facebook
string
Facebook profile account. max-length [100]
twitter
string
Twitter account. max-length [100]
track_1099
boolean
🇺🇸 United States
only
Boolean to track a contact for 1099 reporting.
tax_id_type
string
🇺🇸 United States
only
Tax ID type of the contact, it can be SSN, ATIN, ITIN or EIN.
tax_id_value
string
🇺🇸 United States
only
Tax ID of the contact.

Request Example

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

Body Parameters

Click to copy
{ "contact_name": "Bowman and Co", "company_name": "Bowman and Co", "payment_terms": 15, "payment_terms_label": "Net 15", "contact_type": "customer", "customer_sub_type": "business", "currency_id": 460000000000097, "opening_balance_amount": 1200, "exchange_rate": 1, "credit_limit": 1000, "tags": [ { "tag_id": 462000000009070, "tag_option_id": 462000000002670 } ], "website": "www.bowmanfurniture.com", "owner_id": 460000000016051, "custom_fields": [ { "index": 1, "value": "GBGD078", "label": "VAT ID" } ], "billing_address": { "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "state_code": "CA", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }, "shipping_address": { "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "state_code": "CA", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }, "contact_persons": [ { "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "designation": "Sales Executive", "department": "Sales and Marketing", "skype": "Zoho", "is_primary_contact": true, "enable_portal": true } ], "default_templates": { "invoice_template_id": 460000000052069, "estimate_template_id": 460000000000179, "creditnote_template_id": 460000000000211, "purchaseorder_template_id": 460000000000213, "salesorder_template_id": 460000000000214, "retainerinvoice_template_id": 460000000000215, "paymentthankyou_template_id": 460000000000216, "retainerinvoice_paymentthankyou_template_id": 460000000000217, "invoice_email_template_id": 460000000052071, "estimate_email_template_id": 460000000052073, "creditnote_email_template_id": 460000000052075, "purchaseorder_email_template_id": 460000000000218, "salesorder_email_template_id": 460000000000219, "retainerinvoice_email_template_id": 460000000000220, "paymentthankyou_email_template_id": 460000000000221, "retainerinvoice_paymentthankyou_email_template_id": 460000000000222 }, "notes": "Payment option : Through check", "vat_reg_no": "string", "tax_reg_no": 12345678912345, "country_code": "string", "tax_treatment": "string", "vat_treatment": "string", "place_of_contact": "TN", "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "tax_authority_name": "string", "avatax_exempt_no": "string", "avatax_use_code": "string", "tax_exemption_id": 11149000000061054, "tax_exemption_code": "string", "tax_authority_id": 11149000000061052, "tax_id": 11149000000061058, "is_taxable": true, "facebook": "zoho", "twitter": "zoho", "track_1099": true, "tax_id_type": "string", "tax_id_value": "string" }

Response Example

{ "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", "customer_sub_type": "business", "credit_limit": 1000, "is_taxable": true, "tax_id": 11149000000061058, "tax_name": "CGST", "tax_percentage": 12, "tax_authority_id": 11149000000061052, "tax_exemption_id": 11149000000061054, "tax_authority_name": "string", "tax_exemption_code": "string", "place_of_contact": "TN", "gst_no": "22AAAAA0000A1Z5", "tax_treatment": "string", "vat_treatment": "string", "gst_treatment": "business_gst", "is_linked_with_zohocrm": false, "website": "www.bowmanfurniture.com", "owner_id": 460000000016051, "primary_contact_id": 460000000026051, "payment_terms": 15, "payment_terms_label": "Net 15", "currency_id": 460000000000097, "currency_code": "USD", "currency_symbol": "$", "opening_balance_amount": 1200, "exchange_rate": 1, "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": [ { "index": 1, "value": "GBGD078", "label": "VAT ID" } ], "billing_address": { "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "state_code": "CA", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }, "shipping_address": { "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "state_code": "CA", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }, "facebook": "zoho", "twitter": "zoho", "contact_persons": [ { "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "designation": "Sales Executive", "department": "Sales and Marketing", "skype": "Zoho", "is_primary_contact": true, "enable_portal": true } ], "default_templates": { "invoice_template_id": 460000000052069, "estimate_template_id": 460000000000179, "creditnote_template_id": 460000000000211, "purchaseorder_template_id": 460000000000213, "salesorder_template_id": 460000000000214, "retainerinvoice_template_id": 460000000000215, "paymentthankyou_template_id": 460000000000216, "retainerinvoice_paymentthankyou_template_id": 460000000000217, "invoice_email_template_id": 460000000052071, "estimate_email_template_id": 460000000052073, "creditnote_email_template_id": 460000000052075, "purchaseorder_email_template_id": 460000000000218, "salesorder_email_template_id": 460000000000219, "retainerinvoice_email_template_id": 460000000000220, "paymentthankyou_email_template_id": 460000000000221, "retainerinvoice_paymentthankyou_email_template_id": 460000000000222 }, "notes": "Payment option : Through check", "created_time": "2013-08-05T12:06:10+0530", "last_modified_time": "2013-10-07T18:24:51+0530" } }

Get Contact

Get details of a contact.
oauthscope : ZohoBooks.contacts.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}

Response Example

{ "code": 0, "message": "success", "contact": { "contact_id": 460000000026049, "contact_name": "Bowman and Co", "company_name": "Bowman and Co", "has_transaction": true, "contact_type": "customer", "customer_sub_type": "business", "credit_limit": 1000, "is_taxable": true, "tax_id": 11149000000061058, "tax_name": "CGST", "tax_percentage": 12, "tax_authority_id": 11149000000061052, "tax_exemption_id": 11149000000061054, "tax_authority_name": "string", "tax_exemption_code": "string", "place_of_contact": "TN", "gst_no": "22AAAAA0000A1Z5", "tax_treatment": "string", "vat_treatment": "string", "gst_treatment": "business_gst", "is_linked_with_zohocrm": false, "website": "www.bowmanfurniture.com", "owner_id": 460000000016051, "primary_contact_id": 460000000026051, "payment_terms": 15, "payment_terms_label": "Net 15", "currency_id": 460000000000097, "currency_code": "USD", "currency_symbol": "$", "opening_balance_amount": 1200, "exchange_rate": 1, "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": [ { "index": 1, "value": "GBGD078", "label": "VAT ID" } ], "billing_address": { "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "state_code": "CA", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }, "shipping_address": { "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "state_code": "CA", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }, "contact_persons": [ { "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "designation": "Sales Executive", "department": "Sales and Marketing", "skype": "Zoho", "is_primary_contact": true, "enable_portal": true } ], "default_templates": { "invoice_template_id": 460000000052069, "estimate_template_id": 460000000000179, "creditnote_template_id": 460000000000211, "purchaseorder_template_id": 460000000000213, "salesorder_template_id": 460000000000214, "retainerinvoice_template_id": 460000000000215, "paymentthankyou_template_id": 460000000000216, "retainerinvoice_paymentthankyou_template_id": 460000000000217, "invoice_email_template_id": 460000000052071, "estimate_email_template_id": 460000000052073, "creditnote_email_template_id": 460000000052075, "purchaseorder_email_template_id": 460000000000218, "salesorder_email_template_id": 460000000000219, "retainerinvoice_email_template_id": 460000000000220, "paymentthankyou_email_template_id": 460000000000221, "retainerinvoice_paymentthankyou_email_template_id": 460000000000222 }, "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.
oauthscope : ZohoBooks.contacts.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id} -X DELETE

Response Example

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

Mark as Active

Mark a contact as active.
oauthscope : ZohoBooks.contacts.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/active -X POST

Response Example

{ "code": 0, "message": "The contact has been marked as active." }

Mark as Inactive

Mark a contact as inactive.
oauthscope : ZohoBooks.contacts.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/inactive -X POST

Response Example

{ "code": 0, "message": "The contact has been marked as inactive." }

Enable Portal Access

Enable portal access for a contact.
oauthscope : ZohoBooks.contacts.CREATE

Arguments

contact_persons
array
(Required)
Show Sub-Attributes arrow
contact_person_id
string
ID of the contact person

Request Example

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

Body Parameters

Click to copy
{ "contact_persons": [ { "contact_person_id": 460000000026051 } ] }

Response Example

{ "code": 0, "message": "Client Portal preferences have been updated" }

Enable Payment Reminders

Enable automated payment reminders for a contact.
oauthscope : ZohoBooks.contacts.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/paymentreminder/enable -X POST

Response Example

{ "code": 0, "message": "All reminders associated with this contact have been enabled." }

Disable Payment Reminders

Disable automated payment reminders for a contact.
oauthscope : ZohoBooks.contacts.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/paymentreminder/disable -X POST

Response Example

{ "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.
oauthscope : ZohoBooks.contacts.CREATE

Arguments

send_from_org_email_id
boolean
Boolean to trigger the email from the organization's email address
to_mail_ids
array
(Required)
Array of email address of the recipients.
cc_mail_ids
array
Array of email address of the recipients to be cced.
subject
string
(Required)
Subject of an email has to be sent. Max-length [1000]
body
string
(Required)
Body of an email has to be sent. Max-length [5000]

Query Parameters

start_date
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
End date for the statement. Date format [yyyy-mm-dd]
multipart_or_formdata
Files to be attached along with the statement.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/statements/email -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "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

{ "code": 0, "message": "Statement has been sent to the Customer." }

Get Statement Mail Content

Get the statement mail content.
oauthscope : ZohoBooks.contacts.READ

Query Parameters

start_date
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
End date for the statement. Date format [yyyy-mm-dd]

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/statements/email -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "data": { "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 } }

Email Contact

Send email to contact.
oauthscope : ZohoBooks.contacts.CREATE

Arguments

to_mail_ids
array
(Required)
Array of email address of the recipients.
subject
string
(Required)
Subject of an email has to be sent. Max-length [1000]
body
string
(Required)
Body of an email has to be sent. Max-length [5000]
attachments
binary
Files to be attached to the email. It has to be sent in multipart/formdata

Query Parameters

send_customer_statement
Send customer statement pdf with email.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/email -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "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", "attachments": "string" }

Response Example

{ "code": 0, "message": "Email has been sent." }

List Comments

List recent activities of a contact.
oauthscope : ZohoBooks.contacts.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/comments

Response Example

{ "code": 0, "message": "success", "contact_comments": [ { "comment_id": 460000000053131, "contact_id": 460000000026049, "contact_name": "Bowman and Co", "description": "", "commented_by_id": 460000000024003, "commented_by": "John David", "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" }, {...}, {...} ], "page_context": { "page": 1, "per_page": 200, "has_more_page": false, "applied_filter": "Status.All", "sort_column": "contact_name", "sort_order": "D" } }

Add Additional Address

Add an additional address for a contact using the arguments below.
oauthscope : ZohoBooks.contacts.CREATE

Arguments

attention
string
address
string
Max-length [500]
street2
string
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.
fax
string
Customer's fax number.
phone
string
phone number of the contact person.

Request Example

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

Body Parameters

Click to copy
{ "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }

Response Example

{ "code": 0, "message": "The address has been created.", "address_info": { "address_id": 1053791000000186000, "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" } }

Get Contact Addresses

Get addresses of a contact including its Shipping Address, Billing Address and other additional addresses.
oauthscope : ZohoBooks.contacts.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/address

Response Example

{ "code": 0, "message": "success", "addresses": [ { "address_id": 1053791000000186000, "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }, {...}, {...} ] }

Edit Additional Address

Edit the additional address of a contact using the arguments below.
oauthscope : ZohoBooks.contacts.UPDATE

Arguments

attention
string
address
string
Max-length [500]
street2
string
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.
fax
string
Customer's fax number.
phone
string
phone number of the contact person.

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/address/{address_id} -X PUT -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" }

Response Example

{ "code": 0, "message": "The address has been updated.", "address_info": { "address_id": 1053791000000186000, "attention": "Mr.John", "address": "4900 Hopyard Rd", "street2": "Suite 310", "city": "Pleasanton", "state": "CA", "zip": 94588, "country": "U.S.A", "fax": "+1-925-924-9600", "phone": "+1-925-921-9201" } }

Delete Additional Address

Delete the additional address of a contact.
oauthscope : ZohoBooks.contacts.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/address/{address_id} -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

List Refunds

List the refund history of a contact.
oauthscope : ZohoBooks.contacts.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/refunds

Response Example

{ "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": "gf", "amount_bcy": 57.15, "amount_fcy": 57.15 }, {...}, {...} ], "page_context": { "page": 1, "per_page": 200, "has_more_page": false, "report_name": "Credit Notes Refund", "sort_column": "date", "sort_order": "D" } }

Track 1099

Track a contact for 1099 reporting: (Note: This API is only available when the organization's country is U.S.A).
oauthscope : ZohoBooks.contacts.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/track1099 -X POST

Response Example

{ "code": 0, "message": "1099 tracking is enabled." }

Untrack 1099

Use this API to stop tracking payments to a vendor for 1099 reporting. (Note: This API is only available when the organization's country is U.S.A).
oauthscope : ZohoBooks.contacts.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/untrack1099 -X POST

Response Example

{ "code": 0, "message": "1099 tracking is disabled." }