接続の確立

Sync App アプリケーションの接続ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Zoho Books への接続を作成します。Zoho Books アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからZoho Books コネクタをダウンロードおよびインストールします。

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

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 OAuth 認証の使用 for an authentication guide.

データアクセスのファインチューニング

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, ...).

高度な機能

このセクションでは、Zoho Books Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Zoho Books にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングでは、次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、より洗練されたロギングをサポートする多数の機能があります。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データモデル

Overview

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

Key Features

The Sync App 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 Sync App.
IncludeCustomFields connection property allows you to retrieve custom fields for supported views. Set this property to True, to enable this feature.

Tables

テーブル are statically defined to model Zoho Books entitites such as InvoiceDetails, ContactDetails, BillDetails, and more.

Views

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

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.

テーブル

Sync App はZoho Books のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。

一般的には、Zoho Books テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。

Zoho Books Connector for CData Sync テーブル


Name	Description
BankAccounts	To list, add, update and delete bank and credit card accounts for your organization.
BankRules	To list, add, update and delete specified bank or credit card account ID.
BankTransactions	To list, add, update and delete details involved in an account.
BaseCurrencyAdjustments	To list, add, update and delete base currency adjustment.
BillDetails	To list, add, update and delete details of a bill.
ChartOfAccounts	To list, add, update and delete chart of accounts.
ContactDetails	To list, add, update and delete a contact.
CreditNoteDetails	To list, add, update and delete a Credit Note.
Currencies	To list, add, update and delete currencies configured. Also, get the details of a currency.
CustomerContacts	Create, Read, Update, Delete contact persons. Also, get the contact person details.
CustomerPaymentDetails	To list, add, update and delete details of a payment.
CustomerPaymentsRefund	Read, Insert and Update Vendor Credit Refunds.
EstimateDetails	To list, add, update and delete details of an estimate.
ExpenseDetails	To list, add, update and delete details of an Expense.
InvoiceDetails	To list, add, update and delete details of an invoice.
ItemDetails	To list, add, update and delete details of an existing item.
Journals	To list, add, update and delete journals.
OpeningBalances	To list, add, update and delete opening balance.
Projects	To list, add, update and delete projects.
PurchaseOrderDetails	To list, add, update and delete details of a purchase order.
RecurringBillDetails	To list, add, update and delete details of a bill.
RecurringExpenseDetails	To list, add, update and delete details of a recurring expense.
RecurringInvoiceDetails	To list, add, update and delete details of a recurring invoice.
RetainerInvoiceDetails	To list, add, update and delete of a retainer invoice.
SalesOrderDetails	To list, add, update and delete a sales order.
Tasks	To list, add, update and delete tasks added to a project. Also, get the details of a task.
Taxes	To list, add, update and delete simple and compound taxes. Also, get the details of a simple or compound tax.
TaxGroups	Read, Insert, Update and Delete Tax Groups.
TimeEntries	To list, add, update and delete time entries.
Users	To list, add, update and delete users in the organization. Also, get the details of a user.
VendorCreditDetails	To list, add, update and delete details of a vendor credit.
VendorCreditRefund	Read, Insert and Update Vendor Credit Refunds.
VendorPaymentDetails	To list, add, update and delete details of a Vendor Payment.
VendorPaymentsRefund	Read, Insert and Update Vendor Credit Refunds.

BankAccounts

To list, add, update and delete bank and credit card accounts for your organization.

Table Specific Information

Select

The Sync App 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 Sync App.

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'

Insert

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

INSERT INTO BankAccounts (AccountName, AccountType) VALUES ('testaccount1','bank')

Update

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

UPDATE BankAccounts SET AccountName = 'Test Account', AccountType='bank' WHERE AccountId = '3285934000000264001'

Delete

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

DELETE FROM BankAccounts WHERE AccountId = '3285934000000264001'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
AccountId [KEY]	String	True			Id of the Bank Account.
AccountCode	String	False			Code of the Account.
AccountName	String	False			Name of the account.
AccountType	String	False			Type of the account.
AccountNumber	String	False			Number associated with the Bank Account.
Balance	Decimal	True			The unpaid amount.
BankBalance	Decimal	True			Total balance in Bank.
BankName	String	False			Name of the Bank.
BcyBalance	Decimal	True			Balance of Base Currency.
CanShowInZe	Boolean	True			Check if it can show in Zero Emission.
CanShowPaypalDirectIntegBanner	Boolean	True			Check if it can show direct integ banner.
CurrencyCode	String	False			Currency code of the customer's currency.
CurrencyId	String	False	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String	True			Currency symbol of the customer's currency.
Description	String	False			Description of the Account.
IsActive	Boolean	True			Check if bank account is active.
IsDirectPaypal	Boolean	True			Check if bank account is direct by paypal.
IsPrimaryAccount	Boolean	False			Check if the Account is Primary Account in Zoho Books.
IsPaypalAccount	Boolean	False			Check if the Account is Paypal Account.
PricePrecision	Integer	True			The precision for the price.
PaypalType	String	False			The type of Payment for the Paypal Account. Allowed Values : standard and adaptive.
PaypalEmailAddress	String	False			Email Address of the Paypal account.
RoutingNumber	String	False			Routing Number of the Account.
TotalUnprintedChecks	Integer	True			Total number of unprinted checks.
UncategorizedTransactions	Integer	True			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.

使用できる値は次のとおりです。All, PartiallyPaid, Paid, Overdue, Void, Open

BankRules

To list, add, update and delete specified bank or credit card account ID.

Table Specific Information

Select

The Sync App 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 Sync App.

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

For example:

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

Columns


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

BankTransactions

To list, add, update and delete details involved in an account.

Table Specific Information

Select

The Sync App 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 Sync App.

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

Insert

Insert can be executed by specifying TransactionType,FromAccountId, ToAccountId,Amount,CurrencyId columns. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.

INSERT INTO BankTransactions (TransactionType,FromAccountId, ToAccountId,Amount,CurrencyId) VALUES ('transfer_fund','3285934000000000361','3285934000000256009','500','3285934000000000099')

Update

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

UPDATE BankTransactions SET Amount = '300',TransactionType='transfer_fund' WHERE TransactionId = '3285934000000269001'

Delete

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

DELETE FROM BankTransactions WHERE TransactionId = '3285934000000269001'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
TransactionId [KEY]	String	True			Id of the Transaction.
TransactionType	String	True			Transaction Type of the transaction. 使用できる値は次のとおりです。deposit, refund, transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return
AccountId	String	True	BankAccounts.AccountId		Account id for which transactions are to be listed.
AccountName	String	True			Name of the account.
AccountType	String	True			Type of the account.
Amount	Decimal	False			Start and end amount, to provide a range within which the transaction amount exist.
CurrencyCode	String	True			Currency code of the customer's currency.
CurrencyId	String	False	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String	True			Currency symbol of the customer's currency.
CustomerId	String	False	Contacts.ContactId		ID of the customer or vendor.
CustomFields	String	False			Custom fields of the contact.
Date	Date	False			Start and end date, to provide a range within which the transaction date exist.
DebitOrCredit	String	True			Indicates if transaction is Credit or Debit.
Description	String	False			Description of the bank transactions.
Documents	String	False			List of files to be attached to a particular transaction.
ExcludeDescription	String	True			Is the description is to be excluded.
ImportedTransactionId	Long	True			ID of the Imported Transaction.
IsOffsetaccountMatched	Boolean	True			Check if Offset Account is matched.
IsPaidViaPrintCheck	Boolean	True			Check if paid via print check.
IsRuleExist	Boolean	True			Check if rule exists.
OffsetAccountName	String	True			Name of the offset account.
Payee	String	True			Information about the payee.
PricePrecision	Integer	True			The precision for the price.
ReferenceNumber	String	False			Reference Number of the transaction.
RunningBalance	String	True			Running balance in bank.
Source	String	True			Source of the bank transaction.
Status	String	True			Transaction status wise list view. 使用できる値は次のとおりです。All, uncategorized, manually_added, matched, excluded, categorized
UserId	Long	False	Users.UserId		ID of the User involved in the Transaction.
VendorId	String	True			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	True			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	False			Bank charges of bank transactions. This field will be populated with a value only when the Transaction Id is specified.
BcyTotal	Decimal	True			Total Base Currency This field will be populated with a value only when the Transaction Id is specified.
CustomerName	String	True			Name of the customer or vendor. This field will be populated with a value only when the Transaction Id is specified.
ExchangeRate	Decimal	False			Exchange rate of a bank transaction. This field will be populated with a value only when the Transaction Id is specified.
FromAccountId	String	False	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.
FromAccountTags	String	False			From Account Tags
FromAccountId	String	False	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.
ImportedTransactions	String	True			Imported bank transations. This field will be populated with a value only when the Transaction Id is specified.
IsInclusiveTax	Boolean	False			Check if bank transaction is invlusive tax. This field will be populated with a value only when the Transaction Id is specified.
IsPreGst	Boolean	True			Check if bank transaction is pre GST. This field will be populated with a value only when the Transaction Id is specified.
PaymentMode	String	False			Mode through which payment is made. This field will be populated with a value only when the Transaction Id is specified.
SubTotal	Decimal	True			Sub total of bank transactions This field will be populated with a value only when the Transaction Id is specified.
Tags	String	False			Details of tags related to bank transactions. This field will be populated with a value only when the Transaction Id is specified.
TaxAmount	Decimal	True			Amount of tax. This field will be populated with a value only when the Transaction Id is specified.
TaxId	String	False	Taxes.TaxId		Id of tax. This field will be populated with a value only when the Transaction Id is specified.
TaxName	String	True			Name of tax. This field will be populated with a value only when the Transaction Id is specified.
TaxPercentage	Integer	True			Percentage of tax. This field will be populated with a value only when the Transaction Id is specified.
ToAccountId	String	False	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	True			Account name the transaction was made to. This field will be populated with a value only when the Transaction Id is specified.
Total	Decimal	True			Total of bank transactions. This field will be populated with a value only when the Transaction Id is specified.
ToAccountTags	String	False			To Account Tags
TransactionType	String	False			Type 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

BankTransactionFilter

String

Filters the transactions based on the allowed types.

使用できる値は次のとおりです。Status.All, Status.Uncategorized, Status.Categorized, Status.ManuallyAdded, Status.Excluded, Status.Matched

BaseCurrencyAdjustments

To list, add, update and delete base currency adjustment.

Table Specific Information

Select

The Sync App 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 Sync App. 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	ReadOnly	References	SupportedOperators	Description
BaseCurrencyAdjustmentId [KEY]	String	True			Id of a base currency adjustment.
CurrencyCode	String	True			Currency code of the customer's currency.
CurrencyId	String	False	Currencies.CurrencyId		Currency ID of the customer's currency.
AdjustmentDate	Date	False			Date of currency adjustment.
ExchangeRate	Decimal	False			Exchange rate of currency adjustment.
GainOrLoss	Decimal	True			Check the amount if gain or loss.
Notes	String	False			Notes of Base cuurrency adjustments.
AccountIds	String	False	BankAccounts.AccountId		ID of the accounts for which base currency adjustments need to be posted.

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.

使用できる値は次のとおりです。Date.All, Date.Today, Date.ThisWeek, Date.ThisMonth, Date.ThisQuarter, Date.ThisYear

BillDetails

To list, add, update and delete details of a bill.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: BillId is required in order to query BillDetails.

BillId supports the '=' comparison.

For example:

    SELECT * FROM BillDetails WHERE BillId = '1894553000000085259'

Insert

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

Insert INTO BillLineItems#TEMP(Name,accountid,itemid) values('Cloth-Jeans','3285934000000034001','3285934000000104097')

