Contacts
A contact is either a customer or vendor. A contact can be an individual or a business in general.
Possible error codes:
Error Code | Message |
---|---|
1002 | Contact does not exist |
3000 | This contact cannot be deleted since you have recorded transactions for it |
3013 | Enter a valid Contact Name |
3062 | The contact already exists.Please specify a different name |
9004 | This currency does not exist. Please choose a valid currency |
31006 | Portal is disabled for your organization. Please contact support@zohoinvoice.com to enable it |
Attribute
Maximum length [200]
Maximum length [200]
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
).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).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
.de,en,es,fr,it,ja,nl,pt,sv,zh
Maximum length allowed [500]
Maximum length allowed [500]
Maximum length [100]
Maximum length [100]
Maximum length [100]
Maximum length [100]
Create a Contact
Create a contact with given information.
OAuth Scope : ZohoInvoice.contacts.CREATE
Arguments
Maximum length [200]
Maximum length [200]
Maximum length allowed [500]
Maximum length allowed [500]
Maximum length [100]
Maximum length [100]
de,en,es,fr,it,ja,nl,pt,sv,zh
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.
home_country_mexico
, border_region_mexico
, non_mexico
.Consumers generic RFC:
XAXX010101000
, Overseas generic RFC: XEXX010101000
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].
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
).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).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
.Maximum length [100]
Maximum length [100]
List Contacts
List all contacts with pagination.
OAuth Scope : ZohoInvoice.contacts.READ
Query Parameters
Maximum length [100]
Variants: contact_name_startswith
and contact_name_contains
. Maximum length [100]Maximum length [100]
Variants: company_name_startswith
and company_name_contains
Maximum length [100]
Variants: first_name_startswith
and first_name_contains
Maximum length [100]
Variants: last_name_startswith
and last_name_contains
Maximum length [100]
Variants: address_startswith
and address_contains
Maximum length [100]
Variants: address_startswith
and address_contains
Maximum length [100]
Variants: phone_startswith
and phone_contains
Status.All, Status.Active, Status.Inactive, Status.Duplicate and Status.Crm
Maximum length [100]
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 : ZohoInvoice.contacts.UPDATE
Arguments
Maximum length [200]
Maximum length [200]
Maximum length allowed [500]
Maximum length allowed [500]
Maximum length [100]
Maximum length [100]
de,en,es,fr,it,ja,nl,pt,sv,zh
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.
home_country_mexico
, border_region_mexico
, non_mexico
.Consumers generic RFC:
XAXX010101000
, Overseas generic RFC: XEXX010101000
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].
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
).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).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
.Maximum length [100]
Maximum length [100]
Get a Contact
Get details of a Contact.
OAuth Scope : ZohoInvoice.contacts.READ
Delete a Contact
Delete an existing Contact.
OAuth Scope : ZohoInvoice.contacts.DELETE
Mark as Active
Mark a contact as active.
OAuth Scope : ZohoInvoice.contacts.CREATE
Mark as Inactive
Mark a contact as inactive.
OAuth Scope : ZohoInvoice.contacts.CREATE
Enable Portal Access
Enable Portal Access for a Contact.
OAuth Scope : ZohoInvoice.contacts.CREATE
Arguments
View All Client Reviews
View the list of all client reviews for a particular contact.
OAuth Scope : ZohoInvoice.contacts.READ
Query Parameters
Details of a Particular Client Review
View the details of a particular client review.
OAuth Scope : ZohoInvoice.contacts.READ
Query Parameters
Reply a Client Review
Send a reply to a client's review.
OAuth Scope : ZohoInvoice.contacts.CREATE
Arguments
Query Parameters
Enable Payment Reminders
Enable automated payment reminders for a contact.
OAuth Scope : ZohoInvoice.contacts.CREATE
Disable Payment Reminders
Disable automated payment reminders for a contact.
OAuth Scope : ZohoInvoice.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 : ZohoInvoice.contacts.CREATE
Arguments
Maximum length to be allowed [1000]
Maximum length [5000]
Query Parameters
Date format [yyyy-mm-dd]
Date format [yyyy-mm-dd]
Get Statement Mail Content
Get the mail content of a contacts billing statement.
OAuth Scope : ZohoInvoice.contacts.READ
Query Parameters
Date format [yyyy-mm-dd]
Date format [yyyy-mm-dd]
Email Contact
Send email to contact.
OAuth Scope : ZohoInvoice.contacts.CREATE
Arguments
Maximum length [1000]
Maximum length [5000]
Query Parameters
List Comments
List recent activities of a contact.
OAuth Scope : ZohoInvoice.contacts.READ
Add Additional Address
Add an additional address for a contact using the arguments below.
OAuth Scope : ZohoInvoice.contacts.CREATE
Arguments
Maximum length allowed [500]
Get Contact Addresses
Get addresses of a contact including its Shipping Address, Billing Address and other additional addresses.
OAuth Scope : ZohoInvoice.contacts.READ
Edit Additional Address
Edit the additional address of a contact using the arguments below.
OAuth Scope : ZohoInvoice.contacts.UPDATE
Arguments
Maximum length allowed [500]
Delete Additional Address
Delete the additional address of a contact.
OAuth Scope : ZohoInvoice.contacts.DELETE
List Refunds
List the refund history of a contact.
OAuth Scope : ZohoInvoice.contacts.READ