The identity and technical contract details declared by the specification.
attention
string
Intended recipient at given address
update-a-contact-request
object
35 properties
1 required
estimate_email_template_id
string
ID of the estimate email template used
commented_by_id
string
Id of the commented by individual
last_name
string
Last name of the contact. Maximum length [100]
transaction_id
string
The ID of the transaction made
outstanding_receivable_amount
integer
Outsatnding amount with the contact, which is due for receipt
location_id
string
Location ID
is_sms_enabled
boolean
Used to check if SMS communication preference is enabled for the contact person.
invoice_template_name
string
Name of the invoice template used
avatax_use_code
string
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…
creditnote_template_name
string
Name of the credit note template used
location_name
string
Name of the location
notes
string
Commennts about the payment made by the contact.
tax_exemption_code
string
Enter tax exemption code
invoice_email_template_name
string
Name of the Invoice email template used
avatax_exempt_no
string
Exemption certificate number of the customer.
tax_name
string
Name of the tax
country_code
string
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 [AvaT…
operation_type
string
The type of operation carried out
email-contact-response
object
2 properties
email-statement-response
object
2 properties
opening_balance_amount
number
Opening balance amount for a contact.
send_from_org_email_id
boolean
Boolean to trigger the email from the organization's email address
contact_name
string
Name of the contact. This can be the name of an organisation or the name of an individual. Maximum length [200]
address
string
Street address of the contact. Maximum length allowed [500]
get-contact-response
object
3 properties
website
string
Website of the contact.
language_code
string
language of a contact. allowed values de,en,es,fr,it,ja,nl,pt,sv,zh
payment_reminder_enabled
boolean
To check if a payment reminder service is enabled for the contact
opening_balances
array
List of opening balances
attachments
string
Files to be attached to the email. It has to be sent in multipart/formdata
is_tds_registered
boolean
Boolean to check if tax is registered.
from_emails
array
Received emails
invoice_template_id
string
ID of the Invoice template used
currency_id
string
Currency ID of the customer's currency.
default_templates
object
12 properties
description
string
A short note on the purpose/reason for the credit note
update-a-contact-response
object
3 properties
currency_code
string
Currency code of the currency in which the customer wants to pay. If currencycode is not specified here, the currency chosen in your Zoho Subscriptions organiz…
is_primary_contact
boolean
To mark contact person as primary for contact. Allowed value is true only.
mobile
string
Search contacts by mobile number of the contact person.
email-contact-request
object
4 properties
3 required
tax_regime
string
Tax Regime of the contact.Allowed Values: generallegalperson , legalentitiesnonprofit , residentabroad , productioncooperativesocieties , agriculturallivestock…
gst_no
string
15 digit GST identification number of the customer/vendor.
billing_address
object
Billing address of the contact.
7 properties
tax_reg_no
string
12 digit Tax Registration number of a contact with Tax treatment as homecountrymexico , borderregionmexico , nonmexico . Consumers generic RFC: XAXX010101000 ,…
tax_authority_id
string
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…
creditnote_template_id
string
ID of teh credit note template used
address_id
string
Address ID of the contact
legal_name
string
Legal Name of the contact.
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person.
body
string
Body/content of the email to be sent. Maximum length [5000]
create-a-contact-response
object
3 properties
to_contacts
array
Recepients of the mail
tax_treatment
string
VAT treatment of the contact.Allowed Values: vatregistered , vatnotregistered , gccvatnotregistered , gccvatregistered , nongcc , dzvatregistered and dzvatnotr…
tax_authority_name
string
Name of the Tax Authority
date_description
string
Specifies the number of days since the comment was made
mark-as-active-response
object
2 properties
delete-a-contact-response
object
2 properties
tax_exemption_id
string
ID of the tax exemption.
time
string
The time of the comment
creditnote_email_template_id
string
ID of the credit note email template
custom_fields
array
Custom fields or Additional of the contact which we can create to add more information.
currency_symbol
string
Symbol of the currency of the contacttype
fax
string
Customer's fax number.
file_name
string
The appropriate name of the file to be attached
contact_type
string
Type of the contact. Allowed values are customer and vendor
state
string
State of the customer's billing address.
is_entity_deleted
boolean
Boolean check to check entity availability
list-contacts-response
object
3 properties
company_name
string
Name of the conact's company. Maximum length [200]
comment_id
string
The ID of the comment
commented_by
string
The name of the individual who entered the comment
primary_contact_id
string
Primary contact ID for a contact. This can be a contact person's ID as well.
has_transaction
boolean
Boolean to check if the customer has a history of transaction
salutation
string
Salutation for the contact
exchange_rate
number
Exchange rate for the opening balance.
user_name
string
The appropriate user name who is sending the email
status
string
The status of the contact.
label
string
Label of the custom field.
tax_percentage
number
Percentage of the tax
communication_preference
object
Preferred modes of communication for the contact person.
2 properties
selected
boolean
Boolean to check for selection
country
string
Country of the customer's billing address.
contact_comments
array
Comments added by a contact
date
string
Date when the credit note was created
payment_terms
integer
Net payment term for the customer.
last_modified_time
string
Time at which the contact was last modified
city
string
City of the customer's billing address.
get-contact-address-response
object
3 properties
estimate_email_template_name
string
Name of the estimate email template used
is_taxable
boolean
Boolean to track the taxability of the customer.
contact_person_id
string
The ID of the contact person
facebook
string
Facebook profile account of the contact. Maximum length [100]
vat_reg_no
string
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 Uni…
get-statement-mail-content-response
object
8 properties
creditnote_email_template_name
string
Name of the credit note email template
created_time
string
Time at which the contact was created.
first_name
string
First name of the contact. Maximum length [100]
place_of_contact
string
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. Th…
estimate_template_name
string
Name of the estimate template used
contact_persons
array
Person/Individual who represents a company
cc_mail_ids
array
Array of email addresses of the recipients to be CC'd.
state_code
string
State code of the customer's billing address.
invoice_email_template_id
string
ID of the invoice email tempalte used
contact-response
object
49 properties
index
integer
Index of the custom field. It can hold any value from 1 to 10.
estimate_template_id
string
ID of the estimate template used
street2
string
Additional Street address of the contact. Maximum length allowed [255]
unused_credits_receivable_amount_bcy
integer
receivable unused credits in base currency
email-statement-request
object
5 properties
3 required
subject
string
Subject of an email that has to be sent. Maximum length to be allowed [1000]
tax_id
boolean
ID of the tax or tax group that can be collected from the contact. Tax can be given only if istaxable is true .
shipping_address
object
Customer's shipping address to which the goods must be delivered.
7 properties
phone
string
Search contacts by phone number of the contact person. Variants: phonestartswith and phonecontains
mark-as-inactive-response
object
2 properties
payment_terms_label
string
Label for the paymet due details.
value
string
Value of the custom field.
zip
string
Zip code of the customer's billing address.
to_mail_ids
array
Array of email addresses of the recipients.
gst_treatment
string
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are businessgst , businessnone , overseas , consumer .
unused_credits_receivable_amount
integer
Our Unused credits with the vendor which is receivable
contact_id
string
Contact ID of the contact
list-comments-response
object
3 properties
twitter
string
Twitter account of the contact. MAximum length [100]
vat_treatment
string
VAT treatment of the contact.Allowed Values: uk (A business that is located in the UK.), euvatregistered (A business that is reg for VAT and trade goods betwee…
transaction_type
string
The type of the trasnaction made
is_linked_with_zohocrm
boolean
To check if the customer account is linked to the crm
outstanding_receivable_amount_bcy
integer
outstanding receivable in base currency
create-a-contact-request
object
35 properties
1 required
email
string
Search contacts by email id of the contact person. Variants: addressstartswith and addresscontains
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Zoho Inventory publishes across the network.
