Establishing a Connection

Adding a Connection to Zoho Inventory

To add a connection to Zoho Inventory:

In the application console, navigate to the Connections page.
At the Add Connections panel, select the icon for the connection you want to add.
If the Zoho Inventory icon is not available, click the Add More icon to download and install the Zoho Inventory connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Zoho Inventory

The Sync App leverages OAuth for authentication.

Web Applications

When connecting via a web application (when the Sync App is not running on the same machine as your web browser), you need to create and register a custom OAuth application with Zoho Inventory. You can then use the Sync App to acquire and manage the OAuth token values. See Creating a Custom OAuth App for more information about custom applications.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

OAuthClientId: Set this to the Client Id that was displayed upon creation of your custom OAuth app.
OAuthClientSecret: Set this to the Client Secret that was displayed upon creation of your custom OAuth app.

Then call stored procedures to complete the OAuth exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the CallbackURL input to the Authorized Redirect URI you specified in your custom OAuth application's settings. The stored procedure returns the URL to the OAuth endpoint.
Navigate the user to the URL that the stored procedure returned in Step 1. After the user authenticates and authorizes to the custom OAuth application, the browser redirects the user to the callback URL with a "code" parameter appended to the end.
Call the GetOAuthAccessToken stored procedure. Set AuthMode to WEB and the Verifier input to the "code" parameter in the query string of the callback URL.

Once you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the driver automatically refresh the OAuth access token, set the following on the first data connection:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: Set this to the Client Id that was displayed upon creation of your custom OAuth app.
OAuthClientSecret: Set this to the Client Secret that was displayed upon creation of your custom OAuth app.
OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
OAuthSettingsLocation: Set this to the location where the Sync App saves the OAuth token values that persist across connections.

On subsequent data connections, the values for OAuthAccessToken and OAuthRefreshToken are taken from OAuthSettingsLocation.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token.

Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

InitiateOAuth: Set this to the OFF.
OAuthClientId: Set this to the Client Id in your application settings.
OAuthClientSecret: Set this to the Client Secret in your application settings.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

Choose one of two options:
- Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
- Option 2: Install the Sync App on a machine with an Internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
Then configure the Sync App to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an Internet browser and obtain the OAuthVerifier connection property.

Choose one of these options:
- If you are using the Embedded OAuth Application, call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
- If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
  - InitiateOAuth: Set to OFF.
  - OAuthClientId: Set to the client Id assigned when you registered your application.
  - OAuthClientSecret: Set to the client secret assigned when you registered your application.
  Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
Log in and grant permissions to the Sync App. You are then redirected to the callback URL, which contains the verifier code.
Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

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

InitiateOAuth: Set this to REFRESH.
OAuthVerifier: Set this to the verifier code.
OAuthClientId (custom applications only): Set this to the Client Id that was displayed upon creation of your custom OAuth app.
OAuthClientSecret (custom applications only): Set this to the Client Secret that was displayed upon creation of your custom OAuth app.
OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.

Attempt a connection. If the Sync App reports a successful connection, the OAuth settings file will have been generated in the location specified in OAuthSettingsLocation.

Clear the OAuthVerifier from your Sync App settings:

InitiateOAuth: Set this to REFRESH.
OAuthClientId (custom applications only): Set this to the Client Id that was displayed upon creation of your custom OAuth app.
OAuthClientSecret (custom applications only): Set this to the Client Secret that was displayed upon creation of your custom OAuth app.
OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an Internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this path gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

Advanced Features

This section details a selection of advanced features of the Zoho Inventory Sync App.

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Zoho Inventory and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

SSL Configuration

Customizing the SSL Configuration

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

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

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

Overview

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

Key Features

The Sync App models Zoho Inventory entities like invoices, bills, and currencies as relational views, allowing you to write SQL to query Zoho Inventory data.
Stored procedures allow you to execute operations to Zoho Inventory, including expense receipt, retainer invoice attachment and attachments.
Live connectivity to these objects means any changes to your Zoho Inventory 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

Tables are statically defined to model Zoho Inventory entitites such as Invoices, Contacts, Bills, and more.

Views

Views describes the available views. Views are read-only tables that are statically defined to model Zoho Inventory entities such as InvoiceListPayments, ContactsListComments and more.

Stored Procedures

Stored Procedures are function-like interfaces to Zoho Inventory. Stored procedures allow you to execute operations to Zoho Inventory, including emailing contacts, inviting users into your organization, and printing invoices.

Tables

The Sync App models the data in Zoho Inventory as a list of tables in a relational database that can be queried using standard SQL statements.

Zoho Inventory Connector for CData Sync Tables


Name	Description
Bills	Read, Insert, Update and Delete Bills.
CompositeItems	Read, Insert, Update and Delete the CompositeItems.
CompositeItemsBundles	Read,Insert, Update and Delete CompositeItemsBundles.
CompositeItemsMappedItems	Read the mapped items of the Composite items.
ContactPersons	Read, Insert, Update and Delete Contact Persons.
Contacts	Retrives list of all contacts
CreditNoteInvoicesCredited	List invoice credited for credit notes.
CreditNoteRefund	Read, Insert,Update and Delete Refunds of CreditNotes.
CreditNotes	List, Insert,Update and Delete Credit Notes.
CreditNotesComments	List, Insert and Delete Comments from CreditNotes.
Currencies	Read, Insert, Update and Delete Currencies.
CustomerPayments	Read, Insert, Update nad Delete Customer Payments.
InventoryAdjustments	Read, Insert and Delete Inventory Adjustments.
InvoiceComments	Read, Insert,Update and Delete the Comment of the invoice.
Invoices	Read, Insert, Update and Delete Invoices.
InvoicesBillCredited	Read, Insert and Delete bills credited of invoices.
InvoicesLineItems	Line items of Invoices.
ItemGroups	Read, Insert, Update adn Delete Item groups.
Items	Read, Insert, Update and Delete Items.
Organizations	Get list of Organization
Packages	Read, Insert, Update and Delete Packages.
Pricebooks	Read, Insert, Update and Delete Pricebooks.
PurchaseOrders	Read, Insert, Update and Delete Purchase Orders.
PurchaseReceives	Read, Insert and Delete Purchase Receives.
RetainerInvoiceListPayments	Get payments of Retainer Invoice.
RetainerInvoices	Read, Insert, Update and Delete Retainer Invoice.
RetainerInvoicesComments	List comments of Retainer Invoice.
SalesOrders	Read, Insert,Update and Delete Sales Orders.
SalesReturns	Read, Insert, Update and Delete Sales Returns.
ShipmentOrders	Read, Insert, Update and Delete Shipment Orders.
TaxAuthorities	Read, Create, Update and Delete Tax Authorities.
Taxes	Read, Insert, Update and Delete taxes.
TaxExemptions	Read, Insert, Update and Delete Tax Exemption
TaxGroups	Read, Insert, Update and Delete Tax Groups.
TransferOrders	Read, Insert and Delete Transfer Orders.
Users	Read, Insert, Update and Delete Users.
VendorCreditRefund	Read, Insert and Update Vendor Credit Refunds.
VendorCredits	Read, Insert, Update and Delete Vendor Credits.
VendorCreditsBillCredited	Read, Insert and Delete Bills Credited of Vendor Credits.
Warehouses	Read, Insert, Update and Delete Warehouses.

Bills

Read, Insert, Update and Delete Bills.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Bills WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the VendorId, BillNumber, Date, DueDate and 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 Bills (VendorId, BillNumber, Date, DueDate, LineItems) VALUES (3249056000000160028, 33, '2022-06-30', '2022-07-30', '[{\"name\": \"Chips\",\"warehouse_id\": 3249056000000138013,\"account_id\": 3249056000000000388, \"account_name\": \"Inventory Asset\", \"rate\": 900,\"quantity\": 2,\"reverse_charge_tax_id\":3249056000000158097 }]')

Update

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

UPDATE Bills SET VendorId = '3249056000000160028', BillNumber = '77', Date = '2022-06-30', DueDate = '2022-06-30', LineItems = '[{\"name\": \"Machines\",\"warehouse_id\": 3249056000000138013,\"account_id\": 3249056000000000388, \"account_name\": \"Inventory Asset\", \"rate\": 50000,\"quantity\": 2,\"reverse_charge_tax_id\":3249056000000158097 }]' WHERE Id = 3249056000000195059

Delete

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

DELETE FROM Bills WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique ID generated by the server.
AttachmentName	String	True		Name of the attached file.
Balance	Integer	True		Remaining balance of the Bill.
Status	String	False		Status of the Bill.
BillNumber	String	False		Bill number of Purchase Order.
CreatedTime	Datetime	True		Time at which the Bill details were last created..
CurrencyCode	String	True		Currency code.
CurrencyId	Long	False		Unique ID generated by the server for the currency.
CurrencySymbol	String	True		The symbol for the selected currency.
Date	Date	False		Date of the Bill.
DueByDays	Integer	True		Number of days by which the Bill is due.
DueDate	Date	False		Due date for the Bill.
ExchangeRate	Integer	False		Exchange rate of the currency, with respect to the base currency.
IsItemLevelTaxCalc	Boolean	False		Checks whether item level tax is calculated or not.
LastModifiedTime	Datetime	True		Time at which the bill details were last Modified.
LineItems	String	False		The line items for a Bill.
Notes	String	False		Notes for the Bill.
OpenPurchaseordersCount	Integer	True		Number of Purchase Orders that are associated with this Bill and open.
Payments	String	True		Payment details for the Bill.
PricePrecision	Integer	True		The precision level for the price decimal point in a Bill.
PurchaseorderId	Long	False		Unique ID generated by the server for the Purchase Order.
ReferenceId	Long	True		Unique ID generated by the server for the reference.
ReferenceNumber	String	False		Reference number for the Bill.
SubTotal	Integer	True		Sub Total of the Bill.
TaxTotal	Integer	True		The total of the Tax.
Taxes	String	True		Number of taxes applied on the Purchase Order.
Terms	String	False		Terms and conditions..
UnusedCreditsPayableAmount	Integer	True		Unused credit payable amount.
VendorCredits	String	True		The available Vendor Credits.
VendorCreditsApplied	Integer	True		Vendor credits applied to the Bill.
VendorId	Long	False		Unique ID generated by the server for the vendor.
VendorName	String	True		Name of the vendor.
BillingAddressAddress	String	False		Name of the street of the customers billing address.
BillingAddressCity	String	False		Name of the city of the customers billing address.
BillingAddressCountry	String	False		Name of the country of the customers billing address.
BillingAddressFax	String	False		Fax number of the customers billing address.
BillingAddressState	String	False		Name of the state of the customer billing address.

CompositeItems

Read, Insert, Update and Delete the CompositeItems.

Table Specific Information

Select

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

Id supports the '=' comparison.
CreatedTime supports the '=' comparison.
LastModifiedTime supports the '=' comparison.
Name supports the '=' comparison.
PurchaseRate supports the '=' comparison.
Rate supports the '=' comparison.
ReorderLevel supports the '=' comparison.
Sku supports the '=' comparison.
Source supports the '=' comparison.
TaxName supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CompositeItems WHERE Id = '3350895000000089001'

SELECT * FROM CompositeItems WHERE CreatedTime = '2013-08-05'

SELECT * FROM CompositeItems WHERE LastModifiedTime = '2013-08-05'

SELECT * FROM CompositeItems WHERE Name = 'new'

SELECT * FROM CompositeItems WHERE PurchaseRate = '66'

SELECT * FROM CompositeItems WHERE Rate = '76'

SELECT * FROM CompositeItems WHERE ReorderLevel = '1'

SELECT * FROM CompositeItems WHERE Sku = '23'

SELECT * FROM CompositeItems WHERE Source = 'abc'

SELECT * FROM CompositeItems WHERE TaxName = 'tax'

Insert

Insert can be executed by specifying the Name, MappedItems, Sku, Rate and ItemType 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 CompositeItems (Name, ItemType, Rate, MappedItems) VALUES ('PQRstub', 'inventory', '1999', '[ {\"item_id\": 3285934000000104097, \"quantity\": 3}]')

Update

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

UPDATE CompositeItems SET Name = 'test2' WHERE Id = '3285934000000136008'

Delete

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

DELETE FROM CompositeItems WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique ID generated for the composite item by the server.
ActualAvailableStock	Integer	True		Stock based on Shipments and Receives minus ordered stock.
AvailableStock	Integer	True		Stock based on Shipments and Receives.
AssetValue	Double	True		value of the composite items based on purchase rate
CreatedTime	Datetime	True		Automatically generated time when item was created.
description	String	False		Sample description.
Ean	Long	False		European Article Number, 13 digit barcode number of the item
HsnorSac	String	False		HSN Code of the item
ImageId	Long	True		Unique identifier generated by the server for item image.
ImageName	String	True		Name of the image.
AccountId	Long	False		Unique ID generated by the server for the type of sale of this item
InventoryAccountId	Long	False		Unique ID generated by the server for the type of inventory for this item
InventoryAccountName	String	True		Name of inventory type
IsComboProduct	Boolean	False		Defines whether the item is composite or not.
IsTaxable	Boolean	True		is taxable.
InitialStock	String	False		Initial stock of item
InitialStockRate	String	False		Average purchase price of initial stock.
Isbn	Integer	False		International Standard Book Number, 13 digit unique commercial book identifier barcode of the item.
ItemType	String	False		Type of item Always inventory
LastModifiedTime	Datetime	True		last modified time.
MappedItems	String	False		Items that are associated with the composite item.
ItemTaxPreferences	String	False		Item Tax Preferences that are associated with the composite item.
CustomFields	String	False		Custom fields are used to add more information about the item
Name	String	False		Name of the composite item.
PartNumber	String	False		MPN - Manufacturing Part Number, unambiguously identifies a part design.
ProductType	String	True		product type.
Purchasedescription	String	False		Purchase desc of the item.
PurchaseRate	Integer	False		Buying price of the item.
PurchaseAccountId	Long	False		Unique ID generated by the server for the type of purchase.
PurchaseAccountName	String	True		Type of purchase under which the composite item was bought
PricebookRate	Integer	False		Price list applied on the item selling price.
Rate	Integer	False		Selling price of the item.
ReorderLevel	Integer	False		Reorder point of the item.
Sku	String	False		Stock Keeping Unit value of the item. It should be unique throughout the product.
Source	String	True		source.
Status	String	True		Status of the Item.
StockOnHand	Integer	True		Stock based on Invoices and Bills.
TaxId	Long	False	Taxes.Id	Unique ID generated by the server for the tax ..
TaxName	String	True		Name of the tax applied on selling this item.
TaxPercentage	Integer	True		Percentage at which the item is taxed.
Upc	Long	False		Unique Product Code, 12 digit unique code of the item.
Unit	String	False		Unit of the Item.
VendorId	String	False	Taxes.Id	ID of the vendor the vendor credit is associated with.
OrganizationId	String	False	Organizations.Id	ID of the Organization
VendorName	String	False		Name of the Vendor Associated with the Vendor Credit
CompositeItemsFilter	String	True		Filter items by status The allowed values are Status.All, Status.Active, Status.Inactive, Status.Lowstock.

CompositeItemsBundles

Read,Insert, Update and Delete CompositeItemsBundles.

Table Specific Information

Select

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

Id supports the '=' comparison.
CompositeItemId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CompositeItemsBundles WHERE Id = '3350895000000089001'

SELECT * FROM CompositeItemsBundles WHERE CompositeItemId = '23350895000000089001'

Insert

Insert can be executed by specifying the ReferenceNumber, Date, Description, CompositeItemId, CompositeItemName, IsCompleted, QuantityToBundle and 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 CompositeItemsBundles (ReferenceNumber, Date, Description, CompositeItemId, CompositeItemName, IsCompleted, QuantityToBundle, LineItems) VALUES (124, '22-02-22', 'desc', 123, 'name', 'true', 12, '[ {\"item_id\": 3285934000000104097, \"quantity\": 3}]')

Update

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

UPDATE CompositeItemsBundles SET Name = 'test2' WHERE Id = '3285934000000136008'

Delete

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

DELETE FROM CompositeItemsBundles WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Id of Bundle
IsCompleted	Boolean	False		Denotes the status of the bundle. Currently, this has to be true since we didnt support any other status as of now.
CompositeItemId	Long	False	CompositeItems.Id	Unique ID generated for the composite item by the server.
CompositeItemName	String	False		Name of the composite item
CompositeItemSku	String	False		Stock Keeping Unit value of the composite item.
Date	String	False		The date on which bundling is done
Description	String	False		Sample Description.
LineItems	String	False		A bundle can contain multiple line items.
QuantityToBundle	Integer	False		Quantity of bundles to be bundled.
ReferenceNumber	String	False		Reference number for the Bundle.

CompositeItemsMappedItems

Read the mapped items of the Composite items.

Table Specific Information

Select

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

MappedItemId supports the '=' comparison.
CompositeItemId supports the '=' comparison.
ItemId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CompositeItemsMappedItems WHERE MappedItemId = '3350895000000089001'

SELECT * FROM CompositeItemsMappedItems WHERE CompositeItemId = '205'

SELECT * FROM CompositeItemsMappedItems WHERE ItemId = '20130805'

Insert

Insert can be executed by specifying the Name, MappedItems, Sku, Rate and ItemType 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 CompositeItemsMappedItems (Name, Rate, Sku) VALUES ('PQRstub', 98, 9)

Update

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

UPDATE CompositeItemsMappedItems SET Name = 'test2' WHERE MappedItemId = '3285934000000136008'

Delete

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

DELETE FROM CompositeItemsMappedItems WHERE MappedItemId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
MappedItemId [KEY]	Long	False		Unique ID generated by the server for mapping the associated item with composite item
CompositeItemId	Long	False	CompositeItems.Id	Unique ID generated by the server for the Item.This is used as an identifier.
ActualAvailableStock	Integer	False		Stock based on Shipments and Receives minus ordered stock
AvailableStock	Integer	False		Stock based on Shipments and Receives
Description	String	False		Sample Description.
ImageId	Long	False		Unique identifier generated by the server for item image
ImageName	String	False		Name of the image
ImageType	String	False		Type of the image
IsComboProduct	Boolean	False		Defines whether the item is composite or not
ItemId	Long	False	Items.Id	Unique ID generated by the server for the Item.This is used as an identifier.
Name	String	False		Name of the composite item
PurchaseDescription	String	False		Purchase description of the item
PurchaseRate	Integer	False		Buying price of the item
Quantity	Integer	False		Quantity of item associated with the composite item
Rate	Integer	False		Selling price of the item
Sku	String	False		Stock Keeping Unit value of the item.
StockOnHand	Integer	False		Stock based on Invoices and Bills
Unit	String	False		Unit of Item

