Ready to get started?

Download a free trial of the FreshBooks Driver to get started:

 Download Now

Learn more:

FreshBooks Icon FreshBooks JDBC Driver

Complete read-write access to FreshBooks enables developers to search (Customers, Transactions, Invoices, Sales Receipts, etc.), update items, edit customers, and more, from any Java/J2EE application.

A PostgreSQL Interface for FreshBooks Data



Use the Remoting features of the FreshBooks JDBC Driver to create a PostgreSQL entry-point for data access.

There are a vast number of PostgreSQL clients available on the Internet. From standard Drivers to BI and Analytics tools, PostgreSQL is a popular interface for data access. Using our JDBC Drivers, you can now create PostgreSQL entry-points that you can connect to from any standard client.

To access FreshBooks data as a PostgreSQL database, use the CData JDBC Driver for FreshBooks and a JDBC foreign data wrapper (FDW). In this article, we compile the FDW, install it, and query FreshBooks data from PostgreSQL Server.

Connect to FreshBooks Data as a JDBC Data Source

To connect to FreshBooks as a JDBC data source, you will need the following:

  • Driver JAR path: The JAR is located in the lib subfolder of the installation directory.
  • Driver class: cdata.jdbc.freshbooks.FreshBooksDriver

  • JDBC URL: The URL must start with "jdbc:freshbooks:" and can include any of the connection properties in name-value pairs separated with semicolons.

    To connect to FreshBooks, you can set the CompanyName and Token connection properties. Alternatively, you can use the OAuth authentication standard.

    OAuth can be used to enable other users to access their own company data. To authenticate using OAuth, you will need to obtain the OAuthClientId and OAuthClientSecret by registering an app. 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 FreshBooks JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.freshbooks.jar

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

    A typical JDBC URL is below:

    jdbc:freshbooks:CompanyName=CData;Token=token;

Build the JDBC Foreign Data Wrapper

The Foreign Data Wrapper can be installed as an extension to PostgreSQL, without recompiling PostgreSQL. The jdbc2_fdw extension is used as an example (downloadable here).

  1. Add a symlink from the shared object for your version of the JRE to /usr/lib/libjvm.so. For example: ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
  2. Start the build: make install USE_PGXS=1

Query FreshBooks Data as a PostgreSQL Database

After you have installed the extension, follow the steps below to start executing queries to FreshBooks data:

  1. Log into your database.
  2. Load the extension for the database: CREATE EXTENSION jdbc2_fdw;
  3. Create a server object for FreshBooks: CREATE SERVER FreshBooks FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS ( drivername 'cdata.jdbc.freshbooks.FreshBooksDriver', url 'jdbc:freshbooks:CompanyName=CData;Token=token;', querytimeout '15', jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.freshbooks.jar');
  4. Create a user mapping for the username and password of a user known to the MySQL daemon. CREATE USER MAPPING for postgres SERVER FreshBooks OPTIONS ( username 'admin', password 'test');
  5. Create a foreign table in your local database: postgres=# CREATE FOREIGN TABLE clients ( clients_id text, clients_Username text, clients_Credit numeric) SERVER FreshBooks OPTIONS ( table_name 'clients');
You can now execute read/write commands to FreshBooks: postgres=# SELECT * FROM clients;