Set up MYOB AccountRight and Essentials

📘

AccountRight or Essentials?

MYOB have migrated their Essentials API to a new version. The new version will be using the AccountRight API. You can read more about the update on MYOB website.

The new Essentials will use the same API as their AccountRight Live platform. Therefore, you only need to carry out the setup described below once to gain access to both accounting packages.

Some users may still be on the old, non-migrated version of MYOB Essentials that uses a legacy API. If your customer is unable to connect using the new unified integration, please reach out to our support team who will be able to assist you.

Before you can access accounting data from customers using MYOB AccountRight and Essentials, you need to set up the integration in the Codat Portal.

You will need to:

  • Register for a developer account with MYOB.
  • Register a new application with MYOB.
  • Add your secure keys to the Codat Portal.

Join the MYOB developer program

You should allow a minimum of 72 hours for MYOB to set up your developer account. If you already have a MYOB developer account, you can skip this section.

  1. Go to MYOB's page for developers.
  2. Scroll to the bottom of the page and select Join the MYOB Developer Program Today.
  3. Complete the Developer Registration form. You can use the 'Open Access' (free) tier to create the required app credentials, but if you require a private MYOB sandbox for testing, you may wish to explore one of the paid tiers. Contact MYOB directly for more information on this.
  4. To complete your registration, select Submit.
    A confirmation message is displayed.
  5. Wait for the MYOB team to create your developer account and send through an email notification.
  6. When you receive the email notification from MYOB, open the email and select Set your password.
  7. Follow the onscreen instructions and then select Create Password.

Register your application

  1. Log in to your MYOB developer account.
  2. From the top menu, select Developer, and then select Register App.
    The Application Details page is displayed.
  3. In the App Name box, enter a short name for your application. Your customers will see this name during the linking process.
  4. In the Redirect URi box enter the URL for the correct Codat environment.
    • Production: https://myobaccountright.codat.io/oauth/callback.
    • UAT: https://myobaccountright-uat.codat.io/oauth/callback.

📘

Handling multiple URI redirects for different environments

When you register your MYOB app, you can use multiple redirect URIs. If you wish to use the same app in UAT and Production, you can therefore simply separate each URI with a comma.

For example:
https://myobaccountright.codat.io/oauth/callback,https://myobaccountright-uat.codat.io/oauth/callback.

  1. In the Website box, you should put a link to your company's website in the following format: https://www.[example].com.
  2. In the Description box, you should put a short description of what your app will allow your customers to do.
  3. Select Register App.
  4. On the Developer Dashboard you will now find your application key and secret. You'll need these for the next stage of the process.

❗️

MYOB Limitation

MYOB will only automatically activate the first two API keys you create. All further API keys will need to be manually activated by the MYOB Support Team prior to use, even if the original keys have been deleted. For more information about it, have a look at the article in MYOB knowledge base.

Add your secure keys to the Codat Portal

  1. Open the Codat Portal and log in.
  2. In the left pane, select Integrations > Accounting.
  3. Scroll down to the MYOB AccountRight and Essentials integration and select Manage.
  4. Paste your application key into the Client Key box and your secret into the Client Secret box.
  5. Select Save.

📘

Spaces in secure keys

Make sure that your secure keys don't contain any spaces.

  1. Enable your integration. Go back to Integrations > Accounting, and use the toggle to update the MYOB AccountRight and Essentials platform from Disabled to Enabled.

User credentials

When linking, the user will first be asked to select from their available MYOB data files. If an AccountRight data file is chosen, the company will then be asked to enter the username and password of the company data file the company wishes to link. Codat will store these securely and use to sync their data. This username and password is separate to the credentials they use to login to their MYOB account - it is the credentials securing the file itself, similar to Sage 50.


Did this page help you?