Pension
The pension entity represents the default configuration of an employer's pension scheme; it is a revisable object so that changes to the scheme over time are correctly represented in the payroll history. See revisible objects for more information on revisions and how they work.
Pension [Schema]
Name | Type | Required | Description |
---|---|---|---|
EffectiveDate | xsd:date | yes | The date the revision will come into effect. |
Revision | Revision | no | The revision number of the pension scheme; this is a readonly system generated value. |
Code | SystemCode | no | Allows an override of the default pay code used by the pension scheme. |
SchemeName | xsd:string ( max: 250) | yes | The name of the pension scheme. |
ProviderName | xsd:string ( max: 250) | yes | The name of the pension provider. |
ProviderEmployerRef | xsd:string ( max: 100) | yes | The reference issued by the pension provider. |
Group | xsd:string ( max: 100) | no | The group name within the pension scheme. |
SubGroup | xsd:string ( max: 100) | no | The sub-group name within the pension scheme. |
EmployeeContributionCash | Money | no | The employee's gross cash contribution. |
EmployerContributionCash | Money | no | The employer's gross cash contribution. |
EmployeeContributionPercent | Percentage | no | The employee's percentage contribution from their pensionable pay. |
EmployerContributionPercent | Percentage | no | The employer's percentage contribution from the employee's pensionable pay. |
LowerThreshold | Money | no | The lower earning threshold; only pensionable pay above this value will be included for calculating contributions. Thresholds are predominantly used for triggering Auto Enrolment contributions; see Auto Enrolment for more information.. |
UpperThreshold | Money | no | The upper earning threshold; only pensionable pay below this value will be included for calculating contributions. Thresholds are predominantly used for triggering Auto Enrolment contributions; see Auto Enrolment for more information.. |
TaxationMethod | PensionTaxationMethod | yes | The taxation method to use when calculating pension contributions; this should be mandated by your pension provider. |
ContributionDeductionDay | DayOfMonth | no | The normal day of the month when contributions will be deducted. |
SalarySacrifice | xsd:boolean | yes | The salary sacrifice option. Used to indicate if the pension scheme employee contributions should make use of salary sacrifice. |
EmployerNiSaving | xsd:boolean | no | The employer NI savings option. Used to indicate if the employers NI contribution salary sacrifice savings are included in the pension contribution amount. |
EmployerNiSavingPercentage | Percentage | no | The employers NI percentage to be used when calculating salary sacrifice employer NI savings. |
ProRataMethod | ProRataMethod | yes | The pro-rata method option to be used; the default is not set. See Pro-rata Calculation Methods for more information. |
RoundingOption | RoundingOption | no | The rounding option to use when calculating pension deductions from both employee and employer; default is Bankers. |
RasRoundingOverride | RoundingOption | no | Used to override the default rounding behaviour for relief at source calculations. |
AECompatible | xsd:boolean | yes | The Auto Enrolment compatibility indicator. Used to indicate if this pension scheme is compatible with auto enrolment requirements. |
UseAEThresholds | xsd:boolean | yes | The Use Auto Enrolment Thresholds indicator. Used to indicate if this pension scheme uses the auto enrolment thresholds. |
PensionablePayCodes | SystemCode (list of) |
yes | The list of pay codes that contribute to the pensionable pay amount. |
QualifyingPayCodes | SystemCode (list of) |
yes | The list of pay codes that contribute to the qualifying earnings pay amount. |
MetaData | MetaData | no | The optional pension meta data collection. |
Example
<?xml version="1.0"?>
<Pension xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<EffectiveDate>2021-01-14</EffectiveDate>
<Revision>123</Revision>
<SchemeName>string</SchemeName>
<ProviderName>string</ProviderName>
<ProviderEmployerRef>string</ProviderEmployerRef>
<Group>string</Group>
<SubGroup>string</SubGroup>
<EmployeeContributionCash>123.99</EmployeeContributionCash>
<EmployerContributionCash>123.99</EmployerContributionCash>
<EmployeeContributionPercent>123.99</EmployeeContributionPercent>
<EmployerContributionPercent>123.99</EmployerContributionPercent>
<LowerThreshold>123.99</LowerThreshold>
<UpperThreshold>123.99</UpperThreshold>
<TaxationMethod>NotSet</TaxationMethod>
<Code>string</Code>
<ContributionDeductionDay>123</ContributionDeductionDay>
<SalarySacrifice>true</SalarySacrifice>
<EmployerNiSaving>true</EmployerNiSaving>
<EmployerNiSavingPercentage>123.99</EmployerNiSavingPercentage>
<ProRataMethod>NotSet</ProRataMethod>
<RoundingOption>NotSet</RoundingOption>
<RasRoundingOverride>NotSet</RasRoundingOverride>
<AECompatible>true</AECompatible>
<UseAEThresholds>true</UseAEThresholds>
<PensionablePayCodes>
<PayCode>string</PayCode>
</PensionablePayCodes>
<QualifyingPayCodes>
<PayCode>string</PayCode>
</QualifyingPayCodes>
<MetaData>
<Item Name="string">string</Item>
</MetaData>
</Pension>
{
"Pension": {
"EffectiveDate": "2021-01-14",
"Revision": "123",
"SchemeName": "string",
"ProviderName": "string",
"ProviderEmployerRef": "string",
"Group": "string",
"SubGroup": "string",
"EmployeeContributionCash": "123.99",
"EmployerContributionCash": "123.99",
"EmployeeContributionPercent": "123.99",
"EmployerContributionPercent": "123.99",
"LowerThreshold": "123.99",
"UpperThreshold": "123.99",
"TaxationMethod": "NotSet",
"Code": "string",
"ContributionDeductionDay": "123",
"SalarySacrifice": "true",
"EmployerNiSaving": "true",
"EmployerNiSavingPercentage": "123.99",
"ProRataMethod": "NotSet",
"RoundingOption": "NotSet",
"RasRoundingOverride": "NotSet",
"AECompatible": "true",
"UseAEThresholds": "true",
"PensionablePayCodes": {
"PayCode": [
"string"
]
},
"QualifyingPayCodes": {
"PayCode": [
"string"
]
},
"MetaData": {
"Item": [
{
"@Name": "string",
"#text": "string"
}
]
}
}
}