Pension

Name / Description Type / Format Example
contributionLevelType string "UserDefined" "StatutoryMinimum" "Nhs2015" "Tp2020"
id
The unique id of the object
string uuid "string"
pensionSchemeId string uuid "string"
pensionScheme PensionScheme {PensionScheme}
workerGroupId string uuid "string"
workerGroup WorkerGroup {WorkerGroup}
startDate string date "2020-07-14"
memberReferenceNumber string "string"
overrideContributions
If this is set to true then the Contributions levels set for the WorkerGroup will be replaced with the values provided here
boolean true
employeeContribution
The amount the employee contributes towards the pension. Could be a percentage or a fixed amount depending on EmployeeContributionIsPercentage.
This is read-only if OverrideContributions is false
number double 0.0
employeeContributionIsPercentage
Determines whether the Value of the EmployeeContribution is a fixed amount or a percentage,
boolean true
employerContribution
The amount the employer contributes towards the pension. Could be a percentage or a fixed amount depending on EmployerContributionIsPercentage.
This is read-only if OverrideContributions is false
number double 0.0
employerContributionIsPercentage
Determines whether the Value of the EmployerContribution is a fixed amount or a percentage,
boolean true
isAeQualifyingScheme
Whether or not the associated PensionScheme is a Qualifying Scheme for AutoEnrolment
boolean true
isTeachersPension
Whether or not the associated PensionScheme is a Teachers' Pension (determined by its CsvFormat)
boolean true
aeStatusAtJoining string "Eligible" "NonEligible" "Entitled" "NoDuties"
externalEmployeeId string "string"
additionalVoluntaryContribution
Any additional voluntary amount the employer contributes towards the pension. Could be a percentage or a fixed amount depending on AvcIsPercentage.
number double 0.0
avcIsPercentage
Determines whether the Value of the Additional Voluntary Contribution is a fixed amount or a percentage,
boolean true
exitViaProvider boolean true
forceEnrolment
If the PensionScheme is connected to an ExternalDataProvider that supports enrolment then setting this to true will force this employee to be enrolled with the next submission.
boolean true
teachersPensionDetails
Used to represent additional information needed for Teachers' Pensions
TeachersPensionDetails {TeachersPensionDetails}
forcedTier
If the WorkerGroup ContributionLevelType is a Tiered Scheme then you can specify the name of the tier to force the employee on to.
If none is specified then the Tier is determined by the earnings in the period
string "string"
autoEnrolled
Is True if the employee joined this Pension due to an AutoEnrolment action
boolean true
{
  "contributionLevelType": "UserDefined",
  "id": "string",
  "pensionSchemeId": "string",
  "pensionScheme": {
    "name": "string",
    "provider": {
      "name": "string",
      "accountNo": "string",
      "portal": "string",
      "website": "string",
      "address": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "line4": "string",
        "line5": "string",
        "postCode": "string",
        "country": "England"
      },
      "telephone": "string",
      "papdisVersion": "PAP10",
      "papdisProviderId": "string",
      "papdisEmployerId": "string",
      "csvFormat": "Papdis",
      "excludeNilPaidFromContributions": true,
      "payPeriodDateAdjustment": 0,
      "miscBoolean1": true,
      "miscBoolean2": true,
      "miscString1": "string",
      "miscString2": "string",
      "id": "string"
    },
    "administrator": {
      "name": "string",
      "email": "string",
      "address": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "line4": "string",
        "line5": "string",
        "postCode": "string",
        "country": "England"
      },
      "telephone": "string",
      "id": "string"
    },
    "pensionRule": "ReliefAtSource",
    "qualifyingScheme": true,
    "disableAeLetters": true,
    "subtractBasicRateTax": true,
    "payMethod": "Cash",
    "bankDetails": {
      "bankName": "string",
      "bankBranch": "string",
      "bankReference": "string",
      "accountName": "string",
      "accountNumber": "string",
      "sortCode": "string",
      "note": "string"
    },
    "workerGroups": [
      {
        "name": "string",
        "contributionLevelType": "UserDefined",
        "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"
      }
    ],
    "externalDataProviderId": "SmartPension_Employer",
    "externalDataCompany": {
      "id": "string",
      "name": "string",
      "schemeName": "string"
    },
    "id": "string"
  },
  "workerGroupId": "string",
  "workerGroup": {
    "name": "string",
    "contributionLevelType": "UserDefined",
    "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"
  },
  "startDate": "2020-07-14",
  "memberReferenceNumber": "string",
  "overrideContributions": true,
  "employeeContribution": 0.0,
  "employeeContributionIsPercentage": true,
  "employerContribution": 0.0,
  "employerContributionIsPercentage": true,
  "isAeQualifyingScheme": true,
  "isTeachersPension": true,
  "aeStatusAtJoining": "Eligible",
  "externalEmployeeId": "string",
  "additionalVoluntaryContribution": 0.0,
  "avcIsPercentage": true,
  "exitViaProvider": true,
  "forceEnrolment": true,
  "teachersPensionDetails": {
    "employmentType": "FullTime",
    "fullTimeSalary": 0,
    "partTimeSalaryPaid": 0
  },
  "forcedTier": "string",
  "autoEnrolled": true
}
Contained in Models

- none -

Consumed by Operations
Update Pension
Returned by Operations
Get Pension
Update Pension