PapdisEmployee

Schema

Name / Description Type / Format Example
id integer int32 0
employeeId string uuid "string"
name PapdisEmployeeName {PapdisEmployeeName}
identity PapdisEmployeeIdentity {PapdisEmployeeIdentity}
contact PapdisEmployeeContact {PapdisEmployeeContact}
pay PapdisEmployeePay {PapdisEmployeePay}
assessment PapdisEmployeeAssessment {PapdisEmployeeAssessment}
contribution PapdisEmployeeContribution {PapdisEmployeeContribution}
exit PapdisEmployeeExit {PapdisEmployeeExit}
payrollCode string "string"
aeStateDate string date "2024-12-22"
leaveDate string date "2024-12-22"
statePensionAge integer int32 0
contractualJoinerIndicator boolean true
jobTitle string "string"
pensionMemberReference string "string"
pensionUniqueId string "string"
employeeRoleUniqueId string uuid "string"
lastPaymentDate
The last time the employee was paid
 string date "2024-12-22"
hasPrevioulyLeftPension
Flag indicating the employee has previously left the pension
 boolean true
pensionablePayDefinition string "NotApplicable" "QualifyingEarnings" "BasicPay" "TotalPay" "OwnDefinition"

JSON Example 

{
  "id": 0,
  "employeeId": "string",
  "name": {
    "title": "string",
    "forename1": "string",
    "forename2": "string",
    "surname": "string"
  },
  "identity": {
    "employeeId": "string",
    "birthDate": "2024-12-22",
    "gender": "string",
    "nationalInsuranceNumber": "string",
    "employmentStartDate": "2024-12-22",
    "maritalStatus": "Single"
  },
  "contact": {
    "postalAddress": {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "address4": "string",
      "postcode": "string",
      "country": "string"
    },
    "emailAddress": "string",
    "secondaryEmailAddress": "string",
    "telephone": "string",
    "mobile": "string"
  },
  "pay": {
    "pensionableEarningsAmount": 0.0,
    "totalGrossQualifyingEarningsAmount": 0.0,
    "annualSalary": 0.0,
    "annualPensionableEarningsAmount": 0.0,
    "basis": "Hourly",
    "payAmountMultiplier": 0.0
  },
  "assessment": {
    "assessmentCode": 0,
    "eventCode": 0,
    "eventDate": "2024-12-22",
    "statutoryLetterCode": "string",
    "isIndividualAlreadyMemberOfQPS": true,
    "deferralDate": "2024-12-22",
    "enrolmentCommunicationsIssuedDate": "2024-12-22",
    "workerExclusionCode": "string",
    "reenrolmentIndicator": true,
    "optOutWindowEndDate": "2024-12-22",
    "pensionJoinReason": "Automatic",
    "pensionStartDate": "2024-12-22"
  },
  "contribution": {
    "employerContributionsAmount": 0.0,
    "employerContributionsPercent": 0.0,
    "employeeContributionsAmount": 0.0,
    "employeeContributionsPercent": 0.0,
    "additionalVoluntaryContributionsAmount": 0.0,
    "additionalVoluntaryContributionsPercent": 0.0,
    "salarySacrificeIndicator": true,
    "contributionStartDate": "2024-12-22",
    "employeeContributionIsPercentage": true,
    "employerContributionIsPercentage": true,
    "unadjustedEmployeeContributionsAmount": 0.0,
    "unadjustedEmployerContributionsAmount": 0.0,
    "unadjustedAdditionalVoluntaryContributionsAmount": 0.0,
    "employerContributionNiSavings": 0.0,
    "contributionLevelType": "UserDefined",
    "isAvcOnly": true,
    "employerContributionIncludesNiSaving": true,
    "unadjustedAdditionalVoluntaryContributionsPercent": 0.0,
    "isHalfContributionMember": true,
    "assumedPensionablePay": 0.0,
    "isPensionRefund": true,
    "lowerLimit": 0.0
  },
  "exit": {
    "exitDate": "2024-12-22",
    "exitReasonCode": 0,
    "aeOptOutDate": "2024-12-22",
    "aeOptOutReference": "string",
    "reasonForLeaving": "string"
  },
  "payrollCode": "string",
  "aeStateDate": "2024-12-22",
  "leaveDate": "2024-12-22",
  "statePensionAge": 0,
  "contractualJoinerIndicator": true,
  "jobTitle": "string",
  "pensionMemberReference": "string",
  "pensionUniqueId": "string",
  "employeeRoleUniqueId": "string",
  "lastPaymentDate": "2024-12-22",
  "hasPrevioulyLeftPension": true,
  "pensionablePayDefinition": "NotApplicable"
}

References

Contained in Models
PapdisPayrollPeriod
Consumed by Operations

- none -

Returned by Operations

- none -