Employee



Represents an employee revision. See revisible objects for more information on revisions and how they work.

Employee [Schema]

Name Type Required Description
EffectiveDate xsd:date yes The date the revision will come into effect.
Revision Revision no The revision number of the employee; this is a readonly system generated value.
Code xsd:string ( min: 2 max: 35)
Pattern: [A-Za-z0-9\-\/]*		 yes The employee's unique code also known as the payroll Id The code must be unique to Employer and never reused.
Title Name no The employee's formal title.
FirstName Name no The employee's first name.
MiddleName Name no The employee's middle name(s) (if any).
Initials Name no The employee's initial, if not supplying a first name.
LastName Name yes The employee's last name or surname.
NiNumber NiNumber no The employee's National Insurance number issued by HMRC. Temporary NI numbers should no longer be used for payroll
DateOfBirth xsd:date yes The employee's date of birth. The correct date of birth will ensure the correct NI letter is assigned.
DirectorshipAppointmentDate xsd:date no The date the directorship appointment started.
Gender xsd:string (enumeration)
  • Unknown
  • Male
  • Female
 yes The employee's current gender.
NicLiability xsd:string
Pattern: (?:(?:IsFullyLiable|HasOtherJob|IsFemaleEntitledToReducedRate|IsNotLiable|IsContractedOut|IsApprentice|LeaverBeyond6Weeks)\s?){1,4}		 yes The NIC liability flags are used to ensure the correct NI letter is assigned. See Using the correct NI letter code for more information on setting the correct NIC liability flags.
Region CalculatorRegion yes The employee's region which determines the correct calculators to be used.
Territory CalculatorTerritory yes The employee's territory which determines the correct calculators to be used. Currently United Kingdom is the only supported territory.
PaySchedule Link no A link to the Pay Schedule resource that the employee is assigned to.
StartDate xsd:date no The commencement date of the employee's employment.
StarterDeclaration xsd:string (enumeration)
  • A
  • B
  • C
  • NA
 no The declaration made by the employee.
LeavingDate xsd:date no The date the employee leaves the employment.
LeaverReason xsd:string (enumeration)
  • Resigned
  • Dismissed
  • Redundant
  • Retired
  • Deceased
  • LegalCustody
  • Other
 no The reason the employee leaves the employment.
RuleExclusions RuleExclusionFlags yes The list of pre-calculation rules to exclude. See Pre-calculation rules for more information on how they work.
WorkingWeek xsd:string
Pattern: (?:(?:None|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday|AllWeekDays|AllDays)\s?){1,4}		 yes The employee's normal working week pattern.
Address Address no The employee's home address.
HoursPerWeek xsd:double ( min: 0 max: 168) yes The employee's normal number of hours worked per week (irrespective of pay frequency).
PassportNumber xsd:string ( min: 1 max: 10)
Pattern: [0-9]*		 no The employee's UK passport number (if applicable).
Seconded xsd:string (enumeration)
  • NotSet
  • Stay183DaysOrMore
  • StayLessThan183Days
  • InOutUk
 no Indicates if the employee is on secondment from abroad.
IsAgencyWorker xsd:boolean no Indicates if the employee is an agency worker.
EEACitizen xsd:boolean no Indicates if the seconded employee is a citizen of the European Economic Area.
EPM6 xsd:boolean no Indicates if the seconded employee is under an EPM6 (Modified) Scheme for tax equalised expatriate employees.
PaymentToANonIndividual xsd:boolean no Indicates where payments are made to a body, such as personal representative, trustee or corporate organisation.
IrregularEmployment xsd:boolean no Indicates if the employee is paid on an irregular basis.
OnStrike xsd:boolean no Indicates if the employee's pay in this pay period has been reduced due to being on strike.
PaymentMethod PaymentMethod no The employee's preferred payment method.
MaritalStatus xsd:string (enumeration)
  • NotSet
  • Single
  • Married
  • Divorced
  • Widowed
 no The employee's marital status.
BankAccount BankAccount no The employee's bank account details; used for BACS payments.
EmployeePartner EmployeePartner no The employee's partner details; used when paying ShPP
AEAssessmentOverride AEAssessmentOverride yes The auto enrolment assessment override value. Enables the auto enrolment assessment result to be overridden
AEAssessmentOverrideDate xsd:date no The auto enrolment assessment override date. Determines the date when auto enrolment assessment override applies.
AEPostponementDate xsd:date no The auto enrolment deferment date. Indicates the date when auto enrolment assessments are deferred to.
Deactivated xsd:boolean no Indicates if the employee is deactivated. Deactivated employees cannot be included in a pay run.

EmployeePartner



The details of the employee's partner only need be provided when claiming ShPP.

EmployeePartner [Schema]

Name Type Required Description
Title Name no The employee's partner formal title.
FirstName Name no The employee's partner first name.
MiddleName Name no The employee's partner middle name.
Initials Name no The employee's partner intial, if not supplying a first name.
LastName Name yes The employee's partner lastname or surname.
NiNumber NiNumber no The employee's partner National Insurance number issued by HMRC.