API Docs
/
No Results Found
Customers

Customers

A customer entity allows you to maintain information about a customer.

End Points
Create a customer
List of all customers
Update a customer
Retrieve details of a customer
Delete a customer

Attribute

contact_id
long
Unique ID for the contact. This is used as an identifier.
contact_name
string
Name of the contact.
company_name
string
Registered name of the company the contact represents.
website
string
Website of the contact.
contact_salutation
string
Salutation of the contact person. Possible values are Mr or Mrs or Miss or Ms or Dr
has_transaction
boolean
Whether the Contact has transactions. It can either be trueor false.
contact_type
string
Type of the contact.
source
string
Source of the contact.
is_crm_customer
boolean
Whether the Contact is a CRM customer. It can either be trueor false.
is_linked_with_zohocrm
boolean
Whether the Contact is linked with ZOHO CRM. It can either be trueor false.
primary_contact_id
long
Unique ID for Primary contact.
payment_terms
integer
Payment terms for contact.
payment_terms_label
string
Payment term label.
currency_id
long
Unique ID for currency.
currency_code
string
Base currency of contact.
currency_symbol
string
Symbol of the currency.
price_precision
integer
Precise amount upto n decimal points.
status
string
Status of the contact. It can either be activeor inactive.
vat_reg_no
long
Reg no. of VAT.
vat_treatment
string
VAT treatment.
first_name
string
First name of the contact person.
last_name
string
Last name of the contact person.
email
string
Email address of the contact person.
phone
long
Landline phone number of the contact person.
mobile
long
Mobile number of the contact person.
twitter
string
Twitter handle of the contact person.
facebook
string
Facebook ID of the contact person.
billing_address
object
Contact's billing address object.
Show Sub-Attributes arrow
address_id
long
Unique ID for address.
address
string
Address
city
string
City
state
string
State
zip
string
Zip Code
country
string
Country
fax
string
Fax Number
attention
string
attention
shipping_address
object
Contact’s shipping address object.
Show Sub-Attributes arrow
address_id
long
Unique ID for address.
address
string
Address
city
string
City
state
string
State
zip
string
Zip Code
country
string
Country
fax
string
Fax Number
attention
string
attention
contact_persons
array
List of contact persons for the contact. It contains contact_person_id, salutation, first_name,last_name,email,phone,mobile and is_primary_contact.
Show Sub-Attributes arrow
contact_person_id
long
Unique ID for contact person. This is used as an identifier.
salutation
string
Salutation of the contact person. Possible values are Mr or Mrs or Miss or Ms or Dr
first_name
string
First name of the contact person.
last_name
string
Last name of the contact person.
email
string
Email address of the contact person.
phone
long
Landline phone number of the contact person.
mobile
long
Mobile number of the contact person.
department
string
Department of the contact person.
designation
string
Designation of the contact person.
skype
string
Skype Name / Number of the contact person.
fax
string
Fax Number
can_invite
boolean
Whether the contact person is allowed to invite others. It can either be true or false.
is_primary_contact
boolean
Whether this person is the primary contact person for this contact. It can either be true or false.
notes
string
A short note about the contact.
created_time
string
Time at which the contact details were created.
last_modified_time
string
Time at which the contact details were last updated.

Example

