ShPP Pay Instruction



ShppPayInstruction [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.
BabyDueDate xsd:date yes The date the baby is due.
BabyBornDate xsd:date yes The baby's actual birth date.
SmpSapWeeksTaken xsd:integer yes The number of weeks taken.
SplStartDate xsd:date no The shared parental leave start date.
SplEndDate xsd:date no The shared parental leave end date.
MothersDateOfDeath xsd:date no If applicable, the date of the mother's death.

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"?>
<ShppPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2019-04-16</StartDate>
  <EndDate>2019-04-16</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <AbsenceStart>2019-04-16</AbsenceStart>
  <AbsenceEnd>2019-04-16</AbsenceEnd>
  <StatutoryOffset>true</StatutoryOffset>
  <AverageWeeklyEarningOverride>123.99</AverageWeeklyEarningOverride>
  <BabyDueDate>2019-04-16</BabyDueDate>
  <BabyBornDate>2019-04-16</BabyBornDate>
  <SmpSapWeeksTaken>123</SmpSapWeeksTaken>
  <SplStartDate>2019-04-16</SplStartDate>
  <SplEndDate>2019-04-16</SplEndDate>
  <MothersDateOfDeath>2019-04-16</MothersDateOfDeath>
</ShppPayInstruction>
{
  "ShppPayInstruction": {
    "StartDate": "2019-04-16",
    "EndDate": "2019-04-16",
    "Description": "string",
    "PayLineTag": "string",
    "AbsenceStart": "2019-04-16",
    "AbsenceEnd": "2019-04-16",
    "StatutoryOffset": "true",
    "AverageWeeklyEarningOverride": "123.99",
    "BabyDueDate": "2019-04-16",
    "BabyBornDate": "2019-04-16",
    "SmpSapWeeksTaken": "123",
    "SplStartDate": "2019-04-16",
    "SplEndDate": "2019-04-16",
    "MothersDateOfDeath": "2019-04-16"
  }
}