ODBC Driver for QuickBooks

Build 25.0.9434

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection settings for this provider.


PropertyDescription
BatchSizeSpecifies the maximum number of rows included in each batch submitted during batch operations. To submit the entire batch as a single request, set BatchSize to 0 .
ConnectDirectlySpecifies whether to connect directly to QuickBooks without using the QuickBooks Gateway. Use this property for direct communication with QuickBooks under specific conditions, such as matching application bitness and user permissions.
ConnectOnOpenSpecifies whether the provider establishes a connection to QuickBooks immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary.
CustomFieldModeSpecifies 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.
DefaultDomainThis property is used for the Oracle Database Gateway for ODBC.
DelayAfterCloseSpecifies the delay, in milliseconds, applied after closing a connection to QuickBooks.
EnableForeignKeyDetectionWhether to detect the foreign keys in ODBC.
IncludeDualTableSet this property to mock the Oracle DUAL table for better compatibility with Oracle database.
IncludeLineItemsSpecifies whether to include Line Item details when retrieving base transactions, such as invoices, from QuickBooks.
IncludeLinkedTxnsSpecifies whether to include Linked Transactions when retrieving base transactions, such as invoices, from QuickBooks.
LimitKeySizeThe maximum length of a primary key column.
MapBigintToVarcharThis property controls whether or not the bigint type maps to SQL_VARCHAR instead of SQL_BIGINT. This property is false by default.
MapToIntThis property controls whether or not the long type maps to SQL_INTEGER instead of SQL_BIGINT. This property is false by default.
MapToLongVarcharThis property controls whether or not a column is returned as SQL_LONGVARCHAR.
MapToWVarcharThis property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. This property is set by default.
MaximumColumnSizeThe maximum column size.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies 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.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from QuickBooks.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
QBXMLVersionSpecifies the version of QBXML used in outgoing messages for interacting with QuickBooks Desktop Edition.
ReadonlyToggles read-only access to QuickBooks from the provider.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UpperCaseIdentifiersThis property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UseRDSSpecifies whether the provider connects to QuickBooks using Remote Data Sharing (RDS). This setting is incompatible with connections made through the QuickBooks Gateway.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434