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.

Connect to FreshBooks Data from PowerBuilder



This article demonstrates how to access FreshBooks data from PowerBuilder using the FreshBooks JDBC Driver.

The CData JDBC Driver for FreshBooks is a standards-based control that can be used from any platform or development technology that supports JDBC, including PowerBuilder. This article shows how to use the CData JDBC Driver for FreshBooks in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for FreshBooks to perform reads and writes.

Connect to FreshBooks Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for FreshBooks. You can use a database profile to save connection properties. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

  1. Add the driver JAR to the PowerBuilder classpath. Set the CLASSPATH system environment variable to the path to the driver JAR, located in the lib subfolder of the installation directory.

    Note: If you are using PowerBuilder Classic, you can also add the path to the driver JAR by clicking Tools -> System Options -> Java.

  2. Click Tools -> Database Painter.
  3. Right-click the JDBC node and click New Profile.
  4. In the Database Profile Setup dialog, enter the following:
    • Profile Name: Enter a user-friendly name for the profile.
    • Driver Name: Enter the class name of the driver, cdata.jdbc.freshbooks.FreshBooksDriver
    • URL: Enter 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. A typical JDBC URL is below:

      jdbc:freshbooks:CompanyName=CData;Token=token;
  5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using FreshBooks Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to JDBC data sources and execute queries. The following example shows how to retrieve FreshBooks data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "JDBC" SQLCA.AutoCommit = False SQLCA.DBParm = "Driver='cdata.jdbc.freshbooks.FreshBooksDriver',URL='jdbc:freshbooks:CompanyName=CData;Token=token;"; CONNECT USING SQLCA; dw_clients.SetTransObject(SQLCA); dw_clients.Retrieve();