MYOB Advanced documentation: API Guide
- A. Set up an MYOB Advanced connection
- B. Supply required MYOB Advanced account information
- C. Edit advanced MYOB Advanced settings
- D. Test the connection
A. Set up an MYOB Advanced connection
Start establishing a connection to MYOB Advanced in either of the following ways:
- From the Resources menu, select Connections. Then, click + Create connection at the top right.
– or –
- While working in a new or existing integration, you can add an application to a flow simply by clicking Add source or Add destination/lookup.
In the resulting Application list, select MYOB Advanced.
The Create connection pane opens with required and advanced settings.
B. Supply required MYOB Advanced account information
At this point, you’re presented with a series of options for providing MYOB Advanced authentication.
Name (required): Provide a clear and distinguishable name. Throughout integrator.io imports and exports, you will have the option to choose this new connection, and a unique identifier will prove helpful later when selecting among a list of connections that you’ve created.
Application (required, non-editable): A reminder of the app you’re editing.
Authentication type (required): Select OAuth 2.0 (the cookie option is described separately).
Instance URI (required): Enter the instance URI shown in your MYOB Advanced account. For example, if
https://demo.myobadvanced.com/entity/Default/18.200.001 is the base URI, then the instance URI would be
Endpoint name (required): Enter the endpoint name found in your MYOB Advanced account.
Endpoint version (required): Enter the endpoint version found in your MYOB Advanced account.
Configure scopes (required): Scopes are permissions that the MYOB Advanced API defines to limit the access to your account. To select the scopes for this connection,
- Click the Configure scopes button.
- To access all of the scopes in the API, click the » button.
– or –
Check the scopes you want to add, and click the > button.
Configure your client id and secret (required): Check this box to reveal iClient options.
iClient (required): Select the iClient pair that stores the client ID and client secret provided to you by MYOB Advanced. To add an iClient and configure your credentials, click the plus (+) button. Click the edit ( ) button to modify a selected iClient. Be sure to give the iClient a recognizable name for use in any other connections.
Callback URL (read-only): Copy this integrator.io callback URL to provide directions to MYOB Advanced for where to go after authentication. (This URL should be whitelisted with the authorization server.)
Sign in to your MYOB Advanced account, navigate to the More items menu options and select Integration.
On the Integration page, you should see Web service endpoints in the Preferences section. If not, click Show more at the bottom of the page. Select Web service endpoints.
The page now displays the Endpoint name and Endpoint version, required for your connection:
Sign back in to your MYOB Advanced account, and return to the Integration menu. Select Preferences > Connected applications.
- Leave Client ID blank for a new app, or search for an existing app.
- Provide a Client name.
- Leave Active checked.
- Choose Authorization code for the OAuth 2.0 flow.
In the Secrets tab, click Add shared secret. MYOB Advanced displays the value – just this once – for you to copy for the connection’s Client secret and also gives you the opportunity to name the secret and give it an expiration date. Click OK to return to the Connected applications page.
In the Redirect URIs tab, click the + button to add an entry. Paste the Callback URL from the MYOB Advanced connection, above. Press the enter key to commit this URI.
Finally, click the save button (disk icon). MYOB Advanced then assigns the Client ID, which you can copy for the iClient value.
C. Edit advanced MYOB Advanced settings
Before continuing, you have the opportunity to provide additional configuration information, if needed, for the MYOB Advanced connection.
D. Test the connection
Once you have configured the MYOB Advanced connection, you have the option to Save & authorize or Cancel your changes.
When you save the connection, MYOB Advanced allows you to sign in, if there is no current session.
It then prompts you to review and confirm the scopes. Click Yes, allow.
The new connection is now successfully added to your account. It will be applied to the current source or destination app, if you created it within a flow. Otherwise, you may proceed to register the connection with an integration.
Please sign in to leave a comment.