Zoho Books Version Support

The connector leverages the Zoho Books API to enable bidirectional access to Zoho Books.

Authenticating to Zoho Books

Zoho Books uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See Using OAuth Authentication for an authentication guide.

Use the OAuth authentication standard to connect to Zoho Books. OAuth requires the authenticating user to interact with Zoho Books using the browser.

Custom Credentials

You will need to register an app to obtain the OAuthClientId, OAuthClientSecret. See Custom Credentials for a procedure.

Creating a Custom OAuth App

You may want to create a custom OAuth app to change the information displayed when users log into the Zoho Books. You can register an app to obtain the OAuthClientId, OAuthClientSecret, and OrganizationId.

See Creating a Custom OAuth App for a procedure.

Authenticate using the Embedded OAuth Credentials

Desktop Authentication with the Embedded OAuth App

You can connect without setting any connection properties for your user credentials. After setting the following, you are ready to connect:

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process.

1. Extracts the access token from the callback URL and authenticates requests.
2. Obtains a new access token when the old one expires.
3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

This section describes desktop authentication using the credentials for your custom OAuth app. See Creating a Custom OAuth App for more information.

Desktop Authentication with your OAuth App

Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.

Get an OAuth Access Token

After setting the following, you are ready to connect:

• OAuthClientId: Set this to the Client ID in your app settings.
• OAuthClientSecret: Set this to the Client Secret in your app settings.
• CallbackURL: Set this to the Redirect URL in your app settings.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

1. Extracts the access token from the callback URL and authenticates requests.
2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Using OAuth on a Headless Machine

To create Zoho Books data sources on headless servers or other machines on which the connector cannot open a browser, you need to authenticate from another machine. Authentication is a two-step process.

1. Instead of installing the connector on another machine, you can follow the steps below to obtain the OAuthVerifier value. Or, you can install the connector on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow.
2. You can then configure the connector to automatically refresh the access token from the headless machine.

Using the Credentials for a Custom OAuth App

Create a Custom OAuth App

See Creating a Custom OAuth App for a procedure. You can then follow the procedures below to authenticate and connect to data.

Obtain a Verifier Code

Set the following properties on the headless machine:

• InitiateOAuth: Set this to OFF.
• OAuthClientId: Set this to the App ID in your app settings.
• OAuthClientSecret: Set this to the App Secret in your app settings.

You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.

1. Call the GetOAuthAuthorizationURL stored procedure* with the CallbackURL input parameter set to the exact Redirect URI you specified in your app settings.
2. Open the returned URL in a browser. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code.
3. Save the value of the verifier code. You will set this in the OAuthVerifier connection property.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

• OAuthClientId: Set this to the consumer key in your app settings.
• OAuthClientSecret: Set this to the consumer secret in your app settings.
• OAuthVerifier: Set this to the verifier code.
• OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.
• InitiateOAuth: Set this to REFRESH.

Connect to Data

After the OAuth settings file is generated, set the following properties to connect to data:

• OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
• InitiateOAuth: Set this to REFRESH.

Transfer OAuth Settings

Follow the steps below to install the connector on another machine, authenticate, and then transfer the resulting OAuth values.

On a second machine, install the connector and connect with the following properties set:

• OAuthSettingsLocation: Set this to a writable text file.
• InitiateOAuth: Set this to GETANDREFRESH.
• OAuthClientId: Set this to the Client ID in your app settings.
• OAuthClientSecret: Set this to the Client Secret in your app settings.
• CallbackURL: Set this to the Callback URL in your app settings.

Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:

• InitiateOAuth: Set this to REFRESH.
• OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.

To obtain an OAuthClientId, OAuthClientSecret, CallbackURL, and OrganizationId you first need to create an app linked to your Zoho Books account.

Create and Configure a Custom OAuth App

You will have to first register your application with Zoho's Developer console in order get your Client ID and Client Secret. You can create an app linked to your Zoho Books account as follows:

1. To register your application, go to https://accounts.zoho.com/developerconsole.
2. Click Add Client ID, specify an Client Name Client Domain.
3. Fill the required details in the form.
   • Set the Auth Callback URL to https://localhost:33333 or a different port of your choice.
   • You can choose Client Type as WEB Based/Javascript/Mobile, then click on Create.
4. In Zoho Books, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Books Organization with its own organization ID, base currency, time zone, language, contacts, reports, etc
   • The parameter organization_id along with the organization ID should be sent in with every API request to identify the organization.
   • Click Organization Name, on the top right section. Inside that you can choose the Organization Id.
   • If the value of Organization ID is not specified in the connection string, then we will make a call to get all the available organizations and will select the first organization ID as the default one.
5. After completing the changes the browser will prompt you to save.

Once you are done with creating a new client, it will be displayed on your screen. From there, you can click More Options > Edit to reveal your newly created app's Client ID and Client Secret. You can now use these credentials to connect to Zoho Books by setting them as the following connection properties:

• OAuthClientId = Client Id
• OAuthClientSecret = Client Secret
• CallbackURL = Auth Callback URL

Fine Tuning Data Access

You can use the following properties to gain more control over the data returned from Zoho Books:

• OrganizationId: The ID associated with the specific Zoho Books organization you wish to connect to. In Zoho Books, your business is termed as an organization.
  If you have multiple businesses, you simply set each of those up as an individual organization.
  Each organization is an independent Zoho Books Organization with its own organization ID, base currency, time zone, language, contacts, reports, etc.
  If the value of Organization ID is not specified in the connection string, then we will make a call to get all the available organizations and will select the first organization ID as the default one.
  
• AccountsServer: The full Account Server URL. Most of the time, the value of this property will be https://books.zoho.com, but if your account resides in a different location, then the domain should change accordingly (.eu, .in, .com.au, ...).

This section details a selection of advanced features of the Zoho Books connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

The Jitterbit Connector for Zoho Books allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Defining Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM INVOICES WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Working with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

Customizing the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Overview

This section shows the available API objects and provides more information on executing SQL to Zoho Books APIs.

Key Features

• The connector models Zoho Books entities like invoices, bills, and expenses as relational views, allowing you to write SQL to query Zoho Books data.
• Stored procedures* allow you to execute operations to Zoho Books, including expense receipt, retainer invoice attachment and attachments.
• Live connectivity to these objects means any changes to your Zoho Books account are immediately reflected when using the connector.
• IncludeCustomFields connection property allows you to retrieve custom fields for supported views. Set this property to True, to enable this feature.

Views

Views describes the available views. Views are statically defined to model Invoices, Bills, Expenses, and more.

Stored Procedures

NOTE: Stored procedures are not currently supported. See the above note for details.

Stored Procedures are function-like interfaces to Zoho Books. Stored procedures* allow you to execute operations to Zoho Books, including expense receipt, retainer invoice attachment and attachments.

Collaborative Query Processing

The connector offloads as much of the SELECT statement processing as possible to Zoho Books and then processes the rest of the query in memory. API limitations and requirements are also documented in this section.

See SupportEnhancedSQL for more information on how the connector circumvents API limitations with in-memory client-side processing.

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure* is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard. To find out more about tables and stored procedures, please navigate to their corresponding entries in this help document.

Jitterbit Connector for Zoho Books Views

