Ready to get started?

Learn more about the CData JDBC Driver for QuickBooks or download a free trial:

Download Now

Analyze QuickBooks Data in R

Use standard R functions and the development environment of your choice to analyze QuickBooks data with the CData JDBC Driver for QuickBooks.

Access QuickBooks data with pure R script and standard SQL on any machine where R and Java can be installed. You can use the CData JDBC Driver for QuickBooks and the RJDBC package to work with remote QuickBooks data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to QuickBooks and visualize QuickBooks data by calling standard R functions.

Install R

You can match the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running open R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open 3.2.3, which is preconfigured to install packages from the Jan. 1, 2016 snapshot of the CRAN repository. This snapshot ensures reproducibility.

Load the RJDBC Package

To use the driver, download the RJDBC package. After installing the RJDBC package, the following line loads the package:

library(RJDBC)

Connect to QuickBooks as a JDBC Data Source

You will need the following information to connect to QuickBooks as a JDBC data source:

  • Driver Class: Set this to cdata.jdbc.quickbooks.QuickBooksDriver
  • Classpath: Set this to the location of the driver JAR. By default this is the lib subfolder of the installation folder.

The DBI functions, such as dbConnect and dbSendQuery, provide a unified interface for writing data access code in R. Use the following line to initialize a DBI driver that can make JDBC requests to the CData JDBC Driver for QuickBooks:

driver <- JDBC(driverClass = "cdata.jdbc.quickbooks.QuickBooksDriver", classPath = "MyInstallationDir\lib\cdata.jdbc.quickbooks.jar", identifier.quote = "'")

You can now use DBI functions to connect to QuickBooks and execute SQL queries. Initialize the JDBC connection with the dbConnect function.

When you are connecting to a local QuickBooks instance, you do not need to set any connection properties.

Requests are made to QuickBooks through the Remote Connector. The Remote Connector runs on the same machine as QuickBooks and accepts connections through a lightweight, embedded Web server. The server supports SSL/TLS, enabling users to connect securely from remote machines.

The first time you connect, you will need to authorize the Remote Connector with QuickBooks. See the "Getting Started" chapter of the help documentation for a guide.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the QuickBooks JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.quickbooks.jar

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

Below is a sample dbConnect call, including a typical JDBC connection string:

conn <- dbConnect(driver,"jdbc:quickbooks:URL=http://remotehost:8166;User=admin;Password=admin123;")

Schema Discovery

The driver models QuickBooks APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:

dbListTables(conn)

Execute SQL Queries

You can use the dbGetQuery function to execute any SQL query supported by the QuickBooks API:

customers <- dbGetQuery(conn,"SELECT Name, CustomerBalance FROM Customers")

You can view the results in a data viewer window with the following command:

View(customers)

Plot QuickBooks Data

You can now analyze QuickBooks data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:

par(las=2,ps=10,mar=c(5,15,4,2)) barplot(customers$CustomerBalance, main="QuickBooks Customers", names.arg = customers$Name, horiz=TRUE)