Connection String Options
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Basic Tab.
| Property | Description |
| CompanyFile | Specifies the QuickBooks company file the provider uses during the connection. |
| ApplicationName | Specifies the name of the application connecting to QuickBooks. |
| Property | Description |
| User | Specifies the username required to authenticate the connection to the QuickBooks Gateway. |
| Password | Specifies the password required to authenticate with the QuickBooks Gateway. |
| URL | Specifies the URL where the QuickBooks Gateway is running. This is the endpoint the driver uses to communicate with QuickBooks Desktop. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| Property | Description |
| CustomFieldMode | Specifies the format used to display custom fields in the data. Choose between the traditional XML format for compatibility with older systems or the compact JSON format for modern tools and databases. |
| DelayAfterClose | Specifies the delay, in milliseconds, applied after closing a connection to QuickBooks. |
| IncludeLineItems | Specifies whether to include Line Item details when retrieving base transactions, such as invoices, from QuickBooks. |
| IncludeLinkedTxns | Specifies whether to include Linked Transactions when retrieving base transactions, such as invoices, from QuickBooks. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from QuickBooks. |
| QBXMLVersion | Specifies the version of QBXML used in outgoing messages for interacting with QuickBooks Desktop Edition. |
| Readonly | Toggles read-only access to QuickBooks from the provider. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UseRDS | Specifies whether the provider connects to QuickBooks using Remote Data Sharing (RDS). This setting is incompatible with connections made through the QuickBooks Gateway. |