{ "contact_id": "16367000000096001", "contact_name": "Kenny Digital", "company_name": "Kenny Digital", "website": "kennedyr.com", "contact_salutation": "Mr", "has_transaction": false, "contact_type": "customer", "source": "user", "is_crm_customer": false, "is_linked_with_zohocrm": false, "primary_contact_id": "16367000000096003", "payment_terms": 0, "payment_terms_label": "Due on Receipt", "currency_id": "16367000000000097", "currency_code": "USD", "currency_symbol": "$", "price_precision": 2, "status": "active", "vat_reg_no": "", "vat_treatment": "", "first_name": "Ken", "last_name": "Kennedy", "email": "ken.kennedy@gmail.com", "phone": "235456", "mobile": "9566977190", "twitter": "kenkennedy", "facebook": "ken.kennedy", "billing_address": { "address_id": "16367000000096004", "address": "3500, Bayshore, Burlingame", "city": "San Francisco", "state": "CA", "zip": "94010", "country": "USA", "fax": "342-421234", "attention": "" }, "shipping_address": { "address_id": "16367000000096004", "address": "3500, Bayshore, Burlingame", "city": "San Francisco", "state": "CA", "zip": "94010", "country": "USA", "fax": "342-421234", "attention": "" }, "contact_persons": [ { "contact_person_id": "16367000000096003", "salutation": "Mr.", "first_name": "Ken", "last_name": "Kennedy", "email": "ken.kennedy@gmail.com", "phone": "235456", "mobile": "9566977190", "department": "", "designation": "", "skype": "Kenny", "fax": "342-421234", "can_invite": true, "is_primary_contact": true } ], "notes": "note", "created_time": "2017-02-28T10:36:40+0530", "last_modified_time": "2017-02-28T10:36:40+0530" }

Create a customer

Create a new customer.

Arguments

contact_name
string
(Required)
Name of the contact.
company_name
string
Registered name of the company the contact represents.
website
string
Website of the contact.
email
string
Email address of the contact person.
mobile
long
Mobile number of the contact person.
twitter
string
Twitter handle of the contact person.
facebook
string
Facebook ID of the contact person.
phone
long
Landline phone number of the contact person.
billing_address
object
Contact's billing address object.
Show Sub-Attributes arrow
address_id
long
Unique ID for address.
address
string
Address
city
string
City
state
string
State
zip
string
Zip Code
country
string
Country
fax
string
Fax Number
attention
string
attention
shipping_address
object
Contact’s shipping address object.
Show Sub-Attributes arrow
address_id
long
Unique ID for address.
address
string
Address
city
string
City
state
string
State
zip
string
Zip Code
country
string
Country
fax
string
Fax Number
attention
string
attention
contact_persons
array
List of contact persons for the contact. It contains contact_person_id, salutation, first_name,last_name,email,phone,mobile and is_primary_contact.
Show Sub-Attributes arrow
contact_person_id
long
Unique ID for contact person. This is used as an identifier.
salutation
string
Salutation of the contact person. Possible values are Mr or Mrs or Miss or Ms or Dr
first_name
string
First name of the contact person.
last_name
string
Last name of the contact person.
email
string
Email address of the contact person.
phone
long
Landline phone number of the contact person.
mobile
long
Mobile number of the contact person.
department
string
Department of the contact person.
designation
string
Designation of the contact person.
skype
string
Skype Name / Number of the contact person.
fax
string
Fax Number
can_invite
boolean
Whether the contact person is allowed to invite others. It can either be true or false.
is_primary_contact
boolean
Whether this person is the primary contact person for this contact. It can either be true or false.

Request Example

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

Body Parameters

Click to copy
{ "contact_name": "Kenny Digital", "company_name": "Kenny Digital", "website": "kennedyr.com", "email": "ken.kennedy@gmail.com", "mobile": "9566977190", "twitter": "kenkennedy", "facebook": "ken.kennedy", "phone": "235456", "billing_address": { "address_id": "16367000000096004", "address": "3500, Bayshore, Burlingame", "city": "San Francisco", "state": "CA", "zip": "94010", "country": "USA", "fax": "342-421234", "attention": "" }, "shipping_address": { "address_id": "16367000000096004", "address": "3500, Bayshore, Burlingame", "city": "San Francisco", "state": "CA", "zip": "94010", "country": "USA", "fax": "342-421234", "attention": "" }, "contact_persons": [ { "contact_person_id": "16367000000096003", "salutation": "Mr.", "first_name": "Ken", "last_name": "Kennedy", "email": "ken.kennedy@gmail.com", "phone": "235456", "mobile": "9566977190", "department": "", "designation": "", "skype": "Kenny", "fax": "342-421234", "can_invite": true, "is_primary_contact": true } ] }

