We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Using the CData ODBC Driver for QuickBooks Online in PyCharm
Connect to QuickBooks Online as an ODBC data source in PyCharm using the CData ODBC Driver for QuickBooks Online.
The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for QuickBooks Online from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.
To begin, this tutorial will assume that you have already installed the CData ODBC Driver for QuickBooks Online as well as PyCharm.
About QuickBooks Online Data Integration
CData provides the easiest way to access and integrate live data from QuickBooks Online. Customers use CData connectivity to:
- Realize high-performance data reads thanks to push-down query optimization for complex operations like filters and aggregations.
- Read, write, update, and delete QuickBooks Online data.
- Run reports, download attachments, and send or void invoices directly from code using SQL stored procedures.
- Connect securely using OAuth and modern cryptography, including TLS 1.2, SHA-256, and ECC.
Many users access live QuickBooks Online data from preferred analytics tools like Power BI and Excel, directly from databases with federated access, and use CData solutions to easily integrate QuickBooks Online data with automated workflows for business-to-business communications.
For more information on how customers are solving problems with CData's QuickBooks Online solutions, refer to our blog: https://www.cdata.com/blog/360-view-of-your-customers.
Getting Started
Add Pyodbc to the Project
Follow the steps below to add the pyodbc module to your project.
- Click File -> Settings to open the project settings window.
- Click Project Interpreter from the Project: YourProjectName menu.
- To add pyodbc, click the + button and enter pyodbc.
- Click Install Package to install pyodbc.
Connect to QuickBooks Online
You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.
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.
Below is the syntax for a DSN:
[CData QuickBooksOnline Source]
Driver = CData ODBC Driver for QuickBooks Online
Description = My Description
Execute SQL to QuickBooks Online
Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.
import pyodbc
cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for QuickBooksOnline};')
cursor = cnxn.cursor()
cursor.execute("SELECT DisplayName, Balance FROM Customers WHERE FullyQualifiedName = 'Cook, Brian'")
rows = cursor.fetchall()
for row in rows:
print(row.DisplayName, row.Balance)
After connecting to QuickBooks Online in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to QuickBooks Online data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].