Establishing a Connection

Adding a Connection to Zoho CRM

To add a connection to Zoho CRM:

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

For required properties, see the Settings tab.

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

Connecting to Zoho CRM

Set the following connection properties to connect:

Region: the region associated with the domain of your Zoho CRM server URL.
Schema: the Zoho CRM version (v2, v2.1, or v4). Each Zoho CRM version has its own data model.

Authenticating to Zoho CRM

Zoho CRM provides two ways to authenticate to data:

To authenticate to your own local data via the desktop (non-browser connection), use the CData-supplied embedded OAuth application.

The Sync App is already registered with Zoho CRM as an OAuth application. As such, it will automatically use the embedded application to connect to local data via a Desktop application.

To avoid repeating the OAuth exchange and eliminate the need to manually set the OAuthAccessToken every time you access local data, set InitiateOAuth to GETANDREFRESH.

Note: The Zoho CRM Sync App defaults UseServerSideFiltering to True for higher performance, but this setting might return incorrect results.

To authenticate to shared data over the network (browser connection), use a custom OAuth application. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to Zoho CRM from three common authentication flows:

Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping. Authenticated via either embedded OAuth or custom OAuth.
Web: access to data via a shared website. Authenticated via custom OAuth only.
Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard. Authenticated via embedded OAuth or custom OAuth.

For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Zoho CRM, see Connection.

When the access token expires, the Sync App refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the Sync App automatically refresh the OAuth access token, do the following:

The first time you connect to data, set the following connection parameters:
- InitiateOAuth: REFRESH.
- OAuthClientId: The client Id in your application settings.
- OAuthClientSecret: The client secret in your application settings.
- OAuthAccessToken: The access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation: The path where you want the Sync App to save the OAuth values, which persist across connections.
On subsequent data connections, set the following:
- InitiateOAuth
- OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAUth access token is the OAuth refresh token.

To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by ) has elapsed, call the RefreshOAuthAccessToken stored procedure.
Set the following connection properties:
- OAuthClientId: The Client Id in your application settings.
- OAuthClientSecret: The Client Secret in your application settings.
Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

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

Advanced Features

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

User Defined Views

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

SSL Configuration

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

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 CRM and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

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

Data Model

CData Sync App models Zoho CRM Modules as relational tables.

Each API Version supported - v2, v2.1 and v4 is assigned its own data model.

CData Sync App Data Models


Data Model	Description
v2	The available tables from the v2 version of ZohoCRM.
v2.1	The available tables from the v2.1 version of ZohoCRM
v4	The available tables from the v4 version of ZohoCRM

Batch Operations

The maximum batch size supported by ZohoCRM's API is 100, so that is the recommended value for the BatchSize connection property as well. Using a value bigger than that is not recommended, since it won't improve the performance of the Sync App in any way.

v2

CData Sync App models Zoho CRM Modules as relational tables.

Zoho CRM APIs

The Zoho CRM Sync App supports the following APIs to query data from the source.

Query API : Uses COQL to query data from Zoho CRM. To use this API, set UseCOQL to True.
Bulk API : Uses the Bulk API to query data from Zoho CRM. To use this API, set UseCOQL to False and APIType to Bulk.
REST API : Uses REST endpoints to query data from Zoho CRM. To use this API, set UseCOQL to False and APIType to REST.

API Limitations

V2 of Zoho CRM imposes limits on the maximum number of rows and columns that interfacing tools such as the CData Sync App can retrieve from its APIs.

The limits vary based on whether you're using the Query API, Bulk API, or REST API. These limits are:

Query API: Maximum of 100,000 rows and 50 columns.
Bulk API: Over 100,000 rows and no more than 200 columns.
REST API: Maximum of 10,000 rows (no column limit).

API Metadata

The columns and values retrieved from tables and views vary based on whether you're using the Query API, Bulk API, or REST API. These variations are:

Query API
- For Lookup type columns, the *_Id is displayed and has a value, but *_Name doesn't appear.
- For *Owner and *ModifiedBy columns, *_Id, *_firstname, and *_lastname are displayed and have values, but *_Name doesn't appear.
Bulk API
- For Lookup type columns, the *_Id and _Name are displayed, but only *_Id has a value.
- For *Owner and *ModifiedBy columns, *_Id, *_Name, *_firstname, and *_lastname are displayed, but *_Name has no value.
REST API
- For Lookup type columns, the *_Id and _Name are displayed and both have values.
- For *Owner and *ModifiedBy columns, *_Id, *_Name, *_firstname, and *_lastname are displayed, but *_firstname and *_lastname have no values.

Using Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to the Zoho CRM APIs and then processes the rest of the query within the Sync App. The following sections document API limitations and requirements.

Tables

The Sync App connects to Zoho CRM and retrieves the list of Tables and the metadata for the tables by calling the appropriate Web services. Any changes you make to your Zoho CRM account, such as adding a custom module, adding a custom field, or changing the data type of a field, occur immediately when you connect using the Sync App. Tables shows an example, based on the Zoho CRM development environment, of what the entities in your account may look like.

Note: The Bulk API is not supported by the Notes table. Due to this, if you are using the Bulk API, the Sync App will instead use the REST API (with its associated limitations) when working with notes data.

Views

Most Views are defined in static configuration files. Custom Views are not. Instead, custom views are dynamically retrieved by connecting to Zoho CRM, calling the appropriate Web service, and retrieving the list of custom views from the metadata returned. Any changes you make to your Zoho CRM account, such as adding a new custom view, occur immediately when you connect using the Sync App.

To use Custom Views, set the IncludeCustomViews property to true. Its default value is false since custom views introduce an overhead when retrieving the list of tables and views.

Criteria applied in the custom view (either when creating it or when editing it in the UI) will be preserved in CData Zoho CRM Sync App. Nonetheless, further filtering on records is available at any time.

To use Relative Views set the IncludeRelatedLists property to true. Its default value is false since related views introduce an overhead when retrieving the list of tables and views.

EntityId is required to fetch the related module data. This field refers to the parent module Id.

Stored Procedures

Stored Procedures provides additional capabilities in the Zoho CRM API, including working with files.

Tables

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

Zoho CRM Connector for CData Sync Tables


Name	Description
Accounts	Create, update, delete, and query information regarding accounts.
Activities	Delete, and query information regarding activities.
Attachments	Delete, and query information regarding attachments.
Calls	Create, update, delete, and query information regarding calls.
Campaigns	Create, update, delete, and query information regarding campaigns.
Cases	Create, update, delete, and query information regarding cases.
ContactRoles	Get, add, update, or delete the list of contact roles
Contacts	Create, update, delete, and query information regarding contacts.
Currencies	Get, add or update currencies to your organization.
Deals	Create, update, delete, and query information regarding deals.
Events	Create, update, delete, and query information regarding events.
Invoices	Create, update, delete, and query information regarding invoices. Not available in free and standard ZohoCRM accounts.
Leads	Create, update, delete, and query information regarding Leads.
Notes	Create, update, delete, and query information regarding notes.
Pipeline	To fetch the details of all or a specific pipeline in the Deals module. It works only with ApiVersion=2.1.
PriceBooks	Create, update, delete, and query information regarding price books. Not available in free and standard ZohoCRM accounts.
Products	Create, update, delete, and query information regarding products.
PurchaseOrders	Create, update, delete, and query information regarding purchase orders. Not available in free and standard ZohoCRM accounts.
Quotes	Create, update, delete, and query information regarding quotes. Not available in free and standard ZohoCRM accounts.
SalesOrders	Create, update, delete, and query information regarding sales orders. Not available in free and standard ZohoCRM accounts.
Solutions	Create, update, delete, and query information regarding solutions.
Tasks	Create, update, delete, and query information regarding tasks.
Vendors	Create, update, delete, and query information regarding vendors.

Accounts

Create, update, delete, and query information regarding accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side. The rest of the filter is executed client-side within the Sync App.

Insert

INSERT INTO Accounts(AccountName) VALUES('my name')

Required fields: AccountName.

