SPP Pay Instruction



SppPayInstruction [Schema]

Name Type Required Description
AverageWeeklyEarningOverride AverageWeeklyEarning no Optional override value to the Average Weekly Earnings calculation. If this value is set then the calculated value is ignored.
PayPartWeek xsd:boolean yes Flag to indicate if part weeks should be paid as opposed to payments being made as full weeks only.
BabyDueDate xsd:date yes The date the baby is due.
BabyBornDate xsd:date yes The actual birth date of the baby.
Stillbirth xsd:boolean yes Flag to indicate if the baby was still born.
WorkingDays xsd:date
(list of)
no A list of any days worked during the absence, these will exclude the week from counting towards the statutory absence.

Interits from: AbsencePayInstruction[Schema]

Name Type Required Description
AbsenceStart xsd:date yes The start date of the employee absence.
AbsenceEnd xsd:date no The end date of the employee absence, leave blank if the absence is long-term and the end date is not known.
StatutoryOffset xsd:boolean yes Flag to indicate if the statutory payment should be offset.

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"?>
<SppPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2019-03-21</StartDate>
  <EndDate>2019-03-21</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <AbsenceStart>2019-03-21</AbsenceStart>
  <AbsenceEnd>2019-03-21</AbsenceEnd>
  <StatutoryOffset>true</StatutoryOffset>
  <AverageWeeklyEarningOverride>123.99</AverageWeeklyEarningOverride>
  <PayPartWeek>true</PayPartWeek>
  <BabyDueDate>2019-03-21</BabyDueDate>
  <BabyBornDate>2019-03-21</BabyBornDate>
  <Stillbirth>true</Stillbirth>
  <WorkingDays />
</SppPayInstruction>
{
  "SppPayInstruction": {
    "StartDate": "2019-03-21",
    "EndDate": "2019-03-21",
    "Description": "string",
    "PayLineTag": "string",
    "AbsenceStart": "2019-03-21",
    "AbsenceEnd": "2019-03-21",
    "StatutoryOffset": "true",
    "AverageWeeklyEarningOverride": "123.99",
    "PayPartWeek": "true",
    "BabyDueDate": "2019-03-21",
    "BabyBornDate": "2019-03-21",
    "Stillbirth": "true",
    "WorkingDays": { "Date": [] }
  }
}