Ready to get started?

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

Download Now

Using the CData ODBC Driver for QuickBooks in PyCharm

Connect to QuickBooks as an ODBC data source in PyCharm using the CData ODBC Driver for QuickBooks.

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 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 as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

  1. Click File -> Settings to open the project settings window.
  2. Click Project Interpreter from the Project: YourProjectName menu.
  3. To add pyodbc, click the + button and enter pyodbc.
  4. Click Install Package to install pyodbc.

Connect to QuickBooks

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.

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.

Below is the syntax for a DSN:

[CData QuickBooks Source] Driver = CData ODBC Driver for QuickBooks Description = My Description URL = http://remotehost:8166 User = admin Password = admin123

Execute SQL to QuickBooks

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 QuickBooks};URL = http://remotehost:8166;User = admin;Password = admin123;') cursor = cnxn.cursor() cursor.execute("SELECT Name, CustomerBalance FROM Customers WHERE Type = 'Commercial'") rows = cursor.fetchall() for row in rows: print(row.Name, row.CustomerBalance)

After connecting to QuickBooks in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to QuickBooks data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at support@cdata.com.