Methods

  • get - Get Employee By External Reference ID
  • get - Get Employee By External ID
  • get - Get Employee By ID
  • get - List Employees
  • post - Create or Update Employee
  • put - Update Employee
  • post - Save Details

Resource

{
    "anniversaryDate": "date-time",
    "automaticallyPayEmployee": "string",
    "bankAccount1_AccountName": "string",
    "bankAccount1_AccountNumber": "string",
    "bankAccount1_AllocatedPercentage": "double",
    "bankAccount1_BankCode": "string",
    "bankAccount1_BankName": "string",
    "bankAccount1_BranchCode": "string",
    "bankAccount1_FixedAmount": "double",
    "bankAccount2_AccountName": "string",
    "bankAccount2_AccountNumber": "string",
    "bankAccount2_AllocatedPercentage": "double",
    "bankAccount2_BankCode": "string",
    "bankAccount2_BankName": "string",
    "bankAccount2_BranchCode": "string",
    "bankAccount2_FixedAmount": "double",
    "bankAccount3_AccountName": "string",
    "bankAccount3_AccountNumber": "string",
    "bankAccount3_AllocatedPercentage": "double",
    "bankAccount3_BankCode": "string",
    "bankAccount3_BankName": "string",
    "bankAccount3_BranchCode": "string",
    "bankAccount3_FixedAmount": "double",
    "dateCreated": "date-time",
    "dateOfBirth": "date-time",
    "dependentChildren": "string",
    "eisExempt": "string",
    "emailAddress": "string",
    "emergencyContact1_Address": "string",
    "emergencyContact1_AlternateContactNumber": "string",
    "emergencyContact1_ContactNumber": "string",
    "emergencyContact1_Name": "string",
    "emergencyContact1_Relationship": "string",
    "emergencyContact2_Address": "string",
    "emergencyContact2_AlternateContactNumber": "string",
    "emergencyContact2_ContactNumber": "string",
    "emergencyContact2_Name": "string",
    "emergencyContact2_Relationship": "string",
    "employingEntityId": "string",
    "employmentType": "string",
    "endDate": "date-time",
    "epfContributionType": "string",
    "epfNumber": "string",
    "ethnicity": "string",
    "externalId": "string",
    "firstName": "string",
    "gender": "string",
    "homePhone": "string",
    "hoursPerDay": "double",
    "hoursPerWeek": "double",
    "id": "int32",
    "identityCardNumber": "string",
    "incomeTaxNumber": "string",
    "isEnabledForTimesheets": "string",
    "jobTitle": "string",
    "leaveAccrualStartDateType": "string",
    "leaveTemplate": "string",
    "leaveYearStart": "date-time",
    "locations": "string",
    "maritalStatus": "string",
    "middleName": "string",
    "mobilePhone": "string",
    "nationality": "string",
    "overrideTemplateRate": "string",
    "passportIssuingCountry": "string",
    "passportNumber": "string",
    "payConditionRuleSet": "string",
    "payRateTemplate": "string",
    "paySchedule": "string",
    "paySlipNotificationType": "string",
    "pcbTaxBorne": "boolean",
    "postalAddressLine2": "string",
    "postalAddressLine3": "string",
    "postalAddressType": "string",
    "postalBlockNumber": "string",
    "postalCountry": "string",
    "postalLevelNumber": "string",
    "postalPostCode": "string",
    "postalState": "string",
    "postalStreetAddress": "string",
    "postalStreetName": "string",
    "postalSuburb": "string",
    "postalUnitNumber": "string",
    "preferredName": "string",
    "primaryLocation": "string",
    "primaryPayCategory": "string",
    "rate": "double",
    "rateUnit": "string",
    "religion": "string",
    "residenceStatus": "string",
    "residenceType": "string",
    "residentialAddressLine2": "string",
    "residentialAddressLine3": "string",
    "residentialAddressType": "string",
    "residentialBlockNumber": "string",
    "residentialCountry": "string",
    "residentialLevelNumber": "string",
    "residentialPostCode": "string",
    "residentialState": "string",
    "residentialStreetAddress": "string",
    "residentialStreetName": "string",
    "residentialSuburb": "string",
    "residentialUnitNumber": "string",
    "rosteringNotificationChoices": "string",
    "socsoType": "string",
    "ssfwNumber": "string",
    "startDate": "date-time",
    "status": "string",
    "surname": "string",
    "tags": "string",
    "terminationReason": "string",
    "title": "string",
    "workPhone": "string",
    "workTypes": "string",
    "workerStatus": "string"
}

