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.

Manage FreshBooks Data in DBArtisan as a JDBC Source



Use wizards in DBArtisan to create a JDBC data source for FreshBooks.

The CData JDBC Driver for FreshBooks seamlessly integrates FreshBooks data into database management tools like DBArtisan by enabling you to access FreshBooks data as a database. This article shows how to create a JDBC source for FreshBooks in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate FreshBooks Data into DBArtisan Projects

Follow the steps below to register FreshBooks data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic JDBC.
  3. Click Manage.
  4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
  5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

    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.

    Below is a typical connection string:

    jdbc:freshbooks:CompanyName=CData;Token=token;
  6. Finish the wizard to connect to FreshBooks data. FreshBooks entities are displayed in the Datasource Explorer.

You can now work with FreshBooks data as you work with any other database. See the driver help documentation for more information on the queries supported by the FreshBooks API.