Zoho CRM Query Data Model

Connection String Options

  1. Auto Cache
  2. Batch Size 
  3. Cache Connection
  4. Cache Driver
  5. Cache Location
  6. Cache Metadata
  7. Cache Query Result
  8. Cache Tolerance
  9. Callback URL
  10. Connection Life Time
  11. Connect On Open
  12. Firewall Password
  13. Firewall Port
  14. Firewall Server
  15. Firewall Type
  16. Firewall User
  17. Initiate OAuth
  18. Location
  19. Logfile
  20. Max Log File Size
  21. OAuth Access Token
  22. OAuth Client Id
  23. OAuth Client Secret
  24. OAuth Refresh Token
  25. OAuth Settings Location
  26. OAuth Verifier
  27. Offline
  28. Other
  29. Pool Idle Timeout
  30. Pool Max Size
  31. Pool Min Size
  32. Pool Wait Time
  33. Proxy Auth Scheme
  34. Proxy Auto Detect
  35. Proxy Exceptions
  36. Proxy Password
  37. Proxy Port
  38. Proxy Server
  39. Proxy SSL Type
  40. Proxy User
  41. Pseudo Columns
  42. Readonly
  43. RTK
  44. SSL Server Cert
  45. Support Enhanced SQL
  46. Tables
  47. Timeout
  48. Use Connection Pooling
  49. Use Internal Names
  50. Use Simple Names
  51. Verbosity
  52. Views

Auto Cache

Data Type

bool

Default Value

false

Remarks

When AutoCache is set, the driver automatically maintains a cache of your table's data in the database of your choice. By default, the driver incrementally updates the cache, retrieving only changes since the last SELECT query was run if the length of time since the last run has exceeded the CacheTolerance. After the cache is updated, the query is executed against the cached data. With CacheQueryResult additionally set, the driver updates the cache when you execute a SELECT query and returns the live results from the Zoho CRM data.

 

Explicitly Caching SELECT Results

 

CacheQueryResult is a way to query Zoho CRM in real time while maintaining a cache for offline use. Set CacheQueryResult to update the cache whenever you execute a SELECT statement. When you execute a SELECT statement with AutoCache and CacheQueryResult set, the driver executes the query to the remote data and caches the results; rows that already exist are overwritten. That is, SELECT statements are used to create and refresh the cache, not to query it. Data manipulation commands are executed to the remote data as well.

To query the cached data, set the Offline property. If you need to query the cached data in an online connection, you can append #CACHE to the table name. For example:

SELECT * FROM [Accounts#CACHE]

 

 

Setting the Caching Database

 

When AutoCache is set, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

 

 

See Also

 

 

  • CacheTolerance: Control the tolerance for stale data in the cache.
  • CacheQueryResult: Insert or update each row returned into the corresponding table in the cache.
  • Caching: Best Practices: This section provides more examples of using AutoCache with Offline, as well as information on determining a caching strategy.
  • CacheMetadata: This property reduces the amount of metadata that crosses the network by persisting table schemas retrieved from the Zoho CRM metadata. Metadata then needs to be retrieved only once instead of every connection.
  • REPLICATE Statements: When you execute a SELECT statement with AutoCache set, the driver internally calls the REPLICATE statement. The REPLICATE statement enables incremental updates instead of first dropping the cached table.
  • CACHE Statements: You can use the CACHE statement to persist any SELECT query, as well as manage the cache; for example, refreshing schemas.

 

 

 

Batch Size

Data Type

int

Default Value

0

Remarks

When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.

Setting BatchSize to 0 will submit the entire batch as specified.

 

Cache Connection

Data Type

string

Default Value

""

Remarks

 

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properies are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.

 

Derby and Java DB

 

The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.

Alternatively, you can configure the connection to Derby manually using CacheProvider and CacheConnection. Below is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory

 

 

SQLite

 

To cache to SQLite, you can use the SQLite JDBC driver. Below is the syntax of the JDBC URL:

jdbc:sqlite:dataSource
  • Data Source: The path to an SQLite database file. Or, use a value of :memory to cache in memory.

 

 

MySQL

 

The installation includes the CData JDBC Driver for MySQL. Below is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
Below are typical connection properties:

 

 

  • Server: The IP address or domain name of the server you want to connect to.
  • Port: The port that the server is running on.
  • User: The username provided for authentication to the database.
  • Password: The password provided for authentication to the database.
  • Database: The name of the database.
SQL Server

 

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
Below are typical SQL Server connection properties:
  • Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
  • Port: The port SQL Server is running on.
  • Database: The name of the SQL Server database.
  • Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.

    To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.

  • User ID: The username provided for authentication with SQL Server. Only needed if you are not using integrated security.
  • Password: The password provided for authentication with SQL Server. Only needed if you are not using integrated security.
Oracle

 

Below is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
Below are typical connection properties:
  • Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).

  • Password: The password provided for authentication with the Oracle database.
  • User Id: The user Id provided for authentication with the Oracle database.
PostgreSQL

 

Below is the JDBC URL syntax for the official PostgreSQL JDBC driver:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
Below are typical connection properties:
  • Host: The address of the server hosting the PostgreSQL database.
  • Port: The port used to connect to the server hosting the PostgreSQL database.
  • Database: The name of the database.
  • Username: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
  • Password: The password provided for authentication with the PostgreSQL database.

 

 

Cache Driver

Data Type

string

Default Value

""

Remarks

 

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you would like to use to cache data.

Note that you must also add the CacheDriver JAR to the classpath.

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

 

 

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR is shipped in the JDK. You can find the JAR, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath.

jdbc:zohocrm:CacheLocation='c:/Temp/cachedir';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333
To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:
jdbc:zohocrm:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333
SQLite

 

Below is a JDBC URL for the SQLite JDBC driver:

jdbc:zohocrm:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333
MySQL

 

Below is a JDBC URL for the included CData JDBC Driver for MySQL:

  jdbc:zohocrm:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333

  
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for ZohoCRM 2018 installation directory.
SQL Server

 

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:zohocrm:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333
Oracle

 

Below is a JDBC URL for the Oracle Thin Client:

jdbc:zohocrm:Cache Driver=oracle.jdbc.driver.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333
PostgreSQL

 

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:zohocrm:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333

 

 

