`

Matillion ETL Data Model for SugarCRM
Version - 18.0.6886

Note: Data models are true for the latest version of Matillion ETL. If you are on an older version or using a component from an old job, your experience may differ.




Connection String OptionsBack To Top

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



API Version

The version of the SugarCRM API used.
Data Type

string

Default Value

"v11"

Remarks

The SugarCRM API version used by default is v10;.





Auth Settings Location

The location of the settings file where the authentication token is saved.
Data Type

string

Default Value

""

Remarks

The location of the settings file where the authentication token is saved. This property is required if connecting from multiple applications on the same machine.





Auto Cache

Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . Configured with CacheQueryResult .
Data Type

bool

Default Value

false

Remarks

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

Explicitly Caching SELECT Results

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

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

SELECT * FROM [Accounts#CACHE]

Setting the Caching Database

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

See Also





Batch Size

The maximum size of each batch operation to submit.
Data Type

int

Default Value

0

Remarks

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

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





Cache Connection

The connection string for the cache database. Always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
Data Type

string

Default Value

""

Remarks

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

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

Derby and Java DB

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

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

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

SQLite

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

jdbc:sqlite:dataSource

MySQL

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

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

SQL Server

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

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
Below are typical SQL Server connection properties:
Oracle

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

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
Below are typical connection properties:
PostgreSQL

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

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
Below are typical connection properties:





Cache Driver

The database driver to be used to cache data.
Data Type

string

Default Value

""

Remarks

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

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

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

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

Derby and Java DB

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

jdbc:sugarcrm:CacheLocation='c:/Temp/cachedir';URL=http://mySugarCRM.com;User=myUser;Password=myPassword;
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:sugarcrm:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';URL=http://mySugarCRM.com;User=myUser;Password=myPassword;
SQLite

Below is a JDBC URL for the SQLite JDBC driver:

jdbc:sugarcrm:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';URL=http://mySugarCRM.com;User=myUser;Password=myPassword;
MySQL

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

  jdbc:sugarcrm:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';URL=http://mySugarCRM.com;User=myUser;Password=myPassword;
  
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for SugarCRM 2018 installation directory.
SQL Server

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

jdbc:sugarcrm:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';URL=http://mySugarCRM.com;User=myUser;Password=myPassword;
Oracle

Below is a JDBC URL for the Oracle Thin Client:

jdbc:sugarcrm:Cache Driver=oracle.jdbc.driver.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';URL=http://mySugarCRM.com;User=myUser;Password=myPassword;
PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:sugarcrm:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';URL=http://mySugarCRM.com;User=myUser;Password=myPassword;





Cache Location

Specifies the path to the cache when caching to a file.
Data Type

string

Default Value

""

Remarks

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

CacheLocation defaults to the directory specified by the Location setting.

See Also





Cache Metadata

Whether or not to cache the table metadata to a file store.
Data Type

bool

Default Value

false

Remarks

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

When to Use CacheMetadata

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

When Not to Use CacheMetadata





Cache Query Result

With AutoCache set, caches each row read from a SELECT query's results. Without this, the provider will attempt to fully replicate the table before executing the actual query against the replication database.
Data Type

bool

Default Value

false

Remarks

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





Cache Tolerance

The tolerance for stale data in the cache specified in seconds when using AutoCache .
Data Type

string

Default Value

"600"

Remarks

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





Connection Life Time

The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
Data Type

string

Default Value

"0"

Remarks

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





Connect On Open

Species whether to connect to the SugarCRM when the connection is opened.
Data Type

bool

Default Value

false

Remarks

When set to 'true', a connection will be made to SugarCRM 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 SugarCRM and nothing from this initial connection is maintained.

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





Firewall Password

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

string

Default Value

""

Remarks

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





Firewall Port

The TCP port for a proxy-based firewall.
Data Type

string

Default Value

""

Remarks

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





Firewall Server

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

string

Default Value

""

Remarks

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

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





Firewall Type

The protocol used by a proxy-based firewall.
Data Type

string

Default Value

"NONE"

Remarks

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

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

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





Firewall User

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

string

Default Value

""

Remarks

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





Location

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

string

Default Value

""

Remarks

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

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





Logfile

A path to the log file.
Data Type

string

Default Value

""

Remarks

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





Max Log File Size

A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Data Type

string

Default Value

"100MB"

Remarks

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





Max Rows

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

string

Default Value

"-1"

Remarks

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.





OAuth Client Id

The consumer key obtained from the OAuth token settings.
Data Type

string

Default Value

""

Remarks

The value passed in this parameter must exactly match the value shown in the console.





OAuth Client Secret

The consumer secret obtained during application registration.
Data Type

string

Default Value

""

Remarks

The value passed in this parameter must exactly match the value shown in the console.





Offline

Use offline mode to get the data from the cache instead of the live source.
Data Type

bool

Default Value

false

Remarks

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





Other

Hidden properties needed only in specific use cases.
Data Type

string

Default Value

""

Remarks

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

Specify multiple properties in a semicolon-separated list.

Caching Configuration

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

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTWhether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.





Password

The password of the Sugar CRM account.
Data Type

string

Default Value

""

Remarks

Together with User, this field is used to provide authentication for the user to Sugar CRM's servers.





Pool Idle Timeout

The allowed idle time for a connection before it is closed.
Data Type

string

Default Value

""

Remarks

The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.





Pool Max Size

The maximum connections in the pool.
Data Type

string

Default Value

"100"

Remarks

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





Pool Min Size

The minimum number of connections in the pool.
Data Type

string

Default Value

"1"

Remarks

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





Pool Wait Time

The max seconds to wait for an available connection.
Data Type

string

Default Value

""

Remarks

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





Proxy Auth Scheme

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

string

Default Value

"BASIC"

Remarks

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

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

The authentication type can be one of the following:

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





Proxy Auto Detect

This indicates whether to use the system proxy settings or not. Set ProxyAutoDetect to FALSE to use custom proxy settings. This takes precedence over other proxy settings.
Data Type

bool

Default Value

true

Remarks

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

To connect to an HTTP proxy, see ProxyServer.

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





Proxy Exceptions

A semicolon separated list of hosts or IPs that will be exempt from connecting through the ProxyServer .
Data Type

string

Default Value

""

Remarks

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

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





Proxy Password

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

string

Default Value

""

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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





Proxy Port

The TCP port the ProxyServer proxy is running on.
Data Type

string

Default Value

"80"

Remarks

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





Proxy Server

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

string

Default Value

""

Remarks

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

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

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





Proxy SSL Type

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

string

Default Value

"AUTO"

Remarks

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

AUTODefault 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.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is through a tunneling proxy: The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.





Proxy User

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

string

Default Value

""

Remarks

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

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

user@domain
domain\user





Pseudo Columns

Indicates whether or not to include pseudo columns as columns to the table.
Data Type

string

Default Value

""

Remarks

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





Readonly

You can use this property to enforce read-only access to SugarCRM from the provider.
Data Type

bool

Default Value

false

Remarks

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





RTK

The runtime key used for licensing.
Data Type

string

Default Value

""

Remarks

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





SSL Server Cert

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

string

Default Value

""

Remarks

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

This property can take the forms:

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

If not specified, any certificate trusted by the machine will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).





Support Enhanced SQL

Enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Data Type

bool

Default Value

true

Remarks

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

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

Execution of Predicates

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

Execution of Joins

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

Execution of Aggregates

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





Tables

Restrict the tables reported to a subset of the available tables. For example: Tables=TableA,TableB,TableC.
Data Type

string

Default Value

""

Remarks

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

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

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





Timeout

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

string

Default Value

"60"

Remarks

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

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





URL

The URL of the SugarCRM account.
Data Type

string

Default Value

""

Remarks

The URL of the SugarCRM account in the form 'http://{sugar crm instance}.com'.





Use Connection Pooling

Enables connection pooling.
Data Type

bool

Default Value

false

Remarks

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





User

The user of the Sugar CRM account.
Data Type

string

Default Value

""

Remarks

Together with Password, this field is used to provide authentication for the user to Sugar CRM's servers.





Verbosity

The verbosity level that determines the amount of detail included in the log file.
Data Type

string

Default Value

"1"

Remarks

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

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

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





Views

Restrict the views reported to a subset of the available tables. For example: Views=ViewsA,ViewsB,ViewsC.
Data Type

string

Default Value

""

Remarks

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

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

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





TablesBack To Top

  1. Accounts
  2. ACLRoles
  3. Activities
  4. Administration
  5. Audit
  6. Bugs
  7. Calls
  8. CampaignLog
  9. Campaigns
  10. CampaignTrackers
  11. Cases
  12. Comments
  13. Contacts
  14. Contracts
  15. ContractTypes
  16. Currencies
  17. CustomQueries
  18. DataSets
  19. DocumentRevisions
  20. Documents
  21. EAPM
  22. EmailAddresses
  23. EmailMarketing
  24. Emails
  25. EmailTemplates
  26. Employees
  27. Filters
  28. ForecastManagerWorksheets
  29. Forecasts
  30. ForecastSchedule
  31. ForecastWorksheets
  32. InboundEmail
  33. KBDocuments
  34. Leads
  35. Manufacturers
  36. Meetings
  37. Notes
  38. Notifications
  39. OAuthKeys
  40. OAuthTokens
  41. Opportunities
  42. PdfManager
  43. ProductCategories
  44. Products
  45. ProductTemplates
  46. ProductTypes
  47. Project
  48. ProjectTask
  49. ProspectLists
  50. Prospects
  51. Quotas
  52. Quotes
  53. Releases
  54. ReportMaker
  55. Reports
  56. Reports_1
  57. RevenueLineItems
  58. Roles
  59. SavedSearch
  60. Schedulers
  61. Shippers
  62. Styleguide
  63. Subscriptions
  64. SugarFavorites
  65. Tasks
  66. TaxRates
  67. TeamNotices
  68. Teams
  69. TimePeriods
  70. TrackerPerfs
  71. TrackerQueries
  72. Trackers
  73. TrackerSessions
  74. Users
  75. UserSignatures
  76. WebLogicHooks
  77. WorkFlow



Accounts

Create, update, delete, and query the Accounts module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is the favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the company.

Name String False

The name of the company.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

The full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The user name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Email String False

The email address for the company.

Email1 String False

The alternate email address for the company.

Email2 String False

The second alternate email addres for the company.

Invalid_Email Bool False

Whether the email address of the company has been marked as invalid.

Email_Opt_Out Bool False

Whether the company has opted out of emails.

Email_Addresses_Non_Primary String False

The nonprimary email addresses of the company.

Facebook String False

The Facebook name of the company.

Twitter String False

The Twitter name of the company.

Googleplus String False

The Google Plus name of the company.

Account_Type String False

The type of the company.

Industry String False

The industry that the company belongs in.

Annual_Revenue String False

Annual revenue for this company.

Phone_Fax String False

The fax phone number of this company.

Billing_Address_Street String False

The street address used for the billing address.

Billing_Address_Street_2 String False

The second line of the billing address.

Billing_Address_Street_3 String False

The third line of the billing address.

Billing_Address_Street_4 String False

The fourth line of the billing address.

Billing_Address_City String False

The city used for the billing address.

Billing_Address_State String False

The state used for the billing address.

Billing_Address_Postalcode String False

The postal code used for the billing address.

Billing_Address_Country String False

The country used for the billing address.

Rating String False

An arbitrary rating for this company for use in comparisons with others.

Phone_Office String False

The office phone number.

Phone_Alternate String False

An alternate phone number.

Website String False

The URL of the website for the company.

Ownership String False

The ownership of the company.

Employees String False

Number of employees. Can be a number (100) or range (50-100)

Ticker_Symbol String False

The stock trading (ticker) symbol for the company.

Shipping_Address_Street String False

The street address used for for shipping purposes.

Shipping_Address_Street_2 String False

The second line of the shipping address.

Shipping_Address_Street_3 String False

The third line of the shipping address.

Shipping_Address_Street_4 String False

The fourth line of the shipping address.

Shipping_Address_City String False

The city used for the shipping address.

Shipping_Address_State String False

The state used for the shipping address.

Shipping_Address_Postalcode String False

The ZIP code used for the shipping address.

Shipping_Address_Country String False

The country used for the shipping address.

Parent_Id String False

The Id of the parent of this account.

Sic_Code String False

SIC code of the account.

Duns_Num String False

DUNS number of the account.

Parent_Name String False

The name of the parent of this account.

Campaign_Id String False

The campaign that generated the account.

Campaign_Name String False

The first campaign name for the account.





ACLRoles

Create, update, delete, and query the ACLRoles module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the ACL role.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Modified_User_Id String False

The user who last modified the record.

Created_By String False

The Id of the user who created the record.

Name String False

The role name.

Description String False

The role description.

Deleted Bool False

The record deletion indicator.





Activities

Create, update, delete, and query the Activities module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is the favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier for the record.

Name String False

The name for the record.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

The description for the record.

Deleted Bool False

Record deletion indicator.

Parent_Id String False

The Id of the parent for the record.

Parent_Type String False

The type of the parent for the record.

Activity_Type String False

The type of the activity.

Data String False

The data for the record.

Comment_Count Int False

The number of comments for the record.

Last_Comment String False

The last comment for the record.





Administration

Create, update, delete, and query the Administration module in SugarCRM.

Columns

Name Type ReadOnly Description
Category String False

Settings are grouped under this category; arbitraily defined based on requirements.

Name String False

The name given to the setting.

Value String False

The value given to the setting.

Platform String False

The platform to use to send back the setting via the API.





Audit

Create, update, delete, and query the Audit module in SugarCRM.

Columns

Name Type ReadOnly Description
Parent_Id String False

The Id of the parent of the record.

Date_Created Datetime False

The date the record was created.

Created_By String False

The Id of the user who created the record.

Created_By_Username String False

The user who created the record.

Field_Name String False

The field name of the record.

Data_Type String False

The data type of the record.

Before_Value_String String False

The before value of the record.

After_Value_String String False

The after value of the record.

Before String False

The before value of the record.

After String False

The after value of the record.





Bugs

Create, update, delete, and query the Bugs module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is the favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the record.

Name String False

The short description of the bug.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The favorites for the record.

Description String False

The full text of the note.

Deleted Bool False

Record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The user name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Bug_Number Int True

The visual unique identifier.

Type String False

The type of issue (e.g., issue or feature).

Status String False

The status of the issue.

Priority String False

An indication of the priority of the issue.

Resolution String False

An indication of how the issue was resolved.

System_Id Int False

The system Id.

Work_Log String False

Free-form text used to denote activities of interest.

Found_In_Release String False

The software or service release that manifested the bug.

Release_Name String False

The name of the software or service release.

Fixed_In_Release String False

The software or service release that corrected the bug.

Fixed_In_Release_Name String False

The name of the software or service release that corrected the bug.

Source String False

An indicator of how the bug was entered (e.g., via Web or email).

Product_Category String False

Where the bug was discovered (e.g., Accounts, Contacts, or Leads).

Portal_Viewable Bool False

Whether the bug is viewable in the portal.





Calls

Create, update, delete, and query the Calls module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the call.

Name String False

A brief description of the call.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

The full text of the note.

Deleted Bool False

Record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The user name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Duration_Hours Int False

The hours portion of the call duration.

Duration_Minutes Int False

The minutes portion of the call duration.

Date_Start String False

The date when the call starts.

Date_End String False

The date when the call ends.

Parent_Type String False

The type of the parent Sugar object related to the call.

Parent_Name String False

The name of the parent Sugar object related to the call.

Status String False

The status of the call (e.g., Held or Not Held).

Direction String False

Indicates whether call is inbound or outbound.

Parent_Id String False

The Id of the parent Sugar object identified by .

Reminder_Checked Bool False

The checkbox indicating whether or not the reminder value is set.

Reminder_Time String False

When a reminder alert should be issued. -1 means no alert; otherwise, the number of seconds prior to the start.

Email_Reminder_Checked Bool False

The checkbox indicating whether or not the email reminder value is set.

Email_Reminder_Time String False

When a email reminder alert should be issued. -1 means no alert; otherwise, the number of seconds prior to the start.

Email_Reminder_Sent Bool False

Whether the email reminder is already sent.

Outlook_Id String False

When the Sugar Plug-in for Microsoft Outlook syncs an Outlook appointment, this is the Outlook appointment item Id.

Accept_Status String False

The accept status of the call.

Set_Accept_Links String False

The accept links set for the call.

Contact_Name String False

The contact name for the call.

Accept_Status_Users String False

The accept status of the user.

Contact_Id String False

The Id of the contact for the call.

Repeat_Type String False

The type of recurrence.

Repeat_Interval Int False

The interval of recurrence.

Repeat_Dow String False

The days of week in recurrence.

Repeat_Until Datetime False

Repeat until the specified date.

Repeat_Count Int False

Number of recurrences.

Repeat_Parent_Id String False

The Id of the first element of recurring records.

Recurring_Source String False

The source of the recurring call.

Send_Invites Bool False

The checkbox indicating whether or not to send out invites.





CampaignLog

Create, update, delete, and query the CampaignLog module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the record.

Campaign_Id String False

The identifier of the campaign associated with the campaign log.

Target_Tracker_Key String False

The identifier of the tracker URL.

Target_Id String False

The identifier of the target record.

Target_Type String False

The target record type (e.g., Contact or Lead).

Activity_Type String False

The activity that occurred (e.g., Viewed Message, Bounced, or Opted out).

Activity_Date Datetime False

The date the activity occurred.

Related_Id String False

The Id of the related record.

Related_Type String False

The type of the related record.

Archived Bool False

Indicates if the item has been archived.

Hits Int False

Number of times the item has been invoked (e.g., multiple click throughs).

List_Id String False

The target list from which the item originated.

Deleted Bool False

Record deletion indicator.

Recipient_Name String False

The name of the recipient.

Recipient_Email String False

The email of the recipient.

Marketing_Name String False

The marketing name.

Campaign_Name1 String False

The name of the campaign associated with the campaign log.

Campaign_Name String False

Another campaign associated with the campaign log.

Campaign_Objective String False

The campaign objective.

Campaign_Content String False

The campaign content.

Related_Name String False

The related name for the campaign.

Date_Modified Datetime False

The date the campaign log was last modified.

More_Information String False

More information about the campaign log.

Marketing_Id String False

The Id of the marketing email this entry is associated with.





Campaigns

Create, update, delete, and query the Campaigns module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the Campaign is the favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the campaign.

Name String False

The name of the campaign.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who last created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the campaign.

Description String False

The description for the campaign.

Deleted Bool False

Record deletion indicator.

Assigned_User_Id String False

The user Id assigned to the record.

Assigned_User_Name String False

The name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Tracker_Key Int True

The internal Id of the tracker used in a campaign. 2. (See CampaignTrackers.)

Tracker_Count Int False

The number of accesses made to the tracker URL; no longer used as of 4.2. (See CampaignTrackers.)

Refer_Url String False

The URL referenced in the tracker URL. No longer used as of 4.2. (See CampaignTrackers.)

Tracker_Text String False

The text that appears in the tracker URL. No longer used as of 4.2. (See CampaignTrackers.)

Start_Date Datetime False

Starting date of the campaign.

End_Date Datetime False

Ending date of the campaign.

Status String False

Status of the campaign.

Impressions Int False

Expected click throughs manually entered by the campaign manager.

Currency_Id String False

Currency in use for the campaign.

Base_Rate Decimal False

The base rate for the campaign.

Budget Double False

Budgeted amount for the campaign.

Expected_Cost Double False

Expected cost of the campaign.

Actual_Cost Double False

Actual cost of the campaign.

Expected_Revenue Double False

Expected revenue stemming from the campaign.

Campaign_Type String False

The type of the campaign.

Objective String False

The objective of the campaign.

Content String False

The campaign description.

Frequency String False

Frequency of the campaign.





CampaignTrackers

Create, update, delete, and query the CampaignTrackers module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier for the record.

Tracker_Name String False

The name of the campaign tracker.

Tracker_Url String False

The URL that represents the landing page when the tracker URL in the campaign email is clicked.

Tracker_Key Int True

The internal key to uniquely identify the tracker URL.

Campaign_Id String False

The Id of the campaign.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Modified_User_Id String False

The user who last modified the record.

Created_By String False

The Id of the user who created the record.

Is_Optout Bool False

Indicates whether the tracker URL represents an opt-out link.

Deleted Bool False

Record deletion indicator.





Cases

Create, update, delete, and query the Cases module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier for the record.

Name String False

The short description of the bug.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

The full text of the note.

Deleted Bool False

Record deletion indicator.

Assigned_User_Id String False

The user Id assigned to the record.

Assigned_User_Name String False

The name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Case_Number Int True

The user-visible unique identifier for the case.

Type String False

The type of issue (e.g., issue or feature).

Status String False

The status of the case.

Priority String False

The priority of the case.

Resolution String False

The resolution of the case.

System_Id Int False

The offline client device that created the bug.

Work_Log String False

Free-form text used to denote activities of interest.

Account_Name String False

The name of the associated account.

Account_Id String False

The Id of the associated account.

Source String False

An indicator of how the bug was entered (e.g., via Web or email).

Portal_Viewable Bool False

Whether the case is viewable in the portal.

Escalation_Level_C String False

The escalation level for the case.





Comments

Create, update, delete, and query the Comments module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the record.

Name String False

The name of the comment.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

The description for the record.

Deleted Bool False

Record deletion indicator.

Parent_Id String False

The Id of the parent for the record.

Data String False

The record data.





Contacts

Create, update, delete, and query the Contacts module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier for the record.

Name String False

The name of the contact.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

The full text of the note.

Deleted Bool False

Record deletion indicator.

Assigned_User_Id String False

The user Id assigned to the record.

Assigned_User_Name String False

The name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Email String False

The email for the contact.

Email1 String False

The alternate email for the contact.

Email2 String False

The alternate email for the contact.

Invalid_Email Bool False

Whether the contact email has been marked as invalid.

Email_Opt_Out Bool False

Whether the contact has opted out of emails.

Email_Addresses_Non_Primary String False

The nonprimary email addresses for the contact.

Salutation String False

The contact salutation (e.g., Mr. or Ms.).

First_Name String False

The first name of the contact.

Last_Name String False

The last name of the contact.

Full_Name String False

The full name of hte contact.

Title String False

The title of the contact.

Facebook String False

The Facebook name of the user.

Twitter String False

The Twitter name of the user.

Googleplus String False

The Google Plus Id of the user.

Department String False

The department of the contact.

Do_Not_Call Bool False

An indicator of whether the contact can be called.

Phone_Home String False

Home phone number of the contact.

Phone_Mobile String False

Mobile phone number of the contact.

Phone_Work String False

Work phone number of the contact.

Phone_Other String False

Other phone number for the contact.

Phone_Fax String False

The contact fax number.

Primary_Address_Street String False

The street address used for the primary address.

Primary_Address_Street_2 String False

The second line of the primary address.

Primary_Address_Street_3 String False

The third line of the primary addrss.

Primary_Address_City String False

The city for the primary address.

Primary_Address_State String False

The state for the primary address.

Primary_Address_Postalcode String False

The postal code for the primary address.

Primary_Address_Country String False

The country for primary address.

Alt_Address_Street String False

The street address for the alternate address.

Alt_Address_Street_2 String False

The second line of the alternate address.

Alt_Address_Street_3 String False

The third line of the alternate address.

Alt_Address_City String False

The city for the alternate address.

Alt_Address_State String False

The state for the alternate address.

Alt_Address_Postalcode String False

The postal code for the alternate address.

Alt_Address_Country String False

The country for the alternate address.

Assistant String False

The name of the assistant of the contact.

Assistant_Phone String False

The phone number of the assistant of the contact.

Picture String False

The avatar for the contact.

Email_And_Name1 String False

The email and name of the contact.

Lead_Source String False

The lead source for the contact.

Account_Name String False

The name of the account associated with the contact.

Account_Id String False

The Id of the account associated with the contact.

Dnb_Principal_Id String False

The unique Id For the D. and B. contact.

Opportunity_Role_Fields String False

The opportunity role fields.

Opportunity_Role_Id String False

The Id of the opportunity role.

Opportunity_Role String False

The opportunity role.

Reports_To_Id String False

The Id of the contact this contact reports to.

Report_To_Name String False

The name of the contact this contact reports to.

Birthdate Datetime False

The birthdate of the contact.

Portal_Name String False

The name as it appears in the portal.

Portal_Active Bool False

Whether this contact is a portal user.

Portal_Password String False

Whether the contact has a portal password.

Portal_Password1 String False

The portal password.

Portal_App String False

The reference to the portal.

Preferred_Language String False

The language for the portal.

Campaign_Id String False

The campaign that generated the lead.

Campaign_Name String False

The first campaign name for Contact.

C_Accept_Status_Fields String False

The call accept status fields.

M_Accept_Status_Fields String False

The meeting accept status fields.

Accept_Status_Id String False

The Id of the accept status.

Accept_Status_Name String False

The name of the accept status.

Accept_Status_Calls String False

The accept status for the call.

Accept_Status_Meetings String False

The accept status for the meeting.

Sync_Contact Bool False

Whether the lead is synced to Outlook.

Mkto_Sync Bool False

Whether the lead is synced to Marketo.

Mkto_Id Int False

The associated Marketo lead Id.

Mkto_Lead_Score Int False

The Marketo lead score.

Deptcat_C String False

The department category.





Contracts

Create, update, delete, and query the Contracts module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier for the record.

Name String False

The name of the contract.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

The description for the user.

Deleted Bool False

Record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Reference_Code String False

The reference code used by the organization to refer to this contract.

Opportunity_Name String False

The name of the associated opportunity.

Opportunity_Id String False

The Id of the associated opportunity.

Account_Name String False

The name of the associated account.

Account_Id String False

The Id of the associated account.

Start_Date Datetime False

The effective date of the contract.

End_Date Datetime False

The date in which the contract is no longer effective.

Currency_Id String False

The currency in use for the contract.

Base_Rate Decimal False

The base rate for the contract.

Currency_Name String False

The currency name.

Total_Contract_Value Double False

The overall value of the contract.

Total_Contract_Value_Usdollar Double True

The overall contract value expressed in USD.

Status String False

The contract status.

Customer_Signed_Date Datetime False

The date in which the ultimate customer signed the contract.

Company_Signed_Date Datetime False

The date in which the company using Sugar signed the contract.

Contract_Term Int False

The term of the contract.

Expiration_Notice String False

The date to issue an expiration notice (useful for workflow rules).

Time_To_Expiry Int False

The time to expiration of the contract.

Type_Name String False

The contract type.

Type String False

The drop-down options for contract types.

Parent_Name String False

The parent name of the contract.





ContractTypes

Create, update, delete, and query the ContractTypes module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique idenifier of the contract type.

Name String False

The contract type name.

List_Order Int False

The relative order in the drop-down list.

Date_Entered Datetime False

Date the record was created.

Date_Modified Datetime False

Date the record was last modified.

Modified_User_Id String False

The Id of the user who last modified the record.

Created_By String False

The Id of the user who created the record.

Deleted Bool False

Record deletion indicator.





Currencies

Create, update, delete, and query the Currencies module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifer of the currency.

Name String False

Name of the currency.

Symbol String False

Symbol representing the currency.

Iso4217 String False

3-letter identifier specified by ISO 4217 (e.g., USD).

Conversion_Rate Decimal False

Conversion rate factor (relative to stored value).

Status String False

Currency status.

Deleted Bool False

Record deletion indicator.

Date_Entered Datetime False

Date the record was created.

Date_Modified Datetime False

Date the record was last modified.

Created_By String False

Id of the user who created the record.





CustomQueries

Create, update, delete, and query the CustomQueries module in SugarCRM.

Columns

Name Type ReadOnly Description
Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

Unique identifer of the custom query.

Deleted Bool False

Record deletion indicator.

Date_Entered Datetime False

Date the record was created.

Date_Modified Datetime False

Date the record was last modified.

Modified_User_Id String False

The Id of the user who last modified the record.

Created_By String False

Id of the user who created record.

Name String False

Name of the custom query.

Description String False

Full description of the custom query.

Custom_Query String False

The SQL statement.

Query_Type String False

The type of query (unused).

List_Order Int False

The relative order in the drop-down list.

Query_Locked Bool False

Whether the query body (the SQL statement) can be changed.





DataSets

Create, update, delete, and query the DataSets module in SugarCRM.

Columns

Name Type ReadOnly Description
Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

The Id of the data set.

Deleted Bool False

Whether the data set is deleted.

Date_Entered Datetime False

The date the data set was entered.

Date_Modified Datetime False

The date the data set was last modified.

Modified_User_Id String False

The Id of the user who last modified the data set.

Created_By String False

The Id of the user who created the record.

Parent_Id String False

The Id of the parent of the data set.

Parent_Name String False

The name of the parent data set for the data set.

Report_Id String False

The Id of the associated report.

Report_Name String False

The custom queries for the data set.

Query_Id String False

The Id of the associated query.

Query_Name String False

The custom queries for the data set.

Child_Name String False

The child name for the data set.

Name String False

The name for the data set.

List_Order_Y Int False

The list order of the data set.

Exportable Bool False

Whether the data set is exportable.

Header Bool False

The header for the data set.

Description String False

The description for the data set.

Table_Width String False

The table width for the data set.

Font_Size String False

The font size for the data set.

Output_Default String False

The default output for the data set.

Prespace_Y Bool False

The prespace for the data set.

Use_Prev_Header Bool False

Whether the data set uses the previous header.

Header_Back_Color String False

The back color for the header.

Body_Back_Color String False

The back color for the body.

Header_Text_Color String False

The text color for the header.

Body_Text_Color String False

The text color for the body.

Table_Width_Type String False

The table width type.

Custom_Layout String False

Custom layout parameters.





DocumentRevisions

Create, update, delete, and query the DocumentRevisions module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier for the document revision.

Change_Log String False

The change log for the document revision.

Document_Id String False

The Id for the associated document.

Doc_Id String False

The document Id from the Web service provider for the document.

Doc_Type String False

The document type (e.g., Google, box.net, or IBM SmartCloud).

Doc_Url String False

The document URL from the Web service provider for the document.

Date_Entered Datetime False

The date the revision was entered.

Created_By String False

The Id of the user who created the document.

Filename String False

The file name of the document.

File_Ext String False

The file extension of the document.

File_Mime_Type String False

The MIME type of the document.

Revision String False

The revision number.

Deleted Bool False

Whether the document revision is deleted.

Date_Modified Datetime False

The date the record was last modified.

Created_By_Name String False

The name of the user who created the record.

Latest_Revision_Id String False

The Id of the latest revision.

Document_Name String False

The name of the document.

Latest_Revision String False

The latest revision.





Documents

Create, update, delete, and query the Documents module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the document is a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier for the record.

Name String False

The name of the document.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the document.

Description String False

The full text of the note.

Deleted Bool False

Record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The user name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Document_Name String False

The document name.

Doc_Id String False

The document Id from the Web service provider for the document.

Doc_Type String False

The document type (e.g., Google, box.net, or IBM SmartCloud).

Doc_Url String False

The document URL from the Web service provider for the document.

Filename String False

The file name of the document attachment.

Active_Date Datetime False

The date the document is active.

Exp_Date Datetime False

The date the document expires.

Category_Id String False

The Id for the category of the document.

Subcategory_Id String False

The Id of the subcategory of the document.

Status_Id String False

The Id of the document status.

Status String False

The document status.

Document_Revision_Id String False

The Id of the document revision.

Revision String False

The revision number.

Last_Rev_Created_Name String False

The name of the user who created the last revision.

Last_Rev_Mime_Type String False

The MIME type of the last revision.

Latest_Revision String False

The latest revision.

Last_Rev_Create_Date String False

The date the last revision was created.

Related_Doc_Id String False

The Id of the related document.

Related_Doc_Name String False

The related document name.

Related_Doc_Rev_Id String False

The Id of the related document revision.

Related_Doc_Rev_Number String False

The related document version number .

Is_Template Bool False

Whether the document is a template.

Template_Type String False

The template type of the document.

Latest_Revision_Name String False

The name of the latest revision.

Selected_Revision_Name String False

The name of the selected revision.

Contract_Status String False

The contract status.

Contract_Name String False

The name of the contract

Linked_Id String False

The Id of the linked record.

Selected_Revision_Id String False

The Id of the selected revision.

Latest_Revision_Id String False

The Id of the latest revision.

Selected_Revision_Filename String False

The filename of the selected revision.





EAPM

Create, update, delete, and query the EAPM (external API module) in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the external API is a favorite for the user.

Following Bool False

Whether the user is following this external API.

Id [KEY] String False

Unique identifier for the external API.

Name String False

The name of the external API.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the external API.

Description String False

The full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The name of the user assigned to the record.

Password String False

The password of the external API.

Url String False

The URL of the external API.

Application String False

The application name of the external API.

Api_Data String False

Any API data that the external API may wish to store on a per-user basis.

Consumer_Key String False

The consumer key for the external API.

Consumer_Secret String False

The consumer secret for the external API.

Oauth_Token String False

The OAuth access token for the external API.

Oauth_Secret String False

The OAuth access token secret for the external API.

Validated Bool False

Whether the external API has been validated.

Note String False

The note for the external API.





EmailAddresses

Create, update, delete, and query the EmailAddresses module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the email address.

Email_Address String False

The email address.

Email_Address_Caps String False

The email address in uppercase.

Invalid_Email Bool False

Whether the email address is marked as invalid.

Opt_Out Bool False

Whether the email address is marked as opt out.

Date_Created Datetime False

The date the email address was created.

Date_Modified Datetime False

The date the email address was last modified.

Deleted Bool False

Whether the email address is deleted.





EmailMarketing

Create, update, delete, and query the EmailMarketing module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the email marketing record.

Deleted Bool False

Whether the email marketing record is deleted.

Date_Entered Datetime False

The date the email marketing record was entered.

Date_Modified Datetime False

The date the email marketing record was last modified.

Modified_User_Id String False

The Id of the user who last modified the email marketing record.

Created_By String False

The Id of the user who created the email marketing record.

Name String False

The name of the email marketing record.

From_Name String False

The from name of the email marketing record.

From_Addr String False

The from address of the email marketing record.

Reply_To_Name String False

The reply-to name of the email marketing record.

Reply_To_Addr String False

The reply-to address of the email marketing record.

Inbound_Email_Id String False

The Id of the inbound email for the email marketing record.

Date_Start Datetime False

The date the email marketing record starts.

Template_Id String False

The Id of the template for the email marketing record.

Status String False

The status of the email marketing record.

Campaign_Id String False

The Id of the campaign associated with the email marketing record.

All_Prospect_Lists Bool False

The prospect lists for the email marketing record.

Template_Name String False

The name of the template for the email marketing record.

Prospect_List_Name String False

The name of the prospect list for the email marketing record.





Emails

Create, update, delete, and query the Emails module in SugarCRM.

Columns

Name Type ReadOnly Description
Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

The unique identifier of the email.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The user name of the user assigned to the record.

Modified_User_Id String False

The Id of the user who last modified the record.

Modified_By_Name String False

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String False

The user name of the user who created the record.

Deleted Bool False

The record deletion indicator.

From_Addr_Name String False

The from address in the email.

Reply_To_Addr String False

The reply-to address in the email.

To_Addrs_Names String False

The to addresses in the email.

Cc_Addrs_Names String False

The cc addresses in the email.

Bcc_Addrs_Names String False

The bcc addresses in the email.

Raw_Source String False

The raw source for the email.

Description_Html String False

The HTML description for the email.

Description String False

The description for the email.

Date_Sent Datetime False

The date the email was sent.

Message_Id String False

The Id of the email item obtained from the email transport system.

Message_Uid String False

The UID of the email item obtained from the email transport system.

Name String False

The subject of the email.

Type String False

The type of the email (e.g., draft).

Status String False

The status of the email.

Flagged Bool False

The flagged status of the email.

Reply_To_Status Bool False

The reply-to status of the email. If you reply to an email then the reply-to status of original email is set.

Intent String False

The target of the action used in the Inbound Email assignment.

Mailbox_Id String False

The Id of the mailbox associated with the email.

Parent_Name String False

The name of the Sugar module associated with the email.

Parent_Type String False

The type of the Sugar module associated with the email. (Deprecated as of 4.2.)

Parent_Id String False

The Id of the Sugar module associated with the email. (Deprecated as of 4.2.)





EmailTemplates

Create, update, delete, and query the EmailTemplates module in SugarCRM.

Columns

Name Type ReadOnly Description
Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

The unique identifier of the email template.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Modified_User_Id String False

The Id of the user who last modified the record.

Created_By String False

The Id of the user who created the record.

Published String False

The published status of the record.

Name String False

The name of the email template.

Description String False

The description for the email template.

Subject String False

The subject of the resulting email.

Body String False

Plaintext body of the resulting email.

Body_Html String False

The HTML-formatted body of the resulting email.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The username of the user assigned to the record.

Base_Module String False

In Workflow alert templates, the module to which this template is associated.

From_Name String False

The from name of the resulting email.

From_Address String False

The from address of the resulting email.

Text_Only Bool False

Whether the email template is to be sent in text only.

Type String False

The type of the email template.





Employees

Create, update, delete, and query the Employees module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the employee.

User_Name String False

The username of the employee.

User_Hash String False

The user hash of the employee.

System_Generated_Password Bool False

Whether the employee has a system-generated password.

Pwd_Last_Changed Datetime False

The date the password of the employee was last changed.

Authenticate_Id String False

The Id used in authentication.

Sugar_Login Bool False

Whether the employee has a Sugar login.

Picture String False

The Id of the picture.

First_Name String False

The first name of the employee.

Last_Name String False

The last name of the employee.

Full_Name String False

The full name of the employee.

Name String False

The name of the employee.

Is_Admin Bool False

Whether the employee is an admin.

External_Auth_Only Bool False

Whether the employee only has external authentication available.

Receive_Notifications Bool False

Whether the employee can receive notifications.

Description String False

The description for the employee.

Date_Entered Datetime True

The date the employee record was entered into the system.

Date_Modified Datetime True

The date the employee record was last modified.

Last_Login Datetime True

The last login date of the employee.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Title String False

The title of the employee.

Department String False

The department of the employee.

Phone_Home String False

The home phone number of the employee.

Phone_Mobile String False

The mobile phone number of the employee.

Phone_Work String False

The work phone number of the employee.

Phone_Other String False

The alternate phone of the employee.

Phone_Fax String False

The fax of the employee.

Status String False

The status of the employee.

Address_Street String False

The street address of the employee.

Address_City String False

The city in the address of the employee.

Address_State String False

The state in the address of the employee.

Address_Country String False

The country in the address of the employee.

Address_Postalcode String False

The postal code in the address of the employee.

UserType String False

The user type of the employee.

Default_Team String False

The default team for the employee.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Deleted Bool False

Whether the employee is deleted.

Portal_Only Bool False

Whether the employee is a portal-only user.

Show_On_Employees Bool False

Whether to show the employee.

Employee_Status String False

The status of the employee.

Messenger_Id String False

The Id of the instant messenger service used by the employee.

Messenger_Type String False

The type of the instant messenger service used by the employee.

Reports_To_Id String False

The Id of who the employee reports to.

Reports_To_Name String False

The user name of who the employee reports to.

Email1 String False

The alternate email address of the employee.

Email String False

The email address of the employee.

Email_Link_Type String False

The link type of the email for the employee.

Is_Group Bool False

Whether the employee is a group user.

C_Accept_Status_Fields String False

The status fields for the call accept status of the employee.

M_Accept_Status_Fields String False

The status fields for the meeting accept status of the employee.

Accept_Status_Id String False

The Id of the accept status of the employee.

Accept_Status_Name String False

The name of the accept status of the employee.

Accept_Status_Calls String False

The call accept status for the employee.

Accept_Status_Meetings String False

The meeting accept status for the employee.

Preferred_Language String False

The preferred language for the employee.





Filters

Create, update, delete, and query the Filters module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the filter is a favorite for the user.

Following Bool False

Whether the user is following the filter.

Id [KEY] String False

The unique identifier of the filter

Name String False

The name of the filter.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the filter.

Description String False

The description for the filter.

Deleted Bool False

The record deletion indicator.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The user name of the user assigned to the record.

Filter_Definition String False

The definition of the filter.

Filter_Template String False

The filter template.

Module_Name String False

The name of the module the filter applies to.





ForecastManagerWorksheets

Create, update, delete, and query the ForecastManagerWorksheets module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the forecast manager worksheet is a favorite for the user.

Following Bool False

Whether the user is following the record.

Id [KEY] String False

Unique identifier of the worksheet.

Name String False

The name of the worksheet.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The username of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The username of the user who created the worksheet.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the worksheet.

Description String False

The full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The username of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Quota Double False

The quota for the forecast manager worksheet.

Best_Case Double False

The most optimistic scenario.

Best_Case_Adjusted Double False

The adjusted most optimistic scenario.

Likely_Case Double False

The likely scenario.

Likely_Case_Adjusted Double False

The adjusted likely scenario.

Worst_Case Double False

The least optimistic scenario.

Worst_Case_Adjusted Double False

The adjusted least optimistic scenario.

Currency_Id String False

The Id of the currency associated with the record.

Base_Rate Decimal False

The base rate of the record.

Timeperiod_Id String False

The Id of the time period associated with the worksheet.

Draft Bool False

Whether the worksheet is a draft.

Is_Manager Bool False

Whether the worksheet is visible to the manager.

User_Id String False

The Id of the user associated with the worksheet.

Opp_Count Int False

The number of opportunities represented by this forecast.

Pipeline_Opp_Count Int False

The number of opportunities minus closed won/closed lost represented by this forecast.

Pipeline_Amount Double False

The total of opportunities minus closed won/closed lost represented by this forecast.

Closed_Amount Double False

The total of closed/won items in the forecast.

Manager_Saved Bool False

Whether the manager has saved the forecast.

Show_History_Log Int False

Whether the forecast shows the history log.

Draft_Save_Type String False

The draft save type.





Forecasts

Create, update, delete, and query the Forecasts module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the forecast.

Timeperiod_Id String False

The Id of the associated time period for this forecast.

Commit_Type String False

The commit type of the worksheet.

Forecast_Type String False

The type of the forecast. Valid values: direct or rollup.

Opp_Count Int False

The number of opportunities represented by this forecast.

Pipeline_Opp_Count Int False

The number of opportunities minus closed won/closed lost represented by this forecast.

Pipeline_Amount Double False

Total of opportunities minus closed won/closed lost represented by this forecast.

Closed_Amount Double False

Total of closed/won items in the forecast.

Opp_Weigh_Value Int False

The weighted amount of all opportunities represented by this forecast.

Currency_Id String False

The Id of the currency associated with the forecast.

Base_Rate Decimal False

The base rate of the forecast.

Best_Case Double False

The most optimistic scenario.

Likely_Case Double False

The likely scenario.

Worst_Case Double False

The least optimistic scenario.

User_Id String False

The user to which this forecast pertains.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was modified.

Deleted Bool False

The record deletion indicator.

User_Name String False

The username of the user associated with the forecast.

Reports_To_User_Name String False

The username of who the user reports to.

Start_Date Datetime False

The start date of the forecast.

End_Date Datetime False

The end date of the forecast.

Name String False

The name of the forecast.

Closed_Count Int False

How many closed opportunities exist for the pipeline.





ForecastSchedule

Create, update, delete, and query the ForecastSchedule module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the forecast schedule.

Timeperiod_Id String False

The Id of the associated time period for this forecast schedule.

User_Id String False

The user to which this forecast schedule pertains.

Cascade_Hierarchy Bool False

The flag indicating if a forecast for a manager is propagated to his reports.

Forecast_Start_Date Datetime False

The starting date for this forecast.

Status String False

The status of this forecast.

Created_By String False

The Id of the user who created the record.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was modified.

Deleted Bool False

The record deletion indicator.





ForecastWorksheets

Create, update, delete, and query the ForecastWorksheets module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is a favorite for the user.

Following Bool False

Whether the user is following the record.

Id [KEY] String False

Unique identifier of the worksheet.

Name String False

The name of the worksheet.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The username of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The username of the user who created the worksheet.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the worksheet.

Description String False

Full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The username of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Parent_Id String False

The Id of the parent module associated with the worksheet.

Parent_Type String False

The type of the parent module associated with the worksheet.

Parent_Name String False

The name of the parent module associated with the worksheet.

Opportunity_Id String False

The Id of the opportunity associated with the worksheet.

Opportunity_Name String False

The name of the opportunity associated with the worksheet.

Account_Name String False

The name of the account associated with the worksheet.

Account_Id String False

The Id of the account associated with the worksheet.

Campaign_Id String False

The Id of the campaign associated with the worksheet.

Campaign_Name String False

The name of the campaign associated with the worksheet.

Product_Template_Id String False

The Id of the product template associated with the worksheet.

Product_Template_Name String False

The name of the product template associated with the worksheet.

Category_Id String False

The Id of the category associated with the worksheet.

Category_Name String False

The name of the category associated with the worksheet.

Sales_Status String False

The sales status of the worksheet.

Likely_Case Double False

The likely scenario.

Best_Case Double False

The most optimistic scenario.

Worst_Case Double False

The least optimistic scenario.

Base_Rate Decimal False

The base rate worksheet.

Currency_Id String False

The Id of the currency used for display purposes.

Currency_Name String False

The name of the currency used for display purposes.

Currency_Symbol String False

The symbol of the currency used for display purposes.

Date_Closed Datetime False

Expected or actual date the oppportunity will close.

Date_Closed_Timestamp Int False

The timestamp of the close date for the opportunity.

Sales_Stage String False

The stage that indicates the progression towards closure.

Probability Int False

The probability of closure.

Commit_Stage String False

The forecast commit range, such as Include, Likely, Omit, etc.

Draft Int False

Whether the forecast is a draft.

Next_Step String False

The next step in the sales process.

Lead_Source String False

The source of the product.

Product_Type String False

The type of product. An opportunity type. For example, Existing or New.

List_Price Double False

List price of product (List in Quote).

Cost_Price Double False

Product cost (Cost in Quote).

Discount_Price Double False

Discounted price (Unit Price in Quote).

Discount_Amount Double False

Discounted amount.

Quantity Int False

Quantity in use.

Total_Amount Double False

The total amount.

Parent_Deleted Int False

Whether the parent object is deleted.





InboundEmail

Create, update, delete, and query the InboundEmail module in SugarCRM.

Columns

Name Type ReadOnly Description
Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

The unique identifier for the record.

Deleted Bool False

The record deletion indicator.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Modified_User_Id String False

The Id of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Name String False

The name given to the inbound email mailbox.

Status String False

The status of the inbound email mailbox (e.g., Active or Inactive).

Server_Url String False

The mail server URL.

Email_User String False

The user name of the user allowed access to mail server.

Email_Password String False

The password of the user allowed access to the mail server.

Port Int False

The port used to access the mail server.

Service String False

The service type of the inbound email. For example, ::::::imap::::

Mailbox String False

The mailbox associated with the email.

Delete_Seen Bool False

Whether to delete email from the server once read (seen).

Mailbox_Type String False

The type of the mailbox associated with the email.

Template_Id String False

The template used for autoreply.

Stored_Options String False

The stored options for the email.

Group_Id String False

The group Id for the email.

Is_Personal Bool False

The personal account flag.

Groupfolder_Id String False

The Id of the group folder.





KBDocuments

Create, update, delete, and query the KBDocuments module in SugarCRM.

Columns

Name Type ReadOnly Description
Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

The unique identifier of the KB document.

Kbdocument_Name String False

The name of the KB document.

Name String False

The name of the KB document.

Body String False

The body of the KB document.

Active_Date Datetime False

The active date the KB document.

Exp_Date Datetime False

The expiration date of the KB document.

Status_Id String False

The Id of the status of the KB document.

Date_Entered Datetime False

The date the KB document was entered.

Date_Modified Datetime False

The date the KB document was last modified.

Deleted Bool False

Whether the KB document is deleted.

Is_External_Article Bool False

Whether the KB document is an external article.

Description String False

The description of the KB document.

Modified_User_Id String False

The Id of the user who last modified the KB document.

Created_By String False

The Id of the user who created the KB document.

Kbdocument_Revision_Id String False

The revision Id of the KB document.

Kbdocument_Revision_Number String False

The revision number of the KB document.

Latest_Revision String False

The latest revision of the KB document.

Last_Rev_Create_Date Datetime False

The date the latest revision was created.

Mail_Merge_Document Bool False

Whether the KB document is a Mail Merge document.

Related_Doc_Id String False

The Id of the related document.

Related_Doc_Rev_Id String False

The revision Id of the related document.

Is_Template Bool False

Whether the KB document is a template.

Template_Type String False

The template type of the KB document.

Latest_Revision_Name String False

The name of the latest revision of the KB document.

Selected_Revision_Name String False

The selected revision name of the KB document.

Contract_Status String False

The status of the contract associated with the KB document.

Contract_Name String False

The name of the contract associated with the KB document.

Linked_Id String False

The Id of the linked record.

Selected_Revision_Id String False

The Id of the selected revision.

Latest_Revision_Id String False

The Id of the latest revision.

Selected_Revision_Filename String False

The filename of the selected revision.

Keywords String False

The keywords for the KB document.

Kbdoc_Approver_Id String False

The Id of the user who approved the KB document.

Kbdoc_Approver_Name String False

The name of the approver for the KB document.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The username of the user assigned to the record.

Views_Number String False

The number of views for the KB document.

Attachment_List String False

The attachment List for the KB document.

Parent_Id String False

The Id of the parent record for the KB document.

Parent_Type String False

The type of the parent record for the KB document.

Case_Id String False

The Id for the case associated with the KB document.

Case_Name String False

The name of the case associated with the KB document.





Leads

Create, update, delete, and query the Leads module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the record.

Name String False

The name of the lead.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

Full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The user name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Email String False

The email address for the Lead.

Email1 String False

The alternate email address for the Lead.

Email2 String False

The alternate email address for the Lead.

Invalid_Email Bool False

Whether email for the Lead has been marked as invalid.

Email_Opt_Out Bool False

Whether the Lead has opted out of email.

Email_Addresses_Non_Primary String False

The nonprimary email addresses of the lead.

Salutation String False

The contact salutation (e.g., Mr., Ms.).

First_Name String False

The first name of the lead.

Last_Name String False

The last name of the lead.

Full_Name String False

The full name of the lead.

Title String False

The title of the lead.

Facebook String False

The Facebook name of the lead.

Twitter String False

The Twitter name of the lead.

Googleplus String False

The Google Plus Id of the lead.

Department String False

The department the lead belongs to.

Do_Not_Call Bool False

An indicator of whether the lead can be called.

Phone_Home String False

The home phone number of the lead.

Phone_Mobile String False

The mobile phone number of the lead.

Phone_Work String False

The work phone number of the lead.

Phone_Other String False

Other phone number for the lead

Phone_Fax String False

The contact fax number.

Primary_Address_Street String False

The street address used for the primary address.

Primary_Address_Street_2 String False

The second line of the primary address.

Primary_Address_Street_3 String False

The third line of the primary address.

Primary_Address_City String False

The city for the primary address.

Primary_Address_State String False

The state for the primary address.

Primary_Address_Postalcode String False

The postal code for the primary address.

Primary_Address_Country String False

The country for the primary address.

Alt_Address_Street String False

The street address for the alternate address.

Alt_Address_Street_2 String False

The second line for the alternate address.

Alt_Address_Street_3 String False

The third line for the alternate address.

Alt_Address_City String False

The city for the alternate address.

Alt_Address_State String False

The state for the alternate address.

Alt_Address_Postalcode String False

The postal code for the alternate address.

Alt_Address_Country String False

The country for the alternate address.

Assistant String False

The name of the assistant of the lead.

Assistant_Phone String False

The phone number of the assistant of the lead.

Picture String False

The picture of the lead.

Converted Bool False

Whether the lead been converted to a contact (and other Sugar objects).

Refered_By String False

Identifies who refered the lead.

Lead_Source String False

Lead source (e.g., Web or print).

Lead_Source_Description String False

The description of the lead source.

Status String False

The status of the lead.

Status_Description String False

Description of the status of the lead.

Reports_To_Id String False

Id of the contact the Lead reports to.

Report_To_Name String False

The name of the contact the Lead reports to.

Dnb_Principal_Id String False

The unique Id For the D. and B. Contact.

Account_Name String False

The account name for lead.

Account_Description String False

The description of lead account.

Contact_Id String False

The Id of the contact resulting from the conversion.

Contact_Name String False

The name of the contact resulting from the conversion.

Account_Id String False

The account Id resulting from the conversion.

Opportunity_Id String False

The opportunity Id resulting from the conversion.

Opportunity_Name String False

The opportunity name resulting from the conversion.

Opportunity_Amount String False

The amount of the opportunity.

Campaign_Id String False

The Id of the campaign that generated the lead.

Campaign_Name String False

The name of the campaign that generated the lead.

C_Accept_Status_Fields String False

The fields in the accept status of the call.

M_Accept_Status_Fields String False

The fields in the accept status of the meeting.

Accept_Status_Id String False

The Id of the accept status.

Accept_Status_Name String False

The name of the accept status.

Accept_Status_Calls String False

The accept status of calls for the lead.

Accept_Status_Meetings String False

The accept status of meetings for the lead.

Webtolead_Email1 String False

The main email address of the lead.

Webtolead_Email2 String False

The secondary email address of the lead.

Webtolead_Email_Opt_Out Bool False

Whether the lead elects to opt out of email campaigns.

Webtolead_Invalid_Email Bool False

Whether the email address for the lead is invalid.

Birthdate Datetime False

The birthdate of the lead.

Portal_Name String False

Portal user name when the lead was created via the lead portal.

Portal_App String False

Portal application when the lead was created via lead portal.

Website String False

The URL of the website for the company.

Preferred_Language String False

The preferred language of the lead.

Mkto_Sync Bool False

Whether the lead is to be synced to Marketo.

Mkto_Id Int False

The associated Marketo lead Id.

Mkto_Lead_Score Int False

The lead score of the associated Marketo lead.





Manufacturers

Create, update, delete, and query the Manufacturers module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the manufacturer.

Deleted Bool False

The record deletion indicator.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Modified_User_Id String False

The Id of the user who last modified the record.

Created_By String False

The Id of the user who created the record.

Name String False

The name of the manufacturer.

List_Order Int False

The relative order in the drop-down list.

Status String False

The status of the manufacturer.





Meetings

Create, update, delete, and query the Meetings module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the meeting is a favorite for the user.

Following Bool False

Whether the user is following this meeting.

Id [KEY] String False

The unique identifier for the meeting.

Name String False

The meeting name.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

Full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The user name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Accept_Status String False

The accept status for the meeting.

Set_Accept_Links String False

The accept links for the meeting.

Location String False

The location of the meeting.

Password String False

The password of the meeting.

Join_Url String False

The join URL.

Host_Url String False

The host URL.

Displayed_Url String False

The meeting URL.

Creator String False

The meeting creator.

External_Id String False

The meeting Id for the external app API.

Duration_Hours Int False

The duration (hours).

Duration_Minutes String False

The duration (minutes).

Date_Start String False

Date of the start of the meeting.

Date_End String False

Date the meeting ends.

Parent_Type String False

Module the meeting is associated with.

Status String False

Meeting status (e.g., Planned, Held, or Not held).

Type String False

Meeting type (e.g., WebEx, or Other).

Direction String False

Whether the call is inbound or outbound.

Parent_Id String False

Id of the parent Sugar item.

Reminder_Checked Bool False

Whether or not the reminder value is set.

Reminder_Time String False

Specifies when a reminder alert should be issued: -1 means no alert; otherwise the number of seconds prior to the start.

Email_Reminder_Checked Bool False

Whether or not the email reminder value is set.

Email_Reminder_Time String False

Specifies when a email reminder alert should be issued: -1 means no alert; otherwise the number of seconds prior to the start.

Email_Reminder_Sent Bool False

Whether the email reminder is already sent.

Outlook_Id String False

When the Sugar Plug-in for Microsoft Outlook syncs an Outlook appointment, this is the Outlook appointment item Id.

Sequence Int False

Meeting update sequence for meetings as per iCalendar standards.

Contact_Name String False

The name of the associated contact.

Parent_Name String False

The name of the associated parent Sugar module.

Accept_Status_Users String False

The user accept status.

Contact_Id String False

The Id of the associated contact.

Repeat_Type String False

Type of a recurring meeting.

Repeat_Interval Int False

The interval of a recurring meeting.

Repeat_Dow String False

The day of week of a meeting.

Repeat_Until Datetime False

Repeat until the specified date.

Repeat_Count Int False

Number of recurrences.

Repeat_Parent_Id String False

Id of the first element of recurring records.

Recurring_Source String False

Source of recurring meeting.

Duration String False

Duration handler dropdown.

Send_Invites Bool False

Whether or not to send out invites.





Notes

Create, update, delete, and query the Notes module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the note is a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

Unique identifier of the record.

Name String False

Name of the note.

Date_Entered Datetime True

Date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

Full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The user name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

File_Mime_Type String False

Attachment MIME type.

File_Url String False

Path to file (can be a URL).

Filename String False

File name associated with the note (attachment).

Parent_Type String False

Sugar module the Note is associated with.

Parent_Id String False

The Id of the parent Sugar item.

Contact_Id String False

The Id of the contact the note is associated with.

Portal_Flag Bool False

Portal flag indicator, which determines if the note is created via portal.

Embed_Flag Bool False

Embed flag indicator, which determines if the note is embedded in an email.

Parent_Name String False

The name of the parent object associated with the note.

Contact_Name String False

The name of the contact associated with the note.

Contact_Phone String False

The phone number of the contact associated with the note.

Contact_Email String False

The email of the contact associated with the note.

Account_Id String False

The Id of the account associated with the note.

Opportunity_Id String False

The Id of the opportunity associated with the note.

Acase_Id String False

The Id of the case associated with the note.

Lead_Id String False

The Id of the lead associated with the note.

Product_Id String False

The Id of the product associated with the note.

Quote_Id String False

The Id of the quote associated with the note.





Notifications

Create, update, delete, and query the Notifications module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the meeting is a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

Unique identifier of the record.

Name String True

Name of the note.

Date_Entered Datetime True

Date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

User who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String True

Full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String True

The user name of the user assigned to the record.

Is_Read Bool False

Whether the noficiation is read.

Severity String True

The severity of the notification.

Parent_Name String True

The parent Sugar item associated with the notification.

Parent_Type String False

The type of the parent Sugar item associated with the notification.

Parent_Id String False

The Id of the parent Sugar item associated with the notification.





OAuthKeys

Create, update, delete, and query the OAuthKeys module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the keys are a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

Unique identifier of the record.

Name String False

Name of the note.

Date_Entered Datetime True

Date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

User who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

Full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The user name of the user assigned to the record.

C_Key String False

Consumer public key.

C_Secret String False

Consumer secret key.

Oauth_Type String False

The type of OAuth: oauth1 or oauth6.

Client_Type String False

The type of client: mobile, portal, UI, or other.





OAuthTokens

Create, update, delete, and query the OAuthTokens module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the record.

Secret String False

The secret key.

Tstate String False

The token state.

Consumer String False

Token related to the consumer.

Token_Ts Long False

Token timestamp.

Expire_Ts Long False

Token expiration. Defaults to -1 for no expiration date.

Verify String False

Token verification info.

Download_Token String False

A token used to download images and files.

Platform String False

The platform the token is attached to.

Deleted Bool False

Record deletion indicator.

Callback_Url String False

Callback URL for authorization.

Consumer_Name String False

The consumer name.

Contact_Id String False

Contact Id this oauth token is associated with (via portal).

Contact_Name String False

Contact name this oauth token is associated with (via portal).

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The username of the user assigned to the record.





Opportunities

Create, update, delete, and query the Opportunities module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the opportunity.

Name String False

Name of the opportunity.

Date_Entered Datetime True

Date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

User who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

Full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The user name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Opportunity_Type String False

Type of opportunity (e.g., Existing or New).

Account_Name String False

The name of the associated account.

Account_Id String False

The Id of the associated account.

Campaign_Id String False

The Id of the campaign that generated the lead.

Campaign_Name String False

The name of the campaign that generated the lead.

Lead_Source String False

Source of the opportunity.

Amount Double True

Unconverted amount of the opportunity.

Base_Rate Decimal False

The base rate of the opportunity.

Amount_Usdollar Double True

Formatted amount of the opportunity.

Currency_Id String False

The Id of the currency used for display purposes.

Currency_Name String False

The name of the currency used for display purposes.

Currency_Symbol String False

The symbol of the currency used for display purposes.

Date_Closed Datetime True

The expected or actual date the oppportunity will close.

Date_Closed_Timestamp Int False

The timestamp of the close date.

Next_Step String False

The next step in the sales process.

Sales_Stage String False

Indication of progression towards closure.

Sales_Status String True

The status of the sale.

Probability Int False

The probability of closure.

Best_Case Double True

The most optimistic scenario.

Worst_Case Double True

The least optimistic scenario.

Commit_Stage String False

Forecast commit ranges: Include, Likely, Omit etc.

Total_Revenue_Line_Items Int False

The count of all revenue line items.

Closed_Revenue_Line_Items Int False

The count of the closed revenue line items.

Contact_Role String False

The role of the contact for the opprtunity.

Mkto_Sync Bool False

Whether the Opportunity is to be synced to Marketo.

Mkto_Id Int False

The associated Marketo lead Id.





PdfManager

Create, update, delete, and query the PdfManager module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the PdfManager is a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the record.

Name String False

The name of the template used to print the PDF.

Date_Entered Datetime True

Date the record was created.

Date_Modified Datetime True

Date the record was last modified.

Modified_User_Id String True

Id of the user who last modified the record.

Modified_By_Name String True

Name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

Full text of the note.

Deleted Bool False

Record deletion indicator.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The username of the user assigned to the record.

Base_Module String False

The base module associated with the record.

Published String False

The published status of the record.

Field String False

The field for the record.

Body_Html String False

The body HTML for the record.

Template_Name String False

The name of the PDF template.

Author String False

The author of the PDF template.

Title String False

The title of the PDF template.

Subject String False

The subject of the PDF template.

Keywords String False

The keywords of the PDF template.

Header_Title String False

The header title of the PDF template.

Header_Text String False

The header text of the PDF template.

Header_Logo String False

The PDF header logo.

Footer_Text String False

The footer text for the PDF template.





ProductCategories

Create, update, delete, and query the ProductCategories module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the product category.

Deleted Bool False

Record deletion indicator.

Date_Entered Datetime False

Date the record was created.

Date_Modified Datetime False

Date the record was last modified.

Modified_User_Id String False

Id of the user who last modified the record.

Modified_By_Name String False

Username of the user who last modified the record.

Created_By String False

The Id of the user who created the record.

Created_By_Name String False

The username of the user who created the record.

Name String False

Name of the product category.

List_Order Int False

The relative order in the drop-down list.

Description String False

Full description of the category.

Assigned_User_Id String False

The Id of the user who owns the product category.

Parent_Id String False

Parent category of this item; used for multitiered categorization.

Parent_Name String False

The name of the parent category.

Type String False

The type of the product category.





Products

Create, update, delete, and query the Products module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the product is a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier for the record.

Name String False

The name of the product.

Date_Entered Datetime True

Date the record was created.

Date_Modified Datetime True

Date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The username of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the record.

Description String False

Full text of the note.

Deleted Bool False

Record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The username of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Revenuelineitem_Id String False

The Id of the associated revenue line item that served as the source.

Revenuelineitem_Name String False

The name of the associated revenue line item that served as the source.

Product_Template_Id String False

Id of the product (in Admin Products) from which this product is derived (in user Products).

Product_Template_Name String False

Name of the product (in Admin Products) from which this product is derived (in user Products).

Account_Id String False

Id of the account this product is associated with.

Contact_Id String False

Id of the contact this product is associated with.

Total_Amount Double False

The total amount of the product.

Contact_Name String False

The name of the contact for the product.

Type_Id String False

Product type (e.g., hardware or software).

Quote_Id String False

If product is created via Quote, this is quote Id.

Manufacturer_Id String False

The Id of the manufacturer of the product.

Manufacturer_Name String False

The name of the manufacturer of the product.

Category_Id String False

The Id of the product category.

Category_Name String False

The name of the product category.

Mft_Part_Num String False

Manufacturer part number.

Vendor_Part_Num String False

Vendor part number.

Date_Purchased Datetime False

Date the product was purchased.

Cost_Price Double False

Product cost (Cost in Quote).

Discount_Price Double False

Discounted price (Unit Price in Quote).

Discount_Amount String False

Discounted amount.

Discount_Rate_Percent Decimal False

Discounted percent.

Discount_Amount_Usdollar Double False

Discount amount in USD.

Discount_Select Bool False

The select discount.

Deal_Calc Double False

The deal calculation.

Deal_Calc_Usdollar Double False

The deal calculation in USD.

List_Price Double False

List price of product (List in Quote).

Cost_Usdollar Double False

Cost expressed in USD.

Discount_Usdollar Double False

Discount price expressed in USD.

List_Usdollar Double False

List price expressed in USD.

Currency_Id String False

Currency of the product.

Base_Rate Decimal False

The base rate of the product.

Status String False

Product status (e.g., Quoted, Ordered, or Shipped).

Tax_Class String False

Tax classification (e.g., Taxable or Non-taxable).

Website String False

Product URL.

Weight Decimal False

Weight of the product.

Quantity Decimal False

Quantity in use.

Support_Name String False

Name of product for support purposes.

Support_Description String False

Description of product for support purposes.

Support_Contact String False

Contact for support purposes.

Support_Term String False

Term (length) of support contract.

Date_Support_Expires Datetime False

Support expiration date.

Date_Support_Starts Datetime False

Support start date.

Pricing_Formula String False

Pricing formula (e.g., Fixed or Markup over Cost).

Pricing_Factor Int False

Variable pricing factor depending on pricing_formula.

Serial_Number String False

Serial number of the product in use.

Asset_Number String False

Asset tag number of the product in use.

Book_Value Double False

Book value of the product in use.

Book_Value_Usdollar Double False

Book value expressed in USD.

Book_Value_Date Datetime False

Date of book value for the product in use.

Date_Closed Datetime False

Expected or actual date the product (for opportunity) will close.

Date_Closed_Timestamp Int False

The timestamp of date_closed.

Next_Step String False

The next step in the sales process.

Campaign_Id String False

The Id of the campaign that generated the lead.

Campaign_Name String False

The name of the campaign that generated the lead.

Currency_Name String False

The name of the currency.

Currency_Symbol String False

The symbol of the currency.

Quote_Name String False

Quote name.

Opportunity_Id String False

The opportunity Id for the line item entry.

Opportunity_Name String False

The opportunity name associated with the opportunity.

Type_Name String False

The name of the type.

Account_Name String False

The name of the account.

Product_Index String False

The product index.





ProductTemplates

Create, udpate, delete, and query the ProductTemplates module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the product template.

Deleted Bool False

The record deletion indicator.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The user who last modified the record.

Created_By String True

The Id of the user who created the record.

Type_Id String False

The product type (e.g., hardware or software).

Manufacturer_Id String False

The manufacturer of the product.

Manufacturer_Name String False

The manufacturer name.

Category_Id String False

The category of the product.

Category_Name String False

The category name.

Type_Name String False

The type name.

Name String False

The name of the product.

Mft_Part_Num String False

The manufacturer part number.

Vendor_Part_Num String False

The vendor part number.

Date_Cost_Price Datetime False

The starting date the cost price is valid.

Cost_Price Double False

Product cost (Cost in Quote).

Discount_Price Double False

Discounted price (Unit Price in Quote).

List_Price Double False

List price of product (List in Quote).

Cost_Usdollar Double True

Cost expressed in USD.

Discount_Usdollar Double True

Discount price expressed in USD.

List_Usdollar Double True

List price expressed in USD.

Currency_Id String False

Currency of the product.

Base_Rate Decimal False

The base rate.

Currency_Symbol String False

The currency symbol.

Currency String False

Currency of the product.

Status String False

Product status (not used in product Catalog).

Tax_Class String False

Tax classification (e.g., Taxable or Non-taxable).

Date_Available Datetime False

Availability date.

Website String False

Product URL.

Weight Decimal False

Weight of the product.

Qty_In_Stock Int False

Quantity on hand.

Description String False

Description of the product.

Support_Name String False

Name of product for support purposes.

Support_Description String False

Description of product for support purposes.

Support_Contact String False

Contact for support purposes.

Support_Term String False

Term (length) of support contract.

Pricing_Formula String False

Pricing formula (e.g., Fixed or Markup over Cost).

Pricing_Factor Decimal False

Variable pricing factor depending on pricing_formula.





ProductTypes

Create, udpate, delete, and query the ProductTypes module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the product type.

Deleted Bool False

The record deletion indicator.

Date_Entered Datetime False

Date the record was created.

Date_Modified Datetime False

Date the record was last modified.

Modified_User_Id String False

Id of the user who last modified the record.

Created_By String False

Id of the user who created the record.

Name String False

Product type name.

Description String False

Product type description.

List_Order Int False

The relative order in the drop-down list.





Project

Create, update, delete, and query the Project module in SugarCRM.

Columns

Name Type ReadOnly Description
Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

The unique identifier of the project.

Date_Entered Datetime False

Date the record was created.

Date_Modified Datetime False

Date the record was last modified.

Assigned_User_Id String False

The Id of the user assigned to this record.

Modified_User_Id String False

The Id of the user who last modified the record

Modified_By_Name String False

The name of the user who last modified the record.

Created_By String False

The Id of the user who created the record.

Created_By_Name String False

The name of the user who created the record.

Name String False

Project name.

Description String False

Project description.

Deleted Bool False

The record deletion indicator.

Estimated_Start_Date Datetime False

The estimated start date.

Estimated_End_Date Datetime False

The estimated end date.

Status String False

The status of the project.

Priority String False

The priority of the project.

Is_Template Bool False

Whether the project is a template.

Total_Estimated_Effort Int False

The total estimated effort of the project.

Total_Actual_Effort Int False

The total actual effort of the project.

Assigned_User_Name String False

The user name of the user assigned to the project.





ProjectTask

Create, update, delete, and query the ProjectTask module in SugarCRM.

Columns

Name Type ReadOnly Description
Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

The unique identifier of the project task.

Date_Entered Datetime False

The date the project task was entered.

Date_Modified Datetime False

The date the project task was modified.

Project_Id String False

The Id of the project associated with the task.

Project_Task_Id Int False

The Id of the project task.

Name String False

The name of the project task.

Status String False

The status of the project task.

Description String False

The full text of the note.

Resource_Id String False

The Id of the associated resource.

Resource_Name String False

The name of the associated resource.

Predecessors String False

The predecessors of the project task.

Date_Start Datetime False

The start date of the project task.

Time_Start Int False

The start time of the project task.

Time_Finish Int False

The finish time of the project task.

Date_Finish Datetime False

The finish date of the project task.

Duration Int False

The duration of the project task.

Duration_Unit String False

The duration unit of the project task.

Actual_Duration Int False

The actual duration of the project task.

Percent_Complete Int False

The percent that the project task is complete.

Date_Due Datetime False

The due date of the project task.

Time_Due String False

The time the project task is due.

Parent_Task_Id Int False

The Id of the parent task.

Assigned_User_Id String False

The Id of the user assigned to the project task.

Modified_User_Id String False

The Id of the user who last modified the project task.

Modified_By_Name String False

The user name of the user who last modified the project task.

Priority String False

The priority of the project task.

Created_By String False

The Id of the user who created the project task.

Created_By_Name String False

The user name of the user who created the project task.

Milestone_Flag Bool False

The name of the project task.

Order_Number Int False

The order number of the project task.

Task_Number Int False

The task number of the project task.

Estimated_Effort Int False

The estimated effort of the project task.

Actual_Effort Int False

The actual effort of the project task.

Deleted Bool False

Whether the project task is deleted.

Utilization Int False

The utilization of the project task.

Project_Name String False

The name of the project task.

Assigned_User_Name String False

The user name of the user assigned to the project task.





ProspectLists

Create, update, delete, and query the ProspectLists module in SugarCRM.

Columns

Name Type ReadOnly Description
Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The user name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

The Id of the prospect list.

Name String False

The name of the prospect list.

List_Type String False

The type of the prospect list.

Date_Entered Datetime False

The date the prospect list was entered.

Date_Modified Datetime False

The date the prospect list was last modified.

Modified_User_Id String False

The Id of the user who last modified the prospect list.

Modified_By_Name String False

The user name of the user who last modified the prospect list.

Created_By String False

The Id of the user who created the prospect list.

Created_By_Name String False

The user name of the user who created the prospect list.

Deleted Bool False

Whether the prospect list is deleted.

Description String False

The description of the prospect list.

Domain_Name String False

The domain name of the prospect list.

Entry_Count Int False

The entry count of the prospect list.

Marketing_Id String False

The marketing Id of the prospect list.

Marketing_Name String False

The marketing name of the prospect list.





Prospects

Create, update, delete, and query the Prospects module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is a favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the record.

Name String False

The name of the prospect.

Date_Entered Datetime True

Date the record was created.

Date_Modified Datetime True

Date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The user favorites for the prospect.

Description String False

Full text of the note.

Deleted Bool False

Record deletion indicator.

Assigned_User_Id String False

User Id assigned to the record.

Assigned_User_Name String False

The user name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Email String False

The email for the prospect.

Email1 String False

The alternate email for the prospect.

Email2 String False

The alternate email for the prospect.

Invalid_Email Bool False

Whether the prospect email has been marked as invalid.

Email_Opt_Out Bool False

Whether the prospect has opted out of radio.

Email_Addresses_Non_Primary String False

The nonprimary email addresses for the prospect.

Salutation String False

The prospect salutation (e.g., Mr. or Ms.).

First_Name String False

The first name of the prospect.

Last_Name String False

The last name of the prospect.

Full_Name String False

The full name of hte prospect.

Title String False

The title of the prospect.

Facebook String False

The Facebook name of the user.

Twitter String False

The Twitter name of the user.

Googleplus String False

The Google Plus Id of the user.

Department String False

The department of the prospect.

Do_Not_Call Bool False

An indicator of whether the prospect can be called.

Phone_Home String False

Home phone number of the prospect.

Phone_Mobile String False

Mobile phone number of the prospect.

Phone_Work String False

Work phone number of the prospect.

Phone_Other String False

Other phone number for the prospect.

Phone_Fax String False

The prospect fax number.

Primary_Address_Street String False

The street address used for the primary address.

Primary_Address_Street_2 String False

The second line of the primary address.

Primary_Address_Street_3 String False

The third line of the primary addrss.

Primary_Address_City String False

The city for the primary address.

Primary_Address_State String False

The state for the primary address.

Primary_Address_Postalcode String False

The postal code for the primary address.

Primary_Address_Country String False

The country for the primary address.

Alt_Address_Street String False

The street address for the alternate address.

Alt_Address_Street_2 String False

The second line of the alternate address.

Alt_Address_Street_3 String False

The third line of the alternate address.

Alt_Address_City String False

The city for the alternate address.

Alt_Address_State String False

The state for the alternate address.

Alt_Address_Postalcode String False

The postal code for the alternate address.

Alt_Address_Country String False

The country for the alternate address.

Assistant String False

The name of the assistant of the prospect.

Assistant_Phone String False

The phone number of the assistant of the prospect.

Picture String False

The picture for the prospect.

Tracker_Key Int True

The key for the associated tracker.

Birthdate Datetime False

The birthdate of the prospect.

Lead_Id String False

The Id of the associated lead.

Account_Name String False

The name of the associated acocunt.

Campaign_Id String False

Campaign that generated the lead.

Dnb_Principal_Id String False

The Id for the D. and B. Contact.





Quotas

Create, update, delete, and query the Quotas module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the quota.

User_Id String False

The user Id of the quota.

Assigned_User_Id String False

The Id of the user assigned to the quota.

User_Name String False

The user name of the user assigned to the quota.

User_Full_Name String False

The full name of the user assigned to the quota.

Timeperiod_Id String False

The Id of the time period.

Quota_Type String False

The type of the quota.

Amount Double False

The amount of the quota.

Amount_Base_Currency Double False

The base currency of the amount.

Currency_Id String False

The Id of the currency.

Base_Rate Decimal False

The base rate of the currency.

Currency_Symbol String False

The symbol of the currency.

Committed Bool False

Whether the quota is committed.

Modified_User_Id String False

The Id of the user who modified the record.

Created_By String False

The Id of the user who created the record.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Deleted Bool False

Whether the record is deleted.

Name String False

The name of the record.





Quotes

Create, update, delete, and query the Quotes module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is the favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the quote.

Name String False

The name of the quote.

Date_Entered Datetime True

Date the record was created.

Date_Modified Datetime True

Date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The user name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The user name of the user who created the record

Doc_Owner String False

The document owner.

User_Favorites String False

The favorites of the user.

Description String False

The full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The user Id assigned to the record.

Assigned_User_Name String False

The name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Shipper_Id String False

The Id of the shipper.

Shipper_Name String False

The name of the shipper.

Currency_Id String False

The Id of the currency.

Base_Rate Decimal False

The base rate.

Taxrate_Id String False

The Id of the tax rate.

Show_Line_Nums Bool False

Whether to show the line numbers of the quote.

Calc_Grand_Total Bool False

The grand total of the quote.

Quote_Type String False

The type of the quote.

Date_Quote_Expected_Closed Datetime False

The expected close date of the quote.

Original_Po_Date Datetime False

The original PO date

Payment_Terms String False

The payment terms.

Date_Quote_Closed Datetime False

The close date of the quote.

Date_Order_Shipped Datetime False

The ship date of the order.

Order_Stage String False

The stage of the order

Quote_Stage String False

The stage of the quote.

Purchase_Order_Num String False

The purchase order number.

Quote_Num Int True

The quote number.

Subtotal Double False

The subtotal of the quote.

Subtotal_Usdollar Double False

The subtotal of the quote in USD.

Shipping Double False

The shipping cost.

Shipping_Usdollar Double False

The shipping cost in USD.

Discount Double False

The discount amount.

Deal_Tot Double False

The deal total.

Deal_Tot_Usdollar Double False

The deal total in USD.

New_Sub Double False

The new subtotal.

New_Sub_Usdollar Double False

The new subtotal in USD.

Tax Double False

The tax amount.

Tax_Usdollar Double False

The tax amount in USD.

Total Double False

The total.

Total_Usdollar Double False

The total in USD.

Billing_Address_Street String False

The street of the billing address.

Billing_Address_City String False

The city used for the billing address.

Billing_Address_State String False

The state used for the billing address.

Billing_Address_Postalcode String False

The postal code used for the billing address.

Billing_Address_Country String False

The country used for the billing address.

Shipping_Address_Street String False

The street address used for for shipping purposes.

Shipping_Address_City String False

The city used for the shipping address.

Shipping_Address_State String False

The state used for the shipping address.

Shipping_Address_Postalcode String False

The ZIP code used for the shipping address.

Shipping_Address_Country String False

The country used for the shipping address.

System_Id Int False

The system Id.

Shipping_Account_Name String False

The shipping account name.

Shipping_Account_Id String False

The shipping account Id.

Shipping_Contact_Name String False

The shipping contact name.

Shipping_Contact_Id String False

The shipping contact Id.

Account_Name String False

The account name.

Account_Id String False

The account Id.

Billing_Account_Name String False

The billing account name.

Billing_Account_Id String False

The billing account Id.

Billing_Contact_Name String False

The billing contact name.

Billing_Contact_Id String False

The billing contact Id.

Opportunity_Name String False

The opportunity name.

Opportunity_Id String False

The opportunity Id.





Releases

Create, update, delete, and query the Releases module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the record.

Deleted Bool False

Whether the record is deleted.

Date_Entered Datetime False

The date the record was entered.

Date_Modified Datetime False

The date the record was last modified.

Modified_User_Id String False

The Id of the user who last modified the record.

Created_By String False

The Id of the user who created the record.

Name String False

The name of the release.

List_Order Int False

The relative order in the drop-down list.

Status String False

The status of the record.





ReportMaker

This is a table representing the ReportMaker module in SugarCRM.

Columns

Name Type ReadOnly Description
Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

The unique identifier of the report maker.

Deleted Bool False

Whether the record is deleted.

Date_Entered Datetime False

The entered date of the record.

Date_Modified Datetime False

The modified date of the record.

Modified_User_Id String False

The Id of the user who last modified the record.

Created_By String False

The Id of the user who created the record.

Name String False

The name of the report maker.

Title String False

The title of the report maker.

Report_Align String False

The alignment of the report.

Description String False

The report description.

Scheduled Bool False

Whether the report is scheduled.





Reports

This is a table representing the Reports module in SugarCRM.

Columns

Name Type ReadOnly Description
Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

The unique identifier of the report.

Name String False

The name of the report.

Module String False

The module the report belongs to.

Report_Type String False

The report type.

Content String False

The content of the report.

Deleted Bool False

Whether the record is deleted.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Assigned_User_Id String False

The Id of the user assigned to the record.

Modified_User_Id String False

The Id of the user who last modified the record.

Assigned_User_Name String False

The name of the user assigned to the record.

Created_By String False

The Id of the user who created the record.

Is_Published Bool False

Whether the report is published.

Last_Run_Date String False

The last run date of the report.

Chart_Type String False

The chart type of the report.

Schedule_Type String False

The schedule type of the report.

Favorite Bool False

Whether the report is a favorite of the user.





Reports_1

This is a table representing the Reports module in SugarCRM.

Columns

Name Type ReadOnly Description
Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

The unique identifier of the report.

Name String False

The name of the report.

Module String False

The module the report belongs to.

Report_Type String False

The report type.

Content String False

The content of the report.

Deleted Bool False

Whether the record is deleted.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Assigned_User_Id String False

The Id of the user assigned to the record.

Modified_User_Id String False

The Id of the user who last modified the record.

Assigned_User_Name String False

The name of the user assigned to the record.

Created_By String False

The Id of the user who created the record.

Is_Published Bool False

Whether the report is published.

Last_Run_Date String False

The last run date of the report.

Chart_Type String False

The chart type of the report.

Schedule_Type String False

The schedule type of the report.

Favorite Bool False

Whether the report is a favorite of the user.





RevenueLineItems

This is a table representing the RevenueLineItems module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is the favorite for the user.

Following Bool False

Whether the user is following the record.

Id [KEY] String False

The unique identifier of the revenue line item.

Name String False

The name of the revenue line item.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The favorites of the user.

Description String False

The full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The user Id assigned to the record.

Assigned_User_Name String False

The name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Product_Template_Id String False

The Id of the product (in Admin Products) from which this product is derived (in user Products).

Product_Template_Name String False

The name of the product (in Admin Products) from which this product is derived (in user Products).

Account_Id String False

Account this product is associated with.

Total_Amount Double False

The total amount.

Type_Id String False

Product type (e.g., hardware or software).

Quote_Id String False

The Id of the quote the product is associated with.

Manufacturer_Id String False

The Id of the manufacturer of the product.

Manufacturer_Name String False

The name of the manufacturer of the product.

Category_Id String False

The Id of the product category.

Category_Name String False

The name of the product category.

Mft_Part_Num String False

Manufacturer part number.

Vendor_Part_Num String False

Vendor part number.

Date_Purchased Datetime False

Date product purchased.

Cost_Price Double False

Product cost (Cost in Quote).

Discount_Price Double False

Discounted price (Unit Price in Quote).

Discount_Amount Double False

Discounted amount.

Discount_Rate_Percent Decimal False

Discount rate percent.

Discount_Amount_Usdollar Decimal True

Discount amount in USD.

Discount_Select Bool False

Select discount.

Deal_Calc Double False

The calculated deal.

Deal_Calc_Usdollar Double True

The calculated deal in USD.

List_Price Double False

List price of product (List in Quote).

Cost_Usdollar Double True

Cost expressed in USD.

Discount_Usdollar Double True

Discount price expressed in USD.

List_Usdollar Double True

List price expressed in USD.

Currency_Id String False

Currency of the product.

Base_Rate Decimal False

The base rate.

Status String False

Product status (e.g., Quoted, Ordered, or Shipped).

Tax_Class String False

Tax classification (e.g., Taxable or Non-taxable).

Website String False

Product URL.

Weight Decimal False

Weight of the product.

Quantity Decimal False

Quantity in use.

Support_Name String False

Name of product for support purposes.

Support_Description String False

Description of product for support purposes.

Support_Contact String False

Contact for support purposes.

Support_Term String False

Term (length) of support contract.

Date_Support_Expires Datetime False

Support expiration date.

Date_Support_Starts Datetime False

Support start date.

Pricing_Formula String False

Pricing formula (e.g., Fixed or Markup over Cost).

Pricing_Factor Int False

Variable pricing factor depending on pricing_formula.

Serial_Number String False

Serial number of product in use.

Asset_Number String False

Asset tag number of product in use.

Book_Value Double False

Book value of product in use.

Book_Value_Usdollar Double True

Book value expressed in USD.

Book_Value_Date Datetime False

Date of book value for product in use.

Best_Case Double False

The most optimistic scenario.

Likely_Case Double False

The likely scenario.

Worst_Case Double False

The least optimistic scenario.

Date_Closed Datetime False

Expected or actual date the product (for opportunity) will close.

Date_Closed_Timestamp Int False

The timestamp of the close date for the opportunity.

Next_Step String False

The next step in the sales process.

Commit_Stage String False

Forecast commit category: Include, Likely, Omit etc.

Sales_Stage String False

Indication of progression towards closure.

Probability Int False

The probability of closure.

Lead_Source String False

Source of the product.

Campaign_Id String False

The campaign that generated the lead.

Campaign_Name String False

The name of the campaign.

Currency_Name String False

The name of the currency.

Currency_Symbol String False

The symbol of the currency.

Quote_Name String False

Quote Name.

Opportunity_Id String False

The Id of the opportunity for the line item entry.

Opportunity_Name String False

The name of the opportunity for the line item entry.

Product_Type String False

Type of product from the opportunity type. For example: Existing or New.

Type_Name String False

The type name.

Account_Name String False

The account name.





Roles

This is a table representing the Roles module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the role.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Modified_User_Id String False

The Id of the user who last modified the record.

Created_By String False

The Id of the user who created the record.

Name String False

The name of the role.

Description String False

The description of the role.

Modules String False

The modules associated with the role.

Deleted Bool False

Whether the record is deleted.





SavedSearch

This is a table representing the SavedSearch module in SugarCRM.

Columns

Name Type ReadOnly Description
Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

The unique identifier of the saved search.

Name String False

The name of the saved search.

Search_Module String False

The search module.

Deleted Bool False

Whether the record is deleted.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The name of the user assigned to the record.

Contents String False

The contents of the saved search.

Description String False

The description of the saved search.





Schedulers

This is a table representing the Schedulers module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is the favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the scheduler.

Name String False

The name of the scheduler.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The favorites of the user.

Description String False

The full text of the note.

Deleted Bool False

The record deletion indicator.

Job String False

The job.

Job_Url String False

The job URL.

Job_Function String False

The job function.

Date_Time_Start String False

The start date and time.

Date_Time_End String False

The end date and time.

Job_Interval String False

The job interval.

Adv_Interval Bool False

Whether there are advanced options for the interval.

Time_From String False

The time the scheduler begins to be active per day.

Time_To String False

Time the scheduler stops being active per day.

Last_Run Datetime False

The last run time of the scheduler.

Status String False

The status of the scheduler.

Catch_Up Bool False

Whether the scheduler will catch up.





Shippers

This is a table representing the Shippers module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the shipper.

Deleted Bool False

Whether the record is deleted.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Modified_User_Id String False

The Id of the user who last modified the record.

Created_By String False

The Id of the user who created the record.

Name String False

The name of the shipper.

List_Order Int False

The relative order in the drop-down list.

Default_Cost Double False

Default cost (Shown).

Default_Cost_Usdollar Decimal True

The default cost in USD.

Status String False

The status of the shipper.





Styleguide

This is a table representing the Styleguide module in SugarCRM.

Columns

Name Type ReadOnly Description
Email String False

The email address for the style guide.

Email1 String False

The alternate email address for the style guide.

Email2 String False

The alternate email address for the style guide.

Invalid_Email Bool False

Whether the email address for the style guide is marked as invalid.

Email_Opt_Out Bool False

Whether the contact for the style guide has opted out of email.

Email_Addresses_Non_Primary String False

The nonprimary email addresses for the contact of the style guide.

Salutation String False

Contact salutation (e.g., Mr. or Ms.).

First_Name String False

First name of the contact.

Last_Name String False

Last name of the contact.

Name String False

The name of the contact.

Full_Name String False

The full name of the contact.

Title String False

Title of the Styleguide page.

Facebook String False

The Facebook name of the user.

Twitter String False

The Twitter name of the user

Googleplus String False

The Google Plus Id of the user

Department String False

The department of the contact.

Do_Not_Call Bool False

Whether or not to allow calls to contact.

Phone_Home String False

The home phone number of the contact.

Phone_Mobile String False

The mobile phone number of the contact.

Phone_Work String False

The work phone number of the contact.

Phone_Other String False

Other phone number for the contact.

Phone_Fax String False

Contact fax number.

Primary_Address_Street String False

The street address used for the primary address.

Primary_Address_Street_2 String False

The second line of the primary street address.

Primary_Address_Street_3 String False

The third line of the primary street address.

Primary_Address_City String False

The city of the primary address.

Primary_Address_State String False

The state of the primary address.

Primary_Address_Postalcode String False

The postal code for primary address.

Primary_Address_Country String False

The country for primary address.

Alt_Address_Street String False

The alternate street address.

Alt_Address_Street_2 String False

The second line of the alternate street address.

Alt_Address_Street_3 String False

The third line of the alternate street address.

Alt_Address_City String False

The city of the alternate address.

Alt_Address_State String False

The state of the alternate address

Alt_Address_Postalcode String False

The postal code for the alternate address.

Alt_Address_Country String False

The country for the alternate address.

Assistant String False

Name of the assistant of the contact.

Assistant_Phone String False

Phone number of the assistant of the contact.

Picture String False

Image to be used as an avatar.

My_Favorite Bool False

Favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the style guide.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

User_Favorites String False

The favorites of the user.

Description String False

The full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The user Id assigned to the record.

Assigned_User_Name String False

The name of the user assigned to the record.

Parent_Type String False

The parent Sugar module.

Parent_Id String False

The Id of the parent Sugar module.

Parent_Name String False

The name of the parent Sugar module.

File_Mime_Type String False

Attachment MIME type.

File_Url String False

Path to file (can be URL).

Filename String False

File name associated with the note (attachment).

Currency_Id String False

Currency of the product.

List_Price Double False

List price of product (List in Quote).

Website String False

URL of the website for the company.

Birthdate Datetime False

The birthdate of the contact.

Secret_Password String False

The secret password.

User_Email String False

The email address of the user.

Date_Start String False

The start date.

Radio_Button_Group String False

The radio button group.





Subscriptions

This is a table representing the Subscriptions module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is the favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the company.

Name String False

The name of the company.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The favorites of the user.

Description String False

The full text of the note.

Deleted Bool False

The record deletion indicator.

Parent_Type String False

The type of the parent Sugar item.

Parent_Id String False

The Id of the parent Sugar item.





SugarFavorites

This is a table representing the SugarFavorites module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is the favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the record.

Name String False

The name of the record.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The favorites of the user.

Description String False

The full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The user Id assigned to the record.

Assigned_User_Name String False

The name of the user assigned to the record.

Module String False

The module of the favorite.

Record_Id String False

The Id of the record marked as a favorite.

Record_Name String False

The name of the record marked as a favorite.





Tasks

This is a table representing the Tasks module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is the favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the record.

Name String False

The name of the task.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The favorites of the user.

Description String False

The full text of the note.

Deleted Bool False

The record deletion indicator.

Assigned_User_Id String False

The Id of the user assigned to the record.

Assigned_User_Name String False

The name of the user assigned to the record.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Status String False

The status of the task.

Date_Due_Flag Bool False

Whether the task has a due date.

Date_Due String False

The due date of the task.

Time_Due Datetime False

The time the task is due.

Date_Start_Flag Bool False

Whether the flag has a start date.

Date_Start String False

The start date of the task.

Parent_Type String False

The type of the Sugar item to which the call is related.

Parent_Name String False

The name of the Sugar item to which the call is related.

Parent_Id String False

The Id of the Sugar item to which the call is related.

Contact_Id String False

The Id of the associated contact.

Contact_Name String False

The name of the associated contact.

Contact_Phone String True

The phone of the associated contact.

Contact_Email String False

The email of the associated contact.

Priority String False

The priority of the task.





TaxRates

This is a table representing the TaxRates module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the tax rate.

Deleted Bool False

Whether the record is deleted.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Modified_User_Id String False

The Id of the user who last modified the record.

Created_By String False

The Id of the user who created the record.

Name String False

The name of the tax rate.

Value Decimal False

The value of the tax rate.

List_Order Int False

The relative order in the drop-down list.

Status String False

The status of the tax rate.





TeamNotices

This is a table representing the TeamNotices module in SugarCRM.

Columns

Name Type ReadOnly Description
Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Id [KEY] String False

The unique identifier of the team notice.

Deleted Bool False

The record deletion indicator.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Date_Start Datetime False

The start date of the team notice.

Date_End Datetime False

The end date of the team notice.

Modified_User_Id String False

The Id of the user who last modified the record.

Created_By String False

The Id of the user who created the record.

Name String False

The name of the team notice.

Description String False

The description of the team notice.

Status String False

The status of the team notice.

Url String False

The URL of the team notice.

Url_Title String False

The URL title of the team notice.





Teams

This is a table representing the Teams module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is the favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the team.

Name String False

The name of the team.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The favorites of the user.

Description String False

The full text of the note.

Deleted Bool False

The record deletion indicator.

Name_2 String False

The additional name part for the team.

Associated_User_Id String False

The Id of the user associated with the team.

Private Bool False

Whether the team is private.





TimePeriods

This is a table representing the TimePeriods module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the time period.

Name String False

The name of the time period.

Parent_Id String False

The Id of the parent Sugar module.

Start_Date Datetime False

The start date of the time period.

Start_Date_Timestamp Int False

The start date timestamp of the time period.

End_Date Datetime False

The end date of the time period.

End_Date_Timestamp Int False

The end date timestamp of the time period.

Created_By String False

The Id of the user who created the record.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Deleted Bool False

The record deletion indicator.

Is_Fiscal Bool False

Whether the time period is a fiscal time period.

Is_Fiscal_Year Bool False

Whether the time period is a fiscal year.

Leaf_Cycle Int False

The leaf cycle of the time period.

Type String False

The type of time Period to be forecast over.





TrackerPerfs

This is a table representing the TrackerPerfs module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] Int False

The unique identifier of the record.

Monitor_Id String False

The Id of the monitor.

Server_Response_Time Double False

The response time of the server.

Db_Round_Trips Int False

The round trips to the database.

Files_Opened Int False

The number of files opened.

Memory_Usage Int False

The memory usage.

Deleted Bool False

Record deletion indicator.

Date_Modified Datetime False

The last date the record was modified.





TrackerQueries

This is a table representing the TrackerQueries module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] Int False

The unique identifier of the record.

Query_Id String False

The Id of the query.

Text String False

The text of the tracker query.

Query_Hash String False

The query hash.

Sec_Total Double False

The total seconds for the query to execute.

Sec_Avg Double False

The average time in seconds for the query to execute.

Run_Count Int False

The run count of the query.

Deleted Bool False

Record deletion indicator.

Date_Modified Datetime False

The last time the record was modified.





Trackers

This is a table representing the Trackers module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] Int True

The unique identifier of the record.

Monitor_Id String False

The Id of the monitor.

User_Id String False

The Id of the user associated with the tracker.

Module_Name String False

The name of the associated module.

Item_Id String False

The name of the associated item.

Item_Summary String False

The summary of the associated item.

Team_Id String False

The Id of the primary team.

Date_Modified Datetime False

The last date the record was modified.

Action String False

The tracked action.

Session_Id String False

The session Id.

Visible Bool False

Whether the action is visible.

Deleted Bool False

Record deletion indicator.





TrackerSessions

This is a table representing the TrackerSessions module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] Int False

The unique identifier of the tracker session.

Session_Id String False

The Id of the tracked session.

Date_Start Datetime False

The start date of the tracked session.

Date_End Datetime False

The end date of the tracked session.

Seconds Int False

The tracked seconds.

Client_Ip String False

The tracked client IP.

User_Id String False

The tracked user Id.

Active Bool False

Whether the session is active.

Round_Trips Int False

The number of round trips.

Deleted Bool False

Record deletion indicator.





Users

This is a table representing the Users module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the user.

User_Name String False

The user name of the user.

User_Hash String False

The hash for the user.

System_Generated_Password Bool False

Whether the user has a system-generated password.

Pwd_Last_Changed Datetime False

The date and time the password was last changed.

Authenticate_Id String False

The authentication Id.

Sugar_Login Bool False

Whether Sugar login is enabled for the user.

Picture String False

The picture for the user.

First_Name String False

The first name of the user.

Last_Name String False

The last name of the user.

Full_Name String False

The full name of the user.

Name String False

The name of the user.

Is_Admin Bool False

Whether the user is an admin.

External_Auth_Only Bool False

Whether only external authentication is enabled for the user.

Receive_Notifications Bool False

Whether the user can receive notifications.

Description String False

The description for the user.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Last_Login Datetime True

The last login time of the user.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Title String False

The title of the user.

Department String False

The department of the user.

Phone_Home String False

The home phone number of the user.

Phone_Mobile String False

The mobile phone number of the user.

Phone_Work String False

The work phone number of the user.

Phone_Other String False

The alternate phone number of the user.

Phone_Fax String False

The fax of the user.

Status String False

The status of the user.

Address_Street String False

The street address of the user.

Address_City String False

The city in the address.

Address_State String False

The state in the address.

Address_Country String False

The country in the address.

Address_Postalcode String False

The ZIP code in the address.

UserType String False

The type of the user.

Default_Team String False

The default team for the user.

Team_Id String False

The Id of the primary team.

Team_Set_Id String False

The Id of the team set.

Team_Count String False

The count of the team set.

Team_Name String False

The name of the primary team.

Deleted Bool False

The record deletion indicator.

Portal_Only Bool False

Whether the user is portal only.

Show_On_Employees Bool False

Whether the user is shown on the employees tab.

Employee_Status String False

The status of the employee.

Messenger_Id String False

The Id of the messenger.

Messenger_Type String False

The type of the messenger.

Reports_To_Id String False

The Id of the manager of the user.

Reports_To_Name String False

The name of the manager of the user.

Email1 String False

The alternate email address of the user.

Email String False

The email address of the user.

Email_Link_Type String False

The link type of the email.

Is_Group Bool False

Whether the user is a group.

C_Accept_Status_Fields String False

The fields for the accept status of the call.

M_Accept_Status_Fields String False

The fields for the accept status of the meeting.

Accept_Status_Id String False

The Id of the accept status.

Accept_Status_Name String False

The name of the accept status.

Accept_Status_Calls String False

The accept status for calls.

Accept_Status_Meetings String False

The accept status for meetings.

Preferred_Language String False

The preferred language of the user.





UserSignatures

This is a table representing the UserSignatures module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is the favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier of the user signature.

Name String False

The name of the user signature.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The favorites of the user.

Description String False

The full text of the note.

Deleted Bool False

The record deletion indicator.

User_Id String False

The Id of the associated user.

Signature String False

The signature.

Signature_Html String False

The HTML signature.





WebLogicHooks

This is a table representing the WebLogicHooks module in SugarCRM.

Columns

Name Type ReadOnly Description
My_Favorite Bool False

Whether the record is the favorite for the user.

Following Bool False

Whether the user is following this record.

Id [KEY] String False

The unique identifier for the Web logic hook.

Name String False

The name of the Web logic hook.

Date_Entered Datetime True

The date the record was created.

Date_Modified Datetime True

The date the record was last modified.

Modified_User_Id String True

The Id of the user who last modified the record.

Modified_By_Name String True

The name of the user who last modified the record.

Created_By String True

The Id of the user who created the record.

Created_By_Name String True

The name of the user who created the record.

Doc_Owner String False

The document owner.

User_Favorites String False

The favorites of the user.

Description String False

The full text of the note.

Deleted Bool False

The record deletion indicator.

Webhook_Target_Module String False

The target module of the Web logic hook.

Request_Method String False

The request method.

Url String False

URL of website for the company.

Trigger_Event String False

The trigger event.





WorkFlow

This is a table representing the WorkFlow module in SugarCRM.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the work flow.

Deleted Bool False

The record deletion indicator.

Date_Entered Datetime False

The date the record was created.

Date_Modified Datetime False

The date the record was last modified.

Modified_User_Id String False

The Id of the user who last modified the record.

Created_By String False

The Id of the user who created the record.

Name String False

The name of the work flow.

Base_Module String False

The base module of the work flow.

Status Bool False

The status of the work flow.

Description String False

The description for the work flow.

Type String False

The type of the work flow.

Fire_Order String False

The fire order of the work flow.

Parent_Id String False

The Id of the parent Sugar module.

Record_Type String False

The record type.

List_Order_Y Int False

The list order of the data set.