Name	Description
BankAccounts	Retrieves list of all bank and credit card accounts for your organization.
BankMatchingTransactions	Retrieves the list of transactions which includes invoices/bills/credit-notes.
BankRuleCriterions	Get criterions of a specific bank rule.
BankRules	Fetch all the rules or a specific rule created for a specified bank or credit card account ID.
BankTransactionLineItems	Get details of bank transaction line items.
BankTransactions	Get all the transaction details involved in an account.
BaseCurrencyAdjustmentAccounts	Retrieves lists of base currency adjustment accounts.
BaseCurrencyAdjustments	Retrieves list of base currency adjustment.
BillDetails	Get the details of a bill.
BillLineItems	Get the details of a line items of bills.
BillPayments	Get the list of payments made for a bill.
Bills	Retrieves list of bills.
ChartOfAccountInlineTransactions	Retrieves the list of inline transactions.
ChartOfAccounts	Retrieves list of all chart of accounts.
ChartOfAccountTransactions	Retrieves list of all involved transactions for the given account.
ContactAddresses	Get addresses of a contact including its Shipping Address, Billing Address.
ContactDetails	Get details of a contact.
Contacts	Retrieves list of all contacts.
CreditNoteDetails	Retrieves details of an existing Credit Note.
CreditNoteInvoices	Retrieves details of invoices from an existing Credit Note.
CreditNoteLineItems	Retrieves details of line items from existing Credit Notes.
CreditNotes	Retrieves list of all the Credit Notes.
Currencies	Get list of currencies configured. Also, get the details of a currency.
CurrencyExchangeRates	Retrieves list of exchange rates configured for the currency.
CustomerContacts	Retrieves list of all contact persons. Also, get the contact person details.
CustomerPaymentDetails	Retrieves details of an existing payment.
CustomerPayments	Retrieves list of all the payments made by your customer.
Employees	Retrieves list of employees. Also, get the details of an employee.
EstimateApprovers	Get the details of approvers for estimates.
EstimateDetails	Get the details of an estimate.
EstimateLineItems	Get the details of line items for estimates.
Estimates	Retrieves list of all estimates.
ExpenseDetails	Get the details of an Expense.
Expenses	Retrieves list of all the Expenses.
InvoiceAppliedCredits	Retrieves list of credits applied for an invoice.
InvoiceDetails	Get the details of an invoice.
InvoiceLineItems	Get the details of line items from invoices.
InvoicePayments	Get the list of payments made for an invoice.
Invoices	Retrieves list of all invoices.
ItemDetails	Retrieves details of an existing item.
Items	Retrieves list of all active items.
JournalLineItems	Retrieves list of line items of a journal.
Journals	Retrieves list of journals.
OpeningBalanceAccounts	Retrieves list of accounts of opening balance.
OpeningBalances	Get details of opening balance.
OpeningBalanceTransactionSummaries	Get transaction summaries of opening balance.
Organizations	Retrieves list of organizations.
ProjectInvoices	Retrieves list of invoices created for a project.
Projects	Retrieves list of projects.
ProjectUsers	Retrieves list of users associated with a project. Also, get details of a user in project.
PurchaseOrderDetails	Get the details of a purchase order.
PurchaseOrderLineItems	Get the details of line items of purchase orders.
PurchaseOrders	Retrieves list of all purchase orders.
RecurringExpenseDetails	Get the details of a recurring expense.
RecurringExpenses	Retrieves list of all the Expenses.
RecurringInvoiceDetails	Get the details of a recurring invoice.
RecurringInvoiceLineItems	Get the details of line items of a recurring invoice.
RecurringInvoices	Retrieves list of all recurring invoices.
RecurringSubExpense	Retrieves list of child expenses created from recurring expense.
RetainerInvoiceDetails	Get the details of a retainer invoice.
RetainerInvoiceLineItems	Retrieves detail of line items of retainer invoices.
RetainerInvoicePayments	Get the list of payments made for a retainer invoices.
RetainerInvoices	Retrieves list of all retainer invoices.
SalesOrderDetails	Get the details of a sales order.
SalesOrderLineItems	Retrieves list of line items of a sales order.
SalesOrders	Retrieves list of all sales orders.
Tasks	Retrieves list of tasks added to a project. Also, get the details of a task.
Taxes	Retrieves list of simple and compound taxes. Also, get the details of a simple or compound tax.
TimeEntries	Retrieves list of all time entries.
Users	Retrieves list of all users in the organization. Also, get the details of a user.
VendorCreditBills	Retrieves list of bills to which the vendor credit is applied.
VendorCreditDetails	Get details of a vendor credit.
VendorCreditLineItems	Retrieves list of line items from vendor credits.
VendorCredits	Retrieves list of vendor credits.
VendorPaymentDetails	Get details of a Vendor Payment.
VendorPayments	Retrieves list of all the payments made to your vendor.

Retrieves list of all bank and credit card accounts for your organization.

Table Specific Information

Select

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

• AccountId supports the '=' comparison.
• AccountCodeAccountName supports the '=' comparison.
• AccountType supports the '=' comparison.
• Status supports the '=' comparison.

For example:

    SELECT * FROM BankAccounts WHERE Status = 'All'

    SELECT * FROM BankAccounts WHERE AccountId = '1894343000000085314'

Columns

Name	Type	References	SupportedOperators	Description
AccountId [KEY]	String			Id of the Bank Account.
AccountCode	String			Code of the Account.
AccountName	String			Name of the account.
AccountType	String			Type of the account.
Balance	Decimal			The unpaid amount.
BankBalance	Decimal			Total balance in Bank.
BankName	String			Name of the Bank.
BcyBalance	Decimal			Balance of Base Currency.
CanShowInZe	Boolean			Check if it can show in Zero Emission.
CanShowPayPalDirectIntegBanner	Boolean			Check if it can show direct integ banner.
CurrencyCode	String			Currency code of the customer's currency.
CurrencyId	String	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String			Currency symbol of the customer's currency.
Description	String			Description of the Account.
IsActive	Boolean			Check if bank account is active.
IsDirectPayPal	Boolean			Check if bank account is direct by paypal.
PricePrecision	Integer			The precision for the price.
TotalUnprintedChecks	Integer			Total number of unprinted checks.
UncategorizedTransactions	Integer			Number of uncategorized transactions.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Status	String		Filter bills by any status. The allowed values are All, PartiallyPaid, Paid, Overdue, Void, Open.

Retrieves the list of transactions which includes invoices/bills/credit-notes.

Table Specific Information

Select

The connector will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector. You can even provide criteria to search for matching uncategorised transactions.

• TransactionId supports the '=' comparison.
• TransactionType supports the '=' comparison.
• ReferenceNumber supports the '=' comparison.
• Date supports the '=,<,>' comparisons.
• Contact supports the '=' comparison.
• ShowAllTransactions. supports the '=' comparison.

For example:

    SELECT * FROM BankMatchingTransactions WHERE TransactionId = '1894578000000087001

Columns

Name	Type	References	SupportedOperators	Description
TransactionId [KEY]	String	BankTransactions.TransactionId		ID of the Transaction.
TransactionNumber	String			Numnber of transaction.
TransactionType	String			Transaction Type of the transaction.
Amount	Integer			Amount of the bank matching transactions.
ContactName	String			Display Name of the contact. Max-length [200]
Date	Date		=, <, >	Date when transaction was made.
DebitOrCredit	String			Indicates if transaction is Credit or Debit.
IsBestMatch	Boolean			Check if the transaction is a best match.
IsPaidViaPrintCheck	Boolean			Check if it is paid via print check.
ReferenceNumber	String			Reference Number of the transaction.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Contact	String		Contact person name, involved in the transaction.
ShowAllTransactions	Boolean		Check if all transactions must be shown.

Get criterions of a specific bank rule.

Table Specific Information

Select

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

• RuleAccountId supports the '=' comparison.

For example:

    SELECT * FROM BankRuleCriterions WHERE RuleAccountId = '1894553000000085382

Columns

Name	Type	References	SupportedOperators	Description
CriteriaId [KEY]	String			Id of a criteria.
RuleAccountId	String	BankAccounts.AccountId		ID of the Bank Account.
Comparator	String			Operator for comparing criteria.
Field	String			Field of a criteria.
Value	String			Value of a criteria.

Fetch all the rules or a specific rule created for a specified bank or credit card account ID.

Table Specific Information

Select

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

• RuleAccountId supports the '=' comparison.
• RuleId supports the '=' comparison.

For example:

    SELECT * FROM BankRules WHERE RuleAccountId = '1894553000000085382' AND RuleId = '1894553000000085386'

Columns

Name	Type	References	SupportedOperators	Description
RuleId [KEY]	String			Id of the rule.
RuleName	String			Name of the rule.
RuleOrder	Integer			Order of rule.
ApplyTo	String			To whom can rule be applied.
CriteriaType	String			Type of criteria0.
RecordAs	String			Entity as which it should be recorded.
RuleAccountId	String	BankAccounts.AccountId		ID of the Bank Account.
AccountName	String			Name of the account.
TaxId	String	Taxes.TaxId		Id of a tax.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String			Name of the customer or vendor.
ReferenceNumber	String			Reference number of a bank rule.
PaymentMode	String			Mode through which payment is made.
TaxAuthorityId	String	Taxes.TaxAuthorityId		ID of a tax authority.
TaxAuthorityName	String			Name of a tax authority.
TaxExemptionId	String			ID of a tax exemption.
TaxExemptionCode	String			Code of a tax exemption.
IsReverseCharge	Boolean			Check if it is charged reverse.
GstTreatment	String			Choose whether the bank rule is GST registered/unregistered/consumer/overseas. .
TaxTreatment	String			VAT treatment for the Bank Rule.
GstNo	String			GST Number.
HsnOrSac	String			HSN Code.
DestinationOfSupply	String			Place where the goods/services are supplied to.

Get details of bank transaction line items.

Table Specific Information

Select

The connector will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: TransactionId is required in order to query BankTransactionLineItems.

• TransactionId supports the '=' comparison.

For example:

    SELECT * FROM BankTransactionLineItems WHERE TransactionId = '1894553000000098001'

Columns

Name	Type	References	SupportedOperators	Description
TransactionId [KEY]	String	BankTransactions.TransactionId		ID of the Transaction.
BcyTotal	Decimal			Total Base Currency.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String			Name of the customer or vendor.
FromAccountId	String	BankAccounts.AccountId		Transaction from account ID.
FromAccountName	String			Transaction from account name.
PaymentMode	String			Mode through which payment is made.
SubTotal	Decimal			Sub total of bank transaction line items.
Tags	String			Details of tags related to bank transactions.
Total	Decimal			Total of bank transaction line items.
VendorId	String			ID of the vendor the bank transaction line items has been made.
VendorName	String			Name of the vendor the bank transaction line items has been made.

