Return, update, create and delete categories for cost center tracking.

Date Released: Aug 2013 Date Updated: Dec 2020
/{cf_uri}/GeneralLedger/Category GET |  PUT |  POST |  DELETE
Please note: While accessibility via the API is available to both AccountRight and new Essentials files. Not all features will be displayed in Product for new Essentials or the AccountRight Browser.

The elements list below details information for Category. 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

  • UID Guid (36)
  • Unique category identifier in the form of a guid.
    ONLY required for updating an existing category
    NOT required when creating a new category.
  • DisplayIDString (15)
  • Display id assigned to the category.
  • NameString (30)
  • Name assigned to the category.
  • Description String (255)
  • Description text for the category.
  • IsActive Boolean
  • Please note: Defaults to true if left blank on POST.
    True indicates the category is active.
    False indicates the category is inactive.
  • URIString
  • Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
  • RowVersionString
  • Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
    ONLY required for updating an existing category.
    NOT required when creating a new category.

Paging: default page size is set to 400 with a maximum of 1000 results.

Example json GET response

  • {
  • "UID" : "37a98bf5-f217-4dff-bf1f-703f5c0419f6",
  • "DisplayID" : "CAT002",
  • "Name" : "Victoria",
  • "Description" : "Demo API Category Endpoint.",
  • "IsActive" : true,
  • "Uri" : "{cf_uri}/GeneralLedger/Category/37a98bf5-f217-4dff-bf1f-703f5c0419f6",
  • "RowVersion" : "4149785581645201401"
  • }
Hypermedia in the MYOB Business API

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

Read more about Hypermedia in the MYOB Business API in our best practice guide.