Cache Location

Data Type

string

Default Value

""

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR to the classpath. The JAR, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

CacheLocation defaults to the directory specified by the Location setting.

See Also

 

 

  • AutoCache: Set this to implicitly create and maintain a cache for later offline use.
  • CacheMetadata: Set this to persist the Zoho CRM catalog in CacheLocation.

 

 

Cache Metadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the Zoho CRM catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

 

The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.

When Not to Use CacheMetadata

 

 

  • When you are working with volatile metadata: Metadata for a table is only retrieved the first time the connection to the table is made. To pick up new, changed, or deleted columns, you would need to delete and rebuild the metadata cache. Therefore, it is best to rely on the in-memory caching for cases where metdata will change often.
  • When you are caching to a database: CacheMetadata can only be used with CacheLocation. If you are caching to another database with the CacheDriver and CacheConnection properties, use AutoCache to cache implicitly. Or, use REPLICATE Statements or CACHE Statements to cache explicitly.

 

 

Cache Query Result

Data Type

bool

Default Value

false

Remarks

When CacheQueryResult and AutoCache are set, the rows returned from a SELECT query are cached in the cache database. The driver handles caching in a streaming fashion with each row being processed into the cache database from the original result set as you read the row from the returned ResultSet object. This ensures that the live data is not queried twice. Note that any rows you do not read from the returned ResultSet will not be updated in the cache.

 

Cache Tolerance

Data Type

string

Default Value

"600"

Remarks

The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver will check with the data source for newer records after the tolerance interval has expired. Otherwise it will return the data directly from the cache.

 

Callback URL

Data Type

string

Default Value

""

Remarks

 

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

 

Connection Life Time

Data Type

string

Default Value

"0"

Remarks

The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.

 

Connect On Open

Data Type

bool

Default Value

false

Remarks

When set to 'true', a connection will be made to Zoho CRM when the connection is opened. This property enables the 'Test Connection' feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to Zoho CRM and nothing from this initial connection is maintained.

Setting this property to 'false' may provide performance improvements (depending upon the number of times a connection is opened).

 

Firewall Password

Data Type

string

Default Value

""

Remarks

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

 

Firewall Port

Data Type

string

Default Value

""

Remarks

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

 

Firewall Server

Data Type

string

Default Value

""

Remarks

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

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

 

Firewall Type

Data Type

string

Default Value

"NONE"

Remarks

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

 

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

 

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

 

 

Firewall User

Data Type

string

Default Value

""

Remarks

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

 

Initiate OAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

 

 

Location

Data Type

string

Default Value

""

Remarks

The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files are deployed alongside the driver assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

 

Logfile

Data Type

string

Default Value

""

Remarks

For more control over what is written to the log file, take a look at Verbosity.

 

Max Log File Size

Data Type

string

Default Value

"20MB"

Remarks

A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 20MB. Values lower than 100kB will use 100kB as the value instead.

 

OAuth Access Token

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your username and password. The access token protects your credentials by keeping them on the server.

 

OAuth Client Id

Data Type

string

Default Value

""

Remarks

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

 

OAuth Client Secret

Data Type

string

Default Value

""

Remarks

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

 

OAuth Refresh Token

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

 

OAuth Settings Location

Data Type

string

Default Value

"%APPDATA%\\CData\\ZohoCRM Data Provider\\OAuthSettings.txt"

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to a settings file to avoid requiring the user to manually enter OAuth connection properties. The default OAuthSettingsLocation is a settings file located in the %AppData%\CData folder.

 

OAuth Verifier

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems. The verifier will only be used when InitiateOAuth is set to GETANDREFRESH. Once the OAuth settings file has been generated, the verifier can be removed from the connection properties.

 

 

Offline

Data Type

bool

Default Value

false

Remarks

When Offline is set to TRUE, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.

 

Other

Data Type

string

Default Value

""

Remarks

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

Specify multiple properties in a semicolon-separated list.

Caching Configuration

 

   
CachePartial=True Caches only a subset of columns, which you can specify in your query.
QueryPassthrough=True Passes the specified query to the cache database instead of using the SQL parser of the driver.

 

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

 

 

Pool Idle Timeout

Data Type

string

Default Value

""

Remarks

The allowed idle time from when the connection is free to when the connection is released and returned to the pool. The default is 60 seconds.

 

Pool Max Size

Data Type

string

Default Value

"100"

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.

 

Pool Min Size

Data Type

string

Default Value

"1"

Remarks

The minimum number of connections in the pool. The default is 1.

 

Pool Wait Time

Data Type

string

Default Value

""

Remarks

The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.

 

Proxy Auth Scheme

Data Type

string

Default Value

"BASIC"

Remarks

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

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

The authentication type can be one of the following:

  • BASIC: The driver performs HTTP BASIC authentication.
  • DIGEST: The driver performs HTTP DIGEST authentication.
  • NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The driver does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

 

 

Proxy Auto Detect

Data Type

bool

Default Value

true

Remarks

By default, the driver uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see ProxyServer.

For other proxies, such as SOCKS or tunneling, see FirewallType.

 

Proxy Exceptions

Data Type

string

Default Value

""

Remarks

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

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

 

Proxy Password

Data Type

string

Default Value

""

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

 

Proxy Port

Data Type

string

Default Value

"80"

Remarks

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

 

Proxy Server

Data Type

string

Default Value

""

Remarks

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

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

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

 

Proxy SSL Type

Data Type

string

Default Value

"AUTO"

Remarks

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

 

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

 

 

Proxy User

Data Type

string

Default Value

""

Remarks

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

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

user@domain

domain\user

 

 

Pseudo Columns

Data Type

string

Default Value

""

Remarks

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

 

Readonly

Data Type

bool

Default Value

false

Remarks

If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

 

RTK

Data Type

string

Default Value

""

Remarks

 

The RTK property may be used to license a build. Please see the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

 

SSL Server Cert

Data Type

string

Default Value

""

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 will be rejected.

This property can take the 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 will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

 

Support Enhanced SQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL is set to true, the driver offloads as much of the SELECT statement processing as possible to Zoho CRM and then processes the rest of the query in memory. In this way the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL is set to false, the driver limits SQL execution to what is supported by the Zoho CRM API.

Execution of Predicates

 

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

 

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

 

