> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sync.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# QuickBooks

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.

> [!NOTE]
>
> This connector is available in Sync Self-Hosted deployments only.

## Prerequisites

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](https://downloads.cdata.com/cdatabuilds/support/RemoteConnector.exe) 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 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:

<ol>
  <li>Open the **Connections** page of the Sync dashboard.</li>
  <li>Click **Add Connection** to open the **Select Connectors** page.</li>
  <li>Click the **Sources** tab and locate
  the **QuickBooks** row.</li>

  <li>
    Click the **Configure Connection** icon at the end of that row to open
    the **New Connection** page. This action opens the
    **Add Connection** dialog.

    **Note:** If the **Configure Connection** icon is not
    available, click the **Download Connector** icon to install
    the QuickBooks connector.
  </li>

  <li>Enter a name for your connection in the **Add Connection** dialog.</li>
  <li>Click **Add** to open the **Settings** tab for your connector.</li>
</ol>

For more information about installing new connectors, see
[Connections](https://docs.sync.cdata.com/26.4/en/connections/connections.md).

## Authenticate to QuickBooks

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

* **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](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](https://cdn.cdata.com/help/RQN/synch/default.htm).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.