API Docs
/
No Results Found
ZOHO CRM Integration

ZOHO CRM Integration

API handling for modules specific to Zoho Invoice - Zoho CRM integration.

End Points
Get a contact by CRM contact id / CRM account ID
Import a customer using the CRM account ID
Import a customer using CRM contact ID
Get the list of Invoices using CRM potential ID
Get the list of Estimates using CRM potential ID

Attribute

contact_id
string
Contact ID of the contact
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]
contact_type
string
Type of the contact. Whether he is a customer or vendor
language_code
string
language of a contact. allowed values de,en,es,fr,it,ja,nl,pt,sv,zh
status
string
The status of the contact.
payment_terms
integer
Net payment term for the customer.
payment_terms_label
string
Label for the paymet due details.
gst_treatment
string
🇮🇳 India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
gst_no
string
🇮🇳 India
only
15 digit GST identification number of the customer/vendor.
is_linked_with_zohocrm
boolean
To check if the customer account is linked to the crm
website
string
Website of the contact.
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.
outstanding_receivable_amount
integer
Outsatnding amount with the contact, which is due for receipt
unused_credits_receivable_amount
integer
Our Unused credits with the vendor which is receivable
first_name
string
First name of the contact. Maximum length [100]
last_name
string
Last name of the contact. Maximum length [100]
email
string
The Email ID of the contact person.
phone
string
Phone number of the contact person.
mobile
string
Mobile number of the contact person.
facebook
string
Facebook profile account of the contact. Maximum length [100]
twitter
string
Twitter account of the contact. Maximum length [100]
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)
created_time
string
Time at which the contact was created.
last_modified_time
string
Time at which the contact was last modified

Example

{ "contact_id": 460000000026049, "contact_name": "Bowman and Co", "company_name": "Bowman and Co", "contact_type": "customer", "language_code": "en", "status": "active", "payment_terms": 15, "payment_terms_label": "Net 15", "gst_treatment": "business_gst", "gst_no": "22AAAAA0000A1Z5", "is_linked_with_zohocrm": false, "website": "www.zylker.org", "currency_id": 460000000000097, "currency_code": "USD", "outstanding_receivable_amount": 250, "unused_credits_receivable_amount": 1369.66, "first_name": "Will", "last_name": "Smith", "email": "test@zylker.org", "phone": "1234", "mobile": "1234", "facebook": "zoho", "twitter": "zoho", "place_of_contact": "TN", "created_time": "2013-10-07T12:06:10+0530", "last_modified_time": "2013-11-08T18:24:51+0530" }

Get a contact by CRM contact id / CRM account ID

Use the argument below to get the details of a Zoho CRM contact using its CRM contact ID / CRM account ID.
oauthscope : ZohoInvoices.contacts.READ

Query Parameters

zcrm_contact_id
CRM Contact ID for the contact.
zcrm_account_id
CRM Account ID for the contact.

Request Example

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

Response Example

{ "code": 0, "message": "success", "contact": { "contact_id": 460000000026049, "contact_name": "Bowman and Co", "company_name": "Bowman and Co", "contact_type": "customer", "language_code": "en", "status": "active", "payment_terms": 15, "payment_terms_label": "Net 15", "gst_treatment": "business_gst", "gst_no": "22AAAAA0000A1Z5", "is_linked_with_zohocrm": false, "website": "www.zylker.org", "currency_id": 460000000000097, "currency_code": "USD", "outstanding_receivable_amount": 250, "unused_credits_receivable_amount": 1369.66, "first_name": "Will", "last_name": "Smith", "email": "test@zylker.org", "phone": "1234", "mobile": "1234", "facebook": "zoho", "twitter": "zoho", "place_of_contact": "TN", "created_time": "2013-10-07T12:06:10+0530", "last_modified_time": "2013-11-08T18:24:51+0530" } }

Import a customer using the CRM account ID

Zoho Invoice must be integrated with Zoho CRM using Accounts and Contacts sync or using Accounts only sync to import a customer from CRM with its CRM account ID.
oauthscope : ZohoInvoices.contacts.CREATE

Request Example

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

Response Example

{ "code": 0, "message": "success", "data": { "contact_id": 460000000026049 } }

Import a customer using CRM contact ID

Zoho Invoice must be integrated with Zoho CRM using Contacts only sync to import a customer from CRM with its CRM contact ID.
oauthscope : ZohoInvoices.contacts.CREATE

Request Example

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

Response Example

{ "code": 0, "message": "success", "data": { "contact_id": 460000000026049 } }

Get the list of Invoices using CRM potential ID

Use the CRM potential ID to get the list of Invoices.
oauthscope : ZohoInvoices.contacts.READ

Query Parameters

zcrm_potential_id
Potential ID of a Deal in CRM.

Request Example

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

Response Example

{ "code": 0, "message": "success", "invoices": [ { "invoice_id": 982000000567114, "ach_payment_initiated": false, "customer_name": "Bowman & Co", "customer_id": 982000000567001, "status": "active", "invoice_number": "INV-00003", "reference_number": " ", "date": "2013-11-17", "due_date": "2013-12-03", "due_days": "Due in 14 day(s)", "currency_id": 460000000000097, "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-10-07T12:06:10+0530", "last_modified_time": "2013-11-08T18:24:51+0530", "is_emailed": false, "reminders_sent": 1, "last_reminder_sent_date": " ", "payment_expected_date": " ", "last_payment_date": " ", "custom_fields": [ { "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "documents": "", "salesperson_id": " ", "salesperson_name": " ", "shipping_charge": 0, "adjustment": 0, "write_off_amount": 0, "exchange_rate": 1 }, {...}, {...} ], "page_context": [ { "page": 1, "per_page": 200, "has_more_page": false, "report_name": "Invoices", "applied_filter": "Status.All", "sort_column": "created_time", "sort_order": "D" } ] }

Get the list of Estimates using CRM potential ID

Use the CRM potential ID to get the list of Estimates.
oauthscope : ZohoInvoices.estimates.READ

Query Parameters

zcrm_potential_id
Potential ID of a Deal in CRM.

Request Example

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

Response Example

{ "code": 0, "message": "success", "estimates": [ { "estimate_id": 982000000567011, "customer_name": "Bowman & Co", "customer_id": 982000000567001, "status": "active", "estimate_number": "EST-00002", "reference_number": " ", "date": "2013-11-17", "currency_id": 460000000000097, "currency_code": "USD", "total": 40.6, "created_time": "2013-10-07T12:06:10+0530", "last_modified_time": "2013-11-08T18:24:51+0530", "accepted_date": " ", "declined_date": " ", "expiry_date": "2013-11-30", "has_attachment": false, "is_viewed_by_client": false, "client_viewed_time": "" }, {...}, {...} ], "page_context": [ { "page": 1, "per_page": 200, "has_more_page": false, "report_name": "Invoices", "applied_filter": "Status.All", "sort_column": "created_time", "sort_order": "D" } ] }