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.

Use JayDeBeApi to access FreshBooks Data in Python



Use standard Python scripting and the development environment of your choice to access live FreshBooks data with the CData JDBC Driver for FreshBooks.

Access FreshBooks data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for FreshBooks and the JayDeBeApi module to work with remote FreshBooks data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to FreshBooks and visualize FreshBooks data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with FreshBooks data in Python using SQL.

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 sample variable assignment, including a typical JDBC connection string:

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

Access FreshBooks data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.freshbooks.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from FreshBooks:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:freshbooks:CompanyName=CData;Token=token;" username = "****" password = "****" #The absolute Path to the JDBC driver JAR file, typically: jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.freshbooks.jar" conn = jaydebeapi.connect( "cdata.jdbc.freshbooks.jar", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM Clients;") results = cursor.fetchall() for row in results: print(row) cursor.close() conn.close()

Free trial & more information

Download a free, 30-day trial of the CData JDBC Driver for FreshBooks and start working with your live FreshBooks data in Python. Reach out to our Support Team if you have any questions.