CategoryRegister

Return transactions grouped with categories.

Date Released: Aug 2013 Date Updated: Jan 2022
URLSupports
/{cf_uri}/GeneralLedger/CategoryRegister 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 CategoryRegister. 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

  • Category
  • The following outlines the category information.
    • UID Guid (36)
    • Foreign Key: Unique category identifier in the form of a guid.
    • Name String (30)
    • Name of the category.
    • DisplayID String (15)
    • Display id for the category.
    • URI String
    • Uniform resource identifier associated with the category object.
  • Account
  • The following outlines the account information for this category register.
    • UID Guid (36)
    • Foreign Key: Unique guid identifier belonging to the account.
    • Name String (30)
    • Account name belonging to the account record.
    • DisplayID String (6)
    • Account code format includes separator ie 1-1100
    • URI String
    • Uniform resource identifier associated with the account object.
  • Year Integer
  • Financial year in which the activity was generated ie 2014.
  • Month Integer
  • Month in which the activity was generated ie December = 12.
  • Activity Decimal (13.6)
  • Net activity within profit & loss account or net movement within balance sheet accounts.
  • YearEndActivity Decimal (13.6)
  • Net activity within profit & loss account or net movement within balance sheet accounts for YearEndAdjustments.
  • RowVersion String
  • Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.


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

Example json GET response

  • {
    • "Category" : {
      • "UID" : "37a98bf5-f217-4dff-bf1f-703f5c0419f6",
      • "Name" : "Victoria",
      • "DisplayID" : "CAT002",
      • "Uri" : "{cf_uri}/GeneralLedger/Category/37a98bf5-f217-4dff-bf1f-703f5c0419f6"
      • },
    • "Account" : {
      • "UID" : "7772dc25-5ee6-4a61-994e-28c04b8a35fc",
      • "Name" : "General Cheque Account 1",
      • "DisplayID" : "1-1110",
      • "URI" : "{cf_uri}/GeneralLedger/Account/7772dc25-5ee6-4a61-994e-28c04b8a35fc"
      • },
    • "Year" : 2013,
    • "Month" : 8,
    • "Activity" : -100,
    • "YearEndActivity" : 0,
    • "RowVersion" : "-8208654745812860928"
    • }
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.