Benefit Pay Instruction
BenefitPayInstruction [Schema]
Name | Type | Required | Description |
---|---|---|---|
Code | SystemCode | yes | The code that represents the benefit type and it' treatment. |
TotalCost | Money | yes | The total cost (or value) of the benefit for the remainder of the financial year. |
EmployeeContribution | Money | yes | The amount the employee contributes towards the benefit for the rest of the financial year. |
CashEquivalent | Money | no | The per period cash equivalent value of the benefit. [Optional] used to override the calculated cash equivilent value. |
AccountingMethod | BenefitAccountingMethod | yes | The accounting method used to report the benefit to HMRC. |
BenefitEndDate | xsd:date | no | The date benefit ceases, this is different to end date of the instruction. |
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"?>
<BenefitPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<StartDate>2021-01-26</StartDate>
<EndDate>2021-01-26</EndDate>
<Description>string</Description>
<PayLineTag>string</PayLineTag>
<Code>string</Code>
<TotalCost>123.99</TotalCost>
<EmployeeContribution>123.99</EmployeeContribution>
<CashEquivalent>123.99</CashEquivalent>
<AccountingMethod>P11D</AccountingMethod>
<BenefitEndDate>2021-01-26</BenefitEndDate>
</BenefitPayInstruction>
{
"BenefitPayInstruction": {
"StartDate": "2021-01-26",
"EndDate": "2021-01-26",
"Description": "string",
"PayLineTag": "string",
"Code": "string",
"TotalCost": "123.99",
"EmployeeContribution": "123.99",
"CashEquivalent": "123.99",
"AccountingMethod": "P11D",
"BenefitEndDate": "2021-01-26"
}
}