leave-types

Find leave types

Retrieves a list of all resources from the service.

get/leave-types

Request

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

Response

success

idinteger

ID of the leave type

updatedByinteger nullable

ID user who updated item last

namestring required

Name of the leave type

color'DARK_BLUE' | 'LIGHT_BLUE' | 'GREEN' | 'ORANGE' | 'YELLOW' | 'RED' required

Color of the leave type

icon'PALMTREE' | 'LEAVE-GENERAL' | 'BACKPACK' | 'SUITCASE' | 'CLOCK' | 'PRAM' | 'PLANE' | 'CAR' | 'BIKE' | 'EDUCATION' | 'CERTIFICATE' | 'BOOK' | 'MISC' | 'REVIEW' | 'AGREEMENT' | 'ADDENDUM' | 'MUTATION' | 'USER' | 'TEAM' | 'PRESENT' | 'FLAG' | 'GOALS' required

Icon of the leave type

budgetinteger required

Default budget for the leave type

defaultinteger

Tiny-int indicating whether the leave type should be assigned automatically to new users

calculationMethod'WORK_SCHEDULE' | 'INFINITE_BUDGET' | 'OVERTIME' | 'ONCE' | 'TIME_OFF_IN_LIEU' | 'RECURRING_FIXED_BUDGET' required

Enum describing the way the budget should be calculated

periodOffsetinteger

Amount of offset months the leave period should have. "0" starts with January. "5" starts with June. "11" starts with December.

budgetReleaseRecurrence'YEARLY' | 'QUARTERLY' | 'MONTHLY' | 'WEEKLY'

The time between recurring budget releases

budgetReleaseTiming'LEAVE_PERIOD_START' | 'BUDGET_RELEASE_RECURRENCE_END'

The moment the budget should be released

accumulateBudgetWhenAbsentstring

Tiny-int indicating whether a correction should be applied when the user is on sick-leave. "0" a correction is applied. "1" a correction is NOT applied.

overtimePercentageinteger

Percentage of overtime hours that should be provided as budget

autoApproveLimitinteger

Maximum amount of minutes a leave request should have for automatic approval

invisibleInCalendarinteger

Tiny-int indicating if the items should be invisible/anonymized in the calendar

unpaidLeaveinteger

Tiny-int indicating whether the time of leave should be marked as "unpaid"

leaveInDaysinteger

Tiny-int indicating if the budgets are defined in days instead of minutes

leaveTypeSystemCategorystring

Enum describing a pre-defined leave type

subtractHolidaysinteger

Tiny-int indicating whether a correction for holidays should be applied

useLeaveBudgetOnHolidayinteger

Tiny-int indicating whether a leave items should ignore holidays and deduct from the budget

returnLeaveWhileSickinteger

Tiny-int indicating whether the hours you're sick during leave should be returned/compensated to your budget

sendExpirationNotificationsinteger

Tiny-int indicating whether expiration notifications should be sent for this leave type

preventNegativeBudgetOnRequestinteger

Tiny-int indicating whether regular users can request leave that would result in a negative budget.

isLegacyinteger

Tiny-int indicating whether the leave type is considered a legacy leave type

archivedAtstring date-time

Timestamp of leave type being archived

createdAtstring date-time

Creation date of the leave type

updatedAtstring date-time

Last updated date of the leave type

Example response

[
  {
    "id": 5,
    "archivedAt": "2022-02-23T14:01:17.516Z",
    "createdAt": "2022-02-23T14:01:17.516Z",
    "updatedAt": "2022-02-23T14:01:17.516Z"
  }
]

Changes

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