EmployeePayrollDetails

Return and update employee payroll details on employee contacts for Australian Files.

Date Released: May 2014 Date Updated: May 2021
URLSupports
/{cf_uri}/Contact/EmployeePayrollDetails 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 EmployeePayrollDetails. 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 identifier in the form of a guid.
    Required: for updating an existing employee's payroll 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.
  • DateOfBirthDateTime
  • The employee's date of birth, format YYYY-MM-DD HH:MM:SS { 'DateOfBirth': '1969-09-10 00:00:00' }
  • GenderString
  • Gender of the employee contact.
  • StartDateDateTime
  • Date the employee began employment, format YYYY-MM-DD HH:MM:SS { 'StartDate': '2002-09-10 00:00:00' }
  • TerminationDateDateTime
  • Date the employee’s employment was terminated, format YYYY-MM-DD HH:MM:SS { 'TerminationDate': '2009-09-10 00:00:00' }
  • EmploymentBasisString
  • Employment basis can consist of the following:
    Individual (Defaults to individual on PUT if not specified)
    Labor Hire
    Other
  • EmploymentCategoryString
  • Employment category can consist of the following:
    Permanent (Defaults to permanent on PUT if not specified)
    Temporary
  • EmploymentStatusString
  • Employment status can consist of the following:
    FullTime (Defaults to full time on PUT if not specified)
    PartTime
    Other
    Casual
  • EmploymentClassification
  • The following set of information pulls through details for the employment classification
    • UIDGuid (36)
    • Optional only required if choosing to pass object on PUT.
      Unique guid identifier belonging to the employment classification.
    • NameString (255)
    • Name of the employment classification.
    • URIString
    • Uniform resource identifier associated with the employment classification.
  • PaySlipDeliveryString
  • The methods by which the payslip can be sent:
    ToBePrinted (Defaults to be printed on PUT if not specified)
    ToBeEmailed
    ToBePrintedAndEmailed
    AlreadyPrintedOrSent
  • PaySlipEmailString (255)
  • Email address to which payslips should be emailed.
  • Wage
  • The following set of information pulls through details for the employee wage setup
    • PayBasisString
    • PayBasis can consist of the following:
      Salary (Defaults to salary on PUT if not specified)
      Hourly
    • AnnualSalaryDecimal (13.2)
    • Annual salary amount for the employee.
    • HourlyRateDecimal (13.4)
    • Employee's hourly rate.
    • PayFrequencyString
    • Pay frequency can consist of the following:
      Weekly (Defaults to weekly on PUT if not specified)
      Fortnightly
      TwiceAMonth
      Monthly
    • HoursInWeeklyPayPeriodDecimal (13.3)
    • Hours worked in a pay period
      Defaults to 40 on PUT if not specified.
    • WagesExpenseAccount
    • Details for the employee default linked expense account.
      • UIDGuid (36)
      • Required: if passing on PUT.
        Foreign Key: Unique identifier for the account in the form of a guid.
      • NameString (60)
      • Account name belonging to the account record.
      • DisplayIDString (6)
      • Account code format includes separator ie 6-5100{ 'DisplayID': '6-5100' }
      • URIString
      • Uniform resource identifier associated with the account object.
    • WageCategories []
    • An array of wage categories the employee is linked to
      • UIDGuid (36)
      • Required: 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.
  • Superannuation
  • The following set of information pulls through details for superannuation setup
    • SuperannuationFund
    • The following set of information pulls through details for the superannuation fund
      • UIDGuid (36)
      • Optional only required if choosing to pass object on PUT
        Unique guid identifier belonging to the superannuation fund.
      • NameString (76)
      • Name of the superannuation fund.
      • URIString
      • Uniform resource identifier associated with the superannuation fund.
    • EmployeeMembershipNumberString (17)
    • Employee's membership number.
    • SuperannuationCategories []
    • An array of superannuation categories the employee is linked to
      • UIDGuid (36)
      • Optional only required if choosing to pass object on PUT
        Unique payroll superannuation category identifier in the form of a guid.
      • NameString (31)
      • Name of the payroll superannuation category.
      • TypeString
      • Indicates the type of payroll category ie: Wage, Deduction, Superannuation.
      • URI String
      • Uniform resource identifier associated with the payroll superannuation category object.
  • Entitlements []
  • The following set of information pulls through details for each linked entitlement category
    • EntitlementCategory
    • The following set of information pulls through details for each entitlement category
      • UIDGuid (36)
      • Required: if passing on PUT.
        Unique payroll entitlement category identifier in the form of a guid.
      • NameString (31)
      • Name of the payroll entitlement category.
      • TypeString
      • Indicates the type of payroll category ie: Wage, Deduction, Superannuation.
      • URI String
      • Uniform resource identifier associated with the payroll entitlement category object.
    • IsAssignedBoolean
    • Determined by the setup of the Payroll entitlement category.
    • CarryOverDecimal (13.3)
    • The number of hours carried over from the previous payroll year.
    • YearToDateDecimal (13.3)
    • Net number of hours accrued this payroll year.
    • TotalDecimal (13.3)
    • The number of hours available on the entitlement (Total = CarryOver + YearToDate)
  • Deductions []
  • The following set of information pulls through details for each linked deductions category
    • UIDGuid (36)
    • Optional only required if choosing to pass object on PUT.
      Unique payroll deductions category identifier in the form of a guid.
    • NameString (31)
    • Name of the payroll deductions category.
    • TypeString
    • Indicates the type of payroll category ie: Wage, Deduction, Superannuation.
    • URI String
    • Uniform resource identifier associated with the payroll deductions category object.
  • EmployerExpenses []
  • The following set of information pulls through details for each linked employer expenses category
    • UIDGuid (36)
    • Optional only required if choosing to pass object on PUT
      Unique payroll employer expenses category identifier in the form of a guid.
    • NameString (31)
    • Name of the payroll employer expenses category.
    • TypeString
    • Indicates the type of payroll category ie: Wage, Deduction, Superannuation.
    • URI String
    • Uniform resource identifier associated with the payroll employer expenses category object.
  • Tax
  • The following set of information pulls through details for the taxes setup
    • TaxFileNumberString (11)
    • Employee tax file number (Must be 9 digits and formatted as XXX XXX XXX). This is masked as to comply with the ATO operational framework{ 'TaxFileNumber': 'xxx xxx xxx' }
    • TaxTable
    • The following set of information pulls through details for the Linked tax table for an employee
      • UIDGuid (36)
      • Required: if passing on PUT.
        Unique payroll tax table identifier in the form of a guid.
      • NameString (31)
      • Name of the payroll tax table.
      • URI String
      • Uniform resource identifier associated with the payroll tax table object.
    • WithholdingVariationRate Double (99.99%)
    • % rate that applies if selected tax table = Withholding Variation.
    • TotalRebatesPerYearDecimal (13.2)
    • The employee’s total rebates offset amount.
    • ExtraTaxPerPayDecimal (13.2)
    • The employee’s extra tax withheld from there pay.
    • TaxCategory
    • The following set of information pulls through details for the Linked tax category for an employee
      • UIDGuid (36)
      • Required: if passing on PUT.
        Unique payroll tax category identifier in the form of a guid.
      • NameString (31)
      • Name of the payroll tax category.
      • TypeString
      • Indicates the type of payroll category ie: Wage, Deduction, Superannuation.
      • URI String
      • Uniform resource identifier associated with the payroll tax category object.
  • TimeBilling
  • The following set of information pulls through details for the employee's time billing rates and hours
    • EmployeeBillingRateExcludingTaxDecimal (13.2)
    • Hourly billing rate for services provided by employee.
    • CostPerHourDecimal (13.2)
    • Hourly cost.
  • 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 payroll details.

