Leave

Used to represent Leave, including Holiday and Statutory leave (such as Maternity Leave)

Name / Description Type / Format Example
type string "Unauthorised" "Holiday" "Sick" "Maternity" "Paternity" "Adoption" "SharedParental" "Bereavement"
pay string "DoNotPay" "PayAsUsual" "StatutoryPay"
from
The first day of Leave.
If it's a half day PM then set the time portion to 12:00:00, otherwise leave it blank or set it to 00:00:00
string date-time "2019-11-18T19:08:11"
to
The last day of Leave.
If it's a half day AM then set the time portion to 11:59:59, otherwise set it to 23:59:59
string date-time "2019-11-18T19:08:11"
notes
A free-form text field to record any comments
string "string"
averageWeeklyEarnings
The employees average weekly earnings. Only relevant for Statutory Pay
It's advised that you don't try to calculate this yourself.
number double 0.0
automaticAWECalculation
If set to True then we'll automatically calculate the AverageWeeklyEarnings. Set it to false if you want to manually provide a figure that overrides our calculations
boolean true
babyDate
Only required for Parental Leave with Statutory Pay
If Type is Maternity or Paternity then this is the date the baby is due.
For Adoption Leave this is the Matching Date.
string date-time "2019-11-18T19:08:11"
workingDays
The number of working days covered by this leave. This is calculated based on the employees Working Pattern.
number double 0.0
totalDays
The number of days covered by this leave, regardless of whether or not they're working days. This is calculated based on the employees Working Pattern.
number double 0.0
linkedPiw
Linked Period of Incapacity for Work.
If this is Sick Leave with Statutory Pay then any other Sick Leave with Statutory Pay lasting 4 or more days in the previous 8 weeks will be linked to it the value of the linked Leaves Average Weekly Earnings will replace the parent Leaves' Average Weekly Earnings.
LinkedPiw {LinkedPiw}
employee
A representation of the Employee this object relates to
Item {Item}
id
The unique id of the object
string uuid "string"
{
  "type": "Unauthorised",
  "pay": "DoNotPay",
  "from": "2019-11-18T19:08:11",
  "to": "2019-11-18T19:08:11",
  "notes": "string",
  "averageWeeklyEarnings": 0.0,
  "automaticAWECalculation": true,
  "babyDate": "2019-11-18T19:08:11",
  "workingDays": 0.0,
  "totalDays": 0.0,
  "linkedPiw": {
    "id": "string",
    "averageWeeklyEarnings": 0.0,
    "workingDays": 0.0,
    "totalDays": 0.0,
    "sspFirstPayDay": "2019-11-18T19:08:11"
  },
  "employee": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "id": "string"
}
Contained in Models

- none -

Consumed by Operations
Create Leave
Update Leave
Returned by Operations
Get Leave
Update Leave