QuickBooks Desktop (on-premise)

Learn about our QuickBooks Desktop on-premise connector.

Our QuickBooks Desktop on-premise connector enables SMBs who use QuickBooks Desktop to share their consented accounting data through the Codat platform.

The connector is a Windows application that runs on the SMB user's local machine.

Data type coverage

View the coverage of our QuickBooks Desktop on-premise connector in the Data Coverage Explorer.

🚧

Attachments not supported

Uploading and downloading Attachments to QuickBooks Desktop is not supported for any data type. This functionality is not supported by the QuickBooks SDK.

Features and benefits

Our connector provides a seamless and full featured integration to QuickBooks Desktop.

  • Runs in the background

    The connector runs as a background process and doesn't require any daily interaction by SMB users.

  • Auto restarts and updates

    The connector starts up automatically after a system reboot. And it updates silently in the background.

  • Auto and manual syncs

    Accounting data is synced automatically. SMB users can manually sync their data whenever they want to.

  • Intuitive user interface

    A connector UI enables manual syncs and advanced features, like adding connections to multiple companies.

Initial setup

Before your SMB users can download and install the on-premise connector, you'll need to perform the following tasks in the Codat Portal.

1. Add your branding

Add your company branding: this is used in the link flow and in the connector app.

From the SMB user's perspective, they'll see the connector app as being owned and branded by you, rather than by Codat.

2. Configure the link flow

You can choose to configure the built-in Codat link flow for the connector. This will create a download link for the connector and provide the unique company ID (used as the license key) for each of your SMB users.

Here's how that looks to your users:

Alternatively, you can choose to build this functionality yourself using the Codat API. This involves calling the QuickBooks Desktop connector download endpoint (provided in the data connection response) and the customer ID. This allows you to maintain the look and feel of your company's brand, or to implement a specific workflow.

3. Enable the connector

Enable the QuickBooks Desktop connector in the Codat Portal.

  1. Select Settings > Integrations > Accounting.
  2. Click Set up next to QuickBooks Desktop.
  3. Select the toggle to set the integration to Enabled.

SMB user flow

Here's how your SMB users interact with the QBD connector.

  • The SMB user downloads the connector as part of the link flow.
  • Initially, the connector installer requires administrator privileges (admin rights) to run.
  • The SMB user completes some simple steps to complete the installation (as described in Install the QuickBooks Desktop connector). In summary, they'll need to:
    • Enter their unique license number (their Codat Company ID), which is provided during the link flow.
    • Complete some steps to point the connector at the correct accounting package data file on their local machine.

When installed, the QBD connector doesn’t require any further interaction by the SMB user, and administrator privileges are no longer required.

The connector has a UI that is accessible from the system tray. Your SMB users do not usually need to interact with this, but there is functionality available for advanced users, such as adding connections to multiple companies, pausing syncs, and manually starting syncs.

System requirements

See QuickBooks Desktop requirements to learn about the supported versions of QuickBooks Desktop, and the hardware, software, environment and networking requirements for running the connector.

Install the connector

See Install the QuickBooks Desktop connector to learn how to set up and enable the connector.

📘

Installation in hosted environments

Installation on Right Networks hosted instances is currently available in beta.