ContactPersons

Read, Insert, Update and Delete Contact Persons.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ContactPersons WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the FirstName 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 ContactPersons (FirstName) VALUES ('Test')

Update

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

UPDATE ContactPersons SET Name = 'test2' WHERE Id = '3285934000000136008'

Delete

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

DELETE FROM ContactPersons WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Id of contact person.
ContactId	Long	False	Contacts.Id	ID of the contact.
Department	String	False		department to which the contact person belongs..
Designation	String	False		designation of the contact person
Email	String	False		Email ID of the contact person.
EnablePortal	String	False		Option to enable or disable portal access the contact person.
FirstName	String	False		First Name of the contact
IsAddedInPortal	Boolean	True		tells whether the contact person has portal access or not
IsPrimaryContact	Boolean	True		To mark contact person as primary for communication.
LastName	String	False		Last Name of the contact.
Mobile	String	False		Mobile/Cell number of the contact person.
Phone	String	False		Phone number of the contact person.
Salutation	String	False		Salutation for the contact.
Skype	String	False		skype address of the contact person.

Contacts

Retrives list of all contacts

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM Contacts WHERE Id = '3350895000000089001'

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

SELECT * FROM Contacts WHERE CompanyName = 'name'

SELECT * FROM Contacts WHERE FirstName = 'firstname'

SELECT * FROM Contacts WHERE LastName = 'lastname' 

SELECT * FROM Contacts Address = 'Street and City'

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

SELECT * FROM Contacts WHERE Phone = '873545636272'

Insert

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

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

Update

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

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

Delete

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

DELETE FROM Contacts WHERE Id = '3350895000000089001'

Columns


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

CreditNoteInvoicesCredited

List invoice credited for credit notes.

Table Specific Information

Select

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

CreditNoteId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CreditNoteInvoicesCredited WHERE CreditNoteId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
CreditedAmount	Double	False		CreditedAmount
CreditNoteId [KEY]	String	False	CreditNotes.Id	CreditNoteId
CreditNoteInvoiceId [KEY]	String	False		CreditNoteInvoiceId
CreditNoteNumber	String	False		CreditNoteNumber
Date	Date	False		Date
InvoiceId	String	False		InvoiceId
InvoiceNumber	String	False		InvoiceNumber

CreditNoteRefund

Read, Insert,Update and Delete Refunds of CreditNotes.

Table Specific Information

Select

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

CreditNoteId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CreditNoteRefund WHERE CreditNoteId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
AmountBcy	Integer	False		Refund Amount in Base Currency
AmountFcy	Integer	False		Refund Amount in Foreign Currency
CreditNoteId [KEY]	String	False	CreditNotes.Id	CreditNote Id
CreditNoteNumber	String	False		CreditNote Number
CreditNoteRefundId [KEY]	String	False		CreditNote RefundId
CustomerName	String	False		Customer Name
Date	Date	False		The date on which the credit note was raised. Format [yyyy-mm-dd]
Description	String	False		A brief description about the item.
ReferenceNumber	String	False		Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100]
RefundMode	String	False		The method of refund.

CreditNotes

List, Insert,Update and Delete Credit Notes.

Table Specific Information

Select

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

Id supports the '=' comparison.
Balance supports the '=' comparison.
CreatedTime supports the '=' comparison.
CreditnoteNumber supports the '=' comparison.
CurrencyCode 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.
ItemId supports the '=' comparison.
ItemName supports the '=' comparison.
CreditNoteFilter supports the '=' comparison.
ItemDescription supports the '=, LIKE' comparisons.

For example, the following queries are processed server side:

SELECT * FROM CreditNotes WHERE Id = '3350895000000089001'

SELECT * FROM CreditNotes WHERE CreditnoteNumber = '837872'

SELECT * FROM CreditNotes WHERE Date = '2016-06-05'

SELECT * FROM CreditNotes WHERE Status = 'open'

SELECT * FROM CreditNotes WHERE Total = '500'

SELECT * FROM CreditNotes WHERE ReferenceNumber = '5000000089001'

SELECT * FROM CreditNotes WHERE CustomerName = 'name'

SELECT * FROM CreditNotes WHERE ItemName = 'item1'

SELECT * FROM CreditNotes WHERE CustomerId = '987652367'

SELECT * FROM CreditNotes WHERE ItemDescription = 'new item'

SELECT * FROM CreditNotes WHERE ItemId = '298755'

Insert

Insert can be executed by specifying the CustomerId, CreditnoteNumber and 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 CreditNotes (CustomerId, Date, CreditnoteNumber, LineItems) VALUES (3249056000000113107,, '12-12-22', 'CN-00006', '[{\"item_id\": \"3249056000000083053\", \"description\": \"prorated amount for items\",\"type\": 1, \"invoice_id\": \"3249056000000186055\",\"tax_id\": \"3249056000000158109\"}]')

Update

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

UPDATE CreditNotes SET Balance = 5000 WHERE Id = 3249056000000185047

Delete

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

DELETE FROM CreditNotes WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique ID of the credit note generated by the server.
Balance	Integer	True		The unapplied credits.
CreatedTime	Datetime	True		Time at which the credit note was created..
CreditnoteNumber	String	False		Unique number generated which will be displayed in the interface and credit notes.
CurrencyCode	String	True		Customer currency code.
CurrencyId	String	True		Unique Id of currencies.
CustomerId	String	False	Contacts.Id	Customer ID of the customer for whom the credit note is raised..
CustomerName	String	True		Name of the customer to whom the credit note is raised.
Date	Date	False		The date on which the credit note was raised.
Email	String	True		Email address of the customer.
GstNo	String	True		15 digit GST identification number of the customer.
GstTreatment	String	True		Choose whether the contact is GST registered/unregistered/consumer/overseas.
IsPreGst	Boolean	True		Applicable for transactions that were created before July 1, 2017.
IsDraft	Boolean	False		Set to true if credit note has to be created in draft status.
IsEmailed	Boolean	True		Boolean to check whether emailed or not.
ExchangeRate	String	False		Exchange rate for the currency associated with the customer.
LastModifiedTime	Datetime	True		Time at which the credit note details were last modified.
PlaceOfSupply	String	True		Place where the goods/services are supplied to.
IgnoreAutoGenerationNumber	Boolean	False		Set to true if you need to provide your own credit note number.
ReferenceNumber	String	False		Reference number generated for the payment. A string of your choice can also be used as the reference number.
Status	String	True		Status of the credit note. The allowed values are open, closed, void.
Total	Integer	False		Total credits raised in this credit note.
Notes	String	False		A short note for the credit note
TaxTreatment	String	True		Place where the goods/services are supplied to.
TemplateId	Long	False		Unique ID of the creditnote template
TaxAuthorityId	Long	False	TaxAuthorities.Id	Unique ID of the tax authority. Tax authority depends on the location of the customer.
TaxExemptionId	Long	False	TaxExemptions.Id	Unique ID of the tax exemption
TaxId	Long	False	Taxes.Id	Unique ID to denote the tax associated with the credit note.
TemplateName	String	True		Name of the default template of the creditnote.
Terms	String	False		Terms and condition to be displayed in the credit note.
Total	Integer	True		Total credits raised in this credit note.
UpdatedTime	Datetime	True		Time at which the credit note details were last updated.
VatRegNo	String	True		vat_reg_no
VatTreatment	String	True		VAT treatment for the credit notes.
LineItems	String	True		Line items of credit notes.
Invoices	String	True		List of invoices for which the credit note has been raised.
Taxes	String	True		Taxes associated with the subscription.
ItemId	String	False	Items.Id	Id of an item.
ItemName	String	True		Name of an item.
ItemDescription	String	True		Description of an item.

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 invoices by any status or payment expected date.

The allowed values are Status.All, Status.Draft, Status.Void, Status.Open, Status.Closed.

CreditNotesComments

List, Insert and Delete Comments from CreditNotes.

Table Specific Information

Select

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

Id supports the '=' comparison.
CreditNoteId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CreditNotesComments WHERE Id = '3350895000000089001'

SELECT * FROM CreditNotesComments WHERE CreditnoteId = '837872'

Insert