For more information, check out our Knowledge base article "Employee Payroll Details Endpoint".

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

Example json GET response

  • {
  • "UID" : "0af1126b-57e7-48a7-83b1-b26333896fac",
  • "Employee" : {
    • "UID" : "5383ff72-4bb6-4d8b-bcf0-8b10857455d8",
    • "Name" : "Mary Jones",
    • "DisplayID" : "EMP00001",
    • "URI" : "{cf_uri}/Contact/Employee/5383ff72-4bb6-4d8b-bcf0-8b10857455d8"
    • },
  • "DateOfBirth" : "1972-01-01T00:00:00",
  • "Gender" : "Female",
  • "StartDate" : "2007-05-01T00:00:00",
  • "TerminationDate" : null,
  • "EmploymentBasis" : "Individual",
  • "EmploymentCategory" : "Permanent",
  • "EmploymentStatus" : "FullTime",
  • "EmploymentClassification" : null,
  • "PaySlipDelivery" : "ToBePrintedAndEmailed",
  • "PaySlipEmail" : "Jones@aol.com",
  • "Wage" : {
    • "PayBasis" : "Salary",
    • "AnnualSalary" : "50000.00,
    • "HourlyRate" : 24.038500,
    • "PayFrequency" : "Weekly",
    • "HoursInWeeklyPayPeriod" : 40.000
    • "WagesExpenseAccount" : {
      • "UID" : "f580f0e1-cd44-4955-aa67-aa4a58dba4c1",
      • "Name" : "Wages & Salaries",
      • "DisplayID" : "6-5100",
      • "URI" : "{cf_uri}/GeneralLedger/Account/f580f0e1-cd44-4955-aa67-aa4a58dba4c1"
      • },
    • "WagesCategories" : [
      • {
      • "UID" : "e4c2d4bd-76f9-4655-9b0b-ae29a3a3093b",
      • "Name" : "Base Salary",
      • "Type" : "Wage",
      • "URI" : "{cf_uri}/Payroll/PayrollCategory/Wage/e4c2d4bd-76f9-4655-9b0b-ae29a3a3093b"
      • },
      • {
      • "UID" : "3b114d92-c6e2-4057-b27e-c6d912c99aaa",
      • "Name" : "Sick Pay",
      • "Type" : "Wage",
      • "URI" : "{cf_uri}/Payroll/PayrollCategory/Wage/3b114d92-c6e2-4057-b27e-c6d912c99aaa"
      • },
      • {
      • "UID" : "12977075-a394-4223-a6fc-49b48368b284",
      • "Name" : "Holiday Pay",
      • "Type" : "Wage",
      • "URI" : "{cf_uri}/Payroll/PayrollCategory/Wage/12977075-a394-4223-a6fc-49b48368b284""
      • }
    • ]
  • },
  • "Superannuation" : null,
  • "Entitlements" : [
    • {
    • "EntitlementCategory" : {
      • "UID" : "1425988d-d12b-4751-9c6c-249042fbbe52",
      • "Name" : "Sick Leave Accrual",
      • "Type" : "Entitlement",
      • "URI" : "{cf_uri}/Payroll/PayrollCategory/Entitlement/1425988d-d12b-4751-9c6c-249042fbbe52"
      • },
    • "IsAssigned" : true,
    • "CarryOver" : 0,
    • "YearToDate" : 71.995,
    • "Total" : 71.995,
    • },
  • "EntitlementCategory" : {
    • "UID" : "470d9b21-b730-410d-b6f2-411a34a63bbc",
    • "Name" : "Holiday Leave Accrual",
    • "Type" : "Entitlement",
    • "URI" : "{cf_uri}/Payroll/PayrollCategory/Entitlement/470d9b21-b730-410d-b6f2-411a34a63bbc"
    • },
  • "IsAssigned" : true,
  • "CarryOver" : 0,
  • "YearToDate" : 160,
  • "Total" : 160,
  • }
  • ],
  • "Deductions" : [],
  • "EmployerExpenses" : [],
  • "Tax" : {
    • "TaxFileNumber" : "xxx xxx xxx",
    • "TaxTable" : {
      • "UID" : "083cf715-fd1e-40d2-a118-730bedde0b79",
      • "Name" : "Tax Free Threshold",
      • "URI" : "{cf_uri}/Payroll/PayrollCategory/TaxTable/083cf715-fd1e-40d2-a118-730bedde0b79"
      • },
    • "WithholdingVariationRate" : 0,
    • "TotalRebatesPerYear" : 0,
    • "ExtraTaxPerPay" : 0,
    • "TaxCategory" : {
      • "UID" : "3b53454f-0db9-422b-b9c3-71b5420307ac",
      • "Name" : "PAYG Withholding",
      • "Type" : "Tax",
      • "URI" : "{cf_uri}/Payroll/PayrollCategory/Tax/3b53454f-0db9-422b-b9c3-71b5420307ac"
      • }
    • },
  • "TimeBilling" : {
    • "EmployeeBillingRateExcludingTax" : 45,
    • "CostPerHour" : 16,
    • },
  • "URI" : "{cf_uri}/Contact/EmployeePayrollDetails/0af1126b-57e7-48a7-83b1-b26333896fac",
  • "RowVersion" : "43910096366862336"
  • }
  • 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.