Pay Line NI

A PayLineNI record will be produced following the calculation of a NiPayInstruction or NiYtdPayInstruction.



PayLineNi [Schema]

This type is readonly.

Name Type Description
LEL xsd:decimal The pay value below the lower earning limit.
LELtoPT xsd:decimal The pay value between the lower earning limit and primary threshold.
LELtoST xsd:decimal The pay value between the lower earning limit and secondary threshold.
STtoUST xsd:decimal The pay value between the secondary threshold and upper secondary threshold. (Tax year 2016 onwards)
STtoAUST xsd:decimal The pay value between the secondary threshold and apprentice upper secondary threshold. (apprentice under 25 and tax year 2016 onwards)
PTtoUEL xsd:decimal The pay value between the primary threshold and upper earnings limit.
AboveUEL xsd:decimal The pay value above the upper earning limit.
EmployerNI xsd:decimal The total employer contributions.
DirCalculationMethod DirCalculationMethod The type of directorship calculation used.
NiLetter NiLetter The employee National Insurance category letter.
NiablePay xsd:decimal The total pay amount subject to national insurance.
WeeksAsDirector xsd:integer The number of weeks the employee has been a director.
PeriodsCovered xsd:integer The number of pay periods to use in NI calculations. Added to support back pay situations.

Interits from: PayLine[Schema]

Name Type Description
PayLine PayLine
Description xsd:string ( max: 100) The description of the pay line displayed in the payslip report.
Calculator xsd:string ( max: 300) The name of a Calculator responsible for generating the pay line.
Generated xsd:dateTime The date and time the pay line was generated.
PayCode xsd:string ( max: 35) A loose linkage to the type of pay line and it's calculator treatment.
PayCodeType SystemCodeType The category of pay line.
Value Money The monetary value of the pay line; used in the net pay sum. Typically positive for payments and negative for deductions.
PaymentDate xsd:date The date the employees were paid in the pay run. Not applicable for year to date generated lines.
TaxYear xsd:integer The tax year the pay run was in.
TaxPeriod xsd:integer The tax period the pay run was in.
PayRunSequence xsd:integer The sequence number of the owning pay run.

Example

<?xml version="1.0"?>
<PayLineNi xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Description>string</Description>
  <Calculator>string</Calculator>
  <Generated>2021-09-16T00:00:00+00:00</Generated>
  <PayCode>string</PayCode>
  <PayCodeType>NotSet</PayCodeType>
  <Value>123.99</Value>
  <PaymentDate>2021-09-16</PaymentDate>
  <TaxYear>123</TaxYear>
  <TaxPeriod>123</TaxPeriod>
  <PayRunSequence>123</PayRunSequence>
  <LEL>123.99</LEL>
  <LELtoPT>123.99</LELtoPT>
  <LELtoST>123.99</LELtoST>
  <STtoUST>123.99</STtoUST>
  <STtoAUST>123.99</STtoAUST>
  <PTtoUEL>123.99</PTtoUEL>
  <AboveUEL>123.99</AboveUEL>
  <EmployerNI>123.99</EmployerNI>
  <DirCalculationMethod>Off</DirCalculationMethod>
  <NiLetter>string</NiLetter>
  <NiablePay>123.99</NiablePay>
  <WeeksAsDirector>123</WeeksAsDirector>
  <PeriodsCovered>123</PeriodsCovered>
</PayLineNi>

{
  "PayLineNi": {
    "Description": "string",
    "Calculator": "string",
    "Generated": "2021-09-16T00:00:00+00:00",
    "PayCode": "string",
    "PayCodeType": "NotSet",
    "Value": "123.99",
    "PaymentDate": "2021-09-16",
    "TaxYear": "123",
    "TaxPeriod": "123",
    "PayRunSequence": "123",
    "LEL": "123.99",
    "LELtoPT": "123.99",
    "LELtoST": "123.99",
    "STtoUST": "123.99",
    "STtoAUST": "123.99",
    "PTtoUEL": "123.99",
    "AboveUEL": "123.99",
    "EmployerNI": "123.99",
    "DirCalculationMethod": "Off",
    "NiLetter": "string",
    "NiablePay": "123.99",
    "WeeksAsDirector": "123",
    "PeriodsCovered": "123"
  }
}