Connecting to the Desktop API

Using the API is really simple, as long as you have MYOB AccountRight installed you can start developing against the API.

AccountRight provides you with two different installers to choose from, firstly there is the lighter framed client PC version that gives you an add-on connector to access the desktop API. Secondly a Server build is available for those users that host company files over a network and need to access the API desktop service in network mode. You can find these installers located in the Downloads section of your my.MYOB account.

The next step is to open up your browser (we recommend a browser like Google Chrome) and enter the following address:

http://localhost:8080/accountright/

This should open up a webpage and show you a table of the company files that reside on this computer, with details such as ID, Name, LibraryPath, ProductVersion and more. Pay particular note of the ID, as this is the GUID that identifies the company file. You will use this in the URL of every subsequent call. Also make sure that you include the parameter ?api-version=v2 in the URL as this will allow you to connect to the v2 endpoints for the API. 

Note: the API when accessed via a browser returns HTML, with clickable URIs included so that you can easily explore the data available to you. We recommend that your application uses the JSON format. For more information on formats within the API, click here. 

Additionally: should you want to access a local network computer with the company files on it (AccountRight Server Edition required), simply change the URL to the following

http://[IP ADDRESS OF COMPUTER TO ACCESS]:8080/accountright/

If you would like to connect to the API online, then check out our Getting Started guide