NI Pay Instructions



NiPayInstruction [Schema]

Name Type Required Description
DirCalculationMethod DirCalculationMethod yes The calculation method to be used when treating and employee as a director. See employees as directors for more information.
NiLetter NiLetter yes The employee's NI letter category. See using the correct NI letter for more information.

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"?>
<NiPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2019-09-30</StartDate>
  <EndDate>2019-09-30</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <DirCalculationMethod>Off</DirCalculationMethod>
  <NiLetter>string</NiLetter>
</NiPayInstruction>
{
  "NiPayInstruction": {
    "StartDate": "2019-09-30",
    "EndDate": "2019-09-30",
    "Description": "string",
    "PayLineTag": "string",
    "DirCalculationMethod": "Off",
    "NiLetter": "string"
  }
}