INSERT INTO BillDetails (BillNumber,VendorId,lineitems) VALUES ('00011','3285934000000104023',BillLineItems#TEMP)

Update

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

Insert INTO BillLineItems#TEMP(Name,accountid,itemid) values('Cloth-Jeans','3285934000000034001','3285934000000104097')

UPDATE BillDetails SET BillNumber='00011',VendorId='3285934000000104023',lineitems='BillLineItems#TEMP' WHERE BillId='3350895000000089001'

Delete

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

DELETE FROM BillDetails WHERE BillId = '3350895000000089001'

Columns


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

ChartOfAccounts

To list, add, update and delete chart of accounts.

Table Specific Information

Select

The Sync App 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 Sync App. 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

Insert

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

Insert INTO ChartOfAccounts(AccountName,AccountType,CurrencyId) values('Cash3','Assets','3285934000000000099')

Update

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

Update ChartOfAccounts set AccountName='Cash4',AccountType='Cash',CurrencyId='3285934000000000099' where ChartAccountId='3285934000000281053'

Delete

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

DELETE FROM ChartOfAccounts WHERE ChartAccountId = '32859340000002810531'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
ChartAccountId [KEY]	String	True	BankAccounts.AccountId		Id of the Bank Account.
AccountName	String	False			Name of the account.
AccountType	String	False			Type of the account. 使用できる値は次のとおりです。All, Active, Inactive, Asset, Liability, Equity, Income, Expense
CanShowInZe	Boolean	False			Check if it can show in Zero Emission.
ChildCount	String	True			Child count in chart of accounts.
CreatedTime	Datetime	True			Time at which the Chart of Accounts was created.
CustomFields	String	True			Custom Fields defined for the chart of account
CurrencyId	String	False	Currencies.CurrencyId		Currency ID of the customer's currency.
Depth	Integer	True			Depth of account.
Description	String	False			Description of the Chart of Account.
HasAttachment	Boolean	True			Check if the chart of account has attachment.
IsActive	Boolean	True			Check if chart of account is active.
IsChildPresent	Boolean	True			Check if the child is present in chart of account.
IsStandaloneAccount	Boolean	True			Check if the account is standalone account.
IsUserCreated	Boolean	True			Check if the account is created by the user.
LastModifiedTime	Datetime	True			Last Modified time associated with the entity.
ParentAccountName	String	True			Account name of parent.
AccountCode	String	False			Code of the Account.
ClosingBalance	Decimal	True			Closing balance of account. This field will be populated with a value only when the Chart Account Id is specified.
IsInvolvedInTransaction	Boolean	True			Check if this account is involved in the transaction.
IsSystemAccount	Boolean	True			Check if it is a system account.
IsDebit	Boolean	True			Check if this account is debit. This field will be populated with a value only when the Chart Account Id is specified.
IncludeInVatReturn	Boolean	False			Boolean to include an account in VAT returns.
ParentAccountId	String	False	BankAccounts.AccountId		Id of a Parent account.
ShowOnDashboard	Boolean	False			Show on dashboard.

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.

ContactDetails

To list, add, update and delete a contact.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: ContactId is required in order to query ContactDetails.

ContactId supports the '=' comparison.

For example:

    SELECT * FROM ContactDetails WHERE ContactId = '1894952000000071009'

Insert

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

INSERT INTO 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	True			Check if ACH is supported.
AssociatedWithSquare	Boolean	True			Check if the contact is associated with square.
BillingAddress	String	False			Billing address of a contact.
BillingAddressId	String	True	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	True			Check if contact can show customer ob.
CanShowVendorOb	Boolean	True			Check if contact can show vendor ob.
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	True			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.
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.
IsPortalEnabled	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	False			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.
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	True			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.
Website	String	False			Link of a website.

CreditNoteDetails

To list, add, update and delete a Credit Note.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: CreditnoteId is required in order to query CreditNoteDetails.

CreditnoteId supports the '=' comparison.

For example:

    SELECT * FROM CreditNoteDetails WHERE CreditnoteId = '1895452000000083136'

Insert

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

Insert INTO CreditNoteLineItems#TEMP(Name,accountid,itemid) values('Cloth-Jeans','3285934000000034001','3285934000000104097')

INSERT INTO CreditNoteDetails (customerid,date,lineitems,creditnotenumber) VALUES ('3285934000000085043','2023-01-18',CreditNoteLineItems#Temp,'CN-100')

Update

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

Insert INTO CreditNoteLineItems#TEMP(Name,accountid,itemid) values('Cloth-Jeans1','3285934000000034001','3285934000000104097')

Update CreditNoteDetails set customerid='3285934000000085043',date='2023-01-17',lineitems='CreditNoteLineItems#Temp' where creditnoteid='3285934000000265005'

Delete

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

DELETE FROM CreditNoteDetails WHERE CreditnoteId = '3285934000000265005'

Columns


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

Currencies

To list, add, update and delete currencies configured. Also, get the details of a currency.

Table Specific Information

Select

The Sync App 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 Sync App.

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

For example:

    SELECT * FROM Currencies WHERE CurrencyId = '1894553000000000099'

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

Insert

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

INSERT INTO Currencies (currencycode,currencyformat) VALUES ('AUD','1,234,567.89')

Update

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

UPDATE Currencies SET CurrencyCode = 'AUD',CurrencyFormat='1,234,567.89', PricePrecision='2' WHERE CurrencyId = '3285934000000000105'

Delete

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

DELETE FROM Currencies WHERE CurrencyId = '3285934000000000105'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
CurrencyId [KEY]	String	True			Currency Id of the customer's currency.
CurrencyName	String	True			Name of a currency.
CurrencyCode	String	False			Code of a currency.
CurrencyFormat	String	False			Format of a currency.
CurrencySymbol	String	False			Symbol of a currency.
EffectiveDate	Date	True			Date which the exchange rate is applicable for the currency.
ExchangeRate	Decimal	True			Exchange rate of the currency.
IsBaseCurrency	Boolean	True			Check of it is a base currency.
PricePrecision	Integer	False			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.

使用できる値は次のとおりです。Currencies.ExcludeBaseCurrency

CustomerContacts

Create, Read, Update, Delete contact persons. Also, get the contact person details.

Table Specific Information

Select

The Sync App 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 Sync App.

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

For example:

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

Insert

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

INSERT INTO CustomerContacts (FirstName,CONTACTID) VALUES ('customercontactspersons','3285934000000085043')

Update

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

UPDATE CUSTOMERCONTACTS SET CONTACTID='3285934000000085043', LASTNAME='TEST' where customercontactid='3285934000000266024'

Delete

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

DELETE FROM CUSTOMERCONTACTS WHERE CustomerContactId = '3285934000000266024'

Columns


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

CustomerPaymentDetails

To list, add, update and delete details of a payment.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: PaymentId is required in order to query CustomerPaymentDetails.

PaymentId supports the '=' comparison.

For example:

    SELECT * FROM CustomerPaymentDetails WHERE PaymentId = '1894553000000083001'

Insert

Insert can be executed by specifying CustomerId,PaymentMode,Amount,Date,InvoiceId,AmountApplied columns. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.

INSERT INTO CustomerPaymentDetails (customerid,paymentmode,amount,date,invoiceid,amountapplied) VALUES ('3285934000000104002','cash','1999','2023-01-18','3285934000000220356','1999')

Update

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

UPDATE CustomerPaymentDetails SET CustomerId='3285934000000104002',PaymentMode='bank',Amount='1999',Date='2023-01-18',InvoiceId='3285934000000220356',AmountApplied='1999' WHERE PaymentId = '3285934000000269021'

Delete

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

DELETE FROM CustomerPaymentDetails WHERE PaymentId = '3285934000000269021'

Columns


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

CustomerPaymentsRefund

Read, Insert and Update Vendor Credit Refunds.

Table Specific Information

Select

The Sync App 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 Sync App.

PaymentId supports the '=' comparison.
PaymentRefundId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CustomerPaymentsRefund

SELECT * FROM CustomerPaymentsRefund WHERE PaymentId = '3350895000000089001'

SELECT * FROM CustomerPaymentsRefund WHERE PaymentRefundId = '3285934000000441001'

Insert

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

INSERT INTO CustomerPaymentsRefund (Date,Amount,FromAccountId,PaymentId) VALUES ('2023-02-27','1200',3285934000000259036,3285934000000312117)

Update

Update can be executed by specifying the Amount,Date and AccountId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE CustomerPaymentsRefund SET Description = 'test2' where PaymentRefundId=3285934000000439001 and PaymentId=3285934000000234015

Delete

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

Delete from CustomerPaymentsRefund where PaymentRefundId=3285934000000439001 and PaymentId=3285934000000234015

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
PaymentRefundId [KEY]	String	True		=	Payment Refund Id
PaymentId [KEY]	String	False	CustomerPayments.PaymentId	=	Payment Id
Amount	Integer	False			Amount
FromAccountId	String	False			From Account Id
AmountBcy	Integer	True			Amount BCY
AmountFcy	Integer	True			Amount FCY
CustomerName	String	True			Customer Name
Date	Date	False			Date
Description	String	False			Description
ExchangeRate	Decimal	False			Exchange Rate
ReferenceNumber	String	False			Reference Number
RefundMode	String	False			Refund Mode
PaymentForm	String	False			Payment Form
PaymentNumber	String	True			Payment Number

EstimateDetails

To list, add, update and delete details of an estimate.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: EstimateId is required in order to query EstimateDetails.

EstimateId supports the '=' comparison.

For example:

    SELECT * FROM EstimateDetails WHERE EstimateId = '1894553000000077244'

Insert

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

Insert INTO EstimateLineItems#TEMP(Name,itemid) values('Cloth-Jeans1','3285934000000104097')

INSERT INTO EstimateDetails (Customerid,lineitems) VALUES ('3285934000000104002',EstimateLineItems#Temp)

Update

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

Insert INTO EstimateLineItems#TEMP(Name,itemid) values('Cloth-Jeans12','3285934000000104097')

UPDATE EstimateDetails SET Customerid = '3285934000000104002',lineitems='EstimateLineItems#Temp'  WHERE EstimateId = '3285934000000263048'

Delete

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

DELETE FROM EstimateDetails WHERE EstimateId = '3285934000000263048'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
EstimateId [KEY]	String	True	Estimates.EstimateId		Id of an estimate.
Adjustment	Decimal	False			Adjustments made to the estimate.
AdjustmentDescription	String	False			Description of adjustments made to the estimate.
AllowPartialPayments	Boolean	True			Check if estimate allows partial payments.
ApproverId	String	True	Users.UserId		Id of an approver.
AttachmentName	String	True			Name of the attachment.
AvataxUseCode	String	False			Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule.
AvataxExemptNo	String	False			Exemption certificate number of the customer.
BcyAdjustment	Decimal	True			Adjustment made for base currency.
BcyDiscountTotal	Decimal	True			Total amount get on discount for base currency.
BcyShippingCharge	Decimal	True			Shipping charge applied for base currency.
BcySubTotal	Decimal	True			Sub total of base currency.
BcyTaxTotal	Decimal	True			Total tax applied for the base currency.
BcyTotal	Decimal	True			Total Base Currency.
BillingAddress	String	True			Billing address of a estimate.
BillingAddressAttention	String	True			Name of a person in billing address.
BillingAddressCity	String	True			City of a billing address.
BillingAddressCountry	String	True			Country of a billing address.
BillingAddressFax	String	True			Fax of a billing address.
BillingAddressPhone	String	True			Phone number of a billing address.
BillingAddressState	String	True			State of a billing address.
BillingAddressStreet2	String	True			Street two of a billing address.
BillingAddressZip	String	True			ZIP code of a billing address.
CanSendInMail	Boolean	True			Check if the estimate can be send in mail.
ClientViewedTime	Datetime	True			Time when client viewed the estimate.
ColorCode	String	True			Color code for estimate.
ContactPersons	String	False			Contact persons of a contact.
ContactCategory	String	True			Category for contact.
CreatedById	String	True	Users.UserId		Id of a user who has created estimate.
CreatedTime	Datetime	True			Time at which the estimate was created.
CustomFields	String	False			Custom fields of the contact.
CurrencyCode	String	True			Currency code of the customer's currency.
CurrencyId	String	True	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String	True			Currency symbol of the customer's currency.
CurrentSubStatus	String	True			Current sub status of an estimate .
CurrentSubStatusId	String	True			Current sub status ID of an estimate .
CustomerDefaultBillingAddress	String	True			Customer default billing address of an estimate.
CustomerDefaultBillingAddressCity	String	True			City of a customer default billing address.
CustomerDefaultBillingAddressCountry	String	True			Country of a customer default billing address.
CustomerDefaultBillingAddressFax	String	True			Fax of a customer default billing address.
CustomerDefaultBillingAddressPhone	String	True			Phone number of a customer default billing address.
CustomerDefaultBillingAddressState	String	True			State of a customer default billing address.
CustomerDefaultBillingAddressStateCode	String	True			State code of a customer default billing address.
CustomerDefaultBillingAddressStreet2	String	True			Street two of a customer default billing address.
CustomerDefaultBillingAddressZip	String	True			ZIP code of a customer default billing address.
CustomerId	String	False	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String	True			Name of the customer or vendor.
Date	Date	False			Date of an estimate.
Description	String	False			The description of the line items.
Discount	String	False			Discount applied for estimate.
DiscountAppliedOnAmount	Decimal	True			Discount applied on amount for estimate.
DiscountPercent	Decimal	True			Percent of discount applied for estimate.
DiscountTotal	Decimal	True			Total discount applied for estimate.
DiscountType	String	False			Type of discount applied for estimate.
EstimateNumber	String	False			Number of estimate.
EstimateUrl	String	True			URL of estimate.
ExchangeRate	Decimal	False			Exchange rate of the currency.
ExpiryDate	Date	False			Expiration date of estimate.
ItemId	String	False	Items.ItemId		ID of the customer or vendor.
InvoiceConversionType	String	True			Conversion type of an invoice in estimate.
IsConvertedToOpen	Boolean	True			Check if the estimate is converted to open.
IsDiscountBeforeTax	Boolean	False			Check if the discount is applied before tax. .
IsInclusiveTax	Boolean	False			Check if the expense is inclusive tax.
IsPreGst	Boolean	True			Check if estimate includes pre GST.
IsTransactionCreated	Boolean	True			Check if the transaction os created for estimate.
IsViewedByClient	Boolean	True			Check if the estimate is viewed by client.
LastModifiedById	String	True	Users.UserId		Id of the user last modified.
LastModifiedTime	Datetime	True			The time of last modification of the estimate.
LineItems	String	False			Line items of an estimate.
LineItemId	String	False			ID of the line item. Mandatory, if the existing line item has to be updated. If empty, a new line item will be created.
Notes	String	False			Notes of Estimate.
Name	String	False			The name of the line item.
Orientation	String	True			Orientation of page.
PageHeight	String	True			Height of page.
PageWidth	String	True			Width of page.
PricePrecision	Integer	True			The precision for the price.
ProjectId	String	False			Id of a project.
ProjectName	String	True			Name of a project.
ProjectCustomerId	String	True			Id of a customer.
ProjectCustomerName	String	True			Name of a customer.
ProjectDescription	String	True			Details about the project.
ProjectStatus	String	True			Status of the project.
ProjectBillingType	String	True			Type of billing.
ProjectRate	Decimal	True			Overall rate of the project.
Quantity	Decimal	False			The quantity of line item.
Rate	Decimal	False			Rate of the line item.
ReferenceNumber	String	False			Reference number of estimates.
PlaceOfSupply	String	False			The place of supply is where a transaction is considered to have occurred for VAT purposes.
TaxSpecification	String	True			Working of tax when specifying special tax options and tax methods for earnings codes.
VatTreatment	String	False			VAT treatment for the estimates.
IsTaxable	Boolean	True			Check if estimate is taxble.
GstNo	String	False			GST number.
GstTreatment	String	False			Choose whether the estimate is GST registered/unregistered/consumer/overseas. .
TaxTreatment	String	False			VAT treatment for the Estimate.
ReverseChargeTaxTotal	String	True			Total amount of tax reverse charge.
CanSendEstimateSms	String	True			Check if the estimate can send the estimate SMS.
RetainerPercentage	String	True			Percentage of the retainer in estimate.
AcceptRetainer	Boolean	True			Check if estimate can accept the retainer.
RoundoffValue	Decimal	True			Rounding off the values to precise number.
SalespersonId	String	True			ID of a sales person.
SalespersonName	String	False			Name of a sales person.
ShippingAddress	String	True			Shipment Address.
ShippingAddressAttention	String	True			Name of a person of shipping address.
ShippingAddressCity	String	True			City of a shipping address.
ShippingAddressCountry	String	True			Country of a shipping address.
ShippingAddressFax	String	True			Fax of a shipping address.
ShippingAddressPhone	String	True			Phone number of a shipping address.
ShippingAddressState	String	True			State of a shipping address.
ShippingAddressStreet2	String	True			Street two of a shipping address.
ShippingAddressZip	String	True			Zip of a shipping address.
ShippingCharge	Decimal	False			Shipping charge of estimates.
Status	String	True			Status of the estimate.
SubTotal	Decimal	True			Sub total of estimates.
SubTotalExclusiveOfDiscount	Decimal	True			Subtotal amount which are exclusive of discount.
SubTotalInclusiveOfTax	Decimal	True			Subtotal amount which are inclusive of tax.
SubmittedBy	String	True			Detail of the user who has submitted the estimate.
SubmittedDate	Date	True			Date when estimate was submitted.
SubmitterId	String	True	Users.UserId		ID of the submitter.
TaxId	String	False	Taxes.TaxId		Id of the tax
TaxTotal	Decimal	True			Total amount of tax.
TemplateId	String	False			ID of a template.
TemplateName	String	True			Name of a template.
TemplateType	String	True			Type of a template.
Terms	String	False			Terms and Conditions apply of a estimate.
Total	Decimal	True			Total of estimates.
TransactionRoundingType	String	True			Type of round off used for transaction.
Unit	String	False			Unit of the line item e.g. kgs, Nos.

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
Send	Boolean	Send the invoice to the contact person(s) associated with the invoice. Allowed values true and false.

ExpenseDetails

To list, add, update and delete details of an Expense.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: ExpenseId is required in order to query ExpenseDetails.

ExpenseId supports the '=' comparison.

For example:

    SELECT * FROM ExpenseDetails WHERE ExpenseId = '1894553000000077244'

Insert

Insert can be executed by specifying AccountId,Date,Amount,PaidThroughAccountId columns. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.

Insert INTO ExpenseDetails(AccountId,Date,Amount,PaidThroughAccountId) values('3285934000000000409','2023-01-19','500','3285934000000259036')

Update

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

Update ExpenseDetails set AccountId='3285934000000000409',Date='2023-01-19',Amount='300',PaidThroughAccountId='3285934000000259036' where ExpenseId='3285934000000262014'

Delete

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

DELETE FROM ExpenseDetails WHERE ExpenseId = '3285934000000262014'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
ExpenseId [KEY]	String	True	Expenses.ExpenseId		Id of an expense.
AccountId	String	False	BankAccounts.AccountId		ID of the Bank Account.
AccountName	String	True			Name of the account.
Amount	Decimal	False			Amount of the expenses.
ApproverEmail	String	True			Email of an approver.
ApproverId	String	True	Users.UserId		Id of an approver.
ApproverName	String	True			Name of an approver.
AcquisitionVatId	String	False			This is the ID of the tax applied in case this is an EU - goods expense and acquisition VAT needs to be reported.
BcySurchargeAmount	Decimal	True			Surcharge amount of Base Currency.
BcyTotal	Decimal	True			Total Base Currency.
CanReclaimVatOnMileage	String	False			To specify if tax can be reclaimed for this mileage expense.
CreatedById	String	True	Users.UserId		Id of a user who has created expense.
CreatedTime	Datetime	True			Time at which the Expense was created.
CurrencyCode	String	True			Currency code of the customer's currency.
CurrencyId	String	False	Currencies.CurrencyId		Currency ID of the customer's currency.
CustomerId	String	False	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String	True			Name of the customer or vendor.
CustomFields	String	False			Custom fields of the contact.
Date	Date	False			Expense date.
Description	String	False			Description of the expense.
DestinationOfSupply	String	False			Place where the goods/services are supplied to. (If not given, organisation's home state will be taken).
Distance	String	False			Distance travelled for a particular mileage expense where mileage_type is manual
EmployeeEmail	String	True			Email ID of an employee.
EmployeeId	String	False	Employees.EmployeeId		ID of an employee.
EmployeeName	String	True			Name of an employee.
EndReading	String	False			End Reading of the Odometer.
ExchangeRate	Decimal	False			Exchange rate of the currency.
ExpenseItemId	String	True			Item ID of an expense.
ExpenseReceiptName	String	True			Receipt name of an expense.
ExpenseReceiptType	String	True			Receipt type of an expense.
ExpenseType	String	True			Type of expense.
EngineCapacityRange	String	False			Engine capacity range for a particular mileage expense. Allowed Values: less_than_1400cc, between_1400cc_and_1600cc, between_1600cc_and_2000cc and more_than_2000cc.
HSNORSAC	String	False			Add HSN/SAC code for your goods/services.
FcySurchargeAmount	Decimal	True			Surcharge amount of Foreign Currency.
FuelType	String	False			Fuel type for a particular mileage expense. Allowed Values: petrol, lpg and diesel
GstNo	String	False			GST number used for credit note.
InvoiceConversionType	String	True			Type of invoice conversion.
InvoiceId	String	True	Invoices.InvoiceId		ID of an invoice.
InvoiceNumber	String	True			Number of an invoice.
IsBillable	Boolean	False			Check if the expense is billable.
IsInclusiveTax	Boolean	False			Check if the expense is inclusive tax.
IsPersonal	Boolean	True			Check if the expense is personal.
IsPreGst	Boolean	True			Check if the pre GST is applied in the expense.
IsRecurringApplicable	Boolean	True			Check if the recurring is applicable.
IsReimbursable	Boolean	True			Check if the expense is reimbursable.
IsSurchargeApplicable	Boolean	True			Check if the surcharge is applicable in this expense.
LastModifiedById	String	True	Users.UserId		Id of the user last modified.
LastModifiedTime	Datetime	True			The time of last modification of the expense.
LineItems	String	False			Line items of an estimate.
Location	String	True			Location of the expense.
MerchantId	String	True			ID of the merchant.
MerchantName	String	True			Name of the merchant.
MileageRate	Double	False			Mileage rate for a particular mileage expense.
MileageType	String	False			Type of Mileage.
MileageUnit	String	False			Unit of the distance travelled.
PaidThroughAccountId	String	False	BankAccounts.AccountId		Account ID from which expense amount was paid.
PaidThroughAccountName	String	True			Account name from which expense amount was paid.
PaymentMode	String	True			Mode through which payment is made.
ProjectId	String	False	Projects.ProjectId		ID of the project.
ProjectName	String	True			Name of the project.
ProductType	String	False			Type of the expense. This denotes whether the expense is to be treated as a goods or service purchase.
PlaceOfSupply	String	False			The place of supply is where a transaction is considered to have occurred for VAT purposes.
ReferenceNumber	String	False			Reference number of expense.
ReportId	String	True			ID of the report.
ReportName	String	True			Name of the report.
ReportNumber	String	True			Number of the report.
ReportStatus	String	True			Status of the report.
ReverseChargeVatId	String	False			This is the ID of the tax applied in case this is a non UK - service expense and reverse charge VAT needs to be reported.
ReverseChargeTaxId	String	False			ID of the reverse charge tax.
StartReading	String	False			Start Reading of the Odometer.
Status	String	True			Status of the expense.
SubTotal	Decimal	True			Sub total of expenses.
SourceOfSupply	String	False			Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken).
Tags	String	True			Details of tags related to expenses.
TaxAmount	Decimal	True			Amount of tax.
TaxId	String	False	Taxes.TaxId		Id of tax.
TaxName	String	True			Name of tax.
TaxPercentage	Integer	True			Percentage of tax.
Total	Decimal	True			Total of expenses.
TransactionType	String	True			Type of the Transaction.
TripId	String	True			ID of a trip.
TripNumber	String	True			Number of a trip.
UserEmail	String	True			Email ID of a User.
UserId	String	True	Users.UserId		ID of a user.
UserName	String	True			Name of a user.
VehicleId	String	True			ID of a vehicle.
VehicleType	String	False			Vehicle type for a particular mileage expense. Allowed Values: car, van, motorcycle and bike.
VehicleName	String	True			Name of a vehicle.
VendorId	String	False			ID of the vendor the expenses has been made.
VendorName	String	True			Name of the vendor the expenses has been made.
VatTreatment	String	False			VAT treatment for the estimates.
TaxTreatment	String	False			VAT treatment for the Estimate.

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
Receipt	String	Expense receipt file to attach. Allowed Extensions: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc and docx.

InvoiceDetails

To list, add, update and delete details of an invoice.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: InvoiceId is required in order to query InvoiceDetails.

InvoiceId supports the '=' comparison.

For example:

    SELECT * FROM InvoiceDetails WHERE InvoiceId = '1864543000000078539'

Insert

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

Insert INTO InvoiceLineItems#TEMP(Name,itemid) values('Cloth-Jeans12','3285934000000104097')

INSERT INTO InvoiceDetails (Customerid,lineitems) VALUES ('3285934000000104002',InvoiceLineItems#Temp)

Update

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

Insert INTO InvoiceLineItems#TEMP(Name,itemid) values('Cloth-Jeans2','3285934000000104097')

"UPDATE InvoiceDetails SET Customerid = '3285934000000104002',lineitems='InvoiceLineItems#Temp'  WHERE InvoiceId = '3285934000000264005'

Delete

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

DELETE FROM InvoicesDetails WHERE InvoiceId = '3285934000000264005'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
InvoiceId [KEY]	String	True	Invoices.InvoiceId		Id of an invoice.
InvoiceNumber	String	False			Number of an invoice.
InvoiceUrl	String	True			URL of an invoice.
AchPaymentInitiated	Boolean	True			Check if the Automated Clearing House payment is initiated.
AchSupported	Boolean	True			Check if Automated Clearing House is supported.
Adjustment	Decimal	False			Adjustments made to the invoice.
AdjustmentDescription	String	False			Description of adjustments made to the invoice.
AllowPartialPayments	Boolean	False			Check if invoice can allow partial payments.
ApproverId	String	True	Users.UserId		ID of an approver.
AttachmentName	String	True			Name of the attachment.
Balance	Decimal	True			The unpaid amount.
BcyAdjustment	Decimal	True			Adjustment of base currency.
BcyDiscountTotal	Decimal	True			Total discount applied in base currency.
BcyShippingCharge	Decimal	True			Shipping charge applied in base currency.
BcySubTotal	Decimal	True			Sub total of base currency.
BcyTaxTotal	Decimal	True			Tax total of base currency.
BcyTotal	Decimal	True			Total Base Currency.
BillingAddress	String	True			Billing address of an invoice.
BillingAddressAttention	String	True			Name of a person in billing address.
BillingAddressCity	String	True			City of a billing address.
BillingAddressCountry	String	True			Country of a billing address.
BillingAddressFax	String	True			Fax of a billing address.
BillingAddressPhone	String	True			Phone number of a billing address.
BillingAddressState	String	True			State of a billing address.
BillingAddressStreet2	String	True			Street two of a billing address.
BillingAddressZip	String	True			ZIP code of a billing address.
ContactPersons	String	False			Contact persons of a contact.
CanSendInMail	Boolean	True			Check if invoice can be send in mail.
CanSendInvoiceSms	Boolean	True			Check if invoice can be send in SMS.
ClientViewedTime	String	True			Last time when client viewed the invoice.
ColorCode	String	True			Color code of invoice.
ContactCategory	String	True			Category of a contact.
ContactPersonsDetails	String	True			Details of a contact person.
CreatedById	String	True	Users.UserId		Id of a user who has created invoice.
CreatedTime	Datetime	True			Time at which the invoice was created.
CreditsApplied	Decimal	True			Applied credits for invoice.
CustomFields	String	False			Custom fields of the contact.
CurrencyCode	String	True			Currency code of the customer's currency.
CurrencyId	String	True	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String	True			Symbol of currency.
CurrentSubStatus	String	True			Current sub status of an invoice .
CurrentSubStatusId	String	True			Current sub status ID of an invoice .
CustomerDefaultBillingAddress	String	True			Customer default billing address of an invoice.
CustomerDefaultBillingAddressCity	String	True			City of a billing address.
CustomerDefaultBillingAddressCountry	String	True			Country of a billing address.
CustomerDefaultBillingAddressFax	String	True			Fax of a billing address.
CustomerDefaultBillingAddressPhone	String	True			Phone number of a billing address.
CustomerDefaultBillingAddressState	String	True			State of a billing address.
CustomerDefaultBillingAddressStateCode	String	True			State code of a customer default billing address.
CustomerDefaultBillingAddressStreet2	String	True			Street two of a customer default billing address.
CustomerDefaultBillingAddressZip	String	True			ZIP code of a customer default billing address.
CustomerId	String	False	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String	False			Name of the customer or vendor.
Date	Date	False			Date of an invoice.
Discount	String	False			Discount given to specific item in invoice.
DiscountAmount	Decimal	True			Amount of discount.
DiscountAppliedOnAmount	Decimal	True			Discount applied on amount.
DiscountPercent	Decimal	True			Percent of discount applied.
DiscountTotal	Decimal	True			Total amount get on discount.
DiscountType	String	False			Type of discount.
DueDate	Date	False			Delivery date of the invoice.
EcommOperatorGstNo	String	True			GST number of the ecommerce operator.
EcommOperatorId	String	True			ID of the ecommerce operator.
EcommOperatorName	String	True			Name of the ecommerce operator.
EstimateId	String	True	Estimates.EstimateId		ID of an estimate.
Ewaybills	String	True			Electronic way bills of the invoice.
ExchangeRate	Decimal	False			Exchange rate of the currency.
ExpenseId	String	False	Expenses.ExpenseId		Id of the tax
FiledInVatReturnId	String	True			VAT return ID of bill which was filed.
FiledInVatReturnName	String	True			VAT return name of bill which was filed.
FiledInVatReturnType	String	True			VAT return type of bill which was filed.
GstNo	String	False			GST number.
GstReturnDetailsReturnPeriod	String	True			Return period of GST.
GstReturnDetailsStatus	String	True			Status of GST return.
GstTreatment	String	False			Choose whether the invoice is GST registered/unregistered/consumer/overseas. .
HasNextInvoice	Boolean	True			Check if it has next invoice.
IsAutobillEnabled	Boolean	True			Check if the autobill is enabled for this invoice.
IsClientReviewSettingsEnabled	Boolean	True			Check if the client review settings is enabled or not.
IsDiscountBeforeTax	Boolean	False			Check if the invoice is discounted before tax.
IsEmailed	Boolean	True			Check if the invoice can be emailed.
IsEwayBillRequired	Boolean	True			Check if the eway bill is required.
IsInclusiveTax	Boolean	False			Check if the invoice is inclusive tax.
IsPreGst	Boolean	True			Check if pre GST is applied.
IsTaxable	Boolean	True			Check if invoice is taxable.
IsViewedByClient	Boolean	True			Check if the invoice is viewed by client.
InvoicedEstimateId	Boolean	False			ID of the invoice from which the invoice is created.
LastModifiedById	String	True	Users.UserId		Id of the user last modified.
LastModifiedTime	Datetime	True			The time of last modification of the invoice.
LastPaymentDate	Date	True			Date when last payment was made.
LastReminderSentDate	Date	True			Date when last reminder was sent for an invoice.
LineItems	String	False			Line Items
MerchantGstNo	String	True			GST number of a merchant.
MerchantId	String	True			ID of a merchant.
MerchantName	String	True			Name of a merchant.
NoOfCopies	Integer	True			Total number of copies for invoice.
Notes	String	False			Notes for this invoice.
Orientation	String	True			Orientation of the page.
PageHeight	String	True			Height of the page.
PageWidth	String	True			Width of the page.
PaymentDiscount	Decimal	True			Discount applied on payment.
PaymentExpectedDate	Date	True			Expected date of payment.
PaymentMade	Decimal	True			Total amount of payment made.
PaymentReminderEnabled	Boolean	True			Check if the payment reminder is enabled for the invoice.
PaymentTerms	Integer	False			Net payment term for the customer.
PaymentTermsLabel	String	False			Label for the paymet due details.
PlaceOfSupply	String	False			The place of supply is where a transaction is considered to have occurred for VAT purposes.
PricePrecision	Integer	True			The precision for the price.
ReaderOfflinePaymentInitiated	Boolean	True			Check if the payment for offline reader is initiated.
ReasonForDebitNote	String	True			Description of having the debit note.
RecurringInvoiceId	String	False	RecurringInvoices.RecurringInvoiceId		Id of a recurring invoice.
ReferenceNumber	String	False			Reference number of invoice.
RemindersSent	Integer	True			Total number of reminders sent for this invoice.
ReverseChargeTaxTotal	Decimal	True			Total amount of reverse charge tax.
RoundoffValue	Decimal	True			Rounding off the values to precise number.
SalesorderId	String	True	SalesOrders.SalesorderId		ID of a sales order.
SalesorderItemId	String	False	SalesOrderLineItems.LineItemId		Id of the tax
SalespersonId	String	True			ID of a sales person.
SalespersonName	String	False			Name of a sales person.
ScheduleTime	String	True			Time scheduled for the invoice.
ShipmentCharges	String	True			Charges deducted for shipment.
ShippingAddress	String	True			Shipment Address.
ShippingAddressAttention	String	True			Name of a person of shipping address.
ShippingAddressCity	String	True			City of a shipping address.
ShippingAddressCountry	String	True			Country of a shipping address.
ShippingAddressFax	String	True			Fax of a shipping address.
ShippingAddressPhone	String	True			Phone number of a shipping address.
ShippingAddressState	String	True			State of a shipping address.
ShippingAddressStreet2	String	True			Street two details of a shipping address.
ShippingAddressZip	String	True			Zip code of a shipping address.
ShippingCharge	Decimal	False			Shipping charge of invoice.
ShippingBills	String	True			Shipping bills of invoice.
ShowNoOfCopies	Boolean	True			Check if the invoice can show number of copies.
Status	String	True			Status of the invoice.
StopReminderUntilPaymentExpectedDate	Boolean	True			Check if reminder can be stopped untill the payment expected date.
SubTotal	Decimal	True			Sub total of the invoice.
SubTotalInclusiveOfTax	Decimal	True			Subtotal amount which are inclusive of tax.
SubmittedBy	String	True			Detail of the user who has submitted the invoice.
SubmittedDate	Date	True			Date when invoice was submitted.
SubmitterId	String	True	Users.UserId		Id of the invoice submitter.
TaxAmountWithheld	Decimal	True			Amount withheld for tax.
TaxRegNo	String	True			Registration number of tax.
TaxSpecification	String	True			Working of tax when specifying special tax options and tax methods for earnings codes.
TaxTotal	Decimal	True			Total number ot tax applied in the invoice.
TaxId	String	False	Taxes.TaxId		Id of the tax
TaxTreatment	String	False			VAT treatment for the Invoice.
TemplateId	String	False			ID of a template.
TemplateName	String	True			Name of a template.
TemplateType	String	True			Type of a template.
Terms	String	False			Terms and Conditions apply of a invoice.
Total	Decimal	True			Total of invoices.
TransactionRoundingType	String	True			Type of round off used for transaction.
Type	String	True			Types of invoice.
UnusedRetainerPayments	Decimal	True			Payment of the invoice which is unused.
VatTreatment	String	False			VAT treatment for the bills.
WriteOffAmount	Decimal	True			Amount to be write off.

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
Send	Boolean	Send the invoice to the contact person(s) associated with the invoice. Allowed values true and false.

ItemDetails

To list, add, update and delete details of an existing item.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: ItemId is required in order to query ItemDetails.

ItemId supports the '=' comparison.

For example:

    SELECT * FROM ItemDetails WHERE ItemId = '1894553000000079049'

Insert

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

Insert INTO ItemDetails(Name,Rate) values('Bottle','500')

Update

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

Update ItemDetails set Name='Bottle', Rate='550' where ItemId='3285934000000269037'

Delete

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

DELETE FROM ItemDetails WHERE ItemId = '3285934000000269037'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
ItemId [KEY]	String	True	Items.ItemId		ID of an item.
ItemType	String	False			Type of an item.
AccountId	String	False	BankAccounts.AccountId		ID of the Bank Account.
AccountName	String	True			Name of the account.
AvataxUseCode	String	False			Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule.
AvataxTaxCode	String	False			A tax code is a unique label used to group items together.
Brand	String	True			Brand of the item.
CreatedTime	Datetime	True			Time at which the item was created.
Description	String	False			Description of an item.
HSNORSAC	String	False			Add HSN/SAC code for your goods/services.
ImageName	String	True			Name of the image.
IsTaxable	Boolean	False			Boolean to track the taxability of the item.
InventoryAccountId	String	False			ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory.
LastModifiedTime	Datetime	True			The time of last modification of the item.
Manufacturer	String	True			Company that makes goods for sale.
Name	String	False			Name of an item.
PricebookRate	Decimal	True			Rate of pricebook.
ProductType	String	False			Type of the product.
PurchaseAccountId	String	False	BankAccounts.AccountId		Account ID of purchase items.
PurchaseAccountName	String	True			Account name of purchase items.
PurchaseDescription	String	False			Description of purchase items.
PurchaseRate	Decimal	False			Rate of purchase items.
Rate	Decimal	False			Rate of the item.
SalesChannels	String	True			Total channels exists for sales.
SalesRate	Decimal	True			The rate of sale in the item.
Sku	String	False			Stock Keeping Unit value of item, should be unique throughout the product.
Source	String	True			Source of the item.
Status	String	True			Status of the item.
Tags	String	True			Details of tags related to items.
TaxId	String	False	Taxes.TaxId		Id of tax.
TaxName	String	True			Name of the tax.
TaxPercentage	Integer	False			Percentage applied for tax.
TaxType	String	True			Type of tax.
VendorId	String	False			ID of the vendor the expenses has been made.
Unit	String	True			Number of quantity of item.
ReorderLevel	String	False			Reorder level of the item.
InitialStock	String	False			Opening stock of the item.
InitialStockRate	String	False			Unit price of the opening stock.
ItemTaxPreferences	String	False			Item Tax Preferences.

Journals

To list, add, update and delete journals.

Table Specific Information

Select

The Sync App 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 Sync App. By default, response will be showing the journals of current month only

EntryNumber supports the '=' comparison.
Notes supports the '=' comparison.
ReferenceNumber supports the '=' comparison.
Total supports the '=,<,<=,>,>=' comparisons.
Date supports the '=,<,>' comparisons.
VendorId supports the '=' comparison.
JournalFilter supports the '=' comparison.
CustomerId supports the '=' comparison.
LastModifiedTime supports the '=' comparison.

For example:

    SELECT * FROM Journals WHERE Total < 1000 AND Total >= 119

    SELECT * FROM Journals WHERE JournalFilter = 'JournalDate.All'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
JournalId [KEY]	String	True			Id of a journal.
JournalType	String	False			Type of a journal.
JournalDate	Date	False			Date of a journal.
BcyTotal	Decimal	True			Total Base Currency
CurrencyId	String	False	Currencies.CurrencyId		Currency ID of the customer's currency.
CustomFields	String	True			Custom Fields defined for Journal
EntityType	String	True			Entity type of a journal.
EntryNumber	String	True			Entry number of the journal.
ExchangeRate	Decimal	False			Exchange rate of the currency.
IncludeInVatReturn	String	False			VAT treatment for the estimates.
IsBasAdjustment	Boolean	False			Check if Journal is created for BAS Adjustment.
Notes	String	False			Notes of the journal.
ReferenceNumber	String	False			Reference number of the journal.
Status	String	False			Status of the journal
Total	Decimal	True		=,<,<=,>,>=	Total of journals. Search by journal total. This field will be populated with a value only when the Journal Id is specified.
JournalNumberPrefix	String	True			Prefix for journal number. This field will be populated with a value only when the Journal Id is specified.
JournalNumberSuffix	String	True			Suffix for journal number. This field will be populated with a value only when the Journal Id is specified.
CreatedTime	Datetime	True			Time at which the journal was created. This field will be populated with a value only when the Journal Id is specified.
CurrencyCode	String	True			Currency code of the customer's currency. This field will be populated with a value only when the Journal Id is specified.
CurrencySymbol	String	True			Currency symbol of the customer's currency. This field will be populated with a value only when the Journal Id is specified.
ExchangeRate	Decimal	True			Exchange rate of the currency. This field will be populated with a value only when the Journal Id is specified.
LastModifiedTime	Datetime	True			Last Modified Time of a journal. This field will be populated with a value only when the Journal Id is specified.
LineItemTotal	Decimal	True			Total number of line items included in a journal. This field will be populated with a value only when the Journal Id is specified.
PricePrecision	Integer	True			The precision for the price This field will be populated with a value only when the Journal Id is specified.
ProjectId	String	True	Projects.ProjectId		ID of a project. This field will be populated with a value only when the Journal Id is specified.
ProjectName	String	True			Name of a project. This field will be populated with a value only when the Journal Id is specified.
ProductType	String	False			Type of the journal. This denotes whether the journal is to be treated as goods or service.
VatTreatment	String	False			VAT treatment for the estimates.
LineItems	String	False			Line items of an estimate.
TaxExemptionCode	String	False			Code of a tax exemption.
TaxExemptionType	String	False			Type of the Tax Exemption.

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 of a journal.
VendorId	String	Vendor ID of a journal.
JournalFilter	String	Filter journals by journal date. 使用できる値は次のとおりです。JournalDate.All, JournalDate.Today, JournalDate.ThisWeek, JournalDate.ThisMonth, JournalDate.ThisQuarter, JournalDate.ThisYear
CustomerId	String	Id of a customer

OpeningBalances

To list, add, update and delete opening balance.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the Sync App.

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
OpeningBalanceId [KEY]	String	True			ID of an opening balance.
CanShowCustomerOb	Boolean	True			Check if opening balance can show customer ob.
CanShowVendorOb	Boolean	True			Check if opening balance can show vendor ob.
Date	Date	False			Date of an opening balance.
PricePrecision	Integer	True			The precision for the price
Total	Decimal	True			Total of opening balances.
Accounts	String	False			Accounts.

Projects

To list, add, update and delete projects.

Table Specific Information

Select

The Sync App 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 Sync App.

ProjectId supports the '=' comparison.
CustomerId supports the '=' comparison.
Status supports the '=' comparison.

For example:

    SELECT * FROM Projects WHERE CustomerId = '1894553000000078233' AND ProjectId = '1894553000000078363'

    SELECT * FROM Projects WHERE Status = 'Active'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
ProjectId [KEY]	String	True			Id of the project.
ProjectName	String	False			Name of the project.
Rate	Decimal	False			Hourly rate for a task.
Status	String	True			Status of the project. 使用できる値は次のとおりです。All, Active, Inactive
BillableHours	String	True			Total number of billable hours.
BillingType	String	False			Type of billing.
CanBeInvoiced	Boolean	True			Check if the projecy can be invoiced.
CreatedTime	Datetime	True			Time at which the project was created.
CustomerId	String	False	Contacts.ContactId		ID of the customer or vendor. Search projects by customer id.
CustomerName	String	True			Name of the customer or vendor.
CostBudgetAmount	Decimal	False			Budgeted Cost to complete this project.
BudgetAmount	String	False			Give value, if you are estimating total project revenue budget.
Description	String	False			Description of the projects
HasAttachment	Boolean	True			Check if the projects has attachment.
OtherServiceAppSource	String	True			Source of other service app.
TotalHours	String	True			Total hours spent in the project.
ShowInDashboard	Boolean	True			Check if the project can be shown in dashboard. This field will be populated with a value only when the Id is specified.
ProjectHeadId	String	True			ID of the project head. This field will be populated with a value only when the Id is specified.
ProjectHeadName	String	True			Name of the project head. This field will be populated with a value only when the Id is specified.
BillableAmount	Decimal	True			Amount which is billable for this project. This field will be populated with a value only when the Id is specified.
BilledAmount	Decimal	True			Total amount which was billed for the project. This field will be populated with a value only when the Id is specified.
BilledHours	String	True			Total number of billed hours. This field will be populated with a value only when the Id is specified.
BudgetThreshold	Decimal	True			To determine how much money to allocate to the reserve fund each fiscal year. This field will be populated with a value only when the Id is specified.
BudgetType	String	False			Type of budget. This field will be populated with a value only when the Id is specified.
BudgetHours	String	False			Task budget hours.
CurrencyCode	String	True			Code of currency used in the project. This field will be populated with a value only when the Id is specified.
IsBudgetThresholdNotificationEnabled	Boolean	True			Check if the budget threshold notification is enabled or not. This field will be populated with a value only when the Id is specified.
IsClientApprovalNeeded	Boolean	True			Check if the client approval is needed. This field will be populated with a value only when the Id is specified.
IsExpenseInclusive	Integer	True			Check if the expense is inclusive in the project. This field will be populated with a value only when the Id is specified.
IsUserApprovalNeeded	Boolean	True			Check if the user approval is needed. This field will be populated with a value only when the Id is specified.
IsValidProjectHead	Boolean	True			Check if the project has valid project head. This field will be populated with a value only when the Id is specified.
NonBillableAmount	Decimal	True			Amount which are non billable for the project.. This field will be populated with a value only when the Id is specified.
NonBillableHours	String	True			Hours which are non billable for the project. This field will be populated with a value only when the Id is specified.
TotalAmount	Decimal	True			Total amount for the project. This field will be populated with a value only when the Id is specified.
TotalAmountExpenseInclusive	Decimal	True			Total amount for the project including the project. This field will be populated with a value only when the Id is specified.
UnBilledAmount	Decimal	True			Total amount unbilled for the project. This field will be populated with a value only when the Id is specified.
UnBilledHours	String	True			Total number of unbilled hours. This field will be populated with a value only when the Id is specified.
UserId	String	False	Users.UserId		ID of the user to be added to the project.
Tasks	String	False			Tasks.
Users	String	False			Users.
UnusedRetainerPayments	Decimal	True			Payment of the project which is unused. This field will be populated with a value only when the Id is specified.

PurchaseOrderDetails

To list, add, update and delete details of a purchase order.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: PurchaseorderId is required in order to query PurchaseOrderDetails.

PurchaseorderId supports the '=' comparison.

For example:

    SELECT * FROM PurchaseOrderDetails WHERE PurchaseorderId = '1894553000000087078'

Insert

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

Insert INTO PurchaseorderLineItems#TEMP(Name,itemid,rate,quantity,accountid) values('Cloth-Jeans','3285934000000104097','1700','1','3285934000000034001')

INSERT INTO PurchaseorderDetails (Vendorid,lineitems) VALUES ('3285934000000104023',PurchaseorderLineItems#Temp)

Update

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

Insert INTO PurchaseorderLineItems#TEMP(Name,itemid,rate,quantity,accountid) values('Cloth-Jeans','3285934000000104097','1700','1','3285934000000034001')

UPDATE PurchaseOrderDetails SET Vendorid = '3285934000000104002',lineitems='PurchaseorderLineItems#Temp'  WHERE PurchaseorderId = '3285934000000264005'

Delete

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

DELETE FROM PurchaseOrderDetails WHERE PurchaseOrderId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
PurchaseorderId [KEY]	String	True	PurchaseOrders.PurchaseorderId		ID of a purchase order.
PurchaseorderNumber	String	False			Number of purchase order.
ReferenceNumber	String	False			Reference number of purchase order.
Adjustment	Decimal	True			Adjustments made to the purchase order.
AdjustmentDescription	String	True			Description of adjustments made to the purchase order.
ApproverId	String	True	Users.UserId		ID of an approver.
AttachmentName	String	True			Name of the attachment.
Attention	String	False			Name of a person in purchase order.
BilledStatus	String	True			Status of bill.
BillingAddressId	Long	False			ID of the Billing Address.
BillingAddress	String	True			Billing address of a purchase order.
BillingAddressAttention	String	True			Name of the person of bill order.
BillingAddressCity	String	True			City of billing address.
BillingAddressCountry	String	True			Country of billing address.
BillingAddressFax	String	True			Fax number of billing address.
BillingAddressPhone	String	True			Phone number of billing address.
BillingAddressState	String	True			State of billing address.
BillingAddressStreet2	String	True			Street two of billing address.
BillingAddressZip	String	True			Zip code of billing address.
CanMarkAsBill	Boolean	True			Check if purchase order can be mark as bill.
CanMarkAsUnbill	Boolean	True			Check if purhcase order can be mark as unbill.
CanSendInMail	Boolean	True			Check if purchase order can be sent in mail.
ClientViewedTime	Datetime	True			Last time when client viewed the purchase order.
ColorCode	String	True			Color code.
ContactCategory	String	True			Category of contacts.
CreatedById	String	True	Users.UserId		Contact ID who have created this purchase order.
CreatedTime	Datetime	True			Time at which the purchase order was created.
CurrencyCode	String	True			Currency code of the customer's currency.
CurrencyId	String	True	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String	True			Currency symbol of the customer's currency.
CurrentSubStatus	String	True			Current sub status of a purchase order.
CurrentSubStatusId	String	True			Current sub status ID of a purchase order.
ContactPersons	String	False			Contact persons of a contact.
CustomFields	String	True			Custom Fields defined for Journal
Date	Date	False			Purchase order date.
Documents	String	False			List of files to be attached to a particular transaction.
DeliveryAddress	String	True			Delivery address.
DeliveryAddress1	String	True			Delivery address one.
DeliveryAddress2	String	True			Delivery address two.
DeliveryAddressCity	String	True			City of delivery address.
DeliveryAddressCountry	String	True			Country of delivery address.
DeliveryAddressOrganizationAddressId	String	True			Id or organization address of delivery address.
DeliveryAddressPhone	String	True			Phone number of delivery address.
DeliveryAddressState	String	True			State of delivery address.
DeliveryAddressZip	String	True			Zip code of delivery address.
DeliveryCustomerId	String	False	Contacts.ContactId		ID of a customer of delivery address.
DueDate	Date	False			Delivery date of purchase order..
DeliveryDate	Date	False			Date of delivery.
DeliveryOrgAddressId	String	False			Delivery address ID of an organization.
Discount	String	False			Discount given to specific item in purchase order.
DiscountAccountId	String	False	BankAccounts.AccountId		Account ID of discount.
DiscountAmount	Decimal	True			Amount of discount.
DiscountAppliedOnAmount	Double	True			Discount applied on amount.
ExchangeRate	Decimal	False			Exchange rate of the currency.
ExpectedDeliveryDate	Date	True			Expected delivery date of purchased product.
HasQtyCancelled	Boolean	True			Check if the quantity of a purchase order has been cancelled.
IsDiscountBeforeTax	Boolean	False			Check if purchase order applied discount before tax.
IsDropShipment	Boolean	True			Check if purchase order have drop shipment.
IsEmailed	Boolean	True			Check if purchase order is emailed or not.
IsInclusiveTax	Boolean	False			Check if the purchase order is inclusive tax.
IsPreGst	Boolean	True			Check if purchase order includes pre GST.
IsViewedByClient	Boolean	True			Check if purchase order is viewed by client.
IsUpdateCustomer	Boolean	False			Check if customer should be updated.
LastModifiedTime	Datetime	True			The time of last modification of the purchase order.
Notes	String	False			Notes for this purchase order.
OrderStatus	String	True			Status of order.
Orientation	String	True			Orientation of the page.
PageHeight	String	True			Height of the page.
PageWidth	String	True			Width of the page.
PricePrecision	Integer	True			The precision for the price
PricebookId	String	False			ID of the pricebook.
SalesorderId	String	False	SalesOrders.SalesorderId		ID of the Sales Order.
ShipVia	String	False			Mode of shipping the item.
ShipViaId	String	True			ID of mode through which shipping was done of items.
Status	String	True			Status of the purchase order
SubTotal	Decimal	True			Sub total of Purhcase order.
SubTotalInclusiveOfTax	Decimal	True			Subtotal amount which are inclusive of tax.
SubmittedBy	String	True			Detail of the user who has submitted the purchase order.
SubmittedDate	Date	True			Date of the submission.
SubmitterId	String	True	Users.UserId		ID of the submitter.
TaxTotal	Decimal	True			Total amount of tax.
TemplateId	String	False			ID of the template.
TemplateName	String	True			Name of the template
TemplateType	String	True			Type of template.
Terms	String	False			Terms and Conditions apply of a purchase order.
Total	Decimal	True			Total of purchase orders.
VendorId	String	False			ID of the vendor the purchase order has been made.
VendorName	String	True			Name of the vendor the purchase order has been made.
GstTreatment	String	False			Choose whether the vendor credit is GST registered/unregistered/consumer/overseas.
VatTreatment	String	False			VAT treatment for the vendor credit.
TaxTreatment	String	False			VAT treatment for the Vendor Credit.
GstNo	String	False			GST number.
SourceOfSupply	String	False			Source of supply.
PlaceOfSupply	String	False			The place of supply is where a transaction is considered to have occurred for VAT purposes.
DestinationOfSupply	String	False			Place where the goods/services are supplied to.
LineItems	String	False			Line items of an estimate.

RecurringBillDetails

To list, add, update and delete details of a bill.

Table Specific Information

Select

The Sync App 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 Sync App.

RecurringBillId supports the '=' comparison.

For example:

    SELECT * FROM RecurringBillDetails where RecurringBillId='3255827000000084031'

Insert

Insert can be executed by specifying StartDate, RecurrenceName, RecurrenceFrequency, VendorID, LineItems columns. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.

Insert INTO RecurringBillLineItems#TEMP(Name,itemid) values('rubberband','3255827000000081058')

INSERT INTO RecurringBillDetails (vendorid,startdate,recurrencename,lineitems,recurrencefrequency) VALUES ('3255827000000081003','2023-03-01','recurring7',RecurringBillLineItems#TEMP,'days')

Update

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

UPDATE RecurringBillDetails SET RecurrenceName='recurrence3' WHERE RecurringBillId='3255827000000084031'

Delete

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

DELETE FROM RecurringBillDetails WHERE BillId = '3255827000000084031'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
RecurringBillId [KEY]	String	True			ID of a Recurring Bill.
Adjustment	Integer	True			Adjustment.
AdjustmentDescription	String	True			Status of the bill.
CreatedById	String	True			Created By Id.
CreatedTime	Datetime	True			Created Time.
CurrencyId	String	False	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencyCode	String	True			Currency code of the customer's currency.
CustomFields	String	False			Custom fields of the items.
Discount	String	False			Discount of recurring bills.
DiscountAccountId	String	True			Account ID of discount.
DiscountAmount	Integer	True			Discount amount.
DiscountAppliedOnAmount	String	True			Discount applied on amount.
DiscountSetting	String	True			Discount setting.
DiscountType	String	True			Discount type.
EndDate	Date	False			Date when the payment is expected.
ExchangeRate	Integer	True			Exchange Rate.
IsDiscountBeforeTax	Boolean	False			Check if discount should be applied before tax.
IsInclusiveTax	Boolean	False			Check if the tax is inclusive in the bill.
IsItemLevelTax	Boolean	True			Item Level Tax.
IsPreGST	Boolean	True			Is Pre GST.
IsTDSAmountInPercent	Boolean	True			Is TDS Amount In Percent
LastModifiedById	String	True			Last Modified By Id.
LastModifiedTime	Datetime	True			The time of last modification of the bill.
LastSentDate	Date	True			Date when recurring bill was last sent.
LineItems	String	False			Line items of an recurring bill.
NextBillDate	Date	True			Date when bill will be sent next.
Notes	String	False			Notes of the bill.
PaymentTerms	Integer	False			Net payment term for the customer.
PaymentTermsLabel	String	False			Label for the paymet due details.
RecurrenceFrequency	String	False			Frequency at which recurring bill will be sent. 使用できる値は次のとおりです。days, weeks, months, years
RecurrenceName	String	False			Search recurring bills by recurrence number.
VendorId	String	False			ID of the vendor the bill has been made.
VendorName	String	True			Name of the vendor the bill has been made.
Total	Integer	True			Total of the bill.
ReferenceId	String	True			Reference Id.
RepeatEvery	Integer	False			Integer value denoting the frequency of bill.
StartDate	Date	False			Date when bill was created.
Status	String	True			Status of the bill. 使用できる値は次のとおりです。active, stopped, expired
SubTotal	Integer	True			Sub total of the bill.
TaxAccountId	String	True			Tax Account ID.
TaxRounding	String	True			Tax Rounding.
TaxTotal	String	True			Tax Total.
TdsTaxId	String	True			Tax ID of TDS.
TdsTaxName	String	True			Tds tax name.
TdsAmount	Integer	True			TDS Amount.
TdsPercent	Decimal	True			TDS Percent.
TrackDiscountInAccount	Boolean	True			Track Discount In Account.

RecurringExpenseDetails

To list, add, update and delete details of a recurring expense.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: RecurringExpenseId is required in order to query RecurringExpenseDetails.

RecurringExpenseId supports the '=' comparison.

For example:

    SELECT * FROM RecurringExpenseDetails WHERE RecurringExpenseId = '1801553000000089750'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
RecurringExpenseId [KEY]	String	True	RecurringExpenses.RecurringExpenseId		Id of a recurring expense.
AccountId	String	False	BankAccounts.AccountId		ID of the Bank Account
AccountName	String	True			Name of the account.
Amount	Decimal	False			Amount of the recurring expenses.
BcyTotal	Decimal	True			Total Base Currency.
CreatedTime	Datetime	True			Time at which the recurring expense was created.
CurrencyCode	String	True			Currency code of the customer's currency.
CurrencyId	String	False	Currencies.CurrencyId		Currency ID of the customer's currency.
CustomerId	String	False	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String	True			Name of the customer or vendor.
Description	String	True			Description of the recurring expense.
EmployeeEmail	String	True			Email of an employee.
EmployeeId	String	True	Employees.EmployeeId		Id of an employee.
EmployeeName	String	True			Name of an employee.
EndDate	Date	False			End date of a recurring expense.
ExchangeRate	Decimal	False			Exchange rate of a recurring expense.
IsBillable	Boolean	False			Check if recurring expense is billable.
IsInclusiveTax	Boolean	False			Check if recurring expense is inclusive tax.
IsPreGst	Boolean	True			Check if recurring expense is pre GST.
LastCreatedDate	Date	True			Last created date of a recurring expense.
LastModifiedTime	Datetime	True			The time of last modification of the recurring expense.
MileageRate	Double	True			Mileage rate for a particular mileage expense.
MileageUnit	String	True			Unit of the distance travelled.
NextExpenseDate	Date	True			Next date of expense to be paid.
PaidThroughAccountId	String	True	BankAccounts.AccountId		Account ID from which expense is paid through.
PaidThroughAccountName	String	True			Account name from which expense is paid through.
ProjectId	String	False	Projects.ProjectId		ID of a project.
ProjectName	String	True			Name of the project.
RecurrenceFrequency	String	False			Frequency of a recurrence.
RecurrenceName	String	False			Name of a recurrence
RepeatEvery	Integer	False			Recurrence time of an expense.
StartDate	Date	False			Start date of recurring expense.
Status	String	True			Status of the recurring expense.
SubTotal	Decimal	True			Sub total of recurring expenses.
Tags	String	True			Details of tags related to recurring expenses.
TaxAmount	Decimal	True			Amount of a tax.
TaxId	String	False	Taxes.TaxId		Id of a tax.
TaxName	String	True			Name of a tax.
TaxPercentage	Integer	True			Percentage of a tax.
Total	Decimal	True			Total of recurring expenses.
VendorId	String	True			ID of the vendor the recurring expense has been made.
VendorName	String	True			Name of the vendor the recurring expense has been made.
GstNo	String	False			GST number.
SourceOfSupply	String	False			Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken).
DestinationOfSupply	String	False			Place where the goods/services are supplied to.
PlaceOfSupply	String	False			The place of supply is where a transaction is considered to have occurred for VAT purposes.
LineItems	String	False			Line items of an estimate.
VatTreatment	String	False			VAT treatment for the bills.
TaxTreatment	String	False			VAT treatment for the Bill.
ProductType	String	False			Type of the journal. This denotes whether the journal is to be treated as goods or service.
AcquisitionVatId	String	False			This is the ID of the tax applied in case this is an EU - goods expense and acquisition VAT needs to be reported.
ReverseChargeVatId	String	False			This is the ID of the tax applied in case this is a non UK - service expense and reverse charge VAT needs to be reported.

RecurringInvoiceDetails

To list, add, update and delete details of a recurring invoice.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: RecurringInvoiceId is required in order to query RecurringInvoiceDetails.

RecurringInvoiceId supports the '=' comparison.

For example:

    SELECT * FROM RecurringInvoiceDetails WHERE RecurringInvoiceId = '1895453000000042244'

Insert

Insert can be executed by specifying RecurrenceName,CustomerId,RecurrenceFrequency, LineItems columnS. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.

Insert INTO RecurringInvoiceLineItems#TEMP(Name,itemid,rate,quantity) values('Cloth-Jeans','3285934000000104097','1700','1')

Insert INTO RecurringInvoiceDetails(RecurrenceName,CustomerId,RecurrenceFrequency, LineItems) values('MonthlyInvoice','3285934000000104002','weeks',RecurringInvoiceLineItems#TEMP)

Update

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

Insert INTO RecurringInvoiceLineItems#TEMP(Name,itemid,rate,quantity) values('Cloth-Jeans','3285934000000104097','1700','1')

Update RecurringInvoiceDetails set RecurrenceName='MonthlyInvoice',CustomerId='3285934000000104002',RecurrenceFrequency='weeks', LineItems='RecurringInvoiceLineItems#TEMP' WHERE RECURRINGINVOICEID='3285934000000268005'

Delete

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

DELETE FROM RecurringInvoiceDetails WHERE RECURRINGINVOICEID = '3285934000000268005'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
RecurringInvoiceId [KEY]	String	True	RecurringInvoices.RecurringInvoiceId		Id of a recurring invoice.
ActualChildInvoicesCount	Integer	True			Count total number of actual child invoices.
Adjustment	Decimal	False			Adjustments made to the recurring invoices.
AdjustmentDescription	String	False			Description of adjustments made to the recurring invoices.
AllowPartialPayments	Boolean	True			Check if the recuuring invoice can allow partial payments.
AvataxUseCode	String	False			Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule.
AvataxTaxCode	String	False			A tax code is a unique label used to group items together.
AvataxExemptNo	String	False			Exemption certificate number of the customer.
BcyAdjustment	Decimal	True			Adjustment of base currency.
BcyDiscountTotal	Decimal	True			Total discount applied in base currency.
BcyShippingCharge	Decimal	True			Shipping charge applied in base currency.
BcySubTotal	Decimal	True			Sub total of base currency.
BcyTaxTotal	Decimal	True			Tax total of base currency.
BcyTotal	Decimal	True			Total Base Currency.
BillingAddress	String	False			Billing address of a recurring invoice.
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.
BillingAddressStreet2	String	False			Street two of a billing address.
BillingAddressZip	String	False			ZIP code of a billing address.
ChildEntityType	String	True			Entity type of a child in recurring invoice.
CompanyName	String	True			Name of the company.
ContactCategory	String	True			Category of the contact.
ContactPersons	String	False			Contact persons of a contact.
CreatedById	String	True	Users.UserId		Id of a user who has created recurring invoice.
CreatedTime	Datetime	True			Time at which the recurring invoice was created.
CurrencyCode	String	True			Currency code of the customer's currency.
CurrencyId	String	True	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String	True			Symbol of the currency.
CustomerEmail	String	True			Email address of the customer.
CustomerMobilePhone	String	True			Mobile phone number of customer.
CustomerId	String	False	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String	True			Name of the customer or vendor.
CustomerPhone	String	True			Phone number of a customer.
Discount	String	False			Discount given to specific item in recurring invoice.
DiscountAmount	Decimal	True			Total amount which was discounted.
DiscountAppliedOnAmount	Decimal	True			Amount from which discount was applied.
DiscountPercent	Double	True			Percentage of discount applied.
DiscountTotal	Decimal	True			Total amount get on discount.
DiscountType	String	False			Type to get discount in recurring invoice.
Email	String	False			Email address of the customer.
EndDate	Date	False			End date for the statement.
ExchangeRate	Decimal	False			Exchange rate of the currency.
IsDiscountBeforeTax	Boolean	False			Check if the recurring invoice is discounted before tax.
IsInclusiveTax	Boolean	False			Check if the expense is inclusive tax.
IsPreGst	Boolean	True			Check if pre GST is applied.
ItemId	String	False	Items.ItemId		ID of the customer or vendor.
LastModifiedById	String	True	Users.UserId		Id of the user last modified.
LastModifiedTime	Datetime	True			The time of last modification of the recurring invoice
LastSentDate	Date	True			The date at which the last recurring invoice was sent.
LineItems	String	False			Line items of an estimate.
ManualChildInvoicesCount	Integer	True			Count of manual child invoices.
NextInvoiceDate	Date	True			Date of a next invoice.
Notes	String	True			Notes for this recurring invoice.
Orientation	String	True			Orientation of a page.
PlaceOfSupply	String	False			The place of supply is where a transaction is considered to have occurred for VAT purposes.
PageHeight	String	True			Height of the page.
PageWidth	String	True			Width of the page.
PaidInvoicesTotal	Decimal	True			Total number of paid invoices.
PaymentTerms	Integer	False			Net payment term for the customer.
PaymentTermsLabel	String	False			Label for the paymet due details.
PaymentOptionsPaymentGateways	String	False			Payment Gateway used for payment.
PhotoUrl	String	True			Photo URL for recurring invoices.
PricePrecision	Integer	True			The precision for the price.
ProjectDetails	String	True			Details of project.
RecurrenceFrequency	String	False			Type of recurrence frequency the invoice is recurring.
RecurrenceName	String	False			Name of the recurrence.
ReferenceNumber	String	True			Reference number of a recurring invoice.
RepeatEvery	Integer	False			Recurrence time of the invoice.
RoundoffValue	Decimal	True			Rounding off the values to precise number.
SalespersonId	String	True			ID of a sales person.
SalespersonName	String	False			Name of a sales person.
ShipmentCharges	String	True			Shipment charges of recurring invoice.
ShippingAddress	String	False			Shipment 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.
ShippingAddressStreet2	String	False			Street two details of a shipping address.
ShippingAddressZip	String	False			Zip code of a shipping address.
ShippingCharge	Decimal	True			Shipping charge.
StartDate	Date	False			Starting date of recurring invoice.
Status	String	True			Status of the recurring invoice.
SubTotal	Decimal	True			Sub total of recurring invoices.
SubTotalInclusiveOfTax	Decimal	True			Subtotal amount which are inclusive of tax.
TaxId	String	False	Taxes.TaxId		Id of the tax
TaxTotal	Decimal	True			Total amount for tax.
TemplateId	String	False			ID of a template.
TemplateName	String	True			Name of a template.
Terms	String	True			Terms and Conditions apply of a recurring invoice.
Total	Decimal	True			Total of recurring invoices.
TransactionRoundingType	String	True			Type of round off used for transaction.
UnpaidChildInvoicesCount	String	True			Count of total number of unpaid child invoices.
UnpaidInvoicesBalance	Decimal	True			Total amount of unpaid invoices.
VatTreatment	String	False			VAT treatment for the estimates.
GstNo	String	False			GST number.
GstTreatment	String	False			Choose whether the estimate is GST registered/unregistered/consumer/overseas. .
TaxTreatment	String	False			VAT treatment for the Estimate.
Name	String	False			The name of the line item.
Description	String	False			The description of the line items.
Rate	Decimal	False			Rate of the line item.
Quantity	Integer	False			The quantity of line item.
Unit	String	False			Unit of the line item e.g. kgs, Nos.

RetainerInvoiceDetails

To list, add, update and delete of a retainer invoice.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: RetainerInvoiceId is required in order to query RetainerInvoiceDetails.

RetainerInvoiceId supports the '=' comparison.

For example:

    SELECT * FROM RetainerInvoiceDetails WHERE RetainerInvoiceId = '1894663000000085023'

Insert

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

Insert INTO RetainerInvoiceLineItems#TEMP(description,rate) values('Cloth description','1700')

Insert INTO RetainerInvoiceDetails(CustomerId, LineItems) values('3285934000000104002',RetainerInvoiceLineItems#TEMP)

Update

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

Insert INTO RetainerInvoiceLineItems#TEMP(description,rate) values('Cloth description updated','1700')

Update RetainerInvoiceDetails set CustomerId='3285934000000104002',LineItems='RetainerInvoiceLineItems#TEMP' WHERE RetainerINVOICEID='3285934000000268036'

Delete

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

DELETE FROM RetainerInvoiceDetails WHERE RetainerINVOICEID = '3285934000000268036'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
RetainerInvoiceId [KEY]	String	True	RetainerInvoices.RetainerInvoiceId		Id of retainer invoice.
RetainerinvoiceNumber	String	True			Number of a retainer invoice.
AllowPartialPayments	Boolean	True			Check if the retainer invoice allows partial payments.
AttachmentName	String	True			Name of the attachment.
Balance	Decimal	True			Total amount left.
BillingAddress	String	True			Billing address of a retainer invoice.
BillingAddressAttention	String	True			Name of a person in billing address.
BillingAddressCity	String	True			City of a billing address.
BillingAddressCountry	String	True			Country of a billing address.
BillingAddressFax	String	True			Fax of a billing address.
BillingAddressPhone	String	True			Phone number of a billing address.
BillingAddressState	String	True			State of a billing address.
BillingAddressStreet2	String	True			Street two of a billing address.
BillingAddressZip	String	True			ZIP code of a billing address.
CanSendInMail	Boolean	True			Check if retainer invoice can be send in mail.
ClientViewedTime	Datetime	True			Last time when client viewed retainer invoice.
ColorCode	String	True			Color code of retainer invoice.
ContactPersons	String	False			Contact Persons
CreatedById	String	True	Users.UserId		Id of a user who has created retainer invoice.
CreatedTime	Datetime	True			Time at which the retainer invoice was created.
CurrencyCode	String	True			Currency code of the customer's currency.
CurrencyId	String	True	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String	True			Symbol of currency used for retainer invoice.
CurrentSubStatus	String	True			Current sub status of a retainer invoice.
CurrentSubStatusId	String	True			Current sub status ID of a retainer invoice.
CustomerId	String	False	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String	True			Name of the customer or vendor.
Date	Date	False			Date of a retainer invoice.
ExchangeRate	Decimal	True			Exchange rate of the currency.
InvoiceUrl	String	True			URL of invoice.
IsEmailed	Boolean	True			Check if the retainer invoice is emailed.
IsInclusiveTax	Boolean	True			Check if the retainer invoice is inclusive of tax.
IsPreGst	Boolean	True			Check if the retainer invoice is applied by pre GST.
IsViewedByClient	Boolean	True			Check if retainer invoice is viewed by client.
LastModifiedById	String	True	Users.UserId		Id of a user who has last modified the retainer invoice.
LastModifiedTime	Datetime	True			The time of last modification of the retainer invoice.
LastPaymentDate	Date	True			Date of payment which was last paid.
Notes	String	False			Notes of retainer invoice.
Orientation	String	True			Orientation of a page.
PageHeight	String	True			Height of a page.
PageWidth	String	True			Width of a page.
PaymentDrawn	Decimal	True			The payment which was drawn for retainer invoice.
PaymentOptionPaymentGateways	String	False			Payment options for the retainer invoice, online payment gateways and bank accounts.
PaymentMade	Decimal	True			Payment which was made for the invoice.
PricePrecision	Integer	True			The precision for the price.
ReferenceNumber	String	False			Reference number of a retainer invoice.
RoundoffValue	Decimal	True			Round Off value.
ShippingAddress	String	True			Shipment Address.
ShippingAddressAttention	String	True			Name of a person of shipping address.
ShippingAddressCity	String	True			City of a shipping address.
ShippingAddressCountry	String	True			Country of a shipping address.
ShippingAddressFax	String	True			Fax of a shipping address.
ShippingAddressPhone	String	True			Phone number of a shipping address.
ShippingAddressState	String	True			State of a shipping address.
ShippingAddressStreet2	String	True			Street two details of a shipping address.
ShippingAddressZip	String	True			Zip code of a shipping address.
Status	String	True			Status of the retainer invoice.
SubTotal	Decimal	True			Sub total of retainer invoices.
SubmittedBy	String	True			Detail of the user who has submitted the retainer invoice.
SubmittedDate	Date	True			Date of submission of retainer invoice.
TemplateId	String	False			ID of a template.
TemplateName	String	True			Name of a template.
TemplateType	String	True			Type of a template.
Terms	String	False			Terms and Conditions apply of a retainer invoice.
Total	Decimal	True			Total of retainer invoices.
TransactionRoundingType	String	True			Type of round off used for transaction.
VatTreatment	String	True			VAT treatment for the retainer invoice.
PlaceOfSupply	String	False			The place of supply is where a transaction is considered to have occurred for VAT purposes.
TaxSpecification	String	True			Working of tax when specifying special tax options and tax methods for earnings codes.
UnusedRetainerPayments	Decimal	True			Payment of the retainer invoice which is unused.
LineItems	String	False			Line items of an estimate.

SalesOrderDetails

To list, add, update and delete a sales order.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: SalesorderId is required in order to query SalesOrderDetails.

SalesorderId supports the '=' comparison.

For example:

    SELECT * FROM SalesOrderDetails WHERE SalesorderId = '1894553000000077349'

Insert

Insert can be executed by specifying Name,itemid,rate,quantity columns. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.

Insert INTO SalesOrderLineItems#TEMP(Name,itemid,rate,quantity) values('Cloth-Jeans','3285934000000104097','1700','1')

Insert INTO SalesorderDetails(CustomerId, LineItems) values('3285934000000104002',SalesorderLineItems#TEMP)

Update

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

Insert INTO SalesOrderLineItems#TEMP(Name,itemid,rate,quantity) values('Cloth-Jeans','3285934000000104097','1700','1')

Update SalesorderDetails set CustomerId='3285934000000104002',LineItems='SalesorderLineItems#TEMP' WHERE SalesorderID='3285934000000259151'

Delete

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

DELETE FROM SalesorderDetails WHERE SalesorderID = '3285934000000259151'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
SalesorderId [KEY]	String	True	SalesOrders.SalesorderId		ID of sales order.
AccountIdentifier	String	True			Account identifier for sales order.
Adjustment	Decimal	False			Adjustments made to the sales order.
AdjustmentDescription	String	False			Description of adjustments made to the sales order.
ApproverId	String	True	Users.UserId		ID of an approver.
AttachmentName	String	True			Name of the attachment.
AvataxUseCode	String	False			Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule.
AvataxExemptNo	String	False			Exemption certificate number of the customer.
BcyAdjustment	Decimal	True			Adjustment made in Base Currency.
BcyDiscountTotal	Decimal	True			Total amount of discount in Base Currency.
BcyShippingCharge	Decimal	True			Shipping charge applied in Base Currency.
BcySubTotal	Decimal	True			Sub total of Base Currency.
BcyTaxTotal	Decimal	True			Total tax of Base Currency.
BcyTotal	Decimal	True			Total Base Currency.
BillingAddressId	String	False			ID of the Billing Address
ShippingAddressId	String	False			ID of the Shipping Address
BillingAddress	String	True			Billing address of a sales order.
BillingAddressAttention	String	True			Name of a person in billing address.
BillingAddressCity	String	True			City of a billing address.
BillingAddressCountry	String	True			Country of a billing address.
BillingAddressFax	String	True			Fax of a billing address.
BillingAddressPhone	String	True			Phone number of a billing address.
BillingAddressState	String	True			State of a billing address.
BillingAddressStreet2	String	True			Street two of a billing address.
BillingAddressZip	String	True			ZIP code of a billing address.
CanSendInMail	Boolean	True			Check if the sales order can be send in mail.
ColorCode	String	True			Color code for sales order.
ContactCategory	String	True			Category of a contact.
ContactPersons	String	False			Contact persons of a contact.
CreatedById	String	True	Users.UserId		Id of a user who has created sales order.
CreatedTime	Datetime	True			Time at which the sales order was created.
CurrencyCode	String	True			Currency code of the customer's currency.
CurrencyId	String	True	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String	True			Currency symbol of the customer's currency.
CurrentSubStatus	String	True			Current sub status of a sales order.
CurrentSubStatusId	String	True			Current sub status ID of a sales order.
CustomerId	String	False	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String	True			Name of the customer or vendor.
CustomFields	String	False			Custom fields of the contact.
Date	Date	False			Date of a sales order.
DeliveryMethod	String	False			Method of a delivery.
DeliveryMethodId	String	True			Method ID of a delivery.
Discount	String	False			Discount given to specific item in sales order.
DiscountAppliedOnAmount	Decimal	True			Amount in which discount was applied.
DiscountPercent	Double	True			Percentage applied for discount.
DiscountTotal	Decimal	True			Total amount get on discount.
DiscountType	String	False			Type of discount applied in sales order.
EstimateId	String	False	Estimates.EstimateId		ID of an estimate.
ExchangeRate	Decimal	False			Exchange rate of the currency.
GstNo	String	False			GST number.
GstTreatment	String	False			Choose whether the estimate is GST registered/unregistered/consumer/overseas. .
HasQtyCancelled	Boolean	True			Check if the sales order quantity has been cancelled.
IntegrationId	String	True			ID of sales order integration.
InvoiceConversionType	String	True			Type of invoice conversion applied for sales order.
InvoicedStatus	String	True			Status of invoiced sales order.
IsDiscountBeforeTax	Boolean	False			Check if the sales order can be applied discount before tax.
IsUpdateCustomer	Boolean	False			Boolean to update billing address of customer.
IsEmailed	Boolean	True			Check if the sales order is emailed.
IsInclusiveTax	Boolean	False			Check if the sales order is inclusive tax.
IsPreGst	Boolean	True			Check if pre GST is applied.
LastModifiedById	String	True	Users.UserId		Id of the user last modified.
LastModifiedTime	Datetime	True			The time of last modification of the sales order.
LineItems	String	False			Line items of an estimate.
MerchantId	String	False			ID of the merchant.
MerchantName	String	True			Name of the merchant.
Notes	String	False			Notes of sales order.
NotesDefault	String	False			Default Notes for the Sales Order.
OrderStatus	String	True			Status of order.
Orientation	String	True			Orientation of page.
PageHeight	String	True			Height of page.
PageWidth	String	True			Width of page.
PricePrecision	Integer	True			The precision for the price.
PriceBookId	String	False			ID of a pricebook.
PlaceOfSupply	String	False			The place of supply is where a transaction is considered to have occurred for VAT purposes.
ReferenceNumber	String	False			Reference number of a sales order.
RoundoffValue	Decimal	True			Round Off value of sales order.
SalesorderNumber	String	False			Number of sales order.
SalespersonId	String	False			ID of a sales person.
SalespersonName	String	False			Name of the sales person.
ShipmentDate	Date	False			Date when shipment was done for sale order.
ShippingAddress	String	True			Shipment Address.
ShippingAddressAttention	String	True			Name of a person of shipping address.
ShippingAddressCity	String	True			City of a shipping address.
ShippingAddressCountry	String	True			Country of a shipping address.
ShippingAddressFax	String	True			Fax of a shipping address.
ShippingAddressPhone	String	True			Phone number of a shipping address.
ShippingAddressState	String	True			State of a shipping address.
ShippingAddressStreet2	String	True			Street two details of a shipping address.
ShippingAddressZip	String	True			Zip code of a shipping address.
ShippingCharge	Decimal	False			Shipping charge.
Status	String	True			Status of the sales order.
SubTotal	Decimal	True			Sub total of sales orders.
SubTotalInclusiveOfTax	Decimal	True			Subtotal amount which are inclusive of tax.
SubmittedBy	String	True			Detail of the user who has submitted the sales order.
SubmittedDate	Date	True			Date when submission was made of sales order.
SubmitterId	String	True	Users.UserId		Id of a submitter.
TaxId	String	False	Taxes.TaxId		Id of the tax
TaxTotal	Decimal	True			Total amount of tax.
TemplateId	String	False			ID of a template.
TemplateName	String	True			Name of a template.
TemplateType	String	True			Type of template.
Terms	String	False			Terms and Conditions apply of a sales order.
TermsDefault	String	False			Default Terms of the Sales Order
Total	Decimal	True			Total of sales order.
TransactionRoundingType	String	True			Type of round off used for transaction.
VatTreatment	String	False			VAT treatment for the estimates.
TaxTreatment	String	False			VAT treatment for the Estimate.

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
TotalFiles	Integer	Total number of files.
Doc	String	Document that is to be attached.

Tasks

To list, add, update and delete tasks added to a project. Also, get the details of a task.

Table Specific Information

Select

The Sync App 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 Sync App.

ProjectId supports the '=' comparison.
TaskId supports the '=' comparison.

For example:

    SELECT * FROM Tasks WHERE ProjectId = '1894553000000078367' AND TaskId = '1894553000000085708'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
TaskId [KEY]	String	True			ID of a task.
ProjectId	String	True	Projects.ProjectId		ID of the project.
CurrencyId	String	True	Currencies.CurrencyId		Currency ID of the customer's currency.
TaskName	String	False			Name of the task.
Description	String	False			Description of the task.
ProjectName	String	True			Name of the project.
CustomerId	String	True	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String	True			Name of the customer or vendor.
BilledHours	String	True			Total number of billed hours for a task.
BudgetHours	Integer	False			A project comprises of a single or multiple tasks that need to be completed.
LogTime	String	True			Time logs for the task.
UnBilledHours	String	True			Total number of hours which was un-billed.
Rate	Decimal	False			Rate for task.
Status	String	True			Status of the task.
IsBillable	Boolean	True			Check if tasks is billable or not.

Taxes

To list, add, update and delete simple and compound taxes. Also, get the details of a simple or compound tax.

Table Specific Information

Select

The Sync App 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 Sync App.

TaxId supports the '=' comparison.

For example:

    SELECT * FROM Taxes WHERE TaxId = '1894553000000077244'

Insert

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

INSERT INTO Taxes (TaxName,TAXPERCENTAGE) VALUES ('tax1','3')

Update

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

UPDATE Taxes SET TaxName = 'TaxUpdated',TaxPercentage='5' WHERE TaxId = '3350895000000089005'

Delete

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

DELETE FROM Taxes WHERE TaxId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
TaxId [KEY]	String	True			Id of tax.
TaxName	String	False			Name of the tax.
TaxPercentage	Integer	False			Percentage applied for tax.
TaxType	String	False			Type of tax.
TaxSpecificType	String	False			Type of tax.
TaxAuthorityId	String	False			ID of a tax authority.
TaxAuthorityName	String	False			Name of the tax authority.
TaxSpecification	String	True			Working of tax when specifying special tax options and tax methods for earnings codes.
TdsPayableAccountId	String	True	BankAccounts.AccountId		Account ID of TDS payable.
Country	String	True			Name of the country for taxes.
CountryCode	String	False			Country code for taxes.
IsDefaultTax	Boolean	True			Check if the tax is default.
IsValueAdded	Boolean	False			Check if Tax is Value Added.
IsEditable	Boolean	False			Check if the tax is editable.
TaxType	String	True			Type of tax.
PurchaseTaxExpenseAccountId	String	False			Account ID in which Purchase Tax will be Computed.
UpdateRecurringInvoice	Boolean	False			Check if recurring invoice should be updated.
UpdateRecurringExpense	Boolean	False			Check if Draft Invoices should be updated.
UpdateDraftInvoice	Boolean	False			Check if Draft Invoices should be updated.
UpdateRecurringBills	Boolean	False			Check if Subscriptions should be updated.
UpdateDraftSo	Boolean	False			Check if Subscriptions should be updated.
UpdateSubscription	Boolean	False			Check if Subscriptions should be updated.
UpdateProject	Boolean	False			Check if Projects should be updated.

TaxGroups

Read, Insert, Update and Delete Tax Groups.

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
TaxGroupId [KEY]	String	True		=	Id of the Tax Group
TaxGroupName	String	False			Name of the tax group to be created.
TaxGroupPercentage	Double	True			Tax group percentage
Taxes	String	False			Comma Seperated list of tax IDs that are to be associated to the tax group.

TimeEntries

To list, add, update and delete time entries.

Table Specific Information

Select

The Sync App 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 Sync App. By default, response will be showing the time entries of current month only.

TimeEntryId supports the '=' comparison.
ProjectId supports the '=' comparison.
UserId supports the '=' comparison.
FromDate supports the '=' comparison.
ToDate supports the '=' comparison.
TimeEntryFilter supports the '=' comparison.

For example:

    SELECT * FROM TimeEntries WHERE TimeEntryId = '1894553000000085710' AND UserId = '1894553000000068001'

    SELECT * FROM TimeEntries WHERE TimeEntryFilter = 'Date.All'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
TimeEntryId [KEY]	String	True			Id of time entry.
TimerDurationInMinutes	Integer	True			Timer duration in minutes.
TimerDurationInSeconds	Integer	True			Timer duration in seconds.
TimerStartedAt	String	True			Time when the timer started.
BeginTime	String	False			Time the user started working on this task.
BilledStatus	String	True			Status which are billed.
CostRate	Decimal	False			Hourly cost rate.
CanBeInvoiced	Boolean	True			Check if the entry can be invoiced.
CanContinueTimer	Boolean	True			Check if the entry can continue the timer.
CanCreateClientApproval	Boolean	True			Check if the entry can create client approval.
CanCreateUserApproval	Boolean	True			Check if the entry can create user approval.
CreatedTime	Datetime	True			Time at which the time entry was created.
CustomerId	String	True	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String	True			Name of the customer or vendor.
EndTime	String	False			Time the user stopped working on this task.
InvoiceId	String	True	Invoices.InvoiceId		ID of an invoice.
InvoiceNumber	String	True			Number of an invoice.
IsBillable	Boolean	False			Check if time entries is billable.
IsClientApprovalNeeded	Boolean	True			Check if the client approval is needed in time entries.
IsCurrentUser	Boolean	True			Check if it is a current user of time entries.
IsPaused	Boolean	True			Check if time entries is paused.
LogDate	Date	False			Log of date.
LogTime	String	False			Log of time.
Notes	String	False			Notes for this time entry.
ProjectHeadId	String	True			ID of project head.
ProjectHeadName	String	True			Name of project head.
ProjectId	String	False	Projects.ProjectId		Id of a project.
ProjectName	String	True			Name of the project.
StartTimer	String	False			Start Timer.
TaskId	String	False	Tasks.TaskId		ID of task.
TaskName	String	True			Name of the task.
UserId	String	False	Users.UserId		Id of a user.
UserName	String	True			Name of user for time entries.

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	Date from which the time entries logged to be fetched.
ToDate	Date	Date up to which the time entries logged to be fetched.
TimeEntryFilter	String	Filter time entries by date and status. 使用できる値は次のとおりです。Date.All, Date.Today, Date.ThisWeek, Date.ThisMonth, Date.ThisQuarter, Date.ThisYear, Date.PreviousDay, Date.PreviousWeek, Date.PreviousMonth, Date.PreviousQuarter, Date.PreviousYear, Date.CustomDate, Status.Unbilled, Status.Invoiced

Users

To list, add, update and delete users in the organization. Also, get the details of a user.

Table Specific Information

Select

The Sync App 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 Sync App.

UserId supports the '=' comparison.
Status supports the '=' comparison.

For example:

    SELECT * FROM Users WHERE Status = 'All'

    SELECT * FROM Users ORDER BY UserRole DESC

Insert

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

INSERT INTO Users (Name,Email,UserRole) VALUES ('user1','[email protected]','staff')

Update

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

UPDATE Users SET Name = 'User Name Change',Email='[email protected]',UserRole='staff' WHERE UserId = '3350895000000089005'

Delete

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

DELETE FROM Users WHERE UserId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
UserId [KEY]	String	True			Id of a user.
UserRole	String	False			Role of a user.
UserType	String	True			Type of a user.
CreatedTime	Datetime	True			Time at which the user was created.
Email	String	False			Email ID of a user.
IsAssociatedForApproval	Boolean	True			Check if the user is associated for the approval.
IsClaimant	Boolean	True			Check if the user is claimant.
IsCustomerSegmented	Boolean	True			Check if the user is customer segmented.
IsEmployee	Boolean	True			Check if the user is an employee.
Name	String	False			Name of the user.
PhotoUrl	String	True			Photo URL of the user.
RoleId	String	False			Role ID of a user.
CostRate	Double	False			Hourly cost rate.
Status	String	True			Status of the user. 使用できる値は次のとおりです。All, Active, Inactive, Invited, Deleted

VendorCreditDetails

To list, add, update and delete details of a vendor credit.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: VendorCreditId is required in order to query VendorCreditDetails.

VendorCreditId supports the '=' comparison.

For example:

    SELECT * FROM VendorCreditDetails WHERE VendorCreditId = '1894545000000083308'

Insert

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

Insert INTO VendorCreditLineItems#TEMP(Name,itemid,rate,quantity) values('Cloth-Jeans3','3285934000000104097','1700','1')

INSERT INTO VendorCreditDetails (VendorId,lineitems,VendorCreditNumber) VALUES ('3285934000000104023',VendorCreditLineItems#Temp,'9')

Update

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

Insert INTO VendorCreditLineItems#TEMP(Name,itemid,rate,quantity) values('Cloth-Jeans3','3285934000000104097','1700','1')

Update VendorCreditDetails set CustomerId='3285934000000104002',LineItems='VendorCreditLineItems#TEMP' WHERE VendorCreditID='3285934000000259151'

Delete

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

DELETE FROM VendorCreditDetails WHERE VendorCreditId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
VendorCreditId [KEY]	String	True	VendorCredits.VendorCreditId		Id of a vendor credit.
VendorCreditNumber	String	False			Number of vendor credit.
VendorId	String	False			ID of the vendor the vendor credit has been made.
VendorName	String	True			Name of the vendor the vendor credit has been made.
Adjustment	Decimal	True			Adjustments made to the vendor credit.
AdjustmentDescription	String	True			Description of adjustments made to the vendor credit.
ApproverId	String	True	Users.UserId		ID of a approver.
Balance	Decimal	True			Total balance of vendor credit.
BillId	String	False	Bills.BillId		ID of a Bill.
BillNumber	String	True			Number of a Bill.
ColorCode	String	True			Color code of vendor credit.
ContactCategory	String	True			Category of a contact.
CreatedTime	Datetime	True			Time at which the vendor credit was created.
CurrencyCode	String	True			Currency code of the customer's currency.
CustomFields	String	True			Custom Fields defined for Journal
CurrencyId	String	True	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrentSubStatus	String	True			Current sub status of a vendor credit.
CurrentSubStatusId	String	True			Current sub status ID of a vendor credit.
Documents	String	False			List of files to be attached to a particular transaction.
Date	Date	False			Vendor Credit date.
DestinationOfSupply	String	False			Place where the goods/services are supplied to.
Discount	String	True			Discount amount applied to vendor credit.
DiscountAccountId	String	True	BankAccounts.AccountId		Account ID of the discount.
DiscountAmount	Decimal	True			Amount of the discount.
DiscountAppliedOnAmount	Decimal	True			Amount applied on discount.
DiscountSetting	String	True			Settings of discount.
ExchangeRate	Decimal	False			Exchange rate applied for vendor credits.
FiledInVatReturnId	String	True			VAT return ID of bill which was filed.
FiledInVatReturnName	String	True			VAT return name of bill which was filed.
FiledInVatReturnType	String	True			VAT return type of bill which was filed.
GstNo	String	False			GST number.
GstReturnDetailsReturnPeriod	String	True			Return period of GST return details.
GstReturnDetailsStatus	String	True			Status of GST return details.
GstTreatment	String	False			Choose whether the vendor credit is GST registered/unregistered/consumer/overseas.
HasNextVendorcredit	Boolean	True			Check if there is nect vendor credit.
IsDiscountBeforeTax	Boolean	True			Check if discount is applicable before tax.
IsInclusiveTax	Boolean	False			Check if tax is inclusive.
IsUpdateCustomer	Boolean	False			Check if customer should be updated.
IsPreGst	Boolean	True			Check if pre GST is applied.
IsReverseChargeApplied	Boolean	True			Check if the reverse charge is applied.
LastModifiedTime	Datetime	True			The time of last modification of the vendor credits.
Notes	String	False			Notes of vendor credit.
Orientation	String	True			Orientation of vendor credit.
PageHeight	String	True			Height of a page.
PageWidth	String	True			Width of a page.
PricebookId	String	False			ID of the pricebook.
PricePrecision	Integer	True			The precision for the price.
ReasonForDebitNote	String	True			Specified reason for debit note.
ReferenceNumber	String	False			Reference number of vendor credit.
SourceOfSupply	String	False			Source of supply.
Status	String	True			Status of the vendor credit.
SubTotal	Decimal	True			Sub total of vendor credits.
SubTotalInclusiveOfTax	Decimal	True			Amount if the subtotal is inclusive of tax.
SubmittedBy	String	True			Detail of the user who has submitted the vendor credit.
SubmittedDate	Date	True			Date when vendor credit was submitted.
SubmitterId	String	True	Users.UserId		ID of vendor credit submitter.
TaxTreatment	String	False			VAT treatment for the Vendor Credit.
TemplateId	String	True			ID of a template.
TemplateName	String	True			Name of a template.
TemplateType	String	True			Type of a template.
Total	Decimal	True			Total of vendor credits.
TotalCreditsUsed	Decimal	True			Total credits used for this vendor credit.
TotalRefundedAmount	Decimal	True			Total amount refunded for a vendor credit.
PlaceOfSupply	String	False			The place of supply is where a transaction is considered to have occurred for VAT purposes.
VatTreatment	String	False			VAT treatment for the vendor credit.
LineItems	String	False			Line items of an estimate.

VendorCreditRefund

Read, Insert and Update Vendor Credit Refunds.

Table Specific Information

Select

The Sync App 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 Sync App.

VendorCreditId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM VendorCreditRefund

SELECT * FROM VendorCreditRefund WHERE VendorCreditId = '3350895000000089001'

SELECT * FROM VendorCreditRefund where vendorcreditid='3285934000000134009' and  VendorCreditRefundId='3285934000000435001'

Insert

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

INSERT INTO VendorCreditRefund (Date,Amount,AccountId,VendorCreditId) VALUES ('2023-02-27','1200',3285934000000259036,3285934000000134009)

Update

Update can be executed by specifying the Amount,Date and AccountId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE VendorCreditRefund SET Description = 'test2' where vendorcreditrefundid=3285934000000435001 and VendorCreditId=3285934000000134009

Delete

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

Delete from VendorCreditRefund where VendorCreditId=3285934000000134009 and vendorcreditrefundid=3285934000000432043

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
VendorCreditId [KEY]	String	False	VendorCredits.VendorCreditId	=	Vendor Credit Id
VendorCreditRefundId [KEY]	String	True		=	Vendor Credit Refund Id
Amount	Integer	False			Amount
AmountBcy	Integer	True			Amount BCY
AmountFcy	Integer	True			Amount FCY
CustomerName	String	True			Customer Name
Date	Date	False			Date
Description	String	False			Description
ExchangeRate	Decimal	False			Exchange Rate
ReferenceNumber	String	False			Reference Number
RefundMode	String	False			Refund Mode
VendorName	String	True			Vendor Name
VendorCreditNumber	String	True			Vendor Credit Number

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
AccountId	String	Id of the Bank Account.

VendorPaymentDetails

To list, add, update and delete details of a Vendor Payment.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: PaymentId is required in order to query VendorPaymentDetails.

PaymentId supports the '=' comparison.

For example:

    SELECT * FROM VendorPaymentDetails WHERE PaymentId = '1894553000000085277'

Insert

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

INSERT INTO VendorPaymentDetails (VendorId,Amount) VALUES ('3285934000000104023','500')

Update

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

Update VendorPaymentDetails VendorId='3285934000000104023',Amount='1000' WHERE PaymentId = '3350895000000089005'

Delete

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

DELETE FROM VendorPaymentDetails WHERE PaymentId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
PaymentId [KEY]	String	True	VendorPayments.PaymentId		Id of a payment.
VendorId	String	False	VendorPayments.VendorId		ID of the vendor the vendor payment has been made.
VendorName	String	True			Name of the vendor the vendor payment has been made.
VendorpaymentRefunds	String	True			Refunds of a vendor payment.
AchPaymentStatus	String	True			Status of ACH Payment.
Amount	Decimal	False			Amount of the vendor payments.
Balance	Decimal	True			Total amount of a vendor payment.
Bills	String	False			Individual bill payment details as array.
BillingAddress	String	True			Billing address of a vendor payment.
BillingAddressAttention	String	True			Name of a person in billing address.
BillingAddressCity	String	True			City of a billing address.
BillingAddressCountry	String	True			Country of a billing address.
BillingAddressFax	String	True			Fax of a billing address.
BillingAddressPhone	String	True			Phone number of a billing address.
BillingAddressState	String	True			State of a billing address.
BillingAddressStreet2	String	True			Street two of a billing address.
BillingAddressZip	String	True			ZIP code of a billing address.
CheckDetailsAmountInWords	String	False			Checking details with amount in words.
CheckDetailsCheckId	String	False			Id of check.
CheckDetailsCheckNumber	String	False			Number if check.
CheckDetailsCheckStatus	String	False			Status of check.
CheckDetailsMemo	String	False			Memo of check details.
CheckDetailsTemplateId	String	False			Template Id of a vendor payment in check.
CreatedTime	Datetime	True			Time at which the vendor payment was created.
CurrencyId	String	True	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String	True			Currency symbol of the customer's currency.
CustomFields	String	False			Custom Fields.
Date	Date	False			Date of a vendor payment.
Description	String	False			Description of the vendor payment.
ExchangeRate	Decimal	False			Exchange rate of a vendor payment.
IsAchPayment	Boolean	True			Check if the payment if done with ACH payment.
IsPaidViaPrintCheck	Boolean	False			Check if vendor payment paid via print check.
IsPreGst	Boolean	True			Check if vendor payment includes pre GST.
IsTdsAmountInPercent	Boolean	True			Check if the TDS amount is in percent.
LastModifiedTime	Datetime	True			The time of last modification of the vendor payment.
OffsetAccountId	String	True	BankAccounts.AccountId		Id of an offset account.
OffsetAccountName	String	True			Name of an offset account.
PaidThroughAccountId	String	False	BankAccounts.AccountId		Account Id from which vendor payment has been made.
PaidThroughAccountName	String	True			Account name from which vendor payment has been made.
PaidThroughAccountType	String	True			Account type from which vendor payment has been made.
PaymentMode	String	False			Mode through which payment is made.
PaymentNumber	Integer	True			Number through which payment is made.
ProductDescription	String	True			Description of the product.
PurposeCode	String	True			Purpose code of vendor payment.
ReferenceNumber	String	False			Reference number of a vendor payment.
TaxAccountId	String	True	BankAccounts.AccountId		ID of a tax account.
TaxAccountName	String	True			Name of a tax account.
TaxAmountWithheld	Decimal	True			Amount withheld for tax.
TdsTaxId	String	True			ID of a TDS tax.

VendorPaymentsRefund

Read, Insert and Update Vendor Credit Refunds.

Table Specific Information

Select

The Sync App 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 Sync App.

VendorPaymentId supports the '=' comparison.
VendorPaymentRefundId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM VendorPaymentsRefund

SELECT * FROM VendorPaymentsRefund WHERE VendorPaymentId = '3285934000000429001'

SELECT * FROM VendorPaymentsRefund WHERE VendorPaymentRefundId = '3285934000000429017'

Insert

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

INSERT INTO VendorPaymentsRefund (Date,Amount,ToAccountId,VendorPaymentId) VALUES ('2023-02-27','1200',3285934000000259036,3285934000000429001)

Update

Update can be executed by specifying the Amount,Date and AccountId in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE VendorPaymentsRefund SET Description = 'test2' where vendorpaymentrefundid=3285934000000437017 and VendorPaymentId=3285934000000429001

Delete

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

Delete from VendorPaymentsRefund where VendorPaymentId=3285934000000429001 and vendorpaymentrefundid=3285934000000437017

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
VendorPaymentId [KEY]	String	True			Vendor Payment Id
VendorPaymentRefundId [KEY]	String	True			Vendor Payment Refund Id
ToAccountId	String	False			To Account ID
ToAccountName	String	False			To Account Name
Amount	Integer	False			Amount
AmountBcy	Integer	False			Amount BCY
AmountFcy	Integer	False			Amount FCY
CustomFields	String	True			Custom Fields
CustomerName	String	False			Customer Name
Date	Date	False			Date
Description	String	False			Description
ReferenceNumber	String	False			Reference Number
RefundMode	String	False			Refund Mode

ビュー

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Zoho Books Connector for CData Sync ビュー


Name	Description
AccountTransactionsReport	Generated schema file.
BalanceSheetsReport	This report summarizes your company's assets, liabilities and equity at a specific point in time
BankMatchingTransactions	Retrieves the list of transactions which includes invoices/bills/credit-notes.
BankRuleCriterions	Get criterions of a specific bank rule.
BankTransactionLineItems	Get details of bank transaction line items.
BaseCurrencyAdjustmentAccounts	Retrieves lists of base currency adjustment accounts.
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.
Budgets	To get the list of budgets
BusinessPerformanceRatiosReport	Generated schema file.
CashFlowReport	Generated schema file.
ChartOfAccountInlineTransactions	Retrieves the list of inline transactions.
ChartOfAccountTransactions	Retrieves list of all involved transactions for the given account.
CommittedStockDetailsReport	Generated schema file.
ContactAddresses	Get addresses of a contact including its Shipping Address, Billing Address.
Contacts	Retrieves list of all contacts.
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.
CurrencyExchangeRates	Retrieves list of exchange rates configured for the currency.
CustomerBalancesReport	Generated schema file.
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.
EstimateLineItems	Get the details of line items for estimates.
Estimates	Retrieves list of all estimates.
Expenses	Retrieves list of all the Expenses.
GeneralLedgerReport	Generated schema file.
InventorySummaryReport	Generated schema file.
InventoryValuationReport	Generated schema file.
InvoiceAppliedCredits	Retrieves list of credits applied for 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.
Items	Retrieves list of all active items.
JournalLineItems	Retrieves list of line items of a journal.
JournalReport	Generated schema file.
MovementOfEquityReport	Generated schema file.
OpeningBalanceAccounts	Retrieves list of accounts of opening balance.
OpeningBalanceTransactionSummaries	Get transaction summaries of opening balance.
Organizations	Retrieves list of organizations.
PaymentsReceivedReport	Generated schema file.
ProductSalesReport	Generated schema file.
ProfitsAndLossesReport	This report summarizes your company's assets, liabilities and equity at a specific point in time
ProjectInvoices	Retrieves list of invoices created for a project.
ProjectPerformanceSummaryReport	Generated schema file.
ProjectUsers	Retrieves list of users associated with a project. Also, get details of a user in project.
PurchaseOrderLineItems	Get the details of line items of purchase orders.
PurchaseOrders	Retrieves list of all purchase orders.
PurchaseOrdersByVendorReport	Generated schema file.
RecurringBillLineItems	Get the details of a line items of bills.
RecurringBills	To list, add, update and delete details of a bill.
RecurringExpenses	Retrieves list of all the Expenses.
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.
ReportsAccountTransactionsDetails	Retrieves the list of inline transactions.
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.
SalesByCustomerReport	Generated schema file.
SalesByItemReport	Generated schema file.
SalesBySalespersonReport	Generated schema file.
SalesOrderLineItems	Retrieves list of line items of a sales order.
SalesOrders	Retrieves list of all sales orders.
StockSummaryReport	Generated schema file.
TaxSummaryReport	This report summarizes your company's assets, liabilities and equity at a specific point in time
TrialBalanceReport	This report summarizes your company's assets, liabilities and equity at a specific point in time
VendorBalancesReport	Generated schema file.
VendorCreditBills	Retrieves list of bills to which the vendor credit is applied.
VendorCreditLineItems	Retrieves list of line items from vendor credits.
VendorCredits	Retrieves list of vendor credits.
VendorPayments	Retrieves list of all the payments made to your vendor.

AccountTransactionsReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
CashBased supports the '=' comparison.
AccountTrasactionsTransactionType supports the 'IN', 'NOT IN' comparison.
AccountTrasactionsAccountId supports the 'IN' comparison.
AccountTrasactionsContactId supports the 'IN', 'NOT IN' comparison.
AccountTrasactionsProjectIds supports the 'IN', 'IS NULL', 'IS NOT NULL' comparison.
AccountTrasactionsAccountAccountType supports the '=', '!=' comparison.
AccountTrasactionsAccountAccountGroup supports the '=', '!=' comparison.

For example:

    SELECT * FROM accounttransactionsreport

    SELECT * FROM accounttransactionsreport WHERE TransactionDate = 'Today'

    SELECT * FROM accounttransactionsreport WHERE ToDate = '2022-10-31'

    SELECT * FROM accounttransactionsreport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

    SELECT * FROM accounttransactionsreport WHERE CashBased = True
	
    SELECT * FROM accounttransactionsreport WHERE AccountTrasactionsTransactionType NOT IN ('Invoices','Bills')
	
    SELECT * FROM accounttransactionsreport WHERE AccountTrasactionsAccountId IN ('3285934000000000373')
	
    SELECT * FROM accounttransactionsreport WHERE AccountTrasactionsProjectIds IS NULL
	
    SELECT * FROM accounttransactionsreport WHERE AccountTrasactionsAccountAccountType = 'Asset'
	
    SELECT * FROM accounttransactionsreport WHERE AccountTrasactionsAccountAccountGroup != 'Liability'

Columns


Name	Type	References	SupportedOperators	Description
AccountTrasactionsAccountAccountCode	String			Account Trasactions Account Account Code
AccountTrasactionsAccountName	String			Account Trasactions Account Name
AccountTrasactionsContactName	String			Account Trasactions Contact Name
AccountTrasactionsDescription	String			Account Trasactions Description
AccountTrasactionsCredit	Double			Account Trasactions Credit
AccountTrasactionsCurrencyCode	String			Account Trasactions Currency Code
AccountTransactionsDate	Date			Account Transaction sDate
AccountTrasactionsDebit	Decimal			Account Trasactions Debit
AccountTrasactionsEntityNumber	String			Account Trasactions Entity Number
AccountTrasactionsNetAmount	String			Account Trasactions Net Amount
AccountTrasactionsOffsetAccountId	String			Account Trasactions Offset Account Id
AccountTrasactionsOffsetAccountType	String			Account Trasactions Offset Account Type
AccountTrasactionsReferenceNumber	String			Account Trasactions Reference Number
AccountTrasactionsReferenceTransactionId	String			Account Trasactions Reference Transaction Id
AccountTrasactionsReportingTag	String			Account Trasactions Reporting Tag
AccountTrasactionsTransactionDetails	String			Account Trasactions Transaction Details
AccountTrasactionsTransactionId	String			Account Trasactions Transaction Id
AccountTrasactionsFCYCredit	String			Account Trasactions FCY Credit
AccountTrasactionsFcyDebit	String			Account Trasactions Fcy Debit
AccountTrasactionsFcyNetAmount	String			Account Trasactions Fcy Net Amount
OpeningBalanceAccountCreditBalance	Integer			Opening Balance Account Credit Balance
OpeningBalanceCredit	String			Opening Balance Credit
OpeningBalanceDate	String			Opening Balance Date
OpeningBalanceDebit	String			Opening Balance Debit
OpeningBalanceFCYCredit	String			Opening Balance FCY Credit
OpeningBalanceFcyDebit	String			Opening Balance Fcy Debit
OpeningBalanceName	String			Opening Balance Name
ClosingBalanceCredit	String			Closing Balance Credit
ClosingBalanceDate	String			Closing Balance Date
ClosingBalanceDebit	String			Closing Balance Debit
ClosingBalanceFcyCredit	String			Closing Balance Fcy Credit
ClosingBalanceFcyDebit	String			Closing Balance Fcy Debit
ClosingBalanceName	String			Closing Balance Name
AccountTrasactionsAccountAccountGroup	String		=, !=	Account Trasactions Account Account Group 使用できる値は次のとおりです。Asset, OtherAsset, OtherCurrentAsset, Bank, Cash, FixedAsset, Liability, OtherCurrentLiability, CreditCard, LongTermLiablity, OtherLiability, Equity, Income, OtherIncome, Expense, CostOfGoodsSold, OtherExpense, AccountsReceivable, AccountsPayable, Stock, PaymentClearingAccount, PrepaidCard, OverseasTaxPayable, OutputTax, InputTax
AccountTrasactionsAccountAccountType	String		=, !=	Account Trasactions AccountAccount Type 使用できる値は次のとおりです。Asset, OtherAsset, OtherCurrentAsset, Bank, Cash, FixedAsset, Liability, OtherCurrentLiability, CreditCard, LongTermLiablity, OtherLiability, Equity, Income, OtherIncome, Expense, CostOfGoodsSold, OtherExpense, AccountsReceivable, AccountsPayable, Stock, PaymentClearingAccount, PrepaidCard, OverseasTaxPayable, OutputTax, InputTax
AccountTrasactionsTransactionType	String		IN, NOT IN	AccountTrasactions Transaction Type 使用できる値は次のとおりです。Invoices, Bills, PaymentsMade, CreditNote, CreditNotesRefund, VendorCredits, VendorCreditsRefund, Expense, Journal, BaseCurrencyAdjustment, DebitNote, CustomerPayment, VendorPayment, PaymentRefund, RetainerPayment, InventoryAdjustmentByQuantity, InventoryAdjustmentByValue, TransferOrderTo, TransferOrderFrom, SalesWithoutInvoices, ExpenseRefund, EmployeeReimbursement
AccountTrasactionsProjectIds	String		IN, IS NULL, IS NOT NULL	Account Trasactions Project Ids
AccountTrasactionsContactId	String		IN, NOT IN	Account Trasactions Contact Id
AccountTrasactionsAccountId	String		IN	Account Trasactions Account Id

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
CashBased	Boolean		Cash Based
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date

BalanceSheetsReport

This report summarizes your company's assets, liabilities and equity at a specific point in time

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
CashBased supports the '=' comparison.

For example:

    SELECT * FROM BalanceSheetsReport

    SELECT * FROM BalanceSheetsReport WHERE TransactionDate = 'Today'

    SELECT * FROM BalanceSheetsReport WHERE ToDate = '2022-10-31'

    SELECT * FROM BalanceSheetsReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

    SELECT * FROM BalanceSheetsReport WHERE CashBased = True

Columns


Name	Type	References	SupportedOperators	Description
BalanceTypeName	String			Balance Type Name
SubBalanceTypeName	String			SubBalance Type Name
AccountTransactionTypeName	String			Account Transaction Type Name
SubAccountTransactionTypeName	String			Sub Account Transaction Type Name
AccountTransactionTotal	Decimal			Account Transaction Total
SubAccountTransactionTotal	Decimal			Sub Account Transaction Total
SubBalanceTypeTotal	Decimal			SubBalance Type Total
BalanceTypeTotal	Decimal			Balance Type Total

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
CashBased	Boolean		Balance Type Total
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date

BankMatchingTransactions

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

Table Specific Information

Select

The Sync App 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 Sync App. 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.

BankRuleCriterions

Get criterions of a specific bank rule.

Table Specific Information

Select

The Sync App 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 Sync App.

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.

BankTransactionLineItems

Get details of bank transaction line items.

Table Specific Information

Select

The Sync App 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 Sync App.
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.

BaseCurrencyAdjustmentAccounts

Retrieves lists of base currency adjustment accounts.

Table Specific Information

Select

The Sync App 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 Sync App.

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.

BillLineItems

Get the details of a line items of bills.

Table Specific Information

Select

The Sync App 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 Sync App.
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
LineItemId [KEY]	String			Id of line item.
BillId	String	Bills.BillId		Id of a Bill.
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.

BillPayments

Get the list of payments made for a bill.

Table Specific Information

Select

The Sync App 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 Sync App.

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.

Bills

Retrieves list of bills.

Table Specific Information

Select

The Sync App 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 Sync App.

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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。Status.All, Status.PartiallyPaid, Status.Paid, Status.Overdue, Status.Void, Status.Open
ItemId	String		Id of an Item.
ItemDescription	String		Description of a bill.

Budgets

To get the list of budgets

Table Specific Information

Select

The Sync App 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 Sync App.

BudgetId supports the '=' comparison.

For example:

    SELECT * FROM Budgets 

    SELECT * FROM Budgets where budgetid=3255827000000081030

Columns


Name	Type	References	SupportedOperators	Description
BudgetId [KEY]	String		=	Budget Id
BudgetStartDate	Integer			Budget Start Date
Year	Integer			Year
Frequency	String			Frequency
CustomFields	String			Custom Fields
TagOptionName	Date			Tag Option Name
ProjectName	String			Project Name
BudgetEndDate	String			Budget End Date
EntityType	String			Entity Type
BranchId	String			Branch Id
ProjectId	String			Project Id
BranchName	String			Branch Name
Name	String			Name

BusinessPerformanceRatiosReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToMonth supports the '=' comparison.
FromMonth supports the '=' comparison.

For example:

    SELECT * FROM businessperformanceratiosreport

    SELECT * FROM businessperformanceratiosreport WHERE TransactionDate = 'PreviousQuarter'

    SELECT * FROM businessperformanceratiosreport WHERE TransactionDate = 'CustomDate' and FromMonth = '2022-10' and ToMonth = '2022-11'

Columns


Name	Type	References	SupportedOperators	Description
DashboardMonth	String			DashboardMonth
Denominator	Integer			Denominator
DiffLastQuarter	Double			DiffLastQuarter
DiffLastSixMonths	Double			DiffLastSixMonths
DiffLastTwelveMonths	Double			DiffLastTwelveMonths
DiffLastYear	Double			DiffLastYear
LastQuarter	Integer			LastQuarter
LastSixMonths	Double			LastSixMonths
LastTwelveMonths	Double			LastTwelveMonths
LastYear	Double			LastYear
Numerator	Integer			Numerator
PreLastQuarter	Double			PreLastQuarter
PreLastSixMonths	Double			PreLastSixMonths
PreLastTwelveMonths	Double			PreLastTwelveMonths
PreLastYear	Double			PreLastYear
PreviousValues	String			PreviousValues
Ratio	Integer			Ratio
RatioPrev	Integer			RatioPrev

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
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。PreviousQuarter, PreviousYear, LastSixMonths, LastTwelveMonths, CustomDate
ToMonth	String		To Months
FromMonth	String		From Month
UseState	Boolean		UseState デフォルト値はtrueです。

CashFlowReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.

For example:

    SELECT * FROM cashflowreport

    SELECT * FROM cashflowreport WHERE TransactionDate = 'Today'

    SELECT * FROM cashflowreport WHERE ToDate = '2022-10-31'

    SELECT * FROM cashflowreport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

Columns


Name	Type	References	SupportedOperators	Description
Label	String			Label
Name	String			Name
AccountName	String			Account Name
AccountCode	String			Account Code
AccountId	String			Account Id
LabelTotal	String			Label Total
Total	String			Total
AccountTotal	String			Account Total
NetTotalForName	Double			Net Total For 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
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date

ChartOfAccountInlineTransactions

Retrieves the list of inline transactions.

Table Specific Information

Select

The Sync App 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 Sync App.

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.

ChartOfAccountTransactions

Retrieves list of all involved transactions for the given account.

Table Specific Information

Select

The Sync App 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 Sync App. 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	Decimal			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. 使用できる値は次のとおりです。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.

CommittedStockDetailsReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
CustomerID supports the 'IN' comparison.
ItemName supports the '=, !=, LIKE, NOT LIKE, CONTAINS, IS NULL, IS NOT NULL' comparison.

For example:

    SELECT * FROM committedstockdetailsreport

    SELECT * FROM committedstockdetailsreport WHERE TransactionDate = 'Today'

    SELECT * FROM committedstockdetailsreport WHERE ToDate = '2022-10-31'

    SELECT * FROM committedstockdetailsreport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

    SELECT * FROM committedstockdetailsreport WHERE CustomerID IN ('3456743221369')

    SELECT * FROM committedstockdetailsreport WHERE ItemName IS NULL

Columns


Name	Type	References	SupportedOperators	Description
SalesOrderId	String			Sales OrderId
SalesOrderNumber	String			Sales OrderNumber
OrderType	String			Order Type
CustomerName	String			Customer Name
CommittedStock	Double			Committed Stock
IsSalesOrder	Double			Is SalesOrder
CreatedTime	Datetime			Created Time
Date	Date			Date
ItemUnit	String			Item Unit
ItemProductType	String			Item ProductType
ItemCreatedBy	String			Item CreatedBy
ItemStatus	String			Item Status
ItemDescription	String			Item Description
ItemPurchaseDescription	String			Item Purchase Description
ItemPurchaseRate	String			Item Purchase Rate
ItemItemType	String			Item ItemType
ItemRate	String			Item Rate
ItemLastModitfiedTime	Datetime			Item Last Moditfied Time
ItemCreatedTime	Datetime			Item Created Time
ContactCompanyName	String			Contact Company Name
ContactNotes	String			Contact Notes
ContactPaymentTerms	String			Contact Payment Terms
ContactOutstandingReceivableAmountBcy	Integer			Contact Outstanding Receivable Amount Bcy
ContactSkype	String			Contact Skype
ContactTwitter	String			Contact Twitter
ContactUnusedCreditsReceivableAmountBcy	Integer			Contact Unused Credits Receivable Amount Bcy
ContactMobilePhone	String			Contact Mobile Phone
ContactCreditLimit	Integer			Contact Credit Limit
ContactDepartment	String			Contact Department
ContactFirstName	String			Contact First Name
ContactEmail	String			Contact Email
ContactCreatedTime	Datetime			Contact Created Time
ContactOutstandingReceivableAmount	Integer			Contact Outstanding Receivable Amount
ContactWebsite	String			Contact Website
ContactLastModifiedTime	Datetime			Contact Last ModifiedTime
ContactCustomerSubType	String			Contact Customer SubType
ContactFacebook	String			Contact Facebook
ContactLastName	String			Contact LastName
ContactCreatedBy	String			Contact Created By
ContactPhone	String			Contact Phone
ContactDesignation	String			Contact Designation
ContactCompanyName	String			Contact Company Name
ItemName	String		=, !=, LIKE, NOT LIKE, CONTAINS, IS NULL, IS NOT NULL	ItemName

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
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date
CustomerId	String		Customer Id

ContactAddresses

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

Table Specific Information

Select

The Sync App 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 Sync App.

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.

Contacts

Retrieves list of all contacts.

Table Specific Information

Select

The Sync App 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 Sync App.

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. 使用できる値は次のとおりです。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.

CreditNoteInvoices

Retrieves details of invoices from an existing Credit Note.

Table Specific Information

Select

The Sync App 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 Sync App.
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.

CreditNoteLineItems

Retrieves details of line items from existing Credit Notes.

Table Specific Information

Select

The Sync App 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 Sync App.
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.

CreditNotes

Retrieves list of all the Credit Notes.

Table Specific Information

Select

The Sync App 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 Sync App.

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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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.

CurrencyExchangeRates

Retrieves list of exchange rates configured for the currency.

Table Specific Information

Select

The Sync App 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 Sync App.

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.

CustomerBalancesReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

ReportDate supports the '=' comparison.
CustomerID supports the '=' comparison.

For example:

    SELECT * FROM customerbalancesreport

    SELECT * FROM customerbalancesreport WHERE ReportDate = '2022-10-31'

    SELECT * FROM customerbalancesreport WHERE CustomerID = '3456743221369'

Columns


Name	Type	References	SupportedOperators	Description
AvailableCredits	Integer			Available Credits
BcyAdvancePayment	String			BcyAdvance Payment
BcyAvailableCredits	Integer			Bcy Available Credits
BcyBalance	Integer			Bcy Balance
BcyCreditBalance	String			Bcy CreditBalance
BcyInvoiceBalance	Integer			Bcy Invoice Balance
BcyJournalCredits	String			Bcy Journal Credits
ContactCompanyName	String			Contact Company Name
ContactCreatedBy	String			Contact Created By
ContactCreatedTime	Datetime			Contact Created Time
ContactCreditLimit	Integer			Contact Credit Limit
ContactCustomerSubType	String			Contact Customer SubType
ContactDepartment	String			Contact Department
ContactDesignation	String			Contact Designation
ContactEmail	String			Contact Email
ContactFacebook	String			Contact Facebook
ContactFirstName	String			Contact First Name
ContactLastModifiedTime	Datetime			Contact Last Modified Time
ContactLastName	String			Contact Last Name
ContactMobilePhone	String			Contact Mobile Phone
ContactNotes	String			Contact Notes
ContactOutstandingReceivableAmount	Integer			Contact Outstanding Receivable Amount
ContactOutstandingReceivableAmountBcy	Integer			Contact Outstanding Receivable Amount Bcy
ContactPaymentTerms	String			Contact Payment Terms
ContactPhone	String			Contact Phone
ContactSkype	String			Contact Skype
ContactStatus	String			Contact Status
ContactTwitter	String			Contact Twitter
ContactUnusedCreditsReceivableAmount	Integer			Contact Unused Credits Receivable Amount
ContactUnusedCreditsReceivableAmountBcy	Integer			Contact Unused Credits Receivable Amount Bcy
ContactWebsite	String			Contact Website
CreditLimit	Integer			Credit Limit
CurrencyId	String			Currency Id
CustomerName	String			Customer Name
FcyAdvancePayment	String			Fcy AdvancePayment
FcyBalance	Integer			Fcy Balance
FcyCreditBalance	String			Fcy Credit Balance
FcyJournalCredits	String			Fcy Journal Credits
InvoiceBalance	Integer			Invoice Balance
TotalBcyAdvancePayment	String			Total Bcy Advance Payment
TotalBcyAvailableCredits	Integer			Total Bcy Available Credits
TotalBcyBalance	Integer			Total Bcy Balance
TotalBcyCreditBalance	String			Total Bcy Credit Balance
TotalBcyInvoiceBalance	Integer			Total Bcy Invoice Balance
TotalBcyJournalCredits	String			Total Bcy Journal Credits
CustomerId	String		=	Customer Id

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
ReportDate	Date		Report Date

CustomerPayments

Retrieves list of all the payments made by your customer.

Table Specific Information

Select

The Sync App 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 Sync App.

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. 使用できる値は次のとおりです。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.

Employees

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

Table Specific Information

Select

The Sync App 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 Sync App.

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. 使用できる値は次のとおりです。All, Billable, Nonbillable, Reimbursed, Invoiced, Unbilled

EstimateApprovers

Get the details of approvers for estimates.

Table Specific Information

Select

The Sync App 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 Sync App.

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.

EstimateLineItems

Get the details of line items for estimates.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: EstimateId is required in order to query EstimateLineItems.

EstimateId supports the '=' comparison.

For example:

    SELECT * FROM EstimateLineItems WHERE EstimateId = '1894553000000077244'

Columns


Name	Type	References	SupportedOperators	Description
LineItemId [KEY]	String			Id of the line item.
EstimateId	String	Estimates.EstimateId		ID of an estimate.
BcyRate	Decimal			Rate of base currency.
CustomFields	String			Custom Fields defined for the line item
Description	String			Description of the estimate line items.
Discount	String			Discount given to specific item in estimate.
DiscountAmount	Decimal			Amount of discount given to estimate.
HeaderId	String			ID of the header.
HeaderName	String			Name of the header.
ItemId	String	Items.ItemId		ID of the item.
ItemOrder	Integer			Order of the item.
ItemTotal	Decimal			Total number of items.
Name	String			Name of the line item.
PricebookId	String			Id of a pricebook.
Quantity	Decimal			Quantity of the line item.
Rate	Decimal			Rate of the line item.
Tags	String			Details of tags related to estimates.
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.

Estimates

Retrieves list of all estimates.

Table Specific Information

Select

The Sync App 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 Sync App.

CustomerId supports the '=' comparison.
CustomerName supports the '=' comparison.
Date supports the '=,<,>' comparisons.
EstimateNumber supports the '=' comparison.
ExpiryDate supports the '=' comparison.
ReferenceNumber supports the '=' comparison.
Status supports the '=' comparison.
Total supports the '=,<,<=,>,>=' comparisons.
ItemId supports the '=' comparison.
ItemName supports the '=' comparison.
ItemDescription supports the '=' comparison.

For example:

    SELECT * FROM Estimates WHERE Total >= 500 AND Total <= 600

    SELECT * FROM Estimates WHERE Date <= '2019-02-26'

    SELECT * FROM Estimates ORDER BY CustomerName

    SELECT * FROM Estimates WHERE CONTAINS(EstimateNumber,'006')

Columns


Name	Type	References	SupportedOperators	Description
EstimateId [KEY]	String			ID of an estimate.
AcceptedDate	Date			Accepted date of an estimate.
ClientViewedTime	Datetime			Time when client viewed the estimate.
ColorCode	String			Color code of estimates.
CompanyName	String			Name of the company.
CreatedTime	Datetime			Time at which the estimate was created.
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. Search estimates by customer id..
CustomerName	String			Name of the customer or vendor. Search estimates by customer name.
Date	Date		=,<,>	Date of an estimate.
DeclinedDate	Date			Declined date of the estimate.
EstimateNumber	String			Number of the estimate.
ExpiryDate	Date			The date of expiration of the estimates.
HasAttachment	Boolean			Check if the estimate has attachment.
IsEmailed	Boolean			Check if the estimate is emailed.
ReferenceNumber	String			Reference number of the estimate.
Status	String			Status of the estimate. 使用できる値は次のとおりです。draft, sent, invoiced, accepted, declined, expired
Total	Decimal		=,<,<=,>,>=	Total of estimates. Search estimates by estimate total.

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
ItemId	String		ID of the item.
ItemName	String		Name of an item.
ItemDescription	String		Description of an item.
EstimateFilter	String		Filter estimates by status. 使用できる値は次のとおりです。Status.All, Status.Sent, Status.Draft, Status.Invoiced, Status.Accepted, Status.Declined, Status.Expired

Expenses

Retrieves list of all the Expenses.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountName supports the '=' comparison.
CustomerId supports the '=' comparison.
CustomerName supports the '=' comparison.
Description supports the '=' comparison.
PaidThroughAccountName supports the '=' comparison.
ReferenceNumber supports the '=' comparison.
Status supports the '=' comparison.
VendorId supports the '=' comparison.
VendorName supports the '=' comparison.
RecurringExpenseId supports the '=' comparison.
ExpenseFilter supports the '=' comparison.
Date supports the '=,<,>' comparisons.
Amount supports the '=,<,<=,>,>=' comparisons.

For example:

    SELECT * FROM Expenses WHERE Amount < 10000.0 AND Amount > 300.0

    SELECT * FROM Expenses WHERE ExpenseFilter = 'Status.Billable'

Columns


Name	Type	References	SupportedOperators	Description
ExpenseId [KEY]	String			ID of an expense.
AccountName	String			Name of the account.
BcyTotal	Decimal			Total Base Currency.
BcyTotalWithoutTax	Decimal			Base Currency total amount without tax.
CreatedTime	Datetime			Time at which the expense was created.
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 an expense.
Description	String			Description of the expense.
Distance	Double			Distance Covered.
EndReading	String			End reading of odometer when creating a mileage expense where mileage_type is odometer.
ExchangeRate	Decimal			Exchange rate of the currency.
ExpenseReceiptName	String			Name of the expense receipt.
ExpenseType	String			Type of an expense.
HasAttachment	Boolean			Check if the expense has attachment.
IsBillable	Boolean			Check if the expense is billable.
IsPersonal	Boolean			Check if the expense is personal.
LastModifiedTime	Datetime			The time of last modification of the expense.
MileageRate	Double			Mileage rate for a particular mileage expense.
MileageType	String			Type of Mileage.
MileageUnit	String			Unit of the distance travelled.
PaidThroughAccountName	String			Name of account which payment was paid.
ReferenceNumber	String			Reference number of a expense.
ReportId	String			ID of report.
ReportName	String			Name of the report.
StartReading	String			Start reading of odometer when creating a mileage expense where mileage_type is odometer.
Status	String			Status of the expense. 使用できる値は次のとおりです。unbilled, invoiced, reimbursed, non-billable, billable
Total	Decimal			Total of expenses.
TotalWithoutTax	Decimal			Total amount of expense calculated without tax.
VendorId	String			ID of the vendor the expense has been made.
VendorName	String			Name of the vendor the expense has been made.

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
Amount	Decimal		Amount of the expenses.
ExpenseFilter	String		Filter expenses by their status. 使用できる値は次のとおりです。Status.All, Status.Billable, Status.Nonbillable, Status.Reimbursed, Status.InvoicedStatus.Unbilled
RecurringExpenseId	String		Id of the recurring expense.

GeneralLedgerReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
CashBased supports the '=' comparison.
AccountType supports the '=' comparison.
ProjectId supports the 'IN, IS NULL, IS NOT NULL' comparison.

For example:

    SELECT * FROM GeneralLedgerReport

    SELECT * FROM GeneralLedgerReport WHERE TransactionDate = 'Today'

    SELECT * FROM GeneralLedgerReport WHERE ToDate = '2022-10-31'

    SELECT * FROM GeneralLedgerReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

    SELECT * FROM GeneralLedgerReport WHERE CashBased = True
	
	SELECT * FROM GeneralLedgerReport WHERE AccountType = 'Asset'
	
	SELECT * FROM GeneralLedgerReport WHERE ProjectId IN ('234457895670')

Columns


Name	Type	References	SupportedOperators	Description
AccountCode	String			Account Code
AccountGroup	String			Account Group
AccountId	String			Account Id
Balance	Integer			Balance
BalanceSubAccount	String			Balance Sub Account
ClosingBalance	Integer			Closing Balance
ClosingBalanceSubAccount	Integer			Closing Balance Sub Account
CreditTotal	Integer			Credit Total
CreditTotalSubAccount	String			Credit TotalSub Account
DebitTotal	Integer			Debit Total
DebitTotalSubAccount	String			Debit TotalSub Account
Depth	Integer			Depth
IsChildPresent	Boolean			Is Child Present
IsCollapsedView	Boolean			Is Collapsed View
IsDebit	Boolean			IsDebit
Name	String			Name
OpeningBalance	Integer			Opening Balance
OpeningBalanceSubAccount	Integer			Opening Balance Sub Account
PreviousValues	String			Previous Values
AccountType	String		=	Account Type 使用できる値は次のとおりです。Asset, OtherAsset, OtherCurrentAsset, Bank, Cash, FixedAsset, Liability, OtherCurrentLiability, CreditCard, LongTermLiablity, OtherLiability, Equity, Income, OtherIncome, Expense, CostOfGoodsSold, OtherExpense, AccountsReceivable, AccountsPayable, Stock, PaymentClearingAccount, PrepaidCard, OverseasTaxPayable, OutputTax, InputTax

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
CashBased	Boolean		Cash Based
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date
ProjectId	String

InventorySummaryReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
WarehouseId supports the '=' comparison.
StockAvailability supports the '=' comparison.
Status supports the '=' comparison.
ItemId supports the 'IN' comparison.

For example:

    SELECT * FROM InventorySummaryReport

    SELECT * FROM InventorySummaryReport WHERE TransactionDate = 'Today'

    SELECT * FROM InventorySummaryReport WHERE ToDate = '2022-10-31'

    SELECT * FROM InventorySummaryReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

    SELECT * FROM InventorySummaryReport WHERE warehouseid='3285934000000113095'
	
	SELECT * FROM InventorySummaryReport WHERE StockAvailability = 'AvailableStock'
	
	SELECT * FROM InventorySummaryReport WHERE ItemId IN ('5672409674565')
	
	SELECT * FROM InventorySummaryReport WHERE Status = 'Active'

Columns


Name	Type	References	SupportedOperators	Description
CategoryId	String			Category Id
CategoryName	String			Category Name
IsComboProduct	Boolean			Is Combo Product
QuantityAvailable	Double			Quantity Available
QuantityAvailableForSale	Double			Quantity AvailableForSale
QuantityDemanded	Double			Quantity Demanded
QuantityOrdered	Double			Quantity Ordered
QuantityPurchased	Double			Quantity Purchased
QuantitySold	Double			Quantity Sold
ReorderLevel	String			Reorder Level
Unit	String			Unit
ItemName	String			Item Name
Status	String			Status 使用できる値は次のとおりです。All, Active, Inactive デフォルト値はAllです。
Sku	String			Sku
ItemId	String			Item Id

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
WarehouseId	String		Warehouse Id
StockAvailability	String		Stock Availability 使用できる値は次のとおりです。AvailableStock, OutOfStock, StockLessThanZero, StockEqualToZero デフォルト値はAllです。
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date

InventoryValuationReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
ItemId supports the 'IN' comparison.
Status supports the '=' comparison.
StockAvailability supports the '=' comparison.

For example:

    SELECT * FROM InventoryValuationReport

    SELECT * FROM InventoryValuationReport WHERE TransactionDate = 'Today'

    SELECT * FROM InventoryValuationReport WHERE ToDate = '2022-10-31'

    SELECT * FROM InventoryValuationReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

	SELECT * FROM InventoryValuationReport WHERE StockAvailability = 'AvailableStock'
	
	SELECT * FROM InventoryValuationReport WHERE ItemId IN ('5672409674565')
	
	SELECT * FROM InventoryValuationReport WHERE Status = 'Active'

Columns


Name	Type	References	SupportedOperators	Description
AssetValue	Integer			Asset Value
CategoryId	String			Category Id
CategoryName	String			Category Name
ItemCreatedBy	String			Item Created By
ItemCreatedTime	Datetime			Item Created Time
ItemDescription	String			Item Description
ItemItemType	String			Item Item Type
ItemLastModifiedTime	Datetime			Item Last Modified Time
ItemProductType	String			Item Product Type
ItemPurchaseDescription	String			Item Purchase Description
ItemPurchaseRate	Integer			Item Purchase Rate
ItemSalesPrice	Integer			Item Sales Price
ItemSalesDescription	String			Item Sales Description
ItemRate	Integer			Item Rate
ItemSku	String			Item Sku
ItemStatus	String			Item Status
ItemUnit	String			Item Unit
QuantityAvailable	Integer			Quantity Available
ReorderLevel	String			Reorder Level
ItemName	String			ItemName
Sku	String			Sku
ItemId	String		IN	ItemId
Status	String		=	Status 使用できる値は次のとおりです。All, Active, Inactive デフォルト値はAllです。

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
StockAvailability	String		Stock Availability 使用できる値は次のとおりです。AvailableStock, OutOfStock, StockLessThanZero, StockEqualToZero デフォルト値はAllです。
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date

InvoiceAppliedCredits

Retrieves list of credits applied for an invoice.

Table Specific Information

Select

The Sync App 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 Sync App.

InvoiceId supports the '=' comparison.

For example:

    SELECT * FROM InvoiceAppliedCredits WHERE InvoiceId = '1864543000000078539'

Columns


Name	Type	References	SupportedOperators	Description
CreditnotesInvoiceId [KEY]	String			ID of credit note invoice.
InvoiceId	String	Invoices.InvoiceId		ID of an invoice.
CreditnoteId	String	CreditNotes.CreditnoteId		ID of a credit note.
AmountApplied	Decimal			Amount used for the credit note.
CreditedDate	Date			Date when the credit was applied to the invoice.
CreditnotesNumber	String			Total number of credit notes applied to the invoice.

InvoiceLineItems

Get the details of line items from invoices.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: InvoiceId is required in order to query InvoiceLineItems.

InvoiceId supports the '=' comparison.

For example:

    SELECT * FROM InvoiceLineItems WHERE InvoiceId = '1864543000000078539'

Columns


Name	Type	References	SupportedOperators	Description
LineItemId [KEY]	String			Line Item ID of an item.
InvoiceId	String	Invoices.InvoiceId		ID of an invoice.
AccountId	String	BankAccounts.AccountId		ID of the Bank Account.
AccountName	String			Name of the account.
BcyRate	Decimal			Rate of Base Currency.
BillId	String	Bills.BillId		ID of an invoice.
BillItemId	String			Item ID of an invoice.
CustomFields	String			Custom Fields added for the line item
Description	String			Description of the invoice line item.
Discount	String			Discount applied in invoice.
DiscountAmount	Decimal			Discount Amount applied in invoice.
ExpenseId	String	Expenses.ExpenseId		Id of an expense.
ExpenseReceiptName	String			Receipt name of an expense.
GstTreatmentCode	String			Code GST treatement.
HasProductTypeMismatch	Boolean			Check if product type mismatch or not.
HeaderId	String			Id of a header.
HeaderName	String			Name of a header.
HsnOrSac	String			HSN Code.
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 an invoice.
ProductType	String			Type of the product.
ProjectId	String	Projects.ProjectId		Id of the project.
PurchaseRate	Double			Purchase rate of an invoice.
Quantity	Decimal			Quantity of line items.
Rate	Decimal			Rate of the line item.
ReverseChargeTaxId	String			ID of the reverse charge tax.
SalesorderItemId	String			Item ID of sales order.
TaxId	String	Taxes.TaxId		ID of tax.
TaxName	String			Name of tax.
TaxPercentage	Integer			Percentage of tax.
TaxType	String			Type of tax applied to invoice line item.
Unit	String			Number of unit in line items.

InvoicePayments

Get the list of payments made for an invoice.

Table Specific Information

Select

The Sync App 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 Sync App.

InvoiceId supports the '=' comparison.

For example:

    SELECT * FROM InvoicePayments WHERE InvoiceId = '1864543000000078539'

Columns


Name	Type	References	SupportedOperators	Description
InvoicePaymentId [KEY]	String			ID of an invoice payment.
InvoiceId	String	Invoices.InvoiceId		ID of an invoice.
PaymentId	String			ID of payment.
PaymentNumber	Integer			Number through which payment is made.
PaymentMode	String			Mode through which payment is made.
Description	String			Description of the invoice payment.
Date	Date			Date of an invoice payment.
ReferenceNumber	String			Reference number of an invoice payment.
ExchangeRate	Decimal			Exchange rate provided for this invoice.
Amount	Decimal			Amount of the invoice payments.
TaxAmountWithheld	Decimal			Amount withheld for tax.
OnlineTransactionId	String			ID of online transaction.
IsSingleInvoicePayment	Boolean			Check if the invoice is single invoice payment.

Invoices

Retrieves list of all invoices.

Table Specific Information

Select

The Sync App 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 Sync App.

InvoiceNumber supports the '=' comparison.
ProjectId supports the '=' comparison.
Balance supports the '=' comparison.
CustomerId supports the '=' comparison.
CustomerName supports the '=' comparison.
Date supports the '=,<,>' comparisons.
DueDate supports the '=,<,>' comparisons.
LastModifiedTime supports the '=' comparison.
ReferenceNumber supports the '=' comparison.
Status supports the '=' comparison.
Total supports the '=' comparison.
Email supports the '=' comparison.
RecurringInvoiceId supports the '=' comparison.
ItemId supports the '=' comparison.
ItemName supports the '=' comparison.
ItemDescription supports the '=' comparison.
InvoiceFilter supports the '=' comparison.

For example:

    SELECT * FROM Invoices WHERE InvoiceNumber = 'INV-000057' AND CustomerName = 'OldTech Industries' AND Date = '2016-03-02'

    SELECT * FROM Invoices WHERE DueDate > '2019-07-02'

    SELECT * FROM Invoices ORDER BY CreatedTime DESC

Columns


Name	Type	References	SupportedOperators	Description
InvoiceId [KEY]	String			ID of an invoice.
InvoiceNumber	String			Number of an invoice.
Adjustment	Decimal			Adjustments made to the invoices.
Balance	Decimal			The unpaid amount.
CompanyName	String			Name of the conpany.
CreatedTime	Datetime			Time at which the invoice was created.
CustomerId	String	Contacts.ContactId		ID of the customer the invoice has to be created.
CustomerName	String			The name of the customer.
Date	Date		=,<,>	Date of an invoice.
DueDate	Date		=,<,>	Date of when the invoice is due.
DueDays	String			Number of due day left for invoice.
HasAttachment	Boolean			Check if the invoice has attachment.
InvoiceURL	String			URL of Invoice.
LastModifiedTime	Datetime			The time of last modification of the invoice.
ProjectName	String			Name of the project.
ReferenceNumber	String			The reference number of the invoice.
Status	String			Status of the invoice. 使用できる値は次のとおりです。sent, draft, overdue, paid, void, unpaid, partially_paid, viewed
Total	Decimal			Total of invoices.

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
Email	String		Email address of an invoice.
RecurringInvoiceId	String		ID of the recurring invoice from which the invoice is created.
ItemId	String		Id of an item.
ItemName	String		Name of an item.
ItemDescription	String		Description of an item.
InvoiceFilter	String		Filter invoices by any status or payment expected date. 使用できる値は次のとおりです。Status.All, Status.Sent, Status.Draft, Status.OverDue, Status.Paid, Status.Void, Status.Unpaid, Status.PartiallyPaid, Status.Viewed, Date.PaymentExpectedDate

Items

Retrieves list of all active items.

Table Specific Information

Select

The Sync App 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 Sync App.

TaxId supports the '=' comparison.
TaxName supports the '=' comparison.
Description supports the '=' comparison.
Name supports the '=' comparison.
Rate supports the '=,<,<=,>,>=' comparisons.
AccountId supports the '=' comparison.
Status supports the '=' comparison.

For example:

    SELECT * FROM Items WHERE Rate < 200 AND Rate > 24.9

    SELECT * FROM Items WHERE Description = '16' AND Name = 'Monitor'

Columns


Name	Type	References	SupportedOperators	Description
ItemId [KEY]	String			ID of an item.
ItemName	String			Name of an item.
ItemType	String			Type of item.
TaxId	String	Taxes.TaxId		Id of a tax.
TaxName	String			Name of tax.
TaxPercentage	Integer			Tax percentage of item.
AccountName	String			Name of the account
Description	String			Description of an item.
HasAttachment	Boolean			Check if the items has attachment.
ImageDocumentId	String			ID of an image document.
Name	String			Name of an item.
Rate	Decimal		=,<,<=,>,>=	Price of the item. Search items by rate.
ReorderLevel	String			Reorder level of the item.
Status	String			Status of the item. 使用できる値は次のとおりです。All, Active, Inactive

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
AccountId	String		ID of the Bank Account to which the item has to be associated with.

JournalLineItems

Retrieves list of line items of a journal.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: JournalId is required in order to query JournalLineItems.

JournalId supports the '=' comparison.

For example:

    SELECT * FROM JournalLineItems WHERE JournalId = '1894553000000085774'

Columns


Name	Type	References	SupportedOperators	Description
LineId [KEY]	String			ID of line in journal.
JournalId	String	Journals.JournalId		ID of journal.
AccountId	String	BankAccounts.AccountId		ID of the Bank Account.
AccountName	String			Name of the account.
Amount	Decimal			Amount of the journal line items.
BcyAmount	Decimal			Amount of base currency.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String			Name of the customer or vendor.
DebitOrCredit	String			Indicates if line item is Credit or Debit.
Description	String			Description of the journal line item.
Tags	String			Details of tags related to journal line items.
TaxAuthorityId	String	Taxes.TaxAuthorityId		Authority ID for tax.
TaxExemptionId	String	BankRules.TaxExemptionId		ID of exemption in tax.
TaxExemptionType	String			Type of exemption in tax.
TaxId	String	Taxes.TaxId		Id of tax.
TaxName	String			Name of the tax.
TaxPercentage	Integer			Percentage applied for tax.
TaxType	String			Type of tax.

JournalReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
CashBased supports the '=' comparison.

For example:

    SELECT * FROM JournalReport

    SELECT * FROM JournalReport WHERE TransactionDate = 'Today'

    SELECT * FROM JournalReport WHERE ToDate = '2022-10-31'

    SELECT * FROM JournalReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

    SELECT * FROM JournalReport WHERE CashBased = True

Columns


Name	Type	References	SupportedOperators	Description
AccountTransactionsAccountId	String			Account Transactions Account Id
AccountTransactionsAccountName	String			Account Transactions Account Name
AccountTransactionsDebitAmount	String			Account Transactions Debit Amount
AccountTransactionsCreditAmount	String			Account Transactions Credit Amount
ContactId	String			Contact Id
ContactName	String			Contact Name
CreditFcyTotal	Integer			CreditFcyTotal
CreditTotal	Integer			CreditTotal
Date	String			Date
DebitFcyTotal	Integer			Debit FcyTotal
DebitTotal	Integer			Debit Total
EntityId	String			Entity Id
TransactionId	String			Transaction Id
TransactionNumber	String			Transaction Number
TransactionType	String			Transaction Type

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
CashBased	Boolean		Balance Type Total
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date

MovementOfEquityReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
CashBased supports the '=' comparison.
ProjectId supports the 'IN, Not In, IS NULL, IS Not NULL' comparison.
AccountType supports the '=' comparison.

For example:

    SELECT * FROM MovementOfEquityReport

    SELECT * FROM MovementOfEquityReport WHERE TransactionDate = 'Today'

    SELECT * FROM MovementOfEquityReport WHERE ToDate = '2022-10-31'

    SELECT * FROM MovementOfEquityReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

    SELECT * FROM MovementOfEquityReport WHERE AccountType = 'all'
	
	SELECT * FROM MovementOfEquityReport WHERE ProjectId IN ('2346789876554')

Columns


Name	Type	References	SupportedOperators	Description
Label	String			Label
LabelTotal	String			Label Total
SubLabelTotal	String			Sub Label Total
AccountName	String			Account Name
AccountCode	String			Account Code
AccountId	String			Account Id
AccountTotal	String			Account Total
SubLabel	String			Sub Label

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
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date
CashBased	Boolean		Balance Type Total
AccountType	String		Balance Type Total 使用できる値は次のとおりです。all, has_transactions, non_zero
ProjectId	String

OpeningBalanceAccounts

Retrieves list of accounts of opening balance.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the Sync App.

Columns


Name	Type	References	SupportedOperators	Description
AccountId [KEY]	String	BankAccounts.AccountId		ID of an account.
AccountName	String			Name of an account.
AccountSplitId	String			Split ID of an account.
AccountType	String			Type of the account.
BcyAmount	Decimal			Base currency of the amount.
CurrencyCode	String			Code of currency.
CurrencyId	String	Currencies.CurrencyId		ID of a currency.
DebitOrCredit	String			Type of mode the opening balance is.
ExchangeRate	Decimal			Exchange rate of the currency.
ProductId	String			ID of the product.
ProductName	String			Name of the product.
ProductStock	Integer			Stock of the product.
ProductStockRate	Integer			Stock rate of the product.

OpeningBalanceTransactionSummaries

Get transaction summaries of opening balance.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the Sync App.

Columns


Name	Type	References	SupportedOperators	Description
EntityType	String			Type of entity of opening balance transaction summaries.
Count	Integer			Count of transaction summary.

Organizations

Retrieves list of organizations.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the Sync App.

Columns


Name	Type	References	SupportedOperators	Description
OrganizationId [KEY]	String			ID of an organization.
AccountCreatedDate	Date			Date when the account was created.
CanChangeTimezone	Boolean			Check if the organization can change the timezone.
CanShowDocumentTab	Boolean			Check if the organization can show a document tab.
CanSignInvoice	Boolean			Check if an organization can sign invoice.
ContactName	String			Display Name of the contact. Max-length [200]
Country	String			Country of the organization.
CountryCode	String			Country code of the organization.
CurrencyFormat	String			Format of the currency used in the organization.
CurrencyCode	String			Currency code of the customer's currency.
CurrencyId	String	Currencies.CurrencyId		Currency ID of the customer's currency.
CurrencySymbol	String			Symbol of currency used in the organization.
DigitalSignatureMode	String			Mode of digital signature.
Email	String			Email address of an organization.
FieldSeparator	String			Character which is used as a field separator.
FiscalYearStartMonth	Integer			Start month of the fiscal year in an organization.
IsBillOfSupplyEnabled	Boolean			Check if the bill of the supply is enabled in an organization..
IsDefaultOrg	Boolean			Check if this is a default organization.
IsDesignatedZone	Boolean			Check if there is a designated zone in an organization.
IsDsignRequired	Boolean			Check if the digital signature is required in the organization.
IsExportWithPaymentEnabled	Boolean			Check if export with the payment enabled in the organization.
IsGstIndiaVersion	Boolean			Check if the organization has GST version on India.
IsHsnOrSacEnabled	Boolean			Check if the organization is enabled with HSN or SAC
IsInternationalTradeEnabled	Boolean			Check if international trade is enabled in an organization.
IsInventoryEnabled	Boolean			Check if inventory is available in an organization.
IsInvoicePmtTdsAllowed	Boolean			Check if invoice payment TDS allowing in the organization
IsPoEnabled	Boolean			Check if probationary officer is enabled in the organization.
IsQuickSetupCompleted	Boolean			Check if quick setup is completed for the organization.
IsRegisteredForCompositeScheme	Boolean			Check if the organization is registered for composite scheme.
IsRegisteredForGst	Boolean			Check if the organization is registered for GST.
IsRegisteredForTax	Boolean			Check if the organization is registered for tax.
IsSalesInclusiveTaxEnabled	Boolean			Check if sales inclusive tas is enabled in the organization.
IsSalesReverseChargeEnabled	Boolean			Check if sales reverse charge is enabled in the organization.
IsScanPreferenceEnabled	Boolean			Check if scan preference is enabled in the organization.
IsSearch360Enabled	Boolean			Check if search 360 is enabled in the organization.
IsSkuEnabled	Boolean			Check if stock keeping unit is enabled in the organization.
IsTaxRegistered	Boolean			Check if the tax is registered in the organization.
IsTrialExpired	Boolean			Check if the trial is expired or not for a particular organization.
IsTrialExtended	Boolean			Check if the trial is extended or not for a particular organization.
IsZiedition	Boolean			Nodes used for Internal Usage for Zoho Books.
IsOrgActive	Boolean			Check if Organization is active.
IsOrgNotSupported	Boolean			Check if Organization is not supported.
Mode	String			Mode of an organization.
OrgAction	String			Action of the organization.
OrgCreatedAppSource	Integer			Source of the app where organization was created.
OrgSettings	Boolean			Settings of organization.
PartnersDomain	String			Domain of partners.
PlanName	String			Name of the plan.
PlanPeriod	String			Period of the plan.
PlanType	Integer			Type of a plan.
SalesTaxType	String			Type of sales tax.
Source	Integer			Source of the organizations
StateCode	String			Code of state.
TaxGroupEnabled	Boolean			Check if the tax group is enabled in the organization.
ZiMigrationStatus	Integer			Nodes used for Internal Usage for Zoho Books.
ZiZbClient	Integer			Nodes used for Internal Usage for Zoho Books.
ZiZbEdition	Integer			Nodes used for Internal Usage for Zoho Books.

PaymentsReceivedReport

Generated schema file.

Columns


Name	Type	References	SupportedOperators	Description
Accountid	String			Account id
Accountname	String			Account name
Amount	Integer			Amount
AppliedDate	Date			Applied Date
AppliedInvoiceAmount	String			Applied Invoice Amount
AppliedInvoiceBcyAmount	String			Applied Invoice BcyAmount
AppliedInvoices	String			Applied Invoices
BcyBankCharge	Integer			BcyBankCharge
BcytotalExcludingTdsDeduction	Integer			Bcytotal ExcludingTdsDeduction
ContactBillingAttention	String			Contact Billing Attention
ContactBillingCity	String			Contact Billing City
ContactBillingCountry	String			Contact Billing Country
ContactBillingFax	String			Contact Billing Fax
ContactBillingState	String			Contact Billing State
ContactBillingStreet1	String			Contact Billing Street1
ContactBillingStreet2	String			Contact Billing Street2
ContactBillingZipcode	String			Contact Billing Zipcode
ContactCompanyName	String			Contact Company Name
ContactCreatedBy	String			Contact Created By
ContactCreatedTime	Datetime			Contact Created Time
ContactcreditLimit	Integer			Contact credit Limit
ContactcustomerSubType	String			Contact customer SubType
ContactDepartment	String			Contact Department
ContactDesignation	String			Contact Designation
ContactEmail	String			Contact Email
ContactFacebook	String			Contact Facebook
ContactFirstName	String			Contact First Name
ContactLastModifiedTime	Datetime			Contact Last ModifiedTime
ContactLastName	String			Contact Last Name
ContactMobilePhone	String			Contact Mobile Phone
ContactNotes	String			Contact Notes
ContactOutstandingReceivableAmount	Integer			Contact Outstanding ReceivableAmount
ContactOutstandingReceivableAmountBcy	Integer			Contact Outstanding ReceivableAmountBcy
ContactPaymentTerms	String			Contact Payment Terms
ContactPhone	String			Contact Phone
ContactShippingAttention	String			Contact Shipping Attention
ContactShippingCity	String			Contact Shipping City
ContactShippingCountry	String			Contact Shipping Country
ContactShippingFax	String			Contact Shipping Fax
ContactShippingState	String			Contact Shipping State
ContactShippingStreet1	String			Contact Shipping Street1
ContactShippingStreet2	String			Contact Shipping Street2
ContactShippingZipcode	String			Contact Shipping Zipcode
ContactSkype	String			Contact Skype
ContactStatus	String			Contact Status
ContactTwitter	String			Contact Twitter
ContactUnusedCreditsReceivableAmount	Integer			Contact Unused Credits Receivable Amount
ContactUnusedCreditsReceivableAmountBcy	Integer			Contact Unused Credits Receivable Amount Bcy
ContactWebsite	String			Contact Website
CreatedBy	String			CreatedBy
CreatedTime	Datetime			CreatedTime
CurrencyCode	String			CurrencyCode
CustomFields	String			CustomFields
CustomerName	String			CustomerName
Description	String			Description
Documents	String			Documents
FcyBankCharge	Integer			Fcy Bank Charge
FcytotalExcludingTdsDeduction	Integer			Fcy total Excluding TdsDeduction
GatewayTransactionId	String			GatewayTransactionId
HasAttachment	Boolean			Has Attachment
InvoiceNumber	String			Invoice Number
InvoiceNumbers	String			Invoice Numbers
LastFourDigits	String			Last Four Digits
LastModifiedTime	Datetime			Last Modified Time
PaymentId	String			Payment Id
ProductDescription	String			Product Description
RefundedAmount	Integer			Refunded Amount
Retainerinvoiceid	String			Retainer invoiceid
TaxAccountId	String			Tax Account Id
TaxAccountName	String			Tax Account Name
TaxAmountWithheld	Integer			Tax Amount Withheld
Type	String			Type
UnusedAmount	Integer			UnusedAmount
CustomerId	String		IN, NOT IN	Customer Id
Date	Date		=, >,<	Date
PaymentMode	String		IN, NOT IN	Payment Mode 使用できる値は次のとおりです。Bank Remittance, Bank Transfer, Cash, Check, Credit Card
PaymentNumber	String		=, !=, LIKE, CONTAINS, NOT LIKE, IS NULL, IS NOT NULL	Payment Number
AccountIdFilter	String		IN, NOT IN	AccountIdFilter
BcyUnusedAmount	Integer		=, !=,<,<=, >, >=	Bcy Unused Amount
BcyAmount	Integer		=, !=,<,<=, >, >=	Bcy Amount
BcyRefundedAmount	Integer		=, !=,<, >,<=, >=	Bcy Refunded Amount
ReferenceNumber	String		=, !=, LIKE, NOT LIKE, CONTAINS	Reference Number

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
PaymentType	String		Transaction 使用できる値は次のとおりです。Retainers, Invoices, InvoicePayment, Advance
PaymentDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date

ProductSalesReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

SoldDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
ProductCode supports the '= , != , LIKE , NOT LIKE, CONTAINS, IS NULL, IS NOT NULL' comparison.
ItemSku supports the '= , != , LIKE , NOT LIKE, CONTAINS, IS NULL, IS NOT NULL' comparison.

For example:

    SELECT * FROM ProductSalesReport

    SELECT * FROM ProductSalesReport WHERE SoldDate = 'Today'

    SELECT * FROM ProductSalesReport WHERE ToDate = '2022-10-31'

    SELECT * FROM ProductSalesReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

    SELECT * FROM ProductSalesReport WHERE ProductCode LIKE 'bags%'
	
	SELECT * FROM ProductSalesReport WHERE ItemSku IS NOT NULL

Columns


Name	Type	References	SupportedOperators	Description
IsComboProduct	Boolean			Is Combo Product
ItemCreatedBy	String			Item Created By
ItemCreatedTime	Datetime			Item Created Time
ItemDescription	String			Item Description
ItemItemType	String			Item Item Type
ItemLastModifiedTime	Datetime			Item Last Modified Time
ItemProductType	String			Item Product Type
ItemPurchaseDescription	String			Item Purchase Description
ItemPurchaseRate	Integer			Item Purchase Rate
ItemRate	Integer			Item Rate
ItemStatus	String			Item Status
ItemUnit	String			Item Unit
Margin	Double			Margin
ProductId	String			Product Id
Profit	Integer			Profit
QuantitySold	Integer			Quantity Sold
SalesPrice	Integer			Sales Price
SalesPricewithTax	Integer			Sales Price with Tax
Sku	String			Sku
Unit	String			Unit
ProductCode	String		= , != , LIKE , NOT LIKE, CONTAINS, IS NULL, IS NOT NULL	Product Code
ItemSku	String		= , != , LIKE , NOT LIKE, CONTAINS, IS NULL, IS NOT NULL	Item Sku

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
SoldDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date

ProfitsAndLossesReport

This report summarizes your company's assets, liabilities and equity at a specific point in time

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
CashBased supports the '=' comparison.

For example:

    SELECT * FROM ProfitsAndLossesReport

    SELECT * FROM ProfitsAndLossesReport WHERE TransactionDate = 'Today'

    SELECT * FROM ProfitsAndLossesReport WHERE ToDate = '2022-10-31'

    SELECT * FROM ProfitsAndLossesReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

    SELECT * FROM ProfitsAndLossesReport WHERE CashBased = True

Columns


Name	Type	References	SupportedOperators	Description
BalanceTypeName	String			Balance Type Name
SubBalanceTypeName	String			Sub Balance Type Name
AccountTransactionTypeName	String			Account Transaction Type Name
AccountTransactionTotal	Decimal			Account Transaction Total
BalanceTypeTotal	Decimal			Balance Type Total
SubBalanceTypeTotal	Decimal			Sub Balance Type Total

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
CashBased	Boolean		It has value either true or false
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date

ProjectInvoices

Retrieves list of invoices created for a project.

Table Specific Information

Select

The Sync App 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 Sync App.

ProjectId supports the '=' comparison.

For example:

    SELECT * FROM ProjectInvoices WHERE ProjectId = '1894553000000012367'

Columns


Name	Type	References	SupportedOperators	Description
InvoiceId [KEY]	String	Invoices.InvoiceId		ID of an invoice.
InvoiceNumber	String			Number of an invoice.
ProjectId	String	Projects.ProjectId		Id of a project.
Balance	Decimal			Total amount available in invoice.
CreatedTime	Datetime			Time at which the project invoice was created.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String			Name of the customer or vendor.
Date	Date			Date of project invoice.
DueDate	Date			Delivery date of the project invoice.
ReferenceNumber	String			Reference number of project invoice.
Status	String			Status of the project invoice
Total	Decimal			Total of project invoices.

ProjectPerformanceSummaryReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

BillingType supports the '=, !=' comparison.
ProjectId supports the 'IN, NOT IN' comparison.
CustomerId supports the 'IN, NOT IN' comparison.
Status supports the '=' comparison.

For example:

    SELECT * FROM ProjectPerformanceSummaryReport

	SELECT * FROM ProjectPerformanceSummaryReport WHERE Status='active'
	
	SELECT * FROM ProjectPerformanceSummaryReport WHERE CustomerId IN ('3285934000000104002')
	
	SELECT * FROM ProjectPerformanceSummaryReport WHERE ProjectId IN ('3285934000000312337')
	
	SELECT * FROM ProjectPerformanceSummaryReport WHERE BillingType != 'based_on_staff_hours'

Columns


Name	Type	References	SupportedOperators	Description
ActualCostAmount	Integer			Actual Cost Amount
ActualRevenueAmountBcy	Integer			Actual Revenue AmountBcy
ActualRevenueAmountFcy	Integer			Actual Revenue AmountFcy
BudgetedCostAmount	Integer			Budgeted Cost Amount
BudgetedRevenueAmount	Integer			Budgeted Revenue Amount
CustomerName	String			Customer Name
Description	String			Description
DifferenceInCostAmount	Integer			Difference In Cost Amount
DifferenceInCostPercentage	Integer			Difference In Cost Percentage
DifferenceInRevenueAmount	Integer			Difference In Revenue Amount
DifferenceInRevenuePercentage	Integer			Difference In Revenue Percentage
ProfitAmount	Integer			Profit Amount
ProfitMargin	String			Profit Margin
ProfitPercentage	String			Profit Percentage
ProjectName	String			Project Name
Status	String		=	Status 使用できる値は次のとおりです。active, inactive
ProjectId	String		IN, NOT IN	Project Id
CustomerId	String		IN, NOT IN	Customer Id
BillingType	String		=, !=	Billing Type 使用できる値は次のとおりです。based_on_staff_hours, based_on_project_hours, fixed_cost_for_project, based_on_task_hours

ProjectUsers

Retrieves list of users associated with a project. Also, get details of a user in project.

Table Specific Information

Select

The Sync App 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 Sync App.

ProjectId supports the '=' comparison.
UserId supports the '=' comparison.

For example:

    SELECT * FROM ProjectUsers WHERE ProjectId = '1894553000000072363' AND UserId = '1894553000000056001'

Columns


Name	Type	References	SupportedOperators	Description
ProjectId	String	Projects.ProjectId		Id of a project.
UserId [KEY]	String	Users.UserId		Id of the user.
IsCurrentUser	Boolean			Check if it is a current user.
UserName	String			Username of the project users.
Email	String			Email ID of user.
UserRole	String			Role of the user in project.
RoleId	String	Users.RoleId		ID of the role.
Status	String			Status of the project user.
Rate	Decimal			Hourly rate for a task.
BudgetHours	Integer			Total number of hours alloted to the user for the project.
BudgetHoursInTime	String			Time of total number of hours alloted to the user for the project.
TotalHours	String			Total number of hours to be spent in project.
BilledHours	String			Total number of billed hours to be spent in project.
UnBilledHours	String			Total number of unbilled hours spent in project.
BillableHours	String			Total number of billable hours spent in project.
NonBillableHours	String			Total number of non billable hours spent in project.
StaffRole	String			Role of staff in project.
StaffStatus	String			Status of staff in project.

PurchaseOrderLineItems

Get the details of line items of purchase orders.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: PurchaseorderId is required in order to query PurchaseOrderLineItems.

PurchaseorderId supports the '=' comparison.

For example:

    SELECT * FROM PurchaseOrderLineItems WHERE PurchaseorderId = '1894553000000087078'

Columns


Name	Type	References	SupportedOperators	Description
LineItemId [KEY]	String			Id of line item.
PurchaseorderId	String	PurchaseOrders.PurchaseorderId		Id of purchase order.
ItemId	String	Items.ItemId		Id of an item.
ItemOrder	Integer			Order of an item.
ItemTotal	Decimal			total number of item in purchase order.
ItemType	String			Types of 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 added for the line item
Description	String			Description of the purchase order line item.
Discount	Double			Discount to be applied on purchase order line item.
Name	String			Name of the line item.
ProjectId	String	Projects.ProjectId		ID of the project.
Quantity	Double			Total number of items added in purchase order.
QuantityCancelled	Double			Total number of cancelled quantity added in purchase order.
Rate	Decimal			Rate of the line item.
Tags	String			Details of tags related to purchase order 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.

PurchaseOrders

Retrieves list of all purchase orders.

Table Specific Information

Select

The Sync App 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 Sync App.

Date supports the '=' comparison.
LastModifiedTime supports the '=' comparison.
PurchaseorderNumber supports the '=' comparison.
ReferenceNumber supports the '=' comparison.
Status supports the '=' comparison.
Total supports the '=,<,<=,>,>=' comparisons.
VendorId supports the '=' comparison.
VendorName supports the '=' comparison.
PurchaseOrderFilter supports the '=' comparison.
ItemId supports the '=' comparison.
ItemDescription supports the '=' comparison.

For example:

    SELECT * FROM PurchaseOrders WHERE VendorId = 1894553000000077963

    SELECT * FROM PurchaseOrders WHERE Total < 300

    SELECT * FROM PurchaseOrders WHERE CONTAINS(PurchaseorderNumber,'PO-')

Columns


Name	Type	References	SupportedOperators	Description
PurchaseorderId [KEY]	String			ID of a purchase order.
BilledStatus	String			Billed status of a purchase order.
ClientViewedTime	Datetime			Last time when the client has viewed purchase order.
ColorCode	String			Color code of this purchase order.
CompanyName	String			Name of the company.
CreatedTime	Datetime			Time at which the purchase order was created.
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 purchase order.
CurrentSubStatusId	String			Current sub status ID of a purchase order.
Date	Date			The date the purchase order is created.
DeliveryDate	Date			Delivery date of the order.
HasAttachment	Boolean			Check if the purchase order has attachment.
IsDropShipment	Boolean			Check if it has drop shipment.
IsViewedByClient	Boolean			Check if the purchase order is viewed by client.
LastModifiedTime	Datetime			Last modified time of a purchase order.
OrderStatus	String			Status of purchase order.
PricePrecision	String			The precision for the price.
PurchaseorderNumber	String			Number of the purchase order.
QuantityYetToReceive	Decimal			Number of quantity yet to receive from purchase order.
ReferenceNumber	String			Reference number of a purchase order.
Status	String			Status of a purchase order. 使用できる値は次のとおりです。draft, open, billed, cancelled
Total	Decimal		=,<,<=,>,>=	Total of purchase orders. Search by purchase order total.
VendorId	String			ID of the vendor the purchase orders has been made. Search by vendor id.
VendorName	String			Name of the vendor the purchase orders has been made. Search 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
PurchaseOrderFilter	String		Filter purchase order by any status. 使用できる値は次のとおりです。Status.All, Status.Draft, Status.Open, Status.Billed, Status.Cancelled
ItemId	String		Id of an item.
ItemDescription	String		Description of an item.

PurchaseOrdersByVendorReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

PODate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
VendorId supports the 'IN, NOT IN' comparison.
Status supports the 'IN' comparison.

For example:

    SELECT * FROM PurchaseOrdersByVendorReport

    SELECT * FROM PurchaseOrdersByVendorReport WHERE PODate = 'Today'

    SELECT * FROM PurchaseOrdersByVendorReport WHERE ToDate = '2022-10-31'

    SELECT * FROM PurchaseOrdersByVendorReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

    SELECT * FROM PurchaseOrdersByVendorReport WHERE Status in ('draft')
	
	SELECT * FROM PurchaseOrdersByVendorReport WHERE VendorId in ('3285934000000104023')

Columns


Name	Type	References	SupportedOperators	Description
Amount	Integer			Amount
Count	Integer			Count
FcyAmount	Integer			Fcy Amount
VendorCompanyName	String			Vendor CompanyName
VendorCreatedBy	String			Vendor Created By
VendorCreatedTime	Datetime			Vendor Created Time
VendorDepartment	String			Vendor Department
VendorDesignation	String			Vendor Designation
VendorEmail	String			Vendor Email
VendorFacebook	String			Vendor Facebook
VendorFirstName	String			Vendor First Name
VendorLastModifiedTime	Datetime			Vendor Last ModifiedTime
VendorLastName	String			Vendor Last Name
VendorMobilePhone	String			Vendor Mobile Phone
VendorNotes	String			Vendor Notes
VendorOutstandingPayableAmount	Integer			Vendor Outstanding Payable Amount
VendorOutstandingPayableAmountBcy	Integer			Vendor Outstanding Payable Amount Bcy
VendorPaymentTerms	String			Vendor Payment Terms
VendorPhone	String			Vendor Phone
VendorSkype	String			Vendor Skype
VendorStatus	String			Vendor Status
VendorTwitter	String			Vendor Twitter
VendorUnusedCreditsPayableAmount	Integer			Vendor Unused Credits Payable Amount
VendorUnusedCreditsPayableAmountBcy	Integer			Vendor Unused Credits Payable Amount Bcy
VendorWebsite	String			Vendor Website
VendorName	String			Vendor Name
VendorId	String		IN, NOT IN	Vendor Id

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
PODate	String		Filter transaction by any purchase order date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date
Status	String		Status 使用できる値は次のとおりです。draft, pending_approval, approval_overdue, approved, rejected, open, billed, billed_not_received, cancelled, partially_billed, issued, partially_received, received, received_not_billed, manually_received, drop_shipped, closed, accepted, signed

RecurringBillLineItems

Get the details of a line items of bills.

Columns


Name	Type	References	SupportedOperators	Description
LineItemId [KEY]	String			Id of line item.
RecurringBillId	String	Bills.BillId		Id of a Bill.
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.
HeaderId	String			Id of the Bank Account.
HeaderName	String			Id of the Bank Account.
ImageDocumentId	String			ID of the image document.
IsBillable	Boolean			Check if the bill line items is billable.
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.
ProjectId	String	Projects.ProjectId		ID of project.
ProjectName	String			Name of the project.
Quantity	Decimal			Quantity of line item.
Rate	Decimal			Rate of the line item.
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.

RecurringBills

To list, add, update and delete details of a bill.

Table Specific Information

Select

The Sync App 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 Sync App.

VendorId supports the '=' comparison.
VendorName supports the '=, Contains' comparisons.
RecurrenceName supports the '=' comparison.
Status supports the '=' comparison.
StartDate supports the '=,<,>' comparisons.
EndDate supports the '=' comparison.

For example:

    Select * FROM RecurringBills

    Select * FROM RecurringBills where vendorid='3255827000000081003'

    Select * FROM RecurringBills where contains(vendorname,'c')
  
    Select * FROM RecurringBills where startdate > '2023-03-3'

Columns


Name	Type	References	SupportedOperators	Description
RecurringBillId [KEY]	String			ID of a Bill.
VendorId	String		=	ID of the vendor the bill has been made.
VendorName	String		=	Name of the vendor the bill has been made.
Status	String		=	Status of the bill.
RecurrenceName	String		=	Frequency at which recurring bill will be sent.
RecurrenceFrequency	String			Search recurring bills by recurrence number.
RepeatEvery	Integer			Integer value denoting the frequency of bill.
StartDate	Date		=,>,<	Date when bill was created.
LastSentDate	Date			Date when recurring bill was last sent.
NextBillDate	Date			Date when bill will be sent next.
EndDate	Date		=	Date when the payment is expected.
CreatedTime	Datetime			Time at which the bill was created.
LastModifiedTime	Datetime			The time of last modification of the bill.
Total	Integer			Total of the bill.

RecurringExpenses

Retrieves list of all the Expenses.

Table Specific Information

Select

The Sync App 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 Sync App.

AccountName supports the '=' comparison.
CustomerName supports the '=' comparison.
LastCreatedDate supports the '=,<,>' comparisons.
NextExpenseDate supports the '=,<,>' comparisons.
PaidThroughAccountName supports the '=' comparison.
RecurrenceName supports the '=' comparison.
Status supports the '=' comparison.
CustomerId supports the '=' comparison.
AccountId supports the '=' comparison.
Amount supports the '=,<,<=,>,>=' comparisons.
RecurringExpenseFilter supports the '=' comparison.

For example:

    SELECT * FROM RecurringExpenses WHERE Amount = 500 AND PaidThroughAccountName = 'Petty Cash' AND RecurrenceName = 'Vehicle Rent'

    SELECT * FROM RecurringExpenses WHERE LastCreatedDate > '2017-07-16'

Columns


Name	Type	References	SupportedOperators	Description
RecurringExpenseId [KEY]	String			ID of recurring expense.
AccountName	String			Account name of an expense.
CreatedTime	Datetime			Time at which the recurring expense was created.
CurrencyCode	String			Currency code of the customer's currency.
CurrencyId	String	Currencies.CurrencyId		Currency ID of the customer's currency.
CustomerName	String			Name of the customer.
Description	String			Description of the recurring expense.
IsBillable	Boolean			Check if recurring expense is billable or not.
LastCreatedDate	Date		=,<,>	Recurring expenses date on when last expense was generated.
LastModifiedTime	Datetime			The time of last modification of the recurring expense.
NextExpenseDate	Date		=,<,>	Recurring expenses date on which next expense will be generated.
PaidThroughAccountName	String			Name of the account from which expenses was paid.
RecurrenceName	String			Name of the recurrence.
Status	String			Status of a recurring expenses. 使用できる値は次のとおりです。active, stopped, expired
Total	Decimal			Total of recurring expenses.

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
CustomerId	String		Id of a customer.
AccountId	String		ID of the Bank Account.
Amount	Decimal		Amount of a recurring expenses.
RecurringExpenseFilter	String		Filter expenses by expense status. 使用できる値は次のとおりです。Status.All, Status.Active, Status.Expired, Status.Stopped

RecurringInvoiceLineItems

Get the details of line items of a recurring invoice.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: RecurringInvoiceId is required in order to query RecurringInvoiceLineItems.

RecurringInvoiceId supports the '=' comparison.

For example:

    SELECT * FROM RecurringInvoiceLineItems WHERE RecurringInvoiceId = '1895453000000042244'

Columns


Name	Type	References	SupportedOperators	Description
LineItemId [KEY]	String			ID of line item.
RecurringInvoiceId	String	RecurringInvoices.RecurringInvoiceId		ID of recurring invoice.
ItemId	String	Items.ItemId		ID of the item.
ItemOrder	Integer			Order of the item.
ItemTotal	Decimal			Total number of item.
Description	String			Description of the recurring invoice line item.
Discount	String			Amount of discount applied for items of recurring invoice.
DiscountAmount	Decimal			Amount of discount.
HeaderId	String			ID of the header.
HeaderName	String			Name of the header.
Name	String			Name of the recurring invoice line item.
ProjectId	String	Projects.ProjectId		Id of the project.
Quantity	String			Total number of item.
Rate	Decimal			Rate for recurring invoice..
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			Total quantity included in recurring invoice items.

RecurringInvoices

Retrieves list of all recurring invoices.

Table Specific Information

Select

The Sync App 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 Sync App.

RecurrenceName supports the '=' comparison.
CustomerId supports the '=' comparison.
CustomerName supports the '=' comparison.
Status supports the '=' comparison.
RecurringInvoiceFilter supports the '=' comparison.
LineItemId supports the '=' comparison.
TaxId supports the '=' comparison.
Notes supports the '=' comparison.
ItemId supports the '=' comparison.
ItemName supports the '=' comparison.
ItemDescription supports the '=' comparison.

For example:

    SELECT * FROM RecurringInvoices WHERE RecurrenceName = 'Office Rent' AND EndDate = '2018-06-21'

    SELECT * FROM RecurringInvoices WHERE ItemName = 'Standard Plan'

Columns


Name	Type	References	SupportedOperators	Description
RecurringInvoiceId [KEY]	String			ID of a recurring invoice.
RecurrenceName	String			Name of a recurrence.
ChildEntityType	String			Entity type of a child.
CreatedTime	Datetime			Time at which the recurring invoice was created.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String			Name of the customer or vendor.
EndDate	Date			End date for the statement.
LastFourDigits	String			It store the last four digits of customer's card details.
LastModifiedTime	Datetime			The time of last modification of the recurring invoice.
LastSentDate	Date			Date recurring invoice was last sent.
NextInvoiceDate	Date			Date when recurring invoice will be send next.
RecurrenceFrequency	String			Frequency of the recurrence.
ReferenceNumber	String			Reference number of recurring invoice.
StartDate	Date			Starting date of recurring invoice.
Status	String			Status of the recurring invoice. 使用できる値は次のとおりです。active, stopped, expired
Total	Decimal			Total of recurring invoices.

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
RecurringInvoiceFilter	String		Filter recurring invoice by status. 使用できる値は次のとおりです。Status.All, Status.Active, Status.Stopped, Status.Expired
LineItemId	String		Id of a line item.
TaxId	String		ID of tax.
Notes	String		Notes for this recurring invoice.
ItemId	String		ID of an item.
ItemName	String		Name of an item.
ItemDescription	String		Description of an item.

RecurringSubExpense

Retrieves list of child expenses created from recurring expense.

Table Specific Information

Select

The Sync App 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 Sync App.

RecurringExpenseId supports the '=' comparison.

For example:

    SELECT * FROM RecurringSubExpense WHERE RecurringExpenseId = '1801553000000089750'

Columns


Name	Type	References	SupportedOperators	Description
RecurringExpenseId [KEY]	String	RecurringExpenses.RecurringExpenseId		Sort expenses.
AccountName	String			Name of the account.
CustomerName	String			Name of the customer.
Date	Date			Date of a recurring expense.
ExpenseId	String	Expenses.ExpenseId		ID of an expense.
PaidThroughAccountName	String			Name of the account from which payment was made.
Status	String			Status of the recurring expense.
Total	Decimal			Total of child expenses of recurring expenses.
VendorName	String			Name of the vendor.

ReportsAccountTransactionsDetails

Retrieves the list of inline transactions.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
AccountId supports the '=' comparison.

For example:

    SELECT * FROM ReportsAccountTransactionsDetails

    SELECT * FROM ReportsAccountTransactionsDetails WHERE TransactionDate = 'Today'

    SELECT * FROM ReportsAccountTransactionsDetails WHERE ToDate = '2022-10-31'

    SELECT * FROM ReportsAccountTransactionsDetails WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

    SELECT * FROM ReportsAccountTransactionsDetails WHERE AccountId = 1055236000000014066

Columns


Name	Type	References	SupportedOperators	Description
AccountGroup	String			Account Group
AccountType	String			Account Type
AccountId	Long		=	Account Id
AccountName	String			Account Name
Branch	String			Branch
ContactId	Long	Contacts.ContactId		Contact Id
Credit	Decimal			Credit
CurrencyCode	String			Currency Code
Date	Date			Date
Debit	Decimal			Debit
EntityNumber	String			Entity Number
NetAmount	String			Net Amount
OffsetAccountId	Long			Offset Account Id
OffsetAccountType	String			Offset Account Type
ProjectIds	Long	Projects.ProjectId		Project Ids
ReferenceNumber	String			Reference Number
ReferenceTransactionId	Long			Reference Transaction Id
TransactionDetails	String			Transaction Details
TransactionType	String			Transaction Type
TransactionId	Long			Transaction Id

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
TransactionDate	String		Transaction Date 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date

RetainerInvoiceLineItems

Retrieves detail of line items of retainer invoices.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: RetainerInvoiceId is required in order to query RetainerInvoiceLineItems.

RetainerInvoiceId supports the '=' comparison.

For example:

    SELECT * FROM RetainerInvoiceLineItems WHERE RetainerInvoiceId = '1894663000000085023'

Columns


Name	Type	References	SupportedOperators	Description
RetainerInvoiceId	String	RetainerInvoices.RetainerInvoiceId		ID of a retainer invoice.
LineItemId [KEY]	String			Id of line item.
AccountId	String	BankAccounts.AccountId		ID of the Bank Account.
BcyRate	Decimal			Rate of Base Currency.
Description	String			Description of the retainer invoice line item.
ItemOrder	Integer			Order of items.
ItemTotal	Decimal			Total number of items in retainer invoice.
Rate	Decimal			Rate of the line item.
TaxId	String	Taxes.TaxId		Id of tax.
TaxName	String			Name of the tax.
TaxPercentage	Integer			Percentage applied for tax.
TaxType	String			Type of tax.

RetainerInvoicePayments

Get the list of payments made for a retainer invoices.

Table Specific Information

Select

The Sync App 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 Sync App.

RetainerInvoiceId supports the '=' comparison.

For example:

    SELECT * FROM RetainerInvoicePayments WHERE RetainerInvoiceId = '1894663000000085023'

Columns


Name	Type	References	SupportedOperators	Description
PaymentId [KEY]	String			Id of a payment.
RetainerInvoiceId	String	RetainerInvoices.RetainerInvoiceId		ID of a retainer invoice.
PaymentMode	String			Mode through which payment is made.
ReferenceNumber	Currency			Reference number of retainer invoice payment.
Amount	Integer			Amount of the retainer invoice payments.
AttachmentName	String			Name of the attachment.
BankCharges	Integer			Charges of the bank.
CanSendInMail	Boolean			Check if the retainer invoice can be send through mail.
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			Retainer Invoice date.
Description	String			Description of the retainer invoice payment.
DiscountAmount	Decimal			Amount given for discount.
ExchangeRate	Decimal			Exchange rate given for this retainer invoice.
HtmlString	String			HTML context of a retainer invoice.
IsClientReviewSettingsEnabled	Boolean			Check if the client review settings is enabled or not.
IsPaymentDrawnDetailsRequired	Boolean			Check if the payment drawn details is required.
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.
RetainerinvceBalance	Integer			Total amount for retainer invoice.
RetainerInvceDate	Date			Date for retainer invoice.
RetainerInvceId	String	RetainerInvoices.RetainerInvoiceId		ID for a retainer invoice.
RetainerInvceNumber	String			Number of a retainer invoice.
RetainerInvceTotal	Integer			Total of retainer invoice.
TaxAmountWithheld	Integer			Amount withheld for tax.
TemplateId	String			ID of a template.
TemplateName	String			Name of a template.
TemplateType	String			Type of a template.
UnusedAmount	Integer			Total amount which is unused.

RetainerInvoices

Retrieves list of all retainer invoices.

Table Specific Information

Select

The Sync App 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 Sync App.

Status supports the '=' comparison.

For example:

    SELECT * FROM RetainerInvoices WHERE Status = 'All'

Columns


Name	Type	References	SupportedOperators	Description
RetainerInvoiceId [KEY]	String			ID of a retainer invoice.
Balance	Decimal			Total balance of a retainer invoice.
ClientViewedTime	Datetime			Time when client viewed the retainer invoice.
ColorCode	String			Color code of retainer invoice.
CreatedTime	Datetime			Time at which the retainer invoice was created.
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 retainer invoice.
CurrentSubStatusId	String			Current sub status ID of a retainer invoice.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor.
CustomerName	String			Name of the customer or vendor.
Date	Date			Date of a retainer invoice.
EstimateNumber	String			Estimate number of retainer invoice.
HasAttachment	Boolean			Check if the retainer invoice has attachment.
IsEmailed	Boolean			Check if the retainer invoice is emailed.
IsViewedByClient	Boolean			Check if the retainer invoice is viewed by client.
LastModifiedTime	Datetime			The time of last modification of the retainer invoices.
LastPaymentDate	Date			Date of last payment made to retainer invoice.
ProjectName	String			Name of the project.
ProjectOrEstimateName	String			Name of project or estimate.
ReferenceNumber	String			Reference number of a retainer invoice.
RetainerinvoiceNumber	String			Total number of retainer invoice.
Status	String			Status of the retainer invoice 使用できる値は次のとおりです。All, Sent, Draft, OverDue, Paid, Void, Unpaid, PartiallyPaid, Viewed, Date.PaymentExpectedDate
Total	Decimal			Total of retainer invoices.

SalesByCustomerReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
CustomerId supports the 'IN, NOT IN' comparison.
EntityList supports the 'IN' comparison.

For example:

    SELECT * FROM SalesByCustomerReport

    SELECT * FROM SalesByCustomerReport WHERE TransactionDate = 'Today'

    SELECT * FROM SalesByCustomerReport WHERE ToDate = '2022-10-31'

    SELECT * FROM SalesByCustomerReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'
	
	SELECT * FROM SalesByCustomerReport WHERE CustomerId NOT IN ('3285934000000152001')
	
	SELECT * FROM SalesByCustomerReport WHERE EntityList In ('invoice')

Columns


Name	Type	References	SupportedOperators	Description
ContactBillingAttention	String			Contact Billing Attention
ContactBillingCity	String			Contact Billing City
ContactBillingCountry	String			Contact Billing Country
ContactBillingFax	String			Contact Billing Fax
ContactBillingPhone	String			Contact Billing Phone
ContactBillingState	String			Contact Billing State
ContactBillingStreet1	String			Contact Billing Street1
ContactBillingStreet2	String			Contact Billing Street2
ContactBillingZipcode	String			Contact Billing Zipcode
ContactCompanyName	String			Contact Company Name
ContactCreatedBy	String			Contact Created By
ContactCreatedTime	Datetime			Contact CreatedTime
ContactCreditLimit	Integer			Contact CreditLimit
ContactCustomerSubType	String			Contact CustomerSubType
ContactDepartment	String			Contact Department
ContactDesignation	String			Contact Designation
ContactEmail	String			Contact Email
ContactFacebook	String			Contact Facebook
ContactFirstName	String			Contact FirstName
ContactLastModifiedTime	Datetime			Contact LastModifiedTime
ContactLastName	String			Contact LastName
ContactMobilePhone	String			Contact MobilePhone
ContactNotes	String			Contact Notes
ContactOutstandingReceivableAmount	Integer			Contact Outstanding Receivable Amount
ContactOutstandingReceivableAmountBcy	Integer			Contact Outstanding Receivable Amount Bcy
ContactPaymentTerms	String			Contact Payment Terms
ContactPhone	String			Contact Phone
ContactShippingAttention	String			Contact Shipping Attention
ContactShippingCity	String			Contact Shipping City
ContactShippingCountry	String			Contact Shipping Country
ContactShippingFax	String			Contact Shipping Fax
ContactShippingPhone	String			Contact Shipping Phone
ContactShippingState	String			Contact Shipping State
ContactShippingStreet1	String			Contact Shipping Street1
ContactShippingStreet2	String			Contact Shipping Street2
ContactShippingZipcode	String			Contact Shipping Zipcode
ContactSkype	String			Contact Skype
ContactStatus	String			Contact Status
ContactTwitter	String			Contact Twitter
ContactUnusedCreditsReceivableAmount	Integer			Contact Unused Credits Receivable Amount
ContactUnusedCreditsReceivableAmountBcy	Integer			Contact Unused Credits Receivable Amount Bcy
ContactWebsite	String			Contact Website
Count	Integer			Count
CreditNoteCount	Integer			Credit Note Count
CreditNoteAmount	Integer			Credit Note Amount
CurrencyCode	String			Currency Code
CustomFieldsList	String			Custom Fields List
CustomerName	String			Customer Name
FcyCreditnoteAmount	Integer			Fcy Creditnote Amount
FcyInvoiceAmount	Integer			Fcy Invoice Amount
FcySales	Integer			Fcy Sales
FcySalesWithTax	Integer			Fcy Sales With Tax
FcySalesWithoutDiscount	Integer			Fcy Sales Without Discount
InvoiceAmount	Integer			Invoice Amount
JournalCount	Integer			Journal Count
PreviousValues	String			Previous Values
Sales	Integer			Sales
SalesDepositCount	Integer			Sales Deposit Count
SalesWithTax	Integer			Sales With Tax
SalesWithoutDiscount	Integer			Sales Without Discount
CustomerId	String		IN, NOT IN	Customer Id

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
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date
EntityList	String		EntityList 使用できる値は次のとおりです。invoice, creditnote, sales_without_invoices, journal

SalesByItemReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
CustomerName supports the 'Group By' comparison.
SalesPerson supports the 'Group By' comparison.
CustomerID supports the 'IN, NOT IN' comparison.
WaresouseID supports the 'IN, NOT IN' comparison.
AccountID supports the 'IN, NOT IN' comparison.
ItemName supports the 'IN, NOT IN, LIKE , CONTAINS , NOT LIKE' comparison.
ItemSku supports the '= , != , LIKE , CONTAINS , NOT LIKE , IS NULL , IS NOT NULL' comparison.
Unit supports the '= , != , LIKE , CONTAINS , NOT LIKE , IS NULL , IS NOT NULL' comparison.

For example:

    SELECT * FROM SalesByItemReport

    SELECT * FROM SalesByItemReport WHERE TransactionDate = 'Today'

    SELECT * FROM SalesByItemReport WHERE ToDate = '2022-10-31'

    SELECT * FROM SalesByItemReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'
	
	SELECT * FROM SalesByItemReport group by customername
	
	SELECT * FROM SalesByItemReport group by salesperson
	
	SELECT * FROM SalesByItemReport where customerid in ('3285934000000152001')
	
	SELECT * FROM SalesByItemReport where warehouseid in ('3285934000000113095')
	
	SELECT * FROM SalesByItemReport where accountid in ()
	
    SELECT * FROM SalesByItemReport WHERE CONTAINS(ItemName,'BAGS')
	
	SELECT * FROM SalesByItemReport WHERE Unit LIKE 'cm%'

Columns


Name	Type	References	SupportedOperators	Description
Amount	Integer			Amount
AmountWithTax	Integer			Amount With Tax
AmountWithoutDiscount	Integer			Amount Without Discount
AveragePrice	Integer			Average Price
IsComboProduct	Boolean			Is Combo Product
ItemCreatedBy	String			Item Created By
ItemCreatedTime	Datetime			Item Created Time
ItemDescription	String			Item Description
ItemItemType	String			Item Item Type
ItemLastModifiedTime	Datetime			Item Last Modified Time
ItemProductType	String			Item Product Type
ItemPurchaseDescription	String			Item Purchase Description
ItemPurchaseRate	Integer			Item Purchase Rate
ItemRate	Integer			Item Rate
ItemStatus	String			Item Status
ItemUnit	String			Item Unit
ItemId	String			Item Id
PreviousValues	String			Previous Values
QuantitySold	Integer			Quantity Sold
ReportingTag	String			Reporting Tag
GroupAmount	String			Group Amount
GroupTotalQuantitySold	String			Group Total Quantity Sold
Unit	String		= , != , LIKE , CONTAINS , NOT LIKE , IS NULL , IS NOT NULL	Unit
ItemSku	String		= , != , LIKE , CONTAINS , NOT LIKE , IS NULL , IS NOT NULL	Item Sku
ItemName	String		IN, NOT IN, LIKE , CONTAINS , NOT LIKE	Item 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
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date
CustomerId	String		Customer Id
AccountId	String		Account Id
WarehouseId	String		Warehouse Id
CustomerName	String		Customer Name
SalesPerson	String		Sales Person

SalesBySalespersonReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.

For example:

    SELECT * FROM SalesBySalespersonReport

    SELECT * FROM SalesBySalespersonReport WHERE TransactionDate = 'Today'

    SELECT * FROM SalesBySalespersonReport WHERE ToDate = '2022-10-31'

    SELECT * FROM SalesBySalespersonReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

Columns


Name	Type	References	SupportedOperators	Description
CNCount	Integer			CN Count
CNSales	Integer			CN Sales
CNSaleswithTax	Integer			CN SaleswithTax
Count	Integer			Count
InvoiceCount	Integer			Invoice Count
InvoiceSales	Integer			Invoice Sales
InvoiceSalesWithTax	Integer			Invoice SalesWithTax
PreviousValues	String			Previous Values
Sales	Integer			Sales
SalesWithTax	Integer			Sales With Tax
SalespersonId	String			Salesperson Id
SalespersonStatus	String			Salesperson Status
TotalSales	Integer			Total Sales
TotalSalesWithTax	Integer			Total Sales With Tax
SalespersonName	String			Salesperson Name
CreditBalance	Integer			Credit Balance
Email	String			Email
BalanceDue	Integer			Balance Due

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
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date

SalesOrderLineItems

Retrieves list of line items of a sales order.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: SalesorderId is required in order to query SalesOrderLineItems.

SalesorderId supports the '=' comparison.

For example:

    SELECT * FROM SalesOrderLineItems WHERE SalesorderId = '1894553000000077349'

Columns


Name	Type	References	SupportedOperators	Description
LineItemId [KEY]	String			ID of a line item.
SalesorderId	String	SalesOrders.SalesorderId		ID of a sales order.
BcyRate	Decimal			Rate of Base Currency.
CustomFields	String			Custom Fields added for the line item
Description	String			Description of the sales order line item
Discount	String			Discount given to specific item in sales order.
DiscountAmount	Decimal			Amount of discount applied for items of sales order.
ImageDocumentId	String			ID of image document.
ImageName	String			Name of the image.
ImageType	String			Type of image.
IsInvoiced	Boolean			Check if the sales order is invoiced.
ItemId	String	Items.ItemId		Id of an item.
ItemOrder	Integer			Order of an item.
ItemTotal	Decimal			Total amount of an item.
ItemType	String			Type of item.
Name	String			Name of the sales order.
ProjectId	String	Projects.ProjectId		ID of the project.
Quantity	Decimal			Total number of quantity
QuantityCancelled	Decimal			Total number of quantity canceled for salesorder.
Rate	Decimal			Rate of the line item.
Tags	String			Details of tags related to sales order 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			Total quantity included in sales order items.

SalesOrders

Retrieves list of all sales orders.

Table Specific Information

Select

The Sync App 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 Sync App.

SalesorderId supports the '=' comparison.
CustomerId supports the '=' comparison.
CustomerName supports the '=' comparison.
Date supports the '=,<,>' comparisons.
ReferenceNumber supports the '=' comparison.
SalesorderNumber supports the '=' comparison.
ShipmentDate supports the '=,<,>' comparisons.
Status supports the '=' comparison.
Total supports the '=,<,<=,>,>=' comparisons.
ItemId supports the '=' comparison.
ItemName supports the '=' comparison.
ItemDescription supports the '=' comparison.
SalesOrderFilter supports the '=' comparison.

For example:

    SELECT * FROM SalesOrders WHERE CustomerId = '1894553000000077328' AND CustomerName = 'Zylak' AND SalesOrderFilter = 'Status.All'

    SELECT * FROM SalesOrders WHERE ShipmentDate > '2017-08-01'

    SELECT * FROM SalesOrders WHERE CONTAINS(SalesorderNumber,'SO-00')

Columns


Name	Type	References	SupportedOperators	Description
SalesorderId [KEY]	String			ID of a sales order.
SalespersonName	String			Name of the sales order.
BcyTotal	Decimal			Total Base Currency.
ColorCode	String			Color code of Sales order.
CompanyName	String			Name of the company.
CreatedTime	Datetime			Time at which the sales order was created.
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 sales order.
CurrentSubStatusId	String			Current sub status ID of a sales order.
CustomerId	String	Contacts.ContactId		ID of the customer or vendor. Search Sales Order based on customer_id.
CustomerName	String			Name of the customer or vendor. .
Date	Date		=,<,>	Date of an sales order.
DueByDays	String			Total number of day sales order is due by.
DueInDays	String			Total number of day the sales order is due in.
HasAttachment	Boolean			Check if the sales order has attachment.
InvoicedStatus	String			Status of invoiced sales orders.
IsEmailed	Boolean			Check if the sales order is emailed.
LastModifiedTime	Datetime			The time of last modification of the sales order.
OrderStatus	String			Status of order.
ReferenceNumber	String			Reference number of sales order.
SalesorderNumber	String			Number of a sales order.
ShipmentDate	Date		=,<,>	Date of shipment.
ShipmentDays	String			Total number of days for shipment.
Status	String			Status of sales order. 使用できる値は次のとおりです。draft, open, invoiced, partially_invoiced, void, overdue
Total	Decimal		=,<,<=,>,>=	Total of sales orders.
TotalInvoicedAmount	Decimal			Total amount which is invoiced.

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
ItemId	String		Id of an item.
ItemName	String		Name of an item.
ItemDescription	String		Description of an item.
SalesOrderFilter	String		Filter sales order by status. 使用できる値は次のとおりです。Status.All, Status.Open, Status.Draft, Status.OverDue, Status.PartiallyInvoiced, Status.Invoiced, Status.Void, Status.Closed

StockSummaryReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
ItemName supports the '= , != , LIKE, NOT LIKE, CONTAINS, IS NULL, IS NOT NULL' comparison.
ItemSku supports the '= , != , LIKE, NOT LIKE, CONTAINS, IS NULL, IS NOT NULL' comparison.
WarehouseId supports the 'IN, NOT IN' comparison.

For example:

    SELECT * FROM StockSummaryReport

    SELECT * FROM StockSummaryReport WHERE TransactionDate = 'Today'

    SELECT * FROM StockSummaryReport WHERE ToDate = '2022-10-31'

    SELECT * FROM StockSummaryReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

    SELECT * FROM StockSummaryReport WHERE ItemName IS NULL
	
	SELECT * FROM StockSummaryReport WHERE ItemName = 'BAGS'
	
	SELECT * FROM StockSummaryReport WHERE CONTAINS(ItemName,'BAGS')
	
	SELECT * FROM StockSummaryReport WHERE ItemName LIKE '%b'
	
	SELECT * FROM StockSummaryReport WHERE ItemName NOT LIKE '%b%'
	
	SELECT * FROM StockSummaryReport WHERE WarehouseId IN ('3285934000000113095')

Columns


Name	Type	References	SupportedOperators	Description
ClosingStock	Double			Closing Stock
ItemId	String			Item Id
OpeningStock	Double			Opening Stock
PurchaseAccountName	String			Purchase Account Name
QuantityIn	Double			Quantity In
QuantityOut	Double			Quantity Out
ItemItemType	String			ItemItem Type
ItemProductType	String			Item Product Type
ItemStatus	String			Item Status
ItemUnit	String			Item Unit
ItemDescription	String			Item Description
ItemRate	String			Item Rate
ItemPurchaseDescription	String			Item Purchase Description
ItemPurchaseRate	String			Item Purchase Rate
ItemCreatedTime	Datetime			Item Created Time
ItemCreatedBy	String			Item Created By
ItemLastModitfiedTime	Datetime			Item Last Moditfied Time
ItemSku	String		= , != , LIKE, NOT LIKE, CONTAINS, IS NULL, IS NOT NULL	Item Sku
ItemName	String		= , != , LIKE, NOT LIKE, CONTAINS, IS NULL, IS NOT NULL	Item 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
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		To Date
FromDate	Date		From Date
WarehouseId	String		To Date

TaxSummaryReport

This report summarizes your company's assets, liabilities and equity at a specific point in time

Table Specific Information

Select

The Sync App 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 Sync App.

ToDate supports the '=' comparison.
FromDate supports the '=' comparison.

For example:

    SELECT * FROM TaxSummaryReport

    SELECT * FROM TaxSummaryReport WHERE ToDate = '2022-10-31'

    SELECT * FROM TaxSummaryReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

Columns


Name	Type	References	SupportedOperators	Description
InputTaxAccountId	Long			Input Tax Account Id
IsTaxAccount	Boolean			Is Tax Account
IsValueAdded	Boolean			Is Value Added
OutputTaxAccountId	Long			Output Tax Account Id
TaxAmount	String			Tax Amount
TaxId	Long			Tax Id
TaxName	String			Tax Name
TaxPercentage	String			Tax Percentage
TransactionAmount	String			Transaction Amount

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
ToDate	Date		To Date
FromDate	Date		From Date

TrialBalanceReport

This report summarizes your company's assets, liabilities and equity at a specific point in time

Table Specific Information

Select

The Sync App 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 Sync App.

TransactionDate supports the '=' comparison.
ToDate supports the '=' comparison.
FromDate supports the '=' comparison.
CashBased supports the '=' comparison.

For example:

    SELECT * FROM TrialBalanceReport

    SELECT * FROM TrialBalanceReport WHERE TransactionDate = 'Today'

    SELECT * FROM TrialBalanceReport WHERE ToDate = '2022-10-31'

    SELECT * FROM TrialBalanceReport WHERE FromDate = '2022-10-10' and ToDate = '2022-10-31'

    SELECT * FROM TrialBalanceReport WHERE CashBased = True

Columns


Name	Type	References	SupportedOperators	Description
BalanceTypeName	String			Balance Type Name
SubBalanceTypeName	String			Sub Balance Type Name
AccountTransactionTypeName	String			Account Transaction Type Name
AccountTransactionCreditTotal	Decimal			Credit Total
AccountTransactionDebitTotal	Decimal			Debit Total
SubAccountCreditTotal	Decimal			Sub Account Credit Total
SubAccountDebitTotal	Decimal			Sub Account Debit Total
CreditTotal	Decimal			Account Transaction Type Credit Total
DebitTotal	Decimal			Account Transaction Type Debit Total

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
CashBased	Boolean		Cash Based
TransactionDate	String		Filter transaction by any transaction date. 使用できる値は次のとおりです。Today, ThisWeek, ThisMonth, ThisQuarter, ThisYear, PreviousDay, PreviousWeek, PreviousMonth, PreviousQuarter, PreviousYear and CustomDate
ToDate	Date		ToDate
FromDate	Date		FromDate

VendorBalancesReport

Generated schema file.

Table Specific Information

Select

The Sync App 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 Sync App.

ReportDate supports the '=' comparison.
VendorId supports the '=' comparison.

For example:

    SELECT * FROM VendorBalancesReport

    SELECT * FROM VendorBalancesReport WHERE ReportDate = '2022-10-31'
    
    SELECT * FROM VendorBalancesReport WHERE VendorId   = '3285934000000104023'

Columns


Name	Type	References	SupportedOperators	Description
VendorName	String			Vendor Name
BillBalance	Integer			Bill Balance
BcyAdvancePayment	String			Bcy Advance Payment
BcyBalance	Integer			Bcy Balance
BcyBillBalance	Integer			Bcy Bill Balance
BcyCreditBalance	String			Bcy Credit Balance
BcyExcessPayment	Integer			Bcy Excess Payment
BcyJournalCredits	String			Bcy Journal Credits
CurrencyId	String			CurrencyId
ExcessPayment	Integer			Excess Payment
FcyAdvancePayment	String			Fcy Advance Payment
FcyBalance	Integer			Fcy Balance
FcyCreditBalance	String			Fcy Credit Balance
FcyJournalCredits	String			Fcy Journal Credits
VendorCompanyName	String			Vendor Company Name
VendorCreatedBy	String			Vendor Created By
VendorCreatedTime	Datetime			Vendor Created Time
VendorDepartment	String			Vendor Department
VendorDesignation	String			Vendor Designation
VendorEmail	String			Vendor Email
VendorFacebook	String			Vendor Facebook
VendorFirstName	String			Vendor FirstName
VendorLastModifiedTime	Datetime			Vendor Last Modified Time
VendorLastName	String			Vendor Last Name
VendorMobilePhone	String			Vendor Mobile Phone
VendorNotes	String			Vendor Notes
VendorOutstandingPayableAmount	Integer			Vendor Outstanding Payable Amount
VendorOutstandingPayableAmountBcy	Integer			Vendor Outstanding Payable AmountBcy
VendorPaymentTerms	String			Vendor PaymentTerms
VendorPhone	String			Vendor Phone
VendorSkype	String			Vendor Skype
VendorStatus	String			Vendor Status
VendorTwitter	String			Vendor Twitter
VendorUnusedCreditsPayableAmount	Integer			Vendor Unused Credits Payable Amount
VendorUnusedCreditsPayableAmountBcy	Integer			Vendor Unused Credits Payable AmountBcy
VendorWebsite	String			Vendor Website
VendorId	String		=	Vendor Id

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
ReportDate	Date		Report Date

VendorCreditBills

Retrieves list of bills to which the vendor credit is applied.

Table Specific Information

Select

The Sync App 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 Sync App.

VendorCreditId supports the '=' comparison.

For example:

    SELECT * FROM VendorCreditBills WHERE VendorCreditId = '1894545000000083308'

Columns


Name	Type	References	SupportedOperators	Description
VendorCreditBillId [KEY]	String			Bill ID of vendor credit.
VendorCreditId	String	VendorCredits.VendorCreditId		ID of a vendor credit.
VendorCreditNumber	String			Number of vendor credit.
Amount	Decimal			Amount of the vendor credited bills.
BillId	String	Bills.BillId		Id of a bill.
BillNumber	String			Number of a bill.
Date	Date			Date of a vendor credit.

VendorCreditLineItems

Retrieves list of line items from vendor credits.

Table Specific Information

Select

The Sync App 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 Sync App.
Note: VendorCreditId is required in order to query VendorCreditLineItems.

VendorCreditId supports the '=' comparison.

For example:

    SELECT * FROM VendorCreditLineItems WHERE VendorCreditId = '1894545000000083308'

Columns


Name	Type	References	SupportedOperators	Description
LineItemId [KEY]	String			ID of a line item.
VendorCreditId	String	VendorCredits.VendorCreditId		ID of a vendor credit.
AccountId	String	BankAccounts.AccountId		ID of the Bank Account.
AccountName	String			Name of the account.
BcyRate	Decimal			Rate of a Base Currency.
CustomFields	String			Custom Fields added for the line item
Description	String			Description of the vendor credit line item.
GstTreatmentCode	String			Treatement code of GST.
HasProductTypeMismatch	Boolean			Check if the product type has mismatch.
HsnOrSac	String			HSN Code.
ItcEligibility	String			Eligibility of Input Tax Credit.
ItemId	String	Items.ItemId		ID of an item.
ItemOrder	Integer			Order of an item.
ItemTotal	Decimal			Total of an item.
ItemType	String			Type of an item.
Name	String			Name of a line item.
PricebookId	String			Id of a price book.
ProductType	String			Product type of vendor credit.
ProjectId	String	Projects.ProjectId		Id of a project.
Quantity	Decimal			Quantity of vendor credit.
Rate	Decimal			Rate of vendor credit.
ReverseChargeTaxId	String			ID of the reverse charge tax.
Tags	String			Details of tags related to vendor credit line items.
TaxExemptionCode	String			Code of 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 of tax.
TaxType	String			Type of tax.
Unit	String			Unit of line items in vendor credit.

VendorCredits

Retrieves list of vendor credits.

Table Specific Information

Select

The Sync App 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 Sync App.

VendorCreditNumber supports the '=' comparison.
Date supports the '=,<,>' comparisons.
LastModifiedTime supports the '=' comparison.
ReferenceNumber supports the '=' comparison.
Status supports the '=' comparison.
Total supports the '=,<,<=,>,>=' comparisons.
CustomerId supports the '=' comparison.
VendorCreditsFilter supports the '=' comparison.
LineItemId supports the '=' comparison.
ItemId supports the '=' comparison.
TaxId supports the '=' comparison.
CustomerName supports the '=' comparison.
ItemDescription supports the '=' comparison.
Notes supports the '=' comparison.
ItemName supports the '=' comparison.

For example:

    SELECT * FROM VendorCredits WHERE Total >= 100 AND Status = 'open'

    SELECT * FROM VendorCredits WHERE VendorCreditNumber = 'CN-00001'

Columns


Name	Type	References	SupportedOperators	Description
VendorCreditId [KEY]	String			ID of a vendor credit.
VendorCreditNumber	String			Number of a vendor credit.
VendorName	String			Name of the vendor the vendor credit has been made.
Balance	Decimal			Balance of a vendor credit.
ColorCode	String			Color code of vendor credit.
CreatedTime	Datetime			Time at which the vendor credit was created.
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 vendor credit.
CurrentSubStatusId	String			Current sub status ID of a vendor credit.
Date	Date		=,<,>	Date of the vendor credit.
HasAttachment	Boolean			Check if vendor credit has attachment.
LastModifiedTime	Datetime			Last modfified time of the vendor credit.
ReferenceNumber	String			Reference number of the vendor credit.
Status	String			Status of the vendor credit. 使用できる値は次のとおりです。open, closed, void
Total	Decimal		=,<,<=,>,>=	Total of vendor credits. Search by total amount.

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
CustomerId	String		Id of a customer.
VendorCreditFilter	String		Filter vendor credits by statuses. 使用できる値は次のとおりです。Status.All, Status.Open, Status.Draft, Status.Closed, Status.Void
LineItemId	String		Id of a line item.
ItemId	String		Id of an item.
TaxId	String		Id of a tax.
CustomerName	String		Name of the vendor.
ItemDescription	String		Description of an item.
Notes	String		Notes of a vendor credit.
ItemName	String		Name of an item.

VendorPayments

Retrieves list of all the payments made to your vendor.

Table Specific Information

Select

The Sync App 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 Sync App.

VendorId supports the '=' comparison.
VendorName supports the '=' comparison.
Amount supports the '=,<,<=,>,>=' comparisons.
Date supports the '=,<,>' comparisons.
Description supports the '=' comparison.
LastModifiedTime supports the '=' comparison.
PaymentMode supports the '=' comparison.
PaymentNumber supports the '=' comparison.
ReferenceNumber supports the '=' comparison.
VendorPaymentFilter supports the '=' comparison.
Notes supports the '=' comparison.

For example:

    SELECT * FROM VendorPayments WHERE Amount >= 98 AND Date < '2019-07-07'

    SELECT * FROM VendorPayments WHERE PaymentNumber = 1;

    SELECT * FROM VendorPayments WHERE CONTAINS(PaymentMode,'sh')

Columns


Name	Type	References	SupportedOperators	Description
PaymentId [KEY]	String			ID of a payment.
VendorId	String			ID of the vendor the vendor payment has been made. Search payments by vendor id.
VendorName	String			Name of the vendor the vendor payment has been made. Search payments by vendor name.
AchGwTransactionId	String			ID of a ACH GW Transaction.
Amount	Decimal		=,<,<=,>,>=	Payment amount made to the vendor. Search payments by payment amount.
Balance	Decimal			Balance of vendor payment.
BcyAmount	Decimal			Amount of Base Currency.
BcyBalance	Decimal			Balance of Base Currency.
CheckDetailsCheckId	String			ID of a check.
CheckDetailsCheckNumber	String			Number of a check.
Date	Date		=,<,>	Date the payment is made. Search payments by payment made date.
Description	String			Description of a vendor payment.
HasAttachment	Boolean			Check if a vendor payment has attachment.
LastModifiedTime	Datetime			Last Modified Time of the Vendor Payment.
PaymentMode	String			Mode through which payment is made. Search payments by payment mode.
PaymentNumber	Integer			Number through which payment is made. Search with Payment Number.
ReferenceNumber	String			Reference number of a a bill.

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
VendorPaymentFilter	String		Filter payments by mode. 使用できる値は次のとおりです。PaymentMode.All, PaymentMode.Check, PaymentMode.Cash, PaymentMode.BankTransfer, PaymentMode.Paypal, PaymentMode.CreditCard, PaymentMode.GoogleCheckout, PaymentMode.Credit, PaymentMode.Authorizenet, PaymentMode.BankRemittance, PaymentMode.Payflowpro, PaymentMode.Others.
Notes	String		Notes of vendor payments..

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Connection

プロパティ	説明
OrganizationId	The Id associated with the specific Zoho Books organization you wish to connect to.
IncludeCustomFields	Set whether to include custom fields that are added to the views.
AccountsServer	The full Account Server URL.
RowScanDepth	The maximum number of rows to scan for the custom fields columns available in the table.

OAuth

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Zoho Books から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

Connection

このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。

プロパティ	説明
OrganizationId	The Id associated with the specific Zoho Books organization you wish to connect to.
IncludeCustomFields	Set whether to include custom fields that are added to the views.
AccountsServer	The full Account Server URL.
RowScanDepth	The maximum number of rows to scan for the custom fields columns available in the table.

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.

IncludeCustomFields

Set whether to include custom fields that are added to the views.

解説

If set to FALSE, the custom fields of the tables will not be retrieved. This defaults to true.

AccountsServer

The full Account Server URL.

解説

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 (.com, .eu, .in, .com.au, ...).

RowScanDepth

The maximum number of rows to scan for the custom fields columns available in the table.

解説

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly.

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

OAuthClientId

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuthClientSecret

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSLServerCert

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：


説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

FirewallType

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。


タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はZoho Books への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

FirewallPort

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

FirewallUser

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

FirewallPassword

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyPort

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

BASIC： Sync App はHTTP BASIC 認証を行います。
DIGEST： Sync App はHTTP DIGEST 認証を行います。
NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。


AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

LogModules

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログページを参照してください。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\ZohoBooks Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

BrowsableSchemas

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、パフォーマンスが向上します。

Tables

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Views

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Zoho Books から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

MaxRows

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

Other

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

Pagesize

Zoho Books から返されるページあたりの結果の最大数。

解説

Pagesize プロパティは、Zoho Books から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

PseudoColumns

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

Timeout

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

UserDefinedViews

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

各ルートエレメントはビューの名前を定義します。
各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

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

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

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