Properties

Name Type Description
anniversaryDate date-time Nullable
automaticallyPayEmployee string String
bankAccount1_AccountName string String
bankAccount1_AccountNumber string String
bankAccount1_AllocatedPercentage double Nullable
bankAccount1_BankCode string String
bankAccount1_BankName string String
bankAccount1_BranchCode string String
bankAccount1_FixedAmount double Nullable
bankAccount2_AccountName string String
bankAccount2_AccountNumber string String
bankAccount2_AllocatedPercentage double Nullable
bankAccount2_BankCode string String
bankAccount2_BankName string String
bankAccount2_BranchCode string String
bankAccount2_FixedAmount double Nullable
bankAccount3_AccountName string String
bankAccount3_AccountNumber string String
bankAccount3_AllocatedPercentage double Nullable
bankAccount3_BankCode string String
bankAccount3_BankName string String
bankAccount3_BranchCode string String
bankAccount3_FixedAmount double Nullable
dateCreated date-time DateTime
dateOfBirth date-time Nullable
dependentChildren string String
eisExempt string String
emailAddress string String
emergencyContact1_Address string String
emergencyContact1_AlternateContactNumber string String
emergencyContact1_ContactNumber string String
emergencyContact1_Name string String
emergencyContact1_Relationship string String
emergencyContact2_Address string String
emergencyContact2_AlternateContactNumber string String
emergencyContact2_ContactNumber string String
emergencyContact2_Name string String
emergencyContact2_Relationship string String
employingEntityId string String
employmentType string String
endDate date-time Nullable
epfContributionType string String
epfNumber string String
ethnicity string String
externalId string String
firstName string String
gender string String
homePhone string String
hoursPerDay double Nullable
hoursPerWeek double Nullable
id int32 Int32
identityCardNumber string String
incomeTaxNumber string String
isEnabledForTimesheets string String
jobTitle string String
leaveAccrualStartDateType string Nullable

Possible values are:

  • EmployeeStartDate
  • SpecifiedDate
leaveTemplate string String
leaveYearStart date-time Nullable
locations string String
maritalStatus string String
middleName string String
mobilePhone string String
nationality string String
overrideTemplateRate string String
passportIssuingCountry string String
passportNumber string String
payConditionRuleSet string String
payRateTemplate string String
paySchedule string String
paySlipNotificationType string String
pcbTaxBorne boolean Boolean
postalAddressLine2 string String
postalAddressLine3 string String
postalAddressType string Nullable

Possible values are:

  • LocalAddress
  • ForeignAddress
  • LocalCareOfAddress
postalBlockNumber string String
postalCountry string String
postalLevelNumber string String
postalPostCode string String
postalState string String
postalStreetAddress string String
postalStreetName string String
postalSuburb string String
postalUnitNumber string String
preferredName string String
primaryLocation string String
primaryPayCategory string String
rate double Nullable
rateUnit string String
religion string String
residenceStatus string String
residenceType string String
residentialAddressLine2 string String
residentialAddressLine3 string String
residentialAddressType string AddressTypeEnum

Possible values are:

  • LocalAddress
  • ForeignAddress
  • LocalCareOfAddress
residentialBlockNumber string String
residentialCountry string String
residentialLevelNumber string String
residentialPostCode string String
residentialState string String
residentialStreetAddress string String
residentialStreetName string String
residentialSuburb string String
residentialUnitNumber string String
rosteringNotificationChoices string String
socsoType string String
ssfwNumber string String
startDate date-time Nullable
status string EmployeeStatusEnum

Possible values are:

  • Active
  • Terminated
  • Incomplete
surname string String
tags string String
terminationReason string String
title string String
workPhone string String
workTypes string String
workerStatus string String