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