Get all the transaction details involved in an account.

Table Specific Information

Select

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

• AccountId supports the '=' comparison.
• TransactionType supports the '=' comparison.
• Amount supports the '=' comparison.
• Date supports the '=' comparison.
• ReferenceNumber supports the '=' comparison.
• Status supports the '=' comparison.
• BankTransactionFilter supports the '=' comparison.

For example:

    SELECT * FROM BankTransactions WHERE Status = 'All'

    SELECT * FROM BankTransactions LIMIT 5

Columns

Name	Type	References	SupportedOperators	Description
TransactionId [KEY]	String			Id of the Transaction.
TransactionType	String			Transaction Type of the transaction. The allowed values are deposit, refund, transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return.
AccountId	String	BankAccounts.AccountId		Account ID for which transactions are to be listed.
AccountName	String			Name of the account.
AccountType	String			Type of the account.
Amount	Decimal			Start and end amount, to provide a range within which the transaction amount exist.
CurrencyCode	String			Currency code of the customer's currency.
CurrencyId	String	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String			Currency symbol of the customer's currency.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
Date	Date			Start and end date, to provide a range within which the transaction date exist.
DebitOrCredit	String			Indicates if transaction is Credit or Debit.
Description	String			Description of the bank transactions.
ExcludeDescription	String			Is the description is to be excluded.
ImportedTransactionId	Long			ID of the Imported Transaction.
IsOffsetaccountMatched	Boolean			Check if Offset Account is matched.
IsPaidViaPrintCheck	Boolean			Check if paid via print check.
IsRuleExist	Boolean			Check if rule exists.
OffsetAccountName	String			Name of the offset account.
Payee	String			Information about the payee.
PricePrecision	Integer			The precision for the price.
ReferenceNumber	String			Reference Number of the transaction.
RunningBalance	String			Running balance in bank.
Source	String			Source of the bank transaction.
Status	String			Transaction status wise list view. The allowed values are All, uncategorized, manually_added, matched, excluded, categorized.
VendorId	String			ID of the vendor the bank transaction has been made. This field will be populated with a value only when the Transaction ID is specified.
VendorName	String			Name of the vendor the bank transaction has been made. This field will be populated with a value only when the Transaction ID is specified.
BankCharges	Decimal			Bank charges of bank transactions. This field will be populated with a value only when the Transaction ID is specified.
BcyTotal	Decimal			Total Base Currency This field will be populated with a value only when the Transaction ID is specified.
CustomerName	String			Name of the customer or vendor. This field will be populated with a value only when the Transaction ID is specified.
ExchangeRate	Decimal			Exchange rate of a bank transaction. This field will be populated with a value only when the Transaction ID is specified.
FromAccountId	String	BankAccounts.AccountId		Account ID from which bank transaction was made. This field will be populated with a value only when the Transaction ID is specified.
FromAccountName	String			Account name from which bank transaction was made. This field will be populated with a value only when the Transaction ID is specified.
ImportedTransactions	String			Imported bank transations. This field will be populated with a value only when the Transaction ID is specified.
IsInclusiveTax	Boolean			Check if bank transaction is invlusive tax. This field will be populated with a value only when the Transaction ID is specified.
IsPreGst	Boolean			Check if bank transaction is pre GST. This field will be populated with a value only when the Transaction ID is specified.
PaymentMode	String			Mode through which payment is made. This field will be populated with a value only when the Transaction ID is specified.
SubTotal	Decimal			Sub total of bank transactions This field will be populated with a value only when the Transaction ID is specified.
Tags	String			Details of tags related to bank transactions. This field will be populated with a value only when the Transaction ID is specified.
TaxAmount	Decimal			Amount of tax. This field will be populated with a value only when the Transaction ID is specified.
TaxId	String	Taxes.TaxId		Id of tax. This field will be populated with a value only when the Transaction ID is specified.
TaxName	String			Name of tax. This field will be populated with a value only when the Transaction ID is specified.
TaxPercentage	Integer			Percentage of tax. This field will be populated with a value only when the Transaction ID is specified.
ToAccountId	String	BankAccounts.AccountId		Account ID the transaction was made to. This field will be populated with a value only when the Transaction ID is specified.
ToAccountName	String			Account name the transaction was made to. This field will be populated with a value only when the Transaction ID is specified.
Total	Decimal			Total of bank transactions. This field will be populated with a value only when the Transaction ID is specified.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
BankTransactionFilter	String		Filters the transactions based on the allowed types. The allowed values are Status.All, Status.Uncategorized, Status.Categorized, Status.ManuallyAdded, Status.Excluded, Status.Matched.

Retrieves lists of base currency adjustment accounts.

Table Specific Information

Select

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

• BaseCurrencyAdjustmentId supports the '=' comparison.

For example:

    SELECT * FROM BaseCurrencyAdjustmentAccounts WHERE BaseCurrencyAdjustmentId = '1894553000000000065'

Columns

Name	Type	References	SupportedOperators	Description
BaseCurrencyAdjustmentId [KEY]	String			Id of base currency adjustment account.
AccountId	String	BankAccounts.AccountId		Id of the Bank Account.
AccountName	String			Name of the account.
BcyBalance	Decimal			Balance of Base Currency.
FcyBalance	Decimal			Balance of Foreign Currency.
AdjustedBalance	Decimal			Balance adjusted for base currency.
GainOrLoss	Decimal			Check the amount if gain or loss.
GlSpecificType	String			Specific type of gain or loss.

Retrieves list of base currency adjustment.

Table Specific Information

Select

The connector will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector. By default, response will be showing the base currency adjustments of current month only.

• BaseCurrencyAdjustmentId supports the '=' comparison.
• BaseCurrencyAdjustmentsFilter supports the '=' comparison.

For example:

    SELECT * FROM BaseCurrencyAdjustments WHERE BaseCurrencyAdjustmentsFilter = 'Date.All'

Columns

Name	Type	References	SupportedOperators	Description
BaseCurrencyAdjustmentId [KEY]	String			Id of a base currency adjustment.
CurrencyCode	String			Currency code of the customer's currency.
CurrencyId	String	Currencies.CurrencyId		Currency ID of the customer's currency.
AdjustmentDate	Date			Date of currency adjustment.
ExchangeRate	Decimal			Exchange rate of currency adjustment.
GainOrLoss	Decimal			Check the amount if gain or loss.
Notes	String			Notes of Base cuurrency adjustments.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
BaseCurrencyAdjustmentsFilter	String		Filter base currency adjustment list. The allowed values are Date.All, Date.Today, Date.ThisWeek, Date.ThisMonth, Date.ThisQuarter, Date.ThisYear.

Get the details of a bill.

Table Specific Information

Select

The connector will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: BillId is required in order to query BillDetails.

• BillId supports the '=' comparison.

For example:

    SELECT * FROM BillDetails WHERE BillId = '1894553000000085259'

Columns

