Pay Line SAP

A PayLineSap record will be produced following the calculation of a SapPayInstruction or SapYtdPayInstruction.

PayLineSap [Schema]

This type is readonly.

Name Type Description
HigherEarningRate Money The calculated higher rate used.
StandardEarningRate Money The calculated standard rate used.
WeeksUsed xsd:decimal The number of weeks or fraction of weeks used in the period.
ExclusionReason SapExclusionReason The reason (if any) why SMP was not paid for the period.
KeepInTouchDaysUsed xsd:integer The number of keep in touch days used in the period.

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.


<?xml version="1.0"?>
<PayLineSap xmlns:xsi="" xmlns:xsd="">
  "PayLineSap": {
    "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",
    "HigherEarningRate": "123.99",
    "StandardEarningRate": "123.99",
    "WeeksUsed": "123.99",
    "ExclusionReason": "None",
    "KeepInTouchDaysUsed": "123"