Learn more
 

Ready to get started?

Connect to live data from Invoiced with the API Driver

Connect to Invoiced

In this article

Related articles

Using the CData ODBC Driver for Invoiced in PyCharm


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

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 Invoiced 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 Invoiced 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 Invoiced

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.

Start by setting the Profile connection property to the location of the Invoiced Profile on disk (e.g. C:\profiles\Invoiced.apip). Next, set the ProfileSettings connection property to the connection string for Invoiced (see below).

Invoiced API Profile Settings

In order to authenticate to Invoiced, you'll need to provide your API Key. An API key can be obtained by signing in to your account, and then going to Settings > Developers > API Keys. Set the API Key in the ProfileSettings property to connect.

Below is the syntax for a DSN:

[CData API Source] Driver = CData ODBC Driver for Invoiced Description = My Description Profile = C:\profiles\Invoiced.apip ProfileSettings = 'APIKey = your_api_key'

Execute SQL to Invoiced

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 API};Profile = C:\profiles\Invoiced.apip;ProfileSettings = 'APIKey = your_api_key';') cursor = cnxn.cursor() cursor.execute("SELECT Id, Name FROM Invoices WHERE Paid = 'false'") rows = cursor.fetchall() for row in rows: print(row.Id, row.Name)

After connecting to Invoiced in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Invoiced 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.