PersonalDetails

Name / Description Type / Format Example
address Address {Address}
maritalStatus string "Single" "Married" "Divorced" "Widowed" "CivilPartnership"
title string "string"
firstName string "string"
middleName string "string"
lastName string "string"
email string "string"
emailPayslip
If set to true then the employees Payslip will be sent by email when a PayRun is finalised.
boolean true
passwordProtectPayslip
If set to true then when a payslip is sent by email a password will be set on it.
boolean true
emailStatement
Only applicable to CIS Subcontractors. If set to true then we will automatically email a CIS Statement when a CIS300 is accepted.
boolean true
photoUrl string "string"
telephone string "string"
mobile string "string"
dateOfBirth string date-time "2019-11-12T17:18:53"
statePensionAge
Automatically calculated.
integer int32 0
gender string "Male" "Female"
niNumber string "string"
passportNumber string "string"
partnerDetails PartnerDetails {PartnerDetails}
{
  "address": {
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "line4": "string",
    "line5": "string",
    "postCode": "string",
    "country": "England"
  },
  "maritalStatus": "Single",
  "title": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "email": "string",
  "emailPayslip": true,
  "passwordProtectPayslip": true,
  "emailStatement": true,
  "photoUrl": "string",
  "telephone": "string",
  "mobile": "string",
  "dateOfBirth": "2019-11-12T17:18:53",
  "statePensionAge": 0,
  "gender": "Male",
  "niNumber": "string",
  "passportNumber": "string",
  "partnerDetails": {
    "firstName": "string",
    "initials": "string",
    "lastName": "string",
    "niNumber": "string"
  }
}
Contained in Models
Employee
PayRunEntry
Payslip
Consumed by Operations

- none -

Returned by Operations

- none -