Name	Type	References	SupportedOperators	Description
BillId [KEY]	String	Bills.BillId		ID of a Bill.
BillNumber	String			Number of a Bill.
Adjustment	Decimal			Adjustments made to the bill.
AdjustmentDescription	String			Description of adjustments made to the bill.
AllocatedLandedCosts	String			Allocated landed costs of bill.
ApproverId	String	Users.UserId		ID of an approver.
AttachmentName	String			Name of an attachment.
Balance	Decimal			Balance of bill.
BillingAddress	String			Billing address of a bill.
BillingAddressAttention	String			Name of a person in billing address.
BillingAddressCity	String			City of a billing address.
BillingAddressCountry	String			Country of a billing address.
BillingAddressFax	String			Fax of a billing address.
BillingAddressPhone	String			Phone of a billing address.
BillingAddressState	String			State of a billing address.
BillingAddressStreet2	String			Street two of a billing address.
BillingAddressZip	String			Zip of a billing address.
ClientViewedTime	String			Time when client viewed.
ColorCode	String			Color code.
ContactCategory	String			Category if contact.
CreatedById	String	Users.UserId		Id of a user who has created bill.
CreatedTime	Datetime			Time at which the bill was created.
CurrencyCode	String			Currency code of the customer's currency.
CurrencyId	String	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String			Symbol of the currency.
CurrentSubStatus	String			Current sub status of a bill.
CurrentSubStatusId	String			Current sub status ID of a bill.
Date	Date			Bill date.
DestinationOfSupply	String			Place where the goods/services are supplied to.
Discount	String			Discount of bills.
DiscountAccountId	String	BankAccounts.AccountId		Account ID of discount.
DiscountAmount	Decimal			Amount of discount.
DiscountAppliedOnAmount	Decimal			Discount applied on amount.
DiscountSetting	String			Setting of discount.
DueByDays	Integer			Number of days the bill is due by.
DueDate	Date			Delivery date of the bill.
DueInDays	String			Number of days the bill is due in.
EntityType	String			Entity type of the bill.
ExchangeRate	Decimal			Exchange rate of the currency.
FiledInVatReturnId	String			VAT return ID of bill which was filed.
FiledInVatReturnName	String			VAT return name of bill which was filed.
FiledInVatReturnType	String			VAT return type of bill which was filed.
GstNo	String			GST number.
GstReturnDetailsReturnPeriod	String			Return period of GST.
GstReturnDetailsStatus	String			Status of GST return details.
GstTreatment	String			Choose whether the bill is GST registered/unregistered/consumer/overseas.
HasNextBill	Boolean			Check if it has next bill.
InvoiceConversionType	String			Type of invoice conversion.
IsApprovalRequired	Boolean			Check of the approval required.
IsDiscountBeforeTax	Boolean			Check if discount should be applied before tax.
IsInclusiveTax	Boolean			Check if the tax is inclusive in the bill.
IsItemLevelTaxCalc	Boolean			Check if the item leven tax is calculated.
IsLineItemInvoiced	Boolean			Check if the line item is invoiced in the bill.
IsPreGst	Boolean			Check if pre GST is applied.
IsReverseChargeApplied	Boolean			Check if reverse charge is applied.
IsTdsAmountInPercent	Boolean			Check if the TDS amount in percent.
IsTdsApplied	Boolean			Check if TDS is applied.
IsViewedByClient	Boolean			Check if bill is viewed by client.
LastModifiedId	String			ID when bill was last modified.
LastModifiedTime	Datetime			The time of last modification of the bill.
Notes	String			Notes of the bill.
OpenPurchaseordersCount	Integer			Count of open purchase order.
Orientation	String			Orientation of the bill.
PageHeight	String			Height of the page.
PageWidth	String			Width o the page.
PaymentExpectedDate	Date			Date when the payment is expected.
PaymentMade	Decimal			Amount paid of this bill.
PaymentTerms	Integer			Net payment term for the customer.
PaymentTermsLabel	String			Label for the paymet due details.
PricePrecision	Integer			The precision for the price.
RecurringBillId	String			ID of a recurring bill.
ReferenceBillId	String			ID of a reference bill.
ReferenceId	String			Id of a reference.
ReferenceNumber	String			Number of a reference.
SourceOfSupply	String			Source of supply of bill.
Status	String			Status of the bill.
SubTotal	Decimal			Sub total of bills.
SubTotalInclusiveOfTax	Decimal			Subtotal amount which are inclusive of tax.
SubmittedBy	String			Detail of the user who has submitted the bill.
SubmittedDate	Date			Bill submitted date.
SubmitterId	String	Users.UserId		Id of a submitter.
TaxAccountId	String	BankAccounts.AccountId		Account ID of tax.
TaxTotal	Decimal			Total amount of tax.
TaxTreatment	String			VAT treatment for the Bill.
TdsAmount	Decimal			Amount of TDS.
TdsPercent	String			Percent of TDS.
TdsSection	String			Section of TDS.
TdsTaxId	String			Tax ID of TDS.
TdsTaxName	String			Tax name of TDS.
TemplateId	String			ID of a template.
TemplateName	String			Name of a template.
TemplateType	String			Type of a template.
Terms	String			Terms and Conditions apply of a bill.
Total	Decimal			Total of bills.
UnallocatedLandedCosts	String			Costs of unlocated land.
UnusedCreditsPayableAmount	Decimal			Payable amount of unused credits.
VatTreatment	String			VAT treatment for the bills.
VendorCreditsApplied	Decimal			Amount of applied vendor credits.
VendorId	String			ID of the vendor the bill has been made.
VendorName	String			Name of the vendor the bill has been made.

Get the details of a line items of bills.

Table Specific Information

Select

The connector will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: BillId is required in order to query BillLineItems.

• BillId supports the '=' comparison.

For example:

    SELECT * FROM BillLineItems WHERE BillId = '1894253000000085259'

Columns

Name	Type	References	SupportedOperators	Description
BillId	String	Bills.BillId		Id of a Bill.
LineItemId [KEY]	String			Id of line item.
AccountId	String	BankAccounts.AccountId		Id of the Bank Account.
AccountName	String			Name of the account.
BcyRate	Decimal			Rate of Base Currency.
CustomFields	String			Custom fields
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String			Name of the customer or vendor.
Description	String			Description of the bill line item.
Discount	Double			Discount to be applied on the bill line item.
GstTreatmentCode	String			Treatment code of GST.
HasProductTypeMismatch	Boolean			Check if the product type is mismatch.
HsnOrSac	String			HSN Code.
ImageDocumentId	String			ID of the image document.
InvoiceId	String	Invoices.InvoiceId		ID of an invoice.
InvoiceNumber	String			Number of an invoice.
IsBillable	Boolean			Check if the bill line items is billable.
ItcEligibility	String			Eligibility if bill for Input Tax Credit.
ItemId	String	Items.ItemId		ID of an item.
ItemOrder	Integer			Order of an item.
ItemTotal	Decimal			Total items.
ItemType	String			Type of item.
Name	String			Name of the bill line item.
PricebookId	String			ID of pricebook.
ProductType	String			Type of product.
ProjectId	String	Projects.ProjectId		ID of project.
ProjectName	String			Name of the project.
PurchaseorderItemId	String			Item ID for purchase order.
Quantity	Decimal			Quantity of line item.
Rate	Decimal			Rate of the line item.
ReverseChargeTaxId	String			ID of the reverse charge tax.
TaxExemptionCode	String			Code for tax exemption.
TaxExemptionId	String	BankRules.TaxExemptionId		ID of tax exemption.
TaxId	String	Taxes.TaxId		ID of tax.
TaxName	String			Name of tax.
TaxPercentage	Integer			Percentage applied for tax.
TaxType	String			Type of tax.
Unit	String			Number of quantity.

Get the list of payments made for a bill.

Table Specific Information

Select

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

• BillId supports the '=' comparison.

For example:

    SELECT * FROM BillPayments WHERE BillId = '1894253000000085259'

Columns

Name	Type	References	SupportedOperators	Description
BillPaymentId [KEY]	String			ID of bill payment.
BillId	String	Bills.BillId		ID of a Bill.
VendorId	String			ID of the vendor the bill payments has been made.
VendorName	String			Name of the vendor the bill payments has been made.
PaymentId	String			Id of a payment.
Amount	Decimal			Amount of the bill payments.
Date	Date			Date of a bill payment.
Description	String			Description of the bill payment.
ExchangeRate	Decimal			Exchange rate of bill payments.
IsSingleBillPayment	Boolean			Check if it is single bill payment.
PaidThrough	String			Amount paid via check/cash/credit.
PaymentMode	String			Mode through which payment is made.
ReferenceNumber	String			Reference number of bill payment.

Retrieves list of bills.

Table Specific Information

Select

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

• BillNumber supports the '=' comparison.
• Date supports the '=,<,>' comparisons.
• LastModifiedTime supports the '=' comparison.
• ReferenceNumber supports the '=' comparison.
• Status supports the '=' comparison.
• Total supports the '=,<,<=,>,>=' comparisons.
• VendorId supports the '=' comparison.
• VendorName supports the '=' comparison.
• PurchaseOrderId supports the '=' comparison.
• RecurringBillId supports the '=' comparison.
• BillFilter supports the '=' comparison.
• ItemId supports the '=' comparison.
• ItemDescription. supports the '=' comparison.

For example:

    SELECT * FROM Bills WHERE Total < 100 AND Total <= 98

    SELECT * FROM Bills WHERE Date < '2018-07-03'

    SELECT * FROM Bills WHERE CONTAINS(BillNumber,'Bi')

Columns

Name	Type	References	SupportedOperators	Description
BillId [KEY]	String			Id of a bill.
BillNumber	String			Number of bill.
Balance	Decimal			Amount of bill.
CreatedTime	Datetime			Time at which the bill was created.
Date	Date		=, <, >	Date of a bill.
DueDate	Date			Delivery date to pay the bill.
DueDays	String			Due days to pay the bill.
HasAttachment	Boolean			Check if the bill has attachment.
LastModifiedTime	Datetime			Last Modified Time of bill.
ReferenceNumber	String			Reference number of a bill.
Status	String			Status of a bill. The allowed values are paid, open, overdue, void, partially_paid.
TdsTotal	Decimal			Total amount of TDS applied.
Total	Decimal		=, <, <=, >, >=	Total of bills. Search by bill total.
VendorId	String			ID of the vendor the bill has been made. Search bills by Vendor ID.
VendorName	String			Name of the vendor the bill has been made. Search bills by vendor name.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
PurchaseOrderId	String		Id of a Purchase Order.
RecurringBillId	String		Id of a Recurring Bill.
BillFilter	String		Filter bills by any status. The allowed values are Status.All, Status.PartiallyPaid, Status.Paid, Status.Overdue, Status.Void, Status.Open.
ItemId	String		Id of an Item.
ItemDescription	String		Description of a bill.

