Use JayDeBeApi to access MYOB AccountRight Data in Python

Access MYOB AccountRight data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for MYOB AccountRight and the JayDeBeApi module to work with remote MYOB AccountRight data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to MYOB AccountRight and visualize MYOB AccountRight data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with MYOB AccountRight data in Python using SQL.

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.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the MYOB AccountRight JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.myob.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:myob:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; CompanyFileId=yourCompanyFileId; CallbackURL=http://localhost:33333; User=companyFileUser; Password=companyFilePassword;InitiateOAuth=GETANDREFRESH;"

Access MYOB AccountRight data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.myob.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from MYOB AccountRight:

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:myob:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; CompanyFileId=yourCompanyFileId; CallbackURL=http://localhost:33333; User=companyFileUser; Password=companyFilePassword;InitiateOAuth=GETANDREFRESH;"

username = "****"
password = "****"

#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.myob.jar"

conn = jaydebeapi.connect(
 "cdata.jdbc.myob.MYOBDriver",
 jdbc_url,
 [username, password],
 jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM Accounts;")


results = cursor.fetchall()
for row in results:
 print(row)

cursor.close()
conn.close()

Free trial & more information

Download a free, 30-day trial of the CData JDBC Driver for MYOB AccountRight and start working with your live MYOB AccountRight data in Python. Reach out to our Support Team if you have any questions.