Ready to get started?

Connect to live data from Invoiced with the API Driver

Connect to Invoiced

Create a Data Access Object for Invoiced Data using JDBI

A brief overview of creating a SQL Object API for Invoiced 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 Invoiced integrates connectivity to live Invoiced data in Java applications. By pairing these technologies, you gain simple, programmatic access to Invoiced data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read Invoiced data.

Create a DAO for the Invoiced Invoices 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 MyInvoicesDAO { //request specific data from Invoiced (String type is used for simplicity) @SqlQuery("SELECT Name FROM Invoices WHERE Paid = :paid") String findNameByPaid(@Bind("paid") String paid); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Invoiced

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

Start by setting the Profile connection property to the location of the Invoiced Profile on disk (e.g. C:\profiles\Invoiced.apip). Next, set the ProfileSettings connection property to the connection string for Invoiced (see below).

Invoiced API Profile Settings

In order to authenticate to Invoiced, you'll need to provide your API Key. An API key can be obtained by signing in to your account, and then going to Settings > Developers > API Keys. Set the API Key in the ProfileSettings property to connect.

Built-in Connection String Designer

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

java -jar cdata.jdbc.api.jar

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

A connection string for Invoiced 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:api:Profile=C:\profiles\Invoiced.apip;ProfileSettings='APIKey=your_api_key';"); MyInvoicesDAO dao =; //do stuff with the DAO dao.close();

Read Invoiced Data

With the connection open to Invoiced, simply call the previously defined method to retrieve data from the Invoices entity in Invoiced.

//disply the result of our 'find' method String name = dao.findNameByPaid("false"); System.out.println(name);

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