Load FreshBooks Data to a Database Using Embulk

Ready to get started?

Download for a free trial:

Download Now

Learn more:

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.



Use CData JDBC Driver for FreshBooks with the open source ETL/ELT tool Embulk to load FreshBooks data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for FreshBooks, Embulk easily loads data from FreshBooks to any supported destination. In this article, we explain how to use the CData JDBC Driver for FreshBooks in Embulk to load FreshBooks data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live FreshBooks data. When you issue complex SQL queries to FreshBooks, the driver pushes supported SQL operations, like filters and aggregations, directly to FreshBooks and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to FreshBooks Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for FreshBooks\lib).

Embulk supports JDBC connectivity, so you can easily connect to FreshBooks and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with FreshBooks.

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 JDBC connection string for FreshBooks:

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

Load FreshBooks Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
  2. embulk gem install embulk-input-jdbc
  3. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load FreshBooks data into MySQL using Embulk.

Create a Job to Load FreshBooks Data

Start by creating a config file in Embulk, using a name like freshbooks-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for FreshBooks, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.freshbooks.FreshBooksDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (freshbooks-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for FreshBooks 20xx\lib\cdata.jdbc.freshbooks.jar driver_class: cdata.jdbc.freshbooks.FreshBooksDriver url: jdbc:freshbooks:CompanyName=CData;Token=token; table: "Clients" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Clients" mode: insert

After creating the file, run the Embulk job.

embulk run freshbooks-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered FreshBooks Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for FreshBooks 20xx\lib\cdata.jdbc.freshbooks.jar driver_class: cdata.jdbc.freshbooks.FreshBooksDriver url: jdbc:freshbooks:CompanyName=CData;Token=token; query: "SELECT Username, Credit FROM Clients WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Clients" mode: insert

More Information & Free Trial

By using CData JDBC Driver for FreshBooks as a connector, Embulk can integrate FreshBooks data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.