The driver retrieves all rows necessary to process the aggregation in memory.

 

Tables

Data Type

string

Default Value

""

Remarks

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

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

Specify the tables you want in a comma-separated list. For example: Tables=TableA,TableB,TableC

 

Timeout

Data Type

string

Default Value

"60"

Remarks

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

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

 

Use Connection Pooling

Data Type

bool

Default Value

false

Remarks

Enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.

 

Use Internal Names

Data Type

bool

Default Value

false

Remarks

If set to true, the driver will use internal 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 driver will make the underlying requests to the API name; for example, CustomModule_1.

Set this property to true to use the underlying API name in SQL.

 

Use Simple Names

Data Type

bool

Default Value

false

Remarks

Boolean determining if simple names should be used for tables and columns. Zoho CRM tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the driver 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 displayed table and column names. Any non-alphanumeric characters will be converted to an underscore.

 

Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are described below:

 

   
1 Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2 Setting Verbosity to 2 will log everything included in Verbosity 1, cache queries, and additional information about the request, if applicable, such as HTTP headers.
3 Setting Verbosity to 3 will additionally log the body of the request and the response.
4 Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation.
5 Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.

 

Views

Data Type

string

Default Value

""

Remarks

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

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

Specify the views you want in a comma-separated list. For example: For example: Views=ViewsA,ViewsB,ViewsC




 

Tables

  1. Accounts
  2. Activities
  3. Attachments
  4. Calls
  5. Campaigns
  6. Cases
  7. Contacts
  8. Deals
  9. Events
  10. Invoices
  11. Leads
  12. Notes
  13. PriceBooks
  14. Products
  15. PurchaseOrders
  16. Quotes
  17. SalesOrders
  18. Solutions
  19. Tasks
  20. Vendors

Accounts

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Accounts



SELECT * FROM Accounts WHERE Id = '3152079000000153079'



SELECT * FROM Accounts WHERE AccountName = 'Benton'
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 False

The unique identifier for this record.

AccountOwner_Id String False

The Id of the account owner for the account.

AccountOwner_Name String True

The name of the account owner for the account.

Rating String False

The rating for the account.

AccountName String False

The name of the account.

Phone String False

The phone of the account.

AccountSite String False

The site for the account.

Fax String False

The fax of the account.

ParentAccount_Id String False

The Id of the parent account of the account.

ParentAccount_Name String True

The name of the parent account of the account.

Website String False

The website of the account.

AccountNumber Long False

The account number of the account.

TickerSymbol String False

The ticker symbol of the account

AccountType String False

The type of the account.

Ownership String False

The ownership of the account.

Industry String False

The industry of the account.

Employees Int False

The number of employess the account has.

AnnualRevenue Double False

The annual revenue of the account.

SICCode Int False

The SIC code of the account

Tag String False

The tag of the account.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

LastActivityTime Datetime False

The time of the last activity for the account.

BillingStreet String False

The billing street of the account.

ShippingStreet String False

The shipping street of the account.

BillingCity String False

The billing city of the account.

ShippingCity String False

The shipping city of the account.

BillingState String False

The billing state of the account.

ShippingState String False

The shipping state of the account.

BillingCode String False

The billing code of the account.

ShippingCode String False

The shipping code of the account.

BillingCountry String False

The billing country of the account.

ShippingCountry String False

The shipping country of the account.

Description String False

The description of the account.

History String False

The history of the account.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Activities

Delete, and query information regarding activities.

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Activities



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 False

The unique identifier for this record.

ActivityOwner_Id String False

The Id of the activity owner.

ActivityOwner_Name String True

The name of the activity owner.

Subject String False

The subject of the activity.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

ActivityType String False

The type of the activity.

ContactName_Id String False

The Id of the contact.

ContactName_Name String True

The name of the contact.

RelatedTo_Id String False

The Id to whom this activity is related to.

RelatedTo_Name String True

The name to whom this activity is related to.

Description String False

The description of the activity.

DueDate Date False

The due date of the activity.

Status String False

The status of the activity.

Priority String False

The priority of the activity.

SendNotificationEmail Bool False

Wheter to send a notification email for this activity or not

Repeat String False

If this is a repeat activity or not.

ClosedTime Datetime False

The closed time of the activity.

Location String False

The location where this activity will take place.

From Datetime False

The start time of the activity.

Allday Bool False

Whether this activity will take all day or not.

To Datetime False

The end time of the activity.

Participants Long False

The number of participants in this activity.

Check_InTime Datetime True

The time when check in has to happen.

Check_InBy_Id String False

The Id of the user who is checking in.

Check_InBy_Name String True

The name of the user who is checking in.

Check_InComment String True

The comment of the check in for the activity.

Check_InSub_Locality String True

The sub-locality where the check in for this activity will happen.

Check_InCity String True

The city where the check in for this activity will happen.

Check_InState String True

The state where the check in for this activity will happen.

Check_InCountry String True

The country where the check in for this activity will happen.

Latitude String True

The latitude where the check in for this activity will happen.

Longitude String True

The longitude where the check in for this activity will happen.

ZipCode String True

The zip code where the check in for this activity will happen.

Check_InAddress String True

The address where the check in for this activity will happen.

CheckedInStatus String True

The status of the checked in for this activity.

CallPurpose String False

The purpose of the call for this activity.

CallType String False

The type of the call for this activity.

CallStartTime Datetime False

The start time of the call for this activity.

CallDuration String False

The duration of the call for this activity.

CallDuration_inseconds_ Int False

The duration of the call in seconds for this activity.

CallResult String False

The result of the call for this activity.

Billable Bool False

Whether this activity is billable or not.

CTIEntry Bool False

Whether this activity is a CTI entry or not.

Reminder String False

A reminder set for this activity.

CallStatus String False

The status of the call for this activity.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Attachments

Delete, and query information regarding attachments.

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Attachments



SELECT * FROM Attachments WHERE Id = '3152079000000153079'



SELECT * FROM Attachments WHERE FileName = 'Koala.jpg'
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 False

The unique identifier for this record.

AttachmentOwner_Id String False

The Id of the attachment owner.

AttachmentOwner_Name String True

The name of the attachment owner.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

FileName String False

The name of the file of the attachment.

Size String False

The size of the attachment.

