From May 2020 we will progressively start to upgrade existing Essentials customers to the new Essentials. Once an old Essentials file has been upgraded users will no longer be able to use the old Essentials API and over time support for the Essentials API will cease. In preparation for this upgrade, we are planning to make changes to the Essentials API.
This article provides you with information on:
- New properties for /businesses endpoint on the public Essentials API.
- How this change could impact you.
We are exposing 2 additional properties in the /businesses endpoint:
- migrationStatus - String indicates the status of an Essentials file.
This property could return one of below values:
AVAILABLE: The file is available to be connected via the Essentials API.
UPGRADING: The file is being upgraded to new Essentials. The Essentials API connection is
limited. For details, visit here.
UPGRADED: The file has been upgraded to new Essentials. The Essentials API connection is
limited. For further file usage, connection to the AccountRight API is required.
For details, visit here.
- globalId - Guid(36) indicates the unique new Essentials file identification.
|Sample GET response|
Since this change will be released for internal production reason, your impact should be minimal. Yet, you can utilise this information as an alternative indicator to monitor your client's files' upgrade status from old to new Essentials. For details visit here.