Contacts

Retrives list of all contacts

Table Specific Information

Select

The cmdlet will use the Zoho Inventory API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the cmdlet.

Id supports the '=' comparison.
ContactName supports the '=' comparison.
CompanyName supports the '=' comparison.
FirstName supports the '=' comparison.
LastName supports the '=' comparison.
Address supports the '=' comparison.
Email supports the '=' comparison.
Phone supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Contacts WHERE Id = '3350895000000089001'

SELECT * FROM Contacts WHERE ContactName = 'Mr. FIrst Last'

SELECT * FROM Contacts WHERE CompanyName = 'name'

SELECT * FROM Contacts WHERE FirstName = 'firstname'

SELECT * FROM Contacts WHERE LastName = 'lastname' 

SELECT * FROM Contacts Address = 'Street and City'

SELECT * FROM Contacts WHERE Email = '[email protected]'

SELECT * FROM Contacts WHERE Phone = '873545636272'

Insert

Insert can be executed by specifying the ContactName column. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.

INSERT INTO Contacts (ContactName) VALUES ('test4')

Update

Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE Contacts SET ContactName = 'Name Change' WHERE Id = '3350895000000089005'

Delete

Delete can be executed by specifying the Id in the WHERE Clause For example:

DELETE FROM Contacts WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Contact ID of the contact.
ContactName	String	False		Name of the contact. This can be the name of an organisation or the name of an individual. Maximum length [200].
BillingAddressAddress	String	False		Billing address of the contact..
Status	String	False		The status of the contact..
BillingAddressAttention	String	False		Intended recipient at given address.
BillingAddressCity	String	False		City of the customers billing address..
BillingAddressCountry	String	False		Country of the customers billing address..
BillingAddressState	String	False		State of the customers billing address..
BillingAddressStreet2	String	False		Additional Street address of the contact..
BillingAddressZip	Integer	False		Zip code of the customers billing address.
CompanyName	String	False		Name of the conact company. Maximum length [200].
ContactPersons	String	True		ContactPersons.
ContactType	String	False		ContactType.
CreatedTime	Datetime	True		CreatedTime.
CurrencyCode	String	True		Currency code of the currency in which the customer wants to pay..
CurrencyId	Long	False		Currency ID of the customer currency..
CurrencySymbol	String	True		Symbol of the currency of the contact_type.
CustomFields	String	False		Custom fields or Additional of the contact which we can create to add more information.
DefaultTemplatesCreditnoteEmailTemplateId	Long	False		ID of the credit note email template.
DefaultTemplatesCreditnoteEmailTemplateName	String	False		Name of the credit note email template.
DefaultTemplatesCreditnoteTemplateId	Long	False		ID of teh credit note template used.
DefaultTemplatesCreditNoteTemplateName	String	False		Name of the credit note template used.
DefaultTemplatesEstimateEmailTemplateId	Long	False		ID of the estimate email template used.
DefaultTemplatesEstimateEmailTemplateName	String	False		Name of the estimate email template used.
DefaultTemplatesEstimateTemplateId	Long	False		ID of the estimate template used.
DefaultTemplatesEstimateTemplateName	String	False		Name of the estimate template used.
DefaultTemplatesInvoiceEmailTemplateId	Long	False		ID of the invoice email tempalte used.
DefaultTemplatesInvoiceEmailTemplateName	String	False		Name of the Invoice email template used.
DefaultTemplatesInvoiceTemplateId	Long	False		ID of the Invoice template used.
DefaultTemplatesInvoiceTemplateName	String	False		Name of the invoice template used.
Facebook	String	False		Facebook profile account of the contact. Maximum length [100].
GstNo	String	False		15 digit GST identification number of the customer/vendor..
LanguageCode	String	False		language of a contact
GstTreatment	String	False		Choose whether the contact is GST registered/unregistered/consumer/overseas.
HasTransaction	Boolean	True		Boolean to check if the customer has a history of transaction.
IsLinkedWithZohocrm	Boolean	True		To check if the customer account is linked to the crm.
IsTaxable	Boolean	False		Boolean to track the taxability of the customer..
LastModifiedTime	Datetime	True		Time at which the contact was last modified.
Notes	String	False		Commennts about the payment made by the contact..
OutstandingReceivableAmount	Integer	True		outstanding_receivable_amount.
OutstandingReceivableAmountbcy	Integer	True		outstanding receivable in base currency.
PaymentReminderEnabled	Boolean	True		To check if a payment reminder service is enabled for the contact.
PaymentTerms	Integer	False		Net payment term for the customer.
PaymentTermsLabel	String	True		Label for the paymet due details.
PlaceOfContact	String	False		Location of the contact..
PrimaryContactId	Long	True		Primary contact ID for a contact. This can be a contact person ID as well..
ShippingAddressAddress	String	False		Customers shipping address to which the goods must be delivered..
ShippingAddressAttention	String	False		Intended recipient at given address.
ShippingAddressCity	String	False		City of the customers shipping address.
ShippingAddressCountry	String	False		Country of the customers shipping address.
ShippingAddressState	String	False		State of the customers shipping address.
ShippingAddressStreet2	String	False		Additional Street address of the contact.
ShippingAddressZip	Integer	False		Zip code of the customers shipping address.
TaxAuthorityId	Long	False		ID of the tax authority..
TaxAuthorityName	String	False		Name of the Tax Authority.
TaxExemptionCode	String	False		Enter tax exemption code.
TaxExemptionId	Long	False		ID of the tax exemption..
TaxId	Long	False		ID of the tax or tax group that can be collected from the contact.
TaxName	String	True		Name of the tax.
TaxPercentage	Integer	True		Percentage of the tax.
Twitter	String	False		Twitter account of the contact..
UnusedCreditsReceivableAmount	Double	True		Our Unused credits with the vendor which is receivable.
UnusedCreditsReceivableAmountBcy	Double	True		receivable unused credits in base currency.
VatTreatment	String	True		VAT treatment of the contact.
Website	String	False		Website of the contact..
FirstName	String	True		First name of the contact.
LastName	String	True		Last name of the contact.
Address	String	True		Street address of the contact.
Email	String	True		Search contacts by email id of the contact person.
Phone	String	True		Search contacts by phone number of the contact person.