Retrieves the list of inline transactions.

Table Specific Information

Select

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

• ChartAccountId supports the '=' comparison.

For example:

    SELECT * FROM ChartOfAccountInlineTransactions WHERE ChartAccountId = '1894553000000003003'

Columns

Name	Type	References	SupportedOperators	Description
ChartAccountId	String	BankAccounts.AccountId		ID of the Bank Account.
TransactionId [KEY]	String	BankTransactions.TransactionId		ID of the Transaction.
Credit	Decimal			Credit of inline transaction.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String			Name of the customer or vendor.
Date	Date			Date of an inline account transaction.
Debit	String			Debit of inline transaction.
EntityType	String			Entity type of inline transactions.
FcyCredit	Decimal			Foreign Currency credits.
FcyDebit	String			Foreign Currency debits.
ReferenceNumber	String			Reference number of inline transactions.

Retrieves list of all chart of accounts.

Table Specific Information

Select

The connector will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector. You can even provide criteria to search for matching uncategorised transactions.

• LastModifiedTime supports the '=' comparison.
• ShowBalance supports the '=' comparison.
• AccountType supports the '=' comparison.

For example:

    SELECT * FROM ChartOfAccounts WHERE AccountType = 'All' AND ShowBalance = true

Columns

Name	Type	References	SupportedOperators	Description
ChartAccountId [KEY]	String	BankAccounts.AccountId		Id of the Bank Account.
AccountName	String			Name of the account.
AccountType	String			Type of the account. The allowed values are All, Active, Inactive, Asset, Liability, Equity, Income, Expense.
CanShowInZe	Boolean			Check if it can show in Zero Emission.
ChildCount	String			Child count in chart of accounts.
CreatedTime	Datetime			Time at which the Chart of Accounts was created.
CustomFields	String			Custom Fields defined for the chart of account
Depth	Integer			Depth of account.
Description	String			Description of the Chart of Account.
HasAttachment	Boolean			Check if the chart of account has attachment.
IsActive	Boolean			Check if chart of account is active.
IsChildPresent	Boolean			Check if the child is present in chart of account.
IsStandaloneAccount	Boolean			Check if the account is standalone account.
IsUserCreated	Boolean			Check if the account is created by the user.
LastModifiedTime	Datetime			Last Modified time associated with the entity.
ParentAccountName	String			Account name of parent.
AccountCode	String			Code of the Account.
ClosingBalance	Decimal			Closing balance of account. This field will be populated with a value only when the Chart Account ID is specified.
IsInvolvedInTransaction	Boolean			Check if this account is involved in the transaction.
IsSystemAccount	Boolean			Check if it is a system account.
IsDebit	Boolean			Check if this account is debit. This field will be populated with a value only when the Chart Account ID is specified.
ParentAccountId	String	BankAccounts.AccountId		Id of a Parent account.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
ShowBalance	Boolean		Boolean to get current balance of accounts.

Retrieves list of all involved transactions for the given account.

Table Specific Information

Select

The connector will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector. You can even provide criteria to search for matching uncategorised transactions.

• ChartAccountId supports the '=' comparison.
• TransactionType supports the '=' comparison.
• Date supports the '=,<,>' comparisons.
• Amount supports the '=,<,<=,>,>=' comparisons.

For example:

    SELECT * FROM ChartOfAccountTransactions WHERE ChartAccountId = '1894553000000003001' AND TransactionType = 'opening_balance'

Columns

Name	Type	References	SupportedOperators	Description
ChartAccountId	String	ChartOfAccounts.ChartAccountId		Chart of Account Id.
CategorizedTransactionId [KEY]	String			ID of a categorized transaction in chart of account.
CreditAmount	Integer			Total amount credited.
DebitAmount	Decimal			Total amount debited.
CurrencyCode	String			Currency code of the customer's currency.
CurrencyId	String	Currencies.CurrencyId		Currency ID of the customer's currency.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
DebitOrCredit	String			Indicates if transaction is Credit or Debit.
Description	String			Description of the chart of account transactions.
EntryNumber	String			Entry number of account transaction.
Payee	String			Information about the payee.
TransactionDate	Date			Date of the transaction.
TransactionId	String	BankTransactions.TransactionId		ID of the Transaction.
TransactionType	String			Type of transactions. The allowed values are invoice, customer_payment, bills, vendor_payment, credit_notes, creditnote_refund, expense, card_payment, purchase_or_charges, journal, deposit, refund, transfer_fund, base_currency_adjustment, opening_balance, sales_without_invoices, expense_refund, tax_refund, receipt_from_initial_debtors, owner_contribution, interest_income, other_income, owner_drawings, payment_to_initial_creditors.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Date	Date		Date range filter of Chart of Account.
Amount	Decimal		Amount of the transaction.

Get addresses of a contact including its Shipping Address, Billing Address.

Table Specific Information

Select

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

• ContactId supports the '=' comparison.

For example:

    SELECT * FROM ContactAddresses WHERE ContactId = '1894952000000071009'

Columns

Name	Type	References	SupportedOperators	Description
AddressId [KEY]	String			Id of an address.
ContactId	String	Contacts.ContactId		ID of a contact.
Attention	String			Name of a person in billing address.
Address	String			Address of a contact.
Street2	String			Street two of a billing address.
City	String			City of a billing address.
State	String			State of a billing address.
Zip	String			ZIP code of a billing address.
Country	String			Country of a billing address.
Phone	String			Phone number of a billing address.
Fax	String			Fax of a billing address.

Get details of a contact.

Table Specific Information

Select

The connector will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ContactId is required in order to query ContactDetails.

• ContactId supports the '=' comparison.

For example:

    SELECT * FROM ContactDetails WHERE ContactId = '1894952000000071009'

Columns

