Load QuickBooks Online Data to a Database Using Embulk

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

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

Getting Started

---

Configure a JDBC Connection to QuickBooks Online 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 QuickBooks Online\lib).

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

QuickBooks Online uses the OAuth authentication standard. OAuth requires the authenticating user to log in through the browser. To authenticate using OAuth, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL or you can obtain your own by registering an app with Intuit. Additionally, if you want to connect to sandbox data, set UseSandbox to true.

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 QuickBooks Online JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.quickbooksonline.jar

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

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

Below is a typical JDBC connection string for QuickBooks Online:

jdbc:quickbooksonline:InitiateOAuth=GETANDREFRESH;

Load QuickBooks Online 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

embulk gem install embulk-input-jdbc

2. 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 QuickBooks Online data into MySQL using Embulk.

Create a Job to Load QuickBooks Online Data

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

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

Sample Config File (quickbooksonline-mysql.yml)

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.quickbooksonline.jar
	driver_class: cdata.jdbc.quickbooksonline.QuickBooksOnlineDriver
	url: jdbc:quickbooksonline:InitiateOAuth=GETANDREFRESH;
	table: "Customers"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Customers"
	mode: insert

After creating the file, run the Embulk job.

embulk run quickbooksonline-mysql.yml

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

Load Filtered QuickBooks Online 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[product_name] 20xx\lib\cdata.jdbc.quickbooksonline.jar
	driver_class: cdata.jdbc.quickbooksonline.QuickBooksOnlineDriver
	url: jdbc:quickbooksonline:InitiateOAuth=GETANDREFRESH;
	query: "SELECT DisplayName, Balance FROM Customers WHERE [RecordId] = 1"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Customers"
	mode: insert

More Information & Free Trial

By using CData JDBC Driver for QuickBooks Online as a connector, Embulk can integrate QuickBooks Online 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.