Use Dash to Build to Web Apps on QuickBooks Online Data

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Python Connector for QuickBooks Online, the pandas module, and the Dash framework, you can build QuickBooks Online-connected web applications for QuickBooks Online data. This article shows how to connect to QuickBooks Online with the CData Connector and use pandas and Dash to build a simple web app for visualizing QuickBooks Online data.

With built-in, optimized data processing, the CData Python Connector offers unmatched performance for interacting with live QuickBooks Online data in Python. When you issue complex SQL queries from 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

---

Connecting to QuickBooks Online Data

Connecting to QuickBooks Online 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.

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.

After installing the CData QuickBooks Online Connector, follow the procedure below to install the other required modules and start accessing QuickBooks Online through Python objects.

Install Required Modules

Use the pip utility to install the required modules and frameworks:

pip install pandas
pip install dash
pip install dash-daq

Visualize QuickBooks Online Data in Python

Once the required modules and frameworks are installed, we are ready to build our web app. Code snippets follow, but the full source code is available at the end of the article.

First, be sure to import the modules (including the CData Connector) with the following:

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.quickbooksonline as mod
import plotly.graph_objs as go

You can now connect with a connection string. Use the connect function for the CData QuickBooks Online Connector to create a connection for working with QuickBooks Online data.

cnxn = mod.connect("InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

Execute SQL to QuickBooks Online

Use the read_sql function from pandas to execute any SQL statement and store the result set in a DataFrame.

df = pd.read_sql("SELECT DisplayName, Balance FROM Customers WHERE FullyQualifiedName = 'Cook, Brian'", cnxn)

Configure the Web App

With the query results stored in a DataFrame, we can begin configuring the web app, assigning a name, stylesheet, and title.

app_name = 'dash-quickbooksonlineedataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'

Configure the Layout

The next step is to create a bar graph based on our QuickBooks Online data and configure the app layout.

trace = go.Bar(x=df.DisplayName, y=df.Balance, name='DisplayName')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='QuickBooks Online Customers Data', barmode='stack')
		})
], className="container")

Set the App to Run

With the connection, app, and layout configured, we are ready to run the app. The last lines of Python code follow.

if __name__ == '__main__':
    app.run_server(debug=True)

Now, use Python to run the web app and a browser to view the QuickBooks Online data.

python quickbooksonline-dash.py

Free Trial & More Information

Download a free, 30-day trial of the CData Python Connector for QuickBooks Online to start building Python apps with connectivity to QuickBooks Online data. Reach out to our Support Team if you have any questions.

Full Source Code

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.quickbooksonline as mod
import plotly.graph_objs as go

cnxn = mod.connect("InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

df = pd.read_sql("SELECT DisplayName, Balance FROM Customers WHERE FullyQualifiedName = 'Cook, Brian'", cnxn)
app_name = 'dash-quickbooksonlinedataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'
trace = go.Bar(x=df.DisplayName, y=df.Balance, name='DisplayName')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='QuickBooks Online Customers Data', barmode='stack')
		})
], className="container")

if __name__ == '__main__':
    app.run_server(debug=True)