Ready to get started?

Learn more about the CData JDBC Driver for QuickBooks Online or download a free trial:

Download Now

Create a Data Access Object for QuickBooks Online Data using JDBI

A brief overview of creating a SQL Object API for QuickBooks Online data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for QuickBooks Online integrates connectivity to live QuickBooks Online data in Java applications. By pairing these technologies, you gain simple, programmatic access to QuickBooks Online data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write QuickBooks Online data.

Create a DAO for the QuickBooks Online Customers Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyCustomersDAO { //insert new data into QuickBooks Online @SqlUpdate("INSERT INTO Customers (FullyQualifiedName, Balance) values (:fullyQualifiedName, :balance)") void insert(@Bind("fullyQualifiedName") String fullyQualifiedName, @Bind("balance") String balance); //request specific data from QuickBooks Online (String type is used for simplicity) @SqlQuery("SELECT Balance FROM Customers WHERE FullyQualifiedName = :fullyQualifiedName") String findBalanceByFullyQualifiedName(@Bind("fullyQualifiedName") String fullyQualifiedName); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to QuickBooks Online

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to QuickBooks Online.

QuickBooks Online uses the OAuth authentication standard. OAuth requires the authenticating user to log in through the browser. To authenticate using OAuth, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL or you can obtain your own by registering an app with Intuit. Additionally, if you want to connect to sandbox data, set UseSandbox to true.

See the Getting Started chapter of the help documentation for a guide to using OAuth.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the QuickBooks Online JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.quickbooksonline.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for QuickBooks Online will typically look like the following:


Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:quickbooksonline:InitiateOAuth=GETANDREFRESH"); MyCustomersDAO dao =; //do stuff with the DAO dao.close();

Read QuickBooks Online Data

With the connection open to QuickBooks Online, simply call the previously defined method to retrieve data from the Customers entity in QuickBooks Online.

//disply the result of our 'find' method String balance = dao.findBalanceByFullyQualifiedName("Cook, Brian"); System.out.println(balance);

Write QuickBooks Online Data

It is also simple to write data to QuickBooks Online, using the previously defined method.

//add a new entry to the Customers entity dao.insert(newFullyQualifiedName, newBalance);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for QuickBooks Online by integrating with the CData JDBC Driver for QuickBooks Online. Download a free trial and work with live QuickBooks Online data in custom Java applications today.