Get a single work-hour balance

Returns one employee’s cached overtime and vacation-entitlement balance.

Availability: Full version and ZEP Clock

Request

GET /api/v1/workhour-balances/{id}

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/workhour-balances/{id}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Path parameters

Name
id
Type
integer
Description
The workhour balance ID

Response

{
  "data": {
    "id": 1,
    "employee_id": "max.mustermann",
    "balance": 1.5,
    "calculated_at": "2026-01-31T09:00:00.000000Z",
    "vacation": [
      {
        "year": "string",
        "approved": 12.5,
        "planned": 12.5,
        "remaining": 12.5,
        "annual_entitlement": 12.5
      }
    ]
  }
}

Response fields

Name
id
Type
integer
Description
Unique identifier of the cached work-hour balance record.
Name
employee_id
Type
string
Description
Username of the employee this balance belongs to.
Name
balance
Type
number
Description
Cached overtime balance as of the previous day’s calculation.
Name
calculated_at
Type
string (date-time)
Description
Timestamp the balance was last calculated.
Name
vacation
Type
array of object
Description
Approved, planned, remaining and annual vacation-day entitlements, per period.
Name
vacation.year
Type
string
Description
The calendar year this entitlement period refers to.
Name
vacation.approved
Type
number
Description
Vacation days already approved in this period.
Name
vacation.planned
Type
number
Description
Vacation days planned but not yet approved in this period.
Name
vacation.remaining
Type
number
Description
Vacation days still available in this period.
Name
vacation.annual_entitlement
Type
number
Description
The full annual entitlement for this period, in days.

Generated from the OpenAPI specification — edit the source code, not this page.

GET List work-hour balances Customers