external-leave-budgets

Find external leave budgets

Retrieves a list of all resources from the service.

get/external-leave-budgets

Request

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

Response

success

idinteger

ID of the external-leave-budget record

externalLeaveTypeIdinteger required

ID of the external-leave-type

userIdinteger required

Unique id of the user of the external-leave-budget record

yearinteger

Year of the external-leave-budget record

transferrednumber

Budget transferred from the previous year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)

receivednumber

Budget received this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)

expirednumber

Budget expired this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)

spentnumber

Budget spent this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)

availablenumber

Budget available this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)

createdAtstring date-time

Creation date of the external leave budget

updatedAtstring date-time

Last updated date of the external leave budget

Example response

[
  {
    "id": 5,
    "externalLeaveTypeId": 5,
    "userId": 2,
    "year": 2024,
    "transferred": 120,
    "received": 12000,
    "expired": 120,
    "spent": 8000,
    "available": 4000,
    "createdAt": "2022-02-15T14:01:17.516Z",
    "updatedAt": "2022-02-23T14:01:17.516Z"
  }
]

Changes

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