EmployeeStandardPay

Return and update employee standard pay details on employee contacts for Australian Files.

Date Released: Oct 2014 Date Updated: May 2021
URLSupports
/{cf_uri}/Contact/EmployeeStandardPay 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 EmployeeStandardPay. 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 employee payroll details/standard pay identifier in the form of a guid.
    Required: for updating an existing employee's standard pay 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.
    • 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.
  • EmployeePayrollDetails
  • The following set of information pulls through details for the employee payroll details
    • UIDGuid (36)
    • Foreign Key: Unique guid identifier belonging to the employee payroll details.
      Please note: the UID GUID value is the same as the Standard Pay identifier
    • URIString
    • Uniform resource identifier associated with the employee payroll details object.
  • PayFrequencyString
  • Pay frequency can consist of the following:
    Weekly
    Fortnightly
    TwiceAMonth
    Monthly
  • HoursPerPayFrequencyDecimal (13.3)
  • Hours worked in a pay period.
  • Category
  • The following outlines category information
    • UID GUID (36)
    • Foreign Key: Unique guid identifier belonging to the category assigned.
    • Name String (30)
    • Name of the category
    • DisplayID String (10)
    • Display id for the category
    • URI String
    • Uniform resource identifier associated with the category object
  • MemoString (255)
  • Default memo text to appear on employee's pays.
  • PayrollCategories []
  • All payroll categories linked to the employee contact, includes all payroll categories of type Wage
    • PayrollCategory
    • The following set of information pulls through details for the payroll category.
      • UIDGuid (36)
      • Unique payroll category identifier in the form of a guid.
      • NameString (31)
      • Name of the payroll category.
      • TypeString
      • Indicates the type of payroll category ie: Wage, Expense, Deduction, Entitlement.
      • URIString
      • Uniform resource identifier associated with the payroll category object.
    • HoursDecimal (13.2)
    • Hours for payroll categories that are not automatically calculated, if IsCalculated = true then a null value is returned.
      PUT(update) will allow you to update the hours.
    • AmountDecimal (13.2)
    • Amounts for payroll categories that are not automatically calculated, if IsCalculated = true then a null value is returned.
      PUT(update) will allow you to update the amount.
    • IsCalculatedBoolean
    • Determined by the setup of Payroll category resource.
    • Job
    • The following set of information pulls through the details for a job
      • UID GUID (36)
      • Foreign Key: Unique guid identifier belonging to the job to which the payroll category amounts are allocated.
      • 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
  • 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 employee's standard pay details.

For more information, check out our Knowledge base article "Employee Standard Pay Endpoint".

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

Example json GET response

  • {
  • "UID" : "5t55818c-855a-452e-be92-d8a1595fc4d4",
  • "Employee" : {
    • "UID" : "5383ff72-4bb6-4d8b-bcf0-8b10857455d8",
    • "Name" : "Mary Jones",
    • "DisplayID" : "EMP00001",
    • "URI" : "{cf_uri}/Contact/Employee/5383ff72-4bb6-4d8b-bcf0-8b10857455d8"
    • },
  • "EmployeePayrollDetails" : {
    • "UID" : "5t55818c-855a-452e-be92-d8a1595fc4d4",
    • "URI" : "{cf_uri}/Contact/EmployeePayrollDetails/5t55818c-855a-452e-be92-d8a1595fc4d4"
    • },
  • "PayFrequency" : "Weekly",
  • "HoursPerPayFrequency" : 40,
  • "Category" : {
    • "UID" : "b211a2a3-0be9-477c-940e-1c8bac139cf1",
    • "Name" : "Melbourne",
    • "DisplayID" : "CAT101",
    • "URI" : "{cf_uri}/GeneralLedger/Category/b211a2a3-0be9-477c-940e-1c8bac139cf1"
    • },
  • "Memo" : "Paycheque",
  • "PayrollCategories" : [
    • {
    • "PayrollCategory" : {
      • "UID" : "e4c2d4bd-76f9-4655-9b0b-ae29a3a3093b",
      • "Name" : "Base Salary",
      • "Type" : "Wage",
      • "URI" : "{cf_uri}/Payroll/PayrollCategory/Wage/e4c2d4bd-76f9-4655-9b0b-ae29a3a3093b"
      • },
      • "Hours" : null,
      • "Amount" : 1250.00,
      • "IsCalculated" : false,
      • "Job" : null
      • },
      • {
      • "PayrollCategory" : {
        • "UID" : "b0b10807-dd73-4d3f-a420-9d6720dedb8b",
        • "Name" : "PAYG Withholding",
        • "Type" : "Tax",
        • "URI" : "{cf_uri}/Payroll/PayrollCategory/Tax/b0b10807-dd73-4d3f-a420-9d6720dedb8b"
        • },
        • "Hours" : null,
        • "Amount" : 0,
        • "IsCalculated" : true,
        • "Job" : null
        • },
      • {
      • "PayrollCategory" : {
        • "UID" : "16ab6175-ec02-4aea-b349-8d8afd0e1618",
        • "Name" : "Holiday Leave Accrual",
        • "Type" : "Entitlement",
        • "URI" : "{cf_uri}/Payroll/PayrollCategory/Entitlement/16ab6175-ec02-4aea-b349-8d8afd0e1618"
        • },
        • "Hours" : null,
        • "Amount" : 0,
        • "IsCalculated" : true,
        • "Job" : null
        • },
      • {
      • "PayrollCategory" : {
        • "UID" : "43e24a74-c3c4-4766-b977-9e6c6a54bb39",
        • "Name" : "Sick Leave Accrual",
        • "Type" : "Entitlement",
        • "URI" : "{cf_uri}/Payroll/PayrollCategory/Entitlement/143e24a74-c3c4-4766-b977-9e6c6a54bb39"
        • },
        • "Hours" : null,
        • "Amount" : 0,
        • "IsCalculated" : true,
        • "Job" : null
        • },
      • {
      • "PayrollCategory" : {
        • "UID" : "d09027ff-c607-4037-ace4-2c86c067e0f0",
        • "Name" : "Holiday Pay",
        • "Type" : "Wage",
        • "URI" : "{cf_uri}/Payroll/PayrollCategory/Wage/d09027ff-c607-4037-ace4-2c86c067e0f0"
        • },
        • "Hours" : 0,
        • "Amount" : 0,
        • "IsCalculated" : false,
        • "Job" : null
        • },
      • {
      • "PayrollCategory" : {
        • "UID" : "8ba9c693-91b5-45ab-9f5a-f542e5773496",
        • "Name" : "Sick Pay",
        • "Type" : "Wage",
        • "URI" : "{cf_uri}/Payroll/PayrollCategory/Wage/8ba9c693-91b5-45ab-9f5a-f542e5773496"
        • },
        • "Hours" : 0,
        • "Amount" : 0,
        • "IsCalculated" : false,
        • "Job" : null
        • },
      • {
      • "PayrollCategory" : {
        • "UID" : "479cf725-a62c-4fb2-a5ff-0edeaa64a5d3",
        • "Name" : "Superannuation Guarantee",
        • "Type" : "Superannuation",
        • "URI" : "{cf_uri}/Payroll/PayrollCategory/Superannuation/479cf725-a62c-4fb2-a5ff-0edeaa64a5d3"
        • },
        • "Hours" : 0,
        • "Amount" : 0,
        • "IsCalculated" : true,
        • "Job" : null
        • }
      • ],
    • "URI" : "{cf_uri}/Contact/EmployeePayrollDetails/5t55818c-855a-452e-be92-d8a1595fc4d4",
    • "RowVersion" : "73910496369862302"
    • }
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.