Essentials Upgrade Test Environment

In order to be prepared for MYOB Essentials upgrade, it is highly recommended to ensure that your application switches from the Essentials API to the AccountRight API as expected. This article provides you with information on an old/new Essentials test environment. We have an article that covers the flow in detail, please take a moment to go through the Get prepared for new Essentials upgrade article first if you haven't done so.

Flow Overview

1. Authentication

Complete authentication with below user details to obtain Access and Refresh tokens. Ensure Scope is set to CompanyFile la.global in order to avoid double authentication during the Essentials API to the AccountRight API switch over happens. 

Username: ecosystem@myob.com
Password: EssentialsUpgrade01
 Note: 2FA has been turned off on this account

IMPORTANT:
This file is being shared across developers and any update in the file will be visible for others. Please DO NOT create a new user and avoid (or keep it as minimal as possible) data entry.
If you are a registered MYOB developer and don't have a sandbox new Essentials file access, please contact developers@myob.com for assistance.

2. Call The Essentials API

Call an old Essentials file 308852 via the Essentials API. This old Essentials file will return the response code of 418, which can be considered as a trigger to switch from the Essentials API to the AccountRight API (i.e. new Essentials files).

https://api.myob.com/au/essentials/businesses/308852

Sample JSON Response:

{
 "globalId": "28b1fd62-a610-4f32-bc5f-d32de0d4e86e",
 "businessId": "308852",
 "status": "UPGRADED"
}

3. Switch to The AccountRight API

In the previous step, the response code indicated that the file has been upgraded to new Essentials.
Call the upgraded new Essentials file with obtained globalId, 28b1fd62-a610-4f32-bc5f-d32de0d4e86e via the AccountRIght API. Ensure to update x-myobapi-version header from v0 to v2 during the call.

https://ar2.api.myob.com/accountright/28b1fd62-a610-4f32-bc5f-d32de0d4e86e

Sample JSON Response:

{
 "CompanyFile": {
 "Id": "28b1fd62-a610-4f32-bc5f-d32de0d4e86e",
 "Name": "EssentialsUpgradeTest",
 "LibraryPath": "EssentialsUpgradeTest",
 "ProductVersion": "2020.1",
 "ProductLevel": {
 "Code": 50,
 "Name": "Premier"
 },
 "CheckedOutDate": null,
 "CheckedOutBy": null,
 "Uri": "https://ar2.api.myob.com/accountright/28b1fd62-a610-4f32-bc5f-d32de0d4e86e",
 "Country": "AU",
 "LauncherId": "07976562-2be4-4d94-be41-6b10e5163fa8",
 "SerialNumber": "614431938801",
 "UIAccessFlags": 2
 },
.
.
.