Response Example

{ "code": 0, "message": "The customer has been created.", "contact": { "contact_id": "16367000000096001", "contact_name": "Kenny Digital", "company_name": "Kenny Digital", "website": "kennedyr.com", "contact_salutation": "Mr", "has_transaction": false, "contact_type": "customer", "source": "user", "is_crm_customer": false, "is_linked_with_zohocrm": false, "primary_contact_id": "16367000000096003", "payment_terms": 0, "payment_terms_label": "Due on Receipt", "currency_id": "16367000000000097", "currency_code": "USD", "currency_symbol": "$", "price_precision": 2, "status": "active", "vat_reg_no": "", "vat_treatment": "", "first_name": "Ken", "last_name": "Kennedy", "email": "ken.kennedy@gmail.com", "phone": "235456", "mobile": "9566977190", "twitter": "kenkennedy", "facebook": "ken.kennedy", "billing_address": { "address_id": "16367000000096004", "address": "3500, Bayshore, Burlingame", "city": "San Francisco", "state": "CA", "zip": "94010", "country": "USA", "fax": "342-421234", "attention": "" }, "shipping_address": { "address_id": "16367000000096004", "address": "3500, Bayshore, Burlingame", "city": "San Francisco", "state": "CA", "zip": "94010", "country": "USA", "fax": "342-421234", "attention": "" }, "contact_persons": [ { "contact_person_id": "16367000000096003", "salutation": "Mr.", "first_name": "Ken", "last_name": "Kennedy", "email": "ken.kennedy@gmail.com", "phone": "235456", "mobile": "9566977190", "department": "", "designation": "", "skype": "Kenny", "fax": "342-421234", "can_invite": true, "is_primary_contact": true } ], "notes": "note", "created_time": "2017-02-28T10:36:40+0530", "last_modified_time": "2017-02-28T10:36:40+0530" } }

List of all customers

List of all customers.

Request Example

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

Response Example

{ "code": 0, "message": "success", "customers": [ { "contact_id": "16367000000096001", "contact_name": "Kenny Digital", "company_name": "Kenny Digital", "contact_type": "customer", "status": "active", "source": "user", "is_linked_with_zohocrm": false, "currency_id": "16367000000000097", "currency_code": "USD", "first_name": "Ken", "last_name": "Kennedy", "email": "ken.kennedy@gmail.com", "phone": "235456", "mobile": "9566977190", "created_time": "2017-02-28T10:36:40+0530", "last_modified_time": "2017-02-28T10:36:40+0530" }, {...}, {...} ] }

Update a customer

Update the details of an existing customer.

Arguments

contact_name
string
Name of the contact.
company_name
string
Registered name of the company the contact represents.
website
string
Website of the contact.
notes
string
A short note about the contact.
email
string
Email address of the contact person.
phone
long
Landline phone number of the contact person.
facebook
string
Facebook ID of the contact person.
mobile
long
Mobile number of the contact person.
billing_address
object
Contact's billing address object.
Show Sub-Attributes arrow
address_id
long
Unique ID for address.
address
string
Address
city
string
City
state
string
State
zip
string
Zip Code
country
string
Country
fax
string
Fax Number
attention
string
attention

Request Example

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

Body Parameters

Click to copy
{ "contact_name": "Kenny Digital", "company_name": "Kenny Digital", "website": "kennedyr.com", "notes": "note", "email": "ken.kennedy@gmail.com", "phone": "235456", "facebook": "ken.kennedy", "mobile": "9566977190", "billing_address": { "address_id": "16367000000096004", "address": "3500, Bayshore, Burlingame", "city": "San Francisco", "state": "CA", "zip": "94010", "country": "USA", "fax": "342-421234", "attention": "" } }

