Contract.PersonalDetailsResponse

Schema

Name / Description Type / Format Example
statePensionAge
Automatically calculated.
 integer int32 0
address Contract.Address {Contract.Address}
maritalStatus string "Single" "Married" "Divorced" "Widowed" "CivilPartnership" "Unknown"
title string "string"
firstName string "string"
middleName string "string"
lastName string "string"
alternativeEmail string email "string"
previousSurName 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
pdfPassword
Set the password to be used on PDFs. If blank then we'll create a password based on the PdfPasswordType property.
 string "string"
pdfPasswordType string "InitialsAndDob" "NiNumber" "Custom"
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"
photoSasUrl string "string"
mobile string "string"
dateOfBirth string date "2024-12-22"
gender string "Male" "Female"
niNumber string "string"
passportNumber string "string"
partnerDetails Contract.PartnerDetails {Contract.PartnerDetails}

JSON Example 

{
  "statePensionAge": 0,
  "address": {
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "line4": "string",
    "line5": "string",
    "postCode": "string",
    "country": "England",
    "foreignCountry": "string"
  },
  "maritalStatus": "Single",
  "title": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "alternativeEmail": "string",
  "previousSurName": "string",
  "email": "string",
  "emailPayslip": true,
  "pdfPassword": "string",
  "pdfPasswordType": "InitialsAndDob",
  "emailStatement": true,
  "photoUrl": "string",
  "telephone": "string",
  "photoSasUrl": "string",
  "mobile": "string",
  "dateOfBirth": "2024-12-22",
  "gender": "Male",
  "niNumber": "string",
  "passportNumber": "string",
  "partnerDetails": {
    "firstName": "string",
    "initials": "string",
    "lastName": "string",
    "niNumber": "string"
  }
}

References

Contained in Models
Contract.EmployeeResponse
Consumed by Operations

- none -

Returned by Operations

- none -