Methods

  • get - Get Employee By ID
  • get - Get Employee By External ID
  • 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

Resource

{
    "anniversaryDate": "date-time",
    "appointmentStartDate": "date-time",
    "assessmentDate": "date-time",
    "assessmentStatus": "string",
    "automaticallyPayEmployee": "string",
    "bankAccount1_AccountName": "string",
    "bankAccount1_AccountNumber": "string",
    "bankAccount1_AllocatedPercentage": "double",
    "bankAccount1_FixedAmount": "double",
    "bankAccount1_SortCode": "string",
    "bankAccount2_AccountName": "string",
    "bankAccount2_AccountNumber": "string",
    "bankAccount2_AllocatedPercentage": "double",
    "bankAccount2_FixedAmount": "double",
    "bankAccount2_SortCode": "string",
    "bankAccount3_AccountName": "string",
    "bankAccount3_AccountNumber": "string",
    "bankAccount3_AllocatedPercentage": "double",
    "bankAccount3_FixedAmount": "double",
    "bankAccount3_SortCode": "string",
    "dateCreated": "date-time",
    "dateOfBirth": "date-time",
    "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",
    "employeePaidIrregularly": "string",
    "employeeStarterType": "string",
    "employeeStatement": "string",
    "employmentType": "string",
    "endDate": "date-time",
    "externalId": "string",
    "firstName": "string",
    "gender": "string",
    "hasPostGradLoan": "boolean",
    "hasStudentLoan": "boolean",
    "homePhone": "string",
    "hoursPerWeek": "double",
    "id": "int32",
    "isApprentice": "string",
    "isCompanyDirector": "string",
    "isEnabledForTimesheets": "string",
    "isExemptFromMinimumWage": "string",
    "jobTitle": "string",
    "leaveAccrualStartDateType": "string",
    "leaveTemplate": "string",
    "leaveYearStart": "date-time",
    "locations": "string",
    "middleName": "string",
    "mobilePhone": "string",
    "nationalInsuranceCalculationMethod": "string",
    "nationalInsuranceCategory": "string",
    "nationalInsuranceNumber": "string",
    "optInDate": "date-time",
    "overrideTemplateRate": "string",
    "payConditionRuleSet": "string",
    "payRateTemplate": "string",
    "paySchedule": "string",
    "paySlipNotificationType": "string",
    "payrollId": "string",
    "pensionAssessmentOption": "string",
    "pensionContributionGroup": "string",
    "postalAddressIsOverseas": "boolean",
    "postalAddressLine2": "string",
    "postalCity": "string",
    "postalCountry": "string",
    "postalCounty": "string",
    "postalPostCode": "string",
    "postalStreetAddress": "string",
    "preferredName": "string",
    "previousEmployerContinueStudentLoanDeductions": "boolean",
    "previousEmployerLeavingDate": "date-time",
    "previousEmployerOfficeNumber": "string",
    "previousEmployerReferenceNumber": "string",
    "previousEmployerTaxCode": "string",
    "previousEmployerTaxPeriodFrequency": "string",
    "previousEmployerTaxPeriodNumber": "int32",
    "previousEmployerTaxWithheld": "double",
    "previousEmployerTaxablePay": "double",
    "previousEmployerW1M1": "boolean",
    "primaryLocation": "string",
    "primaryPayCategory": "string",
    "rate": "double",
    "rateUnit": "string",
    "residentialAddressIsOverseas": "boolean",
    "residentialAddressLine2": "string",
    "residentialCity": "string",
    "residentialCountry": "string",
    "residentialCounty": "string",
    "residentialPostCode": "string",
    "residentialStreetAddress": "string",
    "rosteringNotificationChoices": "string",
    "startDate": "date-time",
    "status": "string",
    "studentLoanType": "string",
    "surname": "string",
    "tags": "string",
    "taxCalculationMethod": "string",
    "taxCode": "string",
    "title": "string",
    "workPhone": "string",
    "workTypes": "string"
}

Properties

Name Type Description
anniversaryDate date-time Nullable
appointmentStartDate date-time Nullable
assessmentDate date-time Nullable
assessmentStatus string String
automaticallyPayEmployee string String
bankAccount1_AccountName string String
bankAccount1_AccountNumber string String
bankAccount1_AllocatedPercentage double Nullable
bankAccount1_FixedAmount double Nullable
bankAccount1_SortCode string String
bankAccount2_AccountName string String
bankAccount2_AccountNumber string String
bankAccount2_AllocatedPercentage double Nullable
bankAccount2_FixedAmount double Nullable
bankAccount2_SortCode string String
bankAccount3_AccountName string String
bankAccount3_AccountNumber string String
bankAccount3_AllocatedPercentage double Nullable
bankAccount3_FixedAmount double Nullable
bankAccount3_SortCode string String
dateCreated date-time DateTime
dateOfBirth date-time Nullable
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
employeePaidIrregularly string String
employeeStarterType string String
employeeStatement string String
employmentType string String
endDate date-time Nullable
externalId string String
firstName string String
gender string String
hasPostGradLoan boolean Boolean
hasStudentLoan boolean Boolean
homePhone string String
hoursPerWeek double Nullable
id int32 Int32
isApprentice string String
isCompanyDirector string String
isEnabledForTimesheets string String
isExemptFromMinimumWage string String
jobTitle string String
leaveAccrualStartDateType string Nullable

Possible values are:

  • EmployeeStartDate
  • SpecifiedDate
leaveTemplate string String
leaveYearStart date-time Nullable
locations string String
middleName string String
mobilePhone string String
nationalInsuranceCalculationMethod string String
nationalInsuranceCategory string String
nationalInsuranceNumber string String
optInDate date-time Nullable
overrideTemplateRate string String
payConditionRuleSet string String
payRateTemplate string String
paySchedule string String
paySlipNotificationType string String
payrollId string String
pensionAssessmentOption string String
pensionContributionGroup string String
postalAddressIsOverseas boolean Nullable
postalAddressLine2 string String
postalCity string String
postalCountry string String
postalCounty string String
postalPostCode string String
postalStreetAddress string String
preferredName string String
previousEmployerContinueStudentLoanDeductions boolean Nullable
previousEmployerLeavingDate date-time Nullable
previousEmployerOfficeNumber string String
previousEmployerReferenceNumber string String
previousEmployerTaxCode string String
previousEmployerTaxPeriodFrequency string String
previousEmployerTaxPeriodNumber int32 Nullable
previousEmployerTaxWithheld double Nullable
previousEmployerTaxablePay double Nullable
previousEmployerW1M1 boolean Nullable
primaryLocation string String
primaryPayCategory string String
rate double Nullable
rateUnit string String
residentialAddressIsOverseas boolean Nullable
residentialAddressLine2 string String
residentialCity string String
residentialCountry string String
residentialCounty string String
residentialPostCode string String
residentialStreetAddress string String
rosteringNotificationChoices string String
startDate date-time Nullable
status string EmployeeStatusEnum

Possible values are:

  • Active
  • Terminated
  • Incomplete
studentLoanType string String
surname string String
tags string String
taxCalculationMethod string String
taxCode string String
title string String
workPhone string String
workTypes string String