Pension

Schema

Name / Description Type / Format Example
employee Item {Item}
contributionLevelType string "UserDefined" "StatutoryMinimum" "Nhs2015" "TeachersPensionEnglandAndWales" "LgpsEnglandAndWales" "TpFasterAccrual" "TpAdditionalPensionContributions" "TpActuariallyAdjustedBenefits" "TpFamilyBenefits" "tpPastAddedYears" "tpHigherSalaries" "tpPreston" "LgpsAdditionalPensionContributions" "LgpsSharedAdditionalPensionContributions" "LgpsAdditionalRegularContributions" "LgpsAddedYearsContributions" "LgpsSharedAdditionalPensionLumpSump" "LgpsPartTimeBuyBack" "PrudentialAVC" "tpElectedFurtherEmployment" "AptisCashIsa" "AptisStocksSharesIsa" "AptisInvestmentAccount"
endDate
The date the employee left the scheme
 string date "2024-11-21"
endReason string "OptOut" "CeasedMembership" "Leaver"
joinReason string "Automatic" "OptIn" "VoluntaryJoiner" "ContractualPension" "Enrol"
startPayRunEntryId
Holds the Id for the payroll that the employee joined the scheme
 integer int32 0
endPayRunEntryId
Holds the Id for the payroll that the employee left the scheme
 integer int32 0
startReportingType string "UsePayRun" "UseAssessment" "AlreadyReported" "UseExisting"
endReportingType string "UsePayRun" "UseAssessment" "AlreadyReported" "UseExisting"
pensionOpeningBalances PensionOpeningBalances {PensionOpeningBalances}
reasonForLeaving
If a value is provided for EndDate then this is the reason for leaving the employee left the scheme
 string "string"
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 "2024-11-21"
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
employerContributionTopUpPercentage
Increase Employer Contribution by this percentage of the Employee Contribution
 number double 0.0
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
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"
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
employerContributionIncludesNiSaving
Employer Contribution includes the Employers NI saving
 boolean true
employerContributionNiSavingPercentage
Increase Employer Contribution by this percentage of the Employers NI saving
 number double 0.0
fiftyFiftySchemeMember
if an employee as a member of the 50/50 LGPS scheme, they can enable contribution to 50% of the normal contributions.
 boolean true
associatedEmployeeRoles
The list of employee roles associated with the pension membership
 Item[] {Item}
autoEnrolled
Is True if the employee joined this Pension due to an AutoEnrolment action
 boolean true

JSON Example 

