Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Time Off

Create Time Off

Creates a Time Off record

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage timeoffs (time_and_attendance)-Manage timeoffs (timeoff:write)
post/v1/timeoff

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Request body

employment_idstring required
end_datestring datetime required
leave_policy_variant_idstring uuid

UUID of a custom company leave policy assigned to the employment. Use this field instead of timeoff_type when creating time off against a custom leave policy. Discover available custom leave policy UUIDs via GET /v1/leave-policies/details/{employment_id}.

notesstring
start_datestring datetime required
timeoff_type'time_off' | 'sick_leave' | 'public_holiday' | 'unpaid_leave' | 'extended_leave' | 'in_lieu_time' | 'maternity_leave' | 'paternity_leave' | 'parental_leave' | 'bereavement' | 'military_leave' | 'other' | 'paid_time_off' | 'custom_company_leave' | 'rtt' | 'casual_leave' | 'rol' | 'ex_festivita'
timezonestring required

TZ identifier

approved_atstring date-time required

UTC date time in ISO 8601 format.

approver_idstring nullable required

The field matches the id of a user in the Remote Platform that has permission to approve time off requests. Available users can be found fetching the List Company Manager endpoint.

status'approved' required

Example request

{
  "approved_at": "2021-07-15T18:18:17Z",
  "approver_id": "123e4567-e89b-12d3-a456-426614174000",
  "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
  "end_date": "2021-12-21",
  "start_date": "2021-12-20",
  "status": "approved",
  "timeoff_days": [
    {
      "day": "2021-12-20",
      "hours": 8
    },
    {
      "day": "2021-12-21",
      "hours": 8
    }
  ],
  "timeoff_type": "paid_time_off",
  "timezone": "Asia/Kolkata"
}

Response

Created

Example response

{
  "data": {
    "timeoff": {
      "automatic": false,
      "document": {
        "id": "9880b711-file-id-ecf8f551bd78",
        "inserted_at": "2021-07-15T18:18:17Z",
        "name": "id.pdf",
        "sub_type": "personal_id",
        "type": "id"
      },
      "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
      "end_date": "2021-12-21",
      "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
      "leave_policy": {
        "leave_policy_variant_slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
        "leave_type": "sick_leave",
        "name": "Self-Care"
      },
      "notes": "Some notes",
      "start_date": "2021-12-20",
      "status": "approved",
      "timeoff_days": [
        {
          "day": "2021-12-20",
          "hours": 8,
          "minutes": 480
        },
        {
          "day": "2021-12-21",
          "hours": 8,
          "minutes": 480
        }
      ],
      "timeoff_type": "paid_time_off",
      "timezone": "Asia/Kolkata",
      "total_minutes": 960
    }
  }
}