Name	Type	References	SupportedOperators	Description
ContactId [KEY]	String	Contacts.ContactId		Id of a contact.
AchSupported	Boolean			Check if ACH is supported.
AssociatedWithSquare	Boolean			Check if the contact is associated with square.
BillingAddress	String			Billing address of a contact.
BillingAddressId	String	ContactAddresses.AddressId		Id of a billing address.
BillingAddressAttention	String			Name of a person in billing address.
BillingAddressCity	String			City of a billing address.
BillingAddressCountry	String			Country of a billing address.
BillingAddressFax	String			Fax of a billing address.
BillingAddressPhone	String			Phone number of a billing address.
BillingAddressState	String			State of a billing address.
BillingAddressStateCode	String			State code of a billing address.
BillingAddressStreet2	String			Street two of a billing address.
BillingAddressZip	String			ZIP code of a billing address.
CanShowCustomerOb	Boolean			Check if contact can show customer ob.
CanShowVendorOb	Boolean			Check if contact can show vendor ob.
CompanyName	String			Name of the company.
ContactCategory	String			Category of this contact.
ContactName	String			Display Name of the contact. Max-length [200].
ContactSalutation	String			Salutation of a contact.
CreatedTime	Datetime			Time at which the contact was created.
CreditLimitExceededAmount	Decimal			Amount if the credit limit exceeded.
CurrencyCode	String			Currency code of the customer's currency.
CurrencySymbol	String			Currency symbol of the customer's currency.
CustomerSubType	String			Sub type of a customer.
DefaultTemplatesBillTemplateId	String			ID of a bill template in default template.
DefaultTemplatesBillTemplateName	String			Name of a bill template in default template.
DefaultTemplatesCreditnoteEmailTemplateId	String			ID of a credit note email template in default template.
DefaultTemplatesCreditnoteEmailTemplateName	String			Name of a credit note email template in default template.
DefaultTemplatesCreditnoteTemplateId	String			ID of a credit note template in default template.
DefaultTemplatesCreditnoteTemplateName	String			Name of a credit note template in default template.
DefaultTemplatesEstimateEmailTemplateId	String			ID of a estimate email template in default template.
DefaultTemplatesEstimateEmailTemplateName	String			Name of a estimate email template in default template.
DefaultTemplatesEstimateTemplateId	String			ID of a estimate template in default template.
DefaultTemplatesEstimateTemplateName	String			Name of a estimate template in default template.
DefaultTemplatesInvoiceEmailTemplateId	String			ID of a invoice email template in default template.
DefaultTemplatesInvoiceEmailTemplateName	String			Name of a invoice email template in default template.
DefaultTemplatesInvoiceTemplateId	String			ID of a invoice template in default template.
DefaultTemplatesInvoiceTemplateName	String			Name of a invoice template in default template.
DefaultTemplatesPaymentRemittanceEmailTemplateId	String			ID of a payment remittance template in default template.
DefaultTemplatesPaymentRemittanceEmailTemplateName	String			Name of a payment remittance template in default template.
DefaultTemplatesPaymentthankyouEmailTemplateId	String			ID of a payment thank you email template in default template.
DefaultTemplatesPaymentthankyouEmailTemplateName	String			Name of a payment thank you email template in default template.
DefaultTemplatesPaymentthankyouTemplateId	String			ID of a payment thank you template in default template.
DefaultTemplatesPaymentthankyouTemplateName	String			Name of a payment thank you template in default template.
DefaultTemplatesPurchaseorderEmailTemplateId	String			ID of a purchase order email template in default template.
DefaultTemplatesPurchaseorderEmailTemplateName	String			Name of a purchase order email template in default template.
DefaultTemplatesPurchaseorderTemplateId	String			ID of a purchase order template in default template.
DefaultTemplatesPurchaseorderTemplateName	String			Name of a purchase order template in default template.
DefaultTemplatesSalesorderEmailTemplateId	String			ID of a sales order email template in default template.
DefaultTemplatesSalesorderEmailTemplateName	String			Name of a sales order email template in default template.
DefaultTemplatesSalesorderTemplateId	String			ID of a sales order template in default template.
DefaultTemplatesSalesorderTemplateName	String			Name of a sales order template in default template.
Email	String			Email ID of a contact.
ExchangeRate	Decimal			Exchange rate of the currency.
HasTransaction	Boolean			Check if this contact has transaction.
IsClientReviewAsked	Boolean			Check if the client review is asked.
IsClientReviewSettingsEnabled	Boolean			Check if the client review settings is enabled for this contact.
IsSmsEnabled	Boolean			Check if SMS is enabled.
LanguageCode	String			Language code used for a contact.
LastModifiedTime	Datetime			The time of last modification of the contact.
Mobile	String			Mobile number of a contact.
Notes	String			Notes of a contact.
OpeningBalanceAmount	Decimal			Opening balance amount of a contact.
OpeningBalanceAmountBcy	Decimal			Base Currency of Opening balance amount of a contact.
OutstandingPayableAmount	Decimal			Outstanding OB payable amount of a contact.
OutstandingReceivableAmount	Decimal			Outstanding OB receivable amount of a contact.
OwnerId	String			ID of the owner.
OwnerName	String			Name of the owner.
PaymentReminderEnabled	Boolean			Check if payment reminder is enabled.
PaymentTerms	Integer			Net payment term for the customer.
PaymentTermsLabel	String			Label for the paymet due details.
PortalStatus	String			Status of a portal.
PricePrecision	Integer			The precision for the price.
PricebookId	String			ID of a price book.
PricebookName	String			Name of a price book.
PrimaryContactId	String			Primary ID of a contact.
SalesChannel	String			Channel of sales.
ShippingAddress	String			Shipment Address.
ShippingAddressId	String	ContactAddresses.AddressId		ID of a shipping address.
ShippingAddressAttention	String			Name of a person of shipping address.
ShippingAddressCity	String			City of a shipping address.
ShippingAddressCountry	String			Country of a shipping address.
ShippingAddressFax	String			Fax of a shipping address.
ShippingAddressPhone	String			Phone number of a shipping address.
ShippingAddressState	String			State of a shipping address.
ShippingAddressStateCode	String			State code of a shipping address.
ShippingAddressStreet2	String			Street two details of a shipping address.
ShippingAddressZip	String			Zip code of a shipping address.
Source	String			Source of the contact.
Status	String			Status of the contact.
Twitter	String			Twitter account.
UnusedCreditsPayableAmount	Decimal			Payable amount of Unused credits of a contact.
UnusedCreditsPayableAmountBcy	Decimal			Base Currency Payable amount of Unused credits of a contact.
UnusedCreditsReceivableAmount	Decimal			Receivable amount of Unused credits of a contact.
UnusedCreditsReceivableAmountBcy	Decimal			Base Currency Receivable amount of Unused credits of a contact.
UnusedRetainerPayments	Decimal			Payment of the contact which is unused.
Website	String			Link of a website.

Retrieves list of all contacts.

Table Specific Information

Select

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

• ContactName supports the '=' comparison.
• CompanyName supports the '=' comparison.
• Status supports the '=' comparison.
• FirstName supports the '=' comparison.
• LastName supports the '=' comparison.
• Email supports the '=' comparison.
• Phone supports the '=' comparison.
• Address supports the '=' comparison.
• PlaceOfContact supports the '=' comparison.

For example:

    SELECT * FROM Contacts WHERE CONTAINS(LastName,'D')

    SELECT * FROM Contacts WHERE FirstName = 'John' AND Status = 'Active'

    SELECT * FROM Contacts LIMIT 5

Columns

Name	Type	References	SupportedOperators	Description
ContactId [KEY]	String			Id of a Contact.
ContactName	String			Name of a Contact.
CustomerName	String			Name of the customer.
VendorName	String			Name of the Vendor.
CompanyName	String			Name of a Company.
Website	String			Website of this contact.
LanguageCode	String			Language of a contact.
ContactType	String			Contact type of the contact.
Status	String			Status of the contact. The allowed values are All, Active, Inactive, Duplicate.
CustomerSubType	String			Sub type of a customer.
Source	String			Source of the contact.
CurrencyId	String	Currencies.CurrencyId		Currency ID of the customer's currency.
Facebook	String			Facebook profile account.
CurrencyCode	String			Currency code of the customer's currency.
OutstandingReceivableAmount	Decimal			Outstanding receivable amount of a contact.
OutstandingReceivableAmountBcy	Decimal			Base Currency of Outstanding receivable amount of a contact.
OutstandingPayableAmount	Decimal			Outstanding payable amount of a contact.
OutstandingPayableAmountBcy	Decimal			Base Currency of Outstanding payable amount of a contact.
UnusedCreditsPayableAmount	Decimal			Unused credits payable amount of a contact.
FirstName	String			First name of the contact person.
LastName	String			Last name of the contact person.
Email	String			Email address of the contact person.
Phone	String			Phone number of the contact person.
Mobile	String			Mobile number of the contact person.
PlaceOfContact	String			Code for the place of contact.
AchSupported	Boolean			Check if ACH is supported.
CreatedTime	Datetime			Time at which the contact was created.
GSTTreatment	String			Choose whether the contact is GST registered/unregistered/consumer/overseas.
HasAttachment	Boolean			Check if contacts has attachment.
LastModifiedTime	Datetime			The time of last modification of the contact.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Address	String		Address of a contact.

Retrieves details of an existing Credit Note.

Table Specific Information

Select

The connector will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: CreditnoteId is required in order to query CreditNoteDetails.

• CreditnoteId supports the '=' comparison.

For example:

    SELECT * FROM CreditNoteDetails WHERE CreditnoteId = '1895452000000083136'

Columns

