NI Adjustment Pay Instruction
NiAdjustmentPayInstruction [Schema]
Name | Type | Required | Description |
---|---|---|---|
Periods | xsd:string Pattern: (\d+)(,*\d+)* |
yes | The affected periods the adjustment applies to as a comma separated list. |
TaxYear | TaxYear | yes | The tax year the adjustment applies to. |
Reason | xsd:string ( max: 500) | no | An optional description for reasons why the adjustment was made. |
Interits from: NiPayInstruction[Schema]
Name | Type | Required | Description |
---|---|---|---|
NiPayInstruction | NiPayInstruction | no | |
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. |
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"?>
<NiAdjustmentPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<StartDate>2021-01-14</StartDate>
<EndDate>2021-01-14</EndDate>
<Description>string</Description>
<PayLineTag>string</PayLineTag>
<DirCalculationMethod>Off</DirCalculationMethod>
<NiLetter>string</NiLetter>
<PeriodsCovered>123</PeriodsCovered>
<Periods>string</Periods>
<TaxYear>123</TaxYear>
<Reason>string</Reason>
</NiAdjustmentPayInstruction>
{
"NiAdjustmentPayInstruction": {
"StartDate": "2021-01-14",
"EndDate": "2021-01-14",
"Description": "string",
"PayLineTag": "string",
"DirCalculationMethod": "Off",
"NiLetter": "string",
"PeriodsCovered": "123",
"Periods": "string",
"TaxYear": "123",
"Reason": "string"
}
}