Create a Data Access Object for MYOB AccountRight Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

MYOB AccountRight JDBC Driver

Complete read-write access to MYOB AccountRight enables developers to search (Customers, Transactions, Invoices, Sales Receipts, etc.), update items, edit customers, and more, from any Java/J2EE application.

A brief overview of creating a SQL Object API for MYOB AccountRight data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for MYOB AccountRight integrates connectivity to live MYOB AccountRight data in Java applications. By pairing these technologies, you gain simple, programmatic access to MYOB AccountRight data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write MYOB AccountRight data.

Create a DAO for the MYOB AccountRight Accounts Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyAccountsDAO { //insert new data into MYOB AccountRight @SqlUpdate("INSERT INTO Accounts (Type, Name) values (:type, :name)") void insert(@Bind("type") String type, @Bind("name") String name); //request specific data from MYOB AccountRight (String type is used for simplicity) @SqlQuery("SELECT Name FROM Accounts WHERE Type = :type") String findNameByType(@Bind("type") String type); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to MYOB AccountRight

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to MYOB AccountRight.

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, you will need to 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.

A connection string for MYOB AccountRight will typically look like the following:

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

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:myob:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; CompanyFileId=yourCompanyFileId; CallbackURL=http://localhost:33333; User=companyFileUser; Password=companyFilePassword; InitiateOAuth=GETANDREFRESH"); MyAccountsDAO dao =; //do stuff with the DAO dao.close();

Read MYOB AccountRight Data

With the connection open to MYOB AccountRight, simply call the previously defined method to retrieve data from the Accounts entity in MYOB AccountRight.

//disply the result of our 'find' method String name = dao.findNameByType("Bank"); System.out.println(name);

Write MYOB AccountRight Data

It is also simple to write data to MYOB AccountRight, using the previously defined method.

//add a new entry to the Accounts entity dao.insert(newType, newName);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for MYOB AccountRight by integrating with the CData JDBC Driver for MYOB AccountRight. Download a free trial and work with live MYOB AccountRight data in custom Java applications today.