Matillion ETL Data Model for Zoho CRM
|
string
"2.1"
The Zoho CRM API version to use. Generally this property does not need to be set.
string
"OFF"
The following options are available:
string
""
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.
string
""
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.
string
""
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 user name and password. The access token protects your credentials by keeping them on the server.
string
""
The full Account Server URL. You only need to supply this when executing the RefreshOAuthAccessToken stored procedure with InitiateOAuth=Off. Most of the time, the value of this property will be https://accounts.zoho.com/, but if your account resides in a different location, then the domain should change accordingly (.eu, .in, .com.au, ...).
string
""
The full URL of the API domain. You only need to supply this when using your own OAuth access token with InitiateOAuth=Off. Otherwise, the API domain will be retrieved from the OAuth flow. Most of the time, the value of this property will be https://www.zohoapis.com, but if your account resides in a different location, then the domain should change accordingly (.eu, .in, .com.au, ...).
string
"%APPDATA%\\CData\\ZohoCRM Data Provider\\OAuthSettings.txt"
When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes.
Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.
If left unspecified, the default location is "%APPDATA%\\CData\\ZohoCRM Data Provider\\OAuthSettings.txt" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
string
""
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.
string
""
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.
See Establishing a Connection to obtain the OAuthVerifier value.
Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the driver exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
string
""
The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.
string
""
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
string
""
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
string
""
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
string
"NONE"
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.
string
""
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.
int
0
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.
string
""
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
string
""
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
bool
false
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
NOTE: When this property is set to True, the proxy used is determined as follows:
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
string
""
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.
int
80
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.
string
"BASIC"
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:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
string
""
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
string
""
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.
string
"AUTO"
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. |
string
""
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the driver uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
string
""
Once this property is set, the driver will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.
Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.
If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.
For more control over what is written to the log file, you can adjust the Verbosity property.
Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.
To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.
If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.
Java logging is also supported. To enable Java logging, set Logfile to:
Logfile=JAVALOG://myloggername
As in the above sample, JAVALOG:// is a required prefix to use Java logging, and you will substitute your own Logger.
The supplied Logger's getLogger method is then called, using the supplied value to create the Logger instance. If a logging instance already exists, it will reference the existing instance.
When Java logging is enabled, the Verbosity will now correspond to specific logging levels.
string
"1"
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 detailed in the Logging page.
string
""
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
string
"100MB"
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 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
Adjust the maximum number of logfiles generated with MaxLogFileCount.
int
-1
When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.
Adjust the maximum size of the logfiles generated with MaxLogFileSize.
string
"%APPDATA%\\CData\\ZohoCRM Data Provider\\Schema"
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 folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\ZohoCRM Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
string
""
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. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
string
""
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. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
bool
false
When AutoCache = true, 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.
When AutoCache = true, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:
string
""
You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.
The cache database is determined by the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.
Note: you must add the CacheDriver JAR file to the classpath.
The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, 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;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;
The following is a JDBC URL for the SQLite JDBC driver:
jdbc:zohocrm:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;
The following 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;
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;
The following is a JDBC URL for the Oracle Thin Client:
jdbc:zohocrm:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;
NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .
The following JDBC URL uses the official PostgreSQL JDBC driver:
jdbc:zohocrm:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';InitiateOAuth=GETANDREFRESH;
string
""
The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties 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.
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 CacheDriver and CacheConnection. The following 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
To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL:
jdbc:sqlite:dataSource
The installation includes the CData JDBC Driver for MySQL. The following is an example JDBC URL:
jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
The following are typical connection properties:
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
The following are typical SQL Server connection properties:
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.
The following 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
The following 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).
The following 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
The following are typical connection properties:
string
"%APPDATA%\\CData\\ZohoCRM Data Provider"
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 file to the classpath. The JAR file, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.
If left unspecified, the default location is "%APPDATA%\\CData\\ZohoCRM Data Provider" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
int
600
The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.
bool
false
When Offline = 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.
bool
false
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.
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.
string
"-1"
Sets the length of a aggregate field for a provider. If not set the length reported by the server will be considered.
int
0
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.
int
0
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.
bool
false
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).
bool
false
If set to true, the driver will display custom views among other views. Retrieving custom views is not only a costly operation but it also decreases performance, that's why this property defaults to 'false'.
bool
false
If set to true, the driver will display related List views views among other views. Retrieving related Lists is not only a costly operation but it also decreases performance, that's why this property defaults to 'false'.
int
-1
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
string
""
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.
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. |
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
string
"200"
Note that the PageSize must be between 1 and 200.
int
60
The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.
int
100
The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.
int
1
The minimum number of connections in the pool. The default is 1.
int
60
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.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
bool
false
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.
string
""
The RTK property may be used to license a build. See the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.
int
60
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the driver throws an exception.
bool
false
This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.
bool
true
Query API has limitation to select maximum of 50 columns. Please set the value to false in case more than 50 columns need to be selected.
bool
true
If set to true, the driver will use api names for some operations. This property is used for custom modules: The API name for custom modules is different from a custom module name in the Zoho CRM UI. For example, if you create a Potentials custom module in Zoho CRM, the driver will make the underlying requests to the API name; for example, CustomModule_1.
Set this property to true to use the api name in SQL queries.
string
""
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The driver automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the driver.
This User Defined View configuration file is formatted as follows:
For example:
{ "MyView": { "query": "SELECT * FROM Accounts WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"
bool
false
If the Zoho account you plan on using this driver on supports Sandboxes and you want to use one, set this property to true. Otherwise, just leave empty to proceed using your regular CRM instance.
bool
true
If set to true, the driver will send the filters server-side. In ZohoCRM, if the data is updated recently, it might take some time for the filters to work server-side so only in this case it is recommended for this property to be set to false in order to get proper results. In all the other cases this will be a considerably expensive operation to do client-side and it might take longer to retrieve the data.
bool
false
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 the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.
Create, update, delete, and query information regarding accounts.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side. The rest of the filter is executed client-side within the driver.
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_FirstName | String | False |
The First Name of the account owner for the account. |
AccountOwner_LastName | String | False |
The Last 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. |
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. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The Id of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Id 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 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. |
Delete, and query information regarding activities.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.
For example, the following queries are processed server side:
SELECT * FROM Activities WHERE Id = '3152079000000154214' SELECT * FROM Activities WHERE Subject = 'event'
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. |
CreatedAt | Datetime | False |
The time when the record was created. |
ModifiedAt | 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 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. |
Delete, and query information regarding attachments.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.
For example, the following queries are processed server side:
SELECT * FROM Attachments WHERE Id = '3152079000000153079' SELECT * FROM Attachments WHERE FileName = 'Koala.jpg'
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. |
CreatedAt | Datetime | False |
The time when the record was created. |
ModifiedAt | 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. |
ModuleName | String | False |
The name of the module this attachment belongs to. |
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. |
Create, update, delete, and query information regarding calls.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the contact of the call. |
ContactName_LastName | String | False |
The Last Name of the contact 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. |
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. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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. |
ModuleName | String | False |
The name of the module this call belongs to. |
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. |
Create, update, delete, and query information regarding campaigns.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the campaign owner. |
CampaignOwner_LastName | String | False |
The Last 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. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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 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. |
Create, update, delete, and query information regarding cases.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the owner of the case. |
CaseOwner_LastName | String | False |
The Last 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. |
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. |
No_ofcomments | Int | True |
The number of comments in this case. |
AccountName_Id | String | False |
The Id 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. |
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. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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. |
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. |
Create, update, delete, and query information regarding contacts.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the owner of the contact. |
ContactOwner_LastName | String | False |
The Last 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. |
VendorName_Id | String | False |
The Id of the vendor concerning this account. |
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. |
SkypeID | String | False |
The Skype ID of the contact. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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. |
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 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. |
Get, add or update currencies to your organization.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.
For example, the following queries are processed server side:
SELECT * FROM Currencies WHERE Id = '1234';
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
Represents the unique ID of the currency. |
Name | String | False |
Represents the name of the currency. |
Symbol | String | False |
Represents the symbol of the currency. |
IsActive | Boolean | False |
Represents the status of the currency. |
ExchangeRate | Double | False |
Represents the exchange rate of the currency. |
FormatDecimalSeparator | String | False |
The decimal separator separates the integer part of the currency from its fractional part. |
FormatThousandSeparator | String | False |
The thousand separator separates groups of thousands in a currency. |
FormatDecimalPlaces | String | False |
Represents the number of decimal places allowed for the currency. |
ModifiedByName | String | True |
Represents the name of the user who last modified the currency details. |
ModifiedByid | String | True |
Represents the ID of the user who last modified the currency details. |
PrefixSymbol | Boolean | False |
Represents if the currency has a prefix symbol. |
IsBase | Boolean | True |
Represents if the currency is the base currency. |
CreatedAt | Datetime | True |
Represents the date and time at which the currency was created. |
ModifiedAt | Datetime | True |
Represents the date and time at which the currency was last modified. |
ISO_Code | String | False |
Represents the ISO code of the currency. |
Create, update, delete, and query information regarding deals.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the deal owner. |
DealOwner_LastName | String | False |
The Last 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. |
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. |
ContactName_Id | String | False |
The Id of the contact regarding this deal. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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 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. |
Create, update, delete, and query information regarding events.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the host of the event. |
Host_LastName | String | False |
The Last Name of the host of the event. |
ContactName_Id | String | False |
The Id of the contact of the event. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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. |
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_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. |
ModuleName | String | False |
The name of the module this event belongs to. |
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. |
Create, update, delete, and query information regarding invoices. Not available in free and standard ZohoCRM accounts.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the owner of this invoice. |
InvoiceOwner_LastName | String | False |
The Last 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. |
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. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ContactName_Id | String | False |
The Id of the contact linked with this invoice. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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 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. |
InvoicedItems | String |
Invoiced Items SubForm. This column can only be used for Insert and Update. |
Create, update, delete, and query information regarding Leads.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the lead owner. |
LeadOwner_LastName | String | False |
The Last 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. |
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. |
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_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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. |
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 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. |
Trigger | String |
To trigger the rule while inserting record into CRM account. |
Create, update, delete, and query information regarding notes.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.
For example, the following queries are processed server side:
SELECT * FROM Notes WHERE Id = '3152079000000153079' SELECT * FROM Notes WHERE NoteTitle = 'Deal details'
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_FirstName | String | False |
The First Name of the note owner. |
NoteOwner_LastName | String | False |
The Last 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. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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. |
ModuleName | String | False |
The name of the module this note belongs to. |
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. |
To fetch the details of all or a specific pipeline in the Deals module. It works only with ApiVersion=2.1.
The driver will use the Zoho CRM API to process WHERE clause conditions built with the following column and operator.
For example, the following queries are processed server side:
SELECT * FROM Pipeline WHERE Id = '228122000000223002' AND LayoutId = '228122000000000173' SELECT * FROM Pipeline WHERE LayoutId = '228122000000000173'
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
A unique numeric identifier for the profile. |
DisplayValue | String | False |
The name of the pipeline. |
Default | Boolean | False |
The default value of the pipeline. |
ActualValue | String | False |
The actual name of the pipeline. |
Maps | String | False |
The different stages that a deal has to pass through in the sales pipeline. |
LayoutId [KEY] | String | False |
The unique ID of the layout in the Deals module you want to fetch the pipeline's details from. |
Create, update, delete, and query information regarding price books. Not available in free and standard ZohoCRM accounts.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the owner of the price book. |
PriceBookOwner_LastName | String | False |
The Last 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. |
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_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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 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. |
Create, update, delete, and query information regarding products.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the product owner. |
ProductOwner_LastName | String | False |
The Last 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.. |
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. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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. |
QuantityinDemand | String | False |
The quantity in demand of the product. |
Description | String | False |
A brief description of the product. |
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. |
Create, update, delete, and query information regarding purchase orders. Not available in free and standard ZohoCRM accounts.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the owner of the purchase order. |
PurchaseOrderOwner_LastName | String | False |
The Last 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. |
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. |
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. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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 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. |
PurchaseItems | String |
Purchase Items SubForm. This column can only be used for Insert and Update. |
Create, update, delete, and query information regarding quotes. Not available in free and standard ZohoCRM accounts.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the owner of the quote. |
QuoteOwner_LastName | String | False |
The Last 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. |
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. |
Carrier | String | False |
The carrier of this quote. |
AccountName_Id | String | False |
The Id of the account related to this quote. |
CreatedBy_Id | String | False |
The Id of the User who created the record. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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 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. |
QuotedItems | String |
Quoted Items SubForm. This column can only be used for Insert and Update. |
Create, update, delete, and query information regarding sales orders. Not available in free and standard ZohoCRM accounts.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | True |
The First Name of the owner of the sales order. |
SalesOrderOwner_LastName | String | True |
The Last 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. |
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. |
ContactName_Id | String | False |
The Id 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. |
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. |
CreatedTime | Datetime | False |
The time when the record was created. |
AccountName_Id | String | False |
The Id 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_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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 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. |
OrderedItems | String |
Ordered Items SubForm. This column can only be used for Insert and Update. |
Create, update, delete, and query information regarding solutions.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver.
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_FirstName | String | False |
The First Name of the owner of the solution. |
SolutionOwner_LastName | String | False |
The Last 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. |
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. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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. |
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. |
Create, update, delete, and query information regarding tasks.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the owner of the task. |
TaskOwner_LastName | String | False |
The Last 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. |
RelatedTo_Id | String | False |
The Id 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. |
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_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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. |
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. |
ModuleName | String | False |
The name of the module this task belongs to. |
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. |
Create, update, delete, and query information regarding vendors.
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
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_FirstName | String | False |
The First Name of the owner of the vendor. |
VendorOwner_LastName | String | False |
The Last Name of the owner of the vendor. |
VendorName | String | False |
The name of the vendor. |
Phone | String | False |
The phone number of the vendor. |
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. |
ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
ModifiedBy_LastName | String | False |
The Last 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 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. |
Query information regarding performed actions.
Name | Type | Description |
Id [KEY] | String | The Id of the performed action. |
ActionType | String | The type of the performed action. |
Actions | String | The actions performed. |
TimeSpent | String | The time spent performing the action. |
ActionPerformedTime | Datetime | The date and time when the action was performed. |
ParentID_Id | String | The Id of the parent object where the action was performed. |
ParentID_Name | String | The name of the parent object where the action was performed. |
ChatAttachment_Id | String | The Id of the chat attachment for the action. |
ChatAttachment_Name | String | The name of the chat attachment for the action. |
Pseudo 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 | Bool | Set to true to return only converted records. |
Approved | Bool | Set to true to return only approved records. |
CustomViewId | String | The custom view Id to be used for filtering this record. |
Query information regarding different histories for a particular custom field.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.
All columns used in the criteria are required. Use FieldName to specify the actual name of the tracked custom field and HistoryName to specify the name of the history tracking section. If you want to retrieve data for a specific entity of a module specify EntityId in the criteria.
For example, the following query is processed server side:
SELECT * FROM [CustomFieldHistoryTracking] WHERE ModuleName = 'Leads' AND FieldName = 'pickListField' AND HistoryName = 'Pick List 1' SELECT * FROM [CustomFieldHistoryTracking] WHERE ModuleName = 'Leads' AND FieldName = 'pickListField' AND HistoryName = 'Pick List 1' AND EntityId = '12345665'
Name | Type | Description |
Id [KEY] | String | A unique numeric identifier for the history. |
ModuleName | String | A unique numeric identifier for the module instance this custom field tracking belongs to. |
EntityId | String | A unique numeric identifier for the module instance this custom field tracking belongs to. |
FieldName | String | The name of the custom field. |
HistoryName | String | The name of the custom field tracking history. |
FieldValue | String | The value of the custom field. |
DurationDays | Integer | The duration of this stage. |
ModifiedAt | Datetime | The time this historical value was last modified. |
ModifiedById | String | The id of the user who modified the value. |
ModifiedByName | String | The name of the user who modified the value. |
CurrencySymbol | String | The currency symbol for the value. |
ProcessFlow | Boolean | The boolean indicating the process flow for this historical value. |
Editable | Boolean | The boolean indicating if this historical value can be edited. |
Approved | Boolean | The boolean indicating if this historical value has been approved. |
To get the field metadata for the specified module.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.
For example, the following queries are processed server side:
SELECT * FROM Fields WHERE ModuleName = 'Deals'
Name | Type | Description |
DisplayValue | String | The name of the field. |
ActualValue | String | The actual name of the field. |
Id | String | The unique identifier of the field |
ModuleName | String | The name of the module which the user wants the fields. |
Query information regarding different product details. Not available in free and standard ZohoCRM accounts.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.
For example, the following queries are processed server side:
SELECT * FROM InvoiceProductDetails WHERE InvoiceId = '3152079000000301143'
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. |
To get the layouts metadata for the specified module.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.
For example, the following queries are processed server-side:
SELECT * FROM Layouts WHERE ModuleName = 'Deals'
Name | Type | Description |
Id | String | The unique identifier of the layout. |
Name | String | Represents the name of the layout. |
Type | String | Represents if the section is used or not in the layout. |
ModuleName | String | The name of the module which the user wants the layout. |
To get the field metadata for the specified module.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.
For example, the following queries are processed server-side:
SELECT * FROM ListFields WHERE ModuleName = 'Deals'
Name | Type | Description |
ApiName | String | The Api Name. |
AssociationDetails | String | The Association Details. |
BlueprintSupported | Boolean | Is Blueprint Supported. |
BusinesscardSupported | Boolean | Is Businesscard Supported. |
ConvertMappingAccounts | String | The Convert Mapping Accounts. |
ConvertMappingContacts | String | The Convert Mapping Contacts. |
ConvertMappingDeals | String | The Convert Mapping Deals. |
CreatedSource | String | The Created Source. |
Crypt | String | The Crypt. |
CurrencyPrecision | Integer | The Currency Precision. |
CurrencyRoundingOption | String | The Currency Rounding Option. |
CustomField | Boolean | Is Custom Field. |
DataType | String | The Data Type. |
DecimalPlace | Integer | The Decimal Place. |
DisplayField | Boolean | Is Display Field. |
DisplayLabel | String | The Display Label. |
DisplayType | Integer | The Display Type. |
External | String | The External. |
FieldLabel | String | The Field Label. |
FieldReadOnly | Boolean | Is Field ReadOnly. |
Filterable | Boolean | Is Filterable. |
HistoryTracking | String | The History Tracking. |
Id | String | The Id. |
JsonType | String | The Json Type. |
Length | Integer | The Length. |
MassUpdate | Boolean | Is Mass Update. |
PickListValues | String | The Pick List Values. |
PickListValuesSortedLexically | Boolean | Is Pick List Values Sorted Lexically. |
Profiles | String | The Profiles. |
QuickSequenceNumber | String | The QuickSequenceNumber. |
ReadOnly | Boolean | Is ReadOnly. |
Sortable | Boolean | Is Sortable. |
Subform | String | The Subform. |
SystemMandatory | Boolean | Is System Mandatory. |
Tooltip | String | The Tool tip. |
Type | String | The Type. |
UiType | Integer | The Ui Type. |
ViewTypeCreate | Boolean | Is View Type Create. |
ViewTypeEdit | Boolean | Is View Type Edit. |
ViewTypeQuickCreate | Boolean | Is View Type Quick Create. |
ViewTypeView | Boolean | Is View Type View. |
Visible | Boolean | Is Visible. |
Webhook | Boolean | Is Webhook. |
ModuleName | String | The name of the module which the user wants the fields. |
Retrieves all the files attached to a specified module.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.
For example, the following queries are processed server side:
SELECT * FROM ModuleAttachedFiles WHERE ModuleName = "Leads"
Note: The UploadFile and DownloadFile stored procedures will not work as expected if executed in regards to a custom field. They only upload or download files in the "Attachments" section of the module. Uploading and deleting files from a custom field of type "fileupload" can be done only through the UI.
Name | Type | Description |
FileId | String | Id of the file attached to the module. |
FileName | String | Name of the file attached to the module. |
AttachmentId [KEY] | String | Id of the attachment. |
CreatorId | String | Id of the user who uploaded the attachment. |
EntityId | String | Id of the entity. |
DownloadUrl | String | URL to download the attachment. |
PreviewUrl | String | URL to preview the attachmen. |
FileSize | String | The size of the attachment. |
FileExtension | String | Extension of the attachment. |
ModuleName | String | Id of the module. |
To get the modules metadata for the specified account.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator.
For example, the following queries are processed server-side:
SELECT * FROM Modules
Name | Type | Description |
Id | String | The unique identifier of the modules |
Name | String | The name of the module which the user wants. |
SequenceNumber | Integer | The sequence number of the field. |
ApiName | String | The api name of the field. |
Query information regarding different organizations.
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.
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. |
Query information regarding different pricing details. Not available in free and standard ZohoCRM accounts.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the driver.
For example, the following queries are processed server side:
SELECT * FROM PriceBookPricingDetails WHERE PriceBookId = '3152079000000317001'
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. |
Query information regarding different profiles.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.
For example, the following queries are processed server side:
SELECT * FROM Profiles WHERE Id = '3152079000000026011'
Name | Type | Description |
Id [KEY] | String | A unique numeric identifier for the profile. |
Name | String | The name of the profile. |
Description [KEY] | String | A small description regarding this profile. |
CreatedByName | String | The name of the user who created this profile. |
CreatedById | String | The id of the user who created this profile. |
CreatedAt | Datetime | The time this profile was created. |
ModifiedByName | String | The name of the user who modified this profile. |
ModifiedById | String | The id of the user who modified this profile. |
ModifiedAt | Datetime | The time this profile was last modified. |
Category | Boolean | Whether this profile is a category or not. |
Query information regarding different product details. Not available in free and standard ZohoCRM accounts.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.
For example, the following queries are processed server side:
SELECT * FROM PurchaseOrderProductDetails WHERE PurchaseOrderId = '3152079000000317029'
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. |
Query information regarding different product details. Not available in free and standard ZohoCRM accounts.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.
For example, the following queries are processed server side:
SELECT * FROM QuoteProductDetails WHERE QuoteId = '3152079000000317060'
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. |
To fetch the total number of records in the module.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The module is a mandatory filter for the driver.
Note: It works only with ApiVersion=2.1.
For example, the following queries are processed server-side:
SELECT * FROM RecordCount WHERE ModuleName = 'Leads' SELECT * FROM RecordCount WHERE ModuleName IN ('Leads','Invoices')
Name | Type | Description |
Count [KEY] | Integer | The total number of records in the module. |
ModuleName | String | The name of the module which the user wants the count. |
Query information regarding different roles.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.
For example, the following queries are processed server side:
SELECT * FROM Roles WHERE Id = '3152079000000026008'
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. |
Query information regarding different product details. Not available in free and standard ZohoCRM accounts.
The driver uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.
For example, the following queries are processed server side:
SELECT * FROM SalesOrderProductDetails WHERE SalesOrderId = '3152079000000355025'
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. |
Query information regarding different stage histories for a particular deal.
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. |
DurationDays | Integer | The duration of 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. |
ModifiedById | String | The id of the user who modified the stage. |
ModifiedByName | String | The name of the user who modified the stage. |
Get the list of territories enabled for your organization.
All the filters are executed at client side within the driver.
SELECT * from Territories;
Name | Type | Description |
Id [KEY] | String | Represents the unique ID of the territory. |
Name | String | Represents the name of the territory. |
ParentId | String | Represents the unique ID of the parent territory, if any. |
Criteria | String | Represents the territory criteria details. |
Managername | String | Represents the name of the current territory's manager. |
Managerid | String | Represents the ID of the current territory's manager. |
CreatedByName | String | Represents the name of the user who created the current territory. |
CreatedById | String | Represents the ID of the user who created the current territory. |
ModifiedByName | String | Represents the name of the user who last modified the current territory. |
ModifiedByid | String | Represents the ID of the user who last modified the current territory. |
CreatedAt | Datetime | Represents the date and time at which the current territory was created. |
ModifiedAt | Datetime | Represents the date and time at which the current territory was last modified. |
Desription | String | Represents the description of the territory, if any. |
Query information regarding different users.
The driver will use the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the driver.
For example, the following queries are processed server side:
SELECT * FROM Users WHERE Id = '3152079000000150015'
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. |
String | The email of the user. | |
RoleName | String | The name of the role the user has. |
RoleId | String | The Id of the role the user has. |
ProfileName | String | The name of the profile the user has. |
ProfileId | String | The Id of the profile the user has. |
Country | String | The country where the user is situated. |
City | String | The city where the user is situated. |
Street | String | The street where the user is situated. |
State | String | The state where the user is situated. |
Zip | String | The zip where the user is situated. |
Alias | String | The alias of the user. |
Signature | String | The signature of the user. |
NameFormat | String | The format of the name of the user. |
PersonalAccount | Boolean | Whether this user has a personal account or not. |
DefaultTabGroup | String | The default tab group for this user. |
CountryLocale | String | The default country locale of the user. |
Fax | String | The fax of the user. |
Website | String | The website of the user. |
Mobile | String | The mobile phone number of the user. |
Phone | String | The phone number of the user. |
Dob | String | The date of birth of the user. |
Status | String | The status of the user. |
Confirm | Boolean | Whether this user has confirmed his email or not. |
Language | String | The Language of the user. |
Locale | String | The locale of the user. |
TimeFormat | String | The default time format of the user. |
DateFormat | String | The default date format of the user. |
DecimalSeparator | String | The locale of the default decimal separator of the user. |
TimeZone | String | The time zone of the user. |
Zuid | String | The default ZUID of the user. |
Territories | String | A comma separeted string of the user's territories. |
CreatedByName | String | The name of the user who created this user. |
CreatedById | String | The id of the user who created this user. |
CreatedAt | Datetime | The time this user was created. |
ModifiedByName | String | The name of the user who modified this user. |
ModifiedById | String | The id of the user who modified this user. |
ModifiedAt | Datetime | The time this user was last modified. |
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. |
Query information regarding recent visits.
Name | Type | Description |
Id [KEY] | String | The Id of the visit. |
PageVisited | String | The name of the visited page. |
VisitedBy_Id | String | The Id of the visitor. |
VisitedBy_FirstName | String | The First Name of the visitor. |
VisitedBy_LastName | String | The Last Name of the visitor. |
IPAddress | String | The IP address of the visitor. |
TimeSpent(Minutes) | String | The time spent in minutes for the visit. |
Referrer | String | The referrer of the visitor. |
VisitedPageURL | String | The URL of the visited page. |
CreatedBy_Id | String | The Id of the object which created the visit. |
ModifiedBy_Id | String | The Id of the object which modified the visit. |
ModifiedBy_FirstName | String | The First Name of the object which modified the visit. |
ModifiedBy_LastName | String | The Last Name of the object which modified the visit. |
CreatedTime | Datetime | The date and time when the visit was created. |
ModifiedTime | Datetime | The date and time when the visit was modified. |
AttendedBy | String | Who attended the visit. |
UserDetails | String | The user details of the visit. |
Browser | String | The browser used for the visit. |
TimeVisited | Datetime | The date and time of the visit. |
VisitorType | String | The type of visitor for the visit. |
Revenue | Decimal | The revenue generated by the visit. |
NumberofPages | Int | The number of pages visited from the visit. |
PortalName | String | The name of the portal used for the visit. |
SearchKeyword | String | The search keyword used for the visit. |
SearchEngine | String | The search engine used for the visit. |
OperatingSystem | String | The operating system of the visitor. |
Gclid | String | The GCLID of the visitor. |
Keyword | String | The keyword used in the visit. |
ClickType | String | The click type of the visit. |
Devicetype | String | The type of the device of the visitor. |
AdNetwork | String | The ad network used in the visit. |
SearchPartnerNetwork | String | The search partner network for the visit. |
AdCampaignName | String | The ad campaign name of the visit. |
AdGroupName | String | The ad group name of the visit. |
Ad | String | The ad used for the visit. |
AdClickDate | Date | The date and time when the ad was clicked. |
VisitSource | String | The source of the visit. |
Pseudo 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 | Bool | Set to true to return only converted records. |
Approved | Bool | Set to true to return only approved records. |
CustomViewId | String | The custom view Id to be used for filtering this record. |