Name	Type	References	SupportedOperators	Description
CreditnoteId [KEY]	String	CreditNotes.CreditnoteId		ID of a credit note.
CreditnoteNumber	String			Number of a credit note.
Adjustment	Decimal			Adjustments made to the credit note.
AdjustmentDescription	String			Description of adjustments made to the credit note.
ApproverId	String	Users.UserId		ID of an approver.
Balance	Decimal			The unpaid amount.
BillingAddress	String			Billing address of a credit note.
BillingAddressAttention	String			Name of a person in billing address.
BillingAddressCity	String			City of a billing address.
BillingAddressCountry	String			Country of a billing address.
BillingAddressFax	String			Fax of a billing address.
BillingAddressPhone	String			Phone number of a billing address.
BillingAddressState	String			State of a billing address.
BillingAddressStreet2	String			Street two of a billing address.
BillingAddressZip	String			ZIP code of a billing address.
ColorCode	String			Color code of a credit note.
ContactCategory	String			Category of a contact.
CreatedById	String	Users.UserId		Id of a user who has created credit note.
CreatedTime	Datetime			Time at which the credit note was created.
CurrencyCode	String			Currency code of the customer's currency.
CurrencyId	String	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String			Currency symbol of the customer's currency.
CurrentSubStatus	String			Current sub status of a credit note.
CurrentSubStatusId	String			Current sub status ID of a credit note.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String			Name of the customer or vendor.
Date	Date			Date of a credit note.
Discount	String			Discount given to specific item in credit note.
DiscountAmount	Decimal			Amount of discount.
DiscountAppliedOnAmount	Decimal			Discount applied on amount.
DiscountType	String			Type of discount.
ExchangeRate	Decimal			Exchange rate of the currency.
FiledInVatReturnId	String			VAT return ID of credit note which was filed.
FiledInVatReturnName	String			VAT return name of credit note which was filed.
FiledInVatReturnType	String			VAT return type of credit note which was filed.
GstNo	String			GST number used for credit note.
GstReason	String			Reason for GST given for credit note.
GstReturnDetailsReturnPeriod	String			Period for GST return.
GstReturnDetailsStatus	String			Status of GST return details.
GstTreatment	String			Choose whether the credit note is GST registered/unregistered/consumer/overseas. .
HasNextCreditnote	Boolean			Check if it has credit note.
InvoiceId	String	Invoices.InvoiceId		Invoice ID for credit note.
InvoiceNumber	String			Invoice number for credit note.
IsDiscountBeforeTax	Boolean			Check if the discount is applied before tax in credit note.
IsEmailed	Boolean			Check if the credit note is emailed.
IsEwayBillRequired	Boolean			Check if eway bill is required for credit note.
IsInclusiveTax	Boolean			Check if the credit note is inclusive tax.
IsPreGst	Boolean			Check if pre GST is applied.
IsTaxable	Boolean			Check if this credit note is taxable.
LastModifiedById	String	Users.UserId		Id of the user last modified.
LastModifiedTime	Datetime			The time of last modification of the credit note.
Notes	String			Notes for this credit note.
Orientation	String			Orientation of a page.
PageHeight	String			Height of a page.
PageWidth	String			Width of a page.
PlaceOfSupply	String			The place of supply is where a transaction is considered to have occurred for VAT purposes.
PricePrecision	Integer			The precision for the price.
ReasonForCreditnote	String			Any specific reason for taking credit note.
ReferenceNumber	String			Reference number of credit note.
ReverseChargeTaxTotal	Decimal			Total amount to pay the liability of tax.
RoundoffValue	Decimal			Rounding off the values to precise number.
SalespersonId	String			ID of a sales person.
SalespersonName	String			Name of a sales person.
ShippingAddress	String			Shipment Address.
ShippingAddressAttention	String			Name of a person of shipping address.
ShippingAddressCity	String			City of a shipping address.
ShippingAddressCountry	String			Country of a shipping address.
ShippingAddressFax	String			Fax of a shipping address.
ShippingAddressPhone	String			Phone number of a shipping address.
ShippingAddressState	String			State of a shipping address.
ShippingAddressStreet2	String			Street two details of a shipping address.
ShippingAddressZip	String			Zip code of a shipping address.
ShippingCharge	Decimal			Shipping charge of credit note.
Status	String			Status of the credit note.
SubTotal	Decimal			Sub total of credit notes.
SubTotalInclusiveOfTax	Decimal			Subtotal amount which are inclusive of tax.
SubmittedBy	String			Detail of the user who has submitted the credit note.
SubmittedDate	Date			Date when credit note was submitted.
SubmitterId	String	Users.UserId		Id of a submitter of credit note.
TaxSpecification	String			Working of tax when specifying special tax options and tax methods for earnings codes.
TaxTotal	Decimal			Total amount of Tax.
TaxTreatment	String			VAT treatment for the Credit Note.
TemplateId	String			ID of a template.
TemplateName	String			Name of a tempalte.
TemplateType	String			Type of a template.
Terms	String			Terms and Conditions apply of a credit note.
Total	Decimal			Total of credit notes.
TotalCreditsUsed	Decimal			Total credits used for credit note.
TotalRefundedAmount	Decimal			Total amount refunded for a credit note.
TransactionRoundingType	String			Type of round off used for transaction.
VatTreatment	String			VAT treatment for the credit note.

Retrieves details of invoices from an existing Credit Note.

Table Specific Information

Select

The connector will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: CreditnoteId is required in order to query CreditNoteInvoices.

• CreditnoteId supports the '=' comparison.

For example:

    SELECT * FROM CreditNoteInvoices WHERE CreditnoteId = '1895452000000083136'

Columns

Name	Type	References	SupportedOperators	Description
CreditnoteInvoiceId [KEY]	String			ID of credit note invoice.
CreditnoteId	String	CreditNotes.CreditnoteId		ID of a credit note.
Credited_amount	Decimal			Amount which is credit in credit note invoice.
CreditnoteNumber	String			Number of a credit note.
Date	Date			Date of an credit note invoice.
InvoiceId	String	Invoices.InvoiceId		ID of an invoice.
InvoiceNumber	String			Number of an invoice.

Retrieves details of line items from existing Credit Notes.

Table Specific Information

Select

The connector will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: CreditnoteId is required in order to query CreditNoteLineItems.

• CreditnoteId supports the '=' comparison.

For example:

    SELECT * FROM CreditNoteLineItems WHERE CreditnoteId = '1895452000000083136'

Columns

Name	Type	References	SupportedOperators	Description
CreditnoteId	String	CreditNotes.CreditnoteId		ID of credit note.
LineItemId [KEY]	String			ID of line item.
AccountId	String	BankAccounts.AccountId		ID of the Bank Account.
AccountName	String			Name of the account.
BcyRate	Decimal			Rate of Base Currency.
CustomFields	String			Custom Fields
Description	String			Description of the credit note line item.
Discount	String			Discount given to specific item in credit note.
DiscountAmount	Decimal			Amount of discount.
GstTreatmentCode	String			Treatement codes for GST.
HasProductTypeMismatch	Boolean			Check if the credit note item contains product type mismatch.
HsnOrSac	String			HSN Code.
ImageDocumentId	String			ID of image document.
InvoiceId	String	Invoices.InvoiceId		ID of an invoice.
InvoiceItemId	String			ID of an invoice item.
ItemId	String	Items.ItemId		ID of an item.
ItemOrder	Integer			Order of an item.
ItemTotal	Decimal			Total number of an item.
ItemType	String			Type of an item.
Name	String			Name of the credit note.
PricebookId	String			ID of price book.
ProductType	String			Type of product.
ProjectId	String	Projects.ProjectId		ID of project.
Quantity	Double			Quantity of items in credit note.
Rate	Decimal			Rate of the line item.
ReverseChargeTaxId	String			ID of the reverse charge tax.
Tags	String			Details of tags related to credit note line items.
TaxId	String	Taxes.TaxId		Id of tax.
TaxName	String			Name of the tax.
TaxPercentage	Integer			Percentage applied for tax.
TaxType	String			Type of tax.
Unit	String			Number of quantity.

Retrieves list of all the Credit Notes.

Table Specific Information

Select

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

• CreditnoteNumber supports the '=' comparison.
• CustomerId supports the '=' comparison.
• CustomerName supports the '=' comparison.
• Date supports the '=' comparison.
• ReferenceNumber supports the '=' comparison.
• Status supports the '=' comparison.
• Total supports the '=' comparison.
• CreditNoteFilter supports the '=' comparison.
• LineItemId supports the '=' comparison.
• TaxId supports the '=' comparison.
• ItemId supports the '=' comparison.
• ItemName supports the '=' comparison.
• ItemDescription supports the '=' comparison.

For example:

    SELECT * FROM CreditNotes WHERE CreditnoteNumber = 'CN-00006' AND ReferenceNumber = 'Ref-0075' AND CustomerName = 'AWS Stores'

    SELECT * FROM CreditNotes WHERE CreditNoteFilter = 'Status.All'

Columns

Name	Type	References	SupportedOperators	Description
CreditnoteId [KEY]	String			ID of credit note.
Balance	Decimal			Total amount of credit note left.
ColorCode	String			Color code of a credit note.
CreatedTime	Datetime			Time at which the credit note was created.
CreditnoteNumber	String			Number of a credit note.
CurrencyCode	String			Currency code of the customer's currency.
CurrencyId	String	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrentSubStatus	String			Current sub status of a credit note.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String			Name of the customer or vendor.
Date	Date			Date of a credit note.
HasAttachment	Boolean			Check if the credit note has attachment.
ReferenceNumber	String			Reference number of credit note.
Status	String			Status of the credit note. The allowed values are open, closed, void.
Total	Decimal			Total of credit notes.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
CreditNoteFilter	String		Filter credit notes by status. The allowed values are Status.All, Status.Open, Status.Draft, Status.Closed, Status.Void.
LineItemId	String		Id of a line item.
TaxId	String		Id of a tax.
ItemId	String		Id of an item.
ItemName	String		Name of an item.
ItemDescription	String		Description of an item.

Get list of currencies configured. Also, get the details of a currency.

Table Specific Information

Select

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

• CurrencyFilter supports the '=' comparison.
• CurrencyId supports the '=' comparison.

For example:

    SELECT * FROM Currencies WHERE CurrencyId = '1894553000000000099'

    SELECT * FROM Currencies WHERE CurrencyFilter = 'Currencies.ExcludeBaseCurrency'

Columns

