Version 24.1.8910


You can use the QuickBooks connector from the CData Sync application to capture data from QuickBooks and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.


CData Sync makes requests to QuickBooks through the QuickBooks Gateway. The QuickBooks Gateway runs on the same machine as QuickBooks, and it accepts connections through a lightweight, embedded web server.

You need to perform the following procedure in order to connect to QuickBooks for the first time through the Desktop Gateway:

  1. Download the CData QuickBooks Desktop Gateway and install it on the machine where QuickBooks runs.

  2. Open the company file to which you want to connect in QuickBooks by using an administrator account in single-user mode.

  3. Open the CData QuickBooks Desktop Gateway from the system tray and add a user on the Users tab. Enter a user and a password. Then, select the level of access from the Data Access menu. Sync requires Read-only access.

  4. Click Test Connection. When you first connect, a dialog box opens in QuickBooks that prompts you to authorize the application. After you authorize it, you can execute commands to QuickBooks.

If you want to access QuickBooks when QuickBooks is not running, save the company-file information for the user. The Desktop Gateway opens QuickBooks automatically in the background with the company file for that user.

Note: If the QuickBooks UI is open, you can connect only to that company file. In addition, the user permissions that you specify for the Desktop Gateway must match the user permissions that you use for QuickBooks. The Desktop Gateway installs as a service in the current user account.

Add the QuickBooks Connector

To enable Sync to use data from QuickBooks, you first must add the connector, as follows:

  1. Open the Connections page of the Sync dashboard.

  2. Click Add Connection to open the Select Connectors page.

  3. Click the Sources tab and locate the QuickBooks row.

  4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the QuickBooks connector. For more information about installing new connectors, see Connections.

Authenticate to QuickBooks

After you add the connector, you need to set the required properties.

  • Connection Name - Enter a connection name of your choice.

  • User - Enter the username that you use to authenticate to the QuickBooks Gateway.

  • Password - Enter the password that you use to authenticate to the QuickBooks Gateway.

  • URL - Enter the URL for the QuickBooks Gateway (for example, http://localhost:8166).

Complete Your Connection

To complete your connection:

  1. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

  2. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and QuickBooks, see QuickBooks Connector for CData Sync.