Getting started with Devart ODBC Driver for QuickBooks Desktop
To connect ODBC-compatible applications to QuickBooks Desktop, you need an ODBC Driver and a QuickBooks Desktop company file.
Devart ODBC Driver for QuickBooks Desktop enables high-performance access to QuickBooks Desktop data from Windows-based applications and tools. The Driver connects BI and reporting platforms, IDEs, spreadsheets, programming environments, and other ODBC-compatible applications to QuickBooks Desktop, allowing you to access and manage data stored in QuickBooks Desktop using standard SQL.
This guide shows you how to install and activate the Driver, configure an ODBC data source (DSN), connect to QuickBooks Desktop using a DSN or connection string, and troubleshoot common connection issues.
Quick start: Connect to QuickBooks Desktop with ODBC
To connect to QuickBooks Desktop using the Devart ODBC Driver:
- Download and install the Driver.
- Activate the Driver using your activation key, or continue with the 30-day trial.
- Create an ODBC data source (DSN) and select Devart ODBC Driver for QuickBooks Desktop.
- Select the company file you want to connect to.
- Use the DSN in your ODBC-compatible application to access QuickBooks Desktop and work with its data.
The following sections provide detailed instructions for installing and configuring the ODBC Driver.
Prerequisites
Before you begin, make sure your environment meets the following requirements:
- Operating system: Windows Vista or later (32-bit or 64-bit), including Windows Terminal Server.
- Data source: Path to a QuickBooks Desktop company file.
- Activation key: For a purchased version of the Driver or a full-featured 30-day trial, use the activation key you received in the registration email or through the Customer Portal.
- Administrator rights: Required to install the Driver.
For a complete list of supported platforms and third-party tools, see the ODBC Driver for QuickBooks Desktop compatibility page.
Install the Driver
Installing the Devart ODBC Driver for QuickBooks Desktop is straightforward. All you need to do is download the package and follow the installation instructions.
1. Download the ODBC Driver for QuickBooks Desktop from the Devart website, open it, and click Next.
2. Read the License Agreement, select I accept the agreement, and click Next.
3. On the Select Destination Location page, keep the default folder or click Browse to choose another one, and click Next.
4. On the Select Components page, select the components to install, then click Next.
5. On the Select Start Menu Folder page, specify the folder for the Driver shortcuts. To skip creating a Start Menu folder, select Don't create a Start Menu folder. Click Next, then click Install.
6. On the License Information page, select Input activation key and enter your key. You can find it in the registration email or your Customer Portal. To open the Customer Portal, click Get Activation Key.
If the activation key is saved on your computer, click Load Activation Key and select the corresponding file.
To evaluate the Driver without a purchased key, select Trial evaluation.
7. Click Next, then click Finish to complete the installation.
Configure an ODBC data source
In this guide, you create a Data Source Name (DSN) for the ODBC connection and verify the connection details. A DSN stores the path to the QuickBooks Desktop company file to which applications can connect using the Driver. Applications can also connect without a DSN by passing the same parameters in a connection string.
1. In Windows Search, enter ODBC Data Sources, and open the ODBC Data Source Administrator that matches the bitness of your application.
2. Select the User DSN, System DSN, or File DSN tab, and click Add:
- User DSN — Available only to the user who creates it.
- System DSN — Available to all users on the computer.
- File DSN — Stores connection settings in a file that can be shared between computers where the required ODBC driver is installed.
3. In the Create New Data Source dialog, select Devart ODBC Driver for QuickBooks Desktop, and click Finish.
4. In the Devart ODBC Driver for QuickBooks Desktop Configuration dialog, enter a Data Source Name and an optional Description.
5. In the Company File field, specify the direct path to the QuickBooks Desktop company file.
6. Optional: Click Test Connection to verify the connection settings.
7. Click OK to save the DSN settings.
To fine-tune metadata, timeout, and compatibility behavior, use the Advanced Settings tab of the same dialog.
Connect to QuickBooks Desktop using a connection string
In addition to using a DSN, you can connect to QuickBooks Desktop by specifying the connection parameters directly in an ODBC connection string. This type of connection is known as a DSN-less connection.
The following table summarizes when to use each connection method:
| Connection method | How it works | Best for |
|---|---|---|
| DSN | Stores the connection settings in a configured ODBC data source. Applications connect by specifying the DSN name. | Desktop applications, BI and reporting tools, and reusable connections configured on a client computer |
| DSN-less | Specifies the Driver and connection parameters directly in a connection string. No DSN needs to be created beforehand. | Applications, scripts, and automated deployments where connection settings are managed programmatically |
To create a DSN-less connection, configure the connection string as follows.
You can also specify advanced connection parameters to configure ODBC behavior, string types, and other Driver settings.
For the complete list of supported options, see QuickBooks Desktop ODBC connection string parameters.
Troubleshoot common issues
If you cannot connect to QuickBooks Desktop through the Devart ODBC Driver, use the following solutions to resolve common connection issues.
"Product is not activated or has been deactivated" error
This error occurs when the Driver has not been activated or its activation is no longer valid.
Open the DSN configuration dialog, go to the License tab, click Input Activation Key, and enter your activation key. After activation, test the connection again.
ODBC data source not found or Driver not available
If your application cannot find the DSN or the Devart ODBC Driver for QuickBooks Desktop, check the application and Driver bitness.
A 32-bit application cannot use a DSN created in the 64-bit ODBC Data Source Administrator, and a 64-bit application cannot use a DSN created in the 32-bit administrator.
Make sure that:
- The DSN is created in the ODBC administrator that matches your application's bitness.
- The corresponding 32-bit or 64-bit version of the Driver is installed.
- The application is configured to use the correct DSN.
Cannot connect to QuickBooks Desktop
If the Driver cannot reach QuickBooks Desktop, check the following:
- Verify that QuickBooks Desktop is installed and running.
- Try running QuickBooks Desktop in Single-User Mode.
Company file connection fails
If QuickBooks Desktop is reachable but the company file is not available, verify the company file settings:
- Make sure that the path to the company file is correct.
- Verify that the company file is open.
- Close other applications that may be using the company file.
- Check whether the company file is damaged; run company file verification and repair tools available in QuickBooks Desktop.
QuickBooks Desktop connection times out
If the connection takes too long to establish, increase Connection Timeout on the Advanced Settings tab. The default connection timeout is 60 seconds.
Additional resources
After you install and configure Devart ODBC Driver for QuickBooks Desktop, use the following resources to continue setting up and working with your connections:
- Connection string parameters — Browse the complete list of connection options for configuring the company file, timeouts, metadata retrieval, ODBC behavior, and other Driver settings.
- QuickBooks Desktop integrations — Find step-by-step guides for connecting BI, reporting, analytics, and other ODBC-compatible tools to QuickBooks Desktop.
- Using in third-party tools—ODBC Driver for QuickBooks Desktop — Connect to QuickBooks Desktop from various tools and applications written in Python, C#, C/C++, Go, Node.js, PHP, R, Visual Basic, and other supported languages.
- ODBC Driver for QuickBooks Desktop documentation — Explore installation, configuration, connectivity, and advanced Driver features.