Timesheet

Return, create and update timesheet entries for Australian Files.

Date Released: May 2014 Date Updated: Jan 2022
URLSupports
/{cf_uri}/Payroll/Timesheet 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 Timesheet. 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

  • Employee
  • The following set of information pulls through details for the employee contact
    • UIDGuid (36)
    • Foreign Key: Unique guid identifier belonging to the employee contact.

      Required when creating a new timesheet entry through the PUT operator, include on the end of the URL call.
    • NameString (30)
    • Name of the employee.
    • DisplayIDString (15)
    • Employee contact Card ID, can also be used as a unique employee contact identifier.
    • URIString
    • Uniform resource identifier associated with the employee object.
  • StartDateDateTime
  • Date when the timesheet period starts, format YYYY-MM-DD HH:MM:SS { 'StartDate': '2014-09-10 13:33:02' }
  • EndDateDateTime
  • Date when the timesheet period finishes, format YYYY-MM-DD HH:MM:SS { 'EndDate': '2014-09-10 13:33:02' }
  • Lines []
  • An array of timesheet line information
    • PayrollCategory
    • The following set of information pulls through details for the payroll category
      • UIDGuid (36)
      • Required: only if passing on PUT.
        Unique payroll wage category identifier in the form of a guid.
      • NameString (31)
      • Name of the payroll wage category.
      • TypeString
      • Indicates the type of payroll category ie: Wage, Deduction, Tax.
      • URI String
      • Uniform resource identifier associated with the payroll wage category object.
    • Job
    • The following set of information pulls through details for jobs
      • UID GUID (36)
      • Foreign Key: Unique guid identifier belonging to the job for this line of the timesheet entry
      • Number String (15)
      • Number assigned to the job
      • Name String (30)
      • Name assigned to the job
      • URI String
      • Uniform resource identifier associated with the job object
    • Activity
    • The following set of information pulls through details for the Activity
      Please note: can only be used if preference UseTimesheetsFor = TimeBillingAndPayroll
      • UIDGuid (36)
      • Foreign Key: Unique guid identifier belonging to the activity assigned for this line of the timesheet entry.
      • NameString (30)
      • Name of the activity.
      • URIString
      • Uniform resource identifier associated with the activity object.
    • Customer
    • The following set of information pulls through details for the Customer contact.
      Please note: can only be used if preference I Use Timesheets for Time Billing has been selected.
      • UIDGuid (36)
      • Foreign Key: Unique guid identifier belonging to the customer assigned for this line of the timesheet entry.
      • NameString (30)
      • Name of the customer.
      • DisplayIDString (15)
      • Customer contact Card ID, can also be used as a unique customer contact identifier.
      • URIString
      • Uniform resource identifier associated with the customer object.
    • NotesString (255)
    • Notes attached to the timesheet entry.
    • Entries []
    • An array of timesheet entry information
      • UIDGuid (36)
      • Unique guid identifier belonging to the line entry.
      • DateDateTime
      • Date of the entry, format YYYY-MM-DD HH:MM:SS { 'Date': '2014-09-10 13:33:02' }
      • HoursInteger
      • Number of hours assigned for entry day.
      • ProcessedBoolean
      • True indicates the timesheet entry has been processed as part of payroll
        False indicates the timesheet entry has not been processed as part of payroll
  • URIString
  • Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.


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

Example json GET response

  • {
  • "Employee" : {
    • "UID" : "22985a06-eeaa-4634-89ef-ee4ff314f406",
    • "Name" : "Alan Long",
    • "DisplayID" : "EMP00002",
    • "URI" : "{cf_uri}/Contact/Employee/22985a06-eeaa-4634-89ef-ee4ff314f406"
    • },
  • "StartDate" : "2014-05-05T00:00:00Z",
  • "EndDate" : "2014-05-11T00:00:00Z",
  • "Lines" : [
    • {
      • "PayrollCategory" : {
        • "UID" : "32517300-897d-49a1-82b4-634fa299e028",
        • "Name" : "Annual Leave Pay",
        • "Type" : "Wage",
        • "URI" : "{cf_uri}/Payroll/PayrollCategory/Wage/32517300-897d-49a1-82b4-634fa299e028"
        • },
      • "Job" : null,
      • "Activity" : null,
      • "Customer" : null,
      • "Notes" : "Annual Leave Request for May",
      • "Entries" : [
        • {
          • "UID" : "ba951c0c-dfd8-4a18-bf0c-21ac533129c7",
          • "Date" : "2014-05-05T00:00:00",
          • "Hours" : 7.6,
          • "Processed" : false
          • },
        • {
          • "UID" : "2968fb34-7ac9-45af-81c9-140468467c0f",
          • "Date" : "2014-05-06T00:00:00",
          • "Hours" : 7.6,
          • "Processed" : false
          • },
        • {
          • "UID" : "d019be73-9e74-4efb-be00-2286bc639c1d",
          • "Date" : "2014-05-07T00:00:00",
          • "Hours" : 7.6,
          • "Processed" : false
          • }
        • ]
      • }
    • ],
  • "URI" : "{cf_uri}/Payroll/Timesheet/22985a06-eeaa-4634-89ef-ee4ff314f406?StartDate=2014-05-05T00:00:00&EndDate=2014-05-11T00:00:00"
  • }
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.