Contacts
The list of contacts created.
Attribute
true
and false
.de,en,es,fr,it,ja,nl,pt,pt_br,sv,zh,en_gb
is_taxable
is true
.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.) andoverseas
(A business that is located outside UK. Pre Brexit, this was split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).Allowed Values:
vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
,dz_vat_registered
and dz_vat_not_registered
home_country_mexico
(A business that is located within MX)border_region_mexico
(A business that is located in the northern and southern border regions in MX)non_mexico
(A business that is located outside MX).For Kenya Edition:
vat_registered
,vat_not_registered
,non_kenya
(A business that is located outside Kenya).For SouthAfrica Edition:
vat_registered
, vat_not_registered
, overseas
(A business that is located outside SouthAfrica).general_legal_person
, legal_entities_non_profit
, resident_abroad
, production_cooperative_societies
, agricultural_livestock
, optional_group_of_companies
, coordinated
, simplified_trust
, wages_salaries_income
, lease
, property_disposal_acquisition
, other_income
, resident_abroad
, divident_income
, individual_business_professional
, interest_income
, income_obtaining_price
, no_tax_obligation
, tax_incorporation
, income_through_technology_platform
, simplified_trust
. business_gst
, business_none
, overseas
, consumer
.phone_startswith
and phone_contains
phone_startswith
and phone_contains
phone_startswith
and phone_contains
true
only.true
and false
.Create a Contact
Create a contact with given information.
OAuth Scope : ZohoBooks.contacts.CREATE
Arguments
de,en,es,fr,it,ja,nl,pt,pt_br,sv,zh,en_gb
true
and false
.phone_startswith
and phone_contains
phone_startswith
and phone_contains
phone_startswith
and phone_contains
true
only.true
and false
.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.
vat_registered
,gcc_vat_registered
,dz_vat_registered
.For Mexico Edition: 12 digit Tax Registration number of a contact with Tax treatment as
home_country_mexico
, border_region_mexico
, non_mexico
.Consumers generic RFC:
XAXX010101000
, Overseas generic RFC: XEXX010101000
.For Kenya Edition: 11 digit Tax Registration number of a contact with Tax treatment as
vat_registered
For SouthAfrica Edition: 10 digit Tax Registration number of a contact with Tax treatment as
vat_registered
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
.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.) andoverseas
(A business that is located outside UK. Pre Brexit, this was split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).Allowed Values:
vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
,dz_vat_registered
and dz_vat_not_registered
home_country_mexico
(A business that is located within MX)border_region_mexico
(A business that is located in the northern and southern border regions in MX)non_mexico
(A business that is located outside MX).For Kenya Edition:
vat_registered
,vat_not_registered
,non_kenya
(A business that is located outside Kenya).For SouthAfrica Edition:
vat_registered
, vat_not_registered
, overseas
(A business that is located outside SouthAfrica).general_legal_person
, legal_entities_non_profit
, resident_abroad
, production_cooperative_societies
, agricultural_livestock
, optional_group_of_companies
, coordinated
, simplified_trust
, wages_salaries_income
, lease
, property_disposal_acquisition
, other_income
, resident_abroad
, divident_income
, individual_business_professional
, interest_income
, income_obtaining_price
, no_tax_obligation
, tax_incorporation
, income_through_technology_platform
, simplified_trust
. business_gst
, business_none
, overseas
, consumer
.is_taxable
is true
.Update a contact using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a contact by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header. Based on this value, the corresponding contact will be retrieved and updated. Additionally, there is an optional X-Upsert header. If the X-Upsert header is true and the custom field's unique value is not found in any of the existing contacts, a new contact will be created if the necessary payload details are available
OAuth Scope : ZohoBooks.contacts.UPDATE
Arguments
phone_startswith
and phone_contains
phone_startswith
and phone_contains
contact_person_id
.phone_startswith
and phone_contains
true
only.true
and false
.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.
vat_registered
,gcc_vat_registered
,dz_vat_registered
.For Mexico Edition: 12 digit Tax Registration number of a contact with Tax treatment as
home_country_mexico
, border_region_mexico
, non_mexico
.Consumers generic RFC:
XAXX010101000
, Overseas generic RFC: XEXX010101000
.For Kenya Edition: 11 digit Tax Registration number of a contact with Tax treatment as
vat_registered
For SouthAfrica Edition: 10 digit Tax Registration number of a contact with Tax treatment as
vat_registered
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
.Allowed Values:
vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
,dz_vat_registered
and dz_vat_not_registered
home_country_mexico
(A business that is located within MX)border_region_mexico
(A business that is located in the northern and southern border regions in MX)non_mexico
(A business that is located outside MX).For Kenya Edition:
vat_registered
,vat_not_registered
,non_kenya
(A business that is located outside Kenya).For SouthAfrica Edition:
vat_registered
, vat_not_registered
, overseas
(A business that is located outside SouthAfrica).general_legal_person
, legal_entities_non_profit
, resident_abroad
, production_cooperative_societies
, agricultural_livestock
, optional_group_of_companies
, coordinated
, simplified_trust
, wages_salaries_income
, lease
, property_disposal_acquisition
, other_income
, resident_abroad
, divident_income
, individual_business_professional
, interest_income
, income_obtaining_price
, no_tax_obligation
, tax_incorporation
, income_through_technology_platform
, simplified_trust
.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.) andoverseas
(A business that is located outside UK. Pre Brexit, this was split as eu_vat_registered
, eu_vat_not_registered
and non_eu
). business_gst
, business_none
, overseas
, consumer
.is_taxable
is true
.List Contacts
List all contacts with pagination.
OAuth Scope : ZohoBooks.contacts.READ
Query Parameters
contact_name_startswith
and contact_name_contains
. Max-length [100]company_name_startswith
and company_name_contains
first_name_startswith
and first_name_contains
last_name_startswith
and last_name_contains
address_startswith
and address_contains
email_startswith
and email_contains
phone_startswith
and phone_contains
Status.All, Status.Active, Status.Inactive, Status.Duplicate and Status.Crm
contact_name, first_name, last_name, email, outstanding_receivable_amount, created_time and last_modified_time
Update a Contact
Update an existing contact. To delete a contact person, remove it from the contact_persons list.
OAuth Scope : ZohoBooks.contacts.UPDATE
Arguments
phone_startswith
and phone_contains
phone_startswith
and phone_contains
contact_person_id
.phone_startswith
and phone_contains
true
only.true
and false
.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.
vat_registered
,gcc_vat_registered
,dz_vat_registered
.For Mexico Edition: 12 digit Tax Registration number of a contact with Tax treatment as
home_country_mexico
, border_region_mexico
, non_mexico
.Consumers generic RFC:
XAXX010101000
, Overseas generic RFC: XEXX010101000
.For Kenya Edition: 11 digit Tax Registration number of a contact with Tax treatment as
vat_registered
For SouthAfrica Edition: 10 digit Tax Registration number of a contact with Tax treatment as
vat_registered
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
.Allowed Values:
vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
,dz_vat_registered
and dz_vat_not_registered
home_country_mexico
(A business that is located within MX)border_region_mexico
(A business that is located in the northern and southern border regions in MX)non_mexico
(A business that is located outside MX).For Kenya Edition:
vat_registered
,vat_not_registered
,non_kenya
(A business that is located outside Kenya).For SouthAfrica Edition:
vat_registered
, vat_not_registered
, overseas
(A business that is located outside SouthAfrica).general_legal_person
, legal_entities_non_profit
, resident_abroad
, production_cooperative_societies
, agricultural_livestock
, optional_group_of_companies
, coordinated
, simplified_trust
, wages_salaries_income
, lease
, property_disposal_acquisition
, other_income
, resident_abroad
, divident_income
, individual_business_professional
, interest_income
, income_obtaining_price
, no_tax_obligation
, tax_incorporation
, income_through_technology_platform
, simplified_trust
.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.) andoverseas
(A business that is located outside UK. Pre Brexit, this was split as eu_vat_registered
, eu_vat_not_registered
and non_eu
). business_gst
, business_none
, overseas
, consumer
.is_taxable
is true
.Get Contact
Get details of a contact.
OAuth Scope : ZohoBooks.contacts.READ
Delete a Contact
Delete an existing contact.
OAuth Scope : ZohoBooks.contacts.DELETE
Mark as Active
Mark a contact as active.
OAuth Scope : ZohoBooks.contacts.CREATE
Mark as Inactive
Mark a contact as inactive.
OAuth Scope : ZohoBooks.contacts.CREATE
Enable Portal Access
Enable portal access for a contact.
OAuth Scope : ZohoBooks.contacts.CREATE
Arguments
Enable Payment Reminders
Enable automated payment reminders for a contact.
OAuth Scope : ZohoBooks.contacts.CREATE
Disable Payment Reminders
Disable automated payment reminders for a contact.
OAuth Scope : ZohoBooks.contacts.CREATE
Email Statement
Email statement to the contact. If JSONString is not inputted, mail will be sent with the default mail content.
OAuth Scope : ZohoBooks.contacts.CREATE
Arguments
Query Parameters
Get Statement Mail Content
Get the statement mail content.
OAuth Scope : ZohoBooks.contacts.READ
Query Parameters
Email Contact
Send email to contact.
OAuth Scope : ZohoBooks.contacts.CREATE
Arguments
Query Parameters
List Comments
List recent activities of a contact.
OAuth Scope : ZohoBooks.contacts.READ
Add Additional Address
Add an additional address for a contact using the arguments below.
OAuth Scope : ZohoBooks.contacts.CREATE
Arguments
Get Contact Addresses
Get addresses of a contact including its Shipping Address, Billing Address and other additional addresses.
OAuth Scope : ZohoBooks.contacts.READ
Edit Additional Address
Edit the additional address of a contact using the arguments below.
OAuth Scope : ZohoBooks.contacts.UPDATE
Arguments
Delete Additional Address
Delete the additional address of a contact.
OAuth Scope : ZohoBooks.contacts.DELETE
List Refunds
List the refund history of a contact.
OAuth Scope : ZohoBooks.contacts.READ
Track 1099
Track a contact for 1099 reporting: (Note: This API is only available when the organization's country is U.S.A).
OAuth Scope : ZohoBooks.contacts.CREATE
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).
OAuth Scope : ZohoBooks.contacts.CREATE