ParentID_Id String False

The Id of the parent of the attachment.

ParentID_Name String True

The name of the parent of the attachment.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Calls

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Calls



SELECT * FROM Calls WHERE Id = '3152079000000153079'



SELECT * FROM Calls WHERE CallPurpose = 'Prospecting'
Insert
 
INSERT INTO Calls(Subject) VALUES('A test call') 

 

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 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 False

The unique identifier for this record.

ContactName_Id String False

The Id of the contact of the call.

ContactName_Name String True

The Id of the name of the call.

Subject String False

The subject of the call.

CallPurpose String False

The purpose of the call.

RelatedTo_Id String False

The Id of the person this call was related to.

RelatedTo_Name String True

The name of the person this call was related to.

CallType String False

The type of the call.

CallStartTime Datetime False

The time of the start of the call.

CallDuration String False

The duration of the call.

CallDuration_inseconds_ Int False

The duration of the call in seconds.

Description String False

The description of the call.

CallResult String False

The result of the call.

Billable Bool False

Whether this call was billable or not.

CallOwner_Id String False

The Id of the owner of the call.

CallOwner_Name String True

The name of the owner of the call.

CTIEntry Bool False

Whether this call was a CTI entry or not.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

Tag String False

The tags of the call.

ModifiedTime Datetime False

The time when the record was modified.

Reminder String False

The reminder set for this call.

CallStatus String True

The status of the call.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Campaigns

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Campaigns



SELECT * FROM Campaigns WHERE Id = '3152079000000153079'



SELECT * FROM Campaigns WHERE Type = 'Conference'
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 False

The unique identifier for this record.

CampaignOwner_Id String False

The Id of the campaign owner.

CampaignOwner_Name String True

The name of the campaign owner.

Type String False

The type of the campaign.

CampaignName String False

The name of the campaign.

Status String False

The status of the campaign.

StartDate Date False

The date of the start of the campaign.

EndDate Date False

The date of the end of the campaign.

ExpectedRevenue Double False

The expected revenue from this campaign.

BudgetedCost Double False

The budgeted cost of the campaign.

ActualCost Double False

The actual cost of the campaign.

ExpectedResponse Long False

The expected response from this campaign.

Numberssent Long False

The number of sent campaigns.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

Tag String False

The tags for this campaign.

Description String False

The description of this campaign.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Cases

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Cases



SELECT * FROM Cases WHERE Id = '3152079000000153079'



SELECT * FROM Cases WHERE Priority = 'Medium'
Insert
 
