Pension Pay Instruction



PensionPayInstruction [Schema]

Name Type Required Description
Code SystemCode no [Optional] The payment code override. If omitted; use value defined in pension scheme.
EmployeeContributionCash Money no [Optional] The employee cash contribution amount override. If omitted; use value defined in pension scheme.
EmployerContributionCash Money no [Optional] The employer cash contribution amount override. If omitted; use value defined in pension scheme.
EmployeeContributionPercent Percentage no [Optional] The employee contribution percentage override. If omitted; use value defined in pension scheme.
EmployerContributionPercent Percentage no [Optional] The employer contribution percentage override. If omitted; use value defined in pension scheme.
AdditionalVoluntaryContributionCash Money no [Optional] The employee additional voluntary cash contribution amount.
AdditionalVoluntaryContributionPercent Percentage no [Optional] The employee additional voluntary contribution percentage amount.
LowerThreshold Money no [Optional] The lower contribution cut off threshold. If specified; contributions will only be calculated on pensionable pay exceeding the thresh hold. If omitted; use value defined in pension scheme.
UpperThreshold Money no [Optional] The upper contribution cut off threshold. If specified; contributions will only be calculated on pensionable pay below the thresh hold. If omitted; use value defined in pension scheme.
SalarySacrifice xsd:boolean no [Optional] Determines if the contributions are calculated using the salary sacrifice method. If omitted; use value defined in pension scheme.
TaxationMethod PensionTaxationMethod no [Optional] The pension calculation taxation method override. If omitted; use value defined in pension scheme.
ProRataMethod ProRataMethod no The pro-rata method option to be used. If omitted; use the value defined in the pension scheme. See Pro-rata Calculation Methods for more information.
Pension Link yes A link to the related pension scheme.

Interits from: PayInstruction[Schema]

See Understanding Pay Instructions for more information on how pay instructions can be used.

Name Type Required Description
StartDate xsd:date yes The date the instruction will come into effect.
EndDate xsd:date no The date the instruction will end, open ended instructions will run forever.
Description xsd:string ( max: 200) no The pay line descripton override; this description will override the default description from the pay code. See Customising the Payslip for more information on customising the payslip output and using runtime variables.
PayLineTag xsd:string ( max: 100) no If specified, the PayLineTag value is used to decorate all child pay lines generated by the instruction.

Example

<?xml version="1.0"?>
<PensionPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2020-12-01</StartDate>
  <EndDate>2020-12-01</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <Code>string</Code>
  <EmployeeContributionCash>123.99</EmployeeContributionCash>
  <EmployerContributionCash>123.99</EmployerContributionCash>
  <EmployeeContributionPercent>123.99</EmployeeContributionPercent>
  <EmployerContributionPercent>123.99</EmployerContributionPercent>
  <AdditionalVoluntaryContributionCash>123.99</AdditionalVoluntaryContributionCash>
  <AdditionalVoluntaryContributionPercent>123.99</AdditionalVoluntaryContributionPercent>
  <LowerThreshold>123.99</LowerThreshold>
  <UpperThreshold>123.99</UpperThreshold>
  <SalarySacrifice>true</SalarySacrifice>
  <TaxationMethod>NotSet</TaxationMethod>
  <ProRataMethod>NotSet</ProRataMethod>
  <Pension title="string" href="string" rel="string" />
</PensionPayInstruction>

{
  "PensionPayInstruction": {
    "StartDate": "2020-12-01",
    "EndDate": "2020-12-01",
    "Description": "string",
    "PayLineTag": "string",
    "Code": "string",
    "EmployeeContributionCash": "123.99",
    "EmployerContributionCash": "123.99",
    "EmployeeContributionPercent": "123.99",
    "EmployerContributionPercent": "123.99",
    "AdditionalVoluntaryContributionCash": "123.99",
    "AdditionalVoluntaryContributionPercent": "123.99",
    "LowerThreshold": "123.99",
    "UpperThreshold": "123.99",
    "SalarySacrifice": "true",
    "TaxationMethod": "NotSet",
    "ProRataMethod": "NotSet",
    "Pension": {
      "@title": "string",
      "@href": "string",
      "@rel": "string"
    }
  }
}