Pay Line SSP

A PayLineSsp record will be produced following the calculation of a SspPayInstruction or SspYtdPayInstruction.

PayLineSsp [Schema]

This type is readonly.

Name	Type	Description
WaitingDaysServed	xsd:integer	The number of waiting days served in the period.
QualifyingDays	xsd:integer	The number of qualifying days in the period.
DailyRate	Money	The calculated daily rate used.
WeeksUsed	xsd:decimal	The number of weeks or fraction of weeks used in the period.
ExclusionReason	SspExclusionReason	The reason (if any) why SSP was not paid for the period.
SspType	SspType	The SSP rule type used to calculate this absence.

Interits from: PayLineAbsence[Schema]

Name	Type	Description
PayLineAbsence	PayLineAbsence
AbsenceStart	xsd:date	The absence start date.
AbsenceEnd	xsd:date	The absence end date.
AverageWeeklyEarnings	Money	The Average Weekly Earnings figure used in the calculation.

Interits from: PayLine [Schema]

Name	Type	Description"
PayLine	PayLine
Description	xsd:string ( max: 100)	The description of the pay line displayed in the payslip report.
Calculator	xsd:string ( max: 300)	The name of a Calculator responsible for generating the pay line.
Generated	xsd:dateTime	The date and time the pay line was generated.
PayCode	xsd:string ( max: 35)	A loose linkage to the type of pay line and it's calculator treatment.
PayCodeType	SystemCodeType	The category of pay line.
Value	Money	The monetary value of the pay line; used in the net pay sum. Typically positive for payments and negative for deductions.
PaymentDate	xsd:date	The date the employees were paid in the pay run. Not applicable for year to date generated lines.
TaxYear	xsd:integer	The tax year the pay run was in.
TaxPeriod	xsd:integer	The tax period the pay run was in.
PayRunSequence	xsd:integer	The sequence number of the owning pay run.

Example

<?xml version="1.0"?>
<PayLineSsp xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Description>string</Description>
  <Calculator>string</Calculator>
  <Generated>2022-05-18T00:00:00+01:00</Generated>
  <PayCode>string</PayCode>
  <PayCodeType>NotSet</PayCodeType>
  <Value>123.99</Value>
  <PaymentDate>2022-05-18</PaymentDate>
  <TaxYear>123</TaxYear>
  <TaxPeriod>123</TaxPeriod>
  <PayRunSequence>123</PayRunSequence>
  <AbsenceStart>2022-05-18</AbsenceStart>
  <AbsenceEnd>2022-05-18</AbsenceEnd>
  <AverageWeeklyEarnings>123.99</AverageWeeklyEarnings>
  <WaitingDaysServed>123</WaitingDaysServed>
  <QualifyingDays>123</QualifyingDays>
  <DailyRate>123.99</DailyRate>
  <WeeksUsed>123.99</WeeksUsed>
  <ExclusionReason>None</ExclusionReason>
  <SspType>Standard</SspType>
</PayLineSsp>

{
  "PayLineSsp": {
    "Description": "string",
    "Calculator": "string",
    "Generated": "2022-05-18T00:00:00+01:00",
    "PayCode": "string",
    "PayCodeType": "NotSet",
    "Value": "123.99",
    "PaymentDate": "2022-05-18",
    "TaxYear": "123",
    "TaxPeriod": "123",
    "PayRunSequence": "123",
    "AbsenceStart": "2022-05-18",
    "AbsenceEnd": "2022-05-18",
    "AverageWeeklyEarnings": "123.99",
    "WaitingDaysServed": "123",
    "QualifyingDays": "123",
    "DailyRate": "123.99",
    "WeeksUsed": "123.99",
    "ExclusionReason": "None",
    "SspType": "Standard"
  }
}