Connect to FreshBooks Data in Aqua Data Studio

The CData JDBC Driver for FreshBooks integrates FreshBooks data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to FreshBooks data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The FreshBooks data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, FreshBooks.
   • Driver Location: Click the Browse button and select the cdata.jdbc.freshbooks.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.freshbooks.FreshBooksDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:freshbooks: and is followed by a semicolon-separated list of connection properties.

     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;

Query FreshBooks Data

You can now query the tables exposed.