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 "2025-07-13"
leaveDate string date "2025-07-13"
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 "2025-07-13"
hasPrevioulyLeftPension
Flag indicating the employee has previously left the pension
 boolean true
pensionablePayDefinition string "NotApplicable" "QualifyingEarnings" "BasicPay" "TotalPay" "OwnDefinition"
isPreviousTaxYearRefund
Indicates whether the employee has a pension refund from the previous tax year.
 boolean true
totalPreviousTaxYearRefundEmployeeAmount
The total amount of pension refunds paid to the employee,
calculated as the sum of all EmployeeRefund values from applicable PensionRefunds (when IsPreviousTaxYearRefund is enabled).
 number double 0.0
totalPreviousTaxYearRefundEmployeeAvcAmount
The total amount of AVC (Additional Voluntary Contributions) refunds paid to the employee,
calculated as the sum of all AdditionalVoluntaryContribution values from applicable PensionRefunds (when IsPreviousTaxYearRefund is enabled).
 number double 0.0
totalPreviousTaxYearRefundEmployerAmount
The total amount of employer pension refunds,
calculated as the sum of all EmployerRefund values from applicable PensionRefunds (when IsPreviousTaxYearRefund is enabled).
 number double 0.0

JSON Example 

{
  "id": 0,
  "employeeId": "string",
  "name": {
    "title": "string",
    "forename1": "string",
    "forename2": "string",
    "surname": "string"
  },
  "identity": {
    "employeeId": "string",
    "birthDate": "2025-07-13",
    "gender": "string",
    "nationalInsuranceNumber": "string",
    "employmentStartDate": "2025-07-13",
    "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": "2025-07-13",
    "statutoryLetterCode": "string",
    "isIndividualAlreadyMemberOfQPS": true,
    "deferralDate": "2025-07-13",
    "enrolmentCommunicationsIssuedDate": "2025-07-13",
    "workerExclusionCode": "string",
    "reenrolmentIndicator": true,
    "optOutWindowEndDate": "2025-07-13",
    "pensionJoinReason": "Automatic",
    "pensionStartDate": "2025-07-13"
  },
  "contribution": {
    "employerContributionsAmount": 0.0,
    "employerContributionsPercent": 0.0,
    "employeeContributionsAmount": 0.0,
    "employeeContributionsPercent": 0.0,
    "additionalVoluntaryContributionsAmount": 0.0,
    "additionalVoluntaryContributionsPercent": 0.0,
    "salarySacrificeIndicator": true,
    "contributionStartDate": "2025-07-13",
    "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,
    "isPensionAvcPayLine": true
  },
  "exit": {
    "exitDate": "2025-07-13",
    "exitReasonCode": 0,
    "aeOptOutDate": "2025-07-13",
    "aeOptOutReference": "string",
    "reasonForLeaving": "string"
  },
  "payrollCode": "string",
  "aeStateDate": "2025-07-13",
  "leaveDate": "2025-07-13",
  "statePensionAge": 0,
  "contractualJoinerIndicator": true,
  "jobTitle": "string",
  "pensionMemberReference": "string",
  "pensionUniqueId": "string",
  "employeeRoleUniqueId": "string",
  "lastPaymentDate": "2025-07-13",
  "hasPrevioulyLeftPension": true,
  "pensionablePayDefinition": "NotApplicable",
  "isPreviousTaxYearRefund": true,
  "totalPreviousTaxYearRefundEmployeeAmount": 0.0,
  "totalPreviousTaxYearRefundEmployeeAvcAmount": 0.0,
  "totalPreviousTaxYearRefundEmployerAmount": 0.0
}

References

Contained in Models
PapdisPayrollPeriod
Consumed by Operations

- none -

Returned by Operations

- none -