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
pensionId
The Id of the Pension.
string uuid "string"
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 "2021-10-23"
workerGroupId
The Id of the WorkerGroup.
string uuid "string"
pensionRule 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 WorkerGroup {WorkerGroup}
forcedTier
If the WorkerGroup ContributionLevelType is a Tiered Scheme then the name of the tier to force the employee on to may be specified.
If none is specified then the Tier is determined by the earnings in the period
string "string"
tiers TieredPensionRate[] {TieredPensionRate}
assumedPensionablePay
Assumed Pensionable Pay. If the employee is receiving any Statutory Leave that has an AssumedPensionablePay value set then it'll be shown here.
number double 0.0
pensionablePayCodes
If the pension scheme is set to override the Pensionale PayCodes, then this is what they've been set to.
string[]
{
  "pensionId": "string",
  "name": "string",
  "pensionSchemeId": "string",
  "startDate": "2021-10-23",
  "workerGroupId": "string",
  "pensionRule": "ReliefAtSource",
  "papdisPensionProviderId": "string",
  "papdisEmployerId": "string",
  "employeePensionContributionMultiplier": 0.0,
  "additionalVoluntaryContribution": 0.0,
  "avcIsPercentage": true,
  "autoEnrolled": true,
  "workerGroup": {
    "name": "string",
    "contributionLevelType": "UserDefined",
    "employeeContribution": 0.0,
    "employeeContributionIsPercentage": true,
    "employerContribution": 0.0,
    "employerContributionIsPercentage": true,
    "employerContributionTopUpPercentage": 0.0,
    "customThreshold": true,
    "lowerLimit": 0.0,
    "upperLimit": 0.0,
    "papdisGroup": "string",
    "papdisSubGroup": "string",
    "localAuthorityNumber": "string",
    "schoolEmployerType": "string",
    "workerGroupId": "string",
    "id": "string"
  },
  "forcedTier": "string",
  "tiers": [
    {
      "name": "string",
      "description": "string",
      "rangeStart": 0.0,
      "rate": 0.0
    }
  ],
  "assumedPensionablePay": 0.0,
  "pensionablePayCodes": [
    "string"
  ]
}
Contained in Models
PayRunEntry
Consumed by Operations

- none -

Returned by Operations

- none -