Getting started with Devart ODBC Driver for QuickBooks Online
To connect ODBC-compatible applications to QuickBooks Online, you need an ODBC driver and access to QuickBooks Online.
Devart ODBC Driver for QuickBooks Online enables connectivity to QuickBooks Online on Windows, allowing BI and reporting tools, IDEs, spreadsheets, programming languages, and other ODBC-compatible applications to access its data using standard SQL. The Driver can connect directly via HTTPS or via a proxy, and it does not require additional client software.
This guide shows you how to install and activate the Driver, configure an ODBC data source (DSN), connect to QuickBooks Online using a DSN or connection string, and troubleshoot common connection issues.
Quick start: Connect to QuickBooks Online with ODBC
To connect to QuickBooks Online using the Devart ODBC Driver:
- Download and install the Driver for Windows.
- 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 Online.
- Configure the connection by signing in to your QuickBooks Online account.
- Use the DSN in your ODBC-compatible application to connect to QuickBooks Online and work with its data.
The following sections provide detailed installation and configuration instructions.
Prerequisites
Before you begin, make sure your environment meets the following requirements:
- Operating system: 32-bit or 64-bit Windows (including Windows Terminal Server). The Driver is compatible with all Windows versions (Windows Vista and later) that support .NET Framework 4.5.
- ODBC driver manager: Included with Windows.
- Connection details: An active QuickBooks Online account.
- Activation key: A purchased version of the Driver requires an activation key. For evaluation purposes, you can use the trial version, which is valid for 30 days from installation.
- Administrator rights: Required to install the Driver.
For a complete list of supported platforms and third-party tools, see the ODBC Driver for QuickBooks Online compatibility page.
Install the ODBC Driver
Installing the Devart ODBC Driver for QuickBooks Online is straightforward. All you need to do is download the package for your operating system (Windows) and follow the installation instructions.
1. Download the Driver for QuickBooks Online 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 connection settings, such as the company ID and access token that applications use to connect to QuickBooks Online. Applications can also connect without a DSN by passing the same parameters in a connection string.
To configure an ODBC data source, follow the steps outlined below.
1. In Windows Search, enter ODBC Data Sources, and open the ODBC Data Source Administrator that matches the bitness of your application.
2. Go to 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 Online, and click Finish.
4. In the Devart ODBC Driver for QuickBooks Online Configuration dialog, enter a Data Source Name and an optional Description.
5. To authenticate, click the Connect to QuickBooks button. It will redirect you to the QuickBooks Online sign-in page.
Sign in to your QuickBooks Online account by providing your valid credentials and entering the confirmation code sent to you by the service. You will be taken to a page where you can connect the Driver.
Click Connect to authorize the driver to access your QuickBooks Online data. You will return to the Devart ODBC Driver for QuickBooks Online Configuration window; the Company Id and the Refresh Token fields will be filled automatically. Select Save Token to store it.
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 Online using a connection string
In addition to using a DSN, you can connect to QuickBooks Online 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. |
Use the following connection string configuration as a reference.
Replace the placeholder values with your actual Company Id and Refresh Token for QuickBooks Online.
For the complete list of supported options, see the QuickBooks Online ODBC connection string parameters page.
Troubleshooting
If you cannot connect to QuickBooks Online through the Devart ODBC Driver, refer to the following list of common connection issues and their solutions to troubleshoot and fix the failure.
You get a "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. Activation is required for both purchased and trial versions.
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.
The ODBC data source is not found or the Driver is not available
If your application cannot find the DSN or the Devart ODBC Driver for QuickBooks Online, 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.
Connection fails
If QuickBooks Online is reachable but authentication fails, you may need to reconnect the Driver to QuickBooks Online.
Open the ODBC Data Source Administrator and select the ODBC Driver for QuickBooks Online you have configured. Click Disconnect from QuickBooks. After that, connect to the service again and test the connection.
QuickBooks Online connection times out
If the connection to QuickBooks Online takes too long to establish, increase Connection Timeout on the Advanced Settings tab. Also, check the network connection.
Additional resources
After you install and configure Devart ODBC Driver for QuickBooks Online, use the following resources to continue setting up and working with your connections:
- QuickBooks Online ODBC connection string parameters — Browse the complete list of connection options for configuring authentication, proxy settings, timeouts, ODBC behavior, and other Driver settings.
- Supported ODBC API functions — Explore the currently supported ODBC functions.
- Using in third-party tools — Find step-by-step guides for connecting BI, reporting, analytics, and other ODBC-compatible tools to QuickBooks Online.
- Documentation — Get full information on installing, configuring, and using the Devart ODBC Driver for QuickBooks Online.