Skip to main content

Quickbooks Desktop Source Connector

The Quickbooks Desktop source connector in DataSync lets you retrieve data from QuickBooks Desktop for loading or synchronizing in your data warehouse. Before you set up the connection, ensure that DataSync is installed with HTTPS enabled and that you have a QuickBooks Desktop account with administrative permissions.

After creating all required source connections, configure your destination source to complete the connection setup.

Create a source connection in DataSync

  1. Log in to DataSync.
  2. From the welcome screen, select Connections.
  3. Next to Source Connections, click New.
  4. Select Quickbooks Desktop.
  5. In the Connection Properties panel, enter the connection properties.
  6. (Optional) In the Additional Connection Properties panel, select Add property and enter the parameters for each property.
  7. In the Advanced Settings panel, configure the settings, including the Tracking Type and other values according to your requirements.
  8. Click Save.

Parameters

Connection properties

ParameterDescription
DescriptionUnique name for the connection. Example: Quickbooks Desktop.
URLAddress of the remote connector used to connect to the QuickBooks instance.
Example: https://server.company.com:8335
Custom fields formatFormat used for custom field data returned by QuickBooks:

  • JSON – Formats data in JavaScript Object Notation.
  • XML – Formats data as Extensible Markup Language.
Delay After CloseDelay, in milliseconds, applied each time a QuickBooks connection is closed. Default: 30000 (30 seconds).
Quickbooks XML versionVersion of the QuickBooks XML (“QBXML”) used in outgoing SDK messages. This applies only to the Desktop Edition. Each QuickBooks release is tied to specific SDK versions:
  • 1.0 – QuickBooks 2002
  • 2.0 – QuickBooks 2003
  • 3.0 – QuickBooks 2004
  • ...continued through 13.0 – QuickBooks 2014
  • CA2.0 – QuickBooks Canadian 2003
  • CA3.0 – QuickBooks Canadian 2004–2007
  • UK2.0 – QuickBooks UK 2003
  • UK3.0 – QuickBooks UK 2004–2007
  • OZ2.0 – QuickBooks Australian 2003
  • AU3.0 – QuickBooks Australian 2004–2007
Earlier SDK versions remain supported in later releases, but new SDK features are only available in newer versions. Recommended value: match the QBXML version to the QuickBooks version you are using. Select from the dropdown list:
  • QBDEFAULT (Default)
  • Specific version options, as listed above.
UsernameQuickBooks Desktop account username.
PasswordPassword for the specified username.
Verbosity
  • 1 – Log queries, row counts, execution start/end, errors.
  • 2 – Includes level 1 plus cache queries, HTTP headers.
  • 3 – Includes level 2 plus request/response bodies.
  • 4 – Includes level 3 plus transport-level communication.
  • 5 – Includes level 4 plus all interface commands.
Enable PoolingConnection pooling option for performance.
Pool idle timeoutMaximum idle time for connections before returning them to the pool, in seconds.
Max Pool SizeMaximum number of connections allowed in the pool.
Pool wait timeMaximum wait time for connection allocation before error is thrown, in seconds.

Additional connection properties

Additional connection string properties not specified in the Connection Properties panel. For each property added, you can choose Visible or Encrypted. Selecting Encrypted hides the value from the interface and stores it encrypted in the back end, such as when defining passwords.

ParameterDescription
PropertyConnection string property that defines the action or behavior. Example: ReadOnly
ValueValue for the property. Example: True
TypeVisibility of the property: Visible or Encrypted.

Advanced settings

Advanced settings control how the Quickbooks Desktop connector tracks changes, handles regional and time configuration, and processes data batches during extraction. These options allow fine‑tuning for performance and accuracy, and should be configured according to your system environment and operational requirements.

SettingDescription
Tracking TypeMethod for tracking changes: None or Date.
RegionRegion setting for the connector, if required by your setup.
Time ZoneTime zone matching the Quickbooks Desktop application server.
Time OffsetRefresh offset in seconds to compensate for timing issues in record selection. Minimum value is 0; maximum is 3600 seconds.
Batch SizeQuantity of records processed in each batch during extraction. Larger batch sizes increase memory usage but can improve performance up to a point. The default value is 2000 and the maximum should not exceed 10000 records. Adjust according to your network speed and disk performance; in most cases the default (2000) works best.

Example