JobBudget

Return and update job budgets.

Date Released: Feb 2015 Date Updated: Feb 2021
URLSupports
/{cf_uri}/GeneralLedger/JobBudget 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 JobBudget. 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

  • UIDGuid (36)
  • Unique job budget identifier in the form of a guid.
  • Job
  • The following set of information pulls through job details.
    • UIDString (6)
    • Foreign Key: Unique identifier for the job in the form of a guid.
      Required for PUT on update of job budget
    • NumberString (30)
    • Number assigned to the job.
    • NameString (30)
    • Name assigned to the job.
    • URIString
    • Uniform resource identifier assoicated with the job object.
  • Budgets []
  • An array of job budget information.
    • Account
    • The following set of information pulls through account details.
      • UIDString (6)
      • Foreign Key: Unique identifier for the account in the form of a guid.
        Required for PUT on update of job budget
      • NameString (60)
      • Name of the account.
      • DisplayIDString (6)
      • Account code format includes separator ie 4-1100
      • URIString
      • Uniform resource identifier assoicated with the account object.
    • AmountDecimal (13.6)
    • Budget amount for job.
  • URIString
  • Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web
  • RowVerisonString
  • 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 Jobs Budget.


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

Example json GET response

  • {
  • "UID": "0f2187a1-f11a-4a3a-aab7-38b57e964469",
  • "Job" : {
    • "UID" : "0f2187a1-f11a-4a3a-aab7-38b57e964469",
    • "Number" : "115",
    • "Name": "Supply of Coolers GM",
    • "URI" : "{cf_uri}/GeneralLedger/Job/0f2187a1-f11a-4a3a-aab7-38b57e964469"
    • },
  • "Budgets" : [
    • {
    • "Account" : {
      • "UID" : "357a6415-6a7e-4e94-88bb-60d7ba5d713a",
      • "Name" : "Coolers",
      • "DisplayID" : "6-2160",
      • "URI" : "{cf_uri}/GeneralLedger/Account/357a6415-6a7e-4e94-88bb-60d7ba5d713a"
      • },
    • "Amount": 200
    • }
    • ],
  • "URI" : "{cf_uri}/GeneralLedger/JobBudget/0f2187a1-f11a-4a3a-aab7-38b57e964469",
  • "RowVersion" : "-8837188368807755776"
  • }
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.