Create a connection to Zoho Inventory by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. 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.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

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:

1. 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.
2. 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.
3. 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 path 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.

1. 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.
2. 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.

1. 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.
2. Log in and grant permissions to the Sync App. You are then redirected to the callback URL, which contains the verifier code.
3. 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 file.

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 file containing the encrypted OAuth authentication values. Make sure this file 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 path 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 file gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

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.

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.

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.

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.

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

Generally, querying Zoho Inventory tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

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.

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.

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	Date	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	String	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.

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.

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

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.

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	Date	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	Date	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.

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

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.

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.

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.

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.

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.

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.

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.

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	Date	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	String	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.

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

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.

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	Date	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	Date	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.

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	Date	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	Date	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.

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.

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

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

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.

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.

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

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.