Response Example

{ "code": 0, "message": "Customer information has been saved.", "contact": { "contact_id": "16367000000096001", "contact_name": "Kenny Digital", "company_name": "Kenny Digital", "website": "kennedyr.com", "contact_salutation": "Mr", "has_transaction": false, "contact_type": "customer", "source": "user", "is_crm_customer": false, "is_linked_with_zohocrm": false, "primary_contact_id": "16367000000096003", "payment_terms": 0, "payment_terms_label": "Due on Receipt", "currency_id": "16367000000000097", "currency_code": "USD", "currency_symbol": "$", "price_precision": 2, "status": "active", "vat_reg_no": "", "vat_treatment": "", "first_name": "Ken", "last_name": "Kennedy", "email": "ken.kennedy@gmail.com", "phone": "235456", "mobile": "9566977190", "twitter": "kenkennedy", "facebook": "ken.kennedy", "billing_address": { "address_id": "16367000000096004", "address": "3500, Bayshore, Burlingame", "city": "San Francisco", "state": "CA", "zip": "94010", "country": "USA", "fax": "342-421234", "attention": "" }, "shipping_address": { "address_id": "16367000000096004", "address": "3500, Bayshore, Burlingame", "city": "San Francisco", "state": "CA", "zip": "94010", "country": "USA", "fax": "342-421234", "attention": "" }, "contact_persons": [ { "contact_person_id": "16367000000096003", "salutation": "Mr.", "first_name": "Ken", "last_name": "Kennedy", "email": "ken.kennedy@gmail.com", "phone": "235456", "mobile": "9566977190", "department": "", "designation": "", "skype": "Kenny", "fax": "342-421234", "can_invite": true, "is_primary_contact": true } ], "notes": "note", "created_time": "2017-02-28T10:36:40+0530", "last_modified_time": "2017-02-28T10:36:40+0530" } }

Retrieve details of a customer

Details of an existing customer.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/contacts/{customer_id} -H "X-com-zoho-expense-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "contact": { "contact_id": "16367000000096001", "contact_name": "Kenny Digital", "company_name": "Kenny Digital", "website": "kennedyr.com", "contact_salutation": "Mr", "has_transaction": false, "contact_type": "customer", "source": "user", "is_crm_customer": false, "is_linked_with_zohocrm": false, "primary_contact_id": "16367000000096003", "payment_terms": 0, "payment_terms_label": "Due on Receipt", "currency_id": "16367000000000097", "currency_code": "USD", "currency_symbol": "$", "price_precision": 2, "status": "active", "vat_reg_no": "", "vat_treatment": "", "first_name": "Ken", "last_name": "Kennedy", "email": "ken.kennedy@gmail.com", "phone": "235456", "mobile": "9566977190", "twitter": "kenkennedy", "facebook": "ken.kennedy", "billing_address": { "address_id": "16367000000096004", "address": "3500, Bayshore, Burlingame", "city": "San Francisco", "state": "CA", "zip": "94010", "country": "USA", "fax": "342-421234", "attention": "" }, "shipping_address": { "address_id": "16367000000096004", "address": "3500, Bayshore, Burlingame", "city": "San Francisco", "state": "CA", "zip": "94010", "country": "USA", "fax": "342-421234", "attention": "" }, "contact_persons": [ { "contact_person_id": "16367000000096003", "salutation": "Mr.", "first_name": "Ken", "last_name": "Kennedy", "email": "ken.kennedy@gmail.com", "phone": "235456", "mobile": "9566977190", "department": "", "designation": "", "skype": "Kenny", "fax": "342-421234", "can_invite": true, "is_primary_contact": true } ], "notes": "note", "created_time": "2017-02-28T10:36:40+0530", "last_modified_time": "2017-02-28T10:36:40+0530" } }

Delete a customer

Delete an existing customer.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/contacts/{customer_id} -X DELETE -H "X-com-zoho-expense-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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