Sign in

v1

latestOpenAPI 3.1.02026-07-2421872196.9 KB
Leaves

Create a leave request

Creates a leave request

post/leave_requests

Request body

employee_idinteger required

The ID of an existing employee that leave request will be created for.

leave_type_idinteger required

The ID of an existing leave type that the leave request will be created for. The employee must have a policy of this leave type assigned to them.

starts_onstring date required

The starting date of the total duration of the leave request.

ends_onstring date required

The ending date of the total duration of the leave request.

descriptionstring

Details about the leave request (eg. reason for leave)

skip_approvalboolean

If set to true, approvals for the leave type policy will be skipped and the leave request will be created as approved.

Example request

{
  "starts_on": "2023-01-01",
  "ends_on": "2023-01-01",
  "leave_request_entries": [
    {
      "occurs_on": "2023-01-01"
    }
  ]
}

Response

Created

idinteger required
employee_idinteger required
leave_type_idinteger
leave_typestring required
state'pending' | 'approved' | 'rejected' | 'withdrawn' required
amountnumber required
tracking_time_in'hours' | 'days' required
on_demandboolean
ends_onstring date required
starts_onstring date required
commentstring
attachment_urlstring

Deprecated: URL to attachement if provided to the leave request. This URL is temporary and will expire automatically.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "employee": {
    "id": 100,
    "first_name": "John",
    "last_name": "Doe",
    "email": "test@example.com"
  }
}