Cmdlets for Zoho Books

Build 24.0.8963

ContactDetails

To list, add, update and delete a contact.

Table Specific Information

Select

The 本製品 uses the Zoho Books API to process WHERE clause conditions built with the following column and operator:

  • ContactId supports the '=' and IN operators.

NOTE: ContactId is required to query ContactDetails.

The rest of the filter is executed client-side in the 本製品.

For example:

    SELECT * FROM ContactDetails WHERE ContactId = '1894952000000071009'
	SELECT * FROM ContactDetails WHERE ContactId IN (SELECT ContactId FROM Contacts)
	SELECT * FROM ContactDetails WHERE ContactId IN ('1894952000000071009','1894952000000071010')

Insert

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

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

Update

UPDATE can be executed by specifying the ContactId in the WHERE Clause. The columns that are not read-only can be updated. For example:

UPDATE ContactDetails SET ContactName = 'Name Change' WHERE ContactId = '3350895000000089005'

Delete

DELETE can be executed by specifying the ContactId in the WHERE Clause For example:

DELETE FROM ContactDetails WHERE ContactId = '3350895000000089001'

Columns

Name Type ReadOnly References SupportedOperators Description
ContactId [KEY] String True

Contacts.ContactId

Id of a contact.

AchSupported Boolean False

Check if ACH is supported.

AssociatedWithSquare Boolean False

Check if the contact is associated with square.

BankAccounts String False

Bank accounts of a contact.

BillingAddress String False

Billing address of a contact.

BillingAddressId String False

ContactAddresses.AddressId

Id of a billing address.

BillingAddressAttention String False

Name of a person in billing address.

BillingAddressCity String False

City of a billing address.

BillingAddressCountry String False

Country of a billing address.

BillingAddressFax String False

Fax of a billing address.

BillingAddressPhone String False

Phone number of a billing address.

BillingAddressState String False

State of a billing address.

BillingAddressStateCode String False

State code of a billing address.

BillingAddressStreet2 String False

Street two of a billing address.

BillingAddressZip String False

ZIP code of a billing address.

CanShowCustomerOb Boolean False

Check if contact can show customer ob.

CanShowVendorOb Boolean False

Check if contact can show vendor ob.

Cards String False

Cards

Checks String False

Checks

CompanyName String False

Name of the company.

ContactType String False

Contact type of the contact.

ContactCategory String True

Category of this contact.

ContactName String False

Display Name of the contact. Max-length [200].

ContactPersons String False

Contact persons of a contact.

CustomFields String False

Custom fields of the contact.

ContactSalutation String False

Salutation of a contact.

CreatedTime Datetime True

Time at which the contact was created.

CreditLimit Decimal False

Credit limit for a customer.

CreditLimitExceededAmount Decimal True

Amount if the credit limit exceeded.

CurrencyId String False

Currency Id of the customer's currency.

CurrencyCode String True

Currency code of the customer's currency.

CurrencySymbol String True

Currency symbol of the customer's currency.

CustomerSubType String False

Sub type of a customer.

DefaultTemplatesBillTemplateId String False

Id of a bill template in default template.

DefaultTemplatesBillTemplateName String True

Name of a bill template in default template.

DefaultTemplatesCreditnoteEmailTemplateId String False

Id of a credit note email template in default template.

DefaultTemplatesCreditnoteEmailTemplateName String True

Name of a credit note email template in default template.

DefaultTemplatesCreditnoteTemplateId String False

Id of a credit note template in default template.

DefaultTemplatesCreditnoteTemplateName String True

Name of a credit note template in default template.

DefaultTemplatesEstimateEmailTemplateId String False

Id of a estimate email template in default template.

DefaultTemplatesEstimateEmailTemplateName String True

Name of a estimate email template in default template.

DefaultTemplatesEstimateTemplateId String False

Id of a estimate template in default template.

DefaultTemplatesEstimateTemplateName String True

Name of a estimate template in default template.

DefaultTemplatesInvoiceEmailTemplateId String False

Id of a invoice email template in default template.

DefaultTemplatesInvoiceEmailTemplateName String True

Name of a invoice email template in default template.

DefaultTemplatesInvoiceTemplateId String False

Id of a invoice template in default template.

DefaultTemplatesInvoiceTemplateName String True

Name of a invoice template in default template.

DefaultTemplatesPaymentRemittanceEmailTemplateId String False

Id of a payment remittance template in default template.

