intelliHR can help you record and manage those employees who are on extended leave, such as long term sickness, maternity leave or study leave. To record extended leave follow the steps below. This allows the organisation to be made aware of people that are not currently working and will automatically filter the employee out of business as usual processes like monthly check ins.
Extended Leave can be created and managed via intelliHR’s public API.
This article covers:
Creating Extended Leave
To create a new Extended Leave on existing Job record, make a HTTP POST request to the webhooks endpoint.
leaveType is a search object. The leave type included in the request will need to have a one-to-one match with a leaveType in you intelliHR tenant.
You can include either name, id or both. The more filter values included, the narrower the results will be.
You can return leaveTypes from intelliHR’s API using the List All Extended Leave Types endpoint.
"url": https://api.intellihr.io/v1/extended-leave
"method": 'POST'
"headers": {
"Content-Type": 'application/json',
"Accept": 'application/json',
"Authorization": `Bearer ${apikey}`,
"Tenant": tenantname
}
"body": {
"jobId": "8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9",
"startDate": "2015-03-01T22:30:00+00:00",
"endDate": "2015-03-01T22:30:00+00:00",
"leaveType": { "id": "8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9",
"name": "Long Service"
},
"fte": "1"
}
Updating or Finalising Extended Leave
To update or finalise Extended Leave on existing Job record, make a HTTP PATCH request to the webhooks endpoint.
This endpoint allows Extended Leave to be updated or finalised depending on the value of shouldNotFinaliseEndDate.
- If the update is intended to finalise the Extended Leave then set this value to
FALSE - If the update is not intended to finalise the Extended Leave then set this value to
TRUE
When shouldNotFinaliseEndDate is set to FALSE, then endDate becomes a required field.
leaveType is a search object. The leave type included in the request will need to have a one-to-one match with a leaveType in you intelliHR tenant.
You can include either name, id or both. The more filter values included, the narrower the results will be.
You can return leaveTypes from intelliHR’s API using the List All Extended Leave Types endpoint.
"url": https://api.intellihr.io/v1/extended-leave/{id}
"method": 'PATCH'
"headers": {
"Content-Type": 'application/json',
"Accept": 'application/json',
"Authorization": `Bearer ${apikey}`,
"Tenant": tenantname
}
"body": {
"jobId": "8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9",
"shouldNotFinaliseEndDate": false,
"startDate": "2015-03-01T22:30:00+00:00",
"endDate": "2015-03-01T22:30:00+00:00",
"leaveType": { "id": "8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9",
"name": "Long Service"
},
"fte": "1"
Listing All Extended Leave
To return a list of all Extended Leave Types, make a HTTP GET request to the webhooks endpoint. These types can be managed on a tenant by tenant basis within the intelliHR platform.
"url": https://api.intellihr.io/v1/extended-leave/{id}
"method": 'GET'
"headers": {
"Content-Type": 'application/json',
"Accept": 'application/json',
"Authorization": `Bearer ${apikey}`,
"Tenant": tenantname
}
Tip: For information on managing extended leave via the intelliHR API, contact your friendly intelliHR Integration Team! You can reach them at integrations@intellihr.com