Using the CData ODBC Driver for MYOB AccountRight in PyCharm

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 MYOB AccountRight 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 MYOB AccountRight 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 MYOB AccountRight

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.

These properties are required when connecting to a company file (both for Cloud and On-Premise instances).

• CompanyFileId: You can find this by starting MYOB, opening your data file, and selecting Help -> About MYOB
• User: The username associated with your company file.
• Password: The password associated with your company file.

Connecting to a Cloud Instance

To connect to a cloud instance of MYOB, you can use the embedded OAuth credentials or create an OAuth app with MYOB. This process is detailed in the Help documentation.

Connecting to an On-Premise instance:

When connecting to an on-premise instance, set the following connection property in addition to those above:

• InitiateOauth: Set this to OFF.
• Url: The Url of your MYOB instance.

Below is the syntax for a DSN:

[CData MYOB Source]
Driver = CData ODBC Driver for MYOB AccountRight
Description = My Description
OAuthClientId = YourClientId
 OAuthClientSecret = YourClientSecret
 CompanyFileId = yourCompanyFileId
 CallbackURL = http://localhost:33333
 User = companyFileUser
 Password = companyFilePassword
InitiateOAuth = GETANDREFRESH

Execute SQL to MYOB AccountRight

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 MYOB};OAuthClientId = YourClientId; OAuthClientSecret = YourClientSecret; CompanyFileId = yourCompanyFileId; CallbackURL = http://localhost:33333; User = companyFileUser; Password = companyFilePassword;InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT Id, Name FROM Accounts WHERE Type = 'Bank'")
rows = cursor.fetchall()
for row in rows:
 print(row.Id, row.Name)

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