SPBP YTD Pay Instruction



SpbpYtdPayInstruction [Schema]

Name Type Required Description

Interits from: AbsenceYtdPayInstruction[Schema]

Name Type Required Description
AbsenceStart AbsenceDate yes The date when the absence starts.
AbsenceEnd AbsenceDate yes The date when the absence ends.
Value Money yes The payment value of the absence.
AverageWeeklyEarnings AverageWeeklyEarning yes The employees average weekly earning amount.
WeeksUsed xsd:double yes The number of weeks used in this absence. Represented as a fractional decimal based on the employees working week pattern.
IsAdjustment xsd:boolean yes Indicates if the instruction is an adjustment. Pay lines generated from adjustment YTD instructions appear on the employee payslip.

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"?>
<SpbpYtdPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2022-01-25</StartDate>
  <EndDate>2022-01-25</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <AbsenceStart>2022-01-25</AbsenceStart>
  <AbsenceEnd>2022-01-25</AbsenceEnd>
  <Value>123.99</Value>
  <AverageWeeklyEarnings>123.99</AverageWeeklyEarnings>
  <WeeksUsed>123.99</WeeksUsed>
  <IsAdjustment>true</IsAdjustment>
</SpbpYtdPayInstruction>

{
  "SpbpYtdPayInstruction": {
    "StartDate": "2022-01-25",
    "EndDate": "2022-01-25",
    "Description": "string",
    "PayLineTag": "string",
    "AbsenceStart": "2022-01-25",
    "AbsenceEnd": "2022-01-25",
    "Value": "123.99",
    "AverageWeeklyEarnings": "123.99",
    "WeeksUsed": "123.99",
    "IsAdjustment": "true"
  }
}