Insert can be executed by specifying the CustomerId, CreditnoteNumber and 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 CreditNotesComments (Description, Date) VALUES ('av', '11'-11-20')

Update

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

UPDATE CreditNotesComments SET Description = 'desc' WHERE Id = 3249056000000185047

Delete

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

DELETE FROM CreditNotesComments WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Id of the comment.
CommentType	String	False		Type of the comment.
CommentedBy	String	False		Name of the commenter.
CommentedById	String	True		Id of the commenter.
CreditNoteId [KEY]	String	False	CreditNotes.Id	Id of the credit note.
Date	Date	False		Date of the comment published.
DateDescription	String	False		Description of the date of the comment.
Description	String	False		A brief description about the item.
OperationType	String	False		Operation type of the comment.
Time	Datetime	False		Time of the comment published.
TransactionId	String	True		Transaction Id of the comment.
TransactionType	String	False		Transaction Type of the comment.

Currencies

Read, Insert, Update and Delete Currencies.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Currencies WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the CurrencyCode, CurrencySymbol and CurrencyFormat 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 Currencies (CurrencyCode, CurrencySymbol, CurrencyFormat) VALUES ('ALL', 'Af', '1,234,567.89')

Update

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

UPDATE Currencies SET CurrencyFormat = '1,234,567.89', CurrencySymbol = 'Af' WHERE Id = '3285934000000127023'

Delete

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

DELETE FROM Currencies WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		A unique ID for the currency.
CurrencyCode	String	False		A unique code for the currency.
CurrencyFormat	String	False		The format for the currency to be displayed.
CurrencyName	String	True		The name for the currency.
CurrencySymbol	String	False		A unique symbol for the currency
EffectiveDate	Date	True		Effective date
ExchangeRate	Integer	True		Exchange rate
IsBaseCurrency	Boolean	True		If the specified currency is the base currency of the organization or not.
PricePrecision	Integer	False		The precision for the price in decimals

Pseudo-Columns

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

Name

Type

Description

CurrencyFilter

String

Filter currencies excluding base currency.

The allowed values are Currencies.ExcludeBaseCurrency.

CustomerPayments

Read, Insert, Update nad Delete Customer Payments.

Table Specific Information

Select

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

Id supports the '=' comparison.
Amount supports the '=' comparison.
CustomerName supports the '=' comparison.
Notes supports the '=' comparison.
PaymentMode supports the '=' comparison.
ReferenceNumber supports the '=' comparison.
PaymentsFilter supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CustomerPayments WHERE Id = '3350895000000089001'

SELECT * FROM CustomerPayments WHERE Amount = '100'

SELECT * FROM CustomerPayments WHERE CustomerName = 'name'

SELECT * FROM CustomerPayments WHERE Notes = 'special notes'

SELECT * FROM CustomerPayments WHERE ReferenceNumber = '98900'

Insert

Insert can be executed by specifying the CustomerId, PaymentMode, Amount, Date and Invoices 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 CustomerPayments (CustomerId, PaymentMode, Amount, Date, Invoices) VALUES ('3285934000000104002', 'cash', '5000',\"2022-06-22\", '[{\"invoice_id\":\"3285934000000113001\",\"amount_applied\":5000, \"tax_amount_withheld\":0}]')

Update

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

UPDATE CustomerPayments SET CustomerId = 3285934000000104002, PaymentMode = 'cash', Amount = '5000', Date = '2022-06-21', Invoices = '[{\"invoice_id\":\"3285934000000113001\",\"amount_applied\":5000, \"tax_amount_withheld\":0}]' WHERE Id = '3285934000000136008'

Delete

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

DELETE FROM CustomerPayments WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique ID of the payment generated by the server.
AccountId	String	False		ID of the cash/ bank account the payment has to be deposited.
AccountName	String	True		Name of the cash/ bank account the payment has to be deposited.
Amount	Integer	False		Amount paid in the respective payment.
BcyAmount	Integer	True		Balance amount
BankCharges	Integer	False		Bank Charges
CustomerId	String	False		Customer ID of the customer involved in the payment.
CustomerName	String	True		Name of the customer to whom the invoice is raised.
CurrencyId	String	True		ID of the currency used in the payment
CurrencyCode	String	True		Currency code in which the payment is made.
CurrencySymbol	String	True		Customer currency symbol.
Date	Date	False		Date on which payment is made. Date Format [yyyy-mm-dd]
Email	String	True		Email address of the customer involved in the payment.
Notes	String	True		Search payments by customer notes.
ExchangeRate	String	False		Exchange rate for the currency used in the invoices and customer currency.
Description	String	False		Description about the payment.
InvoiceNumber	String	True		Unique ID (starts with INV) of an invoice.
LastFourDigits	String	True		Mode through which payment is made.
PaymentMode	String	False		Mode through which payment is made. The allowed values are check, cash, creditcard, banktransfer, bankremittance, autotransaction, others.
PaymentNumber	String	True		Payment Number
ReferenceNumber	String	False		Search payments by reference number
TaxAmountWithheld	String	True		Amount withheld for tax.
UnusedAmount	Integer	True		Amount which is not used for invoice payment yet.
Status	Integer	True		Status of the payment
TaxAccountId	Integer	False		ID of the tax account.
TaxAccountName	Integer	True		Name of the tax account.
Invoices	String	False		Invoice related to a payment
CustomFields	String	False		Custom Fields related to a 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

PaymentsFilter

String

Filter invoices by any status or payment expected date.

The allowed values are PaymentMode.All, PaymentMode.Cash, PaymentMode.Check, PaymentMode.BankTransfer, PaymentMode.PayPal, PaymentMode.CreditCard, PaymentMode.GoogleCheckout, PaymentMode.Credit, PaymentMode.Authorizenet, PaymentMode.BankRemittance, PaymentMode.Payflowpro, PaymentMode.Stripe, PaymentMode.TwoCheckout, PaymentMode.Braintree, PaymentMode.Others.

InventoryAdjustments

Read, Insert and Delete Inventory Adjustments.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InventoryAdjustments WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the Date, Reason, AdjustmentType and 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 InventoryAdjustments (Date, Reason, AdjustmentType, LineItems) VALUES ('2022-06-22', 'Damaged Goods 11', 'quantity', '[ {\"item_id\": 3285934000000104097,\"quantity_adjusted\":10 }]')

Update

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

UPDATE InventoryAdjustments SET Reason = 'poor quality' WHERE Id = '3350895000000090009'

Delete

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

DELETE FROM InventoryAdjustments WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique ID generated by the server for the item adjustment.
AdjustmentType	String	False		The adjustment type should be either quantity or value.Allowed values are quantity and value only.
Date	Date	False		The date for the Item Adjustment.
Description	String	False		Sample Description.
Reason	String	False		The reason for the Item Adjustment.
ReasonId	Long	True		Unique ID generated by the server for the reason.
ReferenceNumber	String	False		Reference number of the Item Adjustment.
Total	Integer	True		Total value of the Item Adjustment.
LineItems	String	False		An item adjustment can contain multiple line items.

InvoiceComments

Read, Insert,Update and Delete the Comment of the invoice.

Table Specific Information

Select

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

Id supports the '=' comparison.
InvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InvoiceComments WHERE Id = '3350895000000089001'

SELECT * FROM InvoiceComments WHERE InvoiceId = '1937623621'

Insert

Insert can be executed by specifying the CustomerId and 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 InvoiceComments (Description) VALUES ('test')

Update

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

UPDATE InvoiceComments SET Description = 'test2' WHERE Id = '3285934000000136008'

Delete

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

DELETE FROM InvoiceComments WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Comment ID of the invoice comment.
InvoiceId [KEY]	Long	False	Invoices.Id	ID of the invoice.
Description	String	False		Description of the comment.
PaymentExpectedDate	String	False		Payment Expected Date of Invoice.
ShowCommentToClients	String	False		Show Comment To Clients.
CommentedById	Long	False		Commented By Id.
CommentedBy	String	False		Commented By.
CommentType	String	False		Comment Type.
OperationType	String	False		Operation Type of comment.
Date	Date	False		Date.
DateDescription	String	False		Date Description of comment.
Time	String	False		Time of comment.
TransactionId	Long	False		Transaction Id of comment.
TransactionType	String	False		Transaction Type of comment.

Invoices

Read, Insert, Update and Delete Invoices.

Table Specific Information

Select

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

Id supports the '=' comparison.
CurrencyId supports the '=' comparison.
CustomerId supports the '=' comparison.
SalespersonId supports the '=' comparison.
Balance supports the '=' comparison.
CreatedTime supports the '=' comparison.
CustomerName supports the '=,LIKE' comparisons.
Date supports the '=,>,<,<=,>=' comparisons.
DueDate supports the '=,>,<,<=,>=' comparisons.
InvoiceNumber supports the '=' comparison.
ReferenceNumber supports the '=' comparison.
Status supports the '=' comparison.
TaxAmountWithheld supports the '=' comparison.
Total supports the '=' comparison.
Email supports the '=' comparison.
RecurringInvoiceId supports the '=' comparison.
ItemId supports the '=' comparison.
ItemName supports the '=,LIKE' comparisons.
ItemDescription supports the '=,LIKE' comparisons.
InvoiceFilter supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Invoices WHERE Id = '3350895000000089001'

SELECT * FROM Invoices WHERE InvoiceNumber = '1937623621'

SELECT * FROM Invoices WHERE ItemId = '867623621'

SELECT * FROM Invoices WHERE ItemName = 'name'

SELECT * FROM Invoices WHERE ItemDescription = 'description'

SELECT * FROM Invoices WHERE ReferenceNumber = '30089001'

SELECT * FROM Invoices WHERE CustomerName = 'Mr. First'

SELECT * FROM Invoices WHERE RecurringInvoiceId = '9272623621'

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

SELECT * FROM Invoices WHERE Total = '1960'

SELECT * FROM Invoices WHERE Balance = '100'

SELECT * FROM Invoices WHERE Date = '2013-12-03'

SELECT * FROM Invoices WHERE DueDate = '2013-12-03'

SELECT * FROM Invoices WHERE Status = 'Paid'

SELECT * FROM Invoices WHERE CustomerId = '987123657483'

Insert

Insert can be executed by specifying the CustomerId and 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 Invoices (CustomerId, LineItems) VALUES (3285934000000085043, '[{\"name\": \"I Phone\", \"description\": \"500GB, USB 2.0 interface 1400 rpm, protective hard case.\"}]')

Update

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

UPDATE Invoices SET Email = '[email protected]', CustomerId = '8779', LineItems = [{\"name\": \"I Phone\"}] WHERE Id = '3285934000000136008'

Delete

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

DELETE FROM Invoices WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The ID of the invoice.
CurrencyId	Long	False	Currencies.Id	The id of the currency.
CustomerId	Long	False	Contacts.Id	ID of the customer the invoice has to be created..
SalespersonId	String	True		ID of the salesperson linked to invoice.
TemplateId	String	True		ID of the pdf template associated with the invoice..
AttachmentName	String	True		Name of the file attached
AchPaymentInitiated	Boolean	True		To check initiation of ACH Payment.
Adjustment	Integer	True		Adjustments made to the invoice..
AllowPartialPayments	Integer	True		Boolean to check if partial payments are allowed for the contact.
Balance	Double	True		The unpaid amount
ClientViewedTime	String	True		Time when client viewed the statement.
CreatedTime	Datetime	False		The time of creation of the invoices.
CurrencyCode	String	True		The currency code in which the invoice is created..
CustomerName	String	False		The name of the customer. Maximum length [100].
CanSendInMail	String	False		To check if attachment can be sent in email
Discount	Float	True		Discount applied to the invoice. It can be either in % or in amount.
Date	Date	True		Invoice date. Default date format is yyyy-mm-dd..
IsPreGst	String	True		Applicable for transactions that fall before july 1, 2017
GstNo	String	True		15 digit GST identification number of the customer.
GstTreatment	String	True		Choose whether the contact is GST registered/unregistered/consumer/overseas.
Adjustmentdesc	String	True		Customize the adjustment desc. E.g. Rounding off.
PaymentReminderEnabled	Boolean	True		Boolean to check if reminders have been enabled.
PaymentMade	String	True		The amount paid
PaymentOptions	String	True		Payment options available for payment
PricePrecision	String	True		The precision value on the price
IsDiscountBeforeTax	Boolean	True		Check if discount is exclusive of tax
DiscountType	String	False		Type of discount. Allowed values are entity_level,item_level.
IsInclusiveTax	Boolean	True		To check if discount is inclusive of tax.
InvoiceUrl	String	True		Url of invoice as a link.
PaymentTerms	Integer	True		Payment terms in days.
PaymentTermsLabel	String	True		Used to override the default payment terms label..
DueDate	Date	True		Due date of the invoices. Default date format is yyyy-mm-dd..
DueDays	String	True		Due days.
ExchangeRate	Integer	True		Exchange rate of the currency.
HasAttachment	Boolean	True		To check if invoice has an attachment.
InvoiceNumber	String	False		An unique number given to the invoice. Maximum length [100].
IsEmailed	Boolean	True		Boolean check to see if the mail has been sent.
IsViewedByClient	Boolean	True		Check if invoice is viewed by client
LastModifiedTime	Datetime	True		Date of last modification of the invoice.
LastPaymentDate	String	True		The last payment date of the invoice.
Notes	String	False		The notes added below expressing gratitude or for conveying some information.
LastReminderSentDate	String	True		The date the last email was sent.
ContactPersons	String	False		Contact Person listed in invoice.
Taxes	Double	True		List of the taxes levied.
LineItems	String	False		Items listed in invoice.
CustomFields	String	False		Custom Fields in invoice.
PaymentExpectedDate	String	True		The expected date of payment.
ReferenceNumber	String	False		The reference number of the invoice.
RemindersSent	Integer	True		The number of reminders sent.
SalespersonName	String	True		Name of the salesperson. Maximum length [200]
ShippingCharge	Integer	True		Shipping charges applied to the invoice. Maximum length [100].
BillingAddress	Integer	False		Billing address of the contact
ShippingAddress	Integer	False		Shipping address of the contact
Status	String	True		Search invoices by invoice status. The allowed values are sent, draft, overdue, paid, void, unpaid, partially_paid, viewed.
SubTotal	Double	True		The sub total of the all items
TaxTotal	Double	True		The total amount of the tax levied
Terms	String	True		The terms added below expressing gratitude or for conveying some information.
PlaceOfSupply	String	False		Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)
TemplateName	String	True		Name of the invoice template used
TaxAmountWithheld	Float	True		The tax amount which has been withheld
Total	Double	True		The total amount to be paid.
WriteOffAmount	Integer	True		The write off amount. i.e. the amount which is not expected to be returned. Like a bad debt.
CreditsApplied	Float	False		The credits applied.
Email	String	True		Email address of an invoice.
RecurringInvoiceId	String	True		ID of the recurring invoice from which the invoice is created.
ItemId	String	False	Items.ItemId	Id of an item.
ItemName	String	True		Name of an item.
ItemDescription	String	True		Description of an item.

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

InvoiceFilter

String

Filter invoices by any status or payment expected date.

The allowed values are Status.All, Status.Sent, Status.Draft, Status.OverDue, Status.Paid, Status.Void, Status.Unpaid, Status.PartiallyPaid, Status.Viewed, Date.PaymentExpectedDate.

InvoicesBillCredited

Read, Insert and Delete bills credited of invoices.

Table Specific Information

Select

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

InvoiceId supports the '=' comparison.
CreditNoteId supports the '=' comparison.
CreditNotesInvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InvoicesBillCredited WHERE InvoiceId = '3350895000000089001'

Insert

Insert can be executed by specifying the CustomerId and 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 InvoicesBillCredited (AmountApplied,) VALUES (328)

Update

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

UPDATE InvoicesBillCredited SET AmountApplied = '99' WHERE InvoiceId = '3285934000000136008'

Delete

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

DELETE FROM InvoicesBillCredited WHERE InvoiceId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
AmountApplied	Double	False		Amount Applied
CreditedDate	Date	False		Credited Date
CreditNoteId	Long	False	CreditNotes.Id	Credit Note Id
InvoiceId	Long	False	Invoices.Id	Invoice Id
CreditNotesInvoiceId [KEY]	String	False		CreditNotes Invoice Id
CreditNotesNumber	String	False		CreditNotes Number

InvoicesLineItems

Line items of Invoices.

Table Specific Information

Select

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

LineItemId supports the '=' comparison.
WarehouseId supports the '=' comparison.
TaxId supports the '=' comparison.
InvoiceId supports the '=' comparison.
Name supports the '=' comparison.
ItemId supports the '=' comparison.
Description supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InvoicesLineItems WHERE WarehouseId = '3350895000000089001'

SELECT * FROM InvoicesLineItems WHERE InvoiceId = '1937623621'

Insert

Insert can be executed by specifying the CustomerId and 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 InvoicesLineItems (Description) VALUES ('test')

Update

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

UPDATE InvoicesLineItems SET Description = 'test2' WHERE LineItemId = '3285934000000136008'

Delete

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

DELETE FROM InvoicesLineItems WHERE LineItemId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
LineItemId [KEY]	Long	False		The line item ID.
WarehouseId	Long	False	Warehouses.Id	Unique ID generated by the server for the ware houses.
TaxId	Long	False	Taxes.Id	ID of the tax or tax group applied to the estimate.
InvoiceId	Long	False	Invoices.Id	ID of invoice.
ItemId	Long	False	Items.Id	Unique item id.
ProjectId	String	False		Unique ID of the projet associated to an invoice.
ExpenseId	String	False		Unique ID of the expenses associated.
BcyRate	Integer	False		Base currency rate.
Discount	Integer	False		Discount applied to the invoice..
DiscountAmount	Integer	False		The discount amount on the line item
ExpenseReceiptName	String	False		Name of the expense receipt associated.
HsnOrSac	Integer	False		Add HSN/SAC code for your goods/services.
ItemOrder	Integer	False		The order of the line item_order.
ItemTotal	Integer	False		The total amount of the line items.
Description	String	False		The description of the line items.
Name	String	False		The name of the line item.
Quantity	Integer	False		The quantity of line item.
Rate	Integer	False		Rate of the line item..
TaxName	String	False		The name of the tax.
TaxPercentage	Double	False		The percentage of tax levied.
TaxType	String	False		The type of the tax.
TimeEntryIds	String	False		Unique ID of all the time entries associated to the linked project.
Unit	String	False		Unit of the line item.

ItemGroups

Read, Insert, Update adn Delete Item groups.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ItemGroups WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the GroupName and Unit 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 ItemGroups (GroupName, Unit, Brand) VALUES ('Bags', 'qty', 'Website')

Update

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

UPDATE ItemGroups SET GroupName = 'Ra', unit = 'qty' WHERE GroupId = '3285934000000163005'

Delete

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

DELETE FROM ItemGroups WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Id of the Item Group
AttributeId1	Long	True		Id of the attribute present in the Item Group
AttributeName1	String	False		Name of the attribute present in the Item Group
Brand	String	False		Brand of the Item Group
CreatedTime	Datetime	True		Time at which item group was created.
Description	String	False		Description of the Item Group
GroupName	String	False		Name of the Item Group
ImageId	Long	True		Id of the image.
ImageName	String	True		Name of the image.
ImageType	String	True		Type of the image.
IsTaxable	Boolean	True		Flag to determine if item group is taxable.
LastModifiedTime	Datetime	True		Last modified time of item group
Manufacturer	String	False		Manufacturer of item group
ProductType	String	True		Product type of item group.
Source	String	True		Source of item group.
Status	String	True		Status of item group.
TaxExemptionId	Long	True		Tax exemption id of item group.
TaxId	Long	False		Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
TaxName	String	True		Tax name of item group.
TaxPercentage	Integer	True		Tax percentage of item group.
TaxType	String	True		Tax type of item group.
Unit	String	False		Unit of item group.
Items	String	False		Aggreagate items of item group.
Attributes	String	False		Aggreagate attributes of item group.

Items

Read, Insert, Update and Delete Items.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Items WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the Name 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 Items (Name) VALUES ('testitem11')

Update

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

UPDATE Items SET Name = 'updated name' WHERE Id = '3350895000000090009'

Delete

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

DELETE FROM Items WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique ID generated by the server for the group to which the item belongs, if any. This is used as an identifier.
ActualAvailableStock	Integer	True		Stock based on Shipments and Receives minus ordered stock.
AccountName	String	True		Name of the Sales Account.
AttributeId1	Long	False		Unique ID used by the server. This is used as an identifier.
AttributeName1	String	False		Name of the attribute present in the Item Group.
AttributeOptionId1	Long	True		Unique ID generated by the server for the attribute options. This is used as an identifier.
AttributeOptionName1	String	True		Name of the attribute option.
AvailableStock	Integer	True		Stock based on Shipments and Receives.
CreatedTime	Datetime	True		Time at which item was created.
Description	String	False		Description of the Item.
Documents	String	False		Documents of the Item.
Ean	Long	True		Unique EAN value for the Item.
GroupId	Long	False		Unique ID generated by the server for the group to which the item belongs, if any. This is used as an identifier.
GroupName	String	False		Name of product group.
HsnOrSac	Integer	True		HSN Code of the item
ImageName	String	True		Image name of the Item.
ImageType	String	True		Type of the image i.e., its file format.
InventoryAccountId	Long	False		Unique ID generated by the server for the Inventory account.
IsComboProduct	Boolean	True		Flag to determine is the item part of combo.
IsLinkedWithZohocrm	Boolean	True		Flag to determine if product is linked with ZohoCRM
Name	String	False		Name of the Item.
IsTaxable	Boolean	False		Boolean to track the taxability of the item.
Isbn	Long	True		Unique ISBN value for the Item.
ItemType	String	False		Item type can be inventory, sales, purchases or sales_and_purchases. If item is associated with a group, then type should be inventory.
LastModifiedTime	Datetime	True		Time at which item was last modified.
PartNumber	String	True		Part Number of the Item.
ProductType	String	False		Type of the product. It can be goods or service
PurchaseDescription	String	True		The description for the purchase information. This will be displayed to the vendor in your purchase order.
PurchaseAccountId	Long	False		Unique ID generated by the server for the Purchase account.
PurchaseAccountName	String	False		Name of the Purchase Account.
PurchaseRate	Integer	False		Purchase price of the Item.
Rate	Integer	False		Sales price of the Item.
ReorderLevel	Integer	False		Reorder level of the item.
Sku	String	True		The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory.
Source	String	True		The source of the Item Group.
Status	String	True		Status of the Item Group.
StockOnHand	Integer	True		Stock available for a particular item.
TaxId	Long	False		Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
TaxName	String	True		Name of the tax applied on the Item Group.
TaxPercentage	Integer	True		Percentage of the Tax.
TaxType	String	True		Type of the Tax.
ItemTaxPreferences	String	False		Item Tax Preference.
Upc	Long	True		The 12 digit Unique Product Code (UPC) of the item.
Unit	String	False		Unit of measurement for the item.

Organizations

Get list of Organization

Table Specific Information

Select

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

OrganizationId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Organizations WHERE OrganizationId = '3350895000000089001'

Insert

Insert can be executed by specifying the Name, CurrencyCode, PortalName and TimeZone 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 Organizations (Name, CurrencyCode, PortalName, TimeZone) VALUES ('Test', 'USD', 'newportal', 'PST')

Update

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

UPDATE Organizations SET Name = 'test2' WHERE OrganizationId = '3285934000000136008'

Delete

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

DELETE FROM Organizations WHERE OrganizationId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
OrganizationId [KEY]	String	True		ID of the organisation generated by the server.
AccountCreatedDate	Date	True		Date of creation of the account.
Name	String	False		Name of the Organisation.
Address	String	False		Billing address of the organisation
CurrencyCode	String	False		Code of currency.
Country	String	True		Country of Organization.
IsLogoUploaded	String	True		Boolean to check if logo of the organisation if available.
UserRole	String	True		Role of the user(s).
DateFormat	String	False		Format of Date.
FieldSeparator	String	False		Separator used to classify fields.
UserStatus	String	True		Status of the user.
ContactName	String	True		Name of the contact person of the organisation.
IndustryType	String	False		Business type.
CurrencyFormat	String	True		Format of currency.
CurrencyId	String	True		Id of currency.
CurrencySymbol	String	True		Symbol of currency.
Email	String	True		email.
FiscalYearStartMonth	String	False		Starting month of teh financial year.
IsDefaultOrg	Boolean	True		IsDefaultOrg.
IsOrgActive	Boolean	True		IsOrgActive.
LanguageCode	String	False		Language for use.
PortalName	String	False		Poratal name for the organisation.
PlanName	String	True		PlanName.
PlanPeriod	String	True		PlanPeriod.
PlanType	Integer	True		PlanType.
PricePrecision	Integer	True		PricePrecision.
TaxGroupEnabled	Boolean	True		TaxGroupEnabled.
TimeZone	String	False		Time zone in with the organization is located geographically..
OrgAddress	String	False		Billing address of the organisation
RemitToAddress	String	False		Shipping address of the organisation
IndustrySize	String	True		The size of the industry. The possibe values could be The allowed values are small scale, medium scale, large scale.
ZiMigrationStatus	Integer	True		ZiMigrationStatus.

Packages

Read, Insert, Update and Delete Packages.

Table Specific Information

Select

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

Id supports the '=' comparison.
SalesorderId supports the '=' comparison.
CustomerName supports the '=,LIKE' comparison.
CustomerId supports the '=' comparison.
PackageNumber supports the '=,LIKE' comparison.
SalesorderNumber supports the '=,LIKE' comparison.
StatusFilter supports the '=' comparison.
StartDate supports the '=' comparison.
ShipmentStartDate supports the '=' comparison.
EndDate supports the '=' comparison.
ShipmentEndDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Packages WHERE Id = '3350895000000089001'

SELECT * FROM Packages WHERE SalesorderId = '7538224323'

Insert

Insert can be executed by specifying the CustomerName, SalesorderId, PackageNumber and Date 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 Packages (CustomerName, Date, LineItems) VALUES ('test22''2022-07-01', [{\"quantity\":87}])

Update

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

UPDATE Packages SET CustomerName = 'new' WHERE Id = 3249056000000197079

Delete

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

DELETE FROM Packages WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
CreatedTime	Datetime	True		Time at which the package was created.
CustomerId	Long	True		Unique ID generated by the for the customer.
CustomerName	String	False		Name of the customer.
Date	Date	False		Date on which package is prepared.
Email	String	True		Email of contact person.
IsEmailed	Boolean	True		Package is emailed to the customer or not.
LastModifiedTime	Datetime	True		Time at which the package details were last modified.
Mobile	String	True		Mobile number of the customer.
Notes	String	False		Notes for package.
Id [KEY]	Long	True		Id of package.
PackageNumber	String	False		Name of the package
Phone	String	True		Phone number of the customer.
SalesorderId	Long	False		Unique ID generated by the server for sales order.
SalesorderNumber	String	True		Name of the sales order for which package is created.
TemplateId	Long	True		Unique ID generated by the server for the template used for package.
TemplateName	String	True		Name of the template.
TemplateType	String	True		Type of template.
TotalQuantity	Integer	True		Total quantity in the package.
LineItems	String	False		Details of the items in this package

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
StatusFilter	String	Filter the packages by status. The allowed values are Status.All, Status.NotShipped, Status.Shipped, Status.Delivered.
StartDate	Date	Used for searching packages from specified date
ShipmentStartDate	Date	Used for searching packages from specified date of Shipment
EndDate	Date	Used for searching packages till specified date
ShipmentEndDate	Date	Used for searching packages till specified date of Shipment

Pricebooks

Read, Insert, Update and Delete Pricebooks.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Pricebooks WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the Name, CurrencyId, PricebookType, IsIncrease and SalesOrPurchaseType 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 Pricebooks (Name, CurrencyId, PricebookType, IsIncrease, SalesOrPurchaseType, RoundingType) VALUES ('mylist', 3350895000000075159, 'fixed_percentage', true, 'sales', 'round_to_dollar_minus_01')

Update

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

UPDATE Pricebooks SET Name = 'newname', PricebookType = 'fixed_percentage', CurrencyId = 65, IsIncrease = true, SalesOrPurchaseType = 'sales' WHERE Id = '3350895000000089001'

Delete

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

DELETE FROM Pricebooks WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique ID generated by server for the price book
CurrencyCode	String	True		Code based on currency
CurrencyId	Long	False		The currency id of the currency
DecimalPlace	Integer	True		Decimal place for pricebook.
Description	String	False		Description about the pricebook
IsDefault	Boolean	True		To check the default pricebook.
IsIncrease	Boolean	False		Mark up or Mark down to discounts.
Name	String	False		Name of the pricebook
Percentage	Integer	False		About percentage of discounts
PricebookItems	String	False		Items for the price book
PricebookType	String	False		Type of the pricebook.
RoundingType	String	False		Type of the rounding
SalesOrPurchaseType	String	False		Whether its sales or purchase type
Status	String	False		Status of the price book

PurchaseOrders

Read, Insert, Update and Delete Purchase Orders.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PurchaseOrders WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the PurchaseorderNumber, VendorId and 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 Purchaseorders (PurchaseorderNumber, VendorId, LineItems) VALUES ('PO-00006', 3249056000000085109, '[{\"item_id\":3249056000000113080,\"account_id\":3249056000000034003, \"name\": \"Laptop-white/15inch/dell\", \"description\": \"Just a sample description.\",  \"item_order\": 1, \"bcy_rate\": 122,  \"purchase_rate\": 122,  \"quantity\": 2,  \"quantity_received\": 2,  \"unit\": \"qty\", \"item_total\": 244, \"warehouse_id\": 3249056000000138013, \"salesorder_item_id\": 3249056000000113014}]')

Update

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

UPDATE Purchaseorders SET PurchaseorderNumber = '90', VendorId = '876', LineItems = [{\"item_id\":3249056000000113080,\"account_id\":3249056000000034003, \"name\": \"Laptop-white/15inch/dell\", \"description\": \"Just a sample description.\",  \"item_order\": 1, \"bcy_rate\": 122,  \"purchase_rate\": 122,  \"quantity\": 2,  \"quantity_received\": 2,  \"unit\": \"qty\", \"item_total\": 244, \"warehouse_id\": 3249056000000138013, \"salesorder_item_id\": 3249056000000113014}]' WHERE Id = '99800006'

Delete

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

DELETE FROM PurchaseOrders WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique ID generated by the server for the Purchase Order.
CreatedTime	Datetime	True		Time at which the Purchase Order was created.
CurrencyCode	String	True		Currency code.
CurrencyId	Long	True		Unique ID generated by the server for the currency.
Date	Date	False		Date of Purchase Order
DeliveryDate	Date	False		Date of delivery of the product.
IsBackorder	Boolean	False		This indicates whether it is a Back order or not.
IsDropShipment	Boolean	False		Default is FALSE, in case of drop shipment value must be TRUE.
LastModifiedTime	Datetime	True		Time at which the Purchase Order details were last modified.
PricePrecision	Integer	True		The precision level for the price decimal point in a Purchase Order.
PurchaseorderNumber	String	False		Purchase Order number.
Receives	String	True		Receives
ReferenceNumber	String	False		Reference number of purchase order.
Status	String	True		Status of Purchase Order.
Total	Integer	True		Total amount of the Purchase Order.
VendorId	Long	False		Unique ID generated by the server for the vendor.
VendorName	String	False		Name of the vendor.
LineItems	String	False		Line Items of the Purchase Order.
Bills	String	False		Bills of purchase order.
Purchasereceives	String	False		Purchase Receives of the purchase order
BillingAddressAddress	String	False		Address of billing address.
BillingAddressCity	String	False		City of billing address.
BillingAddressCountry	String	False		Country of billing address.
BillingAddressFax	String	False		Fax of billing address.
BillingAddressState	String	False		State of billing address.
BillingAddressZip	Integer	False		Zip of billing address.
DeliveryAddressAddress	String	False		Address of address.
DeliveryAddressCity	String	False		City of address.
DeliveryAddressCountry	String	False		Country of address.
DeliveryAddressFax	String	False		Fax
DeliveryAddressState	String	False		State of address.
DeliveryAddressZip	Integer	False		Zip code of address.

PurchaseReceives

Read, Insert and Delete Purchase Receives.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PurchaseReceives WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the ReceiveNumber,= and 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 PurchaseReceives (ReceiveNumber, LineItems) VALUES ('PR-00001', '[{\"line_item_id\":3285934000000138007 \"item_id\":3285934000000104036, \"name\": \"Website\",\"item_order\": 0}]' )

Delete

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

DELETE FROM PurchaseReceives WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique ID generated by the server for the Purchase Receive.
ContactPersons	Long	False		Array of contact person IDs.
CreatedTime	Datetime	True		Time at which the Purchase Receive was created.
Date	Date	False		Date of Purchase Order
LastModifiedTime	Datetime	True		Time at which the Purchase Order details were last modified.
Notes	String	False		Purchase Receive notes.
PurchaseorderId	String	False	PurchaseOrders.Id	Unique ID generated by the server for the Purchase Order.
PurchaseorderNumber	String	False		Purchase Order number.
ReceiveNumber	String	False		Number of the Purchase Receive.
VendorId	Long	False		Unique ID generated by the server for the vendor.
VendorName	String	False		Name of the vendor.
LineItems	String	False		Number of line items for purchase receive.
ShippingAddressAddress	String	False		Address of billing address.
ShippingAddressCity	String	False		City of billing address.
ShippingAddressCountry	String	False		Country of billing address.
ShippingAddressFax	String	False		Fax of billing address.
ShippingAddressState	String	False		State of billing address.
ShippingAddressZip	Integer	False		Zip of billing address.
BillingAddressaddress	String	False		Address of billing address.
BillingAddresscity	String	False		City of billing address.
BillingAddresscountry	String	False		Country of billing address.
BillingAddressfax	String	False		Fax of billing address.
BillingAddressstate	String	False		State of billing address.
BillingAddresszip	Integer	False		Zip of billing address.

RetainerInvoiceListPayments

Get payments of Retainer Invoice.

Table Specific Information

Select

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

RetainerInvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM RetainerInvoiceListPayments WHERE RetainerInvoiceId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Amount	Integer	False		Amount
AttachmentName	String	False		Attachment Name
BankCharges	Integer	False		Bank Charges
CanSendInMail	Boolean	False		Can Send In Mail
CurrencyCode	String	False		Currency Code
CurrencyId	Long	False		Currency Id
CustomFields	String	False		Custom Fields
CustomerId	Long	False		Customer Id
CustomerName	String	False		Customer Name
Date	Date	False		Date
Description	String	False		Description
DiscountAmount	Integer	False		DiscountAmount
Documents	String	False		Documents
ExchangeRate	Integer	False		ExchangeRate
HtmlString	String	False		Html String
Invoices	String	False		Invoices
IsClientReviewSettingsEnabled	Boolean	False		Is Client Review Settings Enabled
IsPaymentDrawnDetailsRequired	Boolean	False		Is Payment Drawn Details Required
LastFourDigits	String	False		Last Four Digits
OnlineTransactionId	String	False		Online Transaction Id
Orientation	String	False		Orientation
PageHeight	String	False		Page Height
PageWidth	String	False		Page Width
PaymentId [KEY]	String	False		Payment Id
PaymentMode	String	False		Payment Mode
PaymentRefunds	String	False		Payment Refunds
ReferenceNumber	String	False		Reference Number
RetainerInvoiceRetainerInvoiceBalance	Integer	False		Retainer Invoice Balance
RetainerInvoiceRetainerInvoiceDate	Date	False		Retainer Invoice Date
RetainerInvoiceRetainerInvoiceId	Long	False		Retainer Invoice Id
RetainerInvoiceRetainerInvoiceNumber	String	False		Retainer Invoice Number
RetainerInvoiceRetainerInvoiceTotal	Integer	False		Retainer Invoice Total
RetainerInvoiceId	Long	False	RetainerInvoices.Id	Retainer Invoice Id
TaxAmountWithheld	Integer	False		Tax Amount Withheld
TemplateId	Long	False		Template Id
TemplateName	String	False		Template Name
TemplateType	String	False		Template Type
UnusedAmount	Integer	False		Unused Amount

RetainerInvoices

Read, Insert, Update and Delete Retainer Invoice.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM RetainerInvoices WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the CustomerId and 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 RetainerInvoices (CustomerId, LineItems) VALUES ('3285934000000079043', '[{\"description\":\"500GB, USB 2.0 interface 1400 rpm, protective hard case.\",\"item_order\":5,\"rate\":120}]')

Update

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

UPDATE RetainerInvoices SET CustomerId = 3285934000000079043, LineItems = '[{\"description\":\"Testupdate7777777.\",\"item_order\":2,\"rate\":120}]' WHERE Id = '3285934000000136008'

Delete

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

DELETE FROM RetainerInvoices WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		ID of the retainerinvoice
Balance	Double	False		The unpaid amount
ClientViewedTime	Boolean	False		client viewed time for retainer invoice in client portal.
CreatedTime	Datetime	False		The time of creation of the retainer invoice
CurrencyCode	String	False		The currency code in which the retainer invoice is created.
CurrencyId	Long	False		The currency id of the currency
CustomerId	Long	False		ID of the customer the retainer invoice has to be created.
CustomerName	String	False		The name of the customer.
Date	Date	False		The date of creation of the retainer invoice.
Notes	String	False		The notes added below expressing gratitude or for conveying some information.
Terms	String	False		The terms added below expressing gratitude or for conveying some information.
TemplateId	String	False		ID of the pdf template associated with the retainer invoice.
TemplateName	String	False		Name of template.
TemplateType	String	False		Type of template.
PlaceOfSupply	String	False		Place where the goods/services are supplied to.
HasAttachment	Boolean	False		Boolean to check whether it has attachment or not
IsEmailed	Boolean	False		Boolean check to if the email was sent
IsViewedByClient	Boolean	False		Boolean is retainer invoice viewed by client in client portal.
LastModifiedTime	Datetime	False		The time of last modification of the retainer invoice
LastPaymentDate	String	False		The last payment date of the retainer invoice
ProjectOrEstimateName	String	False		Project or estiminated name
ReferenceNumber	String	False		The reference number of the retainer invoice.
RetainerinvoiceNumber	String	False		number of the retainer invoice.
Status	String	False		retainer invoice status.
Total	Double	False		The total amount to be paid
IgnoreAutoNumberGeneration	Boolean	False		Ignore auto invoice number generation for this invoice.
LineItems	String	False		Line items of a retainer invoice.
PaymentOptionsPaymentGateways	String	False		Payment options for the retainer invoice, online payment gateways and bank accounts. Will be displayed in the pdf.
CustomFields	String	False		Custom Fields of a retainer invoice.

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

StatusFilter

String

Filter retainer invoices by any status or payment expected date.

The allowed values are Status.All, Status.Sent, Status.Draft, Status.OverDue, Status.Paid, Status.Void, Status.Unpaid, Status.PartiallyPaid, Status.Viewed, Date.PaymentExpectedDate.

RetainerInvoicesComments

List comments of Retainer Invoice.

Table Specific Information

Select

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

Id supports the '=' comparison.
RetainerInvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM RetainerInvoicesComments WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the CustomerId and 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 RetainerInvoicesComments (Description) VALUES ('description')

Update

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

UPDATE RetainerInvoicesComments SET Description = 'desc' WHERE Id = 1234

Delete

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

DELETE FROM RetainerInvoicesComments WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Id of the comment.
CommentType	String	False		Comment Type.
CommentedBy	String	False		Commented By.
CommentedById	Long	True		Commented By Id.
Date	Date	False		Date.
DateDescription	String	False		Date Description.
Description	String	False		Description.
OperationType	String	False		Operation Type.
RetainerInvoiceId [KEY]	Long	False	RetainerInvoices.Id	RetainerInvoice Id.
Time	Datetime	False		Time.
TransactionId	String	True		Transaction Id.
TransactionType	String	False		Transaction Type.

SalesOrders

Read, Insert,Update and Delete Sales Orders.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM SalesOrders WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the CustomerId, SalesorderNumber and 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 Salesorders (CustomerId, SalesorderNumber, LineItems) VALUES (3285934000000085043, 'SO-0001', '[{\"name\": \"OnePlus 8 pro\",\"description\":\"just a simple des\"}]')

Update

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

UPDATE SalesOrders SET SalesorderNumber = 11, CustomerId = 111 WHERE Id = '3285934000000136008'

Delete

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

DELETE FROM SalesOrders WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique ID generated by the server for the Sales Order.
BcyTotal	Integer	True		Base Total.
CreatedTime	Datetime	True		Created Time.
CurrencyCode	String	True		Currency code.
CustomerId	Long	False	Contacts.Id	Unique ID generated for the customer.
PriceBookId	Long	False	Pricebooks.Id	Unique ID generated by the server for the Pricebook. This is used as an identifier.
SalespersonId	Long	False		Unique ID generated by the server for the sales person. This is used as an identifier.
TemplateId	Long	False		Unique ID generated by the server for the Template. This is used as an identifier.
CustomerName	String	True		Name of the customer.
Date	Date	False		The date for the Sales Order.
IsBackorder	Boolean	True		is backorder.
IsDropShipment	Boolean	True		is drop shipment.
IsDiscountBeforeTax	Boolean	False		Used to check whether the discount is applied before tax or after tax.
IsEmailed	Boolean	True		is emailed.
IsInclusiveTax	Boolean	False		Used to specify whether the line item rates are inclusive or exclusive of tax.
LastModifiedTime	Datetime	True		Time at which the sales order details were last modified.
LineItems	String	False		Each line item contains item_id,name,desc,rate,quantity,unit,tax_id,tax_name,tax_type,tax_percentage,item_total.
CustomFields	String	False		Custom Fields.
Notes	String	False		Notes for the Sales Order.
ExchangeRate	Double	False		Exchange rate of the currency, with respect to the base currency.
Adjustment	Double	False		Adjustment on the Sales Orde total.
AdjustmentDescription	String	False		Description for the adjustment.
Terms	String	False		Terms for the Sales Order.
Discount	String	False		The percentage of Discount applied.
DiscountType	String	False		Type of discount. The allowed values are entity_level, item_level.
ShippingCharge	Double	False		Shipping charges that can be applied to the Sales Order.
DeliveryMethod	String	False		Delivery method of the shipment.
Quantity	Integer	True		Quantity of the line item.
QuantityInvoiced	Integer	True		Quantity Invoiced of the line item.
QuantityPacked	Integer	True		Quantity Packed of the line item.
QuAntityShipped	Integer	True		Quantity shipped of the line item.
ReferenceNumber	String	False		Reference number of the Sales Order.
SalesChannel	String	True		sales channel.
SalesorderNumber	String	False		The Sales Order number.
ShipmentDate	Date	False		Shipment date of the Sales Order.
ShipmentDays	String	True		Shipment days.
Status	String	True		The status for the Sales Order.
Total	Integer	True		Total amount of the Sales Order.
ShippingAddressId	Long	False		Customer shipping address.
BillingAddressId	Long	False		Customer billing address.
Taxes	String	True		Number of taxes applied on sales order.
Documents	String	True		Sales order can have files attached to them.
BillingAddressAddress	String	False		Name of the street of the customer shipping address.
BillingAddressCity	String	False		Name of the city of the customer shipping address.
BillingAddressCountry	String	False		Name of the country of the customer shipping address.
BillingAddressFax	String	False		Fax number of the customer shipping address.
BillingAddressState	String	False		Name of the state of the customer shipping address.
BillingAddressZip	Integer	False		Zip code of the customer shipping address.
ContactPersonsContactPersonId	Long	False	ContactPersons.Id	Unique ID generated by the server for the contact person.
ShippingAddressAddress	String	False		Name of the street of the customer shipping address.
ShippingAddressCity	String	False		Name of the city of the customer shipping address.
ShippingAddressCountry	String	False		Name of the country of the customer shipping address.
ShippingAddressFax	String	False		Fax number of the customer shipping address.
ShippingAddressState	String	False		Name of the state of the customer shipping address.
ShippingAddressZip	Integer	False		Zip code of the customer shipping address.

SalesReturns

Read, Insert, Update and Delete Sales Returns.

Table Specific Information

Select

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

Id supports the '=' comparison.
SalesorderId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM SalesReturns WHERE Id = '3350895000000089001'

SELECT * FROM SalesReturns WHERE SalesorderId = '3350895000000089001'

Insert

Insert can be executed by specifying the Name,email and UserRole 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 SalesReturns (LineItems) VALUES ('[{\"item_id\":\"3285934000000104036\",\"salesorder_item_id\":\"3285934000000113099\", \"quantity\":1,\"non_receive_quantity\":\"0\",\"warehouse_id\":\"3285934000000113095\"}]')

Update

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

UPDATE SalesReturns SET Reason = 'unspecified' AND LineItems = [{\"item_id\":\"3285934000000104036\",\"salesorder_item_id\":\"3285934000000113099\", \"quantity\":1,\"non_receive_quantity\":\"0\",\"warehouse_id\":\"3285934000000113095\"}] WHERE Id = '3285934000000136008'

Delete

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

DELETE FROM SalesReturns WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique ID generated by the server for the Sales Return.
CustomerId	Long	True		Customer ID of the customer involved in the payment.
CustomerName	String	True		Name of the customer to whom the invoice is raised.
Date	Date	False		Date on which payment is made.
Quantity	Integer	True		The quantity that can be received for the line item.
ReceiveStatus	String	True		Status whether received or not
RefundStatus	String	True		Status of refund
Reason	String	False		The reason for raising a Sales Return.
RefundedAmount	Integer	True		Amount refunded
SalesorderId	Long	True		Unique ID generated by the server for the Sales Order from which the Sales Return is created.
SalesorderNumber	String	True		Unique sales order number for each sales order.
SalesreturnNumber	String	False		Return Merchandise Authorisation (RMA) number of the Sales Return.
SalesreturnStatus	String	True		Return Merchandise Authorisation (RMA) status of the Sales Return.
LineItems	String	False		The underlying items in a Sales Return
Comments	String	False		History related to the Sales Return.
SalesReturnReceives	String	False		Sales receive of Sales Return.
CreditNotes	String	False		Credit notes of Sales Return.

ShipmentOrders

Read, Insert, Update and Delete Shipment Orders.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ShipmentOrders WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the ContactPersons, ShipmentNumber, DeliveryMethod and TrackingNumber 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 ShipmentOrders (ContactPersons, ShipmentNumber, DeliveryMethod, TrackingNumber) VALUES (3285934000000104004, 'SH-00009', 'FedEx', 'TRK214124124')

Update

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

UPDATE ShipmentOrders SET Name = 'test2' WHERE Id = '3285934000000136008'

Delete

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

DELETE FROM ShipmentOrders WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Unique ID generated by the server for the shipment.
Carrier	String	True		Carrier used for shipment
ContactPersons	Long	False		contact persons.
CreatedTime	Datetime	True		Time at which the Shipment Details was created.
CurrencyCode	String	True		Currency code.
CurrencyId	Long	True		Unique ID generated by the server for the currency.
CurrencySymbol	String	True		The symbol for the selected currency.
CustomerId	Long	True		Unique ID generated by the for the customer.
CustomerName	String	False		Name of the customer
Date	String	False		Date on which package is prepared.
DeliveryDays	Integer	True		Number of days taken by the courier for delivering in package.
DeliveryGuarantee	Boolean	True		guarantee assured by the courier.
DeliveryMethod	String	False		Delivery method of the shipment.
DeliveryMethodId	Long	False		Delivery Id of the shipment.
DetailedStatus	String	False		Detailed shipment details received from the courier.
Discount	String	True		The percentage of Discount applied.
DiscountAmount	Integer	True		Discount to be applied on the Sales Order.
DiscountType	String	True		Type of discount.
EstimateId	Long	True		Estimate Id.
ExchangeRate	Integer	False		Exchange rate of the currency, with respect to the base currency.
IsDiscountBeforeTax	Boolean	True		Used to check whether the discount is applied before tax or after tax.
IsEmailed	Boolean	True		Checks whether the Package has been emailed to the customer or not.
LastModifiedTime	Datetime	True		Time at which the Shipment Details details were last modified.
LineItems	String	True		List of items in a package.
Notes	String	False		notes.
PricePrecision	Integer	True		The precision level for the price decimal point in a Shipment.
ReferenceNumber	String	False		Tracking number for the Shipment.
SalesorderId	Long	False		Unique ID generated by the server for the Sales Order.
SalesorderNumber	String	True		The Sales Order number.
Service	String	True		Type of service selected for shipment.
ShipmentNumber	String	False		Shipment number of the package.
ShippingCharge	Integer	False		Shipping charges that are applied to the Shipment.
Status	String	True		Status of the Shipment Order.
StatusMessage	String	True		Status message of the shipment.
SubTotal	Integer	True		Sub total of the Sales Order.
TaxTotal	Integer	True		Tax total of the Sales Order.
Taxes	String	True		Number of taxes applied on sales order..
TemplateId	Long	False		Unique ID generated by the server for the Template.
TemplateName	String	True		Name of the template used for the Shipment.
TemplateType	String	True		Type of the template.
Total	Integer	True		Total amount of the Sales Order.
TrackingNumber	String	False		Tracking number of shipment.
BillingAddressAddress	String	False		Name of the street of the customer billing address.
BillingAddressCity	String	False		Name of the city of the customer billing address.
BillingAddressCountry	String	False		Name of the country of the customer billing address.
BillingAddressFax	String	False		Fax number of the customer billing address.
BillingAddressState	String	False		Name of the state of the customer billing address.
BillingAddressZip	Integer	False		Zip code of the customer billing address.
ShippingAddressAddress	String	False		Name of the street of the customer billing address.
ShippingAddressCity	String	False		Name of the city of the customer billing address
ShippingAddressState	String	False		Name of the state of the customer billing address.
ShippingAddressZip	String	False		Zip code of the customer billing address.
ShippingAddressCountry	String	False		Name of the country of the customer billing address.
ShippingAddressFax	String	False		Fax number of the customer billing address.

TaxAuthorities

Read, Create, Update and Delete Tax Authorities.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM TaxAuthorities WHERE Id = 3350895000000089001

Insert

Insert can be executed by specifying the TaxAuthorityName 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 TaxAuthorities (TaxAuthorityName) VALUES ('newtype')

Update

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

UPDATE TaxAuthorities SET Description = 'desc', TaxAuthorityName = 'newtype' WHERE Id = '3297210000000091004'

Delete

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

DELETE FROM TaxAuthorities WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Id of the TAX authority
Description	String	False		Description
RegistrationNumber	String	False		Registration Number of the Tax Authority
RegistrationNumberLabel	String	False		Registration Number Label of the Tax Authority
TaxAuthorityName	String	False		Name of the TAX authority

Taxes

Read, Insert, Update and Delete taxes.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Taxes WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the TaxName and TaxPercentage 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 Taxes (TaxName, TaxPercentage) VALUES ('Cost Order', 29)

Update

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

UPDATE Taxes SET TaxPercentage = '20' WHERE Id = '3297210000000091004'

Delete

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

DELETE FROM Taxes WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Tax id.
IsDefaultTax	Boolean	True		Is Default Tax.
IsEditable	Boolean	False		To check if tax/tax rate is editable.
IsValueAdded	Boolean	False		Check if Tax is Value Added.
TaxAuthorityId	String	False		ID of the tax authority.
TaxAuthorityName	String	False		Name of the tax authority.
TaxName	String	False		Tax name.
TaxPercentage	Double	False		Number of percentage taxable.
TaxSpecificType	String	False		Type of Tax For Indian Edition.
TaxType	String	False		Type to determine whether it is a simple or compound tax.
CountryCode	String	False		Country code.
PurchaseTaxExpenseAccountId	String	False		Purchase Tax Expense Account Id
UpdateDraftInvoice	String	False		Check if Draft Invoices should be updated
UpdateDraftSO	String	False		Check if Draft Sales Orders should be updated

TaxExemptions

Read, Insert, Update and Delete Tax Exemption

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM TaxExemption WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the TaxName and TaxPercentage 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 TaxExemption (TaxExemptionCode, Type) VALUES ('111', 'newtype')

Update

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

UPDATE TaxExemption SET TaxExemptionCode = '20', Type = 'newtype' WHERE Id = '3297210000000091004'

Delete

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

DELETE FROM TaxExemption WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Id of the Tax Exemption
Description	String	False		Description.
TaxExemptionCode	String	False		Code of the Tax Exemption
Type	String	False		Type of the Tax Exemption

TaxGroups

Read, Insert, Update and Delete Tax Groups.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM TaxGroups WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the TaxName and TaxPercentage 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 TaxGroups (TaxGroupName, Taxes) VALUES ('Cost Order', '8937927392')

Update

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

UPDATE TaxGroups SET TaxPercentage = '20' WHERE Id = '3297210000000091004'

Delete

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

DELETE FROM TaxGroups WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [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.

TransferOrders

Read, Insert and Delete Transfer Orders.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM TransferOrders WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the TransferOrderNumber, Date, FromWarehouseId, ToWarehouseId and 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 TransferOrders (TransferOrderNumber, Date, FromWarehouseId, ToWarehouseId, LineItems) VALUES ('TO-00001', '2018-03-23', '4815000000035003', '4815000000035003', 'TransferOrderLINEITEMS#TEMP')

Delete

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

DELETE FROM TransferOrders WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique ID generated by the server for the Transfer Order
Date	Date	False		The date for the Transfer Order.
TransferOrderNumber	String	False		The Transfer Order number.
FromWarehouseId	Long	False		Unique ID generated by the server for the Warehouse.This is used a unique identifier.This is a source warehouse.
IsIntransitOrder	Boolean	False		It states whether the transfer order is in transit or transferred.The default value is false.
ToWarehouseId	Long	False		Unique ID generated by the server for the Warehouse.This is used a unique identifier.This is a destination warehouse.
TransferOrderNumber	String	False		The Transfer Order number. This is unique for each transfer order.
LineItems	String	False		A transfer can contain multiple line items.

Users

Read, Insert, Update and Delete Users.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Users WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the Name and 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 ('Test', '[email protected]', 'admin')

Update

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

UPDATE Users SET Name = 'test2', Email = '[email protected]' WHERE Id = '3285934000000136008'

Delete

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

DELETE FROM Users WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Id of the user
Email	String	False		email address of the user
IsCurrentUser	Boolean	True		check if user is activated or not
Name	String	False		name of the user
PhotoUrl	String	True		PhotoUrl
RoleId	String	True		RoleId
Status	String	True		Status
UserRole	String	False		UserRole
UserType	String	True		Usertype

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
UserFilter	String	Criteria used to filter

VendorCreditRefund

Read, Insert and Update Vendor Credit Refunds.

Table Specific Information

Select

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

VendorCreditId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM VendorCreditRefund WHERE VendorCreditId = '3350895000000089001'

SELECT * FROM VendorCreditRefund WHERE VendorCreditNumber = '983872973'

Insert

Insert can be executed by specifying the Amount, Date 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 (Amount, Date) VALUES (66, 12-12-20)

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', Date = '12-12-19', Amount = 90 WHERE AccountId = '3285934000000136008'

Delete

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

DELETE FROM VendorCreditRefund WHERE Id = '3350895000000089001'

Columns


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

VendorCredits

Read, Insert, Update and Delete Vendor Credits.

Table Specific Information

Select

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

Id supports the '=' comparison.
VendorId supports the '=' comparison.
PriceBookId supports the '=' comparison.
Balance supports the '=' comparison.
CreatedTime supports the '=' comparison.
Date supports the '>,<,>=,<=,=' comparisons.
LastModifiedTime supports the '>,<,>=,<=,=' comparisons.
ReferenceNumber supports the '=,LIKE' comparisons.
Status supports the '=' comparison.
Total supports the '=,>,<,>=,<=' comparisons.
VendorCreditNumber supports the '=,LIKE' comparisons.
Notes supports the '=,LIKE' comparisons.
VendorName supports the '=' comparison.
CustomerName supports the '=,LIKE' comparisons.
ItemName supports the '=,LIKE' comparisons.
ItemDescription supports the '=,LIKE' comparisons.
ItemId supports the '=' comparison.
LineItemId supports the '=' comparison.
VendorCreditsFilter supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM VendorCredits WHERE Id = '3350895000000089001'

SELECT * FROM VendorCredits WHERE VendorCreditNumber = '983872973'

SELECT * FROM VendorCredits WHERE Date = '22-09-12'

SELECT * FROM VendorCredits WHERE Status = 'closed'

SELECT * FROM VendorCredits WHERE Total = '244'

SELECT * FROM VendorCredits WHERE ReferenceNumber = '2287678362612'

SELECT * FROM VendorCredits WHERE CustomerName = 'Ms. Name'

SELECT * FROM VendorCredits WHERE ItemName = 'item name'

SELECT * FROM VendorCredits WHERE ItemDescription = 'Item description'

SELECT * FROM VendorCredits WHERE Notes = 'my notes'

SELECT * FROM VendorCredits WHERE LastModifiedTime = '2014-08-28T22:53:31-0700'

SELECT * FROM VendorCredits WHERE LineItemId = '3359001'

Insert

Insert can be executed by specifying the VendorId 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 VendorCredits (VendorId) VALUES (324905600000085109)

Update

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

UPDATE VendorCredits SET Notes = 'test2' WHERE Id = '3285934000000136008'

Delete

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

DELETE FROM VendorCredits WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		ID of the vendor the vendor credit associated with the Vendor Credit
VendorId	Long	False		ID of the Vendor Involved in the Vendor Credit
PriceBookId	Long	False		ID of the Currency Involved in the Vendor Credit
Balance	Integer	True		Balance in the Vendor Credit
CreatedTime	Datetime	True		Time of Vendor Credit Creation
CurrencyCode	String	True		Code of the Currency Involved in the Vendor Credit
CurrencyId	String	True		ID of the Currency Involved in the Vendor Credit
SourceofSupply	String	True		Place from where the goods/services are supplied.
DestinationofSupply	String	True		Place where the goods/services are supplied to.
PlaceofSupply	String	True		The place of supply is where a transaction is considered to have occurred for VAT purposes.
GstNo	String	True		15 digit GST identification number of the customer/vendor..
GstTreatment	String	True		Choose whether the contact is GST registered/unregistered/consumer/overseas.
Date	Date	False		The date the vendor credit is created. [yyyy-mm-dd]
ExchangeRate	Integer	False		Exchange rate of the currency.
HasAttachment	Boolean	True		Boolean to check whether it has attachment or not
IsReverseChargeApplied	Boolean	True		Applicable for transactions where you pay reverse charge
IsUpdateCustomer	Boolean	False		Check if customer should be updated
IsInclusiveTax	Boolean	False		Check if tax is inclusive.
LastModifiedTime	Datetime	True		Search vendor credits by vendor credit last modfified time
ReferenceNumber	String	False		Search vendor credits by vendor credit reference number.
Status	String	True		Search vendor credits by vendor credit status. The allowed values are open, closed, void.
SourceofSupply	String	True		Place from where the goods/services are supplied.
Total	Integer	True		Search vendor credits by total amount.
Tags	String	False		tags
Notes	String	False		notes
TaxTreatment	String	True		VAT treatment for the vendor credit.
VendorCreditNumber	String	False		Number of the Vendor Credit
VendorName	String	True		Name of the Vendor Associated with the Vendor Credit
LineItems	String	False		Line items of a vendor credit.
VendorCreditRefunds	String	True		Vendor Credit Refunds.
Documents	String	False		Documents.
Comments	String	True		Comments.
BillsCredited	String	True		Bills Credited.
CustomerName	String	True		Search vendor credits by vendor name.
ItemName	String	True		Name of an item.
ItemDescription	String	True		Description of an item.
ItemId	Long	False	Items.ItemId	Id of an item.
LineItemId	Long	True		Id of lineitem.

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

VendorCreditsFilter

String

Filter invoices by any status or payment expected date.

The allowed values are Status.All, Status.Draft, Status.Void, Status.Open, Status.Closed.

VendorCreditsBillCredited

Read, Insert and Delete Bills Credited of Vendor Credits.

Table Specific Information

Select

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

BillId supports the '=' comparison.
VendorCreditId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM VendorCreditsBillCredited WHERE BillId = '3350895000000089001'

SELECT * FROM VendorCreditsBillCredited WHERE VendorCreditId = '983872973'

Insert

Insert can be executed by specifying the VendorId 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 VendorCreditsBillCredited (BillNumber) VALUES (324905600000085109)

Delete

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

DELETE FROM VendorCreditsBillCredited WHERE BillId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
VendorCreditId [KEY]	String	True	VendorCredits.Id	Vendor Credit Id
BillId	String	False		Bill Id
BillNumber	String	False		Bill Number
Date	Date	False		Date
VendorCreditBillId [KEY]	String	False		Vendor Credit Bill Id

Warehouses

Read, Insert, Update and Delete Warehouses.

Table Specific Information

Select

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

WarehouseId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Warehouses WHERE WarehouseId = '3350895000000089001'

Insert

Insert can be executed by specifying the WarehouseName and Country 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 Warehouses (warehousename, country) VALUES ('TestWarehouse', 'India')

Update

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

UPDATE Warehouses SET Country = 'Australia' WHERE WarehouseId = '3350895000000085088'

Delete

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

DELETE FROM Warehouses WHERE WarehouseId = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
WarehouseId [KEY]	Long	True		Id of the warehouse
Address	String	False		Street Name of the warehouse.
City	String	False		City Name of the warehouse.
Country	String	False		Country Name of the warehouse.
Email	String	False		Email id for the warehouse
IsPrimary	Boolean	True		Boolean to check if it is primary
Phone	String	False		Mobile number for warehouse
State	String	False		State Name of the warehouse.
Status	String	True		Status check
WarehouseName	String	False		Name of the warehouse
Zip	Integer	False		Zipcode of the warehouse.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Zoho Inventory Connector for CData Sync Views


Name	Description
BillLineItems	Get Line items of Bills.
BillPayments	Get payments of the bills.
BillTaxes	Taxes of the bills.
BillVendorCredits	Vendor credits of the bills.
CompositeItemsBundlesLineItems	Get the line items of the bundles.
CompositeItemsTaxPreferences	Tax refereces of composite items..
ContactContactPersons	Get contact persons of the contacts.
ContactListComments	List recent activities of a contact
ContactsGetMailContent	List mail content of a contact.
ContactsGetMailContentFromEmails	List from emails of Mail Content for Contacts.
ContactsGetMailContentToContacts	List to contacts of Mail Content for Contacts
CreditNoteGetMailContent	List mail contents of Credit Notes.
CreditNoteGetMailContentToContacts	List to contacts of Mail Content for Credit Notes.
CreditNoteGetMailHistory	List email history of credit notes.
CreditNoteListTemplates	List of templates for credit notes.
CreditNotesGetMailContentEmailTemplates	List Email Templates of Mail Content for Credit Notes.
CreditNotesGetMailContentFromEmails	List from emails of Mail Content for Credit Notes.
CreditNotesInvoices	List invoices of Credit Notes.
CreditNotesLineItems	List line items of Credit Notes.
CreditNotesTaxes	List taxes of credit notes.
CustomerPaymentsInvoices	Get Invoices of Customer Payments.
InventoryAdjustmentsLineItems	Line items of the inventory adjustments.
InvoiceGetMailContent	Get mail contents of invoices.
InvoiceListPayments	List Payments of Invoices.
InvoiceListTemplates	List templates of Invoices.
InvoicesContactPersons	List Contact Persons of the invoices.
InvoicesGetMailContentEmailTemplates	List Email Templates of Mail Content for Invoices.
InvoicesGetMailContentFromEmails	List from emails of Mail Content for Invoices.
InvoicesGetMailContentToContacts	List to contacts of Mail Content for Invoices.
InvoicesGetPaymentReminderMailContent	Get payment reminder for Invoices.
InvoicesTaxes	List taxes of invoices.
ItemGroupsAttributeOptions	List Item Groups Attribute Options.
ItemGroupsAttributes	List attributes of item groups.
ItemGroupsItems	List items of Item Groups.
ItemTaxPreferences	List tax preference of the items.
OrganizationAddress	List addresses of Organizations.
PackageLineItems	List line items of the package.
PackagesContactPersons	List Contact persons of the Package.
PriceBookItems	List items of pricebooks.
PurchaseOrderBills	List Bills of purchase orders.
PurchaseOrderDocuments	List Documents of Purchase Orders.
PurchaseOrderLineItems	List line items of Purchase Orders.
PurchaseOrderPurchaseReceives	List Purchase receives of purchase items.
PurchaseOrderTaxes	List taxes of purchaseorders
PurchaseReceiveLineItems	List line tiems of purchase receives.
RetainerInvoiceGetMailContent	Get mail content of retainer invoice.
RetainerInvoiceGetMailContentFromEmails	List from emails of Mail Content for Retainer Invoices.
RetainerInvoiceGetMailContentToContacts	List to contacts of Mail Content for Retainer Invoices.
RetainerInvoiceListTemplates	List templates of retainer invoices.
RetainerInvoicesLineItems	List line items of retainer invoice.
RetainerInvoicesPaymentOptionsPaymentGateways	Payment Gateways of Retainer Invoices
RetainerInvoicesTaxes	List taxes of retainer invoices.
SalesOrderDocuments	List documents of sales orders.
SalesOrderLineItems	List line items of sales orders.
SalesOrderTaxes	List taxes of Sales Orders.
SalesReturnReceiveLineItems	List line items of sales receives of sales returns.
SalesReturnsComments	List comments of Sales Returns.
SalesReturnsCreditNotes	List Credit Notes of Sales Returns.
SalesReturnsLineItems	List line items of Sales Retruns.
SalesReturnsSalesReceives	List sales receives of sales returns.
ShipmentOrdersLineItems	List line items of shipment orders..
ShipmentOrdersTaxes	List taxes of shipment orders.
TransferOrderLineItems	List line items of transfer orders.
VendorCreditsComments	List Comments of VendorCredits.
VendorCreditsDocuments	List Documents related to vendor credits.
VendorCreditsLineItems	List line items of Vendor Credits.
VendorCreditsLineItemsTags	Tags of the List line items of Vendor Credits.

BillLineItems

Get Line items of Bills.

Table Specific Information

Select

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

BillId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM BillLineItems WHERE BillId = '3350895000000089001'

Columns


Name	Type	References	Description
BillId	Long	Bills.Id	Unique ID generated by the server.
Description	String		Desciption of line item.
ItemId	Long	Items.Id	Item Id of line item.
ItemOrder	Integer		Order of the line item, starting from 0
LineItemId [KEY]	Long		Unique ID generated by the server for each line item..
Name	String		Name of line item.
Quantity	Integer		Quantity of line item.
Unit	String		Unit of line item.

BillPayments

Get payments of the bills.

Table Specific Information

Select

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

BillId supports the '=' comparison.
BillPaymentId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM BillPayments WHERE BillId = '3350895000000089001'

SELECT * FROM BillPayments WHERE BillPaymentId = '3350895000000089001'

Columns


Name	Type	References	Description
Amount	Integer		Amount paid for the payment.
BillId	Long	Bills.Id	Unique ID generated by the server.
BillPaymentId [KEY]	Long		Bill payment ID.
Date	Date		Date of the Bill.
Description	String		Description for the line item.
ExchangeRate	Integer		Exchange rate of the currency, with respect to the base currency.
IsSingleBillPayment	Boolean		Checks whether the payment is for single bills or multiple bills.
PaidThroughAccountId	Long		ID for the account through which the payment is made.
PaidThroughAccountName	String		Name of the account.
PaymentId	Long		Unique ID generated by the server.
PaymentMode	String		Mode of payment for the Bill.
PaymentNumber	Integer		Number of the payment.
ReferenceNumber	String		Reference number for the Bill.

BillTaxes

Taxes of the bills.

Table Specific Information

Select

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

BillId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM BillTaxes WHERE BillId = '3350895000000089001'

Columns


Name	Type	References	Description
BillId	Long	Bills.Id	Unique ID generated by the server.
TaxAmount	Integer		Amount of the tax.
TaxName	String		Name of the tax.

BillVendorCredits

Vendor credits of the bills.

Table Specific Information

Select

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

BillId supports the '=' comparison.
VendorCreditBillId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM BillVendorCredits WHERE BillId = '3350895000000089001'

SELECT * FROM BillVendorCredits WHERE VendorCreditBillId = '3350895000000089001'

Columns


Name	Type	References	Description
BillId	Long	Bills.Id	Unique ID generated by the server for vendor credits.
Amount	Integer		Amount of Vendor Credit.
Date	Date		Date of Vendor Credit.
VendorCreditBillId [KEY]	Long		Unique ID generated by server for vendor credit bills
VendorCreditId	Long		Unique ID generated by server for vendor credits
VendorCreditNumber	Integer		VendorCreditNumber of Vendor Credit.

CompositeItemsBundlesLineItems

Get the line items of the bundles.

Table Specific Information

Select

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

BundleId supports the '=' comparison.
ItemId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CompositeItemsBundlesLineItems WHERE BundleId = '3350895000000089001'

SELECT * FROM CompositeItemsBundlesLineItems WHERE ItemId = '3350895000000089001'

Columns


Name	Type	References	Description
BundleId	Long	CompositeItemsBundles.Id	Unique ID generated by the server for the bundle
AccountId	Long		Unique ID generated by the server for the type of sale of this item
AccountName	String		Type of sale under which the composite item is sold
Description	String		Sample Description
ItemId	Long		Unique ID generated by the server for the Item
LineItemId [KEY]	Long		Unique ID generated by the server for mapping the associated item with composite item
Name	String		Name of the composite item
QuantityConsumed	Integer		Quantity of item to be bundled.
Rate	Integer		Selling price of the item
Unit	String		Unit of Item
WarehouseId	Long		Unique ID generated by the server for the Warehouse.
WarehouseName	String		Name of the Warehouse.

CompositeItemsTaxPreferences

Tax refereces of composite items..

Table Specific Information

Select

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

CompositeItemId supports the '=' comparison.
TaxId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CompositeItemsTaxPreferences WHERE CompositeItemId = '3350895000000089001'

SELECT * FROM CompositeItemsTaxPreferences WHERE TaxId = '205'

Columns


Name	Type	References	Description
CompositeItemId	Long	CompositeItems.Id	Unique ID generated for the composite item by the server.
TaxId [KEY]	Long	Taxes.Id	Unique ID generated for the taxes by the server
TaxSpecification	String		Tax specification of the composite item.

ContactContactPersons

Get contact persons of the contacts.

Table Specific Information

Select

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

ContactId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ContactContactPersons WHERE ContactId = '3350895000000089001'

Columns


Name	Type	References	Description
ContactId	Long	Contacts.Id	Unique ID generated for contacts by the server.
Email	String		Search contacts by email id of the contact person.
FirstName	String		First name of the contact.
IsPrimaryContact	Boolean		To mark contact person as primary for contact.
LastName	String		Last name of the contact.
Mobile	String		Search contacts by mobile number of the contact person.
Phone	String		Search contacts by phone number of the contact person.
Salutation	String		Salutation for the contact.

ContactListComments

List recent activities of a contact

Table Specific Information

Select

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

ContactId supports the '=' comparison.
CommentId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ContactListComments WHERE ContactId = '3350895000000089001'

SELECT * FROM ContactListComments WHERE CommentId = '3350895000000089001'

Columns


Name	Type	References	Description
CommentId [KEY]	Long		The unique id of each comment associated with a contact
CommentedBy	String		The name of the person who has commented
CommentedById	Long		The unique id generated for the person who has commented
ContactId	Long	Contacts.Id	The unique id generated by the contact server
ContactName	String		The name of the contact
Date	Date		Date when the comment was made
DateDescription	String		Days passed from the day when comment was made
Description	String		Description
IsEntityDeleted	Boolean		A boolean value which will be true if the comment will be deleted.
OperationType	String		Type of Operation
Time	Datetime		Time when te comment was made
TransactionId	Long		Id for the transaction
TransactionType	String		Type of transaction

ContactsGetMailContent

List mail content of a contact.

Table Specific Information

Select

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

ContactId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ContactsGetMailContent WHERE ContactId = '3350895000000089001'

Columns


Name	Type	References	Description
Body	String		Body of the mail.
StartDate	Date		Date when or after the contact was created
EndDate	Date		Date after the contact was created
ContactId	String	Contacts.Id	Contact Id
FileName	String		File Name
FromEmails	String		From Emails
Subject	String		Subject
ToContacts	String		To COntacts

ContactsGetMailContentFromEmails

List from emails of Mail Content for Contacts.

Table Specific Information

Select

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

ContactId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ContactsGetMailContentFromEmails WHERE ContactId = '3350895000000089001'

Columns


Name	Type	References	Description
ContactId	String	Contacts.Id	Contact Id
UserName	String		Username.
Selected	Boolean		Selected.
Email	String		Email.
StartDate	Date		Date when or after the contact was created
EndDate	Date		Date after the contact was created

ContactsGetMailContentToContacts

List to contacts of Mail Content for Contacts

Table Specific Information

Select

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

ContactId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ContactsGetMailContentToContacts WHERE ContactId = '3350895000000089001'

Columns


Name	Type	References	Description
ContactId	String	Contacts.Id	Contact Id
FirstName	String		First name.
LastName	String		Last name.
Selected	String		Selected.
Phone	String		Phone.
Email	String		Email.
Salutation	String		Salutation.
ContactPersonId	Long		Contact Person Id.
Mobile	String		Mobile.
StartDate	Date		Date when or after the contact was created
EndDate	Date		Date after the contact was created

CreditNoteGetMailContent

List mail contents of Credit Notes.

Table Specific Information

Select

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

CreditNoteId supports the '=' comparison.
CustomerId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CreditNoteGetMailContent WHERE CreditNoteId = '3350895000000089001'

SELECT * FROM CreditNoteGetMailContent WHERE CustomerId = '837872'

Columns


Name	Type	References	Description
Body	String		Body of the mail.
CustomerId	String		Cusomter Id
CreditNoteId	String	CreditNotes.Id	Credit Notes Id
EmailTemplates	String		Email Templates
ErrorList	String		Error list
FileName	String		File Name
FromEmails	String		From Emails
Subject	String		Subject
ToContacts	String		To COntacts

CreditNoteGetMailContentToContacts

List to contacts of Mail Content for Credit Notes.

Table Specific Information

Select

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

CreditNoteId supports the '=' comparison.
ContactPersonId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CreditNoteGetMailContentToContacts WHERE CreditNoteId = '3350895000000089001'

SELECT * FROM CreditNoteGetMailContentToContacts WHERE ContactPersonId = '3350895000000089001'

Columns


Name	Type	References	Description
CreditNoteId	String	CreditNotes.Id	Credit Notes Id
FirstName	String		First name.
LastName	String		Last name.
Selected	String		Selected.
Phone	String		Phone.
Email	String		Email.
Salutation	String		Salutation.
ContactPersonId	Long	ContactPersons.Id	Contact Person Id.
Mobile	String		Mobile.

CreditNoteGetMailHistory

List email history of credit notes.

Table Specific Information

Select

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

CreditNoteId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CreditNotes WHERE CreditNoteId = '3350895000000089001'

Columns


Name	Type	References	Description
Date	Date		Date of email history.
From	String		From email.
CreditNoteId	Long	CreditNotes.Id	CreditNoteId of email history.
MailhistoryId [KEY]	Long		MailHistoryId of email history.
Subject	String		Subject of email history.
ToMailIds	String		ToEmailIds of email history.

CreditNoteListTemplates

List of templates for credit notes.

Table Specific Information

Select

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

CreditNoteId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CreditNoteListTemplates WHERE CreditNoteId = '3350895000000089001'

Columns


Name	Type	References	Description
CreditNoteId [KEY]	String	CreditNotes.Id	CreditNoteId
TemplateId [KEY]	String		Template Id
TemplateName	String		Template Name
TemplateType	String		Template Type

CreditNotesGetMailContentEmailTemplates

List Email Templates of Mail Content for Credit Notes.

Table Specific Information

Select

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

CreditNoteId supports the '=' comparison.
EmailTemplateId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CreditNotesGetMailContentEmailTemplates WHERE CreditNoteId = '3350895000000089001'

SELECT * FROM CreditNotesGetMailContentEmailTemplates WHERE EmailTemplateId = '837872'

Columns


Name	Type	References	Description
CreditNoteId	String	CreditNotes.Id	Credit Notes Id
Selected	String		Selected.
Name	String		Name.
EmailTemplateId	Long		EmailTemplateId.

CreditNotesGetMailContentFromEmails

List from emails of Mail Content for Credit Notes.

Table Specific Information

Select

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

CreditNoteId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CreditNotesGetMailContentFromEmails WHERE CreditNoteId = '3350895000000089001'

Columns


Name	Type	References	Description
CreditNoteId	String	CreditNotes.Id	Credit Notes Id
UserName	String		Username.
Selected	Boolean		Selected.
Email	String		Email.

CreditNotesInvoices

List invoices of Credit Notes.

Table Specific Information

Select

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

CreditNoteId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CreditNotes WHERE CreditNoteId = '3350895000000089001'

Columns


Name	Type	References	Description
CreditNoteId	String	CreditNotes.Id	Unique ID of the credit note generated by the server
Amount	Integer		Amount paid for the invoice.
InvoiceId [KEY]	Long		Invoice ID of the required invoice.
InvoiceNumber	String		Invoice number of the required invoice.

CreditNotesLineItems

List line items of Credit Notes.

Table Specific Information

Select

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

CreditNoteId supports the '=' comparison.
ItemId supports the '=' comparison.
TaxId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CreditNotesLineItems WHERE CreditNoteId = '1123344555'

SELECT * FROM CreditNotesLineItems WHERE ItemId = '1123344555'

SELECT * FROM CreditNotesLineItems WHERE TaxId = '1123344555'

Columns


Name	Type	References	Description
CreditNoteId	String	CreditNotes.Id	Unique ID of the credit note generated by the server
AccountId	String		Unique ID to denote the account..
AccountName	String		Name of the account..
Code	String		Unique code for the underlying line item of a credit note..
Description	String		A brief description about the item..
InvoiceId	String		Invoice ID of the required invoice..
InvoiceItemId [KEY]	Long		line_item_id of the underlying items in the invoice.
IsItemShipped	Boolean		Defines the shipping status of the line item in the corresponding sales order..
IsReturnedToStock	Boolean		Defines the receivability of the items in the sales return..
ItemId	String		Defines the receivability of the items in the sales return..
Name	String		Name of the credit.
ProductType	String		Enter goods/services.
Quantity	Integer		Quantity of the item included..
SalesreturnItemId	Long		line_item_id of the underlying items in the sales return..
SerialNumbers	String		Enter serial number.
TaxId	String		Unique ID to denote the tax associated with the credit note..
Type	Integer		Type.
WarehouseId	Long		Warehouse Id.
WarehouseName	String		Warehouse Name.

CreditNotesTaxes

List taxes of credit notes.

Table Specific Information

Select

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

CreditNoteId supports the '=' comparison.
TaxId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CreditNotesTaxes WHERE CreditNoteId = '3350895000000089001'

SELECT * FROM CreditNotesTaxes WHERE TaxId = '988'

Columns


Name	Type	References	Description
CreditNoteId	String	CreditNotes.Id	Unique ID of the credit note generated by the server
TaxAmount	String		Tax amount applied to the subscription.
TaxId [KEY]	String	Taxes.Id	Unique ID to denote the tax associated with the credit note.
TaxName	String		Unique name for tax.

CustomerPaymentsInvoices

Get Invoices of Customer Payments.

Table Specific Information

Select

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

InvoiceId supports the '=' comparison.
CustomerPaymentId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CustomerPaymentsInvoices WHERE InvoiceId = '3350895000000089001'

SELECT * FROM CustomerPaymentsInvoices WHERE CustomerPaymentId = '4534543100'

Columns


Name	Type	References	Description
CustomerPaymentId	String		Unique ID of the payment generated by the server.
AmountApplied	Integer		Amount paid for the invoice.
BalanceAmount	Integer		Unpaid amount of the invoice.
Date	Date		Date on which the invoice was raised.
InvoiceAmount	Integer		Total amount raised for the invoice.
InvoiceId	String		Invoice ID of the required invoice.
InvoiceNumber	String		Unique ID (starts with INV) of an invoice.

InventoryAdjustmentsLineItems

Line items of the inventory adjustments.

Table Specific Information

Select

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

Id supports the '=' comparison.
InventoryAdjustmentsId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InventoryAdjustmentsLineItems WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the QuantityAdjusted and ItemId 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 InventoryAdjustmentsLineItems (QuantityAdjusted, Description, ItemId) VALUES ('11', 'value', 9)

Update

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

UPDATE InventoryAdjustmentsLineItems SET Description = 'poor quality', QuantityAdjusted = '9', ItemId = 9 WHERE Id = '3350895000000090009'

Delete

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

DELETE FROM InventoryAdjustmentsLineItems WHERE Id = '3350895000000089001'

Columns


Name	Type	References	Description
InventoryAdjustmentsId	Long		Unique ID generated by the server for the item adjustment.
Id [KEY]	Long		Unique ID generated by the server for each line item.
ItemId	Long		Unique ID generated by the server for the item.
Name	String		Name of the line item.
Description	String		Sample Description.
QuantityAdjusted	Double		The adjusted quantity of the line item.
ItemTotal	Double		Total of line item.
Unit	String		Unit of line item.
IsComboProduct	Boolean		boolean to see is_combo_product
AdjustmentAccountId	Long		Unique
AdjustmentAccountName	String		Name of the Adjustment Account.
WarehouseId	Long		Unique ID generated by the server for the Warehouse.
WarehouseName	String		Name of the Warehouse.

InvoiceGetMailContent

Get mail contents of invoices.

Table Specific Information

Select

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

InvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InvoiceGetMailContent WHERE InvoiceId = '3350895000000089001'

Columns


Name	Type	References	Description
InvoiceId	Long	Invoices.Id	Invoice Id.
AttachPdf	Boolean		Attach pdf
AttachmentName	String		Attachment name
BccMails	String		Bcc mails
BccMailsStr	String		Bcc mails str
Body	String		Body
CcMailsList	String		Cc mails list
CcMailsStr	String		Cc mails str
CustomerId	Long		Customer id
CustomerName	String		Customer name
DeprecatedPlaceholdersUsed	String		Deprecated placeholders used
Documents	String		Documents
EmailtemplateDocuments	String		Emailtemplate documents
Emailtemplates	String		Email templates
EntityId	String		Entity id
ErrorList	String		Error list
FileName	String		File name
FileNameWithoutExtension	String		File name without extension
FromAddress	String		From address
FromEmail	String		From email
FromEmails	String		From emails
GatewaysAssociated	Boolean		Gateways associated
GatewaysConfigured	Boolean		Gateways configured
Subject	String		Subject
ToContacts	String		To contacts
ToMailsStr	String		To mails str

InvoiceListPayments

List Payments of Invoices.

Table Specific Information

Select

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

InvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InvoiceListPayments WHERE InvoiceId = '3350895000000089001'

Columns


Name	Type	References	Description
Amount	Double		Amount
Date	Date		Date
Description	String		Description
ExchangeRate	Integer		ExchangeRate
InvoiceId	Long	Invoices.Id	Invoice Id
InvoicePaymentId [KEY]	Long		Invoice Payment Id
IsSingleInvoicePayment	Boolean		IsSingleInvoice Payment
OnlineTransactionId	String		OnlineTransaction Id
PaymentId	String		Payment Id
PaymentMode	String		Payment Mode
PaymentNumber	Integer		Payment Number
ReferenceNumber	Integer		Reference Number
TaxAmountWithheld	Integer		Tax Amount Withheld

InvoiceListTemplates

List templates of Invoices.

Table Specific Information

Select

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

TemplateId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InvoiceListTemplates WHERE TemplateId = '3350895000000089001'

Columns


Name	Type	References	Description
TemplateId [KEY]	Long		Id of template.
TemplateName	String		Name of template.
TemplateType	String		Type of template.

InvoicesContactPersons

List Contact Persons of the invoices.

Table Specific Information

Select

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

InvoiceId supports the '=' comparison.
ContactPersonId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InvoicesContactPersons WHERE InvoiceId = '3350895000000089001'

SELECT * FROM InvoicesContactPersons WHERE ContactPersonId = '3350895000000089001'

Columns


Name	Type	References	Description
InvoiceId	Long	Invoices.Id	Invoice Id
ContactPersonId [KEY]	Long	ContactPersons.Id	Unique ID of the contact person.
Email	String		Contact email id.
FirstName	String		First name of the contact.
IsPrimaryContact	String		To mark contact person as primary for contact.
LastName	String		Last name of the contact.
Mobile	String		Mobile number of the contact person.
Phone	String		Phone number of the contact.
Salutation	String		Salutation to the contact.

InvoicesGetMailContentEmailTemplates

List Email Templates of Mail Content for Invoices.

Table Specific Information

Select

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

EmailTemplateId supports the '=' comparison.
InvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InvoicesGetMailContentEmailTemplates WHERE EmailTemplateId = '3350895000000089001'

SELECT * FROM InvoicesGetMailContentEmailTemplates WHERE InvoiceId = '1937623621'

Columns


Name	Type	References	Description
InvoiceId	Long	Invoices.Id	Invoice Id.
Selected	String		Selected.
Name	String		Name.
EmailTemplateId	Long		EmailTemplateId.

InvoicesGetMailContentFromEmails

List from emails of Mail Content for Invoices.

Table Specific Information

Select

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

InvoiceId supports the '=' comparison.
OrganizationContactId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InvoicesGetMailContentFromEmails WHERE OrganizationContactId = '3350895000000089001'

SELECT * FROM InvoicesGetMailContentFromEmails WHERE InvoiceId = '1937623621'

Columns


Name	Type	References	Description
InvoiceId	Long	Invoices.Id	Invoice Id.
UserName	String		Username.
Selected	Boolean		Selected.
Email	String		Email.
OrganizationContactId	String		Organization Contact Id.
IsOrgEmailId	Boolean		Is Org Email Id.

InvoicesGetMailContentToContacts

List to contacts of Mail Content for Invoices.

Table Specific Information

Select

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

ContactPersonId supports the '=' comparison.
InvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InvoicesGetMailContentToContacts WHERE ContactPersonId = '3350895000000089001'

SELECT * FROM InvoicesGetMailContentToContacts WHERE InvoiceId = '1937623621'

Columns


Name	Type	References	Description
InvoiceId	Long	Invoices.Id	Invoice Id.
FirstName	String		First name.
LastName	String		Last name.
Selected	String		Selected.
Phone	String		Phone.
Email	String		Email.
Salutation	String		Salutation.
ContactPersonId [KEY]	Long	ContactPersons.Id	Contact Person Id.
Mobile	String		Mobile.

InvoicesGetPaymentReminderMailContent

Get payment reminder for Invoices.

Table Specific Information

Select

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

InvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InvoicesGetPaymentReminderMailContent WHERE InvoiceId = '3350895000000089001'

Columns


Name	Type	References	Description
AttachPdf	Boolean		Attach pdf
AttachmentName	String		Attachment name
BccMails	String		Bcc mails
BccMailsStr	String		Bcc mails str
Body	String		Body
CcMailsList	String		Cc mails list
CcMailsStr	String		Cc mails str
CustomerId	Long		Customer id
InvoiceId	Long	Invoices.Id	Invoice id
CustomerName	String		Customer name
DeprecatedPlaceholdersUsed	String		Deprecated placeholders used
Documents	String		Documents
EmailtemplateDocuments	String		Email template documents
Emailtemplates	String		Email templates
EntityId	String		Entity id
ErrorList	String		Error list
FileName	String		File name
FileNameWithoutExtension	String		File name without extension
FromAddress	String		From address
FromEmail	String		From email
FromEmails	String		From emails
GatewaysAssociated	Boolean		Gateways associated
GatewaysConfigured	Boolean		Gateways configured
Subject	String		Subject
ToContacts	String		To contacts
ToMailsStr	String		To mails str

InvoicesTaxes

List taxes of invoices.

Table Specific Information

Select

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

InvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM InvoicesTaxes WHERE InvoiceId = '3350895000000089001'

Columns


Name	Type	References	Description
InvoiceId	Long	Invoices.Id	ID of invoice.
TaxAmount	Double		The amount of the tax levied
TaxName	String		The name of the tax

ItemGroupsAttributeOptions

List Item Groups Attribute Options.

Table Specific Information

Select

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

Id supports the '=' comparison.
GroupId supports the '=' comparison.
GroupAttributeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ItemGroupsAttributeOptions WHERE Id = '3350895000000089001'

Columns


Name	Type	References	Description
GroupId	Long	ItemGroups.Id	Id of the Item Group
GroupAttributeId	Long	ItemGroupsAttributes.Id	Unique ID generated by the server for the attribute.
Id	Long		Unique ID generated by the server for the attribute option.
Name	String		Name of the Item.

ItemGroupsAttributes

List attributes of item groups.

Table Specific Information

Select

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

Id supports the '=' comparison.
GroupId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ItemGroupsAttributes WHERE Id = '3350895000000089001'

Columns


Name	Type	References	Description
GroupId	Long	ItemGroups.Id	Id of the Item Group
Id [KEY]	Long		Unique ID generated by the server for the attribute.
Name	String		Name of the Item.
Options	String		The options present for each attribute.

ItemGroupsItems

List items of Item Groups.

Table Specific Information

Select

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

Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ItemGroupsItems WHERE Id = '3350895000000089001'

Columns


Name	Type	References	Description
GroupId	Long	ItemGroups.Id	Id of the Item Group
Name	String		Name of the Item.
Rate	Double		Sales price of the Item.
PurchaseRate	Double		Purchase price of the Item.
ReorderLevel	Double		Reorder level of the item.
InitialStock	Double		The opening stock of the item.
InitialStockRate	Double		The opening stock value of the item.
VendorId	Long		Unique ID generated by the server for the Vendor.
Sku	String		The Stock Keeeping Unit (SKU) of an item.
Upc	Long		The 12 digit Unique Product Code (UPC) of the item.
Ean	Long		Unique EAN value for the Item.
Isbn	Long		Unique ISBN value for the Item.
PartNumber	String		Part Number of the Item.
AttributeOptionName1	Long		Name of the attribute option.

ItemTaxPreferences

List tax preference of the items.

Table Specific Information

Select

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

ItemId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ItemTaxPreferences WHERE ItemId = '3350895000000089001'

Columns


Name	Type	References	Description
ItemId	Long	Items.Id	Unique ID generated by the server for the item belongs, if any. This is used as an identifier.
TaxId [KEY]	Long		Unique ID generated by the server for the tax associated with the item.
TaxSpecification	String		Type of tax.

OrganizationAddress

List addresses of Organizations.

Table Specific Information

Select

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

OrganizationId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM OrganizationAddresses WHERE OrganizationId = '3350895000000089001'

Columns


Name	Type	References	Description
City	String		City of the organisation.
Country	String		Country of the Organisation.
State	String		State where the organisation is located.
StreetAddress1	String		Street name of the Billing address of the Organisation.
StreetAddress2	String		Continyed billing address of the organisation.
Zip	String		ZIP/Postal code of the organisation location.
OrganizationId	String	Organizations.Id	ID of the organisation generated by the server.

PackageLineItems

List line items of the package.

Table Specific Information

Select

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

LineItemId supports the '=' comparison.
PackageId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PackageLineItems WHERE PackageId = '3350895000000089001'

Columns


Name	Type	References	Description
Description	String		Description of the item in package
PackageId	Long	Packages.Id	Unique ID generated by the server of the item in package
IsInvoiced	Boolean		Sales order item is invoiced to the customer or not
ItemId	Long		Unique ID generated by the server of the item in package
ItemOrder	String		Item Order
LineItemId [KEY]	Long		Unique value generated by the server for an item of sales order in package
Name	String		Name of the packaged item
Quantity	Integer		Number of quantity of line items in sales order
Sku	String		Stock keeping unit of the item in package
SoLineItemId	Long		Unique ID generated by the server for items in sales order
Unit	String		Unit of the item in package

PackagesContactPersons

List Contact persons of the Package.

Table Specific Information

Select

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

PackageId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PackagesContactPersons WHERE PackageId = '3350895000000089001'

Columns


Name	Type	References	Description
PackageId	Long	Packages.Id	Unique ID generated by the server of the item in package
ContactPersonId	Long		Unique ID generated by the server for contact person

PriceBookItems

List items of pricebooks.

Table Specific Information

Select

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

Id supports the '=' comparison.
PricebookItemId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PriceBookItems WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the Name,CurrencyId,PricebookType,IsIncrease and SalesOrPurchaseType 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 PriceBookItems (PricebookRate) VALUES ('12')

Update

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

UPDATE PriceBookItems SET PricebookRate = '67' WHERE Id = '3350895000000089001'

Delete

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

DELETE FROM PriceBookItems WHERE Id = '3350895000000089001'

Columns


Name	Type	References	Description
PricebookId	Long	Pricebooks.Id	Unique ID generated by server for the price book
ItemId	Long		Unique ID generated by server for Item
PricebookItemId [KEY]	Long		Unique ID generated by server for Price book Item
PricebookRate	Integer		Rate of the price book for the Items

PurchaseOrderBills

List Bills of purchase orders.

Table Specific Information

Select

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

BillNumber supports the '=' comparison.
PurchaseOrderId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PurchaseOrderBills WHERE PurchaseOrderId = '3350895000000089001'

Columns


Name	Type	References	Description
PurchaseOrderId	Long	PurchaseOrders.Id	Unique ID generated by the server for the Purchase Order.
Balance	Integer		Balance of the bill.
BillId [KEY]	Long		Id of the bill.
BillNumber [KEY]	String		Bill number of the bill.
Date	Date		Date of the bill.
DueDate	Date		Due date of the bill.
Status	String		Status of the bill.
Total	Integer		Total amount in the bill.

PurchaseOrderDocuments

List Documents of Purchase Orders.

Table Specific Information

Select

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

DocumentId supports the '=' comparison.
PurchaseOrderId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PurchaseOrderDocuments WHERE DocumentId = '3350895000000089001'

Columns


Name	Type	References	Description
PurchaseOrderId	Long	PurchaseOrders.Id	Unique ID generated by the server for the Purchase Order.
AttachmentOrder	Integer		Attachment Order
CanSendInMail	Boolean		Can Send in Mail
DocumentId [KEY]	Long		Document Id
FileName	String		File Name
FileSize	Integer		File Size
FileSizeFormatted	String		File Size Formatted
FileType	String		File Type

PurchaseOrderLineItems

List line items of Purchase Orders.

Table Specific Information

Select

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

LineItemId supports the '=' comparison.
PurchaseOrderId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PurchaseOrderLineItems WHERE PurchaseOrderId = '3350895000000089001'

Columns


Name	Type	References	Description
PurchaseOrderId	Long	PurchaseOrders.Id	Unique ID generated by the server for the Purchase Order.
AccountId	Long		Account ID of the item.
BcyRate	Integer		Item rate in the organization base currency.
Description	String		Description of the line item.
HsnOrSac	String		HSN or SAC Code for the Item
ImageId	Long		Unique ID generated by the server for the item image. This is used an identifier.
ImageName	String		Name of the image of the line item.
ImageType	String		The type (file format) of the image.
ItemId	Long		Unique ID generated by the server for the item. This is used as an identifier
ItemOrder	Integer		The order of the line items, starts from 0 by default.
ItemTotal	Integer		Total of line item.
LineItemId [KEY]	Long		Id of line item.
Name	String		Name of the line item.
PurchaseRate	Integer		Purchase Price of the line item.
Quantity	Integer		Quantity of the line item.
QuantityReceived	Integer		Quantity invoiced of the line item.
ReverseChargeTaxAmount	Integer		Enter reverse charge tax amount.
ReverseChargeTaxId	Long		Enter reverse charge tax ID.
ReverseChargeTaxName	String		Enter reverse charge tax name.
ReverseChargeTaxPercentage	Integer		Enter reverse charge tax percentage.
SalesorderItemId	Long		Salesorder Item Id.
TaxExemptionCode	String		Enter tax exemption code.
TaxRxemptionId	String		Enter tax exemption id
TaxId	Long		Unique ID generated by the server for the tax. This is used as an identifier.
TaxName	String		Name of the tax applied on the line item.
TaxPercentage	Integer		Percentage of the tax.
TaxType	String		Denotes the type of the tax. This can either be a single tax or a tax group.
Unit	String		Unit of line item.
WarehouseId	Long		Warehouse Id.

PurchaseOrderPurchaseReceives

List Purchase receives of purchase items.

Table Specific Information

Select

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

PurchaseOrderId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PurchaseOrderPurchaseReceives WHERE PurchaseOrderId = '3350895000000089001'

Columns


Name	Type	References	Description
PurchaseOrderId	Long		Unique ID generated by the server for the Purchase Order.
Date	Date		Date of purchase received.
LineItems	String		Line items of purchase receive.
Notes	String		Notes of purchase receive.
ReceiveId [KEY]	Long		Id of Purchase Receive.
ReceiveNumber	String		Purchase Receive Number.

PurchaseOrderTaxes

List taxes of purchaseorders

Table Specific Information

Select

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

PurchaseOrderId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PurchaseOrderTaxes WHERE PurchaseOrderId = '3350895000000089001'

Columns


Name	Type	References	Description
PurchaseOrderId	Long	PurchaseOrders.Id	ID of purchase order.
TaxAmount	Double		The amount of the tax levied
TaxName	String		The name of the tax

PurchaseReceiveLineItems

List line tiems of purchase receives.

Table Specific Information

Select

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

LineItemId supports the '=' comparison.
ReceiveId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PurchaseReceiveLineItems WHERE ReceiveId = '3350895000000089001'

Columns


Name	Type	References	Description
ReceiveId	Long	PurchaseReceives.Id	Unique ID generated by the server for the Purchase Receive.
Description	String		Descripition of line item.
Item_id	Long		Item ID of line item.
Item_order	Integer		Item Order of line item.
Line_item_id [KEY]	Long		Line item id of line item.
Name	String		Name of line item.
Quantity	Integer		Quantity of line item.
Unit	String		Unit of line item.

RetainerInvoiceGetMailContent

Get mail content of retainer invoice.

Table Specific Information

Select

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

RetainerInvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM RetainerInvoiceGetMailContent WHERE RetainerInvoiceId = '3350895000000089001'

Columns


Name	Type	References	Description
AttachmentName	String		Attachment Name
Body	String		Body
RetainerInvoiceId	Long	RetainerInvoices.Id	Retainer Invoice Id
CustomerId	Long		Customer Id
DeprecatedPlaceholdersUsed	String		Deprecated Placeholders Used
EmailTemplateId	String		EmailTemplate Id
ErrorList	String		Error List
FileName	String		File Name
FromEmails	String		From Emails
GatewaysConfigured	Boolean		Gateways Configured
Subject	String		Subject
ToContacts	String		To Contacts

RetainerInvoiceGetMailContentFromEmails

List from emails of Mail Content for Retainer Invoices.

Table Specific Information

Select

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

RetainerInvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM RetainerInvoicesGetMailContentFromEmails WHERE RetainerInvoiceId = '1937623621'

Columns


Name	Type	References	Description
RetainerInvoiceId	Long	RetainerInvoices.Id	Retainer Invoice Id
UserName	String		Username.
Selected	Boolean		Selected.
Email	String		Email.

RetainerInvoiceGetMailContentToContacts

List to contacts of Mail Content for Retainer Invoices.

Table Specific Information

Select

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

RetainerInvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM RetainerInvoiceGetMailContentToContacts WHERE RetainerInvoiceId = '3350895000000089001'

Columns


Name	Type	References	Description
RetainerInvoiceId	Long	RetainerInvoices.Id	Retainer Invoice Id.
FirstName	String		First name.
LastName	String		Last name.
Selected	String		Selected.
Phone	String		Phone.
Email	String		Email.
Salutation	String		Salutation.
ContactPersonId [KEY]	Long	ContactPersons.Id	Contact Person Id.
Mobile	String		Mobile.

RetainerInvoiceListTemplates

List templates of retainer invoices.

Table Specific Information

Select

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

TemplateId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM RetainerInvoiceListTemplates WHERE TemplateId = '3350895000000089001'

Columns


Name	Type	References	Description
TemplateId [KEY]	Long		ID of the pdf template associated with the retainer invoice.
TemplateName	String		Template Name
TemplateType	String		The type of template type

RetainerInvoicesLineItems

List line items of retainer invoice.

Table Specific Information

Select

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

RetainerInvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM RetainerInvoiceLineItems WHERE RetainerInvoiceId = '3350895000000089001'

Columns


Name	Type	References	Description
RetainerInvoiceId	Long	RetainerInvoices.Id	RetainerInvoice Id.
BcyRate	Integer		base currency rate
Description	String		The description of the line items.
ItemOrder	Integer		The order of the line item_order
ItemTotal	Integer		The total amount of the line items
LineItemId [KEY]	Long		The line item id
Rate	Integer		Rate of the line item.
TaxId	Long		ID of the tax or tax group applied to the estimate
TaxName	String		The name of the tax
TaxPercentage	Double		The percentage of tax levied
TaxType	String		The type of the tax

RetainerInvoicesPaymentOptionsPaymentGateways

Payment Gateways of Retainer Invoices

Table Specific Information

Select

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

RetainerInvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM RetainerInvoicesPaymentOptionsPaymentGateways WHERE RetainerInvoiceId = '3350895000000089001'

Columns


Name	Type	References	Description
RetainerInvoiceId	Long	RetainerInvoices.Id	ID of the retainerinvoice
Configured	Boolean		Boolean value configured.
AdditionalField1	String		Additional field.
GatewayName	String		Name of the Gateway.

RetainerInvoicesTaxes

List taxes of retainer invoices.

Table Specific Information

Select

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

RetainerInvoiceId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM RetainerInvoicesTaxes WHERE RetainerInvoiceId = '3350895000000089001'

Columns


Name	Type	References	Description
RetainerInvoiceId	Long	RetainerInvoices.Id	RetainerInvoice Id.
TaxName	String		The name of the tax
TaxAmount	Float		The amount of tax levied

SalesOrderDocuments

List documents of sales orders.

Table Specific Information

Select

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

DocumentId supports the '=' comparison.
SalesOrderId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM SalesOrderDocuments WHERE DocumentId = '3350895000000089001'

SELECT * FROM SalesOrderDocuments WHERE SalesOrderId = '3350895000000089001'

Columns


Name	Type	References	Description
DocumentId [KEY]	Long		Unique ID generated by the server for the document.
SalesOrderId	Long	SalesOrders.Id	Id of the salesorder.
AttachmentOrder	Integer		This indicates the chronological number of the attachment.
CanSendInMail	Boolean		Checks whether the sales order can be sent as a mail or not.
FileName	String		This indicates the name of the file.
FileSize	Integer		this indicates the size of the attached file.
FileSizeFormatted	String		This indicates the size of the formatted file.
FileType	String		Sales order can have files attached to them.

SalesOrderLineItems

List line items of sales orders.

Table Specific Information

Select

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

SalesOrderId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM SalesOrderLineItems WHERE SalesOrderId = '3350895000000089001'

Columns


Name	Type	References	Description
LineItemId [KEY]	Long		Unique ID generated by the server for each line item.
SalesOrderId	Long	SalesOrders.Id	Id of the salesorder.
BcyRate	Integer		Item rate in the organization base currency.
Description	String		Description of the line item.
HsnOrSac	Integer		Add HSN/SAC code for your goods/services.
ImageId	Long		Unique ID generated by the server for the item image.
ImageName	String		Name of the image of the line item.
ImageType	String		The type (file format) of the image.
IsInvoiced	Boolean		Checks whether the Sales Order has been invoiced or not.
ItemId	Long		Unique ID generated by the server for the item.
ItemOrder	Integer		The order of the line items.
ItemTotal	Integer		Total of line item.
Name	String		Name of the line item.
Quantity	Integer		Quantity of the line item.
QuantityInvoiced	Integer		Quantity invoiced of the line item.
QuantityPacked	Integer		Quantity packed of the line item.
QuantityShipped	Integer		Quantity shipped of the line item.
Rate	Integer		Rate / Selling Price of the line item.
TaxId	Long		Unique ID generated by the server for the tax.
TaxName	String		Name of the tax applied on the line item.
TaxPercentage	Integer		Percentage of the tax.
TaxType	String		Denotes the type of the tax.
Unit	String		Unit of line item.
WarehouseId	Long		Unique ID generated by the server for the ware houses.

SalesOrderTaxes

List taxes of Sales Orders.

Table Specific Information

Select

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

SalesOrderId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM SalesOrderTaxes WHERE SalesOrderId = '3350895000000089001'

Columns


Name	Type	References	Description
TaxAmount	Double		Tax Amount
TaxName	String		Tax Name
SalesOrderId	Long	SalesOrders.Id	Salesorder Id

SalesReturnReceiveLineItems

List line items of sales receives of sales returns.

Table Specific Information

Select

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

SalesReturnId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM SalesReturnReceiveLineItems WHERE SalesReturnId = '3350895000000089001'

Columns


Name	Type	References	Description
SalesReturnId	Long	SalesReturns.Id	Sales Return Id.
ReceiveId	Long		Recevie Id.
Id	Long		Unique line item id.
ItemId	Long		Unique item id.
Name	String		The name of the line item.
Quantity	Integer		The quantity of line item.
Unit	String		Unit of the line item.
Description	String		Description of the line item.

SalesReturnsComments

List comments of Sales Returns.

Table Specific Information

Select

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

CommentId supports the '=' comparison.
SalesReturnId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM SalesReturnsComments WHERE CommentId = '3350895000000089001'

SELECT * FROM SalesReturnsComments WHERE SalesReturnId = '3350895000000089001'

Columns


Name	Type	References	Description
CommentId [KEY]	Long		Unique ID generated by the server for the comment(history).
CommentType	String		Indicates the type of the action.
CommentedBy	String		Indicates the user who performed the action on the purchase order.
Date	Date		Date on which the entity was created.
DateDescription	String		Indicates the time duration since the action was performed.
OperationType	String		Type of operation performed on the transaction.
SalesreturnId	Long	SalesReturns.Id	Unique ID generated by the server for the Sales Return.
Time	Datetime		Indicates the time when the action was performed.
TransactionId	Integer		Unique ID generated by the server for the transaction
TransactionType	String		Indicates the type of transaction.

SalesReturnsCreditNotes

List Credit Notes of Sales Returns.

Table Specific Information

Select

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

SalesReturnId supports the '=' comparison.
CreditNoteId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM SalesReturnsCreditNotes WHERE SalesReturnId = '3350895000000089001'

SELECT * FROM SalesReturnsCreditNotes WHERE CreditNoteId = '3350895000000089001'

Columns


Name	Type	References	Description
CreditnoteId [KEY]	Long		Credit note Id.
SalesReturnId	Long	SalesReturns.Id	Sales Return Id.
CreditnoteNumber	String		Credit Note number.
Date	Date		Date of Credit note.
Status	String		Status of Credit note.
Total	Integer		Total in credit note.

SalesReturnsLineItems

List line items of Sales Retruns.

Columns


Name	Type	References	Description
LineItemId [KEY]	Long		Unique ID generated by the server for each line item.
SalesreturnId	Long	SalesReturns.Id	Unique ID generated by the server for the Sales Return.
Description	String		Description of the line item.
ItemId	Long		Unique ID generated by the server for the item.
Name	String		Name of the line item.
NonReceiveQuantity	Integer		The quantity that cannot be received for the line item.
Quantity	Integer		The quantity that can be received for the line item.
Rate	Integer		Price of the line item in an entity.
SalesorderItemId [KEY]	Long		Unique ID generated by the server for each line item in a sales order.
Unit	String		Measurement unit of the line item.
WarehouseId	Long		Unique ID generated by the server for each warehouse.
WarehouseName	String		Name of the warehouse.

SalesReturnsSalesReceives

List sales receives of sales returns.

Table Specific Information

Select

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

SalesReturnId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM SalesReturnsSalesReceives WHERE SalesReturnId = '3350895000000089001'

Columns


Name	Type	References	Description
ReceiveId [KEY]	Long		Recevie Id.
SalesReturnId	Long	SalesReturns.Id	Sales Return Id.
Date	Date		Date of Sales Receive.
LineItems	String		Line items of Sales Receive.
Notes	String		Notes of Sales Recevie
ReceiveNumber	String		Receive Number.

ShipmentOrdersLineItems

List line items of shipment orders..

Table Specific Information

Select

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

ShipmentOrderId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ShipmentOrdersLineItems WHERE ShipmentOrderId = '3350895000000089001'

Columns


Name	Type	References	Description
LineItemId [KEY]	Long		Unique ID generated by the server for each line item.
ShipmentOrderId	Long	ShipmentOrders.Id	Unique ID generated by the server for the shipment.
BcyRate	Integer		Item rate in the organization base currency..
desc	String		desc of the line item.
IsInvoiced	Boolean		Checks whether the Sales Order has been invoiced or not.
ItemId	Long		Unique ID generated by the server for the item.
ItemOrder	Integer		The order of the line items.
ItemTotal	Integer		Total of line item.
Name	String		Name of the line item.
Rate	Integer		Rate / Selling Price of the line item.
TaxId	Long		Unique ID generated by the server for the tax.
TaxName	String		Name of the tax applied on the line item.
TaxPercentage	Integer		percentage of tax.
TaxType	String		Denotes the type of tax.
Unit	String		unit of line item.

ShipmentOrdersTaxes

List taxes of shipment orders.

Table Specific Information

Select

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

ShipmentOrderId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM ShipmentOrdersTaxes WHERE ShipmentOrderId = '3350895000000089001'

Columns


Name	Type	References	Description
ShipmentOrderId	Long	ShipmentOrders.Id	Unique ID generated by the server for the shipment.
TaxAmount	Double		Amount of the Tax.
TaxName	String		Name of the tax applied on the line item.

TransferOrderLineItems

List line items of transfer orders.

Table Specific Information

Select

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

LineItemId supports the '=' comparison.
TransferOrderId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM TransferOrderLineItems WHERE TransferOrderId = '3350895000000089001'

Columns


Name	Type	References	Description
TransferOrderId	Long		Unique ID generated by the server for the Transfer Order
Description	String		Description of the line item.
ItemId	Long		Unique ID generated by the server for the item.
LineItemId [KEY]	Long		Unique ID generated by the server for each line item.
Name	String		Name of the line item.
QuantityTransfer	Integer		Quantity of the line item to be transferred.
Unit	String		Unit of line item.

VendorCreditsComments

List Comments of VendorCredits.

Table Specific Information

Select

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

CommentId supports the '=' comparison.
VendorCreditId supports the '=' comparison.
TransactionId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM VendorCreditsComments WHERE CommentId = '3350895000000089001'

SELECT * FROM VendorCreditsComments WHERE VendorCreditId = '983872973'

SELECT * FROM VendorCreditsComments WHERE TransactionId = '983872973'

Columns


Name	Type	References	Description
CommentId [KEY]	String		Comment Id
CommentType	String		Comment Type
CommentedBy	String		Commented By
CommentedById	String		Commented By Id
Date	Date		Date
DateDescription	String		Date Description
Description	String		Description
OperationType	String		Operation Type
Time	Datetime		Time
TransactionId	String		Transaction Id
TransactionType	String		Transaction Type
VendorCreditId	String	VendorCredits.Id	Vendor Credit Id

VendorCreditsDocuments

List Documents related to vendor credits.

Table Specific Information

Select

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

DocumentId supports the '=' comparison.
VendorCreditId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM VendorCreditsDocuments WHERE DocumentId = '3350895000000089001'

SELECT * FROM VendorCreditsDocuments WHERE VendorCreditId = '983872973'

Columns


Name	Type	References	Description
DocumentId [KEY]	Long		ID of the Document
FileName	String		Name of the file
VendorCreditId	String	VendorCredits.Id	Vendor Credit Id

VendorCreditsLineItems

List line items of Vendor Credits.

Table Specific Information

Select

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

LineItemId supports the '=' comparison.
VendorCreditId supports the '=' comparison.
ItemId supports the '=' comparison.
AccountId supports the '=' comparison.
TaxId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM VendorCreditsLineItems WHERE LineItemId = '3350895000000089001'

SELECT * FROM VendorCreditsLineItems WHERE VendorCreditId = '983872973'

Columns


Name	Type	References	Description
VendorCreditId	Long	VendorCredits.Id	ID of the Vendor Credit
ItemId	String		Item Id.
LineItemId [KEY]	String		Line Item Id.
AccountId	String		ID of the account, the line item is associated with
Name	String		Name of the line item.
HSNOrSAC	String		HSN Code
ReverseChargeTaxId	Long		ID of the Reverse Charge
WarehouseId	Boolean		Warehouse Id.
Description	Boolean		Description of the line item.
ItemOrder	String		Order of the line item
Quantity	String		Quantity of the line item.
Unit	String		Unit of the line item e.g. kgs, Nos.
Rate	Integer		Rate of the line item.
TaxId	Long		ID of the Tax associated with the Vendor Credit
TaxTreatmentCode	String		Tax Treatment Code.
Tags	String		Tags.
ItemCustomFields	Integer		Item Custom Fields.
ProjectId	Long		Project Id.
ProjectName	String		Project Name.

VendorCreditsLineItemsTags

Tags of the List line items of Vendor Credits.

Table Specific Information

Select

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

TagId supports the '=' comparison.
VendorCreditId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM VendorCreditsLineItemsTags WHERE TagId = '3350895000000089001'

SELECT * FROM VendorCreditsLineItemsTags WHERE VendorCreditId = '983872973'

Columns


Name	Type	References	Description
VendorCreditId	Long	VendorCredits.Id	ID of the Vendor Credit.
TagId [KEY]	String		Tag Id.
TagOptionId	String		Tag option Id.

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Connection

Property	Description
OrganizationId	The Id associated with the specific Zoho Inventory organization you wish to connect to.
Region	The Top-level domain in the Server URL.

OAuth

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

SSL

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

Property	Description
LogModules	Core modules to be included in the log file.

Schema

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

Property	Description
AccountsServer	The full Account Server URL.
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Connection

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

Property	Description
OrganizationId	The Id associated with the specific Zoho Inventory organization you wish to connect to.
Region	The Top-level domain in the Server URL.

OrganizationId

The Id associated with the specific Zoho Inventory organization you wish to connect to.

Remarks

In Zoho Inventory, your business is referred to as an organization. If you have multiple businesses, configure each of those as an individual organization. Each organization is an independent Zoho Inventory 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, the Sync App makes a call to get all the available organizations and selects the first organization Id as the default.

Region

The Top-level domain in the Server URL.

Remarks

If your account resides in a domain other than the US, then change the Region accordingly. This table lists all possible values:


Region	Domain
US	.com
Europe	.eu
India	.in
Australia	.com.au

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

OAuthClientId

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

FirewallType

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.


Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Zoho Inventory and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

FirewallPort

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

ProxyAutoDetect

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

ProxyPort

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

BASIC: The Sync App performs HTTP BASIC authentication.
DIGEST: The Sync App performs HTTP DIGEST authentication.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:


AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
LogModules	Core modules to be included in the log file.

LogModules

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\Zoho Inventory Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
AccountsServer	The full Account Server URL.
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

AccountsServer

The full Account Server URL.

Remarks

You only need to supply this when executing the RefreshOAuthAccessToken stored procedure with InitiateOAuth=Off. Most of the time, the value of this property will be https://accounts.zoho.com/, but if your account resides in a different location, then the domain should change accordingly (.eu, .in, .com.au, ...).

IncludeCustomFields

A boolean indicating if you would like to include custom fields in the column listing.

Remarks

Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.

MaxRows

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting


DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

RowScanDepth

The maximum number of rows to scan to look for the columns available in a table.

Remarks

The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

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

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

This User Defined View configuration file is formatted as follows:

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

For example:

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

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

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

Note that the specified path is not embedded in quotation marks.

Zoho Inventory Connector for CData Sync

Zoho Inventory Connector for CData Sync

Overview

Zoho Inventory Version Support

Establishing a Connection

Adding a Connection to Zoho Inventory

Connecting to Zoho Inventory

Web Applications

Get an OAuth Access Token

Automatic Refresh of the OAuth Access Token

Manual Refresh of the OAuth Access Token

Headless Machines

Option 1: Obtain and Exchange a Verifier Code

Option 2: Transfer OAuth Settings

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Overview

Key Features

Tables

Views

Stored Procedures

Tables

Zoho Inventory Connector for CData Sync Tables

Bills

Table Specific Information

Select

Insert

Update

Delete

Columns

CompositeItems

Table Specific Information

Select

Insert

Update

Delete

Columns

CompositeItemsBundles

Table Specific Information

Select

Insert

Update

Delete

Columns

CompositeItemsMappedItems

Table Specific Information

Select

Insert

Update

Delete

Columns

ContactPersons

Table Specific Information

Select

Insert

Update

Delete

Columns

Contacts

Table Specific Information

Select

Insert

Update

Delete

Columns

CreditNoteInvoicesCredited

Table Specific Information

Select

Columns