| Name / Description | Type / Format | Example | |
|---|---|---|---|
payrollCode
Payroll Code
|
string
|
"string"
|
|
type
|
string
|
"Unauthorised"
"Holiday"
"Sick"
"Maternity"
"Paternity"
"Adoption"
"SharedParental"
"Bereavement"
"SharedParentalAdoption"
"PaternityAdoption"
"StrikeAction"
|
|
pay
|
string
|
"DoNotPay"
"PayAsUsual"
"StatutoryPay"
"OccupationalPolicy"
"Custom"
|
|
openEndedAbsence
Open Ended Absence
|
boolean
|
true
|
|
from
The first day of Leave.
|
string
date
|
"2024-12-22"
|
|
to
The last day of Leave.
|
string
date
|
"2024-12-22"
|
|
historicLeaveRequiresProcessing
Only used during the creation of historical SSP.
When creating historical SSP, this will determine whether to pay that leave in the next PayRun. |
boolean
|
true
|
|
averageWeeklyEarnings
The employees average weekly earnings.
|
number
double
|
0.0
|
|
automaticAWECalculation
Automatic Average Weekly Earnings.
|
boolean
|
true
|
|
offsetPay
Top-up pay to usual amongst (offsetting)
|
boolean
|
true
|
|
calculationType
|
string
|
"OneThreeSixtyFifthFTE"
"OneThreeSixtyFifthProRata"
"UsualProRata"
"OneFifthOrWorkingPattern"
"SpecifyHours"
|
|
percentOfPay
Only provided when the leave type is 'Sick' and the payment type is 'Custom'.
|
number
double
|
0.0
|
|
strikeHoursToDeduct
Only provided when the leave type is 'StrikeAction' and the calculation type is 'SpecifyHours'.
|
number
double
|
0.0
|
|
paySSPInAddition
Only provided when the leave type is 'Sick' and the payment type is 'Custom'.
|
boolean
|
true
|
|
useAssumedPensionablePay
Only provided when the leave type is 'Sick' and the payment type is 'Custom', 'Occupational Policy' or 'Statutory Pay'.
|
boolean
|
true
|
|
assumedPensionablePay
Assumed Pensionable Pay (APP) is an average figure, calculated as the average pay in the 3 months
(or 12 weeks if weekly/fortnightly/fourweekly paid) before the absence |
number
double
|
0.0
|
|
automaticAPPCalculation
If set to True then we'll automatically calculate the AssumedPensionablePay.
Set it to false if you want to manually provide a figure that overrides our calculations |
boolean
|
true
|
{
"payrollCode": "string",
"type": "Unauthorised",
"pay": "DoNotPay",
"openEndedAbsence": true,
"from": "2024-12-22",
"to": "2024-12-22",
"historicLeaveRequiresProcessing": true,
"averageWeeklyEarnings": 0.0,
"automaticAWECalculation": true,
"offsetPay": true,
"calculationType": "OneThreeSixtyFifthFTE",
"percentOfPay": 0.0,
"strikeHoursToDeduct": 0.0,
"paySSPInAddition": true,
"useAssumedPensionablePay": true,
"assumedPensionablePay": 0.0,
"automaticAPPCalculation": true
}- none -
- none -