DefaultTemplatesPaymentRemittanceEmailTemplateName String True

Name of a payment remittance template in default template.

DefaultTemplatesPaymentthankyouEmailTemplateId String False

Id of a payment thank you email template in default template.

DefaultTemplatesPaymentthankyouEmailTemplateName String True

Name of a payment thank you email template in default template.

DefaultTemplatesPaymentthankyouTemplateId String False

Id of a payment thank you template in default template.

DefaultTemplatesPaymentthankyouTemplateName String True

Name of a payment thank you template in default template.

DefaultTemplatesPurchaseorderEmailTemplateId String False

Id of a purchase order email template in default template.

DefaultTemplatesPurchaseorderEmailTemplateName String True

Name of a purchase order email template in default template.

DefaultTemplatesPurchaseorderTemplateId String False

Id of a purchase order template in default template.

DefaultTemplatesPurchaseorderTemplateName String True

Name of a purchase order template in default template.

DefaultTemplatesSalesorderEmailTemplateId String False

Id of a sales order email template in default template.

DefaultTemplatesSalesorderEmailTemplateName String True

Name of a sales order email template in default template.

DefaultTemplatesSalesorderTemplateId String False

Id of a sales order template in default template.

DefaultTemplatesSalesorderTemplateName String True

Name of a sales order template in default template.

Department String False

Department

Designation String False

Designation

Email String True

Email Id of a contact.

ExchangeRate Decimal False

Exchange rate of the currency.

Facebook String False

Facebook profile account. max-length [100].

HasTransaction Boolean True

Check if this contact has transaction.

IsClientReviewAsked Boolean True

Check if the client review is asked.

IsClientReviewSettingsEnabled Boolean True

Check if the client review settings is enabled for this contact.

IsSmsEnabled Boolean True

Check if SMS is enabled.

IsAddedInPortal Boolean False

To enable client portal for the contact. Allowed value is true and false.

LanguageCode String False

Language code used for a contact.

LastModifiedTime Datetime True

The time of last modification of the contact.

Mobile String True

Mobile number of a contact.

Notes String False

Notes of a contact.

OpeningBalanceAmount Decimal True

Opening balance amount of a contact.

OpeningBalanceAmountBcy Decimal True

Base Currency of Opening balance amount of a contact.

OutstandingPayableAmount Decimal True

Outstanding OB payable amount of a contact.

OutstandingReceivableAmount Decimal True

Outstanding OB receivable amount of a contact.

OwnerId String False

Id of the owner.

OwnerName String True

Name of the owner.

PaymentReminderEnabled Boolean True

Check if payment reminder is enabled.

PaymentTerms Integer False

Net payment term for the customer.

PaymentTermsLabel String False

Label for the paymet due details.

Phone Integer False

Phone

PortalStatus String True

Status of a portal.

PricePrecision Integer True

The precision for the price.

PricebookId String True

Id of a price book.

PricebookName String True

Name of a price book.

PrimaryContactId String True

Primary Id of a contact.

SalesChannel String True

Channel of sales.

ShippingAddress String False

Shipment Address.

ShippingAddressId String True

ContactAddresses.AddressId

Id of a shipping address.

ShippingAddressAttention String False

Name of a person of shipping address.

ShippingAddressCity String False

City of a shipping address.

ShippingAddressCountry String False

Country of a shipping address.

ShippingAddressFax String False

Fax of a shipping address.

ShippingAddressPhone String False

Phone number of a shipping address.

ShippingAddressState String False

State of a shipping address.

ShippingAddressStateCode String False

State code of a shipping address.

ShippingAddressStreet2 String False

Street two details of a shipping address.

ShippingAddressZip String False

Zip code of a shipping address.

Source String True

Source of the contact.

Status String True

Status of the contact.

Twitter String False

Twitter account.

TaxAuthorityName String False

Enter tax authority name.

Tags String False

Tags.

UnusedCreditsPayableAmount Decimal True

Payable amount of Unused credits of a contact.

UnusedCreditsPayableAmountBcy Decimal True

Base Currency Payable amount of Unused credits of a contact.

UnusedCreditsReceivableAmount Decimal True

Receivable amount of Unused credits of a contact.

UnusedCreditsReceivableAmountBcy Decimal True

Base Currency Receivable amount of Unused credits of a contact.

UnusedRetainerPayments Decimal True

Payment of the contact which is unused.

VendorCurrencySummaries String True

VendorCurrencySummaries

Website String False

Link of a website.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.8963