time-off

Create time off

Creates a new resource with data.

post/time-off

Request

  • Base URL: https://api.hoorayhr.io
  • URL: https://api.hoorayhr.io/time-off
  • Auth: API key in header authorization

Request body

notesstring nullable
userIdinteger

Unique ID of the user.

leaveTypeIdinteger

ID of the leave type

timeOffType'HOLIDAY' | 'LEAVE' | 'OVERTIME_NONE' | 'OVERTIME_PAYOUT' | 'OVERTIME_TIME_OFF_IN_LIEU' | 'TRANSACTION_SPENT' | 'TRANSACTION_LEGACY' | 'TRANSACTION_CORRECTION'
startstring date-time
endstring date-time
statusinteger
labelIdsinteger[]

List of id's belonging to labels

Example request

{
  "notes": "Worked hours on 05-03",
  "timeOffType": "OVERTIME_PAYOUT",
  "start": "2023-05-03T07:00:00.000Z",
  "end": "2023-05-03T14:59:59.999Z",
  "status": 3,
  "labelIds": []
}

Response

created

OR

Example response

{
  "id": 5,
  "userId": 1,
  "budgetCalculated": 8,
  "budgetAdjustment": 2,
  "budgetTotal": 480,
  "notes": "I would like to attend the wedding of my sister",
  "start": "2022-02-15T14:01:17.516Z",
  "end": "2022-02-15T18:01:17.516Z",
  "pause": 30,
  "tags": [
    {
      "id": 2,
      "name": "Hours",
      "archived": null
    }
  ],
  "status": 1,
  "leaveTypeId": 1,
  "leaveTypeRuleId": 2,
  "timeOffType": "LEAVE",
  "labelIds": [
    1,
    2,
    3
  ],
  "labels": [
    {
      "id": 5,
      "name": "Long term leave",
      "type": "LEAVE",
      "systemCategoryType": "car",
      "createdAt": "2022-02-23T14:01:17.516Z",
      "updatedAt": "2022-02-23T14:01:17.516Z"
    }
  ],
  "timezone": "Europe/Amsterdam",
  "createdAt": "2022-02-15T14:01:17.516Z",
  "updatedAt": "2022-02-23T14:01:17.516Z",
  "userIdApproved": 3,
  "reply": "Enjoy the wedding!"
}

Changes

No recorded changes to this operation across all 1 revision of this API.