| Name / Description | Type / Format | Example | |
|---|---|---|---|
pensionRule
|
string
|
"ReliefAtSource"
"SalarySacrifice"
"NetPayArrangement"
|
|
employerId
Taken from the papdisEmployerId property of the PensionProvider
|
string
|
"string"
|
|
group
Taken from the papdisGroup property of the WorkerGroup
|
string
|
"string"
|
|
subGroup
Taken from the papdisSubGroup property of the WorkerGroup
|
string
|
"string"
|
|
payrollPeriod
|
PapdisPayrollPeriod
|
{PapdisPayrollPeriod}
|
|
stagingDate
|
string
date
|
"2024-12-22"
|
|
cyclicalReenrolmentDate
|
string
date
|
"2024-12-22"
|
|
name
|
string
|
"string"
|
|
postalAddress
|
PapdisEmployerContactPostalAddress
|
{PapdisEmployerContactPostalAddress}
|
|
fullTimeContractedHours
|
number
double
|
0.0
|
|
fullTimeContractedWeeks
|
number
double
|
0.0
|
|
contractedWeeks
|
number
double
|
0.0
|
|
id
|
integer
int32
|
0
|
{
"pensionRule": "ReliefAtSource",
"employerId": "string",
"group": "string",
"subGroup": "string",
"payrollPeriod": {
"payPeriodStartDate": "2024-12-22",
"payPeriodEndDate": "2024-12-22",
"contributionDeductionDate": "2024-12-22",
"frequencyCode": "string",
"taxPeriod": 0,
"payReferenceStartDate": "2024-12-22",
"payReferenceEndDate": "2024-12-22",
"employees": [
{
"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": "error too many levels",
"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"
}
]
},
"stagingDate": "2024-12-22",
"cyclicalReenrolmentDate": "2024-12-22",
"name": "string",
"postalAddress": {
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"postcode": "string",
"country": "string"
},
"fullTimeContractedHours": 0.0,
"fullTimeContractedWeeks": 0.0,
"contractedWeeks": 0.0,
"id": 0
}- none -
- none -