INSERT INTO Cases(Email, Priority, Description) VALUES('test@gmail.com', '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 False

The unique identifier for this record.

CaseOwner_Id String False

The Id of the owner of the case.

CaseOwner_Name String True

The name of the owner of the case.

CaseNumber String False

The number of the case.

Status String False

The status of the case.

ProductName_Id String False

The Id of the product concerning this case.

ProductName_Name String True

The name of the product concerning this case.

Priority String False

The priority of the case.

Type String False

The type of the case.

CaseReason String False

The reason this case was opened.

CaseOrigin String False

The origin of this case.

Subject String False

The subject of the case.

RelatedTo_Id String False

The Id to what this case is related to.

RelatedTo_Name String True

The name to what this chase is related to.

No_ofcomments Int True

The number of comments in this case.

AccountName_Id String False

The Id of the account of this case.

AccountName_Name String True

The name of the account of this case.

ReportedBy String False

By whom this case was reported.

DealName_Id String False

The Id of the deal this case concerns.

DealName_Name String True

The name of the deal this case concerns.

Email String False

The email of the person opening this case.

Tag String False

The tags concerning this case.

Phone String False

The phone of the person opening this case.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

Description String False

The description of this case.

InternalComments String False

The internal comments of this case.

Solution String False

The solution of this case.

Comments String True

A list of comments regarding this case.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Contacts

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Contacts



SELECT * FROM Contacts WHERE Id = '3152079000000153079'



SELECT * FROM Contacts WHERE FirstName = 'John'
Insert
 
INSERT INTO Contacts(FirstName, LastName, Email) VALUES('John', 'Smith', 'johnsmith6131@gmail.com')

 

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 False

The unique identifier for this record.

ContactOwner_Id String False

The Id of the owner of the contact.

ContactOwner_Name String True

The name of the owner of the contact.

LeadSource String False

The source of the lead.

FirstName String False

The first name of the contact.

LastName String False

The last name of the contact.

AccountName_Id String False

The id of the account concerning this contact.

AccountName_Name String True

The name of the account concerning this contact.

VendorName_Id String False

The Id of the vendor concerning this account.

VendorName_Name String True

The name of the vendor concerning this account.

Email String False

The email of the contact.

Title String False

The title of the contact.

Department String False

The Department of the contact.

Phone String False

The phone of the contact.

HomePhone String False

The home phone of the contact.

OtherPhone String False

A different phone number of the contact.

Fax String False

The fax of the contact.

Mobile String False

The mobile of the contact.

DateofBirth Date False

The date of birth of the contact.

Tag String False

A list of tags of the contact.

Assistant String False

The assistant of the contact.

AsstPhone String False

The phone number of the assistant of the contact.

ReportsTo String False

To whom the contact reports to.

EmailOptOut Bool False

Whether this contact has opted out from receiving emails.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

SkypeID String False

The Skype ID of the contact.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

FullName String False

The full name of the contact.

Salutation String False

The salutation the contact likes to be referenced as.

SecondaryEmail String False

The secondary email of the contact.

LastActivityTime Datetime False

The time of the contact's last activity.

Twitter String False

The twitter handle of the contact.

MailingStreet String False

The mailing street of the contact.

OtherStreet String False

The other street of the contact.

MailingCity String False

The mailing city of the contact.

OtherCity String False

The other city of the contact.

MailingState String False

The mailing state of the contact.

OtherState String False

The other state of the contact.

MailingZip String False

The mailing zip of the contact.

OtherZip String False

The other zip of the contact.

MailingCountry String False

The mailing country of the contact.

OtherCountry String False

The other country of the contact.

Description String False

The description of the contact.

MostRecentVisit Datetime False

The most recent visit of the contact.

FirstVisit Datetime False

The first visit of the contact.

Referrer String False

The referrer of the contact.

FirstPageVisited String False

The first page the contact has visited.

NumberOfChats Int False

The number of chats the contact has had.

AverageTimeSpent_Minutes_ String False

The average time in minutes the contact has spent.

DaysVisited Int False

The number of days the contact has visited.

VisitorScore Long False

The visitor score of the contact.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Deals

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Deals



SELECT * FROM Deals WHERE Id = '3152079000000153079'



SELECT * FROM Deals WHERE Stage = 'Qualification'
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 False

The unique identifier for this record.

DealOwner_Id String False

The Id of the deal owner.

DealOwner_Name String True

The name of the deal owner.

Amount Double False

The amount of the deal.

DealName String False

The name of the deal.

ClosingDate Date False

The closing date of the dal.

AccountName_Id String False

The Id of the account who created the deal.

AccountName_Name String True

The name of the account who created the deal.

Stage String False

The stage in which the deal is in.

Type String False

The type of the deal.

Probability_ Int False

The probability this deal has of being closed.

NextStep String False

The next step of the deal.

ExpectedRevenue Double True

The expected revenue from the deal.

LeadSource String False

The source of the deal.

CampaignSource_Id String False

The Id of the campaign source concerning this deal.

CampaignSource_Name String True

The name of the campaign source concerning this deal.

ContactName_Id String False

The Id of the contact regarding this deal.

ContactName_Name String True

The name of the contact regarding this deal.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

Tag String False

A list of tags regarding this deal.

ModifiedTime Datetime False

The time when the record was modified.

LastActivityTime Datetime False

The last activity time of this deal.

LeadConversionTime Int False

The time it took for this lead to convert.

SalesCycleDuration Int False

The duration of sales cycles it took for this deal.

OverallSalesDuration Int False

The overal sales duration of this deal.

Description String False

The descrption of this deal.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Events

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Events



SELECT * FROM Events WHERE Id = '3152079000000153079'



SELECT * FROM Events WHERE Location = 'Online'
Insert
 
INSERT INTO Events(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 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.

Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String False

The unique identifier for this record.

Title String False

The title of the event.

Location String False

The location of the event.

From Datetime False

The starting time of the event.

Allday Bool False

Whether the even will be going on for the whole day or not.

To Datetime False

The end time of the event.

Host_Id String False

The Id of the host of the event.

Host_Name String True

The name of the host of the event.

ContactName_Id String False

The Id of the contact of the event.

ContactName_Name String True

The name of the contact of the event.

Participants Long False

A list of participants in this event.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

Description String False

The description of the event.

RelatedTo_Id String False

The Id to whom this event is related to.

RelatedTo_Name String True

The name to whom this event is related to.

Repeat String False

Whether this is a recurring activity or not.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

Check_InTime Datetime True

The time of the check in for this event.

Check_InBy_Id String False

The Id of the person who checked in for this event.

Check_InBy_Name String True

The name of the person who checked in for this event.

Check_InComment String True

The check in comment for this event.

Check_InSub_Locality String True

The sub locality of the check in for this event.

Reminder String False

A reminder set for this event.

Check_InCity String True

The city where the check in for this event will be held at.

Check_InState String True

The state where the check in for this event will be held at.

Check_InCountry String True

The country where the check in for this event will be held at.

Latitude String True

The latitude of where the event will take place.

Longitude String True

The longitude of where the event will take place.

ZipCode String True

The ZIP code of where the event will take place.

Check_InAddress String True

The address of the check in for this event.

CheckedInStatus String True

The check in status for this event.

Tag String False

A list of tags for this event.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Invoices

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Invoices



SELECT * FROM Invoices WHERE Id = '3152079000000153079'



SELECT * FROM Invoices WHERE BillingCity = 'Sioux Falls'
Insert
 
INSERT INTO Invoices(Status, DueDate, Subject) VALUES('Created', '2018/06/06', 'An invoice for the purchase of products XYZ.')



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: 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 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 False

The unique identifier for this record.

InvoiceOwner_Id String False

The Id of the owner of this invoice.

InvoiceOwner_Name String True

The name of the owner of this invoice.

InvoiceNumber String False

The number of this invoice.

Subject String False

The subject of this invoice.

SalesOrder_Id String False

The Id of the sales order linked to this invoice.

SalesOrder_Name String True

The name of the sales order linked to this invoice.

InvoiceDate Date False

The date listed in the invoice.

PurchaseOrder String False

The purchase order linked with this invoice.

DueDate Date False

The date when this invoice is due at.

ExciseDuty Double False

The amount of excise duty for this invoice.

SalesCommission Double False

The amount of sales commission for this invoice.

Status String False

The status of the invoice.

AccountName_Id String False

The Id of the account linked with this invoice.

AccountName_Name String True

The name of the account linked with this invoice.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ContactName_Id String False

The Id of the contact linked with this invoice.

ContactName_Name String True

The name of the contact linked with this invoice.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

Tag String False

A list of tags related to this invoice.

BillingStreet String False

The billing street of the invoice.

ShippingStreet String False

The shipping street of the invoice.

BillingCity String False

The billing city of the invoice.

ShippingCity String False

The shipping city of the invoice.

BillingState String False

The billing state of the invoice.

ShippingState String False

The shipping state of the invoice.

BillingCode String False

The billing code of the invoice.

ShippingCode String False

The shipping code of the invoice.

BillingCountry String False

The billing country of the invoice.

ShippingCountry String False

The shippingcountry of the invoice.

ProductDetails String False

A json aggregate of the product details for this invoice.

SubTotal Double True

The subtotal of this invoice.

Discount Double False

The discount applied to this invoice.

Tax Double True

The tax applied to this invoice.

Adjustment Double False

The adjustment applied to this invoice.

GrandTotal Double True

The grand total of this invoice.

TermsandConditions String False

The terms and conditions of this invoice.

Description String False

The description of this invoice.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Leads

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Leads



SELECT * FROM Leads WHERE Id = '3152079000000153079'



SELECT * FROM Leads WHERE Id IN('3276571000000184007', '3276571000000184001')



SELECT * FROM Leads WHERE FirstName = 'Different Tiger'



SELECT * FROM Leads WHERE FirstName = 'Different Tiger'



SELECT * FROM Leads WHERE FirstName = 'Different Tiger' AND LastName = 'Smith'



SELECT * FROM Leads WHERE FirstName LIKE 'Different %'
Insert
 
INSERT INTO Leads(FirstName, LastName, Title) VALUES('Alert', 'Bat', 'Mr')

 

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 False

The unique identifier for this record.

LeadOwner_Id String False

The Id of the lead owner.

LeadOwner_Name String True

The name of the lead owner.

Company String False

The company of the lead.

FirstName String False

The first name of the lead.

LastName String False

The last name of the lead.

Title String False

The designation of the lead.

Email String False

The email of the lead.

Phone String False

The phone number of the lead.

Fax String False

The fax number of the lead.

Mobile String False

The mobile number of the lead.

Website String False

The website of the lead.

LeadSource String False

The source of the lead.

LeadStatus String False

The status of the lead.

Industry String False

The induystr in which the lead is in.

No_ofEmployees Int False

The number of employees in the lead's company.

AnnualRevenue Double False

The annual revenue of the lead.

Rating String False

The rating of the lead.

Tag String False

A list of tag related to the lead.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

EmailOptOut Bool False

Whether the lead has opted out of emails or not.

SkypeID String False

The skype id of the lead.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

FullName String False

The full name of the lead.

Salutation String False

The salutation that the lead likes to be referred to.

SecondaryEmail String False

The secondary email of the lead.

Twitter String False

The twitter handle of the lead.

LastActivityTime Datetime False

The last time the lead had any activity.

Street String False

The street where the lead resides in.

City String False

The city where the lead resides in.

State String False

The state where the lead resides in.

ZipCode String False

The zip code of the place where the lead resides in.

Country String False

The country where the lead resides in.

Description String False

A description of the lead.

MostRecentVisit Datetime False

The last time the lead visited.

FirstVisit Datetime False

The first time the lead visited.

Referrer String False

The referrer of the lead.

FirstPageVisited String False

The first URL that the lead has visited.

NumberOfChats Int False

The number of chats had with the lead.

AverageTimeSpent_Minutes_ String False

The average time the lead has spent in minutes.

DaysVisited Int False

The number of days the lead has visitied.

VisitorScore Long False

The visitor score calculated for this lead.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Notes

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Notes



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 False

The unique identifier for this record.

NoteOwner_Id String False

The Id of the note owner.

NoteOwner_Name String True

The name of the note owner.

NoteTitle String False

The title of the note.

NoteContent String False

The text content of the note.

ParentID_Id String False

The Id of the parent of this note.

ParentID_Name String True

The name of the parent of this note.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

PriceBooks

Create, update, delete, and query information regarding price books.

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM PriceBooks



SELECT * FROM PriceBooks WHERE Id = '3152079000000153079'



SELECT * FROM PriceBooks WHERE PriceBookName = 'Differential'
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 False

The unique identifier for this record.

PriceBookOwner_Id String False

The Id of the owner of the price book.

PriceBookOwner_Name String True

The name of the owner of the price book.

PriceBookName String False

The name of the price book.

Active Bool False

Whether this price book is active or not.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

PricingModel String False

The pricing model of the price book. (Flat or Differential).

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

Tag String False

A list of tags related to this price book.

Description String False

The description of the price book.

PricingDetails String False

A json aggregate with pricing details.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Products

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Products



SELECT * FROM Products WHERE Id = '3152079000000153079'



SELECT * FROM Products WHERE ProductName = 'BB8'
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 False

The unique identifier for this record.

ProductOwner_Id String False

The Id of the product owner.

ProductOwner_Name String True

The name of the product owner.

ProductName String False

The name of the product.

ProductCode String False

The code of the product.

VendorName_Id String False

The Id of the vendor of the product..

VendorName_Name String True

The name of the vendor of the product.

ProductActive Bool False

Whether this product is active or not.

Manufacturer String False

The manufacturer of the product.

ProductCategory String False

The category of the product.

SalesStartDate Date False

The start date of the sale of the product.

SalesEndDate Date False

The end date of the sale of the product.

SupportStartDate Date False

The start date of the support of the product.

SupportEndDate Date False

The end date of the support of the product.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

Tag String False

A list of tags related to the product.

UnitPrice Double False

The unit price of the product.

CommissionRate Double False

The commission rate of the product.

Tax String False

A json aggregate of the tax related to this product.

Taxable Bool False

Whether this product is taxable or not.

UsageUnit String False

The unit of usage of the product.

QtyOrdered String False

The quantity ordered for this product.

QuantityinStock String False

The number of items in stock for this product.

ReorderLevel String False

The level of reorder for the product.

Handler_Id String False

The Id of the handler of the product.

Handler_Name String True

The name of the handler of the product.

QuantityinDemand String False

The quantity in demand of the product.

Description String False

A brief description of the product.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

PurchaseOrders

Create, update, delete, and query information regarding purchase orders.

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM PurchaseOrders



SELECT * FROM PurchaseOrders WHERE Id = '3152079000000153079'



SELECT * FROM PurchaseOrders WHERE Carrier = 'FedEx
Insert
 
INSERT INTO PurchaseOrders(TrackingNumber, ExciseDuty, Carrier) VALUES('123123123', 33.33, 'UPS')

 

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 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 False

The unique identifier for this record.

PurchaseOrderOwner_Id String False

The Id of the owner of the purchase order.

PurchaseOrderOwner_Name String True

The name of the owner of the purchase order.

PONumber String False

The number of the purchase order.

Subject String False

The subject of the purchase order.

VendorName_Id String False

The Id of the vendor of the purchase order.

VendorName_Name String True

The name of the vendor of the purchase order.

RequisitionNumber String False

The requisition number of the purchase order.

TrackingNumber String False

The tracking number of the purchase order.

ContactName_Id String False

The Id of the contanct regarding this purchase order.

ContactName_Name String True

The name of the contact regarding this purchase order.

PODate Date False

The date listed in this purchase order.

DueDate Date False

The due date of this purchase order.

Carrier String False

The carrier listed in this purchase order.

ExciseDuty Double False

The amount of excise duty on this purchase order.

SalesCommission Double False

The amount of commision for the sale listed on this purchase order.

Status String False

The status of the purchase order.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

Tag String False

A list of tags regarding this purchase order.

ModifiedTime Datetime False

The time when the record was modified.

BillingStreet String False

The billing street of the purchase order.

ShippingStreet String False

The shipping street of the purchase order.

BillingCity String False

The billing city of this purchase order.

ShippingCity String False

The shipping city of this purchase order.

BillingState String False

The billing state of this purchase order.

ShippingState String False

The shipping state of this purchase order.

BillingCode String False

The billing code of this purchase order.

ShippingCode String False

The shipping code of this purchase order.

BillingCountry String False

The billing country of this purchase order.

ShippingCountry String False

The shipping country of this purchase order.

ProductDetails String False

A json aggregate of the product details.

SubTotal Double True

The sub total price of the purchase order.

Discount Double False

The discount listed in this purchase order.

Tax Double True

The amount of tax listed in this purchase order.

Adjustment Double False

The amount of adjustment regarding this purchase order.

GrandTotal Double True

The grand total of this purchase order.

TermsandConditions String False

The terms and conditions regarding this purchase order.

Description String False

The description of this purchase order.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Quotes

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Quotes



SELECT * FROM Quotes WHERE Id = '3152079000000153079'



SELECT * FROM Quotes WHERE Subject = 'A simple quote'
Insert
 
INSERT INTO Quotes(Subject, Team, Adjustment) VALUES('A quote for product XYZ for company ABC.', 'A-Team', 12.5)

 

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 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 False

The unique identifier for this record.

QuoteOwner_Id String False

The Id of the owner of the quote.

QuoteOwner_Name String True

The name of the owner of the quote.

QuoteNumber String False

The number of the quote.

Subject String False

The subject of the quote.

DealName_Id String False

The Id of the deal related to this quote.

DealName_Name String True

The name of the deal related to this quote.

QuoteStage String False

The stage in which this quote is currently at.

ValidUntil Date False

The time until this quote is valid.

Team String False

The team who is related to this quote.

ContactName_Id String False

The Id of the contact of the quote.

ContactName_Name String True

The nate of the contact of the quote.

Carrier String False

The carrier of this quote.

AccountName_Id String False

The Id of the account related to this quote.

AccountName_Name String True

The name of the account related to this quote.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

Tag String False

A list of tags related to this quote.

BillingStreet String False

The billing street of the record.

ShippingStreet String False

The shipping street of the record.

BillingCity String False

The billing city of the record.

ShippingCity String False

The shipping city of the record.

BillingState String False

The billing state of the record.

ShippingState String False

The shipping state of the record.

BillingCode String False

The billing code of the record.

ShippingCode String False

The shipping code of the record.

BillingCountry String False

The billing country of the record.

ShippingCountry String False

The shipping country of the record.

ProductDetails String False

A json aggregate of the product details related to this quote.

SubTotal Double True

The sub total price of this quote.

Discount Double False

The disocunt applied to this quote.

Tax Double True

The amount of tax applied to this quote.

Adjustment Double False

The amount of adjusted price applied to this quote.

GrandTotal Double True

The gradn total of the quote.

TermsandConditions String False

The terms and conditions of this quote.

Description String False

The description of this quote.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

SalesOrders

Create, update, delete, and query information regarding sales orders.

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM SalesOrders



SELECT * FROM SalesOrders WHERE Id = '3152079000000153079'



SELECT * FROM SalesOrders WHERE Status = 'Created'
Insert
 
INSERT INTO SalesOrders(Subject, Status) VALUES('A brand new sales order', 'Created')

 

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 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 False

The unique identifier for this record.

Subject String False

The subject of the sales order.

SalesOrderOwner_Id String False

The Id of the owner of the sales order.

SalesOrderOwner_Name String True

The name of the owner of the sales order.

SONumber String False

The sales order number.

DealName_Id String False

The Id of the deal regarding this sales order.

DealName_Name String True

The name of the deal regarding this sales order.

CustomerNo_ String False

The number of the customer regarding this sales order.

EndDate String False

The end date of the sales order.

PurchaseOrder String False

The purchase order linked to this sales order.

DueDate Date False

The due date of this sales order.

QuoteName_Id String False

The Id of the quote related to this sales order.

QuoteName_Name String True

The name of the quote related to this sales order.

ContactName_Id String False

The Id of the contact of this sales order.

ContactName_Name String True

The name of the contact of this sales order.

Pending String False

The pending status of this sales order.

ExciseDuty Double False

The amount of excise duty of this sales order.

Carrier String False

The carrier of this sales order.

Status String False

The status of this sales order.

SalesCommission Double False

The commission of sales for this sales order.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

Tag String False

A list of tags related to this record.

Layout_Id String False

The Id of the layout used in this sales order.

Layout_Name String True

The name of the layout used in this sales order.

CreatedTime Datetime False

The time when the record was created.

AccountName_Id String False

The Id of the account of this sales order.

AccountName_Name String True

The name of the account of this sales order.

ModifiedTime Datetime False

The time when the record was modified.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

BillingStreet String False

The billing street of the record.

ShippingStreet String False

The shipping street of the record.

BillingCity String False

The billing city of the record.

ShippingCity String False

The shipping city of the record.

BillingState String False

The billing state of the record.

ShippingState String False

The shipping state of the record.

BillingCode String False

The billing code of the record.

ShippingCode String False

The shipping code of the record.

BillingCountry String False

The billing country of the record.

ShippingCountry String False

The shipping country of the record.

ProductDetails String False

A json aggregate of the product details related to this sales order.

SubTotal Double True

The sub total price of the sales order.

Discount Double False

The amount of discount applied to this sales order.

Tax Double True

The amount of tax applied to this sales order.

Adjustment Double False

The amount of adjustment applied to this sales order.

GrandTotal Double True

The grand total of the sales order.

TermsandConditions String False

The terms and conditions of the sales order.

Description String False

The description of the sales order.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Solutions

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Solutions



SELECT * FROM Solutions WHERE Id = '3152079000000153079'



SELECT * FROM Solutions WHERE AccountName = 'Benton'
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 False

The unique identifier for this record.

SolutionNumber String False

The number of the solution.

SolutionOwner_Id String False

The Id of the owner of the solution.

SolutionOwner_Name String True

The name of the owner of the solution.

SolutionTitle String False

The title of the solution.

Published Bool False

Whether the solution is published or not.

Status String False

The status of the solution.

ProductName_Id String False

The Id of the product concerning this solution.

ProductName_Name String True

The name of the product concerning this solution.

No_ofcomments Int True

The number of different comments in this solution.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

Tag String False

A list of tags related to this record.

Question String False

The question which was asked that led to the creating of this solution.

Answer String False

The answer given for this solution.

AddComment String False

An additional comment give for this solution.

Comments String True

A list of comments given in this solution.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Tasks

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Tasks



SELECT * FROM Tasks WHERE Id = '3152079000000153079'



SELECT * FROM Tasks WHERE Status = 'Completed'
Insert
 
INSERT INTO Tasks(Subject, Status) VALUES('Finish sending emails to potential leads.', 'Created')

 

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 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 False

The unique identifier for this record.

TaskOwner_Id String False

The Id of the owner of the task.

TaskOwner_Name String True

The name of the owner of the task.

Subject String False

The subject of the task.

DueDate Date False

The date when this task is due.

ContactName_Id String False

The Id of the contact of the task.

ContactName_Name String True

The name of the contact of the task.

RelatedTo_Id String False

The Id of the object related to the task.

RelatedTo_Name String True

The name of the object related to the task.

Status String False

The status of the task.

Priority String False

The priority of the task.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

Tag String False

A list of tags related to this record.

SendNotificationEmail Bool False

Whether a notification email should be sent for this task or not.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

Reminder String False

When should a reminder for this task be sent at.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

Repeat String False

If this task is recurring or not.

ClosedTime Datetime False

The time when this task closes.

Description String False

The description of the tax.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 

 

Vendors

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

 

Table-Specific Information
Select
The driver uses the Zoho CRM API to processes search criteria for string columns using operators equals (=) and starts with (LIKE '...%'). The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

 

For example, the following queries are processed server side:

SELECT * FROM Vendors



SELECT * FROM Vendors WHERE Id = '3152079000000153079'



SELECT * FROM Vendors WHERE Email = 'favorite_vendor@gmail.com'
Insert
 
INSERT INTO Vendors(VendorName, Email, Website) VALUES('XYZVendor', 'info@vendeverything.xyz', '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 False

The unique identifier for this record.

VendorOwner_Id String False

The Id of the owner of the vendor.

VendorOwner_Name String True

The name of the owner of the vendor.

VendorName String False

The name of the vendor.

Phone String False

The phone number of the vendor.

Email String False

The email address of the vendor.

Website String False

The website of the vendor.

GLAccount String False

The GL account of the vendor.

Category String False

The category in which this vendor is placed at.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

Tag String False

A list of tags related to this record.

Street String False

The street associated with this vendo's address.

City String False

The city associated with this vendo's address.

State String False

The state associated with this vendo's address.

ZipCode String False

The ZIP code associated with this vendo's address.

Country String False

The country associated with this vendo's address.

Description String False

A brief description regarding this vendor.

 

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

 

 




 

Views

  1. InvoiceProductDetails
  2. Organizations
  3. PriceBookPricingDetails
  4. Profiles
  5. PurchaseOrderProductDetails
  6. QuoteProductDetails
  7. Roles
  8. SalesOrderProductDetails
  9. StageHistories
  10. Users

InvoiceProductDetails

Query information regarding different product details.

 

View-Specific Information
Select

 

The driver uses the Zoho CRM API to processes search criteria that refer to the InvoiceId column. The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

For example, the following queries are processed server side:

SELECT * FROM InvoiceProductDetails



SELECT * FROM InvoiceProductDetails WHERE InvoiceId = '3152079000000301143'
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.

 

 

 

Organizations

Query information regarding different organizations.

 

View-Specific Information
Select

 

The driver processes filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

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.

 

 

 

PriceBookPricingDetails

Query information regarding different pricing details.

 

View-Specific Information
Select

 

The driver uses the Zoho CRM API to processes search criteria that refer to the PriceBookId column. The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

For example, the following queries are processed server side:

SELECT * FROM PriceBookPricingDetails



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 different profiles.

 

View-Specific Information
Select

 

The driver uses the Zoho CRM API to processes search criteria that refer to the Id column. The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

For example, the following queries are processed server side:

SELECT * FROM Profiles



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.
CreatedTime 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.
ModifiedTime Datetime The time this profile was last modified.
Category Boolean Whether this profile is a category or not.

 

 

 

PurchaseOrderProductDetails

Query information regarding different product details.

 

View-Specific Information
Select

 

The driver uses the Zoho CRM API to processes search criteria that refer to the PurchaseOrderId column. The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

For example, the following queries are processed server side:

SELECT * FROM PurchaseOrderProductDetails



SELECT * FROM PurchaseOrderProductDetails WHERE PurchaseOrderId = '3152079000000317029'
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 different product details.

 

View-Specific Information
Select

 

The driver uses the Zoho CRM API to processes search criteria that refer to the QuoteId column. The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

For example, the following queries are processed server side:

SELECT * FROM QuoteProductDetails



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.

 

 

 

Roles

Query information regarding different roles.

 

View-Specific Information
Select

 

The driver uses the Zoho CRM API to processes search criteria that refer to the Id column. The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

For example, the following queries are processed server side:

SELECT * FROM Roles



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.

 

 

 

SalesOrderProductDetails

Query information regarding different product details.

 

View-Specific Information
Select

 

The driver uses the Zoho CRM API to processes search criteria that refer to the SalesOrderId column. The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

For example, the following queries are processed server side:

SELECT * FROM SalesOrderProductDetails



SELECT * FROM SalesOrderProductDetails WHERE SalesOrderId = '3152079000000355025'
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 different 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 Double The amount of money spent for this stage.
ExpectedRevenue Double The expected revenue from this stage.
Probability Double The probability for the stage to happen.
CloseDate Date The date when this stage closes.
LastModifiedTime Datetime The time this stage was last modified.

 

 

 

Users

Query information regarding different users.

 

View-Specific Information
Select

 

The driver uses the Zoho CRM API to processes search criteria that refer to the Id column. The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will not be filtered.

For example, the following queries are processed server side:

SELECT * FROM Users



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.
CreatedTime 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.
ModifiedTime Datetime The time this user was last modified.

 

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.