Company Files

Default endpoint for the AccountRight Live API - returns a list of company files.

Date Released: Feb 2013 Date Updated: Nov 6th 2013
URLSupports
{domain}/accountright/ GET |  PUT |  POST |  DELETE

The first thing you are going to want to do is get a list of the company files. This really couldn't be simpler as there is no specific end point for this, just call the base API url.

As soon as you request the API (provided you have authenticated and passed the right headers, you will be presented with a list of the company files on the computer or that the user has in the cloud.

Default API Call

Pick the appropriate URL for your access needs:

http://localhost:8080/accountright/
http://[IP OF NETWORK COMPUTER]:8080/accountright/
https://api.myob.com/accountright/

The elements list below details information for Company Files. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.

Items shown with are required when posting or puting data
Items shown with are read-only elements

Attribute Details

  • IdGuid (36)
  • Unique GUID for the company file.
  • NameString
  • Given name of the company file.
  • LibraryPathString
  • Path name to the company file
  • ProductVersionString
  • MYOB AccountRight Live version this company file was created with. EG: 2013.3
  • ProductLevel
  • The following set of information pulls through details for the AccountRight Live product
    • CodeString
    • AccountRight Live product code.
    • NameString
    • AccountRight Live product name, ie Basics, Standard, Plus.
  • CheckedOutDateDateTime
  • Date the online file was checked out offline, format YYYY-MM-DD HH:MM:SS
  • CheckedOutByString
  • my.MYOB user that has checked out the file offline.
  • URIString
  • Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
  • CountryString (2)
  • The 2 character country code. EG: AU or NZ

Example json GET response

  • {
  • "Id": "d2014f64-ffdf-487b-8d12-67a20976aca6",
  • "Name": "Internal Sandbox API",
  • "LibraryPath": "Internal Sandbox API",
  • "ProductVersion": "2013.0",
  • "ProductLevel" : {
    • "Code" : 20,
    • "Name" : "Standard"
  • },
  • "CheckedOutDate" : "2013-06-11T01:47:47.0065514",
  • "CheckedOutBy" : "developers@myob.com",
  • "Uri": "{cf_uri}",
  • "Country": "AU"
  • }
Hypermedia in the AccountRight Live API

The {cf_uri} is provided by the Company File endpoint.

Read more about Hypermedia in the AccountRight Live API in our best practice guide.