| Name / Description | Type / Format | Example | |
|---|---|---|---|
policyName
The unique policy name
|
string
|
"string"
|
|
type
|
string
|
"Sickness"
"Maternity"
|
|
entitlement
|
string
|
"Days"
"Weeks"
|
|
sicknessYear
|
string
|
"NotApplicable"
"Rolling"
"Fixed"
|
|
policyStartMonth
|
string
|
"None"
"January"
"February"
"March"
"April"
"May"
"June"
"July"
"August"
"September"
"October"
"November"
"December"
|
|
serviceBands
Service Bands Json
|
ServiceBand[]
|
{ServiceBand}
|
|
payCalculatedOn
|
string
|
"NotApplicable"
"PercentageOfAnnualSalary"
"PercentageOfAverageWeeklyEarnings"
"PercentageOfPayCodeSet"
"Custom"
|
|
payCodeSetUniqueId
|
string
uuid
|
"string"
|
|
useAggregatedServiceDate
|
boolean
|
true
|
|
daysOrWeeksBeforeRecalculatingEntitlement
How many days or weeks an employee needs to return to work before new entitlements are used in calculations
|
integer
int32
|
0
|
|
entitlementRecalculationBasis
|
string
|
"ServiceBanding"
"SickYear"
|
|
ignorePreviousYearsSickness
Defines whether any sickness that relates to a previous year's sickness entitlement should be included in the entitlement calculation,
or whether only sickness that is relevant to the current year's entitlement is taken into consideration |
boolean
|
true
|
{
"policyName": "string",
"type": "Sickness",
"entitlement": "Days",
"sicknessYear": "NotApplicable",
"policyStartMonth": "None",
"serviceBands": [
{
"description": "string",
"from": 0,
"to": 0,
"entitlementBands": [
{
"percentOfPay": 0.0,
"period": 0,
"paySspInAddition": true,
"order": 0,
"id": "string"
}
],
"id": "string"
}
],
"payCalculatedOn": "NotApplicable",
"payCodeSetUniqueId": "string",
"useAggregatedServiceDate": true,
"daysOrWeeksBeforeRecalculatingEntitlement": 0,
"entitlementRecalculationBasis": "ServiceBanding",
"ignorePreviousYearsSickness": true
}- none -