Name	Type	References	SupportedOperators	Description
CurrencyId [KEY]	String			Currency ID of the customer's currency.
CurrencyName	String			Name of a currency.
CurrencyCode	String			Code of a currency.
CurrencyFormat	String			Format of a currency.
CurrencySymbol	String			Symbol of a currency.
EffectiveDate	Date			Date which the exchange rate is applicable for the currency.
ExchangeRate	Decimal			Exchange rate of the currency.
IsBaseCurrency	Boolean			Check of it is a base currency.
PricePrecision	Integer			The precision for the price.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
CurrencyFilter	String		Filter currencies excluding base currency. The allowed values are Currencies.ExcludeBaseCurrency.

Retrieves list of exchange rates configured for the currency.

Table Specific Information

Select

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

• FromDate supports the '=' comparison.
• IsCurrentDate supports the '=' comparison.
• CurrencyId supports the '=' comparison.

For example:

    SELECT * FROM CurrencyExchangeRates WHERE CurrencyId = '1894553000000000089'

    SELECT * FROM CurrencyExchangeRates WHERE CurrencyId = '1894553000000000087' AND IsCurrentDate = true

Columns

Name	Type	References	SupportedOperators	Description
CurrencyId [KEY]	String	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencyCode	String			Currency code of the customer's currency.
EffectiveDate	Date			Effective date for currency exchange.
IsMarketClosedRates	Boolean			Check if the rates are closed to markets.
Rate	Decimal			Rate of exchange for the currency with respect to base currency.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
FromDate	Date		Returns the exchange rate details from the given date or from previous closest match in the absence of the exchange rate on the given date.
IsCurrentDate	Boolean		To return the exchange rate only if available for current date.

Retrieves list of all contact persons. Also, get the contact person details.

Table Specific Information

Select

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

• ContactId supports the '=' comparison.
• CustomerContactId supports the '=' comparison.

For example:

    SELECT * FROM CustomerContacts WHERE ContactId = '1864553000000072009' AND CustomerContactId = '1896253000000071011'

Columns

Name	Type	References	SupportedOperators	Description
CustomerContactId [KEY]	String			ID of a contact person.
ContactId	String	Contacts.ContactId		Id of a contact.
ContactName	String			Display Name of the contact. Max-length [200].
CreatedTime	Datetime			Time at which the contact person was created.
CurrencyCode	String			Currency code used for this contact person.
Department	String			Department on which a person belongs. .
Designation	String			Designation of a person.
Email	String			Email ID of contact person.
Fax	String			Fax ID of contact person.
FirstName	String			First name of the contact person.
IsPrimaryContact	Boolean			Check if it is a primary contact.
LastName	String			Last name of contact person.
Mobile	String			Mobile number of a contact person.
Phone	String			Phone number of a contact person.
Salutation	String			Salutation of a contact person.
Skype	String			Skype ID of contact person.

Retrieves details of an existing payment.

Table Specific Information

Select

The connector will use the Zoho Books API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: PaymentId is required in order to query CustomerPaymentDetails.

• PaymentId supports the '=' comparison.

For example:

    SELECT * FROM CustomerPaymentDetails WHERE PaymentId = '1894553000000083001'

Columns

Name	Type	References	SupportedOperators	Description
PaymentId [KEY]	String	CustomerPayments.PaymentId		ID of a payment.
AccountId	String	BankAccounts.AccountId		ID of the Bank Account.
AccountName	String			Name of the account.
AccountType	String			Type of the account.
Amount	Decimal			Amount of the customer payments.
AttachmentName	String			Name of the attachment.
BankCharges	Decimal			Charges of bank.
CanSendInMail	Boolean			Check if the customer payment can be send in mail.
CanSendPaymentSms	Boolean			Check if the customer payment can send payment SMS.
CardType	String			Type of card.
CurrencyCode	String			Currency code of the customer's currency.
CurrencyId	String	Currencies.CurrencyId		Currency ID of the customer's currency.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String			Name of the customer or vendor.
Date	Date			Date of a customer payment.
Description	String			Description of the customer payment.
DiscountAmount	Decimal			Total discount amount applied in customer payment.
ExchangeRate	Decimal			Exchange rate of the currency.
IsClientReviewSettingsEnabled	Boolean			Check if the client review settings is enabled or not.
IsPaymentDetailsRequired	Boolean			Check if the payment details is required.
IsPreGst	Boolean			Check if pre GST is applied.
LastFourDigits	String			It store the last four digits of customer's card details.
OnlineTransactionId	String			ID of online transaction.
Orientation	String			Orientation of the page.
PageHeight	String			Height of the page.
PageWidth	String			Width of the page.
PaymentMode	String			Mode through which payment is made.
PaymentNumber	Integer			Number through which payment is made.
PaymentNumberPrefix	String			Prefix of the payment number.
PaymentNumberSuffix	String			Suffix of the payment number.
ProductDescription	String			Description of the product.
ReferenceNumber	String			Reference number of a customer payment.
SettlementStatus	String			Status of the settlement.
TaxAccountId	String	BankAccounts.AccountId		Account ID of tax.
TaxAccountName	String			Account name of tax.
TaxAmountWithheld	Decimal			Amount withheld for tax.
TemplateId	String			ID of a template.
TemplateName	String			Name of a template.
TemplateType	String			Type of a template.
UnusedAmount	Decimal			Unused amount of the customer payment.

Retrieves list of all the payments made by your customer.

Table Specific Information

Select

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

• PaymentMode supports the '=' comparison.
• Amount supports the '=,<,<=,>,>=' comparisons.
• CustomerName supports the '=' comparison.
• Date supports the '=' comparison.
• ReferenceNumber supports the '=' comparison.
• PaymentModeFilter supports the '=' comparison.
• Notes supports the '=' comparison.

For example:

    SELECT * FROM CustomerPayments WHERE Amount < 900 AND Amount > 50 AND ReferenceNumber = '1894553000000079879'

    SELECT * FROM CustomerPayments WHERE CustomerName = 'Harry'

    SELECT * FROM CustomerPayments WHERE CONTAINS(ReferenceNumber,'455')

Columns

Name	Type	References	SupportedOperators	Description
PaymentId [KEY]	String			Id of a payment.
AccountId	String	BankAccounts.AccountId		ID of the Bank Account.
PaymentMode	String			Mode through which payment is made.
PaymentNumber	Integer			Number through which payment is made.
PaymentType	String			Type of the payment.
AccountName	String			Name of the account.
Amount	Decimal		=, <, <=, >, >=	Amount of the customer payments.
BcyAmount	Decimal			Amount applied for Base Currency.
BcyRefundedAmount	Decimal			Refunded amount from Base Currency.
BcyUnusedAmount	Decimal			Unused amount from Base Currency.
CreatedTime	Datetime			Time at which the customer payment was created.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String			Name of the customer or vendor.
Date	Date			Date of a customer payment.
GatewayTransactionId	String			ID of gateway transaction.
HasAttachment	Boolean			Check if the customer payment has an attachment.
LastModifiedTime	Datetime			The time of last modification of the customer payment.
ReferenceNumber	String			Reference number of a customer payment.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
PaymentModeFilter	String		Filter customer payments by payment mode. The allowed values are PaymentMode.All, PaymentMode.Check, PaymentMode.Cash, PaymentMode.BankTransfer, PaymentMode.PayPal, PaymentMode.CreditCard, PaymentMode.GoogleCheckout, PaymentMode.Credit, PaymentMode.Authorizenet, PaymentMode.BankRemittance, PaymentMode.Payflowpro, PaymentMode.Stripe, PaymentMode.TwoCheckout, PaymentMode.Braintree, PaymentMode.Others.
Notes	String		Notes of customer payments.

Retrieves list of employees. Also, get the details of an employee.

Table Specific Information

Select

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

• EmployeeId supports the '=' comparison.
• Status supports the '=' comparison.

For example:

    SELECT * FROM Employees WHERE EmployeeId = '1894553000000068001' AND Status='All'

Columns

Name	Type	References	SupportedOperators	Description
EmployeeId [KEY]	String			Id of an employee.
Name	String			Name of an employee.
Email	String			Email address of an employee.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Status	String		Filter employee based on the status. The allowed values are All, Billable, Nonbillable, Reimbursed, Invoiced, Unbilled.

Get the details of approvers for estimates.

Table Specific Information

Select

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

• EstimateId supports the '=' comparison.

For example:

    SELECT * FROM EstimateApprovers WHERE EstimateId = '1894553000000077244'

Columns

Name	Type	References	SupportedOperators	Description
EstimateId	String	Estimates.EstimateId		ID of an estimate.
ApproverUserId [KEY]	String	Users.UserId		User ID of an approver.
Order	String			Order number.
ApproverName	String			Name of the approver.
Email	String			Email ID of the approver.
Has_approved	Boolean			Check if the User has approved the estimate.
ApprovalStatus	String			Status of an approval.
IsNextApprover	String			Check if it is a next approver.
SubmittedDate	Date			Date of submission.
ApprovedDate	Date			Date of approval.
PhotoUrl	String			Photo Url.
UserStatus	String			Status of a user.
IsFinalApprover	Boolean			Check if this is a final approver.