Leave

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

Name / Description Type / Format Example
providerId string "SmartPension_Employer" "SmartPension_Adviser" "PeoplesPension" "Xero" "Qbo" "Sage" "Nest" "Cashplus" "BreatheHr" "KashFlow" "Reckon" "FreeAgent" "FreeAgentPm" "Modulr" "Square" "Cezanne" "Ciphr" "Telleroo" "WeWorked" "RotaCloud" "Quinyx" "Csod" "Planday" "Starling" "Deputy" "Bottomline" "Twinfield" "MyePayWindow" "IFinance" "AccountsIQ"
externalId
If the Leave comes from an ExternalDataProvider, then this is its Id in the ExternalDataProvider
string "string"
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 "2021-10-16T10:58:31"
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 "2021-10-16T10:58:31"
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 "2021-10-16"
overridePaymentDescription
If Pay is StatutoryPay and you want to override our description that goes with the payment then set this to true
boolean true
overridenPaymentDescription
If OverridePaymentDescription is true and Pay is set to StatutoryPay then we'll use this as the description for the payment amount.
string "string"
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
useAssumedPensionablePay
If this Leave has Statutory Pay (and isn't for Sick) then if this is set to True we will use the value set in AssumedPensionablePay to work out the employer pension contributions
boolean true
assumedPensionablePay
if AssumedPensionablePay is True, then this is the value used to calculate the employer pension contributions
number double 0.0
offsetPay
If this Leave has Statutory Pay and this is set to True and the employe eis paid a fixed amoutn per period with Leave Adjustments set to automatic, then we'll reduce their pay for the period by the statutory amount so the employee still gets paid the full amount.
boolean true
sspPayFromDayOne
If this is Sick Leave with Statutory Pay then setting this to true will force SSP to be paid from day one rather than the usual rule of the first Working Day after 3 Qualifying Days
boolean true
linkedPiw
Linked Period of Incapacity for Work.
If you record Sick Leave and select 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
LinkedPiw {LinkedPiw}
kitSplitDays
If the LeaveType supports KIT/SPLIT days then use this property to store the list of dates
string[]
documentCount
The number of attachments associated with this model
integer int32 0
documents
The attachments associated with this model
Item[] {Item}
employee Item {Item}
id
The unique id of the object
string uuid "string"
{
  "providerId": "SmartPension_Employer",
  "externalId": "string",
  "type": "Unauthorised",
  "pay": "DoNotPay",
  "from": "2021-10-16T10:58:31",
  "to": "2021-10-16T10:58:31",
  "notes": "string",
  "averageWeeklyEarnings": 0.0,
  "automaticAWECalculation": true,
  "babyDate": "2021-10-16",
  "overridePaymentDescription": true,
  "overridenPaymentDescription": "string",
  "workingDays": 0.0,
  "totalDays": 0.0,
  "useAssumedPensionablePay": true,
  "assumedPensionablePay": 0.0,
  "offsetPay": true,
  "sspPayFromDayOne": true,
  "linkedPiw": {
    "id": "string",
    "averageWeeklyEarnings": 0.0,
    "workingDays": 0.0,
    "totalDays": 0.0,
    "sspFirstPayDay": "2021-10-16"
  },
  "kitSplitDays": [
    "string"
  ],
  "documentCount": 0,
  "documents": [
    {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    }
  ],
  "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