QuickBooks Desktop (on-premise)
Learn about our QuickBooks Desktop on-premise connector
Our QuickBooks Desktop connector enables SMBsSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. who use QuickBooks Desktop to share their consented accounting data through the Codat platform, supporting the following ways of connecting to QBD:
- QuickBooks Desktop app
- QuickBooks Enterprise Cloud
- Rightworks
The connector utilizes the Intuit Web Connector, a Windows application that runs on the SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. user's local machine.
Uploading and downloading attachments to QuickBooks Desktop is not supported for any data type. This functionality is not supported by Intuit's own 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 SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. 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. SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. users can manually syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. their data whenever they want to.
Intuitive user interface
A connector UI enables manual syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. and advanced features, like adding connectionsConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. to multiple companies.
Initial setup
Before your SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. 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 companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. branding: this is used in the LinkLink The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat. flow.
From the SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. user's perspective, they'll see the connector app as being owned and branded by Intuit.
2. Enable the connector
Enable the QuickBooks Desktop connector in the Codat Portal.
- Select Settings > Integrations > Accounting.
- Click Set up next to QuickBooks Desktop.
- Select the toggle to set the integration to Enabled.
SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. user flow
Here's how your SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. users interact with the QBD connector.
- The user selects the way they connect QBD at the start of the flow. If they choose the
QuickBooks Desktop appoption, they will download the connector. Selecting any of the other options skips this step because hosted environments already have the web connector installed. - The user downloads and runs the connector installer. This requires the user to have administrator privileges (admin rights), or a different administrator to approve the installation and run the connector.
- The SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. user then downloads and runs the configuration file (as described in Install the QuickBooks Desktop connector). In summary, they'll need to:
- Authorise the connector to access the QuickBooks Desktop companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources..
- Enter the password into the connector, which is provided during the LinkLink The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat. flow.
When installed, the QBD connector doesn’t require any further interaction by the SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. user, and administrator privileges are no longer required.
The connector has a UI that is accessible from the system tray and the Start menu. Your SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. users do not usually need to interact with this, but there is functionality available for advanced users, such as adding connectionsConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. to multiple companies and adjusting auto-run timings.
Your SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. user isn't able to interact with QBD while the software is syncing data through the connector. This is due to QBD's own limitations and applies to all connectors and syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule..
Your user may need to pause a data syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. so that they can interact with QuickBooks Desktop. To support this, implement our Connections SDK that provides this functionality out of the box. See Pause the connector.
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.