Any field which is not read-only (ReadOnly = false in the table below below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Accounts WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Accounts SET Description = 'Updated from API' WHERE Id = '3152079000000153079'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
AccountOwner_Id	String	False	AccountOwner Id
AccountOwner_FirstName	String	True	AccountOwner FirstName
AccountOwner_LastName	String	True	AccountOwner LastName
AccountOwner_Email	String	True	AccountOwner Email
AccountOwner_Name	String	True	AccountOwner Name
Rating	String	False	Rating
AccountName	String	False	AccountName
Phone	String	False	Phone
Fax	String	False	Fax
ParentAccount_Id	String	False	ParentAccount Id
ParentAccount_Name	String	True	ParentAccount Name
Website	String	False	Website
TickerSymbol	String	False	TickerSymbol
AccountType	String	False	AccountType
Ownership	String	False	Ownership
Industry	String	False	Industry
Employees	Int	False	Employees
AnnualRevenue	Decimal	False	AnnualRevenue
SICCode	Int	False	SICCode
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
LastActivityTime	Datetime	True	LastActivityTime
AccountNumber	Long	False	AccountNumber
AccountSite	String	False	AccountSite
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
Description	String	False	Description
AccountImage	String	False	AccountImage
ChangeLogTime	Datetime	True	ChangeLogTime
Locked	Bool	True	Locked
LastEnrichedTime	Datetime	True	LastEnrichedTime
EnrichStatus	String	True	EnrichStatus

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Activities

Delete, and query information regarding activities.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

DueDate supports the '=' operator.
ClosedTime supports the '=' operator.
Location supports the '=, LIKE' operators.
From supports the '=' operator.
To supports the '=' operator.
Check-InTime supports the '=' operator.
Check-InComment supports the '=, LIKE'.
Check-InSub-Locality supports the '=, LIKE' operators.
Check-InCity supports the '=, LIKE' operators.
Check-InState supports the '=, LIKE' operators.
Check-InCountry supports the '=, LIKE' operators.
ZipCode supports the '=, LIKE' operators.
Check-InAddress supports the '=, LIKE' operators.
CheckedInStatus supports the '=, LIKE' operators.
CallStartTime supports the '=' operator.
CallDuration supports the '=, LIKE' operators.
CallResult supports the '=, LIKE' operators.
Reminder supports the '=, LIKE' operators.
CallStatus supports the '=, LIKE' operators.
Subject supports the '=, LIKE' operators.
CreatedTime supports the '=' operator.
ModifiedTime supports the '=' operator.
ActivityType supports the '=, LIKE' operators.
Description supports the '=, LIKE' operators.

For example, the following queries are processed server side:

SELECT * FROM Activities WHERE Id = '3152079000000154214'

SELECT * FROM Activities WHERE Subject = 'event'

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Activities WHERE Id = '3152079000000156229'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
ActivityOwner_Id	String	False	ActivityOwner Id
ActivityOwner_FirstName	String	True	ActivityOwner FirstName
ActivityOwner_LastName	String	True	ActivityOwner LastName
ActivityOwner_Email	String	True	ActivityOwner Email
ActivityOwner_Name	String	True	ActivityOwner Name
Subject	String	False	Subject
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedAt	Datetime	False	CreatedAt
ModifiedAt	Datetime	False	ModifiedAt
ActivityType	String	False	ActivityType
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
Description	String	False	Description
DueDate	Date	False	DueDate
Status	String	False	Status
Priority	String	False	Priority
ClosedTime	Datetime	True	ClosedTime
Repeat_Id	String	False	Repeat Id
Repeat_Name	String	True	Repeat Name
Tag	String	False	Tag
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime
Location	String	False	Location
Allday	Bool	False	Allday
From	Datetime	False	From
To	Datetime	False	To
Participants	String	False	Participants
Check-InTime	Datetime	True	Check-InTime
Check-InBy_Id	String	False	Check-InBy Id
Check-InBy_Name	String	True	Check-InBy Name
Check-InComment	String	True	Check-InComment
Check-InSub-Locality	String	True	Check-InSub-Locality
Check-InCity	String	True	Check-InCity
Check-InState	String	True	Check-InState
Check-InCountry	String	True	Check-InCountry
Latitude	Double	True	Latitude
Longitude	Double	True	Longitude
ZipCode	String	True	ZipCode
Check-InAddress	String	True	Check-InAddress
CheckedInStatus	String	True	CheckedInStatus
CallType	String	False	CallType
CallPurpose	String	False	CallPurpose
CallStartTime	Datetime	False	CallStartTime
CallDuration	String	False	CallDuration
CallDuration(inseconds)	Int	False	CallDuration(inseconds)
CallResult	String	False	CallResult
CTIEntry	Bool	False	CTIEntry
Reminder	String	False	Reminder
CallStatus	String	False	CallStatus
CallAgenda	String	False	CallAgenda
CallerID	String	True	CallerID
DialledNumber	String	True	DialledNumber
VoiceRecording	String	False	VoiceRecording

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
Converted	Bool	To get the list of converted records.
Approved	Bool	To retrieve the list of approved records. Default value is true.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Attachments

Delete, and query information regarding attachments.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

SELECT * FROM Attachments

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Attachments WHERE Id = '3152079000000431011'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
AttachmentOwner_Id	String	False	AttachmentOwner Id
AttachmentOwner_FirstName	String	True	AttachmentOwner FirstName
AttachmentOwner_LastName	String	True	AttachmentOwner LastName
AttachmentOwner_Email	String	True	AttachmentOwner Email
AttachmentOwner_Name	String	True	AttachmentOwner Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
CreatedAt	Datetime	True	CreatedAt
ModifiedAt	Datetime	True	ModifiedAt
FileName	String	False	FileName
Size	String	False	Size
ParentID_Id	String	False	ParentID Id
ParentID_Name	String	True	ParentID Name
ModuleName	String	False	ModuleName
Editable	String	False	Editable
FileId	String	False	FileId
Type	String	False	Type
State	String	False	State
LinkUrl	String	False	LinkUrl

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
Converted	Bool	To get the list of converted records.
Approved	Bool	To retrieve the list of approved records. Default value is true.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Calls

Create, update, delete, and query information regarding calls.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Calls (Subject, ModuleName, RelatedTo_Id,CallType,CallStartTime) VALUES ('A test call', 'Accounts', '5768552000000433001','Outbound','May 20, 2023 12:00 AM')

Required fields: Subject, ModuleName, CallType, CallStartTime and ContactName_Id if ModuleName = Contacts and RelatedTo_Id if any other modulename is specified.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Calls WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Calls SET Subject = 'Updated from API' WHERE Id = '3152079000000484001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
CallOwner_Id	String	False	CallOwner Id
CallOwner_FirstName	String	True	CallOwner FirstName
CallOwner_LastName	String	True	CallOwner LastName
CallOwner_Email	String	True	CallOwner Email
CallOwner_Name	String	True	CallOwner Name
Subject	String	False	Subject
CallType	String	False	CallType
CallPurpose	String	False	CallPurpose
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
CallStartTime	Datetime	False	CallStartTime
CallDuration	String	False	CallDuration
CallDuration(inseconds)	Int	False	CallDuration(inseconds)
Description	String	False	Description
CallResult	String	False	CallResult
CTIEntry	Bool	False	CTIEntry
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Reminder	String	False	Reminder
CallStatus	String	True	CallStatus
Tag	String	False	Tag
LastActivityTime	Datetime	False	LastActivityTime
CallAgenda	String	False	CallAgenda
CallerID	String	True	CallerID
DialledNumber	String	True	DialledNumber
ModuleName	String	False	ModuleName

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Campaigns

Create, update, delete, and query information regarding campaigns.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Campaigns (CampaignName) VALUES ('a test campaign')

Required fields: CampaignName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Campaigns WHERE Id = '3152079000000485001'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Campaigns SET CampaignName = 'Updated from API' WHERE Id = '3152079000000485001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
CampaignOwner_Id	String	False	CampaignOwner Id
CampaignOwner_FirstName	String	True	CampaignOwner FirstName
CampaignOwner_LastName	String	True	CampaignOwner LastName
CampaignOwner_Email	String	True	CampaignOwner Email
CampaignOwner_Name	String	True	CampaignOwner Name
Type	String	False	Type
CampaignName	String	False	CampaignName
Status	String	False	Status
StartDate	Date	False	StartDate
EndDate	Date	False	EndDate
ExpectedRevenue	Decimal	False	ExpectedRevenue
BudgetedCost	Decimal	False	BudgetedCost
ActualCost	Decimal	False	ActualCost
ExpectedResponse	Long	False	ExpectedResponse
Numberssent	Long	False	Numberssent
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Description	String	False	Description
ParentCampaign_Id	String	False	ParentCampaign Id
ParentCampaign_Name	String	True	ParentCampaign Name
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Cases

Create, update, delete, and query information regarding cases.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Cases (Email, Priority, Description) VALUES ('[email protected]', 'Medium', 'A simple test case')

Required fields: None.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Cases WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Cases SET Priority = 'Low' WHERE Id = '3152079000000473022'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
CaseReason	String	False	CaseReason
CaseNumber	String	True	CaseNumber
CaseOwner_Id	String	False	CaseOwner Id
CaseOwner_FirstName	String	True	CaseOwner FirstName
CaseOwner_LastName	String	True	CaseOwner LastName
CaseOwner_Email	String	True	CaseOwner Email
CaseOwner_Name	String	True	CaseOwner Name
Status	String	False	Status
ProductName_Id	String	False	ProductName Id
ProductName_Name	String	True	ProductName Name
Priority	String	False	Priority
Type	String	False	Type
CaseOrigin	String	False	CaseOrigin
Subject	String	False	Subject
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
DealName_Id	String	False	DealName Id
DealName_Name	String	True	DealName Name
No.ofcomments	Int	True	No.ofcomments
ReportedBy	String	False	ReportedBy
Email	String	False	Email
Phone	String	False	Phone
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Description	String	False	Description
InternalComments	String	False	InternalComments
Solution	String	False	Solution
AddComment	String	False	AddComment
Comments	String	True	Comments
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

ContactRoles

Get, add, update, or delete the list of contact roles

Table-Specific Information

Select

SELECT * FROM ContactRoles

Insert

Insert INTO ContactRoles(SequenceNumber, Name) VALUES(8, 'TEST3')

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM ContactRoles WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE ContactRoles SET Name='Sales Lead 1' where Id= '2732548000006917001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Represents the unique ID of the contact role.
SequenceNumber	Int	False	Represents the position of the contact role in the picklist in CRM UI.
Name	String	False	Represents the name of the contact role.

Contacts

Create, update, delete, and query information regarding contacts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Contacts (FirstName, LastName, Email) VALUES ('John', 'Smith', '[email protected]')

Required fields: LastName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Contacts WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Contacts SET Description = 'John helped us in the past with setting up the servers.' WHERE Id = '3152079000000484021'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
ContactOwner_Id	String	False	ContactOwner Id
ContactOwner_FirstName	String	True	ContactOwner FirstName
ContactOwner_LastName	String	True	ContactOwner LastName
ContactOwner_Email	String	True	ContactOwner Email
ContactOwner_Name	String	True	ContactOwner Name
LeadSource	String	False	LeadSource
FirstName	String	False	FirstName
LastName	String	False	LastName
FullName	String	False	FullName
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
VendorName_Id	String	False	VendorName Id
VendorName_Name	String	True	VendorName Name
Email	String	False	Email
Title	String	False	Title
Department	String	False	Department
Phone	String	False	Phone
HomePhone	String	False	HomePhone
OtherPhone	String	False	OtherPhone
Fax	String	False	Fax
Mobile	String	False	Mobile
DateofBirth	Date	False	DateofBirth
Assistant	String	False	Assistant
AsstPhone	String	False	AsstPhone
EmailOptOut	Bool	False	EmailOptOut
SkypeID	String	False	SkypeID
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Salutation	String	False	Salutation
SecondaryEmail	String	False	SecondaryEmail
LastActivityTime	Datetime	True	LastActivityTime
Twitter	String	False	Twitter
Tag	String	False	Tag
MailingStreet	String	False	MailingStreet
OtherStreet	String	False	OtherStreet
MailingCity	String	False	MailingCity
OtherCity	String	False	OtherCity
MailingState	String	False	MailingState
OtherState	String	False	OtherState
MailingZip	String	False	MailingZip
OtherZip	String	False	OtherZip
MailingCountry	String	False	MailingCountry
OtherCountry	String	False	OtherCountry
Description	String	False	Description
ContactImage	String	False	ContactImage
ReportingTo_Id	String	False	ReportingTo Id
ReportingTo_Name	String	True	ReportingTo Name
UnsubscribedMode	String	True	UnsubscribedMode
UnsubscribedTime	Datetime	True	UnsubscribedTime
ChangeLogTime	Datetime	True	ChangeLogTime
Locked	Bool	True	Locked
LastEnrichedTime	Datetime	True	LastEnrichedTime
EnrichStatus	String	True	EnrichStatus

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Currencies

Get, add or update currencies to your organization.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Currencies WHERE Id = '1234';

Insert

INSERT INTO Currencies (ISO_Code, Name, ExchangeRate) VALUES ('1234', 'hello','1.000');

Bulk Insert operation:

INSERT INTO Currencies#TEMP (id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code) VALUES ('4150868000000236307', 'cdata1','$','true','1.0000','period','comma','2','true','2');

INSERT INTO Currencies#TEMP (id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code) VALUES ('1234', 'cdata','$','true','2.0000','period','comma','3','true','3');

INSERT INTO Currencies (id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code) SELECT id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code FROM currencies#TEMP;

Required fields: Name, ISO_Code, ExchangeRate.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Update

UPDATE Currencies SET symbol = 'hello', FormatDecimalSeparator = 'period', FormatThousandSeparator = 'comma',FormatDecimalPlaces = '2',prefixsymbol = 'true',exchangerate = '1.0000' WHERE Id = '1234';

Bulk Update Operation:

UPDATE Currencies SET symbol = '$',FormatDecimalSeparator = 'period',FormatThousandSeparator = 'comma',FormatDecimalPlaces = '2';

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated. NOTE: if Id field is not specified in the query, PostData will be created for each id ( driver will execute bulk update operation for each currency id).

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Represents the unique ID of the currency.
Name	String	False	Represents the name of the currency.
Symbol	String	False	Represents the symbol of the currency.
IsActive	Bool	False	Represents the status of the currency.
ExchangeRate	Double	False	Represents the exchange rate of the currency.
FormatDecimalSeparator	String	False	The decimal separator separates the integer part of the currency from its fractional part.
FormatThousandSeparator	String	False	The thousand separator separates groups of thousands in a currency.
FormatDecimalPlaces	String	False	Represents the number of decimal places allowed for the currency.
ModifiedByName	String	True	Represents the name of the user who last modified the currency details.
ModifiedByid	String	True	Represents the ID of the user who last modified the currency details.
PrefixSymbol	Bool	False	Represents if the currency has a prefix symbol.
IsBase	Bool	True	Represents if the currency is the base currency.
CreatedAt	Datetime	True	Represents the date and time at which the currency was created.
ModifiedAt	Datetime	True	Represents the date and time at which the currency was last modified.
ISO_Code	String	False	Represents the ISO code of the currency.

Deals

Create, update, delete, and query information regarding deals.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Deals (DealName, Stage) VALUES ('Converting company XYZ into our client.', 'Qualification')

Required fields: DealName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Deals WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Deals SET Description = 'Updated from API' WHERE Id = '3152079000000153079'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
DealOwner_Id	String	False	DealOwner Id
DealOwner_FirstName	String	True	DealOwner FirstName
DealOwner_LastName	String	True	DealOwner LastName
DealOwner_Email	String	True	DealOwner Email
DealOwner_Name	String	True	DealOwner Name
Amount	Decimal	False	Amount
DealName	String	False	DealName
ClosingDate	Date	False	ClosingDate
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
Stage	String	False	Stage
Type	String	False	Type
Probability(%)	Int	False	Probability(%)
ExpectedRevenue	Decimal	True	ExpectedRevenue
NextStep	String	False	NextStep
LeadSource	String	False	LeadSource
CampaignSource_Id	String	False	CampaignSource Id
CampaignSource_Name	String	True	CampaignSource Name
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
LastActivityTime	Datetime	True	LastActivityTime
LeadConversionTime	Int	True	LeadConversionTime
SalesCycleDuration	Int	True	SalesCycleDuration
OverallSalesDuration	Int	True	OverallSalesDuration
Tag	String	False	Tag
Description	String	False	Description
ChangeLogTime	Datetime	True	ChangeLogTime
Locked	Bool	True	Locked
ReasonForLoss	String	False	ReasonForLoss

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Events

Create, update, delete, and query information regarding events.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Events (Title, `From`, To) VALUES ('A test event', '2018/05/29 18:00:00', '2018/05/29 20:30:00')

INSERT INTO Events (Title, `From`, To, ModuleName) VALUES ('A test event', '2018/05/29 18:00:00', '2018/05/29 20:30:00', 'Contacts')

INSERT INTO Events (Title, `From`, To, ModuleName, RelatedTo_Id) VALUES ('A test event', '2018/05/29 18:00:00', '2018/05/29 20:30:00', 'Contacts', '2788704000120533263')

Required fields: Title, From, To, ModuleName if RelatedTo_Id is specified..

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Events WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Events SET Description = 'Changed from the API.' WHERE Id = '3152079000000154219'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

NOTE: This table is supported only in v2.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
Title	String	False	Title
Location	String	False	Location
Allday	Bool	False	Allday
From	Datetime	False	From
To	Datetime	False	To
Host_Id	String	False	Host Id
Host_FirstName	String	True	Host FirstName
Host_LastName	String	True	Host LastName
Host_Email	String	True	Host Email
Host_Name	String	True	Host Name
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
Repeat_Id	String	False	Repeat Id
Repeat_Name	String	True	Repeat Name
Reminder	String	False	Reminder
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Participants	String	False	Participants
Description	String	False	Description
Check-InTime	Datetime	True	Check-InTime
Check-InBy_Id	String	False	Check-InBy Id
Check-InBy_Name	String	True	Check-InBy Name
Check-InComment	String	True	Check-InComment
Check-InSub-Locality	String	True	Check-InSub-Locality
Check-InCity	String	True	Check-InCity
Check-InState	String	True	Check-InState
Check-InCountry	String	True	Check-InCountry
Latitude	Double	True	Latitude
Longitude	Double	True	Longitude
ZipCode	String	True	ZipCode
Check-InAddress	String	True	Check-InAddress
CheckedInStatus	String	True	CheckedInStatus
Tag	String	False	Tag
LastActivityTime	Datetime	False	LastActivityTime
ModuleName	String	False	ModuleName

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Invoices

Create, update, delete, and query information regarding invoices. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Invoices (Status, DueDate, Subject, ProductDetails) VALUES ('Created', '2018/06/06', 'An invoice for the purchase of products XYZ.', '[
            { 
              "product": { 
                "Product_Code": "12342321", 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, InvoicedItems.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Invoices WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Invoices SET Description = 'Updated from API' WHERE Id = '3152079000000153079'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
InvoiceOwner_Id	String	False	InvoiceOwner Id
InvoiceOwner_FirstName	String	True	InvoiceOwner FirstName
InvoiceOwner_LastName	String	True	InvoiceOwner LastName
InvoiceOwner_Email	String	True	InvoiceOwner Email
InvoiceOwner_Name	String	True	InvoiceOwner Name
InvoiceNumber	String	True	InvoiceNumber
Subject	String	False	Subject
SalesOrder_Id	String	False	SalesOrder Id
SalesOrder_Name	String	True	SalesOrder Name
InvoiceDate	Date	False	InvoiceDate
PurchaseOrder	String	False	PurchaseOrder
DueDate	Date	False	DueDate
ExciseDuty	Decimal	False	ExciseDuty
SalesCommission	Decimal	False	SalesCommission
Status	String	False	Status
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
ProductDetails	String	False	ProductDetails
SubTotal	Decimal	True	SubTotal
Discount	Decimal	False	Discount
Tax	Decimal	True	Tax
Adjustment	Decimal	False	Adjustment
GrandTotal	Decimal	True	GrandTotal
TermsandConditions	String	False	TermsandConditions
Description	String	False	Description
DealName_Id	String	False	DealName Id
DealName_Name	String	True	DealName Name
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Leads

Create, update, delete, and query information regarding Leads.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Leads(FirstName, LastName, Title) VALUES('Alert', 'Bat', 'Mr')
INSERT INTO LEADS(FirstName, LastName, Email, Trigger) VALUES('Enthusiastic', 'Panda', '[email protected]', 'workflow,approval,blueprint')

Required fields: LastName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Leads WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Leads SET Description = 'Changed from the API.' WHERE Id = '3152079000000488014'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
LeadOwner_Id	String	False	LeadOwner Id
LeadOwner_FirstName	String	True	LeadOwner FirstName
LeadOwner_LastName	String	True	LeadOwner LastName
LeadOwner_Email	String	True	LeadOwner Email
LeadOwner_Name	String	True	LeadOwner Name
Company	String	False	Company
FirstName	String	False	FirstName
LastName	String	False	LastName
FullName	String	False	FullName
Title	String	False	Title
Email	String	False	Email
Phone	String	False	Phone
Fax	String	False	Fax
Mobile	String	False	Mobile
Website	String	False	Website
LeadSource	String	False	LeadSource
LeadStatus	String	False	LeadStatus
Industry	String	False	Industry
No.ofEmployees	Int	False	No.ofEmployees
AnnualRevenue	Decimal	False	AnnualRevenue
Rating	String	False	Rating
EmailOptOut	Bool	False	EmailOptOut
SkypeID	String	False	SkypeID
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Salutation	String	False	Salutation
SecondaryEmail	String	False	SecondaryEmail
LastActivityTime	Datetime	True	LastActivityTime
Twitter	String	False	Twitter
Tag	String	False	Tag
Street	String	False	Street
City	String	False	City
State	String	False	State
ZipCode	String	False	ZipCode
Country	String	False	Country
Description	String	False	Description
LeadImage	String	False	LeadImage
UnsubscribedMode	String	True	UnsubscribedMode
UnsubscribedTime	Datetime	True	UnsubscribedTime
ChangeLogTime	Datetime	True	ChangeLogTime
Locked	Bool	True	Locked
LastEnrichedTime	Datetime	True	LastEnrichedTime
EnrichStatus	String	True	EnrichStatus

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Notes

Create, update, delete, and query information regarding notes.

Table-Specific Information

Note: The Bulk API is not supported by the Notes table. Due to this, if you are using the Bulk API (UseCOQL set to False and APIType set to Bulk), the Sync App will instead use the REST API (with its associated limitations) when working with notes data. Refer to v2, v2.1, or v4 (in accordance with the value you set for Schema) to see the limits imposed by the REST API.

Select

The Sync App uses the Zoho CRM 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.

NoteTitle supports the '=, LIKE' operators.
NoteContent supports the '=, LIKE' operators.
CreatedTime supports the '=' operator.
ModifiedTime supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Notes WHERE Id = '3152079000000153079'

SELECT * FROM Notes WHERE NoteTitle = 'Deal details'

Insert

INSERT INTO Notes (ParentID_Id, ModuleName, NoteContent) VALUES ('3276571000000184007', 'Leads', 'Janet converted this lead.')

Required fields: ParentID_Id (the Id of the item in which you are inserting the note to), ModuleName (the API name of the module you are inserting the note to), NoteContent.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Notes WHERE Id = '3152079000000488014'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Notes SET NoteTitle = 'Changed from the API.' WHERE Id = '3152079000000304003'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
NoteOwner_Id	String	False	NoteOwner Id
NoteOwner_FirstName	String	True	NoteOwner FirstName
NoteOwner_LastName	String	True	NoteOwner LastName
NoteOwner_Email	String	True	NoteOwner Email
NoteOwner_Name	String	True	NoteOwner Name
NoteTitle	String	False	NoteTitle
NoteContent	String	False	NoteContent
ParentID_Id	String	False	ParentID Id
ParentID_Name	String	True	ParentID Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Associated_Id	Long	False	Associated_Id
ModuleName	String	False	ModuleName
Attachments	String	False	Attachments
Editable	String	False	Editable
IsSharedToClient	String	False	IsSharedToClient
State	String	False	State
VoiceNote	String	False	VoiceNote

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Pipeline

To fetch the details of all or a specific pipeline in the Deals module. It works only with ApiVersion=2.1.

Table-Specific Information

Select

The Sync App will use the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

For example, the following queries are processed server side:

SELECT * FROM Pipeline WHERE Id = '228122000000223002' AND LayoutId = '228122000000000173'

SELECT * FROM Pipeline WHERE  LayoutId = '228122000000000173'

Insert

The maps values can be obtained by using the Fields view.

Insert Into Pipeline (LayoutId,DisplayValue,default,maps) VALUES ('4917206000000318488','Test_pipee11','true','[\n" +
            "        {\n" +
            "          \"display_value\": \"Qualification\",\n" +
            "          \"sequence_number\": \"2\",\n" +
            "          \"id\": \"4917206000000006801\"\n" +
            "        },\n" +
            "        {\n" +
            "          \"display_value\": \"Needs Analysis\",\n" +
            "          \"sequence_number\": \"1\",\n" +
            "          \"id\": \"4917206000000006803\"\n" +
            "        }\n" +
            "      ]')

Required fields: LayoutId, DisplayValue, Default and maps.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Update

You must specify the Id and LayoutId in the WHERE clause when executing an update against this table.

UPDATE Pipeline Set DisplayValue = 'Pipeline_test12', default = 'false', maps = '[\n" +
            "        {\n" +
            "          \"display_value\": \"Qualification\",\n" +
            "          \"sequence_number\": \"2\",\n" +
            "          \"id\": \"4917206000000006801\"\n" +
            "        },\n" +
            "        {\n" +
            "          \"display_value\": \"Needs Analysis\",\n" +
            "          \"sequence_number\": \"1\",\n" +
            "          \"id\": \"4917206000000006803\"\n" +
            "        }\n" +
            "      ]' WHERE Id = '4917206000000357004' AND LayoutId = '4917206000000318488' ")

Required fields: Id,LayoutId.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Delete

The users can use the TransferAndDeltePipeline stored procedure to delete the pipeline.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	A unique numeric identifier for the profile.
DisplayValue	String	False	The name of the pipeline.
Default	Boolean	False	The default value of the pipeline.
ActualValue	String	False	The actual name of the pipeline.
Maps	String	False	The different stages that a deal has to pass through in the sales pipeline.
LayoutId [KEY]	String	False	The unique ID of the layout in the Deals module you want to fetch the pipeline's details from.

PriceBooks

Create, update, delete, and query information regarding price books. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO PriceBooks (PriceBookName, Active) VALUES ('pricebook_2018', true)

Required fields: PriceBookName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM PriceBooks WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE PriceBooks SET Description = 'Changed from the API.' WHERE Id = '3152079000000488023'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
PriceBookOwner_Id	String	False	PriceBookOwner Id
PriceBookOwner_FirstName	String	True	PriceBookOwner FirstName
PriceBookOwner_LastName	String	True	PriceBookOwner LastName
PriceBookOwner_Email	String	True	PriceBookOwner Email
PriceBookOwner_Name	String	True	PriceBookOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
PriceBookName	String	False	PriceBookName
Active	Bool	False	Active
PricingModel	String	False	PricingModel
Tag	String	False	Tag
PricingDetails	String	False	PricingDetails
Description	String	False	Description
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Products

Create, update, delete, and query information regarding products.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Products(ProductName, ProductActive) VALUES('C-3PO', true)

Required fields: ProductName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Products WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Products SET Description = 'Changed from the API.' WHERE Id = '3152079000000487023'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
ProductOwner_Id	String	False	ProductOwner Id
ProductOwner_FirstName	String	True	ProductOwner FirstName
ProductOwner_LastName	String	True	ProductOwner LastName
ProductOwner_Email	String	True	ProductOwner Email
ProductOwner_Name	String	True	ProductOwner Name
ProductName	String	False	ProductName
ProductCode	String	False	ProductCode
VendorName_Id	String	False	VendorName Id
VendorName_Name	String	True	VendorName Name
ProductActive	Bool	False	ProductActive
Manufacturer	String	False	Manufacturer
ProductCategory	String	False	ProductCategory
SalesStartDate	Date	False	SalesStartDate
SalesEndDate	Date	False	SalesEndDate
SupportStartDate	Date	False	SupportStartDate
SupportEndDate	Date	False	SupportEndDate
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
UnitPrice	Decimal	False	UnitPrice
CommissionRate	Decimal	False	CommissionRate
Tax	String	False	Tax
Taxable	Bool	False	Taxable
UsageUnit	String	False	UsageUnit
QtyOrdered	Double	False	QtyOrdered
QuantityinStock	Double	False	QuantityinStock
ReorderLevel	Double	False	ReorderLevel
Handler_Id	String	False	Handler Id
Handler_Name	String	True	Handler Name
QuantityinDemand	Double	False	QuantityinDemand
Description	String	False	Description
ProductImage	String	False	ProductImage
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

PurchaseOrders

Create, update, delete, and query information regarding purchase orders. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO PurchaseOrders (Subject, ProductDetails) VALUES ('Purchase Order', '[
            { 
              "product": { 
                "Product_Code": "12342321", 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, Purchase_Items

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM PurchaseOrders WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE PurchaseOrders SET Description = 'Changed from the API.' WHERE Id = '3152079000000492001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
RequisitionNumber	String	False	RequisitionNumber
TrackingNumber	String	False	TrackingNumber
PONumber	String	False	PONumber
Subject	String	False	Subject
VendorName_Id	String	False	VendorName Id
VendorName_Name	String	True	VendorName Name
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
PODate	Date	False	PODate
DueDate	Date	False	DueDate
Carrier	String	False	Carrier
ExciseDuty	Decimal	False	ExciseDuty
SalesCommission	Decimal	False	SalesCommission
Status	String	False	Status
PurchaseOrderOwner_Id	String	False	PurchaseOrderOwner Id
PurchaseOrderOwner_FirstName	String	True	PurchaseOrderOwner FirstName
PurchaseOrderOwner_LastName	String	True	PurchaseOrderOwner LastName
PurchaseOrderOwner_Email	String	True	PurchaseOrderOwner Email
PurchaseOrderOwner_Name	String	True	PurchaseOrderOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
ProductDetails	String	False	ProductDetails
SubTotal	Decimal	True	SubTotal
Discount	Decimal	False	Discount
Tax	Decimal	True	Tax
Adjustment	Decimal	False	Adjustment
GrandTotal	Decimal	True	GrandTotal
TermsandConditions	String	False	TermsandConditions
Description	String	False	Description
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Quotes

Create, update, delete, and query information regarding quotes. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Quotes (Subject, QuotedItems) VALUES ('QuotedItems', '[
            { 
              "product": { 
                "Product_Code": "12342321", 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, QuotedItems.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Quotes WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Quotes SET Description = 'Changed from the API.' WHERE Id = '3152079000000490009'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
Team	String	False	Team
QuoteNumber	String	True	QuoteNumber
Subject	String	False	Subject
DealName_Id	String	False	DealName Id
DealName_Name	String	True	DealName Name
QuoteStage	String	False	QuoteStage
ValidUntil	Date	False	ValidUntil
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
Carrier	String	False	Carrier
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
QuoteOwner_Id	String	False	QuoteOwner Id
QuoteOwner_FirstName	String	True	QuoteOwner FirstName
QuoteOwner_LastName	String	True	QuoteOwner LastName
QuoteOwner_Email	String	True	QuoteOwner Email
QuoteOwner_Name	String	True	QuoteOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
ProductDetails	String	False	ProductDetails
SubTotal	Decimal	True	SubTotal
Discount	Decimal	False	Discount
Tax	Decimal	True	Tax
Adjustment	Decimal	False	Adjustment
GrandTotal	Decimal	True	GrandTotal
TermsandConditions	String	False	TermsandConditions
Description	String	False	Description
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

SalesOrders

Create, update, delete, and query information regarding sales orders. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO SalesOrders (Subject, ProductDetails) VALUES ('Sales Order', '[
            { 
              "product": { 
                "Product_Code": "12342321", 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, OrderedItems

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM SalesOrders WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE SalesOrders SET Description = 'Changed from the API.' WHERE Id = '3152079000000493027'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
CustomerNo.	String	False	CustomerNo.
SONumber	String	True	SONumber
Subject	String	False	Subject
DealName_Id	String	False	DealName Id
DealName_Name	String	True	DealName Name
PurchaseOrder	String	False	PurchaseOrder
QuoteName_Id	String	False	QuoteName Id
QuoteName_Name	String	True	QuoteName Name
DueDate	Date	False	DueDate
Pending	String	False	Pending
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
Carrier	String	False	Carrier
ExciseDuty	Decimal	False	ExciseDuty
SalesCommission	Decimal	False	SalesCommission
Status	String	False	Status
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
SalesOrderOwner_Id	String	False	SalesOrderOwner Id
SalesOrderOwner_FirstName	String	True	SalesOrderOwner FirstName
SalesOrderOwner_LastName	String	True	SalesOrderOwner LastName
SalesOrderOwner_Email	String	True	SalesOrderOwner Email
SalesOrderOwner_Name	String	True	SalesOrderOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
ProductDetails	String	False	ProductDetails
SubTotal	Decimal	True	SubTotal
Discount	Decimal	False	Discount
Tax	Decimal	True	Tax
Adjustment	Decimal	False	Adjustment
GrandTotal	Decimal	True	GrandTotal
TermsandConditions	String	False	TermsandConditions
Description	String	False	Description
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Solutions

Create, update, delete, and query information regarding solutions.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Sync App.

Insert

INSERT INTO Solutions (SolutionTitle, Status) VALUES ('Converting from XML to JSON', 'Created')

Required fields: SolutionTitle.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Solutions WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Solutions SET Question = 'Changed from the API.' WHERE Id = '3152079000000492018'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
SolutionNumber	String	False	SolutionNumber
SolutionOwner_Id	String	False	SolutionOwner Id
SolutionOwner_FirstName	String	True	SolutionOwner FirstName
SolutionOwner_LastName	String	True	SolutionOwner LastName
SolutionOwner_Email	String	True	SolutionOwner Email
SolutionOwner_Name	String	True	SolutionOwner Name
SolutionTitle	String	False	SolutionTitle
Published	Bool	False	Published
Status	String	False	Status
ProductName_Id	String	False	ProductName Id
ProductName_Name	String	True	ProductName Name
No.ofcomments	Int	True	No.ofcomments
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Question	String	False	Question
Answer	String	False	Answer
AddComment	String	False	AddComment
Comments	String	True	Comments
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Tasks

Create, update, delete, and query information regarding tasks.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Tasks(Subject, Status) VALUES ('Finish sending emails to potential leads.', 'Created')

INSERT INTO Tasks(Subject, Status, ModuleName) VALUES ('Finish sending emails to potential leads.', 'Created', 'Contacts')

INSERT INTO Tasks(Subject, Status, ModuleName, RelatedTo_Id) VALUES ('Finish sending emails to potential leads.', 'Created', 'Contacts', '2788704000120533263')

Required fields: Subject, ModuleName if RelatedTo_Id is specified.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Tasks WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Tasks SET Status = 'In progress' WHERE Id = '3152079000000492026'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
TaskOwner_Id	String	False	TaskOwner Id
TaskOwner_FirstName	String	True	TaskOwner FirstName
TaskOwner_LastName	String	True	TaskOwner LastName
TaskOwner_Email	String	True	TaskOwner Email
TaskOwner_Name	String	True	TaskOwner Name
Subject	String	False	Subject
DueDate	Date	False	DueDate
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
Status	String	False	Status
Priority	String	False	Priority
ClosedTime	Datetime	True	ClosedTime
SendNotificationEmail	Bool	False	SendNotificationEmail
Repeat_Id	String	False	Repeat Id
Repeat_Name	String	True	Repeat Name
Reminder_Id	String	False	Reminder Id
Reminder_Name	String	True	Reminder Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Description	String	False	Description
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime
ModuleName	String	False	ModuleName

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Vendors

Create, update, delete, and query information regarding vendors.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Vendors(VendorName, Email, Website) VALUES('XYZVendor', '[email protected]', 'vendeverything.xyz')

Required fields: VendorName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Vendors WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Vendors SET Description = 'Changed from the API' WHERE Id = '3152079000000492032'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
VendorName	String	False	VendorName
Phone	String	False	Phone
Email	String	False	Email
Website	String	False	Website
GLAccount	String	False	GLAccount
Category	String	False	Category
VendorOwner_Id	String	False	VendorOwner Id
VendorOwner_FirstName	String	True	VendorOwner FirstName
VendorOwner_LastName	String	True	VendorOwner LastName
VendorOwner_Email	String	True	VendorOwner Email
VendorOwner_Name	String	True	VendorOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Street	String	False	Street
City	String	False	City
State	String	False	State
ZipCode	String	False	ZipCode
Country	String	False	Country
Description	String	False	Description
VendorImage	String	False	VendorImage
Locked	Bool	True	Locked
EmailOptOut	Bool	False	EmailOptOut
UnsubscribedMode	String	True	UnsubscribedMode
UnsubscribedTime	Datetime	True	UnsubscribedTime
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Views

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

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

Zoho CRM Connector for CData Sync Views


Name	Description
ActionsPerformed	Query information regarding performed actions.
CustomFieldHistoryTracking	Query information regarding histories for a particular custom field.
Fields	To get the field metadata for the specified module.
InvoiceProductDetails	Query information regarding product details. Not available in free and standard ZohoCRM accounts.
Layouts	To get the layouts metadata for the specified module.
ListFields	Get the field metadata for the specified module.
ModuleAttachedFiles	Retrieves all the files attached to a specified module.
Modules	To get the modules metadata for the specified account.
Organizations	Query information regarding organizations.
PriceBookPricingDetails	Query information regarding pricing details. Not available in free and standard ZohoCRM accounts.
Profiles	Query information regarding profiles.
PurchaseOrderProductDetails	Query information regarding purchase order product details. Not available in free and standard ZohoCRM accounts.
QuoteProductDetails	Query information regarding quote product details. Not available in free and standard ZohoCRM accounts.
RecordCount	To fetch the total number of records in the module.
Roles	Query information regarding roles.
SalesOrderProductDetails	Query information regarding sales order product details. Not available in free and standard ZohoCRM accounts.
StageHistories	Query information regarding stage histories for a particular deal.
Territories	Get the list of territories enabled for your organization.
Users	Query information regarding users.
Visits	Query information regarding recent visits.

ActionsPerformed

Query information regarding performed actions.

Table-Specific Information

Select

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

Note : ActionsPerformed cannot be queried until it is enabled from the UI.

SELECT * FROM ActionsPerformed

Columns


Name	Type	Description
Id [KEY]	String	The Id of the performed action.
ActionType	String	The type of the performed action.
Actions	String	The actions performed.
TimeSpent	String	The time spent performing the action.
ActionPerformedTime	Datetime	The date and time when the action was performed.
ParentID_Id	String	The Id of the parent object where the action was performed.
ParentID_Name	String	The name of the parent object where the action was performed.
ChatAttachment_Id	String	The Id of the chat attachment for the action.
ChatAttachment_Name	String	The name of the chat attachment for the action.

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

CustomFieldHistoryTracking

Query information regarding histories for a particular custom field.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

ModuleName supports the '=' operator.
EntityId supports the '=' operator.
FieldName supports the '=' operator.
HistoryName supports the '=' operator.

All columns used in the criteria are required. Use FieldName to specify the actual name of the tracked custom field and HistoryName to specify the name of the history tracking section. If you want to retrieve data for a specific entity of a module specify EntityId in the criteria. For example, the following query is processed server side:

SELECT * FROM [CustomFieldHistoryTracking] WHERE ModuleName = 'Leads' AND FieldName = 'pickListField' AND HistoryName = 'Pick List 1'

SELECT * FROM [CustomFieldHistoryTracking] WHERE ModuleName = 'Leads' AND FieldName = 'pickListField' AND HistoryName = 'Pick List 1' AND EntityId = '12345665'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the history.
ModuleName	String	A unique numeric identifier for the module instance this custom field tracking belongs to.
EntityId	String	A unique numeric identifier for the module instance this custom field tracking belongs to.
FieldName	String	The name of the custom field.
HistoryName	String	The name of the custom field tracking history.
FieldValue	String	The value of the custom field.
DurationDays	Integer	The duration of this stage.
ModifiedAt	Datetime	The time this historical value was last modified.
ModifiedById	String	The id of the user who modified the value.
ModifiedByName	String	The name of the user who modified the value.
CurrencySymbol	String	The currency symbol for the value.
ProcessFlow	Boolean	The boolean indicating the process flow for this historical value.
Editable	Boolean	The boolean indicating if this historical value can be edited.
Approved	Boolean	The boolean indicating if this historical value has been approved.

Fields

To get the field metadata for the specified module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

ModuleName supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Fields WHERE ModuleName = 'Deals'

Columns


Name	Type	Description
DisplayValue	String	The name of the field.
ActualValue	String	The actual name of the field.
Id	String	The unique identifier of the field
ModuleName	String	The name of the module which the user wants the fields.

InvoiceProductDetails

Query information regarding product details. Not available in free and standard ZohoCRM accounts.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM InvoiceProductDetails WHERE InvoiceId = '3152079000000301143'

NOTE: ProductDetails has been changed to InvoicedItems after v2

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the product detail.
InvoiceId [KEY]	String	A unique numeric identifier for the invoice this product detail belongs to.
ProductId	String	A unique numeric identifier for the id of the product.
ProductCode	String	The code of the product.
ProductName	String	The name of the product.
ProductDescription	String	The description of the product.
Quantity	Double	The quantity of products in this product detail.
Discount	Double	The discount applied to this product detail.
TotalAfterDiscount	Double	The total after discount for this product detail.
NetTotal	Double	The net total for this product detail.
Book	String	The book linked with this product detail.
Tax	Double	The total tax of this product detail.
ListPrice	Double	The listing price of this product detail.
UnitPrice	Double	The unit price of the product.
QuantityInStock	Double	The quantity in stock for this product.
Total	Double	The total price for this product detail.
LineTax	String	A line tax aggregate regarding this product detail.

Layouts

To get the layouts metadata for the specified module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

ModuleName supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM Layouts WHERE ModuleName = 'Deals'

Columns


Name	Type	Description
Id	String	The unique identifier of the layout.
Name	String	Represents the name of the layout.
Type	String	Represents if the section is used or not in the layout.
ModuleName	String	The name of the module which the user wants the layout.

ListFields

Get the field metadata for the specified module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

ModuleName supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM ListFields WHERE ModuleName = 'Deals'

Columns


Name	Type	Description
ApiName	String	The API Name.
AssociationDetails	String	The Association Details.
BlueprintSupported	Boolean	Is Blueprint Supported.
BusinesscardSupported	Boolean	Is Businesscard Supported.
ConvertMappingAccounts	String	The Convert Mapping Accounts.
ConvertMappingContacts	String	The Convert Mapping Contacts.
ConvertMappingDeals	String	The Convert Mapping Deals.
CreatedSource	String	The Created Source.
Crypt	String	The Crypt.
CurrencyPrecision	Integer	The Currency Precision.
CurrencyRoundingOption	String	The Currency Rounding Option.
CustomField	Boolean	Is Custom Field.
DataType	String	The Data Type.
DecimalPlace	Integer	The Decimal Place.
DisplayField	Boolean	Is Display Field.
DisplayLabel	String	The Display Label.
DisplayType	Integer	The Display Type.
External	String	The External.
FieldLabel	String	The Field Label.
FieldReadOnly	Boolean	Is Field ReadOnly.
Filterable	Boolean	Is Filterable.
HistoryTracking	String	The History Tracking.
Id	String	The Id.
JsonType	String	The JSON Type.
Length	Integer	The Length.
MassUpdate	Boolean	Is Mass Update.
PickListValues	String	The Pick List Values.
PickListValuesSortedLexically	Boolean	Are Pick List Values Sorted Lexically.
Profiles	String	The Profiles.
QuickSequenceNumber	String	The QuickSequenceNumber.
ReadOnly	Boolean	Is ReadOnly.
Sortable	Boolean	Is Sortable.
Subform	String	The Subform.
SystemMandatory	Boolean	Is System Mandatory.
Tooltip	String	The Tool tip.
Type	String	The Type.
UiType	Integer	The Ui Type.
ViewTypeCreate	Boolean	Is View Type Create.
ViewTypeEdit	Boolean	Is View Type Edit.
ViewTypeQuickCreate	Boolean	Is View Type Quick Create.
ViewTypeView	Boolean	Is View Type View.
Visible	Boolean	Is Visible.
Webhook	Boolean	Is Webhook.
ModuleName	String	The name of the module which the user wants the fields.

ModuleAttachedFiles

Retrieves all the files attached to a specified module.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

ModuleName supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM ModuleAttachedFiles WHERE ModuleName = "Leads"

Note: The UploadFile and DownloadFile stored procedures will not work as expected if executed in regards to a custom field. They only upload or download files in the "Attachments" section of the module. Uploading and deleting files from a custom field of type "fileupload" can be done only through the UI.

Columns


Name	Type	Description
FileId	String	Id of the file attached to the module.
FileName	String	Name of the file attached to the module.
AttachmentId [KEY]	String	Id of the attachment.
CreatorId	String	Id of the user who uploaded the attachment.
EntityId	String	Id of the entity.
DownloadUrl	String	URL to download the attachment.
PreviewUrl	String	URL to preview the attachmen.
FileSize	String	The size of the attachment.
FileExtension	String	Extension of the attachment.
ModuleName	String	Id of the module.

Modules

To get the modules metadata for the specified account.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

For example, the following queries are processed server-side:

SELECT * FROM Modules

Columns


Name	Type	Description
Id	String	The unique identifier of the modules
Name	String	The name of the module which the user wants.
SequenceNumber	Integer	The sequence number of the field.
ApiName	String	The api name of the field.
GlobalSearchSupported	Boolean	Represents if the current module has global search support.
Deletable	Boolean	Describes if the user can delete a record in the current module.
Description	String	Represents the description of the module, if any.
Creatable	Boolean	Represents if the user can create records in the current module.
InventoryTemplateSupported	Boolean	Represents the module supports inventory template. The value will be true only for Quotes, Invoices, Purchase Orders, and Sales Orders modules.
ModifiedDateTime	Datetime	Represents the date and time of when the module properties were last modified.
PluralLabel	String	Represents the plural of the module name. Example: Leads.
SingularLabel	String	Represents the singular of the module name. Example: Lead.
PresenceSubMenu	Boolean	Represents if the module has a submenu. For instance, Tasks in Activities is a submenu.
TriggersSupported	Boolean	Represents if the module supports triggers from custom buttons, workflows, approval etc.
Visibility	Integer	Represents the visibility of the module in the org. 1- The module is visible, default value; 2- The module is hidden; XXXX - The sum of the feature numbers that are hidden.
Convertable	Boolean	Describes if the user can convert the record into another type of record. For example: Convert Leads into Deals.
Editable	Boolean	Describes if the user can edit a record in the current module.
EmailTemplateSupport	Boolean	Represents if the module supports the usage of the email templates.
FilterSupported	Boolean	Represents if the module supports custom filters besides the system-defined ones in a custom view.
ShowAsTab	Boolean	Represents if the module is displayed as a tab in the CRM UI.
Viewable	Boolean	Represents if the user can view the records in the current module.
ApiSupported	Boolean	Describes if the current module is accessible via API.
QuickCreate	Boolean	Represents if the module supports quick create.
ModifiedByName	String	Represents the name of the user who last modified the module properties.
ModifiedById	String	Represents the ID of the user who last modified the module properties.
GeneratedType	String	Represents how the module was created.
FeedsRequired	Boolean	Represents if feeds is enabled for the module.
ScoringSupported	Boolean	Represents if the records of the module qualify for the scoring process, if there is one.
WebformSupported	Boolean	Represents if the records in the module can be created via web forms.
BusinessCardFieldLimit	Integer	Represents the number of fields you can have in the business card details.
ParentModuleApiName	String	Represents the api name of the parent module, if any. For instance, Activities is the parent module for Tasks, Calls, and Events.
ParentModuleId	String	Represents the id of the parent module, if any.
WebLink	String	Represents the web link of the module, if any. For instance, https://extensions.zoho.com/plugin/facebook

Organizations

Query information regarding organizations.

View-Specific Information

Select

The Sync App processes filters client-side within the Sync App.

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the organization.
CompanyName	String	The name of the company for this organization.
PrimaryEmail	String	The primary email of the organization.
Phone	String	The phone number of the organization.
Mobile	String	The mobile phone number of the organization.
IsoCode	String	The ISO code of the organization.
Description	String	The description of the organization.
Country	String	The country where this organization is situated.
City	String	The city where this organization is situated.
State	String	The state where this organization is situated.
Street	String	The street where this organization is situated.
Zip	String	The zip where this organization is situated.
CountryCode	String	The country code of the organization.
Alias	String	The alias of the organization.
Fax	String	The fax of the organization.
EmployeeCount	Int	The number of employees this organization has.
Website	String	The website of the organization.
CurrencySymbol	String	The default currency symbol for the organization.
CurrencyLocale	String	The default currency locale for the organization.
PrimaryZuid	String	The primary ZUID for the organization.
TimeZone	String	The time zone for the organization.
Zgid	String	The zgid for the organization.
MCStatus	Boolean	Whether this organization has MC status or not.
GappsEnabled	Boolean	Whether this organization has gapps enabled or not.
LicenseDetailsPaidExpiry	Datetime	The date and time the subscription expires for this organization.
LicenseDetailsTrialType	String	The trial type of subscription the organization has.
LicenseDetailsTrialExpiry	Datetime	The date and time the trial subscription expires for this organization.
LicenseDetailsPaid	Boolean	Whether the organization has a paid subscription.
LicenseDetailsPaidType	String	The type of subscription the organization has.
LicenseDetailsUsersLicensePurchased	Integer	The number of licenses purchased by the organization.
PhotoId	String	Represents the unique ID of the organization photo file.
DomainName	String	Represents the domain name of the organization. For instance, org694902300.
TranslationEnabled	Boolean	Represents if translation is enabled for the organization.
Currency	String	Represents the base/home currency details of the organization.
ZiaPortalId	String	Represents Zia portal ID of the organization, if configured.
PrivacySettings	String	Represents if the privacy settings are enabled for the organization.
HipaaComplianceEnabled	Boolean	Represents if HIPAA compliance is enabled for the organization.

PriceBookPricingDetails

Query information regarding pricing details. Not available in free and standard ZohoCRM accounts.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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.

PriceBookId supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM PriceBookPricingDetails WHERE PriceBookId = '3152079000000317001'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the pricing detail.
PriceBookId [KEY]	String	A unique numeric identifier for the price book this pricing detail belongs to.
Discount	Double	How much discount should be applied for this pricing detail.
FromRange	Double	Starting from what amount should this discount be applied.
ToRange	Double	Until what amount should this discount be applied.

Profiles

Query information regarding profiles.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Profiles WHERE Id = '3152079000000026011'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the profile.
Name	String	The name of the profile.
Description [KEY]	String	A small description regarding this profile.
CreatedByName	String	The name of the user who created this profile.
CreatedById	String	The id of the user who created this profile.
CreatedAt	Datetime	The time this profile was created.
ModifiedByName	String	The name of the user who modified this profile.
ModifiedById	String	The id of the user who modified this profile.
ModifiedAt	Datetime	The time this profile was last modified.
Category	Boolean	Whether this profile is a category or not.
DisplayLabel	String	Represents the display name of the current profile.

PurchaseOrderProductDetails

Query information regarding purchase order product details. Not available in free and standard ZohoCRM accounts.

View-Specific Information

Select

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

PurchaseOrderId supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM PurchaseOrderProductDetails WHERE PurchaseOrderId = '3152079000000317029'

NOTE: ProductDetails has been changed to PurchaseItems after v2.

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the product detail.
PurchaseOrderId [KEY]	String	A unique numeric identifier for the purchase order this product detail belongs to.
ProductId	String	A unique numeric identifier for the id of the product.
ProductCode	String	The code of the product.
ProductName	String	The name of the product.
ProductDescription	String	The description of the product.
Quantity	Double	The quantity of products in this product detail.
Discount	Double	The discount applied to this product detail.
TotalAfterDiscount	Double	The total after discount for this product detail.
NetTotal	Double	The net total for this product detail.
Book	String	The book linked with this product detail.
Tax	Double	The total tax of this product detail.
ListPrice	Double	The listing price of this product detail.
UnitPrice	Double	The unit price of the product.
QuantityInStock	Double	The quantity in stock for this product.
Total	Double	The total price for this product detail.
LineTax	String	A line tax aggregate regarding this product detail.

QuoteProductDetails

Query information regarding quote product details. Not available in free and standard ZohoCRM accounts.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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.

QuoteId supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM QuoteProductDetails WHERE QuoteId = '3152079000000317060'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the product detail.
QuoteId [KEY]	String	A unique numeric identifier for the quote this product detail belongs to.
ProductId	String	A unique numeric identifier for the id of the product.
ProductCode	String	The code of the product.
ProductName	String	The name of the product.
ProductDescription	String	The description of the product.
Quantity	Double	The quantity of products in this product detail.
Discount	Double	The discount applied to this product detail.
TotalAfterDiscount	Double	The total after discount for this product detail.
NetTotal	Double	The net total for this product detail.
Book	String	The book linked with this product detail.
Tax	Double	The total tax of this product detail.
ListPrice	Double	The listing price of this product detail.
UnitPrice	Double	The unit price of the product.
QuantityInStock	Double	The quantity in stock for this product.
Total	Double	The total price for this product detail.
LineTax	String	A line tax aggregate regarding this product detail.

RecordCount

To fetch the total number of records in the module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The module is a mandatory filter for the Sync App.

Note: It works only with ApiVersion=2.1.

ModuleName supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM RecordCount WHERE ModuleName = 'Leads'

SELECT * FROM RecordCount WHERE ModuleName IN ('Leads','Invoices')

Columns


Name	Type	Description
Count [KEY]	Integer	The total number of records in the module.
ModuleName	String	The name of the module which the user wants the count.

Roles

Query information regarding roles.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Roles WHERE Id = '3152079000000026008'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the role.
Name	String	The name of the role.
DisplayLabel [KEY]	String	The way the role is displayed in the UI.
ReportingToName	String	The name of the role this role reports to.
ReportingToId	String	The id of the role this role reports to.
AdminUser	Boolean	Whether this role has administrative privileges or not.
ForecastManagerName	String	The forecast manager's name.
ForecastManagerId	String	The forecast manager's id.
ShareWithPeers	Boolean	Represents if the users with the current role have the permission to share records.
Description	String	Represents the description of the role, if any.

SalesOrderProductDetails

Query information regarding sales order product details. Not available in free and standard ZohoCRM accounts.

View-Specific Information

Select

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

SalesOrderId supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM SalesOrderProductDetails WHERE SalesOrderId = '3152079000000355025'

NOTE: ProductDetails has been changed to OrderedItems after v2.

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the product detail.
SalesOrderId [KEY]	String	A unique numeric identifier for the sales order this product detail belongs to.
ProductId	String	A unique numeric identifier for the id of the product.
ProductCode	String	The code of the product.
ProductName	String	The name of the product.
ProductDescription	String	The description of the product.
Quantity	Double	The quantity of products in this product detail.
Discount	Double	The discount applied to this product detail.
TotalAfterDiscount	Double	The total after discount for this product detail.
NetTotal	Double	The net total for this product detail.
Book	String	The book linked with this product detail.
Tax	Double	The total tax of this product detail.
ListPrice	Double	The listing price of this product detail.
UnitPrice	Double	The unit price of the product.
QuantityInStock	Double	The quantity in stock for this product.
Total	Double	The total price for this product detail.
LineTax	String	A line tax aggregate regarding this product detail.

StageHistories

Query information regarding stage histories for a particular deal.

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the stage.
DealId	String	A unique numeric identifier for the deal this stage belongs to.
Stage	String	The stage number for this stage.
Amount	Decimal	The amount of money spent for this stage.
DurationDays	Integer	The duration of this stage.
ExpectedRevenue	Decimal	The expected revenue from this stage.
Probability	Decimal	The probability for the stage to happen.
CloseDate	Date	The date when this stage closes.
LastModifiedTime	Datetime	The time this stage was last modified.
ModifiedById	String	The id of the user who modified the stage.
ModifiedByName	String	The name of the user who modified the stage.

Territories

Get the list of territories enabled for your organization.

Select

All the filters are executed at client side within the Sync App.

SELECT * from Territories;

Columns


Name	Type	Description
Id [KEY]	String	Represents the unique ID of the territory.
Name	String	Represents the name of the territory.
ParentId	String	Represents the unique ID of the parent territory, if any.
Criteria	String	Represents the territory criteria details.
Managername	String	Represents the name of the current territory's manager.
Managerid	String	Represents the ID of the current territory's manager.
CreatedByName	String	Represents the name of the user who created the current territory.
CreatedById	String	Represents the ID of the user who created the current territory.
ModifiedByName	String	Represents the name of the user who last modified the current territory.
ModifiedByid	String	Represents the ID of the user who last modified the current territory.
CreatedAt	Datetime	Represents the date and time at which the current territory was created.
ModifiedAt	Datetime	Represents the date and time at which the current territory was last modified.
Desription	String	Represents the description of the territory, if any.

Users

Query information regarding users.

View-Specific Information

Select

The Sync App will use the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Users WHERE Id = '3152079000000150015'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the user.
FirstName	String	The first name of the user.
LastName	String	The last name of the user.
FullName	String	The full name of the user.
Email	String	The email of the user.
RoleName	String	The name of the role the user has.
RoleId	String	The Id of the role the user has.
ProfileName	String	The name of the profile the user has.
ProfileId	String	The Id of the profile the user has.
Country	String	The country where the user is situated.
City	String	The city where the user is situated.
Street	String	The street where the user is situated.
State	String	The state where the user is situated.
Zip	String	The zip where the user is situated.
Alias	String	The alias of the user.
Signature	String	The signature of the user.
NameFormat	String	The format of the name of the user.
PersonalAccount	Boolean	Whether this user has a personal account or not.
DefaultTabGroup	String	The default tab group for this user.
CountryLocale	String	The default country locale of the user.
Fax	String	The fax of the user.
Website	String	The website of the user.
Mobile	String	The mobile phone number of the user.
Phone	String	The phone number of the user.
Dob	String	The date of birth of the user.
Status	String	The status of the user.
Confirm	Boolean	Whether this user has confirmed his email or not.
Language	String	The Language of the user.
Locale	String	The locale of the user.
TimeFormat	String	The default time format of the user.
DateFormat	String	The default date format of the user.
DecimalSeparator	String	The locale of the default decimal separator of the user.
TimeZone	String	The time zone of the user.
Zuid	String	The default ZUID of the user.
Territories	String	A comma separeted string of the user's territories.
CreatedByName	String	The name of the user who created this user.
CreatedById	String	The id of the user who created this user.
CreatedAt	Datetime	The time this user was created.
ModifiedByName	String	The name of the user who modified this user.
ModifiedById	String	The id of the user who modified this user.
ModifiedAt	Datetime	The time this user was last modified.
CustomizeInfoNotesDesc	String	The Customize info notes description.
CustomizeInfoShowRightPanel	Boolean	The Customize info show right panel.
CustomizeInfoShowLeftPanel	Boolean	The Customize info show left panel.
CustomizeInfoBcView	String	The Customize info bc view.
CustomizeInfoShowHome	Boolean	The Customize info show home.
CustomizeInfoShowDetailView	Boolean	The Customize info show detail view.
CustomizeInfoUnpinRecentItem	String	The Customize info unpin recent item.
Microsoft	Boolean	Represents if the user is a microsoft user.
ThemeBackground	String	The theme background.
ThemeNewBackground	String	The theme new background.
ThemeNormalTabBackground	String	The theme normal tab background.
ThemeNormalTabFontColor	String	The theme normal tab font color.
ThemeScreen	String	The theme screen.
ThemeSelectedTabBackground	String	The theme selected tab background.
ThemeSelectedTabBackground	String	The theme selected tab background.
ThemeType	String	The theme type.
ReportingToName	String	Represents the name of the user to whom the user reports to.
ReportingToId	String	Represents the id of the user to whom the user reports to.
Offset	Integer	Offset.
SandboxDeveloper	Boolean	Sandbox Developer.

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
Type	String	Limit the users returned to the ones of this type The allowed values are AllUsers, ActiveUsers, DeactiveUsers, ConfirmedUsers, NotConfirmedUsers, DeletedUsers, ActiveConfirmedUsers, AdminUsers, ActiveConfirmedAdmins, CurrentUser.

Visits

Query information regarding recent visits.

Columns


Name	Type	Description
Id [KEY]	String	The Id of the visit.
PageVisited	String	The name of the visited page.
VisitedBy_Id	String	The Id of the visitor.
VisitedBy_FirstName	String	The First Name of the visitor.
VisitedBy_LastName	String	The Last Name of the visitor.
IPAddress	String	The IP address of the visitor.
TimeSpent(Minutes)	String	The time spent in minutes for the visit.
Referrer	String	The referrer of the visitor.
VisitedPageURL	String	The URL of the visited page.
CreatedBy_Id	String	The Id of the object which created the visit.
ModifiedBy_Id	String	The Id of the object which modified the visit.
ModifiedBy_FirstName	String	The First Name of the object which modified the visit.
ModifiedBy_LastName	String	The Last Name of the object which modified the visit.
CreatedTime	Datetime	The date and time when the visit was created.
ModifiedTime	Datetime	The date and time when the visit was modified.
AttendedBy	String	Who attended the visit.
UserDetails	String	The user details of the visit.
Browser	String	The browser used for the visit.
TimeVisited	Datetime	The date and time of the visit.
VisitorType	String	The type of visitor for the visit.
Revenue	Decimal	The revenue generated by the visit.
NumberofPages	Int	The number of pages visited from the visit.
PortalName	String	The name of the portal used for the visit.
SearchKeyword	String	The search keyword used for the visit.
SearchEngine	String	The search engine used for the visit.
OperatingSystem	String	The operating system of the visitor.
Gclid	String	The GCLID of the visitor.
Keyword	String	The keyword used in the visit.
ClickType	String	The click type of the visit.
Devicetype	String	The type of the device of the visitor.
AdNetwork	String	The ad network used in the visit.
SearchPartnerNetwork	String	The search partner network for the visit.
AdCampaignName	String	The ad campaign name of the visit.
AdGroupName	String	The ad group name of the visit.
Ad	String	The ad used for the visit.
AdClickDate	Date	The date and time when the ad was clicked.
VisitSource	String	The source of the visit.

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

v2.1

CData Sync App models Zoho CRM Modules as relational tables.

Zoho CRM APIs

The Zoho CRM Sync App supports the following APIs to query data from the source.

Query API: Uses COQL to query data from Zoho CRM. To use this API, set UseCOQL to True.
Bulk API: Uses the Bulk API to query data from Zoho CRM. To use this API, set UseCOQL to False and APIType to Bulk.
REST API: Uses REST endpoints to query data from Zoho CRM. To use this API, set UseCOQL to False and APIType to REST.

API Limitations

V2.1 of Zoho CRM imposes limits on the maximum number of rows and columns that interfacing tools such as the CData Sync App can retrieve from its APIs.

The limits vary based on whether you're using the Query API, Bulk API, or REST API. These limits are:

Query API: Maximum of 100,000 rows and 50 columns.
Bulk API: Over 100,000 rows and no more than 200 columns.
REST API: Maximum of 10,000 rows (no column limit).

API Metadata

The columns and values retrieved from tables and views vary based on whether you're using the Query API, Bulk API, or REST API. These variations are:

Query API
- For Lookup type columns, the *_Id is displayed and has a value, but *_Name doesn't appear.
- For *Owner and *ModifiedBy columns, *_Id, *_firstname, and *_lastname are displayed and have values, but *_Name doesn't appear.
Bulk API
- For Lookup type columns, the *_Id and _Name are displayed, but only *Id has a value.
- For *Owner and *ModifiedBy columns, *_Id, *_Name, *_firstname, and *_lastname are displayed, but *_Name has no value.
REST API
- For Lookup type columns, the *_Id and _Name are displayed and both have values.
- For *Owner and *ModifiedBy columns, *_Id, *_Name, *_firstname, and *_lastname are displayed, but *_firstname and *_lastname have no values.

Using Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to the Zoho CRM APIs and then processes the rest of the query in the Sync App. The following sections document API limitations and requirements.

Tables

The Sync App connects to Zoho CRM and gets the list of Tables and the metadata for the tables by calling the appropriate Web services. Any changes you make to your Zoho CRM account, such as adding a custom module, adding a custom field, or changing the data type of a field, occur immediately when you connect using the Sync App. Tables shows an example, based on the Zoho CRM development environment, of what the entities in your account may look like.

Note: The Bulk API is not supported by the Notes table. Due to this, if you are using the Bulk API, the Sync App will instead use the REST API (with its associated limitations) when working with notes data.

Views

Most Views are defined in static configuration files. Custom Views are not. Instead, custom views are dynamically retrieved by connecting to Zoho CRM, calling the appropriate Web service and retrieving the list of custom views from the metadata returned. Any changes you make to your Zoho CRM account, such as adding a new custom view, occur immediately when you connect using the Sync App.

To use Custom Views, set the IncludeCustomViews property to true. Its default value is false since custom views introduce an overhead when retrieving the list of tables and views.

Criteria applied in the custom view (either when creating it or when editing it in the UI) are preserved in CData Zoho CRM Sync App. Nonetheless, further filtering on records is available at any time.

To use Relative Views, set the IncludeRelatedLists property to true. Its default value is false since related views introduce an overhead when retrieving the list of tables and views.

The EntityId field is required to fetch related module data. This field refers to the parent module Id.

Stored Procedures

Stored Procedures provides additional capabilities in the Zoho CRM API, including working with files.

Tables

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

Zoho CRM Connector for CData Sync Tables


Name	Description
Accounts	Create, update, delete, and query information regarding accounts.
Activities	Delete, and query information regarding activities.
Attachments	Delete, and query information regarding attachments.
Calls	Create, update, delete, and query information regarding calls.
Campaigns	Create, update, delete, and query information regarding campaigns.
Cases	Create, update, delete, and query information regarding cases.
ContactRoles	Get, add, update, or delete the list of contact roles
Contacts	Create, update, delete, and query information regarding contacts.
Currencies	Get, add or update currencies to your organization.
Deals	Create, update, delete, and query information regarding deals.
Invoices	Create, update, delete, and query information regarding invoices. Not available in free and standard ZohoCRM accounts.
Leads	Create, update, delete, and query information regarding Leads.
Meetings	Create, update, delete, and query information regarding meetings.
Notes	Create, update, delete, and query information regarding notes.
Pipeline	To fetch the details of all or a specific pipeline in the Deals module. It works only with ApiVersion=2.1.
PriceBooks	Create, update, delete, and query information regarding price books. Not available in free and standard ZohoCRM accounts.
Products	Create, update, delete, and query information regarding products. Not available in free and standard ZohoCRM accounts.
PurchaseOrders	Create, update, delete, and query information regarding purchase orders. Not available in free and standard ZohoCRM accounts.
Quotes	Create, update, delete, and query information regarding quotes. Not available in free and standard ZohoCRM accounts.
SalesOrders	Create, update, delete, and query information regarding sales orders. Not available in free and standard ZohoCRM accounts.
Solutions	Create, update, delete, and query information regarding solutions.
Tasks	Create, update, delete, and query information regarding tasks.
Vendors	Create, update, delete, and query information regarding vendors.

Accounts

Create, update, delete, and query information regarding accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side. The rest of the filter is executed client-side within the Sync App.

Insert

INSERT INTO Accounts(AccountName) VALUES('my name')

Required fields: AccountName.

Any field which is not read-only (ReadOnly = false in the table below below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Accounts WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Accounts SET Description = 'Updated from API' WHERE Id = '3152079000000153079'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
AccountOwner_Id	String	False	AccountOwner Id
AccountOwner_FirstName	String	True	AccountOwner FirstName
AccountOwner_LastName	String	True	AccountOwner LastName
AccountOwner_Email	String	True	AccountOwner Email
AccountOwner_Name	String	True	AccountOwner Name
Rating	String	False	Rating
AccountName	String	False	AccountName
Phone	String	False	Phone
Fax	String	False	Fax
ParentAccount_Id	String	False	ParentAccount Id
ParentAccount_Name	String	True	ParentAccount Name
Website	String	False	Website
TickerSymbol	String	False	TickerSymbol
AccountType	String	False	AccountType
Ownership	String	False	Ownership
Industry	String	False	Industry
Employees	Int	False	Employees
AnnualRevenue	Decimal	False	AnnualRevenue
SICCode	Int	False	SICCode
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
LastActivityTime	Datetime	True	LastActivityTime
AccountNumber	Long	False	AccountNumber
AccountSite	String	False	AccountSite
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
Description	String	False	Description
AccountImage	String	False	AccountImage
ChangeLogTime	Datetime	True	ChangeLogTime
Locked	Bool	True	Locked
LastEnrichedTime	Datetime	True	LastEnrichedTime
EnrichStatus	String	True	EnrichStatus

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Activities

Delete, and query information regarding activities.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

DueDate supports the '=' operator.
ClosedTime supports the '=' operator.
Location supports the '=, LIKE' operators.
From supports the '=' operator.
To supports the '=' operator.
Check-InTime supports the '=' operator.
Check-InComment supports the '=, LIKE'.
Check-InSub-Locality supports the '=, LIKE' operators.
Check-InCity supports the '=, LIKE' operators.
Check-InState supports the '=, LIKE' operators.
Check-InCountry supports the '=, LIKE' operators.
ZipCode supports the '=, LIKE' operators.
Check-InAddress supports the '=, LIKE' operators.
CheckedInStatus supports the '=, LIKE' operators.
CallStartTime supports the '=' operator.
CallDuration supports the '=, LIKE' operators.
CallResult supports the '=, LIKE' operators.
Reminder supports the '=, LIKE' operators.
CallStatus supports the '=, LIKE' operators.
Subject supports the '=, LIKE' operators.
CreatedTime supports the '=' operator.
ModifiedTime supports the '=' operator.
ActivityType supports the '=, LIKE' operators.
Description supports the '=, LIKE' operators.

For example, the following queries are processed server side:

SELECT * FROM Activities WHERE Id = '3152079000000154214'

SELECT * FROM Activities WHERE Subject = 'event'

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Activities WHERE Id = '3152079000000156229'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
ActivityOwner_Id	String	False	ActivityOwner Id
ActivityOwner_FirstName	String	True	ActivityOwner FirstName
ActivityOwner_LastName	String	True	ActivityOwner LastName
ActivityOwner_Email	String	True	ActivityOwner Email
ActivityOwner_Name	String	True	ActivityOwner Name
Subject	String	False	Subject
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedAt	Datetime	False	CreatedAt
ModifiedAt	Datetime	False	ModifiedAt
ActivityType	String	False	ActivityType
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
Description	String	False	Description
DueDate	Date	False	DueDate
Status	String	False	Status
Priority	String	False	Priority
ClosedTime	Datetime	True	ClosedTime
Repeat_Id	String	False	Repeat Id
Repeat_Name	String	True	Repeat Name
Tag	String	False	Tag
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime
Location	String	False	Location
Allday	Bool	False	Allday
From	Datetime	False	From
To	Datetime	False	To
Participants	String	False	Participants
Check-InTime	Datetime	True	Check-InTime
Check-InBy_Id	String	False	Check-InBy Id
Check-InBy_Name	String	True	Check-InBy Name
Check-InComment	String	True	Check-InComment
Check-InSub-Locality	String	True	Check-InSub-Locality
Check-InCity	String	True	Check-InCity
Check-InState	String	True	Check-InState
Check-InCountry	String	True	Check-InCountry
Latitude	Double	True	Latitude
Longitude	Double	True	Longitude
ZipCode	String	True	ZipCode
Check-InAddress	String	True	Check-InAddress
CheckedInStatus	String	True	CheckedInStatus
CallType	String	False	CallType
CallPurpose	String	False	CallPurpose
CallStartTime	Datetime	False	CallStartTime
CallDuration	String	False	CallDuration
CallDuration(inseconds)	Int	False	CallDuration(inseconds)
CallResult	String	False	CallResult
CTIEntry	Bool	False	CTIEntry
Reminder	String	False	Reminder
OutgoingCallStatus	String	False	OutgoingCallStatus
ScheduledinCRM	String	True	ScheduledinCRM
CallAgenda	String	False	CallAgenda
CallerID	String	True	CallerID
DialledNumber	String	True	DialledNumber
VoiceRecording	String	False	VoiceRecording

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
Converted	Bool	To get the list of converted records.
Approved	Bool	To retrieve the list of approved records. Default value is true.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Attachments

Delete, and query information regarding attachments.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

SELECT * FROM Attachments

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Attachments WHERE Id = '3152079000000431011'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
AttachmentOwner_Id	String	False	AttachmentOwner Id
AttachmentOwner_FirstName	String	True	AttachmentOwner FirstName
AttachmentOwner_LastName	String	True	AttachmentOwner LastName
AttachmentOwner_Email	String	True	AttachmentOwner Email
AttachmentOwner_Name	String	True	AttachmentOwner Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
CreatedAt	Datetime	True	CreatedAt
ModifiedAt	Datetime	True	ModifiedAt
FileName	String	False	FileName
Size	String	False	Size
ParentID_Id	String	False	ParentID Id
ParentID_Name	String	True	ParentID Name
ModuleName	String	False	ModuleName
Editable	String	False	Editable
FileId	String	False	FileId
Type	String	False	Type
State	String	False	State
LinkUrl	String	False	LinkUrl

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
Converted	Bool	To get the list of converted records.
Approved	Bool	To retrieve the list of approved records. Default value is true.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Calls

Create, update, delete, and query information regarding calls.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Calls (Subject, ModuleName, RelatedTo_Id,CallType,CallStartTime) VALUES ('A test call', 'Accounts', '5768552000000433001','Outbound','May 20, 2023 12:00 AM')

Required fields: Subject, ModuleName, CallType, CallStartTime and ContactName_Id if ModuleName = Contacts and RelatedTo_Id if any other modulename is specified.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Calls WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Calls SET Subject = 'Updated from API' WHERE Id = '3152079000000484001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
CallOwner_Id	String	False	CallOwner Id
CallOwner_FirstName	String	True	CallOwner FirstName
CallOwner_LastName	String	True	CallOwner LastName
CallOwner_Email	String	True	CallOwner Email
CallOwner_Name	String	True	CallOwner Name
Subject	String	False	Subject
CallType	String	False	CallType
CallPurpose	String	False	CallPurpose
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
CallStartTime	Datetime	False	CallStartTime
CallDuration	String	False	CallDuration
CallDuration(inseconds)	Int	False	CallDuration(inseconds)
Description	String	False	Description
CallResult	String	False	CallResult
CTIEntry	Bool	False	CTIEntry
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Reminder	String	False	Reminder
Tag	String	False	Tag
OutgoingCallStatus	String	False	OutgoingCallStatus
ScheduledinCRM	String	True	ScheduledinCRM
LastActivityTime	Datetime	False	LastActivityTime
CallAgenda	String	False	CallAgenda
CallerID	String	True	CallerID
DialledNumber	String	True	DialledNumber
ModuleName	String	False	ModuleName

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Campaigns

Create, update, delete, and query information regarding campaigns.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Campaigns (CampaignName) VALUES ('a test campaign')

Required fields: CampaignName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Campaigns WHERE Id = '3152079000000485001'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Campaigns SET CampaignName = 'Updated from API' WHERE Id = '3152079000000485001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
CampaignOwner_Id	String	False	CampaignOwner Id
CampaignOwner_FirstName	String	True	CampaignOwner FirstName
CampaignOwner_LastName	String	True	CampaignOwner LastName
CampaignOwner_Email	String	True	CampaignOwner Email
CampaignOwner_Name	String	True	CampaignOwner Name
Type	String	False	Type
CampaignName	String	False	CampaignName
Status	String	False	Status
StartDate	Date	False	StartDate
EndDate	Date	False	EndDate
ExpectedRevenue	Decimal	False	ExpectedRevenue
BudgetedCost	Decimal	False	BudgetedCost
ActualCost	Decimal	False	ActualCost
ExpectedResponse	Long	False	ExpectedResponse
Numberssent	Long	False	Numberssent
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Description	String	False	Description
ParentCampaign_Id	String	False	ParentCampaign Id
ParentCampaign_Name	String	True	ParentCampaign Name
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Cases

Create, update, delete, and query information regarding cases.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Cases (Email, Priority, Description) VALUES ('[email protected]', 'Medium', 'A simple test case')

Required fields: None.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Cases WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Cases SET Priority = 'Low' WHERE Id = '3152079000000473022'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
CaseReason	String	False	CaseReason
CaseNumber	String	True	CaseNumber
CaseOwner_Id	String	False	CaseOwner Id
CaseOwner_FirstName	String	True	CaseOwner FirstName
CaseOwner_LastName	String	True	CaseOwner LastName
CaseOwner_Email	String	True	CaseOwner Email
CaseOwner_Name	String	True	CaseOwner Name
Status	String	False	Status
ProductName_Id	String	False	ProductName Id
ProductName_Name	String	True	ProductName Name
Priority	String	False	Priority
Type	String	False	Type
CaseOrigin	String	False	CaseOrigin
Subject	String	False	Subject
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
DealName_Id	String	False	DealName Id
DealName_Name	String	True	DealName Name
No.ofcomments	Int	True	No.ofcomments
ReportedBy	String	False	ReportedBy
Email	String	False	Email
Phone	String	False	Phone
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Description	String	False	Description
InternalComments	String	False	InternalComments
Solution	String	False	Solution
AddComment	String	False	AddComment
Comments	String	True	Comments
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

ContactRoles

Get, add, update, or delete the list of contact roles

Table-Specific Information

Select

SELECT * FROM ContactRoles

Insert

Insert INTO ContactRoles(SequenceNumber, Name) VALUES(8, 'TEST3')

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM ContactRoles WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE ContactRoles SET Name='Sales Lead 1' where Id= '2732548000006917001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Represents the unique ID of the contact role.
SequenceNumber	Int	False	Represents the position of the contact role in the picklist in CRM UI.
Name	String	False	Represents the name of the contact role.

Contacts

Create, update, delete, and query information regarding contacts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Contacts (FirstName, LastName, Email) VALUES ('John', 'Smith', '[email protected]')

Required fields: LastName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Contacts WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Contacts SET Description = 'John helped us in the past with setting up the servers.' WHERE Id = '3152079000000484021'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
ContactOwner_Id	String	False	ContactOwner Id
ContactOwner_FirstName	String	True	ContactOwner FirstName
ContactOwner_LastName	String	True	ContactOwner LastName
ContactOwner_Email	String	True	ContactOwner Email
ContactOwner_Name	String	True	ContactOwner Name
LeadSource	String	False	LeadSource
FirstName	String	False	FirstName
LastName	String	False	LastName
FullName	String	False	FullName
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
VendorName_Id	String	False	VendorName Id
VendorName_Name	String	True	VendorName Name
Email	String	False	Email
Title	String	False	Title
Department	String	False	Department
Phone	String	False	Phone
HomePhone	String	False	HomePhone
OtherPhone	String	False	OtherPhone
Fax	String	False	Fax
Mobile	String	False	Mobile
DateofBirth	Date	False	DateofBirth
Assistant	String	False	Assistant
AsstPhone	String	False	AsstPhone
EmailOptOut	Bool	False	EmailOptOut
SkypeID	String	False	SkypeID
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Salutation	String	False	Salutation
SecondaryEmail	String	False	SecondaryEmail
LastActivityTime	Datetime	True	LastActivityTime
Twitter	String	False	Twitter
Tag	String	False	Tag
MailingStreet	String	False	MailingStreet
OtherStreet	String	False	OtherStreet
MailingCity	String	False	MailingCity
OtherCity	String	False	OtherCity
MailingState	String	False	MailingState
OtherState	String	False	OtherState
MailingZip	String	False	MailingZip
OtherZip	String	False	OtherZip
MailingCountry	String	False	MailingCountry
OtherCountry	String	False	OtherCountry
Description	String	False	Description
ContactImage	String	False	ContactImage
ReportingTo_Id	String	False	ReportingTo Id
ReportingTo_Name	String	True	ReportingTo Name
UnsubscribedMode	String	True	UnsubscribedMode
UnsubscribedTime	Datetime	True	UnsubscribedTime
ChangeLogTime	Datetime	True	ChangeLogTime
Locked	Bool	True	Locked
LastEnrichedTime	Datetime	True	LastEnrichedTime
EnrichStatus	String	True	EnrichStatus

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Currencies

Get, add or update currencies to your organization.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Currencies WHERE Id = '1234';

Insert

INSERT INTO Currencies (ISO_Code, Name, ExchangeRate) VALUES ('1234', 'hello','1.000');

Bulk Insert operation:

INSERT INTO Currencies#TEMP (id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code) VALUES ('4150868000000236307', 'cdata1','$','true','1.0000','period','comma','2','true','2');

INSERT INTO Currencies#TEMP (id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code) VALUES ('1234', 'cdata','$','true','2.0000','period','comma','3','true','3');

INSERT INTO Currencies (id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code) SELECT id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code FROM currencies#TEMP;

Required fields: Name, ISO_Code, ExchangeRate.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Update

UPDATE Currencies SET symbol = 'hello', FormatDecimalSeparator = 'period', FormatThousandSeparator = 'comma',FormatDecimalPlaces = '2',prefixsymbol = 'true',exchangerate = '1.0000' WHERE Id = '1234';

Bulk Update Operation:

UPDATE Currencies SET symbol = '$',FormatDecimalSeparator = 'period',FormatThousandSeparator = 'comma',FormatDecimalPlaces = '2';

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated. NOTE: if Id field is not specified in the query, PostData will be created for each id ( driver will execute bulk update operation for each currency id).

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Represents the unique ID of the currency.
Name	String	False	Represents the name of the currency.
Symbol	String	False	Represents the symbol of the currency.
IsActive	Bool	False	Represents the status of the currency.
ExchangeRate	Double	False	Represents the exchange rate of the currency.
FormatDecimalSeparator	String	False	The decimal separator separates the integer part of the currency from its fractional part.
FormatThousandSeparator	String	False	The thousand separator separates groups of thousands in a currency.
FormatDecimalPlaces	String	False	Represents the number of decimal places allowed for the currency.
ModifiedByName	String	True	Represents the name of the user who last modified the currency details.
ModifiedByid	String	True	Represents the ID of the user who last modified the currency details.
PrefixSymbol	Bool	False	Represents if the currency has a prefix symbol.
IsBase	Bool	True	Represents if the currency is the base currency.
CreatedAt	Datetime	True	Represents the date and time at which the currency was created.
ModifiedAt	Datetime	True	Represents the date and time at which the currency was last modified.
ISO_Code	String	False	Represents the ISO code of the currency.

Deals

Create, update, delete, and query information regarding deals.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Deals (DealName, Stage) VALUES ('Converting company XYZ into our client.', 'Qualification')

Required fields: DealName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Deals WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Deals SET Description = 'Updated from API' WHERE Id = '3152079000000153079'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
DealOwner_Id	String	False	DealOwner Id
DealOwner_FirstName	String	True	DealOwner FirstName
DealOwner_LastName	String	True	DealOwner LastName
DealOwner_Email	String	True	DealOwner Email
DealOwner_Name	String	True	DealOwner Name
Amount	Decimal	False	Amount
DealName	String	False	DealName
ClosingDate	Date	False	ClosingDate
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
Stage	String	False	Stage
Type	String	False	Type
Probability(%)	Int	False	Probability(%)
ExpectedRevenue	Decimal	True	ExpectedRevenue
NextStep	String	False	NextStep
LeadSource	String	False	LeadSource
CampaignSource_Id	String	False	CampaignSource Id
CampaignSource_Name	String	True	CampaignSource Name
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
LastActivityTime	Datetime	True	LastActivityTime
LeadConversionTime	Int	True	LeadConversionTime
SalesCycleDuration	Int	True	SalesCycleDuration
OverallSalesDuration	Int	True	OverallSalesDuration
Tag	String	False	Tag
Description	String	False	Description
ChangeLogTime	Datetime	True	ChangeLogTime
Locked	Bool	True	Locked
ReasonForLoss	String	False	ReasonForLoss

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Invoices

Create, update, delete, and query information regarding invoices. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Invoices (Status, DueDate, Subject, InvoicedItems) VALUES ('Created', '2018/06/06', 'An invoice for the purchase of products XYZ.', '[
            { 
              "Product_Name": { 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, InvoicedItems.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Invoices WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Invoices SET Description = 'Updated from API' WHERE Id = '3152079000000153079'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
InvoiceOwner_Id	String	False	InvoiceOwner Id
InvoiceOwner_FirstName	String	True	InvoiceOwner FirstName
InvoiceOwner_LastName	String	True	InvoiceOwner LastName
InvoiceOwner_Email	String	True	InvoiceOwner Email
InvoiceOwner_Name	String	True	InvoiceOwner Name
InvoiceNumber	String	True	InvoiceNumber
Subject	String	False	Subject
SalesOrder_Id	String	False	SalesOrder Id
SalesOrder_Name	String	True	SalesOrder Name
InvoiceDate	Date	False	InvoiceDate
PurchaseOrder	String	False	PurchaseOrder
DueDate	Date	False	DueDate
ExciseDuty	Decimal	False	ExciseDuty
SalesCommission	Decimal	False	SalesCommission
Status	String	False	Status
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
SubTotal	String	True	SubTotal
Discount	Decimal	False	Discount
Tax	Decimal	False	Tax
Adjustment	Decimal	False	Adjustment
GrandTotal	String	True	GrandTotal
TermsandConditions	String	False	TermsandConditions
Description	String	False	Description
InvoicedItems	String	False	InvoicedItems
DealName_Id	String	False	DealName Id
DealName_Name	String	True	DealName Name
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Leads

Create, update, delete, and query information regarding Leads.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Leads(FirstName, LastName, Title) VALUES('Alert', 'Bat', 'Mr')
INSERT INTO LEADS(FirstName, LastName, Email, Trigger) VALUES('Enthusiastic', 'Panda', '[email protected]', 'workflow,approval,blueprint')

Required fields: LastName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Leads WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Leads SET Description = 'Changed from the API.' WHERE Id = '3152079000000488014'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
LeadOwner_Id	String	False	LeadOwner Id
LeadOwner_FirstName	String	True	LeadOwner FirstName
LeadOwner_LastName	String	True	LeadOwner LastName
LeadOwner_Email	String	True	LeadOwner Email
LeadOwner_Name	String	True	LeadOwner Name
Company	String	False	Company
FirstName	String	False	FirstName
LastName	String	False	LastName
FullName	String	False	FullName
Title	String	False	Title
Email	String	False	Email
Phone	String	False	Phone
Fax	String	False	Fax
Mobile	String	False	Mobile
Website	String	False	Website
LeadSource	String	False	LeadSource
LeadStatus	String	False	LeadStatus
Industry	String	False	Industry
No.ofEmployees	Int	False	No.ofEmployees
AnnualRevenue	Decimal	False	AnnualRevenue
Rating	String	False	Rating
EmailOptOut	Bool	False	EmailOptOut
SkypeID	String	False	SkypeID
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Salutation	String	False	Salutation
SecondaryEmail	String	False	SecondaryEmail
LastActivityTime	Datetime	True	LastActivityTime
Twitter	String	False	Twitter
Tag	String	False	Tag
Street	String	False	Street
City	String	False	City
State	String	False	State
ZipCode	String	False	ZipCode
Country	String	False	Country
Description	String	False	Description
LeadImage	String	False	LeadImage
LeadConversionTime	Int	True	LeadConversionTime
UnsubscribedMode	String	True	UnsubscribedMode
UnsubscribedTime	Datetime	True	UnsubscribedTime
ChangeLogTime	Datetime	True	ChangeLogTime
Locked	Bool	True	Locked
LastEnrichedTime	Datetime	True	LastEnrichedTime
EnrichStatus	String	True	EnrichStatus

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Meetings

Create, update, delete, and query information regarding meetings.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Meetings (Title, `From`, To) VALUES ('A test event', '2018/05/29 18:00:00', '2018/05/29 20:30:00')

Required fields: Title, From, To.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Meetings WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Meetings SET Description = 'Changed from the API.' WHERE Id = '3152079000000154219'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
Title	String	False	Title
Location	String	False	Location
Allday	Bool	False	Allday
From	Datetime	False	From
To	Datetime	False	To
Host_Id	String	False	Host Id
Host_FirstName	String	True	Host FirstName
Host_LastName	String	True	Host LastName
Host_Email	String	True	Host Email
Host_Name	String	True	Host Name
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
Repeat_Id	String	False	Repeat Id
Repeat_Name	String	True	Repeat Name
Reminder	String	False	Reminder
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Participants	String	False	Participants
Description	String	False	Description
Check-InTime	Datetime	True	Check-InTime
Check-InBy_Id	String	False	Check-InBy Id
Check-InBy_Name	String	True	Check-InBy Name
Check-InComment	String	True	Check-InComment
Check-InSub-Locality	String	True	Check-InSub-Locality
Check-InCity	String	True	Check-InCity
Check-InState	String	True	Check-InState
Check-InCountry	String	True	Check-InCountry
Latitude	Double	True	Latitude
Longitude	Double	True	Longitude
ZipCode	String	True	ZipCode
Check-InAddress	String	True	Check-InAddress
CheckedInStatus	String	True	CheckedInStatus
Tag	String	False	Tag
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Notes

Create, update, delete, and query information regarding notes.

Table-Specific Information

Note: The Bulk API is not supported by the Notes table. Due to this, if you are using the Bulk API (UseCOQL set to False and APIType set to Bulk), the Sync App will instead use the REST API (with its associated limitations) when working with notes data. Refer to v2, v2.1, or v4 (in accordance with the value you set for Schema) to see the limits imposed by the REST API.

Select

The Sync App uses the Zoho CRM 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.

NoteTitle supports the '=, LIKE' operators.
NoteContent supports the '=, LIKE' operators.
CreatedTime supports the '=' operator.
ModifiedTime supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Notes WHERE Id = '3152079000000153079'

SELECT * FROM Notes WHERE NoteTitle = 'Deal details'

Insert

INSERT INTO Notes (ParentID_Id, ModuleName, NoteContent) VALUES ('3276571000000184007', 'Leads', 'Janet converted this lead.')

Required fields: ParentID_Id (the Id of the item in which you are inserting the note to), ModuleName (the API name of the module you are inserting the note to), NoteContent.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Notes WHERE Id = '3152079000000488014'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Notes SET NoteTitle = 'Changed from the API.' WHERE Id = '3152079000000304003'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
NoteOwner_Id	String	False	NoteOwner Id
NoteOwner_FirstName	String	True	NoteOwner FirstName
NoteOwner_LastName	String	True	NoteOwner LastName
NoteOwner_Email	String	True	NoteOwner Email
NoteOwner_Name	String	True	NoteOwner Name
NoteTitle	String	False	NoteTitle
NoteContent	String	False	NoteContent
ParentID_Id	String	False	ParentID Id
ParentID_Name	String	True	ParentID Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Associated_Id	Long	False	Associated_Id
ModuleName	String	False	ModuleName
Attachments	String	False	Attachments
Editable	String	False	Editable
IsSharedToClient	String	False	IsSharedToClient
State	String	False	State
VoiceNote	String	False	VoiceNote

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Pipeline

To fetch the details of all or a specific pipeline in the Deals module. It works only with ApiVersion=2.1.

Table-Specific Information

Select

The Sync App will use the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

For example, the following queries are processed server side:

SELECT * FROM Pipeline WHERE Id = '228122000000223002' AND LayoutId = '228122000000000173'

SELECT * FROM Pipeline WHERE  LayoutId = '228122000000000173'

Insert

The maps values can be obtained by using the Fields view.

Insert Into Pipeline (LayoutId,DisplayValue,default,maps) VALUES ('4917206000000318488','Test_pipee11','true','[\n" +
            "        {\n" +
            "          \"display_value\": \"Qualification\",\n" +
            "          \"sequence_number\": \"2\",\n" +
            "          \"id\": \"4917206000000006801\"\n" +
            "        },\n" +
            "        {\n" +
            "          \"display_value\": \"Needs Analysis\",\n" +
            "          \"sequence_number\": \"1\",\n" +
            "          \"id\": \"4917206000000006803\"\n" +
            "        }\n" +
            "      ]')

Required fields: LayoutId, DisplayValue, Default and maps.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Update

You must specify the Id and LayoutId in the WHERE clause when executing an update against this table.

UPDATE Pipeline Set DisplayValue = 'Pipeline_test12', default = 'false', maps = '[\n" +
            "        {\n" +
            "          \"display_value\": \"Qualification\",\n" +
            "          \"sequence_number\": \"2\",\n" +
            "          \"id\": \"4917206000000006801\"\n" +
            "        },\n" +
            "        {\n" +
            "          \"display_value\": \"Needs Analysis\",\n" +
            "          \"sequence_number\": \"1\",\n" +
            "          \"id\": \"4917206000000006803\"\n" +
            "        }\n" +
            "      ]' WHERE Id = '4917206000000357004' AND LayoutId = '4917206000000318488' ")

Required fields: Id,LayoutId.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Delete

The users can use the TransferAndDeltePipeline stored procedure to delete the pipeline.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	A unique numeric identifier for the profile.
DisplayValue	String	False	The name of the pipeline.
Default	Bool	False	The default value of the pipeline.
ActualValue	String	False	The actual name of the pipeline.
Maps	String	False	The different stages that a deal has to pass through in the sales pipeline.
LayoutId [KEY]	String	False	The unique ID of the layout in the Deals module you want to fetch the pipeline's details from.

PriceBooks

Create, update, delete, and query information regarding price books. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO PriceBooks (PriceBookName, Active) VALUES ('pricebook_2018', true)

Required fields: PriceBookName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM PriceBooks WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE PriceBooks SET Description = 'Changed from the API.' WHERE Id = '3152079000000488023'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
PriceBookOwner_Id	String	False	PriceBookOwner Id
PriceBookOwner_FirstName	String	True	PriceBookOwner FirstName
PriceBookOwner_LastName	String	True	PriceBookOwner LastName
PriceBookOwner_Email	String	True	PriceBookOwner Email
PriceBookOwner_Name	String	True	PriceBookOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
PriceBookName	String	False	PriceBookName
Active	Bool	False	Active
PricingModel	String	False	PricingModel
Tag	String	False	Tag
PricingDetails	String	False	PricingDetails
Description	String	False	Description
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Products

Create, update, delete, and query information regarding products. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Products(ProductName, ProductActive) VALUES('C-3PO', true)

Required fields: ProductName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Products WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Products SET Description = 'Changed from the API.' WHERE Id = '3152079000000487023'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
ProductOwner_Id	String	False	ProductOwner Id
ProductOwner_FirstName	String	True	ProductOwner FirstName
ProductOwner_LastName	String	True	ProductOwner LastName
ProductOwner_Email	String	True	ProductOwner Email
ProductOwner_Name	String	True	ProductOwner Name
ProductName	String	False	ProductName
ProductCode	String	False	ProductCode
VendorName_Id	String	False	VendorName Id
VendorName_Name	String	True	VendorName Name
ProductActive	Bool	False	ProductActive
Manufacturer	String	False	Manufacturer
ProductCategory	String	False	ProductCategory
SalesStartDate	Date	False	SalesStartDate
SalesEndDate	Date	False	SalesEndDate
SupportStartDate	Date	False	SupportStartDate
SupportEndDate	Date	False	SupportEndDate
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
UnitPrice	Decimal	False	UnitPrice
CommissionRate	Decimal	False	CommissionRate
Tax	String	False	Tax
Taxable	Bool	False	Taxable
UsageUnit	String	False	UsageUnit
QtyOrdered	Double	False	QtyOrdered
QuantityinStock	Double	False	QuantityinStock
ReorderLevel	Double	False	ReorderLevel
Handler_Id	String	False	Handler Id
Handler_Name	String	True	Handler Name
QuantityinDemand	Double	False	QuantityinDemand
Description	String	False	Description
ProductImage	String	False	ProductImage
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

PurchaseOrders

Create, update, delete, and query information regarding purchase orders. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO PurchaseOrders (Subject, PurchaseItems) VALUES ('Purchase Order', '[
            { 
              "Product_Name": { 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, Purchase_Items

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM PurchaseOrders WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE PurchaseOrders SET Description = 'Changed from the API.' WHERE Id = '3152079000000492001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
RequisitionNumber	String	False	RequisitionNumber
TrackingNumber	String	False	TrackingNumber
PONumber	String	False	PONumber
Subject	String	False	Subject
VendorName_Id	String	False	VendorName Id
VendorName_Name	String	True	VendorName Name
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
PODate	Date	False	PODate
DueDate	Date	False	DueDate
Carrier	String	False	Carrier
ExciseDuty	Decimal	False	ExciseDuty
SalesCommission	Decimal	False	SalesCommission
Status	String	False	Status
PurchaseOrderOwner_Id	String	False	PurchaseOrderOwner Id
PurchaseOrderOwner_FirstName	String	True	PurchaseOrderOwner FirstName
PurchaseOrderOwner_LastName	String	True	PurchaseOrderOwner LastName
PurchaseOrderOwner_Email	String	True	PurchaseOrderOwner Email
PurchaseOrderOwner_Name	String	True	PurchaseOrderOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
SubTotal	String	True	SubTotal
Discount	Decimal	False	Discount
Tax	Decimal	False	Tax
Adjustment	Decimal	False	Adjustment
GrandTotal	String	True	GrandTotal
TermsandConditions	String	False	TermsandConditions
Description	String	False	Description
PurchaseItems	String	False	PurchaseItems
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Quotes

Create, update, delete, and query information regarding quotes. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Quotes (Subject, QuotedItems) VALUES ('QuotedItems', '[
            { 
              "Product_Name": { 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, QuotedItems.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Quotes WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Quotes SET Description = 'Changed from the API.' WHERE Id = '3152079000000490009'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
Team	String	False	Team
QuoteNumber	String	True	QuoteNumber
Subject	String	False	Subject
DealName_Id	String	False	DealName Id
DealName_Name	String	True	DealName Name
QuoteStage	String	False	QuoteStage
ValidUntil	Date	False	ValidUntil
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
Carrier	String	False	Carrier
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
QuoteOwner_Id	String	False	QuoteOwner Id
QuoteOwner_FirstName	String	True	QuoteOwner FirstName
QuoteOwner_LastName	String	True	QuoteOwner LastName
QuoteOwner_Email	String	True	QuoteOwner Email
QuoteOwner_Name	String	True	QuoteOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
SubTotal	String	True	SubTotal
Discount	Decimal	False	Discount
Tax	Decimal	False	Tax
Adjustment	Decimal	False	Adjustment
GrandTotal	String	True	GrandTotal
TermsandConditions	String	False	TermsandConditions
Description	String	False	Description
QuotedItems	String	False	QuotedItems
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

SalesOrders

Create, update, delete, and query information regarding sales orders. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO SalesOrders (Subject, OrderedItems) VALUES ('Sales Order', '[
            { 
              "Product_Name": { 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, OrderedItems

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM SalesOrders WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE SalesOrders SET Description = 'Changed from the API.' WHERE Id = '3152079000000493027'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
CustomerNo.	String	False	CustomerNo.
SONumber	String	True	SONumber
Subject	String	False	Subject
DealName_Id	String	False	DealName Id
DealName_Name	String	True	DealName Name
PurchaseOrder	String	False	PurchaseOrder
QuoteName_Id	String	False	QuoteName Id
QuoteName_Name	String	True	QuoteName Name
DueDate	Date	False	DueDate
Pending	String	False	Pending
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
Carrier	String	False	Carrier
ExciseDuty	Decimal	False	ExciseDuty
SalesCommission	Decimal	False	SalesCommission
Status	String	False	Status
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
SalesOrderOwner_Id	String	False	SalesOrderOwner Id
SalesOrderOwner_FirstName	String	True	SalesOrderOwner FirstName
SalesOrderOwner_LastName	String	True	SalesOrderOwner LastName
SalesOrderOwner_Email	String	True	SalesOrderOwner Email
SalesOrderOwner_Name	String	True	SalesOrderOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
SubTotal	String	True	SubTotal
Discount	Decimal	False	Discount
Tax	Decimal	False	Tax
Adjustment	Decimal	False	Adjustment
GrandTotal	String	True	GrandTotal
TermsandConditions	String	False	TermsandConditions
Description	String	False	Description
OrderedItems	String	False	OrderedItems
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Solutions

Create, update, delete, and query information regarding solutions.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Sync App.

Insert

INSERT INTO Solutions (SolutionTitle, Status) VALUES ('Converting from XML to JSON', 'Created')

Required fields: SolutionTitle.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Solutions WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Solutions SET Question = 'Changed from the API.' WHERE Id = '3152079000000492018'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
SolutionNumber	String	False	SolutionNumber
SolutionOwner_Id	String	False	SolutionOwner Id
SolutionOwner_FirstName	String	True	SolutionOwner FirstName
SolutionOwner_LastName	String	True	SolutionOwner LastName
SolutionOwner_Email	String	True	SolutionOwner Email
SolutionOwner_Name	String	True	SolutionOwner Name
SolutionTitle	String	False	SolutionTitle
Published	Bool	False	Published
Status	String	False	Status
ProductName_Id	String	False	ProductName Id
ProductName_Name	String	True	ProductName Name
No.ofcomments	Int	True	No.ofcomments
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Question	String	False	Question
Answer	String	False	Answer
AddComment	String	False	AddComment
Comments	String	True	Comments
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Tasks

Create, update, delete, and query information regarding tasks.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Tasks(Subject, Status) VALUES ('Finish sending emails to potential leads.', 'Created')

INSERT INTO Tasks(Subject, Status, ModuleName) VALUES ('Finish sending emails to potential leads.', 'Created', 'Contacts')

INSERT INTO Tasks(Subject, Status, ModuleName, RelatedTo_Id) VALUES ('Finish sending emails to potential leads.', 'Created', 'Contacts', '2788704000120533263')

Required fields: Subject, ModuleName if RelatedTo_Id is specified.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Tasks WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Tasks SET Status = 'In progress' WHERE Id = '3152079000000492026'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
TaskOwner_Id	String	False	TaskOwner Id
TaskOwner_FirstName	String	True	TaskOwner FirstName
TaskOwner_LastName	String	True	TaskOwner LastName
TaskOwner_Email	String	True	TaskOwner Email
TaskOwner_Name	String	True	TaskOwner Name
Subject	String	False	Subject
DueDate	Date	False	DueDate
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
Status	String	False	Status
Priority	String	False	Priority
ClosedTime	Datetime	True	ClosedTime
SendNotificationEmail	Bool	False	SendNotificationEmail
Repeat_Id	String	False	Repeat Id
Repeat_Name	String	True	Repeat Name
Reminder_Id	String	False	Reminder Id
Reminder_Name	String	True	Reminder Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Description	String	False	Description
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime
ModuleName	String	False	ModuleName

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Vendors

Create, update, delete, and query information regarding vendors.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Vendors(VendorName, Email, Website) VALUES('XYZVendor', '[email protected]', 'vendeverything.xyz')

Required fields: VendorName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Vendors WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Vendors SET Description = 'Changed from the API' WHERE Id = '3152079000000492032'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
VendorName	String	False	VendorName
Phone	String	False	Phone
Email	String	False	Email
Website	String	False	Website
GLAccount	String	False	GLAccount
Category	String	False	Category
VendorOwner_Id	String	False	VendorOwner Id
VendorOwner_FirstName	String	True	VendorOwner FirstName
VendorOwner_LastName	String	True	VendorOwner LastName
VendorOwner_Email	String	True	VendorOwner Email
VendorOwner_Name	String	True	VendorOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Street	String	False	Street
City	String	False	City
State	String	False	State
ZipCode	String	False	ZipCode
Country	String	False	Country
Description	String	False	Description
VendorImage	String	False	VendorImage
Locked	Bool	True	Locked
EmailOptOut	Bool	False	EmailOptOut
UnsubscribedMode	String	True	UnsubscribedMode
UnsubscribedTime	Datetime	True	UnsubscribedTime
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Views

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

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

Zoho CRM Connector for CData Sync Views


Name	Description
ActionsPerformed	Query information regarding performed actions.
AllowedFromAddresses	To get the list of email addresses that you can send emails from.
CustomFieldHistoryTracking	Query information regarding histories for a particular custom field.
DealHistory	Query information regarding deal history.
EmailTemplateAttachments	To fetch the email template attachments in a module.
EmailTemplates	To fetch the email templates in a module.
Fields	To get the field metadata for the specified module.
InvoicedItems	Query information regarding invoiced items.
Layouts	To get the layouts metadata for the specified module.
ListFields	Get the field metadata for the specified module.
ModuleAttachedFiles	Retrieves all the files attached to a specified module.
Modules	To get the modules metadata for the specified account.
OrderedItems	Query information regarding ordered items.
Organizations	Query information regarding organizations.
PriceBookPricingDetails	Query information regarding pricing details. Not available in free and standard ZohoCRM accounts.
Profiles	Query information regarding profiles.
PurchaseItems	Query information regarding purchase items.
QuotedItems	Query information regarding quoted items.
RecordCount	To fetch the total number of records in the module.
Roles	Query information regarding roles.
StageHistories	Query information regarding stage histories for a particular deal.
Territories	Get the list of territories enabled for your organization.
Users	Query information regarding users.
Visits	Query information regarding recent visits.

ActionsPerformed

Query information regarding performed actions.

Table-Specific Information

Select

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

Note : ActionsPerformed cannot be queried until it is enabled from the UI.

SELECT * FROM ActionsPerformed

Columns


Name	Type	Description
Id [KEY]	String	The Id of the performed action.
ActionType	String	The type of the performed action.
Actions	String	The actions performed.
TimeSpent	String	The time spent performing the action.
ActionPerformedTime	Datetime	The date and time when the action was performed.
ParentID_Id	String	The Id of the parent object where the action was performed.
ParentID_Name	String	The name of the parent object where the action was performed.
ChatAttachment_Id	String	The Id of the chat attachment for the action.
ChatAttachment_Name	String	The name of the chat attachment for the action.

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

AllowedFromAddresses

To get the list of email addresses that you can send emails from.

Table-Specific Information

Note : This view is available for API Version 2.1 and above.

Select

The following queries are processed server side:

SELECT * FROM AllowedFromAddresses

Columns


Name	Type	Description
Id	String	Id of AllowedFromAddresses.
Email	String	Email addresses that you can send emails from.
Type	String	Type of email address.
UserName	String	User Name of the email.
Default	Boolean	Flag to determine if the email is default.

CustomFieldHistoryTracking

Query information regarding histories for a particular custom field.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

ModuleName supports the '=' operator.
EntityId supports the '=' operator.
FieldName supports the '=' operator.
HistoryName supports the '=' operator.

All columns used in the criteria are required. Use FieldName to specify the actual name of the tracked custom field and HistoryName to specify the name of the history tracking section. If you want to retrieve data for a specific entity of a module specify EntityId in the criteria. For example, the following query is processed server side:

SELECT * FROM [CustomFieldHistoryTracking] WHERE ModuleName = 'Leads' AND FieldName = 'pickListField' AND HistoryName = 'Pick List 1'

SELECT * FROM [CustomFieldHistoryTracking] WHERE ModuleName = 'Leads' AND FieldName = 'pickListField' AND HistoryName = 'Pick List 1' AND EntityId = '12345665'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the history.
ModuleName	String	A unique numeric identifier for the module instance this custom field tracking belongs to.
EntityId	String	A unique numeric identifier for the module instance this custom field tracking belongs to.
FieldName	String	The name of the custom field.
HistoryName	String	The name of the custom field tracking history.
FieldValue	String	The value of the custom field.
DurationDays	Integer	The duration of this stage.
ModifiedAt	Datetime	The time this historical value was last modified.
ModifiedById	String	The id of the user who modified the value.
ModifiedByName	String	The name of the user who modified the value.
CurrencySymbol	String	The currency symbol for the value.
ProcessFlow	Boolean	The boolean indicating the process flow for this historical value.
Editable	Boolean	The boolean indicating if this historical value can be edited.
Approved	Boolean	The boolean indicating if this historical value has been approved.

DealHistory

Query information regarding deal history.

Columns


Name	Type	Description
Id [KEY]	String
DealName_Id	String
DealName_Name	String
Stage	String
StageDuration(CalendarDays)	Int
ModifiedBy_Id	String
ModifiedBy_Name	String
ModifiedTime	Datetime
Amount	Decimal
Probability(%)	Int
ExpectedRevenue	Decimal
ClosingDate	Date
LastActivityTime	Datetime
MovedTo	String

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.
Trigger	String	To trigger the rule while inserting record into CRM account.

EmailTemplateAttachments

To fetch the email template attachments in a module.

Table-Specific Information

Note : This view is available for API Version 2.1 and above.

Select

The Sync App will use the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

EmailTemplateIdId supports the '=,IN' operator.
ModuleName supports the '=,IN' operator.

For example, the following queries are processed server side:

SELECT * FROM EmailTemplateAttachments

SELECT * FROM EmailTemplateAttachments where EmailTemplateId = '721000000'

SELECT * FROM EmailTemplateAttachments where ModuleName='Accounts'

Columns


Name	Type	Description
Id [KEY]	String	Id of attachment.
EmailTemplateId	String	Represents the unique ID of the email template.
FileId	String	File Id of attachment.
FileName	String	File Name of attachment.
Size	String	Size of attachment.
ModuleName	String	The name of the module which the user wants the fields.

EmailTemplates

To fetch the email templates in a module.

Table-Specific Information

Note : This view is available for API Version 2.1 and above.

Select

The Sync App will use the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

Id supports the '=,IN' operator.
ModuleApiName supports the '=,IN' operator.

For example, the following queries are processed server side:

SELECT * FROM EmailTemplates

SELECT * FROM EmailTemplates where id = '721000000'

SELECT * FROM EmailTemplates where ModuleApiName='Accounts'

Columns


Name	Type	Description
Id [KEY]	String	Represents the unique ID of the email template.
Associated	Boolean	Represents whether the template is associated or not.
Attachments	String	Represents the attachments added in the template.
Category	String	Represents the type of the template. The allowed values are custom_templates, system_templates, plugin_templates, marketplace_templates.
ConsentLinked	Boolean	Represents whether the consent form is linked with the template.
CreatedById	String	Represents the ID of the user who created the email template.
CreatedByName	String	Represents the name of the user who created the email template.
CreatedTime	Datetime	Represents the date and time at which the email template was created.
EditorMode	String	Represents the mode in which the email template is created. The allowed values are gallery, rich_text, plain_text.
Favorite	Boolean	Represents if the email template is marked as favorite.
FolderId	String	Represents the unique ID of the template folder.
FolderName	String	Represents the name of the template folder.
LastUsageTime	Datetime	Represents the date and time at which the email template was last used.
Layout	String	Represents the layout Id the template is associated with.
ModifiedById	String	Represents the ID of the user who last modified the email template.
ModifiedByName	String	Represents the name of the user who last modified the email template.
ModifiedTime	Datetime	Represents the date and time at which the email template was last modified.
ModuleApiName	String	Represents the module api name with which the template is associated with.
ModuleId	String	Represents the module id with which the template is associated with.
Name	String	Represents the name of the email template.
Subject	String	Represents the subject of the email template.

Fields

To get the field metadata for the specified module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

ModuleName supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Fields WHERE ModuleName = 'Deals'

Columns


Name	Type	Description
DisplayValue	String	The name of the field.
ActualValue	String	The actual name of the field.
Id	String	The unique identifier of the field
ModuleName	String	The name of the module which the user wants the fields.

InvoicedItems

Query information regarding invoiced items.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM InvoicedItems WHERE Id = '3152079000000301143'

NOTE: This table is not supported in v2.

Columns

Description [KEY] String Long Datetime String String String String String String String String Decimal String Decimal String Decimal String String

Pseudo-Columns


Name	Type
Id
S.NO
CreatedTime
ParentID_Id
ParentID_Name
ProductName_Id
ProductName_Name
PriceBook_Id
PriceBook_Name
Description
Quantity
ListPrice
Amount
Discount
TotalAfterDiscount
Tax
Total
TaxbyPercentage

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.
Trigger	String	To trigger the rule while inserting record into CRM account.

Layouts

To get the layouts metadata for the specified module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

ModuleName supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM Layouts WHERE ModuleName = 'Deals'

Columns


Name	Type	Description
Id	String	The unique identifier of the layout.
Name	String	Represents the name of the layout.
Type	String	Represents if the section is used or not in the layout.
ModuleName	String	The name of the module which the user wants the layout.

ListFields

Get the field metadata for the specified module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

ModuleName supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM ListFields WHERE ModuleName = 'Deals'

Columns


Name	Type	Description
ApiName	String	The API Name.
AssociationDetails	String	The Association Details.
BlueprintSupported	Boolean	Is Blueprint Supported.
BusinesscardSupported	Boolean	Is Businesscard Supported.
ConvertMappingAccounts	String	The Convert Mapping Accounts.
ConvertMappingContacts	String	The Convert Mapping Contacts.
ConvertMappingDeals	String	The Convert Mapping Deals.
CreatedSource	String	The Created Source.
Crypt	String	The Crypt.
CurrencyPrecision	Integer	The Currency Precision.
CurrencyRoundingOption	String	The Currency Rounding Option.
CustomField	Boolean	Is Custom Field.
DataType	String	The Data Type.
DecimalPlace	Integer	The Decimal Place.
DisplayField	Boolean	Is Display Field.
DisplayLabel	String	The Display Label.
DisplayType	Integer	The Display Type.
External	String	The External.
FieldLabel	String	The Field Label.
FieldReadOnly	Boolean	Is Field ReadOnly.
Filterable	Boolean	Is Filterable.
HistoryTracking	String	The History Tracking.
Id	String	The Id.
JsonType	String	The JSON Type.
Length	Integer	The Length.
MassUpdate	Boolean	Is Mass Update.
PickListValues	String	The Pick List Values.
PickListValuesSortedLexically	Boolean	Are Pick List Values Sorted Lexically.
Profiles	String	The Profiles.
QuickSequenceNumber	String	The QuickSequenceNumber.
ReadOnly	Boolean	Is ReadOnly.
Sortable	Boolean	Is Sortable.
Subform	String	The Subform.
SystemMandatory	Boolean	Is System Mandatory.
Tooltip	String	The Tool tip.
Type	String	The Type.
UiType	Integer	The Ui Type.
ViewTypeCreate	Boolean	Is View Type Create.
ViewTypeEdit	Boolean	Is View Type Edit.
ViewTypeQuickCreate	Boolean	Is View Type Quick Create.
ViewTypeView	Boolean	Is View Type View.
Visible	Boolean	Is Visible.
Webhook	Boolean	Is Webhook.
ModuleName	String	The name of the module which the user wants the fields.

ModuleAttachedFiles

Retrieves all the files attached to a specified module.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

ModuleName supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM ModuleAttachedFiles WHERE ModuleName = "Leads"

Note: The UploadFile and DownloadFile stored procedures will not work as expected if executed in regards to a custom field. They only upload or download files in the "Attachments" section of the module. Uploading and deleting files from a custom field of type "fileupload" can be done only through the UI.

Columns


Name	Type	Description
FileId	String	Id of the file attached to the module.
FileName	String	Name of the file attached to the module.
AttachmentId [KEY]	String	Id of the attachment.
CreatorId	String	Id of the user who uploaded the attachment.
EntityId	String	Id of the entity.
DownloadUrl	String	URL to download the attachment.
PreviewUrl	String	URL to preview the attachmen.
FileSize	String	The size of the attachment.
FileExtension	String	Extension of the attachment.
ModuleName	String	Id of the module.

Modules

To get the modules metadata for the specified account.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

For example, the following queries are processed server-side:

SELECT * FROM Modules

Columns


Name	Type	Description
Id	String	The unique identifier of the modules
Name	String	The name of the module which the user wants.
SequenceNumber	Integer	The sequence number of the field.
ApiName	String	The api name of the field.
GlobalSearchSupported	Boolean	Represents if the current module has global search support.
Deletable	Boolean	Describes if the user can delete a record in the current module.
Description	String	Represents the description of the module, if any.
Creatable	Boolean	Represents if the user can create records in the current module.
InventoryTemplateSupported	Boolean	Represents the module supports inventory template. The value will be true only for Quotes, Invoices, Purchase Orders, and Sales Orders modules.
ModifiedDateTime	Datetime	Represents the date and time of when the module properties were last modified.
PluralLabel	String	Represents the plural of the module name. Example: Leads.
SingularLabel	String	Represents the singular of the module name. Example: Lead.
PresenceSubMenu	Boolean	Represents if the module has a submenu. For instance, Tasks in Activities is a submenu.
TriggersSupported	Boolean	Represents if the module supports triggers from custom buttons, workflows, approval etc.
Visibility	Integer	Represents the visibility of the module in the org. 1- The module is visible, default value; 2- The module is hidden; XXXX - The sum of the feature numbers that are hidden.
Convertable	Boolean	Describes if the user can convert the record into another type of record. For example: Convert Leads into Deals.
Editable	Boolean	Describes if the user can edit a record in the current module.
EmailTemplateSupport	Boolean	Represents if the module supports the usage of the email templates.
FilterSupported	Boolean	Represents if the module supports custom filters besides the system-defined ones in a custom view.
ShowAsTab	Boolean	Represents if the module is displayed as a tab in the CRM UI.
Viewable	Boolean	Represents if the user can view the records in the current module.
ApiSupported	Boolean	Describes if the current module is accessible via API.
QuickCreate	Boolean	Represents if the module supports quick create.
ModifiedByName	String	Represents the name of the user who last modified the module properties.
ModifiedById	String	Represents the ID of the user who last modified the module properties.
GeneratedType	String	Represents how the module was created.
FeedsRequired	Boolean	Represents if feeds is enabled for the module.
ScoringSupported	Boolean	Represents if the records of the module qualify for the scoring process, if there is one.
WebformSupported	Boolean	Represents if the records in the module can be created via web forms.
BusinessCardFieldLimit	Integer	Represents the number of fields you can have in the business card details.
ParentModuleApiName	String	Represents the api name of the parent module, if any. For instance, Activities is the parent module for Tasks, Calls, and Events.
ParentModuleId	String	Represents the id of the parent module, if any.
WebLink	String	Represents the web link of the module, if any. For instance, https://extensions.zoho.com/plugin/facebook
IsBlueprintSupported	Boolean	Is blueprint Supported.

OrderedItems

Query information regarding ordered items.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM OrderedItems WHERE Id = '3152079000000301143'

NOTE: This table is not supported in v2.

Columns


Name	Type	Description
Id [KEY]	String
S.NO	Long
CreatedTime	Datetime
ParentID_Id	String
ParentID_Name	String
ProductName_Id	String
ProductName_Name	String
PriceBook_Id	String
PriceBook_Name	String
Description	String
Quantity	String
ListPrice	Decimal
Amount	String
Discount	Decimal
TotalAfterDiscount	String
Tax	Decimal
Total	String
TaxbyPercentage	String

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.
Trigger	String	To trigger the rule while inserting record into CRM account.

Organizations

Query information regarding organizations.

View-Specific Information

Select

The Sync App processes filters client-side within the Sync App.

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the organization.
CompanyName	String	The name of the company for this organization.
PrimaryEmail	String	The primary email of the organization.
Phone	String	The phone number of the organization.
Mobile	String	The mobile phone number of the organization.
IsoCode	String	The ISO code of the organization.
Description	String	The description of the organization.
Country	String	The country where this organization is situated.
City	String	The city where this organization is situated.
State	String	The state where this organization is situated.
Street	String	The street where this organization is situated.
Zip	String	The zip where this organization is situated.
CountryCode	String	The country code of the organization.
Alias	String	The alias of the organization.
Fax	String	The fax of the organization.
EmployeeCount	Int	The number of employees this organization has.
Website	String	The website of the organization.
CurrencySymbol	String	The default currency symbol for the organization.
CurrencyLocale	String	The default currency locale for the organization.
PrimaryZuid	String	The primary ZUID for the organization.
TimeZone	String	The time zone for the organization.
Zgid	String	The zgid for the organization.
MCStatus	Boolean	Whether this organization has MC status or not.
GappsEnabled	Boolean	Whether this organization has gapps enabled or not.
LicenseDetailsPaidExpiry	Datetime	The date and time the subscription expires for this organization.
LicenseDetailsTrialType	String	The trial type of subscription the organization has.
LicenseDetailsTrialExpiry	Datetime	The date and time the trial subscription expires for this organization.
LicenseDetailsPaid	Boolean	Whether the organization has a paid subscription.
LicenseDetailsPaidType	String	The type of subscription the organization has.
LicenseDetailsUsersLicensePurchased	Integer	The number of licenses purchased by the organization.
PhotoId	String	Represents the unique ID of the organization photo file.
DomainName	String	Represents the domain name of the organization. For instance, org694902300.
TranslationEnabled	Boolean	Represents if translation is enabled for the organization.
Currency	String	Represents the base/home currency details of the organization.
ZiaPortalId	String	Represents Zia portal ID of the organization, if configured.
PrivacySettings	String	Represents if the privacy settings are enabled for the organization.
HipaaComplianceEnabled	Boolean	Represents if HIPAA compliance is enabled for the organization.

PriceBookPricingDetails

Query information regarding pricing details. Not available in free and standard ZohoCRM accounts.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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.

PriceBookId supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM PriceBookPricingDetails WHERE PriceBookId = '3152079000000317001'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the pricing detail.
PriceBookId [KEY]	String	A unique numeric identifier for the price book this pricing detail belongs to.
Discount	Double	How much discount should be applied for this pricing detail.
FromRange	Double	Starting from what amount should this discount be applied.
ToRange	Double	Until what amount should this discount be applied.

Profiles

Query information regarding profiles.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Profiles WHERE Id = '3152079000000026011'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the profile.
Name	String	The name of the profile.
Description [KEY]	String	A small description regarding this profile.
CreatedByName	String	The name of the user who created this profile.
CreatedById	String	The id of the user who created this profile.
CreatedAt	Datetime	The time this profile was created.
ModifiedByName	String	The name of the user who modified this profile.
ModifiedById	String	The id of the user who modified this profile.
ModifiedAt	Datetime	The time this profile was last modified.
Category	Boolean	Whether this profile is a category or not.
DisplayLabel	String	Represents the display name of the current profile.

PurchaseItems

Query information regarding purchase items.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM PurchaseItems WHERE Id = '3152079000000301143'

NOTE: This table is not supported in v2.

Columns


Name	Type	Description
Id [KEY]	String
S.NO	Long
CreatedTime	Datetime
ParentID_Id	String
ParentID_Name	String
ProductName_Id	String
ProductName_Name	String
PriceBook_Id	String
PriceBook_Name	String
Description	String
Quantity	String
ListPrice	Decimal
Amount	String
Discount	Decimal
TotalAfterDiscount	String
Tax	Decimal
Total	String
TaxbyPercentage	String

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.
Trigger	String	To trigger the rule while inserting record into CRM account.

QuotedItems

Query information regarding quoted items.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM QuotedItems WHERE Id = '3152079000000301143'

NOTE: This table is not supported in v2.

Columns


Name	Type	Description
Id [KEY]	String
S.NO	Long
CreatedTime	Datetime
ParentID_Id	String
ParentID_Name	String
ProductName_Id	String
ProductName_Name	String
PriceBook_Id	String
PriceBook_Name	String
Description	String
Quantity	String
ListPrice	Decimal
Amount	String
Discount	Decimal
TotalAfterDiscount	String
Tax	Decimal
Total	String
TaxbyPercentage	String

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.
Trigger	String	To trigger the rule while inserting record into CRM account.

RecordCount

To fetch the total number of records in the module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The module is a mandatory filter for the Sync App.

Note: It works only with ApiVersion=2.1.

ModuleName supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM RecordCount WHERE ModuleName = 'Leads'

SELECT * FROM RecordCount WHERE ModuleName IN ('Leads','Invoices')

Columns


Name	Type	Description
Count [KEY]	Integer	The total number of records in the module.
ModuleName	String	The name of the module which the user wants the count.

Roles

Query information regarding roles.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Roles WHERE Id = '3152079000000026008'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the role.
Name	String	The name of the role.
DisplayLabel [KEY]	String	The way the role is displayed in the UI.
ReportingToName	String	The name of the role this role reports to.
ReportingToId	String	The id of the role this role reports to.
AdminUser	Boolean	Whether this role has administrative privileges or not.
ForecastManagerName	String	The forecast manager's name.
ForecastManagerId	String	The forecast manager's id.
ShareWithPeers	Boolean	Represents if the users with the current role have the permission to share records.
Description	String	Represents the description of the role, if any.

StageHistories

Query information regarding stage histories for a particular deal.

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the stage.
DealId	String	A unique numeric identifier for the deal this stage belongs to.
Stage	String	The stage number for this stage.
Amount	Decimal	The amount of money spent for this stage.
DurationDays	Integer	The duration of this stage.
ExpectedRevenue	Decimal	The expected revenue from this stage.
Probability	Decimal	The probability for the stage to happen.
CloseDate	Date	The date when this stage closes.
LastModifiedTime	Datetime	The time this stage was last modified.
ModifiedById	String	The id of the user who modified the stage.
ModifiedByName	String	The name of the user who modified the stage.

Territories

Get the list of territories enabled for your organization.

Select

All the filters are executed at client side within the Sync App.

SELECT * from Territories;

Columns


Name	Type	Description
Id [KEY]	String	Represents the unique ID of the territory.
Name	String	Represents the name of the territory.
ParentId	String	Represents the unique ID of the parent territory, if any.
Criteria	String	Represents the territory criteria details.
Managername	String	Represents the name of the current territory's manager.
Managerid	String	Represents the ID of the current territory's manager.
CreatedByName	String	Represents the name of the user who created the current territory.
CreatedById	String	Represents the ID of the user who created the current territory.
ModifiedByName	String	Represents the name of the user who last modified the current territory.
ModifiedByid	String	Represents the ID of the user who last modified the current territory.
CreatedAt	Datetime	Represents the date and time at which the current territory was created.
ModifiedAt	Datetime	Represents the date and time at which the current territory was last modified.
Desription	String	Represents the description of the territory, if any.

Users

Query information regarding users.

View-Specific Information

Select

The Sync App will use the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Users WHERE Id = '3152079000000150015'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the user.
FirstName	String	The first name of the user.
LastName	String	The last name of the user.
FullName	String	The full name of the user.
Email	String	The email of the user.
RoleName	String	The name of the role the user has.
RoleId	String	The Id of the role the user has.
ProfileName	String	The name of the profile the user has.
ProfileId	String	The Id of the profile the user has.
Country	String	The country where the user is situated.
City	String	The city where the user is situated.
Street	String	The street where the user is situated.
State	String	The state where the user is situated.
Zip	String	The zip where the user is situated.
Alias	String	The alias of the user.
Signature	String	The signature of the user.
NameFormat	String	The format of the name of the user.
PersonalAccount	Boolean	Whether this user has a personal account or not.
DefaultTabGroup	String	The default tab group for this user.
CountryLocale	String	The default country locale of the user.
Fax	String	The fax of the user.
Website	String	The website of the user.
Mobile	String	The mobile phone number of the user.
Phone	String	The phone number of the user.
Dob	String	The date of birth of the user.
Status	String	The status of the user.
Confirm	Boolean	Whether this user has confirmed his email or not.
Language	String	The Language of the user.
Locale	String	The locale of the user.
TimeFormat	String	The default time format of the user.
DateFormat	String	The default date format of the user.
DecimalSeparator	String	The locale of the default decimal separator of the user.
TimeZone	String	The time zone of the user.
Zuid	String	The default ZUID of the user.
Territories	String	A comma separeted string of the user's territories.
CreatedByName	String	The name of the user who created this user.
CreatedById	String	The id of the user who created this user.
CreatedAt	Datetime	The time this user was created.
ModifiedByName	String	The name of the user who modified this user.
ModifiedById	String	The id of the user who modified this user.
ModifiedAt	Datetime	The time this user was last modified.
CustomizeInfoNotesDesc	String	The Customize info notes description.
CustomizeInfoShowRightPanel	Boolean	The Customize info show right panel.
CustomizeInfoShowLeftPanel	Boolean	The Customize info show left panel.
CustomizeInfoBcView	String	The Customize info bc view.
CustomizeInfoShowHome	Boolean	The Customize info show home.
CustomizeInfoShowDetailView	Boolean	The Customize info show detail view.
CustomizeInfoUnpinRecentItem	String	The Customize info unpin recent item.
Microsoft	Boolean	Represents if the user is a microsoft user.
ThemeBackground	String	The theme background.
ThemeNewBackground	String	The theme new background.
ThemeNormalTabBackground	String	The theme normal tab background.
ThemeNormalTabFontColor	String	The theme normal tab font color.
ThemeScreen	String	The theme screen.
ThemeSelectedTabBackground	String	The theme selected tab background.
ThemeSelectedTabBackground	String	The theme selected tab background.
ThemeType	String	The theme type.
ReportingToName	String	Represents the name of the user to whom the user reports to.
ReportingToId	String	Represents the id of the user to whom the user reports to.
Offset	Integer	Offset.
SandboxDeveloper	Boolean	Sandbox Developer.
Category	String	The category of the user.
SortOrderPreference	String	Sort Order Preference.

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
Type	String	Limit the users returned to the ones of this type The allowed values are AllUsers, ActiveUsers, DeactiveUsers, ConfirmedUsers, NotConfirmedUsers, DeletedUsers, ActiveConfirmedUsers, AdminUsers, ActiveConfirmedAdmins, CurrentUser.

Visits

Query information regarding recent visits.

Columns


Name	Type	Description
Id [KEY]	String	The Id of the visit.
PageVisited	String	The name of the visited page.
VisitedBy_Id	String	The Id of the visitor.
VisitedBy_FirstName	String	The First Name of the visitor.
VisitedBy_LastName	String	The Last Name of the visitor.
IPAddress	String	The IP address of the visitor.
TimeSpent(Minutes)	String	The time spent in minutes for the visit.
Referrer	String	The referrer of the visitor.
VisitedPageURL	String	The URL of the visited page.
CreatedBy_Id	String	The Id of the object which created the visit.
ModifiedBy_Id	String	The Id of the object which modified the visit.
ModifiedBy_FirstName	String	The First Name of the object which modified the visit.
ModifiedBy_LastName	String	The Last Name of the object which modified the visit.
CreatedTime	Datetime	The date and time when the visit was created.
ModifiedTime	Datetime	The date and time when the visit was modified.
AttendedBy	String	Who attended the visit.
UserDetails	String	The user details of the visit.
Browser	String	The browser used for the visit.
TimeVisited	Datetime	The date and time of the visit.
VisitorType	String	The type of visitor for the visit.
Revenue	Decimal	The revenue generated by the visit.
NumberofPages	Int	The number of pages visited from the visit.
PortalName	String	The name of the portal used for the visit.
SearchKeyword	String	The search keyword used for the visit.
SearchEngine	String	The search engine used for the visit.
OperatingSystem	String	The operating system of the visitor.
Gclid	String	The GCLID of the visitor.
Keyword	String	The keyword used in the visit.
ClickType	String	The click type of the visit.
Devicetype	String	The type of the device of the visitor.
AdNetwork	String	The ad network used in the visit.
SearchPartnerNetwork	String	The search partner network for the visit.
AdCampaignName	String	The ad campaign name of the visit.
AdGroupName	String	The ad group name of the visit.
Ad	String	The ad used for the visit.
AdClickDate	Date	The date and time when the ad was clicked.
VisitSource	String	The source of the visit.

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

v4

CData Sync App models Zoho CRM Modules as relational tables.

Zoho CRM APIs

The Zoho CRM Sync App supports the following APIs to query data from the source.

Query API : Uses COQL to query data from Zoho CRM. To use this API, set UseCOQL to True.
Bulk API : Uses the Bulk API to query data from Zoho CRM. To use this API, set UseCOQL to False and APIType to Bulk.
REST API : Uses REST endpoints to query data from Zoho CRM. To use this API, set UseCOQL to False and APIType to REST.

API Limitations

V4 of Zoho CRM imposes limits on the maximum number of rows and columns that interfacing tools such as the CData Sync App can retrieve from its APIs.

The limits vary based on whether you're using the Query API, Bulk API, or REST API. These limits are:

Query API: Maximum of 100,000 rows and 50 columns.
Bulk API: Over 100,000 rows and no more than 200 columns.
REST API: Maximum of 10,000 rows and 50 columns.

API Metadata

The columns and values retrieved from tables and views vary based on whether you're using the Query API, Bulk API, or REST API. These variations are:

Query API
- For Lookup type columns, the *_Id is displayed and has a value, but *_Name doesn't appear.
- For *Owner and *ModifiedBy columns, *_Id, *_firstname, and *_lastname are displayed and have values, but *_Name doesn't appear.
Bulk API
- For Lookup type columns, the *_Id and _Name are displayed, but only *Id has a value.
- For *Owner and *ModifiedBy columns, *_Id, *_Name, *_firstname, and *_lastname are displayed, but *_Name has no value.
REST API
- For Lookup type columns, the *_Id and _Name are displayed and both have values.
- For *Owner and *ModifiedBy columns, *_Id, *_Name, *_firstname, and *_lastname are displayed, but *_firstname and *_lastname have no values.

Using Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to the Zoho CRM APIs and then processes the rest of the query within the Sync App. The following sections document API limitations and requirements.

Tables

The Sync App connects to Zoho CRM and retrieves the list of Tables and the metadata for the tables by calling the appropriate Web services. Any changes you make to your Zoho CRM account, such as adding a custom module, adding a custom field, or changing the data type of a field, occur immediately when you connect using the Sync App. Tables shows an example, based on the Zoho CRM development environment, of what the entities in your account may look like.

Note: The Bulk API is not supported by the Notes table. Due to this, if you are using the Bulk API, the Sync App will instead use the REST API (with its associated limitations) when working with notes data.

Views

Most Views are defined in static configuration files. Custom Views are not. Instead, custom views are dynamically retrieved by connecting to Zoho CRM, calling the appropriate Web service, and retreving the list of custom views from the metadata returned. Any changes you make to your Zoho CRM account, such as adding a new custom view, occur immediately when you connect using the Sync App.

To use Custom Views, set the IncludeCustomViews property to true. Its default value is false since custom views introduce an overhead when retrieving the list of tables and views.

Criteria applied in the custom view (either when creating it or when editing it in the UI) are preserved in CData Zoho CRM Sync App. Nonetheless, further filtering on records is available at any time.

To use Relative Views you must set property IncludeRelatedLists to true. Its default value is false since related views introduce an overhead when retrieving the list of tables and views.

EntityId is required to fetch the related module data. This field refers to the parent module Id.

Stored Procedures

Stored Procedures provides additional capabilities in the Zoho CRM API, including working with files.

Tables

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

Zoho CRM Connector for CData Sync Tables


Name	Description
Accounts	Create, update, delete, and query information regarding Accounts.
Attachments	Create, update, delete, and query information regarding attachments.
Calls	Create, update, delete, and query information regarding calls.
Campaigns	Create, update, delete, and query information regarding campaigns.
Cases	Create, update, delete, and query information regarding cases.
ContactRoles	Get, add, update, or delete the list of contact roles
Contacts	Create, update, delete, and query information regarding contacts.
Currencies	Get, add or update currencies to your organization.
Deals	Create, update, delete, and query information regarding deals.
Invoices	Create, update, delete, and query information regarding invoices. Not available in free and standard ZohoCRM accounts.
Leads	Create, update, delete, and query information regarding leads.
Meetings	Create, update, delete, and query information regarding meetings.
Notes	Create, update, delete, and query information regarding notes.
Pipeline	To fetch the details of all or a specific pipeline in the Deals module. It works only with ApiVersion=2.1.
PriceBooks	Create, update, delete, and query information regarding price books. Not available in free and standard ZohoCRM accounts.
Products	Create, update, delete, and query information regarding products.
PurchaseOrders	Create, update, delete, and query information regarding purchase orders. Not available in free and standard ZohoCRM accounts.
Quotes	Create, update, delete, and query information regarding quotes. Not available in free and standard ZohoCRM accounts.
SalesOrders	Create, update, delete, and query information regarding sales orders. Not available in free and standard ZohoCRM accounts.
Solutions	Create, update, delete, and query information regarding solutions.
Tasks	Create, update, delete, and query information regarding tasks.
Vendors	Create, update, delete, and query information regarding vendors.

Accounts

Create, update, delete, and query information regarding Accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side. The rest of the filter is executed client-side within the Sync App.

Insert

INSERT INTO Accounts(AccountName) VALUES('my name')

Required fields: AccountName.

Any field which is not read-only (ReadOnly = false in the table below below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Accounts WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Accounts SET Description = 'Updated from API' WHERE Id = '3152079000000153079'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
AccountOwner_Id	String	False	AccountOwner Id
AccountOwner_FirstName	String	True	AccountOwner FirstName
AccountOwner_LastName	String	True	AccountOwner LastName
AccountOwner_Email	String	True	AccountOwner Email
AccountOwner_Name	String	True	AccountOwner Name
Rating	String	False	Rating
AccountName	String	False	AccountName
Phone	String	False	Phone
Fax	String	False	Fax
ParentAccount_Id	String	False	ParentAccount Id
ParentAccount_Name	String	True	ParentAccount Name
Website	String	False	Website
TickerSymbol	String	False	TickerSymbol
AccountType	String	False	AccountType
Ownership	String	False	Ownership
Industry	String	False	Industry
Employees	Int	False	Employees
AnnualRevenue	Decimal	False	AnnualRevenue
SICCode	Int	False	SICCode
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
LastActivityTime	Datetime	True	LastActivityTime
AccountNumber	Long	False	AccountNumber
AccountSite	String	False	AccountSite
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
Description	String	False	Description
AccountImage	String	False	AccountImage
RecordId	Long	True	RecordId
ChangeLogTime	Datetime	True	ChangeLogTime
Locked	Bool	True	Locked
LastEnrichedTime	Datetime	True	LastEnrichedTime
EnrichStatus	String	True	EnrichStatus

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Attachments

Create, update, delete, and query information regarding attachments.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

SELECT * FROM Attachments

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Attachments WHERE Id = '3152079000000431011'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
AttachmentOwner_Id	String	False	AttachmentOwner Id
AttachmentOwner_FirstName	String	True	AttachmentOwner FirstName
AttachmentOwner_LastName	String	True	AttachmentOwner LastName
AttachmentOwner_Email	String	True	AttachmentOwner Email
AttachmentOwner_Name	String	True	AttachmentOwner Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
CreatedAt	Datetime	True	CreatedAt
ModifiedAt	Datetime	True	ModifiedAt
FileName	String	False	FileName
Size	Long	False	Size
ParentID_Id	String	False	ParentID Id
ParentID_Name	String	True	ParentID Name
RecordId	Long	True	RecordId
ModuleName	String	False	ModuleName
Editable	String	False	Editable
FileId	String	False	FileId
Type	String	False	Type
State	String	False	State
LinkUrl	String	False	LinkUrl

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
Converted	Bool	To get the list of converted records.
Approved	Bool	To retrieve the list of approved records. Default value is true.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Calls

Create, update, delete, and query information regarding calls.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Calls (Subject, ModuleName, RelatedTo_Id,CallType,CallStartTime) VALUES ('A test call', 'Accounts', '5768552000000433001','Outbound','May 20, 2023 12:00 AM')

Required fields: Subject, ModuleName, CallType, CallStartTime and ContactName_Id if ModuleName = Contacts and RelatedTo_Id if any other modulename is specified.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Calls WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Calls SET Subject = 'Updated from API' WHERE Id = '3152079000000484001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
CallOwner_Id	String	False	CallOwner Id
CallOwner_FirstName	String	True	CallOwner FirstName
CallOwner_LastName	String	True	CallOwner LastName
CallOwner_Email	String	True	CallOwner Email
CallOwner_Name	String	True	CallOwner Name
Subject	String	False	Subject
CallType	String	False	CallType
CallPurpose	String	False	CallPurpose
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
CallStartTime	Datetime	False	CallStartTime
CallDuration	String	False	CallDuration
CallDuration(inseconds)	Int	False	CallDuration(inseconds)
Description	String	False	Description
CallResult	String	False	CallResult
CTIEntry	Bool	False	CTIEntry
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Reminder	String	False	Reminder
Tag	String	False	Tag
OutgoingCallStatus	String	False	OutgoingCallStatus
ScheduledinCRM	String	True	ScheduledinCRM
RecordId	Long	True	RecordId
LastActivityTime	Datetime	False	LastActivityTime
CallAgenda	String	False	CallAgenda
CallerID	String	True	CallerID
DialledNumber	String	True	DialledNumber
VoiceRecording	String	False	VoiceRecording
ModuleName	String	False	ModuleName

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Campaigns

Create, update, delete, and query information regarding campaigns.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Campaigns (CampaignName) VALUES ('a test campaign')

Required fields: CampaignName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Campaigns WHERE Id = '3152079000000485001'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Campaigns SET CampaignName = 'Updated from API' WHERE Id = '3152079000000485001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
CampaignOwner_Id	String	False	CampaignOwner Id
CampaignOwner_FirstName	String	True	CampaignOwner FirstName
CampaignOwner_LastName	String	True	CampaignOwner LastName
CampaignOwner_Email	String	True	CampaignOwner Email
CampaignOwner_Name	String	True	CampaignOwner Name
Type	String	False	Type
CampaignName	String	False	CampaignName
Status	String	False	Status
StartDate	Date	False	StartDate
EndDate	Date	False	EndDate
ExpectedRevenue	Decimal	False	ExpectedRevenue
BudgetedCost	Decimal	False	BudgetedCost
ActualCost	Decimal	False	ActualCost
ExpectedResponse	Long	False	ExpectedResponse
Numberssent	Long	False	Numberssent
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Description	String	False	Description
ParentCampaign_Id	String	False	ParentCampaign Id
ParentCampaign_Name	String	True	ParentCampaign Name
RecordId	Long	True	RecordId
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Cases

Create, update, delete, and query information regarding cases.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Cases (Email, Priority, Subject) VALUES ('[email protected]', 'Medium', 'A simple test case')

Required fields: Subject.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Cases WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Cases SET Priority = 'Low' WHERE Id = '3152079000000473022'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
CaseReason	String	False	CaseReason
CaseNumber	String	True	CaseNumber
CaseOwner_Id	String	False	CaseOwner Id
CaseOwner_FirstName	String	True	CaseOwner FirstName
CaseOwner_LastName	String	True	CaseOwner LastName
CaseOwner_Email	String	True	CaseOwner Email
CaseOwner_Name	String	True	CaseOwner Name
Status	String	False	Status
ProductName_Id	String	False	ProductName Id
ProductName_Name	String	True	ProductName Name
Priority	String	False	Priority
Type	String	False	Type
CaseOrigin	String	False	CaseOrigin
Subject	String	False	Subject
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
DealName_Id	String	False	DealName Id
DealName_Name	String	True	DealName Name
No.ofcomments	Int	True	No.ofcomments
ReportedBy	String	False	ReportedBy
Email	String	False	Email
Phone	String	False	Phone
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Description	String	False	Description
InternalComments	String	False	InternalComments
Solution	String	False	Solution
AddComment	String	False	AddComment
Comments	String	True	Comments
RecordId	Long	True	RecordId
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

ContactRoles

Get, add, update, or delete the list of contact roles

Table-Specific Information

Select

SELECT * FROM ContactRoles

Insert

Insert INTO ContactRoles(SequenceNumber, Name) VALUES(8, 'TEST3')

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM ContactRoles WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE ContactRoles SET Name='Sales Lead 1' where Id= '2732548000006917001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Represents the unique ID of the contact role.
SequenceNumber	Int	False	Represents the position of the contact role in the picklist in CRM UI.
Name	String	False	Represents the name of the contact role.

Contacts

Create, update, delete, and query information regarding contacts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Contacts (FirstName, LastName, Email) VALUES ('John', 'Smith', '[email protected]')

Required fields: LastName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Contacts WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Contacts SET Description = 'John helped us in the past with setting up the servers.' WHERE Id = '3152079000000484021'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
ContactOwner_Id	String	False	ContactOwner Id
ContactOwner_FirstName	String	True	ContactOwner FirstName
ContactOwner_LastName	String	True	ContactOwner LastName
ContactOwner_Email	String	True	ContactOwner Email
ContactOwner_Name	String	True	ContactOwner Name
LeadSource	String	False	LeadSource
FirstName	String	False	FirstName
LastName	String	False	LastName
FullName	String	False	FullName
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
VendorName_Id	String	False	VendorName Id
VendorName_Name	String	True	VendorName Name
Email	String	False	Email
Title	String	False	Title
Department	String	False	Department
Phone	String	False	Phone
HomePhone	String	False	HomePhone
OtherPhone	String	False	OtherPhone
Fax	String	False	Fax
Mobile	String	False	Mobile
DateofBirth	Date	False	DateofBirth
Assistant	String	False	Assistant
AsstPhone	String	False	AsstPhone
EmailOptOut	Bool	False	EmailOptOut
SkypeID	String	False	SkypeID
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Salutation	String	False	Salutation
SecondaryEmail	String	False	SecondaryEmail
LastActivityTime	Datetime	True	LastActivityTime
Twitter	String	False	Twitter
Tag	String	False	Tag
MailingStreet	String	False	MailingStreet
OtherStreet	String	False	OtherStreet
MailingCity	String	False	MailingCity
OtherCity	String	False	OtherCity
MailingState	String	False	MailingState
OtherState	String	False	OtherState
MailingZip	String	False	MailingZip
OtherZip	String	False	OtherZip
MailingCountry	String	False	MailingCountry
OtherCountry	String	False	OtherCountry
Description	String	False	Description
ContactImage	String	False	ContactImage
ReportingTo_Id	String	False	ReportingTo Id
ReportingTo_Name	String	True	ReportingTo Name
UnsubscribedMode	String	True	UnsubscribedMode
UnsubscribedTime	Datetime	True	UnsubscribedTime
RecordId	Long	True	RecordId
ChangeLogTime	Datetime	True	ChangeLogTime
Locked	Bool	True	Locked
LastEnrichedTime	Datetime	True	LastEnrichedTime
EnrichStatus	String	True	EnrichStatus

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Currencies

Get, add or update currencies to your organization.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Currencies WHERE Id = '1234';

Insert

INSERT INTO Currencies (ISO_Code, Name, ExchangeRate) VALUES ('1234', 'hello','1.000');

Bulk Insert operation:

INSERT INTO Currencies#TEMP (id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code) VALUES ('4150868000000236307', 'cdata1','$','true','1.0000','period','comma','2','true','2');

INSERT INTO Currencies#TEMP (id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code) VALUES ('1234', 'cdata','$','true','2.0000','period','comma','3','true','3');

INSERT INTO Currencies (id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code) SELECT id, Name, Symbol, IsActive, ExchangeRate, FormatDecimalSeparator, FormatThousandSeparator, FormatDecimalPlaces, PrefixSymbol, ISO_Code FROM currencies#TEMP;

Required fields: Name, ISO_Code, ExchangeRate.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Update

UPDATE Currencies SET symbol = 'hello', FormatDecimalSeparator = 'period', FormatThousandSeparator = 'comma',FormatDecimalPlaces = '2',prefixsymbol = 'true',exchangerate = '1.0000' WHERE Id = '1234';

Bulk Update Operation:

UPDATE Currencies SET symbol = '$',FormatDecimalSeparator = 'period',FormatThousandSeparator = 'comma',FormatDecimalPlaces = '2';

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated. NOTE: if Id field is not specified in the query, PostData will be created for each id ( driver will execute bulk update operation for each currency id).

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Represents the unique ID of the currency.
Name	String	False	Represents the name of the currency.
Symbol	String	False	Represents the symbol of the currency.
IsActive	Bool	False	Represents the status of the currency.
ExchangeRate	Double	False	Represents the exchange rate of the currency.
FormatDecimalSeparator	String	False	The decimal separator separates the integer part of the currency from its fractional part.
FormatThousandSeparator	String	False	The thousand separator separates groups of thousands in a currency.
FormatDecimalPlaces	String	False	Represents the number of decimal places allowed for the currency.
ModifiedByName	String	True	Represents the name of the user who last modified the currency details.
ModifiedByid	String	True	Represents the ID of the user who last modified the currency details.
PrefixSymbol	Bool	False	Represents if the currency has a prefix symbol.
IsBase	Bool	True	Represents if the currency is the base currency.
CreatedAt	Datetime	True	Represents the date and time at which the currency was created.
ModifiedAt	Datetime	True	Represents the date and time at which the currency was last modified.
ISO_Code	String	False	Represents the ISO code of the currency.

Deals

Create, update, delete, and query information regarding deals.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Deals (DealName, Stage) VALUES ('Converting company XYZ into our client.', 'Qualification')

Required fields: DealName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Deals WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Deals SET Description = 'Updated from API' WHERE Id = '3152079000000153079'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
DealOwner_Id	String	False	DealOwner Id
DealOwner_FirstName	String	True	DealOwner FirstName
DealOwner_LastName	String	True	DealOwner LastName
DealOwner_Email	String	True	DealOwner Email
DealOwner_Name	String	True	DealOwner Name
Amount	Decimal	False	Amount
DealName	String	False	DealName
ClosingDate	Date	False	ClosingDate
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
Stage	String	False	Stage
Type	String	False	Type
Probability(%)	Int	False	Probability(%)
ExpectedRevenue	Decimal	True	ExpectedRevenue
NextStep	String	False	NextStep
LeadSource	String	False	LeadSource
CampaignSource_Id	String	False	CampaignSource Id
CampaignSource_Name	String	True	CampaignSource Name
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
LastActivityTime	Datetime	True	LastActivityTime
LeadConversionTime	Int	True	LeadConversionTime
SalesCycleDuration	Int	True	SalesCycleDuration
OverallSalesDuration	Int	True	OverallSalesDuration
Tag	String	False	Tag
Description	String	False	Description
RecordId	Long	True	RecordId
ChangeLogTime	Datetime	True	ChangeLogTime
Locked	Bool	True	Locked
ReasonForLoss	String	False	ReasonForLoss

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Invoices

Create, update, delete, and query information regarding invoices. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Invoices (Status, DueDate, Subject, InvoicedItems) VALUES ('Created', '2018/06/06', 'An invoice for the purchase of products XYZ.', '[
            { 
              "Product_Name": { 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, InvoicedItems.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Invoices WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Invoices SET Description = 'Updated from API' WHERE Id = '3152079000000153079'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
InvoiceOwner_Id	String	False	InvoiceOwner Id
InvoiceOwner_FirstName	String	True	InvoiceOwner FirstName
InvoiceOwner_LastName	String	True	InvoiceOwner LastName
InvoiceOwner_Email	String	True	InvoiceOwner Email
InvoiceOwner_Name	String	True	InvoiceOwner Name
InvoiceNumber	String	True	InvoiceNumber
Subject	String	False	Subject
SalesOrder_Id	String	False	SalesOrder Id
SalesOrder_Name	String	True	SalesOrder Name
InvoiceDate	Date	False	InvoiceDate
PurchaseOrder	String	False	PurchaseOrder
DueDate	Date	False	DueDate
ExciseDuty	Decimal	False	ExciseDuty
SalesCommission	Decimal	False	SalesCommission
Status	String	False	Status
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
SubTotal	String	True	SubTotal
Discount	Decimal	False	Discount
Tax	Decimal	False	Tax
Adjustment	Decimal	False	Adjustment
GrandTotal	String	True	GrandTotal
TermsandConditions	String	False	TermsandConditions
Description	String	False	Description
InvoicedItems	String	False	InvoicedItems
RecordId	Long	True	RecordId
DealName_Id	String	False	DealName Id
DealName_Name	String	True	DealName Name
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Leads

Create, update, delete, and query information regarding leads.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Leads(FirstName, LastName, Title) VALUES('Alert', 'Bat', 'Mr')
INSERT INTO LEADS(FirstName, LastName, Email, Trigger) VALUES('Enthusiastic', 'Panda', '[email protected]', 'workflow,approval,blueprint')

Required fields: LastName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Leads WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Leads SET Description = 'Changed from the API.' WHERE Id = '3152079000000488014'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
LeadOwner_Id	String	False	LeadOwner Id
LeadOwner_FirstName	String	True	LeadOwner FirstName
LeadOwner_LastName	String	True	LeadOwner LastName
LeadOwner_Email	String	True	LeadOwner Email
LeadOwner_Name	String	True	LeadOwner Name
Company	String	False	Company
FirstName	String	False	FirstName
LastName	String	False	LastName
FullName	String	False	FullName
Title	String	False	Title
Email	String	False	Email
Phone	String	False	Phone
Fax	String	False	Fax
Mobile	String	False	Mobile
Website	String	False	Website
LeadSource	String	False	LeadSource
LeadStatus	String	False	LeadStatus
Industry	String	False	Industry
No.ofEmployees	Int	False	No.ofEmployees
AnnualRevenue	Decimal	False	AnnualRevenue
Rating	String	False	Rating
EmailOptOut	Bool	False	EmailOptOut
SkypeID	String	False	SkypeID
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Salutation	String	False	Salutation
SecondaryEmail	String	False	SecondaryEmail
LastActivityTime	Datetime	True	LastActivityTime
Twitter	String	False	Twitter
Tag	String	False	Tag
Street	String	False	Street
City	String	False	City
State	String	False	State
ZipCode	String	False	ZipCode
Country	String	False	Country
Description	String	False	Description
LeadImage	String	False	LeadImage
ConvertedDateTime	Datetime	False	ConvertedDateTime
LeadConversionTime	Int	True	LeadConversionTime
UnsubscribedMode	String	True	UnsubscribedMode
UnsubscribedTime	Datetime	True	UnsubscribedTime
ConvertedAccount_Id	String	False	ConvertedAccount Id
ConvertedAccount_Name	String	True	ConvertedAccount Name
ConvertedContact_Id	String	False	ConvertedContact Id
ConvertedContact_Name	String	True	ConvertedContact Name
ConvertedDeal_Id	String	False	ConvertedDeal Id
ConvertedDeal_Name	String	True	ConvertedDeal Name
RecordId	Long	True	RecordId
ChangeLogTime	Datetime	True	ChangeLogTime
IsConverted	Bool	True	IsConverted
Locked	Bool	True	Locked
LastEnrichedTime	Datetime	True	LastEnrichedTime
EnrichStatus	String	True	EnrichStatus

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Meetings

Create, update, delete, and query information regarding meetings.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Meetings (Title, `From`, To) VALUES ('A test event', '2018/05/29 18:00:00', '2018/05/29 20:30:00')

Required fields: Title, From, To.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Meetings WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Meetings SET Description = 'Changed from the API.' WHERE Id = '3152079000000154219'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
Title	String	False	Title
Location	String	False	Location
Allday	Bool	False	Allday
From	Datetime	False	From
To	Datetime	False	To
Host_Id	String	False	Host Id
Host_FirstName	String	True	Host FirstName
Host_LastName	String	True	Host LastName
Host_Email	String	True	Host Email
Host_Name	String	True	Host Name
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
Repeat_Id	String	False	Repeat Id
Repeat_Name	String	True	Repeat Name
Reminder	String	False	Reminder
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Participants	String	False	Participants
Description	String	False	Description
Check-InTime	Datetime	True	Check-InTime
Check-InBy_Id	String	False	Check-InBy Id
Check-InBy_Name	String	True	Check-InBy Name
Check-InComment	String	True	Check-InComment
Check-InSub-Locality	String	True	Check-InSub-Locality
Check-InCity	String	True	Check-InCity
Check-InState	String	True	Check-InState
Check-InCountry	String	True	Check-InCountry
Latitude	Double	True	Latitude
Longitude	Double	True	Longitude
ZipCode	String	True	ZipCode
Check-InAddress	String	True	Check-InAddress
CheckedInStatus	String	True	CheckedInStatus
Tag	String	False	Tag
ParticipantsReminder	String	False	ParticipantsReminder
RecordId	Long	True	RecordId
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Notes

Create, update, delete, and query information regarding notes.

Table-Specific Information

Note: The Bulk API is not supported by the Notes table. Due to this, if you are using the Bulk API (UseCOQL set to False and APIType set to Bulk), the Sync App will instead use the REST API (with its associated limitations) when working with notes data. Refer to v2, v2.1, or v4 (in accordance with the value you set for Schema) to see the limits imposed by the REST API.

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

SELECT * FROM Notes WHERE Id = '3152079000000153079'

Insert

INSERT INTO Notes (ParentID_Id, ModuleName, NoteContent) VALUES ('3276571000000184007', 'Leads', 'Janet converted this lead.')

Required fields:

ParentID_Id (the Id of the item in which you are inserting the note to)
ModuleName (the API name of the module you are inserting the note to)
NoteContent

You can insert any field which is not read-only (ReadOnly = false in the table below).

Delete

Specify the Id in the WHERE clause when executing a delete in this table.

DELETE FROM Notes WHERE Id = '3152079000000488014'

Update

Specify the Id in the WHERE clause when executing an update in this table.

UPDATE Notes SET NoteTitle = 'Changed from the API.' WHERE Id = '3152079000000304003'

Required fields: Id.

You can update any field which is not read-only (ReadOnly = false in the table below).

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
NoteOwner_Id	String	False	NoteOwner Id
NoteOwner_FirstName	String	True	NoteOwner FirstName
NoteOwner_LastName	String	True	NoteOwner LastName
NoteOwner_Email	String	True	NoteOwner Email
NoteOwner_Name	String	True	NoteOwner Name
NoteTitle	String	False	NoteTitle
NoteContent	String	False	NoteContent
ParentID_Id	String	False	ParentID Id
ParentID_Name	String	True	ParentID Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
RecordId	Long	True	RecordId
Associated_Id	Long	False	Associated_Id
ModuleName	String	False	ModuleName
Attachments	String	False	Attachments
Editable	String	False	Editable
IsSharedToClient	String	False	IsSharedToClient
State	String	False	State
VoiceNote	String	False	VoiceNote

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Pipeline

To fetch the details of all or a specific pipeline in the Deals module. It works only with ApiVersion=2.1.

Table-Specific Information

Select

The Sync App will use the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

For example, the following queries are processed server side:

SELECT * FROM Pipeline WHERE Id = '228122000000223002' AND LayoutId = '228122000000000173'

SELECT * FROM Pipeline WHERE  LayoutId = '228122000000000173'

Insert

The maps values can be obtained by using the Fields view.

Insert Into Pipeline (LayoutId,DisplayValue,default,maps) VALUES ('4917206000000318488','Test_pipee11','true','[\n" +
            "        {\n" +
            "          \"display_value\": \"Qualification\",\n" +
            "          \"sequence_number\": \"2\",\n" +
            "          \"id\": \"4917206000000006801\"\n" +
            "        },\n" +
            "        {\n" +
            "          \"display_value\": \"Needs Analysis\",\n" +
            "          \"sequence_number\": \"1\",\n" +
            "          \"id\": \"4917206000000006803\"\n" +
            "        }\n" +
            "      ]')

Required fields: LayoutId, DisplayValue, Default and maps.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Update

You must specify the Id and LayoutId in the WHERE clause when executing an update against this table.

UPDATE Pipeline Set DisplayValue = 'Pipeline_test12', default = 'false' WHERE Id = '4917206000000357004' AND LayoutId = '4917206000000318488' ")

Required fields: Id,LayoutId.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Delete

The users can use the TransferAndDeltePipeline stored procedure to delete the pipeline.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	A unique numeric identifier for the profile.
DisplayValue	String	False	The name of the pipeline.
Default	Bool	False	The default value of the pipeline.
ActualValue	String	False	The actual name of the pipeline.
Maps	String	False	The different stages that a deal has to pass through in the sales pipeline.
LayoutId [KEY]	String	False	The unique ID of the layout in the Deals module you want to fetch the pipeline's details from.

PriceBooks

Create, update, delete, and query information regarding price books. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO PriceBooks (PriceBookName, Active) VALUES ('pricebook_2018', true)

Required fields: PriceBookName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM PriceBooks WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE PriceBooks SET Description = 'Changed from the API.' WHERE Id = '3152079000000488023'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
PriceBookOwner_Id	String	False	PriceBookOwner Id
PriceBookOwner_FirstName	String	True	PriceBookOwner FirstName
PriceBookOwner_LastName	String	True	PriceBookOwner LastName
PriceBookOwner_Email	String	True	PriceBookOwner Email
PriceBookOwner_Name	String	True	PriceBookOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
PriceBookName	String	False	PriceBookName
Active	Bool	False	Active
PricingModel	String	False	PricingModel
Tag	String	False	Tag
PricingDetails	String	False	PricingDetails
Description	String	False	Description
RecordId	Long	True	RecordId
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Products

Create, update, delete, and query information regarding products.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Products(ProductName, ProductActive) VALUES('C-3PO', true)

Required fields: ProductName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Products WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Products SET Description = 'Changed from the API.' WHERE Id = '3152079000000487023'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
ProductOwner_Id	String	False	ProductOwner Id
ProductOwner_FirstName	String	True	ProductOwner FirstName
ProductOwner_LastName	String	True	ProductOwner LastName
ProductOwner_Email	String	True	ProductOwner Email
ProductOwner_Name	String	True	ProductOwner Name
ProductName	String	False	ProductName
ProductCode	String	False	ProductCode
VendorName_Id	String	False	VendorName Id
VendorName_Name	String	True	VendorName Name
ProductActive	Bool	False	ProductActive
Manufacturer	String	False	Manufacturer
ProductCategory	String	False	ProductCategory
SalesStartDate	Date	False	SalesStartDate
SalesEndDate	Date	False	SalesEndDate
SupportStartDate	Date	False	SupportStartDate
SupportEndDate	Date	False	SupportEndDate
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
UnitPrice	Decimal	False	UnitPrice
CommissionRate	Decimal	False	CommissionRate
Tax	String	False	Tax
Taxable	Bool	False	Taxable
UsageUnit	String	False	UsageUnit
QtyOrdered	Double	False	QtyOrdered
QuantityinStock	Double	False	QuantityinStock
ReorderLevel	Double	False	ReorderLevel
Handler_Id	String	False	Handler Id
Handler_Name	String	True	Handler Name
QuantityinDemand	Double	False	QuantityinDemand
Description	String	False	Description
ProductImage	String	False	ProductImage
RecordId	Long	True	RecordId
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

PurchaseOrders

Create, update, delete, and query information regarding purchase orders. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO PurchaseOrders (Subject, PurchaseItems) VALUES ('Purchase Order', '[
            { 
              "Product_Name": { 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, Purchase_Items

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM PurchaseOrders WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE PurchaseOrders SET Description = 'Changed from the API.' WHERE Id = '3152079000000492001'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
RequisitionNumber	String	False	RequisitionNumber
TrackingNumber	String	False	TrackingNumber
PONumber	String	False	PONumber
Subject	String	False	Subject
VendorName_Id	String	False	VendorName Id
VendorName_Name	String	True	VendorName Name
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
PODate	Date	False	PODate
DueDate	Date	False	DueDate
Carrier	String	False	Carrier
ExciseDuty	Decimal	False	ExciseDuty
SalesCommission	Decimal	False	SalesCommission
Status	String	False	Status
PurchaseOrderOwner_Id	String	False	PurchaseOrderOwner Id
PurchaseOrderOwner_FirstName	String	True	PurchaseOrderOwner FirstName
PurchaseOrderOwner_LastName	String	True	PurchaseOrderOwner LastName
PurchaseOrderOwner_Email	String	True	PurchaseOrderOwner Email
PurchaseOrderOwner_Name	String	True	PurchaseOrderOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
SubTotal	String	True	SubTotal
Discount	Decimal	False	Discount
Tax	Decimal	False	Tax
Adjustment	Decimal	False	Adjustment
GrandTotal	String	True	GrandTotal
TermsandConditions	String	False	TermsandConditions
Description	String	False	Description
PurchaseItems	String	False	PurchaseItems
RecordId	Long	True	RecordId
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Quotes

Create, update, delete, and query information regarding quotes. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Quotes (Subject, QuotedItems) VALUES ('QuotedItems', '[
            { 
              "Product_Name": { 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, QuotedItems.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Quotes WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Quotes SET Description = 'Changed from the API.' WHERE Id = '3152079000000490009'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
Team	String	False	Team
QuoteNumber	String	True	QuoteNumber
Subject	String	False	Subject
DealName_Id	String	False	DealName Id
DealName_Name	String	True	DealName Name
QuoteStage	String	False	QuoteStage
ValidUntil	Date	False	ValidUntil
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
Carrier	String	False	Carrier
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
QuoteOwner_Id	String	False	QuoteOwner Id
QuoteOwner_FirstName	String	True	QuoteOwner FirstName
QuoteOwner_LastName	String	True	QuoteOwner LastName
QuoteOwner_Email	String	True	QuoteOwner Email
QuoteOwner_Name	String	True	QuoteOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
SubTotal	String	True	SubTotal
Discount	Decimal	False	Discount
Tax	Decimal	False	Tax
Adjustment	Decimal	False	Adjustment
GrandTotal	String	True	GrandTotal
TermsandConditions	String	False	TermsandConditions
Description	String	False	Description
QuotedItems	String	False	QuotedItems
RecordId	Long	True	RecordId
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

SalesOrders

Create, update, delete, and query information regarding sales orders. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO SalesOrders (Subject, OrderedItems) VALUES ('Sales Order', '[
            { 
              "Product_Name": { 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: Subject, OrderedItems

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM SalesOrders WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE SalesOrders SET Description = 'Changed from the API.' WHERE Id = '3152079000000493027'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
CustomerNo.	String	False	CustomerNo.
SONumber	String	True	SONumber
Subject	String	False	Subject
DealName_Id	String	False	DealName Id
DealName_Name	String	True	DealName Name
PurchaseOrder	String	False	PurchaseOrder
QuoteName_Id	String	False	QuoteName Id
QuoteName_Name	String	True	QuoteName Name
DueDate	Date	False	DueDate
Pending	String	False	Pending
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
Carrier	String	False	Carrier
ExciseDuty	Decimal	False	ExciseDuty
SalesCommission	Decimal	False	SalesCommission
Status	String	False	Status
AccountName_Id	String	False	AccountName Id
AccountName_Name	String	True	AccountName Name
SalesOrderOwner_Id	String	False	SalesOrderOwner Id
SalesOrderOwner_FirstName	String	True	SalesOrderOwner FirstName
SalesOrderOwner_LastName	String	True	SalesOrderOwner LastName
SalesOrderOwner_Email	String	True	SalesOrderOwner Email
SalesOrderOwner_Name	String	True	SalesOrderOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
BillingStreet	String	False	BillingStreet
ShippingStreet	String	False	ShippingStreet
BillingCity	String	False	BillingCity
ShippingCity	String	False	ShippingCity
BillingState	String	False	BillingState
ShippingState	String	False	ShippingState
BillingCode	String	False	BillingCode
ShippingCode	String	False	ShippingCode
BillingCountry	String	False	BillingCountry
ShippingCountry	String	False	ShippingCountry
SubTotal	String	True	SubTotal
Discount	Decimal	False	Discount
Tax	Decimal	False	Tax
Adjustment	Decimal	False	Adjustment
GrandTotal	String	True	GrandTotal
TermsandConditions	String	False	TermsandConditions
Description	String	False	Description
OrderedItems	String	False	OrderedItems
RecordId	Long	True	RecordId
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Solutions

Create, update, delete, and query information regarding solutions.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Sync App.

Insert

INSERT INTO Solutions (SolutionTitle, Status) VALUES ('Converting from XML to JSON', 'Created')

Required fields: SolutionTitle.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Solutions WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Solutions SET Question = 'Changed from the API.' WHERE Id = '3152079000000492018'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
SolutionNumber	String	False	SolutionNumber
SolutionOwner_Id	String	False	SolutionOwner Id
SolutionOwner_FirstName	String	True	SolutionOwner FirstName
SolutionOwner_LastName	String	True	SolutionOwner LastName
SolutionOwner_Email	String	True	SolutionOwner Email
SolutionOwner_Name	String	True	SolutionOwner Name
SolutionTitle	String	False	SolutionTitle
Published	Bool	False	Published
Status	String	False	Status
ProductName_Id	String	False	ProductName Id
ProductName_Name	String	True	ProductName Name
No.ofcomments	Int	True	No.ofcomments
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Question	String	False	Question
Answer	String	False	Answer
AddComment	String	False	AddComment
Comments	String	True	Comments
RecordId	Long	True	RecordId
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Tasks

Create, update, delete, and query information regarding tasks.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Tasks(Subject, Status) VALUES ('Finish sending emails to potential leads.', 'Created')

INSERT INTO Tasks(Subject, Status, ModuleName) VALUES ('Finish sending emails to potential leads.', 'Created', 'Contacts')

INSERT INTO Tasks(Subject, Status, ModuleName, RelatedTo_Id) VALUES ('Finish sending emails to potential leads.', 'Created', 'Contacts', '2788704000120533263')

Required fields: Subject, ModuleName if RelatedTo_Id is specified.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Tasks WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Tasks SET Status = 'In progress' WHERE Id = '3152079000000492026'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
TaskOwner_Id	String	False	TaskOwner Id
TaskOwner_FirstName	String	True	TaskOwner FirstName
TaskOwner_LastName	String	True	TaskOwner LastName
TaskOwner_Email	String	True	TaskOwner Email
TaskOwner_Name	String	True	TaskOwner Name
Subject	String	False	Subject
DueDate	Date	False	DueDate
ContactName_Id	String	False	ContactName Id
ContactName_Name	String	True	ContactName Name
RelatedTo_Id	String	False	RelatedTo Id
RelatedTo_Name	String	True	RelatedTo Name
Status	String	False	Status
Priority	String	False	Priority
ClosedTime	Datetime	True	ClosedTime
SendNotificationEmail	Bool	False	SendNotificationEmail
Repeat_Id	String	False	Repeat Id
Repeat_Name	String	True	Repeat Name
Reminder_Id	String	False	Reminder Id
Reminder_Name	String	True	Reminder Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Description	String	False	Description
RecordId	Long	True	RecordId
Locked	Bool	True	Locked
LastActivityTime	Datetime	False	LastActivityTime
ModuleName	String	False	ModuleName

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Vendors

Create, update, delete, and query information regarding vendors.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Vendors(VendorName, Email, Website) VALUES('XYZVendor', '[email protected]', 'vendeverything.xyz')

Required fields: VendorName.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Vendors WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Vendors SET Description = 'Changed from the API' WHERE Id = '3152079000000492032'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id
VendorName	String	False	VendorName
Phone	String	False	Phone
Email	String	False	Email
Website	String	False	Website
GLAccount	String	False	GLAccount
Category	String	False	Category
VendorOwner_Id	String	False	VendorOwner Id
VendorOwner_FirstName	String	True	VendorOwner FirstName
VendorOwner_LastName	String	True	VendorOwner LastName
VendorOwner_Email	String	True	VendorOwner Email
VendorOwner_Name	String	True	VendorOwner Name
CreatedBy_Id	String	False	CreatedBy Id
CreatedBy_FirstName	String	True	CreatedBy FirstName
CreatedBy_LastName	String	True	CreatedBy LastName
CreatedBy_Email	String	True	CreatedBy Email
CreatedBy_Name	String	True	CreatedBy Name
ModifiedBy_Id	String	False	ModifiedBy Id
ModifiedBy_FirstName	String	True	ModifiedBy FirstName
ModifiedBy_LastName	String	True	ModifiedBy LastName
ModifiedBy_Email	String	True	ModifiedBy Email
ModifiedBy_Name	String	True	ModifiedBy Name
CreatedTime	Datetime	False	CreatedTime
ModifiedTime	Datetime	False	ModifiedTime
Tag	String	False	Tag
Street	String	False	Street
City	String	False	City
State	String	False	State
ZipCode	String	False	ZipCode
Country	String	False	Country
Description	String	False	Description
VendorImage	String	False	VendorImage
RecordId	Long	True	RecordId
Locked	Bool	True	Locked
EmailOptOut	Bool	False	EmailOptOut
UnsubscribedMode	String	True	UnsubscribedMode
UnsubscribedTime	Datetime	True	UnsubscribedTime
LastActivityTime	Datetime	False	LastActivityTime

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
DuplicateCheckFields	String	The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field.
Trigger	String	To trigger the rule while inserting record into CRM account.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Views

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

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

Zoho CRM Connector for CData Sync Views


Name	Description
ActionsPerformed	Query information regarding performed actions.
AllowedFromAddresses	To get the list of email addresses that you can send emails from.
CustomFieldHistoryTracking	Query information regarding histories for a particular custom field.
DealHistory	Query information regarding deal history.
EmailTemplateAttachments	To fetch the email template attachments in a module.
EmailTemplates	To fetch the email templates in a module.
Fields	To get the field metadata for the specified module.
InvoicedItems	Query information regarding invoiced items.
Layouts	To get the layouts metadata for the specified module.
ListFields	Get the field metadata for the specified module.
ModuleAttachedFiles	Retrieves all the files attached to a specified module.
Modules	To get the modules metadata for the specified account.
OrderedItems	Query information regarding ordered items.
Organizations	Query information regarding organizations.
PriceBookPricingDetails	Query information regarding pricing details. Not available in free and standard ZohoCRM accounts.
Profiles	Query information regarding profiles.
PurchaseItems	Query information regarding purchase items.
QuotedItems	Query information regarding quoted items.
RecordCount	To fetch the total number of records in the module.
Roles	Query information regarding roles.
StageHistories	Query information regarding stage histories for a particular deal.
Territories	Get the list of territories enabled for your organization.
Users	Query information regarding users.
Visits	Query information regarding recent visits.

ActionsPerformed

Query information regarding performed actions.

Table-Specific Information

Select

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

Note : ActionsPerformed cannot be queried until it is enabled from the UI.

SELECT * FROM ActionsPerformed

Columns


Name	Type	Description
Id [KEY]	String	The Id of the performed action.
ActionType	String	The type of the performed action.
Actions	String	The actions performed.
TimeSpent	String	The time spent performing the action.
ActionPerformedTime	Datetime	The date and time when the action was performed.
ParentID_Id	String	The Id of the parent object where the action was performed.
ParentID_Name	String	The name of the parent object where the action was performed.
ChatAttachment_Id	String	The Id of the chat attachment for the action.
ChatAttachment_Name	String	The name of the chat attachment for the action.

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

AllowedFromAddresses

To get the list of email addresses that you can send emails from.

Table-Specific Information

Note : This view is available for API Version 2.1 and above.

Select

The following queries are processed server side:

SELECT * FROM AllowedFromAddresses

Columns


Name	Type	Description
Id	String	Id of AllowedFromAddresses.
Email	String	Email addresses that you can send emails from.
Type	String	Type of email address.
UserName	String	User Name of the email.
Default	Boolean	Flag to determine if the email is default.

CustomFieldHistoryTracking

Query information regarding histories for a particular custom field.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

ModuleName supports the '=' operator.
EntityId supports the '=' operator.
FieldName supports the '=' operator.
HistoryName supports the '=' operator.

All columns used in the criteria are required. Use FieldName to specify the actual name of the tracked custom field and HistoryName to specify the name of the history tracking section. If you want to retrieve data for a specific entity of a module specify EntityId in the criteria. For example, the following query is processed server side:

SELECT * FROM [CustomFieldHistoryTracking] WHERE ModuleName = 'Leads' AND FieldName = 'pickListField' AND HistoryName = 'Pick List 1'

SELECT * FROM [CustomFieldHistoryTracking] WHERE ModuleName = 'Leads' AND FieldName = 'pickListField' AND HistoryName = 'Pick List 1' AND EntityId = '12345665'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the history.
ModuleName	String	A unique numeric identifier for the module instance this custom field tracking belongs to.
EntityId	String	A unique numeric identifier for the module instance this custom field tracking belongs to.
FieldName	String	The name of the custom field.
HistoryName	String	The name of the custom field tracking history.
FieldValue	String	The value of the custom field.
DurationDays	Integer	The duration of this stage.
ModifiedAt	Datetime	The time this historical value was last modified.
ModifiedById	String	The id of the user who modified the value.
ModifiedByName	String	The name of the user who modified the value.
CurrencySymbol	String	The currency symbol for the value.
ProcessFlow	Boolean	The boolean indicating the process flow for this historical value.
Editable	Boolean	The boolean indicating if this historical value can be edited.
Approved	Boolean	The boolean indicating if this historical value has been approved.

DealHistory

Query information regarding deal history.

Columns


Name	Type	Description
Id [KEY]	String
DealName_Id	String
DealName_Name	String
Stage	String
StageDuration(CalendarDays)	Int
ModifiedBy_Id	String
ModifiedBy_Name	String
ModifiedTime	Datetime
Amount	Decimal
Probability(%)	Int
ExpectedRevenue	Decimal
ClosingDate	Date
RecordId	Long
LastActivityTime	Datetime
MovedTo	String

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.
Trigger	String	To trigger the rule while inserting record into CRM account.

EmailTemplateAttachments

To fetch the email template attachments in a module.

Table-Specific Information

Note : This view is available for API Version 2.1 and above.

Select

The Sync App will use the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

EmailTemplateId supports the '=,IN' operator.
ModuleName supports the '=,IN' operator.

For example, the following queries are processed server side:

SELECT * FROM EmailTemplateAttachments

SELECT * FROM EmailTemplateAttachments where EmailTemplateId = '721000000'

SELECT * FROM EmailTemplateAttachments where ModuleName='Accounts'

Columns


Name	Type	Description
Id [KEY]	String	Id of attachment.
EmailTemplateId	String	Represents the unique ID of the email template.
FileId	String	File Id of attachment.
FileName	String	File Name of attachment.
Size	String	Size of attachment.
ModuleName	String	The name of the module which the user wants the fields.

EmailTemplates

To fetch the email templates in a module.

Table-Specific Information

Note : This view is available for API Version 2.1 and above.

Select

The Sync App will use the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

Id supports the '=,IN' operator.
ModuleApiName supports the '=,IN' operator.

For example, the following queries are processed server side:

SELECT * FROM EmailTemplates

SELECT * FROM EmailTemplates where id = '721000000'

SELECT * FROM EmailTemplates where ModuleApiName='Accounts'

Columns


Name	Type	Description
Id [KEY]	String	Represents the unique ID of the email template.
Active	Boolean	Active.
Associated	Boolean	Represents whether the template is associated or not.
Attachments	String	Represents the attachments added in the template.
Category	String	Represents the type of the template. The allowed values are custom_templates, system_templates, plugin_templates, marketplace_templates.
ConsentLinked	Boolean	Represents whether the consent form is linked with the template.
CreatedById	String	Represents the ID of the user who created the email template.
CreatedByName	String	Represents the name of the user who created the email template.
CreatedTime	Datetime	Represents the date and time at which the email template was created.
EditorMode	String	Represents the mode in which the email template is created. The allowed values are gallery, rich_text, plain_text.
Favorite	Boolean	Represents if the email template is marked as favorite.
FolderId	String	Represents the unique ID of the template folder.
FolderName	String	Represents the name of the template folder.
LastUsageTime	Datetime	Represents the date and time at which the email template was last used.
LastVersionStatisticsBounced	Integer	The statistics such as the number of emails that were bounced, that used this template.
LastVersionStatisticsClicked	Integer	The statistics such as the number of emails that were clicked, that used this template.
LastVersionStatisticsDelivered	Integer	The statistics such as the number of emails that were delivered, that used this template.
LastVersionStatisticsOpened	Integer	The statistics such as the number of emails that were opened, that used this template.
LastVersionStatisticsSent	Integer	The statistics such as the number of emails that were sent, that used this template.
LastVersionStatisticsTracked	Integer	The statistics such as the number of emails that were tracked, that used this template.
Layout	String	Represents the layout Id the template is associated with.
ModifiedById	String	Represents the ID of the user who last modified the email template.
ModifiedByName	String	Represents the name of the user who last modified the email template.
ModifiedTime	Datetime	Represents the date and time at which the email template was last modified.
ModuleApiName	String	Represents the module api name with which the template is associated with.
ModuleId	String	Represents the module id with which the template is associated with.
Name	String	Represents the name of the email template.
Subject	String	Represents the subject of the email template.

Fields

To get the field metadata for the specified module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

ModuleName supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Fields WHERE ModuleName = 'Deals'

Columns


Name	Type	Description
DisplayValue	String	The name of the field.
ActualValue	String	The actual name of the field.
Id	String	The unique identifier of the field
ModuleName	String	The name of the module which the user wants the fields.

InvoicedItems

Query information regarding invoiced items.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM InvoicedItems WHERE Id = '3152079000000301143'

Columns


Name	Type	Description
Id [KEY]	String
S.NO	Long
CreatedTime	Datetime
ModifiedTime	Datetime
ParentID_Id	String
ParentID_Name	String
ProductName_Id	String
ProductName_Name	String
PriceBook_Id	String
PriceBook_Name	String
Description	String
Quantity	String
ListPrice	Decimal
Amount	String
Discount	Decimal
TotalAfterDiscount	String
Tax	Decimal
Total	String
TaxbyPercentage	String

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.
Trigger	String	To trigger the rule while inserting record into CRM account.

Layouts

To get the layouts metadata for the specified module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

ModuleName supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM Layouts WHERE ModuleName = 'Deals'

Columns


Name	Type	Description
Id	String	The unique identifier of the layout.
Name	String	Represents the name of the layout.
Type	String	Represents if the section is used or not in the layout.
ModuleName	String	The name of the module which the user wants the layout.

ListFields

Get the field metadata for the specified module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

ModuleName supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM ListFields WHERE ModuleName = 'Deals'

Columns


Name	Type	Description
ApiName	String	The API Name.
AssociationDetails	String	The Association Details.
BlueprintSupported	Boolean	Is Blueprint Supported.
BusinesscardSupported	Boolean	Is Businesscard Supported.
ConvertMappingAccounts	String	The Convert Mapping Accounts.
ConvertMappingContacts	String	The Convert Mapping Contacts.
ConvertMappingDeals	String	The Convert Mapping Deals.
CreatedSource	String	The Created Source.
Crypt	String	The Crypt.
CurrencyPrecision	Integer	The Currency Precision.
CurrencyRoundingOption	String	The Currency Rounding Option.
CustomField	Boolean	Is Custom Field.
DataType	String	The Data Type.
DecimalPlace	Integer	The Decimal Place.
DisplayField	Boolean	Is Display Field.
DisplayLabel	String	The Display Label.
DisplayType	Integer	The Display Type.
External	String	The External.
FieldLabel	String	The Field Label.
FieldReadOnly	Boolean	Is Field ReadOnly.
Filterable	Boolean	Is Filterable.
HistoryTracking	String	The History Tracking.
Id	String	The Id.
JsonType	String	The JSON Type.
Length	Integer	The Length.
MassUpdate	Boolean	Is Mass Update.
PickListValues	String	The Pick List Values.
PickListValuesSortedLexically	Boolean	Are Pick List Values Sorted Lexically.
Profiles	String	The Profiles.
QuickSequenceNumber	String	The QuickSequenceNumber.
ReadOnly	Boolean	Is ReadOnly.
Sortable	Boolean	Is Sortable.
Sortable	Boolean	Is Sortable.
SystemMandatory	Boolean	Is System Mandatory.
Tooltip	String	The Tool tip.
Type	String	The Type.
UiType	Integer	The Ui Type.
ViewTypeCreate	Boolean	Is View Type Create.
ViewTypeEdit	Boolean	Is View Type Edit.
ViewTypeQuickCreate	Boolean	Is View Type Quick Create.
ViewTypeView	Boolean	Is View Type View.
Visible	Boolean	Is Visible.
Webhook	Boolean	Is Webhook.
Searchable	Boolean	Represents whether the field is supported in a search.
SharingProperties	String	In a lookup field, represents if the user has access to the records that the field looks up to.
ModuleName	String	The name of the module which the user wants the fields.

ModuleAttachedFiles

Retrieves all the files attached to a specified module.

Table-Specific Information

Select

The Sync App uses the Zoho CRM 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.

ModuleName supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM ModuleAttachedFiles WHERE ModuleName = "Leads"

Note: The UploadFile and DownloadFile stored procedures will not work as expected if executed in regards to a custom field. They only upload or download files in the "Attachments" section of the module. Uploading and deleting files from a custom field of type "fileupload" can be done only through the UI.

Columns


Name	Type	Description
FileId	String	Id of the file attached to the module.
FileName	String	Name of the file attached to the module.
AttachmentId [KEY]	String	Id of the attachment.
CreatorId	String	Id of the user who uploaded the attachment.
EntityId	String	Id of the entity.
DownloadUrl	String	URL to download the attachment.
PreviewUrl	String	URL to preview the attachmen.
FileSize	String	The size of the attachment.
FileExtension	String	Extension of the attachment.
ModuleName	String	Id of the module.

Modules

To get the modules metadata for the specified account.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.

For example, the following queries are processed server-side:

SELECT * FROM Modules

Columns


Name	Type	Description
Id	String	The unique identifier of the modules
Name	String	The name of the module which the user wants.
SequenceNumber	Integer	The sequence number of the field.
ApiName	String	The api name of the field.
GlobalSearchSupported	Boolean	Represents if the current module has global search support.
Deletable	Boolean	Describes if the user can delete a record in the current module.
Description	String	Represents the description of the module, if any.
Creatable	Boolean	Represents if the user can create records in the current module.
InventoryTemplateSupported	Boolean	Represents the module supports inventory template. The value will be true only for Quotes, Invoices, Purchase Orders, and Sales Orders modules.
ModifiedDateTime	Datetime	Represents the date and time of when the module properties were last modified.
PluralLabel	String	Represents the plural of the module name. Example: Leads.
SingularLabel	String	Represents the singular of the module name. Example: Lead.
PresenceSubMenu	Boolean	Represents if the module has a submenu. For instance, Tasks in Activities is a submenu.
TriggersSupported	Boolean	Represents if the module supports triggers from custom buttons, workflows, approval etc.
Visibility	Integer	Represents the visibility of the module in the org. 1- The module is visible, default value; 2- The module is hidden; XXXX - The sum of the feature numbers that are hidden.
Convertable	Boolean	Describes if the user can convert the record into another type of record. For example: Convert Leads into Deals.
Editable	Boolean	Describes if the user can edit a record in the current module.
EmailTemplateSupport	Boolean	Represents if the module supports the usage of the email templates.
FilterSupported	Boolean	Represents if the module supports custom filters besides the system-defined ones in a custom view.
ShowAsTab	Boolean	Represents if the module is displayed as a tab in the CRM UI.
Viewable	Boolean	Represents if the user can view the records in the current module.
ApiSupported	Boolean	Describes if the current module is accessible via API.
QuickCreate	Boolean	Represents if the module supports quick create.
ModifiedByName	String	Represents the name of the user who last modified the module properties.
ModifiedById	String	Represents the ID of the user who last modified the module properties.
GeneratedType	String	Represents how the module was created.
FeedsRequired	Boolean	Represents if feeds is enabled for the module.
ScoringSupported	Boolean	Represents if the records of the module qualify for the scoring process, if there is one.
WebformSupported	Boolean	Represents if the records in the module can be created via web forms.
BusinessCardFieldLimit	Integer	Represents the number of fields you can have in the business card details.
ParentModuleApiName	String	Represents the api name of the parent module, if any. For instance, Activities is the parent module for Tasks, Calls, and Events.
ParentModuleId	String	Represents the id of the parent module, if any.
WebLink	String	Represents the web link of the module, if any. For instance, https://extensions.zoho.com/plugin/facebook
IsBlueprintSupported	Boolean	Is blueprint Supported.

OrderedItems

Query information regarding ordered items.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM OrderedItems WHERE Id = '3152079000000301143'

Columns


Name	Type	Description
Id [KEY]	String
S.NO	Long
CreatedTime	Datetime
ModifiedTime	Datetime
ParentID_Id	String
ParentID_Name	String
ProductName_Id	String
ProductName_Name	String
PriceBook_Id	String
PriceBook_Name	String
Description	String
Quantity	String
ListPrice	Decimal
Amount	String
Discount	Decimal
TotalAfterDiscount	String
Tax	Decimal
Total	String
TaxbyPercentage	String

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.
Trigger	String	To trigger the rule while inserting record into CRM account.

Organizations

Query information regarding organizations.

View-Specific Information

Select

The Sync App processes filters client-side within the Sync App.

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the organization.
CompanyName	String	The name of the company for this organization.
PrimaryEmail	String	The primary email of the organization.
Phone	String	The phone number of the organization.
Mobile	String	The mobile phone number of the organization.
IsoCode	String	The ISO code of the organization.
Description	String	The description of the organization.
Country	String	The country where this organization is situated.
City	String	The city where this organization is situated.
State	String	The state where this organization is situated.
Street	String	The street where this organization is situated.
Zip	String	The zip where this organization is situated.
CountryCode	String	The country code of the organization.
Alias	String	The alias of the organization.
Fax	String	The fax of the organization.
EmployeeCount	Int	The number of employees this organization has.
Website	String	The website of the organization.
CurrencySymbol	String	The default currency symbol for the organization.
CurrencyLocale	String	The default currency locale for the organization.
PrimaryZuid	String	The primary ZUID for the organization.
TimeZone	String	The time zone for the organization.
Zgid	String	The zgid for the organization.
MCStatus	Boolean	Whether this organization has MC status or not.
GappsEnabled	Boolean	Whether this organization has gapps enabled or not.
LicenseDetailsPaidExpiry	Datetime	The date and time the subscription expires for this organization.
LicenseDetailsTrialType	String	The trial type of subscription the organization has.
LicenseDetailsTrialExpiry	Datetime	The date and time the trial subscription expires for this organization.
LicenseDetailsPaid	Boolean	Whether the organization has a paid subscription.
LicenseDetailsPaidType	String	The type of subscription the organization has.
DeletableOrgAccount	Boolean	Represents if the account related to this organization is deletable.
LicenseDetailsUsersLicensePurchased	Integer	The number of licenses purchased by the organization.
PhotoId	String	Represents the unique ID of the organization photo file.
DomainName	String	Represents the domain name of the organization. For instance, org694902300.
TranslationEnabled	Boolean	Represents if translation is enabled for the organization.
Currency	String	Represents the base/home currency details of the organization.
ZiaPortalId	String	Represents Zia portal ID of the organization, if configured.
PrivacySettings	String	Represents if the privacy settings are enabled for the organization.
HipaaComplianceEnabled	Boolean	Represents if HIPAA compliance is enabled for the organization.

PriceBookPricingDetails

Query information regarding pricing details. Not available in free and standard ZohoCRM accounts.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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.

PriceBookId supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM PriceBookPricingDetails WHERE PriceBookId = '3152079000000317001'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the pricing detail.
PriceBookId [KEY]	String	A unique numeric identifier for the price book this pricing detail belongs to.
Discount	Double	How much discount should be applied for this pricing detail.
FromRange	Double	Starting from what amount should this discount be applied.
ToRange	Double	Until what amount should this discount be applied.

Profiles

Query information regarding profiles.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Profiles WHERE Id = '3152079000000026011'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the profile.
Name	String	The name of the profile.
Description [KEY]	String	A small description regarding this profile.
CreatedByName	String	The name of the user who created this profile.
CreatedById	String	The id of the user who created this profile.
CreatedAt	Datetime	The time this profile was created.
ModifiedByName	String	The name of the user who modified this profile.
ModifiedById	String	The id of the user who modified this profile.
ModifiedAt	Datetime	The time this profile was last modified.
Category	Boolean	Whether this profile is a category or not.
DisplayLabel	String	Represents the display name of the current profile.

PurchaseItems

Query information regarding purchase items.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM PurchaseItems WHERE Id = '3152079000000301143'

NOTE: This table is not supported in v2.

Columns


Name	Type	Description
Id [KEY]	String
S.NO	Long
CreatedTime	Datetime
ModifiedTime	Datetime
ParentID_Id	String
ParentID_Name	String
ProductName_Id	String
ProductName_Name	String
PriceBook_Id	String
PriceBook_Name	String
Description	String
Quantity	String
ListPrice	Decimal
Amount	String
Discount	Decimal
TotalAfterDiscount	String
Tax	Decimal
Total	String
TaxbyPercentage	String

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.
Trigger	String	To trigger the rule while inserting record into CRM account.

QuotedItems

Query information regarding quoted items.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM QuotedItems WHERE Id = '3152079000000301143'

Columns


Name	Type	Description
Id [KEY]	String
S.NO	Long
CreatedTime	Datetime
ModifiedTime	Datetime
ParentID_Id	String
ParentID_Name	String
ProductName_Id	String
ProductName_Name	String
PriceBook_Id	String
PriceBook_Name	String
Description	String
Quantity	String
ListPrice	Decimal
Amount	String
Discount	Decimal
TotalAfterDiscount	String
Tax	Decimal
Total	String
TaxbyPercentage	String

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.
Trigger	String	To trigger the rule while inserting record into CRM account.

RecordCount

To fetch the total number of records in the module.

View-Specific Information

Select

The Sync App uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The module is a mandatory filter for the Sync App.

Note: It works only with ApiVersion=2.1.

ModuleName supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM RecordCount WHERE ModuleName = 'Leads'

SELECT * FROM RecordCount WHERE ModuleName IN ('Leads','Invoices')

Columns


Name	Type	Description
Count [KEY]	Integer	The total number of records in the module.
ModuleName	String	The name of the module which the user wants the count.

Roles

Query information regarding roles.

View-Specific Information

Select

The Sync App uses the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Roles WHERE Id = '3152079000000026008'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the role.
Name	String	The name of the role.
DisplayLabel [KEY]	String	The way the role is displayed in the UI.
ReportingToName	String	The name of the role this role reports to.
ReportingToId	String	The id of the role this role reports to.
CreatedByID	String	Represents the ID of the user that created this role.
CreatedByName	String	Represents the name of the user that created this role.
CreatedTime	Datetime	Represents the date and time at which the role was created.
ModifiedByID	String	Represents the ID of the user who modified this role last.
ModifiedByName	String	Represents the name of the user who modified this role last.
ModifiedTime	Datetime	Represents the date and time at which the role was modified last.
ForecastManagerName	String	The forecast manager's name.
ForecastManagerId	String	The forecast manager's id.
ShareWithPeers	Boolean	Represents if the users with the current role have the permission to share records.
Description	String	Represents the description of the role, if any.

StageHistories

Query information regarding stage histories for a particular deal.

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the stage.
DealId	String	A unique numeric identifier for the deal this stage belongs to.
Stage	String	The stage number for this stage.
Amount	Decimal	The amount of money spent for this stage.
DurationDays	Integer	The duration of this stage.
ExpectedRevenue	Decimal	The expected revenue from this stage.
Probability	Decimal	The probability for the stage to happen.
CloseDate	Date	The date when this stage closes.
LastModifiedTime	Datetime	The time this stage was last modified.
ModifiedById	String	The id of the user who modified the stage.
ModifiedByName	String	The name of the user who modified the stage.
ModifiedByEmail	String	The email of the user who modified the stage.

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
Fields	String	The fields that must be shown in response.

Territories

Get the list of territories enabled for your organization.

Select

All the filters are executed at client side within the Sync App.

SELECT * from Territories;

Columns


Name	Type	Description
Id [KEY]	String	Represents the unique ID of the territory.
Name	String	Represents the name of the territory.
ParentId	String	Represents the unique ID of the parent territory, if any.
Criteria	String	Represents the territory criteria details.
Managername	String	Represents the name of the current territory's manager.
Managerid	String	Represents the ID of the current territory's manager.
CreatedByName	String	Represents the name of the user who created the current territory.
CreatedById	String	Represents the ID of the user who created the current territory.
ModifiedByName	String	Represents the name of the user who last modified the current territory.
ModifiedByid	String	Represents the ID of the user who last modified the current territory.
CreatedAt	Datetime	Represents the date and time at which the current territory was created.
ModifiedAt	Datetime	Represents the date and time at which the current territory was last modified.
Desription	String	Represents the description of the territory, if any.

Users

Query information regarding users.

View-Specific Information

Select

The Sync App will use the Zoho CRM 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 '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Users WHERE Id = '3152079000000150015'

Columns


Name	Type	Description
Id [KEY]	String	A unique numeric identifier for the user.
FirstName	String	The first name of the user.
LastName	String	The last name of the user.
FullName	String	The full name of the user.
Email	String	The email of the user.
RoleName	String	The name of the role the user has.
RoleId	String	The Id of the role the user has.
ProfileName	String	The name of the profile the user has.
ProfileId	String	The Id of the profile the user has.
Country	String	The country where the user is situated.
City	String	The city where the user is situated.
Street	String	The street where the user is situated.
State	String	The state where the user is situated.
Zip	String	The zip where the user is situated.
Alias	String	The alias of the user.
Signature	String	The signature of the user.
NameFormat	String	The format of the name of the user.
PersonalAccount	Boolean	Whether this user has a personal account or not.
DefaultTabGroup	String	The default tab group for this user.
CountryLocale	String	The default country locale of the user.
Fax	String	The fax of the user.
Website	String	The website of the user.
Mobile	String	The mobile phone number of the user.
Phone	String	The phone number of the user.
Dob	String	The date of birth of the user.
Status	String	The status of the user.
Confirm	Boolean	Whether this user has confirmed his email or not.
Language	String	The Language of the user.
Locale	String	The locale of the user.
TimeFormat	String	The default time format of the user.
DateFormat	String	The default date format of the user.
DecimalSeparator	String	The locale of the default decimal separator of the user.
TimeZone	String	The time zone of the user.
Zuid	String	The default ZUID of the user.
CreatedByName	String	The name of the user who created this user.
CreatedById	String	The id of the user who created this user.
CreatedAt	Datetime	The time this user was created.
ModifiedByName	String	The name of the user who modified this user.
ModifiedById	String	The id of the user who modified this user.
ModifiedAt	Datetime	The time this user was last modified.
NumberSeparator	String	Represents the format of the number fields. The possible values are comma, period and space.
CustomizeInfoNotesDesc	String	The Customize info notes description.
CustomizeInfoShowRightPanel	Boolean	The Customize info show right panel.
CustomizeInfoShowLeftPanel	Boolean	The Customize info show left panel.
CustomizeInfoBcView	String	The Customize info bc view.
CustomizeInfoShowHome	Boolean	The Customize info show home.
CustomizeInfoShowDetailView	Boolean	The Customize info show detail view.
CustomizeInfoUnpinRecentItem	String	The Customize info unpin recent item.
Microsoft	Boolean	Represents if the user is a microsoft user.
ThemeBackground	String	The theme background.
ThemeNewBackground	String	The theme new background.
ThemeNormalTabBackground	String	The theme normal tab background.
ThemeNormalTabFontColor	String	The theme normal tab font color.
ThemeScreen	String	The theme screen.
ThemeSelectedTabBackground	String	The theme selected tab background.
ThemeSelectedTabBackground	String	The theme selected tab background.
ThemeType	String	The theme type.
ReportingToName	String	Represents the name of the user to whom the user reports to.
ReportingToId	String	Represents the id of the user to whom the user reports to.
Offset	Integer	Offset.
SandboxDeveloper	Boolean	Sandbox Developer.
Category	String	The category of the user.
SortOrderPreference	String	Represents how the records in the response are sorted based on either the last name or first name. The default sorting happens by the record IDs.

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
Type	String	Limit the users returned to the ones of this type The allowed values are AllUsers, ActiveUsers, DeactiveUsers, ConfirmedUsers, NotConfirmedUsers, DeletedUsers, ActiveConfirmedUsers, AdminUsers, ActiveConfirmedAdmins, CurrentUser.

Visits

Query information regarding recent visits.

Columns


Name	Type	Description
Id [KEY]	String	The Id of the visit.
PageVisited	String	The name of the visited page.
VisitedBy_Id	String	The Id of the visitor.
VisitedBy_FirstName	String	The First Name of the visitor.
VisitedBy_LastName	String	The Last Name of the visitor.
IPAddress	String	The IP address of the visitor.
TimeSpent(Minutes)	String	The time spent in minutes for the visit.
Referrer	String	The referrer of the visitor.
VisitedPageURL	String	The URL of the visited page.
CreatedBy_Id	String	The Id of the object which created the visit.
ModifiedBy_Id	String	The Id of the object which modified the visit.
ModifiedBy_FirstName	String	The First Name of the object which modified the visit.
ModifiedBy_LastName	String	The Last Name of the object which modified the visit.
CreatedTime	Datetime	The date and time when the visit was created.
ModifiedTime	Datetime	The date and time when the visit was modified.
AttendedBy	String	Who attended the visit.
UserDetails	String	The user details of the visit.
Browser	String	The browser used for the visit.
TimeVisited	Datetime	The date and time of the visit.
VisitorType	String	The type of visitor for the visit.
Revenue	Decimal	The revenue generated by the visit.
NumberofPages	Int	The number of pages visited from the visit.
PortalName	String	The name of the portal used for the visit.
SearchKeyword	String	The search keyword used for the visit.
SearchEngine	String	The search engine used for the visit.
OperatingSystem	String	The operating system of the visitor.
Gclid	String	The GCLID of the visitor.
Keyword	String	The keyword used in the visit.
ClickType	String	The click type of the visit.
Devicetype	String	The type of the device of the visitor.
AdNetwork	String	The ad network used in the visit.
SearchPartnerNetwork	String	The search partner network for the visit.
AdCampaignName	String	The ad campaign name of the visit.
AdGroupName	String	The ad group name of the visit.
Ad	String	The ad used for the visit.
AdClickDate	Date	The date and time when the ad was clicked.
VisitSource	String	The source of the visit.

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
DuplicateCheckFields	String	The field/s to be used for checking in an upsert.
CustomViewId	Long	The custom view Id to be used for filtering this record. Will work when useCOQL=false.

Server Side Filtering

After updating or inserting a new record into Zoho CRM account, the behavior of ModifiedTime filter server-side may be inconsistent due to API related issues, leading to the wrong filtered results or no results at all until all the data is synchronized server-side. In order to resolve this issue temporarily, the ModifiedTime filter should be adjusted to an hour(60 minutes) prior to the current filter that you have specified.

Working with Subforms

A Subform is a secondary table that allow you to add multiple line items to a primary table. The Sync App allows you to retrieve Subform information, add lines to an existing subform, modify subform entries, and delete entries.

Select

In order to access the Subform data, you must filter on the Id of the parent:

SELECT * FROM ParentTable WHERE Id = 21142143232903

This will return the entire Subform as a JSON aggregate.

Deep Insert

It is possible to insert a new parent object along with its full subform record all in one operation. This is done by formatting the Subform as a JSON aggregate and setting the name of the Subform field to this string in your INSERT statement. The following query will insert a parent record with a subform containing two line items.

 INSERT INTO ParentTable (ParentName,ChildForm) 
   VALUES (
     'New Parent', 
     '[ 
       {
        "subformprop1": "row1val1", 
        "subformprop2": "row1val2"
       }, 
       {
        "subformprop1": "row2val1", 
        "subformprop2": "row2val2"
       }
      ]')

Modifying Subform records

Any modifications done to an existing Subform requires an UPDATE request on the parent record. When building the JSON aggregate of the Subform in your query, you must specify the Id of the lines that you wish to leave untouched. If the Id is not included in the JSON, that line will be deleted from the Subform. New lines can be added by appending a line in your JSON that does not contain an Id. Existing lines can be modified by specifying the Id and any properties to be modified. Properties not specified will be unchanged. Below are examples of how to add lines, modify existing lines, and delete lines from a Subform record that already exists.

Add line items to an existing Subform

To add a line to an existing Subform, you will need to issue an UPDATE request with a JSON aggregate that contains all of the existing Ids specified along with the new lines specified without Ids. The service will recognize that it needs to insert the new line because the record does not have an Id. See below example.

 UPDATE ParentTableTable SET ChildForm = 
     -- first include existing child Ids so that they do not get deleted, then append the new lines
     '[
       { "id":"2732548000001192003" },
       { "id":"2732548000001192004" },
       { "id":"2732548000001192005" },
       {
        "subformprop1": "newline1val",
        "subformprop2": "newline1val2",
       }, 
       {
        "subformprop1": "newline2val",
        "subformprop2": "newline2val2"
       }
      ]'  WHERE id=2732548000001192001

Modify a Subform line

To modify a line, specify the Id of that line and any properties you wish to modify. Properties not specified will remain unchanged. In the example below, records with Ids ending in 3 and 4 will be untouched, and the record ending in 5 gets one property modified. Other records that exist are deleted.

 UPDATE ParentTableTable SET ChildForm = 
     '[
       { "id":"2732548000001192003" },
       { "id":"2732548000001192004" },
       {
        "id":"2732548000001192005",
        "subformprop1": "updatedval"
       }
      ]'  WHERE id=2732548000001192001

You can perform any combination of deletions, inserts, and updates to line items in a single request depending on how you format the JSON aggregate of the Subform.

Data Type Mapping

Data Type Mappings

The Sync App maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.


Zoho CRM	CData Schema
Auto-Number	string
Checkbox	bool
Currency	float
Date	date
Date/Time	datetime
Decimal	string
Email	string
FileUpload	string
Formula	string
LongInteger	long
Lookup	string
Multi-Line	string
Multi-Select	string
Number	int
Percent	string
Phone	string
PickList	string
SingleLine	string
URL	string
User	string

Connection String Options

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

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

Authentication

Property	Description
Region	The Top Level Domain (TLD) in the server URL.

OAuth

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL

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

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Schema	Specifies the Zoho CRM version the provider retrieves data from. Each version has a corresponding data model.

Miscellaneous

Property	Description
AccountsServer	Deprecated. The full Account Server URL.
AggregateColumnSize	Sets the length of a aggregate field for a provider.
APIDomain	Deprecated. The full URL of the API domain.
APIType	Specifies the API to use for retrieving data.
IncludeCustomFields	Specifies whether custom fields must be dynamically retrieved for existing tables.
IncludeCustomViews	If set to true, the provider will display custom views among the other views and make them available for use.
IncludeRelatedLists	If set to true, the provider will display related List views among the other views and make them available for use.
JobPollingInterval	Specifies the polling interval (in seconds) when checking the status of a bulk API job.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PageSize	The number of results to return per page of data retrieved from Zoho CRM.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UseCOQL	When true, the provider uses the Query API to retrieve data.
UseDisplayNames	If set to false, the provider will use api names for some operations.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
UseSandbox	Determines whether the calls will be sent to a Sandbox instance instead of a regular one.
UseServerSideFiltering	If set to false, the provider will not send the filters server-side but will process them client-side.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.

Authentication

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

Property	Description
Region	The Top Level Domain (TLD) in the server URL.

Region

The Top Level Domain (TLD) in the server URL.

Remarks

If your account resides in a domain other than the US, then change the Region accordingly. You only need to supply this when using your own OAuth access token with InitiateOAuth=Off. Otherwise, the Region will be retrieved from the OAuth flow. This table lists all possible values:


Region	Domain
US	.com
Europe	.eu
India	.in
Australia	.com.au
Japan	.jp
China	.com.cn
Canada	.ca

OAuth

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

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

SSL

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

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

SSLServerCert

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

Remarks

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

This property can take the following forms:


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

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

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

Firewall

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

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Zoho CRM. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Zoho CRM. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Zoho CRM. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

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

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

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

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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

ProxyServer

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

BASIC: The Sync App performs HTTP BASIC authentication.
DIGEST: The Sync App performs HTTP DIGEST authentication.
NTLM: The Sync App retrieves an NTLM token.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

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

ProxyUser

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

ProxyPassword

The password associated with the user specified in the ProxyUser connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

ProxySSLType

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


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

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

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

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Logging

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

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Schema

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

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Schema	Specifies the Zoho CRM version the provider retrieves data from. Each version has a corresponding data model.

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\ZohoCRM Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:


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

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Schema

Specifies the Zoho CRM version the provider retrieves data from. Each version has a corresponding data model.

Remarks

The Zoho CRM version. Each version has a corresponding data model.

Note: This specifies the Zoho CRM version, not the API (Query, Bulk, REST) used. That is specified by UseCOQL and APIType.

Miscellaneous

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

Property	Description
AccountsServer	Deprecated. The full Account Server URL.
AggregateColumnSize	Sets the length of a aggregate field for a provider.
APIDomain	Deprecated. The full URL of the API domain.
APIType	Specifies the API to use for retrieving data.
IncludeCustomFields	Specifies whether custom fields must be dynamically retrieved for existing tables.
IncludeCustomViews	If set to true, the provider will display custom views among the other views and make them available for use.
IncludeRelatedLists	If set to true, the provider will display related List views among the other views and make them available for use.
JobPollingInterval	Specifies the polling interval (in seconds) when checking the status of a bulk API job.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PageSize	The number of results to return per page of data retrieved from Zoho CRM.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UseCOQL	When true, the provider uses the Query API to retrieve data.
UseDisplayNames	If set to false, the provider will use api names for some operations.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
UseSandbox	Determines whether the calls will be sent to a Sandbox instance instead of a regular one.
UseServerSideFiltering	If set to false, the provider will not send the filters server-side but will process them client-side.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.

AccountsServer

Deprecated. The full Account Server URL.

Remarks

Note: This connection property has been deprecated. Set the Region connection property instead.

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

AggregateColumnSize

Sets the length of a aggregate field for a provider.

Remarks

Sets the length of a aggregate field for a provider. If not set the length reported by the server will be considered.

APIDomain

Deprecated. The full URL of the API domain.

Remarks

Note: This connection property has been deprecated. Set the Region connection property instead.

The full URL of the API domain. You only need to supply this when using your own OAuth access token with InitiateOAuth=Off. Otherwise, the API domain is retrieved from the OAuth flow. Most of the time, the value of this property is https://www.zohoapis.com, but if your account resides in a different location, then the domain should change accordingly (.eu, .in, .com.au, ...).

APIType

Specifies the API to use for retrieving data.

Remarks

Gives an option to use either BULK API or REST API for both read and write operations.

This connection property only takes effect when UseCOQL is set to False.

Note: This does not specify the Zoho CRM version whose associated data model is used by the Sync App. That is specified by Schema.

IncludeCustomFields

Specifies whether custom fields must be dynamically retrieved for existing tables.

Remarks

With this property set to false only standard columns will be displayed for a given table.

IncludeCustomViews

If set to true, the provider will display custom views among the other views and make them available for use.

Remarks

If set to true, the Sync App will display custom views among other views. Retrieving custom views is not only a costly operation but it also decreases performance, that's why this property defaults to 'false'.

IncludeRelatedLists

If set to true, the provider will display related List views among the other views and make them available for use.

Remarks

If set to true, the Sync App will display related List views views among other views. Retrieving related Lists is not only a costly operation but it also decreases performance, that's why this property defaults to 'false'.

JobPollingInterval

Specifies the polling interval (in seconds) when checking the status of a bulk API job.

Remarks

This property is used to specify the polling interval (in seconds) to identify when a bulk API job has completed. The Sync App will wait JobPollingInterval seconds between calls to check a bulk API job status. Once the job is identified as 'Completed', the Sync App will download and parse the generated file returning the results of the specified query.

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting


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

PageSize

The number of results to return per page of data retrieved from Zoho CRM.

Remarks

Note that the PageSize must be between 1 and 200.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UseCOQL

When true, the provider uses the Query API to retrieve data.

Remarks

When Schema is set to v2, v2.1, or v4 the Query API limits queries to a single table or view to a maximum of 10,000 rows and 50 columns.

If you need to select more columns and rows, refer to v2, v2.1, or v4 (in accordance with the value you set for Schema) to see the limits imposed by all available APIs.

UseDisplayNames

If set to false, the provider will use api names for some operations.

Remarks

If set to true, the Sync App will use api names for some operations. This property is used for custom modules: The API name for custom modules is different from a custom module name in the Zoho CRM UI. For example, if you create a Potentials custom module in Zoho CRM, the Sync App will make the underlying requests to the API name; for example, CustomModule_1.

Set this property to true to use the api name in SQL queries.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

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

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

UseSandbox

Determines whether the calls will be sent to a Sandbox instance instead of a regular one.

Remarks

If the Zoho account you plan on using this driver on supports Sandboxes and you want to use one, set this property to true. Otherwise, just leave empty to proceed using your regular CRM instance.

UseServerSideFiltering

If set to false, the provider will not send the filters server-side but will process them client-side.

Remarks

If set to true, the Sync App will send the filters server-side. In ZohoCRM, if the data is updated recently, it might take some time for the filters to work server-side so only in this case it is recommended for this property to be set to false in order to get proper results. In all the other cases this will be a considerably expensive operation to do client-side and it might take longer to retrieve the data.

UseSimpleNames

Boolean determining if simple names should be used for tables and columns.

Remarks

Zoho CRM tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Sync App easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.

Zoho CRM Connector for CData Sync

Zoho CRM Connector for CData Sync

Overview

Zoho CRM Version Support

Establishing a Connection

Adding a Connection to Zoho CRM

Connecting to Zoho CRM

Authenticating to Zoho CRM

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

CData Sync App Data Models

Batch Operations

v2

Zoho CRM APIs

API Limitations

API Metadata

Using Query Processing

Tables

Views

Stored Procedures

Tables

Zoho CRM Connector for CData Sync Tables

Accounts

Table-Specific Information

Select

Insert

Delete

Update

Columns

Pseudo-Columns

Activities

Table-Specific Information

Select

Delete

Columns

Pseudo-Columns

Attachments

Table-Specific Information

Select

Delete

Columns

Pseudo-Columns

Calls

Table-Specific Information

Select

Insert

Delete

Update

Columns

Pseudo-Columns

Campaigns

Table-Specific Information

Select

Insert

Delete

Update

Columns

Pseudo-Columns

Cases

Table-Specific Information

Select

Insert

Delete

Update

Columns

Pseudo-Columns

ContactRoles

Table-Specific Information

Select