{
  "employee": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "contributionLevelType": "UserDefined",
  "endDate": "2024-11-21",
  "endReason": "OptOut",
  "joinReason": "Automatic",
  "startPayRunEntryId": 0,
  "endPayRunEntryId": 0,
  "startReportingType": "UsePayRun",
  "endReportingType": "UsePayRun",
  "pensionOpeningBalances": {
    "pensionableEarnings": 0.0,
    "pensionablePay": 0.0,
    "employeePensionContribution": 0.0,
    "employeePensionContributionAvc": 0.0,
    "employerPensionContribution": 0.0,
    "assumedPensionablePay": 0.0
  },
  "reasonForLeaving": "string",
  "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",
        "foreignCountry": "string"
      },
      "telephone": "string",
      "papdisVersion": "PAP10",
      "papdisProviderId": "string",
      "papdisEmployerId": "string",
      "csvFormat": "Papdis",
      "excludeNilPaidFromContributions": true,
      "payPeriodDateAdjustment": 0,
      "miscBoolean1": true,
      "miscBoolean2": true,
      "miscString1": "string",
      "miscString2": "string",
      "optOutWindow": 0,
      "optOutWindowIsMonths": true,
      "id": "string"
    },
    "administrator": {
      "name": "string",
      "email": "string",
      "address": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "line4": "string",
        "line5": "string",
        "postCode": "string",
        "country": "England",
        "foreignCountry": "string"
      },
      "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",
      "buildingSocietyRollNumber": "string"
    },
    "useCustomPayCodes": true,
    "useCustomPayCodesForTierablePay": true,
    "customPayCodes": [
      "string"
    ],
    "tierablePayCustomPayCodes": [
      "string"
    ],
    "workerGroups": [
      {
        "name": "string",
        "contributionLevelType": "UserDefined",
        "employeeContribution": 0.0,
        "employeeContributionIsPercentage": true,
        "employerContribution": 0.0,
        "employerContributionIsPercentage": true,
        "employerContributionTopUpPercentage": 0.0,
        "employerContributionIncludesNiSaving": true,
        "employerContributionNiSavingPercentage": 0.0,
        "isAvc": true,
        "additionalVoluntaryContribution": 0.0,
        "avcIsPercentage": true,
        "employerContributionNiSaving": 0.0,
        "customThreshold": true,
        "lowerLimit": 0.0,
        "upperLimit": 0.0,
        "papdisGroup": "string",
        "papdisSubGroup": "string",
        "localAuthorityNumber": "string",
        "schoolEmployerType": "string",
        "matIdentifier": "string",
        "matUniqueNumber": "string",
        "employerReference": "string",
        "lgpsFund": "Avon",
        "workerGroupId": "string",
        "assumedPensionablePay": "AssumedPensionablePay",
        "pensionablePayDefinition": "NotApplicable",
        "payslipDescription": "string",
        "id": "string"
      }
    ],
    "externalDataProviderId": "SmartPension_Employer",
    "externalDataCompany": {
      "id": "string",
      "name": "string",
      "schemeName": "string"
    },
    "payCodeType": "Default",
    "tierablePayPayCodeType": "Default",
    "payCodeSetUniqueId": "string",
    "tierablePayPayCodeSetUniqueId": "string",
    "paymentDateRule": "OnPayDate",
    "paymentDateDayOfWeek": "Sunday",
    "paymentDateDayOfMonth": 0,
    "reportOptionsLgpsIConnect": {
      "fileType": "SingleFile",
      "payrollReference1": "Empty",
      "payrollReference2": "Empty",
      "payrollReference3": "Empty",
      "populateEmailAddress": true,
      "populateTelephoneNumber": true,
      "populateMobileNumber": true,
      "populateWorksPlaceName": true,
      "populateWorksAddress": true,
      "populateWorksEmailAddress": true,
      "includeEmploymentBreaks": true,
      "breakReasonSmpIndicatorOnly": true,
      "populateMaritalStatus": true,
      "includeAeQualifyingEarnings": true,
      "proRatePtHoursByTermTimeWeeks": true,
      "ignoreTermTimeWeeksForFteFinalPay": true,
      "showFteAnnualSalaryForFteFinalPay": true,
      "casualStaffHoursAsOne": true,
      "casualStaffIndicatorAsY": true,
      "ignoreHours": true,
      "forceUpperCase": true,
      "salaryType": "PayOnJoining",
      "customText": "string"
    },
    "reportOptionsLgpsCivicaUpm": {
      "payrollNumber": "PayrollCode",
      "casualHours": "ReportAsZero",
      "omitHeaderLine": true,
      "includeFolderNo": true,
      "excludeSchoolEmployerName": true,
      "addressesForNewJoinersOnly": true,
      "proRatePtHoursWeeksWorked": true,
      "fullTimeHoursAsOneHundred": true,
      "includeWeeksWorkedColumns": true
    },
    "deficitValueOrdinal": 0,
    "deficitValue": 0.0,
    "includeDeficitValue": true,
    "deficitValuePayPeriod": "Custom",
    "nominalCodeMappings": [
      {
        "nominalCode": "string",
        "nominalName": "string",
        "journalNarrative": "string",
        "payCode": "string"
      }
    ],
    "id": "string"
  },
  "workerGroupId": "string",
  "workerGroup": {
    "name": "string",
    "contributionLevelType": "UserDefined",
    "employeeContribution": 0.0,
    "employeeContributionIsPercentage": true,
    "employerContribution": 0.0,
    "employerContributionIsPercentage": true,
    "employerContributionTopUpPercentage": 0.0,
    "employerContributionIncludesNiSaving": true,
    "employerContributionNiSavingPercentage": 0.0,
    "isAvc": true,
    "additionalVoluntaryContribution": 0.0,
    "avcIsPercentage": true,
    "employerContributionNiSaving": 0.0,
    "customThreshold": true,
    "lowerLimit": 0.0,
    "upperLimit": 0.0,
    "papdisGroup": "string",
    "papdisSubGroup": "string",
    "localAuthorityNumber": "string",
    "schoolEmployerType": "string",
    "matIdentifier": "string",
    "matUniqueNumber": "string",
    "employerReference": "string",
    "lgpsFund": "Avon",
    "workerGroupId": "string",
    "assumedPensionablePay": "AssumedPensionablePay",
    "pensionablePayDefinition": "NotApplicable",
    "payslipDescription": "string",
    "id": "string"
  },
  "startDate": "2024-11-21",
  "memberReferenceNumber": "string",
  "overrideContributions": true,
  "employeeContribution": 0.0,
  "employeeContributionIsPercentage": true,
  "employerContribution": 0.0,
  "employerContributionIsPercentage": true,
  "employerContributionTopUpPercentage": 0.0,
  "isAeQualifyingScheme": true,
  "isTeachersPension": true,
  "aeStatusAtJoining": "Eligible",
  "externalEmployeeId": "string",
  "additionalVoluntaryContribution": 0.0,
  "avcIsPercentage": true,
  "exitViaProvider": true,
  "teachersPensionDetails": {
    "employmentType": "FullTime",
    "fullTimeSalary": 0,
    "partTimeSalaryPaid": 0,
    "mcrRoleId1": "string",
    "mcrRoleId2": "string",
    "teachersPensionAdminNiNumber": "string"
  },
  "forcedTier": "string",
  "forceEnrolment": true,
  "employerContributionIncludesNiSaving": true,
  "employerContributionNiSavingPercentage": 0.0,
  "fiftyFiftySchemeMember": true,
  "associatedEmployeeRoles": [
    {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    }
  ],
  "autoEnrolled": true
}

References

Contained in Models

- none -

Consumed by Operations
Update Pension
Create Pension
Update Pension (deprecated)
Returned by Operations
Get Pension
Update Pension
Create Pension
Get Pension (deprecated)
Update Pension (deprecated)