PensionSummary

If a PayRunEntry contains pension contributions then it'll also include a PensionSummary model giving further information about the Pension Scheme and the contributions made

Name / Description Type / Format Example
name
The name of the PensionScheme to which contributions have been made.
string "string"
pensionSchemeId
The Id of the PensionScheme.
string uuid "string"
startDate string date-time "2019-11-17T19:42:10"
workerGroupId
The Id of the WorkerGroup.
string uuid "string"
pensionRule
The PensionRule used by the PensionScheme referred to above.
string "ReliefAtSource" "SalarySacrifice" "NetPayArrangement"
papdisPensionProviderId
Papdis information from the PensionScheme
string "string"
papdisEmployerId
Papdis information from the PensionScheme
string "string"
employeePensionContributionMultiplier
If the PensionScheme is set to SubtractBasicRateTax then this value is used to reduce the contribution amount.
Otherwise it is set as 1.
number double 0.0
additionalVoluntaryContribution
Any Additional Voluntary Contribution the Employee has chosen to make Otherwise it is set as 1.
number double 0.0
avcIsPercentage
Determines whether the Value of the Additional Voluntary Contribution is a fixed amount or a percentage,
boolean true
autoEnrolled
Any Additional Voluntary Contribution the Employee has chosen to make Otherwise it is set as 1.
boolean true
workerGroup
The WorkerGroup from the PensionScheme to which the employee is assigned.
WorkerGroup {WorkerGroup}
{
  "name": "string",
  "pensionSchemeId": "string",
  "startDate": "2019-11-17T19:42:10",
  "workerGroupId": "string",
  "pensionRule": "ReliefAtSource",
  "papdisPensionProviderId": "string",
  "papdisEmployerId": "string",
  "employeePensionContributionMultiplier": 0.0,
  "additionalVoluntaryContribution": 0.0,
  "avcIsPercentage": true,
  "autoEnrolled": true,
  "workerGroup": {
    "name": "string",
    "employeeContribution": 0.0,
    "employeeContributionIsPercentage": true,
    "employerContribution": 0.0,
    "employerContributionIsPercentage": true,
    "customThreshold": true,
    "lowerLimit": 0.0,
    "upperLimit": 0.0,
    "papdisGroup": "string",
    "papdisSubGroup": "string",
    "workerGroupId": "string",
    "id": "string"
  }
}
Contained in Models
PayRunEntry
Consumed by Operations

- none -

Returned by Operations

- none -