Job

Return, update, create and delete a job.

Date Released: Aug 2013 Date Updated: Feb 2021
URLSupports
/{cf_uri}/GeneralLedger/Job 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

The elements list below details information for Job. 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 job identifier in the form of a guid.
    ONLY required for updating an existing job.
    NOT required when creating a new job.
  • NumberString (30)
  • Number assigned to the job.
  • IsHeaderBoolean
  • Please note: Defaults to true if left blank on POST.
    True indicates the job is a header.
    False indicates the job is not a header.
  • NameString (30)
  • Name assigned to the job.
  • DescriptionString (255)
  • Description text for the job.
  • ParentJob
  • The following set of information pulls through parent job details.
    • UID Guid (36)
    • Foreign Key: Unique guid identifier belonging to the assigned parent job.
    • NumberString (30)
    • Number of the parent job.
    • NameString (30)
    • Name of the parent job.
    • URIString
    • Uniform resource identifier associated with the parent job object.
  • LinkedCustomer
  • The following set of information pulls through linked customer details.
    • UID Guid (36)
    • Foreign Key: Unique guid identifier belonging to the assigned customer contact.
    • NameString (25)
    • Name of the customer contact.
    • DisplayIDString (15)
    • Customer contact Card ID, can also be used as a unique customer contact identifier.
    • URIString
    • Uniform resource identifier associated with the customer contact object.
  • PercentCompleteDouble (99.99%)
  • % of the job completed.
  • StartDateDateTime
  • Date the job started, format YYYY-MM-DD HH:MM:SS.
  • FinishDateDateTime
  • Date the job was completed, format YYYY-MM-DD HH:MM:SS.
  • ContactString (25)
  • Contact for the job.
  • ManagerString (25)
  • Manager of the job.
  • IsActiveBoolean
  • Please note: Defaults to true if left blank on POST.
    True indicates the job is active.
    False indicates the job is inactive.
  • TrackReimbursablesBoolean
  • True indicates a job is used to track reimbursable expenses.
    False indicates a job is not used to track reimbursable expenses.
  • LastModifiedDateTime
  • DateTime of the last time this resource was modified through a direct action to the object. eg a field was updated.
  • 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 job.
    NOT required when creating a new job.


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

Example json GET response

  • {
    • "UID" : "797755431-e8d1-411f-9859-5ff2a54f97d9",
    • "Number" : "125",
    • "IsHeader" : false,
    • "Name" : "Supply of Coolers FH",
    • "Description" : "Supply & installation of coolers in shopping centre food hall",
    • "ParentJob" : {
      • "UID" :"28e1c70c-55e7-4c14-85cb-d97c4179fb33",
      • "Number" : "120",
      • "Name" : "Food Hall",
      • "Uri" : "{cf_uri}/GeneralLedger/Job/28e1c70c-55e7-4c14-85cb-d97c4179fb33"
      • },
    • "LinkedCustomer" : {
      • "UID" :"94b43777-9730-4594-8323-d32ef9cb3f24",
      • "Name" : "My Town Reality",
      • "DisplayID" : "CUS000008",
      • "Uri" : "{cf_uri}/Contact/Customer/94b43777-9730-4594-8323-d32ef9cb3f24"
      • },
    • "PercentComplete" : 8,
    • "StartDate" : "2012-07-07T00:00:00",
    • "FinishDate" : "2013-06-28T00:00:00",
    • "Contact" : "Mrs A Curtis",
    • "Manager" : "GabCrawper",
    • "IsActive" : true,
    • "TrackReimbursables" : true,
    • "LastModified" : "2020-09-13T22:46:30.633",
    • "URI" : "{cf_uri}/GeneralLedger/Job/97755431-e8d1-411f-9859-5ff2a54f97d9",
    • "RowVersion" : "2708070750933221376"
    • }
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.