| Name / Description | Type / Format | Example | |
|---|---|---|---|
name
|
string
|
"string"
|
|
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"
|
|
employeeContribution
|
number
double
|
0.0
|
|
employeeContributionIsPercentage
|
boolean
|
true
|
|
employerContribution
|
number
double
|
0.0
|
|
employerContributionIsPercentage
|
boolean
|
true
|
|
employerContributionTopUpPercentage
Increase Employer Contribution by this percentage of the Employee Contribution
|
number
double
|
0.0
|
|
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
|
|
isAvc
Determines whether the workergroup uses additonal voluntary contributions.
This property will automatically be set to true for the following Contribution Level Types: TpFasterAccrual, TpAdditionalPensionContributions, TpActuariallyAdjustedBenefits, TpFamilyBenefits, tpPastAddedYears, tpHigherSalaries, tpPreston, tpElectedFurtherEmployment, LgpsAdditionalPensionContributions, LgpsSharedAdditionalPensionContributions, LgpsAdditionalRegularContributions, LgpsAddedYearsContributions, LgpsSharedAdditionalPensionLumpSump, LgpsPartTimeBuyBack, PrudentialAVC. |
boolean
|
true
|
|
additionalVoluntaryContribution
Any additional voluntary amount the employee 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
|
|
employerContributionNiSaving
Employers NI Saving
|
number
double
|
0.0
|
|
customThreshold
|
boolean
|
true
|
|
lowerLimit
|
number
double
|
0.0
|
|
upperLimit
|
number
double
|
0.0
|
|
papdisGroup
|
string
|
"string"
|
|
papdisSubGroup
|
string
|
"string"
|
|
localAuthorityNumber
Only applicable if ContributionLevelType is TeachersPensionEnglandAndWales
|
string
|
"string"
|
|
schoolEmployerType
Only applicable if ContributionLevelType is TeachersPensionEnglandAndWales
|
string
|
"string"
|
|
matIdentifier
Only applicable if ContributionLevelType is TeachersPensionEnglandAndWales
|
string
|
"string"
|
|
matUniqueNumber
Only applicable if ContributionLevelType is TeachersPensionEnglandAndWales
|
string
|
"string"
|
|
employerReference
|
string
|
"string"
|
|
lgpsFund
|
string
|
"Avon"
"BarkingAndDagenham"
"Barnet"
"Bedfordshire"
"Berkshire"
"Bexley"
"Brent"
"Bromley"
"Buckinghamshire"
"Cambridgeshire"
"Camden"
"Cardiff"
"Cheshire"
"CityOfWestminster"
"Clwyd"
"Cornwall"
"Croydon"
"Cumbria"
"Derbyshire"
"Devon"
"Dorset"
"Durham"
"Dyfed"
"Ealing"
"EastRiding"
"EastSussex"
"Enfield"
"Essex"
"Gloucestershire"
"GreaterGwent"
"GreaterManchester"
"Greenwich"
"Gwynedd"
"Hackney"
"HammersmithAndFulham"
"Hampshire"
"Haringey"
"Harrow"
"Havering"
"Hertfordshire"
"Hillingdon"
"Hounslow"
"IsleOfWight"
"Islington"
"KensingtonAndChelsea"
"Kent"
"KingstonUponThames"
"Lambeth"
"Lancashire"
"Leicestershire"
"Lewisham"
"Lincolnshire"
"LondonPensionsFundAuthority"
"Merseyside"
"Merton"
"Newham"
"Norfolk"
"NorthYorkshire"
"Northamptonshire"
"Northumberland"
"Nottinghamshire"
"Oxfordshire"
"Powys"
"Redbridge"
"RhonddaCynonTaf"
"Shropshire"
"Somerset"
"SouthYorkshire"
"Southwark"
"Staffordshire"
"Suffolk"
"Surrey"
"Sutton"
"Swansea"
"Teesside"
"TowerHamlets"
"TyneAndWear"
"WalthamForest"
"Wandsworth"
"Warwickshire"
"WestMidlandsPassengerTransport"
"WestMidlands"
"WestSussex"
"WestYorkshire"
"Wiltshire"
"Worcestershire"
|
|
workerGroupId
|
string
uuid
|
"string"
|
|
assumedPensionablePay
|
string
|
"AssumedPensionablePay"
"NormalPay"
"HigherOfTheTwo"
|
|
pensionablePayDefinition
|
string
|
"NotApplicable"
"QualifyingEarnings"
"BasicPay"
"TotalPay"
"OwnDefinition"
|
|
payslipDescription
Used for overwriting the pension description that is displayed on the payslip
|
string
|
"string"
|
|
id
The unique id of the object
|
string
uuid
|
"string"
|
{
"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"
}- none -
- none -