NI YTD Pay Instruction



NiYtdPayInstruction [Schema]

Name Type Required Description
Value Money yes The total employee contributions.
EmployerNI Money yes The total employer contributions.
NiablePay Money yes The total pay amount subject to national insurance.
NiLetter NiLetter yes The employee National Insurance category letter.
LEL Money no The pay value below the lower earning limit.
LELtoPT Money no The pay value between the lower earning limit and primary threshold.
PTtoST Money no The pay value between the primary and secondary threshold.
STtoUST Money no The pay value between the secondary threshold and upper secondary threshold. (Tax year 2016 onwards)
STtoAUST Money no The pay value between the secondary threshold and apprentice upper secondary threshold. (apprentice under 25 and tax year 2016 onwards)
USTtoUEL Money no The pay value between the upper secondary threshold and upper earnings limit.
AboveUEL Money no The pay value above the upper earning limit.
DirCalculationMethod DirCalculationMethod yes The type of directorship calculation used.
IsAdjustment xsd:boolean yes Indicates if the instruction is an adjustment. Pay lines generated from adjustment YTD instructions appear on the employee pay slip.
PeriodsCovered xsd:integer ( min: 1 max: 99) no The number of pay periods to use in NI calculations. Added to support back pay situations. If omitted, defaults to '1'

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"?>
<NiYtdPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2020-10-28</StartDate>
  <EndDate>2020-10-28</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <Value>123.99</Value>
  <EmployerNI>123.99</EmployerNI>
  <NiablePay>123.99</NiablePay>
  <NiLetter>string</NiLetter>
  <LEL>123.99</LEL>
  <LELtoPT>123.99</LELtoPT>
  <PTtoST>123.99</PTtoST>
  <STtoUST>123.99</STtoUST>
  <STtoAUST>123.99</STtoAUST>
  <USTtoUEL>123.99</USTtoUEL>
  <AboveUEL>123.99</AboveUEL>
  <DirCalculationMethod>Off</DirCalculationMethod>
  <IsAdjustment>true</IsAdjustment>
  <PeriodsCovered>123</PeriodsCovered>
</NiYtdPayInstruction>

{
  "NiYtdPayInstruction": {
    "StartDate": "2020-10-28",
    "EndDate": "2020-10-28",
    "Description": "string",
    "PayLineTag": "string",
    "Value": "123.99",
    "EmployerNI": "123.99",
    "NiablePay": "123.99",
    "NiLetter": "string",
    "LEL": "123.99",
    "LELtoPT": "123.99",
    "PTtoST": "123.99",
    "STtoUST": "123.99",
    "STtoAUST": "123.99",
    "USTtoUEL": "123.99",
    "AboveUEL": "123.99",
    "DirCalculationMethod": "Off",
    "IsAdjustment": "true",
    "PeriodsCovered": "123"
  }
}