EmployeePayrollDetails

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.