ConnectCloud Developers

Vacation account of a year (own, or any with hr:absence:approve)

GET /api/hr/v1/employees/{id}/vacation

Module: HR · operationId: getVacationAccount · Tag: Absences · Auth: access token (Authorization: Bearer <accessToken>)

Parameters

Name In Type Required Description
year query integer
id path string yes Employee id or me

Responses

  • 200 Account (application/json)
  • 404 Error (application/json)

Fields of the 200 answer:

  • adjustments (number): Sum of the corrections in days
  • carryover (number): Remaining days of the previous year
  • carryoverExpires (string (date)): Day the carryover expires (YYYY-MM-DD)
  • carryoverForfeited (number): Part of the carryover not used before it expired
  • employeeId (string): Id of the employee
  • entitlement (number): 1/12 of the yearly days per full month of employment, rounded up to half days
  • entries (array of object): Corrections of the account
    • createdAt (string (date-time)): When it was entered
    • createdBy (string): Who entered it (e-mail)
    • days (number): Days added (negative: subtracted)
    • id (string): Id of the correction
    • note (string): Reason of the correction
    • year (integer): Year the correction counts for
  • planned (number): Approved days (also with a pending cancellation) on dates after today
  • remaining (number): Days left: entitlement + carryover − carryoverForfeited + adjustments − taken − planned − requested
  • requested (number): Days of requests not decided yet (status requested)
  • taken (number): Approved days (also with a pending cancellation) on dates up to and including today (tenant time zone); an absence spanning today counts its days up to today here
  • year (integer): The year

Example 200 answer:

{
  "adjustments": 1,
  "carryover": 2,
  "carryoverExpires": "2026-03-31",
  "carryoverForfeited": 0,
  "employeeId": "e5a1c3d7-2b4f-4c6e-8a0b-1d3f5b7c9e02",
  "entitlement": 28,
  "entries": [
    {
      "createdAt": "2026-10-12T09:30:00Z",
      "createdBy": "martin.brandl@muster-it.example",
      "days": 1,
      "id": "7c9e1a3c-5e7a-4c9e-8a1c-5e7a9c1e3a33",
      "note": "Ausgleich für den Samstagseinsatz beim Rollout Donau Maschinenbau",
      "year": 2026
    }
  ],
  "planned": 0,
  "remaining": 5,
  "requested": 5,
  "taken": 21,
  "year": 2026
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/hr/v1/employees/string/vacation' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI