accountrightapi.myob.cloud Open in urlscan Pro
54.156.154.87  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Public


Documentation Settings

ENVIRONMENT
Sample MYOB AccountRight Production Environment

LAYOUT
Double Column

LANGUAGE
cURL - cURL



MYOB AccountRight
Introduction
Welcome
Getting started
Need Support?
Authentication
General API Endpoints
General Ledger
Contacts
Inventory
Purchases (Bills)
Sales (Invoices)
Reports
Payroll
Banking
TimeBilling
Company & User settings
Example ODATA queries
Working with the local API


MYOB ACCOUNTRIGHT

Beta




WELCOME

A collection of endpoints for Postman when working with the MYOB AccountRight
API Please note this postman collection is in beta - last updated Jan 2021

Note: we have a quick getting started video you can watch on our developer site
here.

To use this API you will need to make calls to https://api.myob.com/accountright
This API makes use of OAUTH2.0 and will require you to complete the OAUTH flow
to obtain access_tokens for making calls to this API.

Authorisation is to the users account, the first call you make to the API will
return a list of company files that are within this users account.

Future calls will involve using the URI for the company file the users selects.
Note: all future calls you make will be to an url that looks like
https://arX.api.myob.com/accountright where x is a number. This allows the API
to route you to the correct location for that specific file.


EXPECTATIONS

This collection of endpoints and methods has been created to guide and assist
you as you work with the MYOB AccountRight API. It is not intended to be a
replacement to MYOB's documentation nor support channels. Best efforts have been
undertaken to as accurately as possible represent and give samples of how to
work with the API. Most POST and PUT examples will only submit the minimum
required items, for a full list of potential items for any endpoint, please
refer to the http://developers.myob.com/ documentation.


GETTING STARTED

The first thing you will need to do is open this collection in Postman - which
if you haven't used before, is a power REST API explorer tool that allows you to
quickly and easily explore API endpoints, make calls and fetch data.

Once you have the collection running in Postman you'll need some MYOB API Keys
and an MYOB AccountRight Sandbox company file to test with. These are free, and
easily obtained from the MYOB Developers API portal - please note: all api
registrations and sandbox file allocations are manually reviewed before being
granted. Learn more about Getting Started with the MYOB AccountRight API. Once
you have a my.myob login, you will need to login and register your Application,
which will give you the API credentials. Note that for working with postman,
make sure that one of the redirect_uri that you setup is
https://oauth.pstmn.io/v1/callback - you can have multiple so in the redirect
uri form you can enter
https://oauth.pstmn.io/v1/callback,https://staging.mydomain.xyz,https://production.mydomain.abc
to use your keys across multiple environments.

Now that you have your API Credentials and you have opened this collection in
Postman you will see a collection called MYOB AccountRight, and if you mouse
over this collection, on the right you will see an ellipsis ... - click this and
then hit EDIT. Here you will find 5 tabs Description (this content),
Authorization, Pre-request Scripts, Tests and Variables.


SETTING UP THE VARIABLES

Head to the Variables tab, and fill in the client_id and client_secret along
with your redirect_uri (note: make sure this is not url encoded when you paste
it here).


AUTHORIZATION

Now switch over to the Authorization tab, and click the orange Get New Access
Token button. You will notice most of this is prefilled for you. For now simply
click request token and it should take you through the standard OAUTH 2.0 flow.
You'll see the MYOB login screen, login and grant permission for your app. It
should now redirect you to Postman with a acess token.

NOTE: if you see an invalid_request message, the most usual issue will be with
your redirect_uri or the scope paramater.

Postman will now display the response body, scroll to the bottom and click use
token, and then click Update on the bottom of the edit collection window. This
setups up the authorization headers for the collection. All of the endpoints are
setup to inherit this token and use it for calls. Note this collection does not
(yet) auto-refresh the token, so you will need to redo that last authorization
step roughly every 20mins as that's the life time of an MYOB Access Token.


GO EXPLORING.

At this point you can start exploring the API. You might have spotted in the
Variables tab a couple of other items that expect data - these are the
company_file_uri and company_file_id - you get these after making a GET request
to the List Company Files endpoint found in the General API Endpoints folder.
The Company File URI looks like https://arx.api.myob.com/accountright where the
x is a number. The Company File ID is the UID of the file. These two variables
are used in subsequent calls to the API to read/write data to a specific MYOB
AccountRight Company File.


NEED SUPPORT?

If you need support or want to read the full API Documentation you can head to:

   
 * MYOB AccountRight API Documentation
   
 * Log a Ticket with API Support
   

AUTHORIZATIONOAuth 2.0
Access Token