![]() |
VOOZH | about |
The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData API Driver for Python, the pandas & Matplotlib modules, and the SQLAlchemy toolkit, you can build FreshBooks-connected Python applications and scripts for visualizing FreshBooks data. This article shows how to use the pandas, SQLAlchemy, and Matplotlib built-in functions to connect to FreshBooks data, execute queries, and visualize the results.
With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live FreshBooks data in Python. When you issue complex SQL queries from 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).
Connecting to FreshBooks data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.
Start by setting the Profile connection property to the location of the FreshBooks Profile on disk (e.g. C:\profiles\FreshBooks.apip). Next, set the ProfileSettings connection property to the connection string for FreshBooks (see below).
Register an OAuth application in your FreshBooks Developer Dashboard to obtain a Client ID and Client Secret, and configure the redirect URI to match your application's callback URL.
Follow the procedure below to install the required modules and start accessing FreshBooks through Python objects.
Use the pip utility to install the pandas & Matplotlib modules and the SQLAlchemy toolkit:
pip install pandas pip install matplotlib pip install sqlalchemy
Be sure to import the module with the following:
import pandas import matplotlib.pyplot as plt from sqlalchemy import create_engine
You can now connect with a connection string. Use the create_engine function to create an Engine for working with FreshBooks data.
engine = create_engine("api:///?Profile=C:\profiles\FreshBooks.apip&Authscheme=OAuth&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url&InitiateOAuth=GETANDREFRESH")
Use the read_sql function from pandas to execute any SQL statement and store the resultset in a DataFrame.
df = pandas.read_sql("SELECT Id, InvoiceNumber FROM Invoices WHERE AccountId = 'your_account_id'", engine)
With the query results stored in a DataFrame, use the plot function to build a chart to display the FreshBooks data. The show method displays the chart in a new window.
df.plot(kind="bar", x="Id", y="InvoiceNumber") plt.show()👁 FreshBooks data in a Python plot (Salesforce is shown).
Download a free, 30-day trial of the CData API Driver for Python to start building Python apps and scripts with connectivity to FreshBooks data. Reach out to our Support Team if you have any questions.
import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engin
engine = create_engine("api:///?Profile=C:\profiles\FreshBooks.apip&Authscheme=OAuth&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url&InitiateOAuth=GETANDREFRESH")
df = pandas.read_sql("SELECT Id, InvoiceNumber FROM Invoices WHERE AccountId = 'your_account_id'", engine)
df.plot(kind="bar", x="Id", y="InvoiceNumber")
plt.show()
Connect to live data from FreshBooks with the API Driver
Connect to FreshBooks