List work-hour balances

Returns the cached overtime and vacation-entitlement balances, filterable by employee.

Availability: Full version and ZEP Clock

Request

GET /api/v1/workhour-balances

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

Query parameters

Name
perPage
Type
integer, nullable
Description
Ignored on this endpoint — send limit instead. Any value given here is replaced by limit, or by the default when limit is absent.
Name
page
Type
integer, nullable
Description
The page of results to return, counting from 1.
Name
orderBy
Type
string, nullable
Description
Name of the field to sort by.
Name
order
Type
string, nullable
Description
Sort direction, ascending or descending.
One of: "asc", "desc"
Name
limit
Type
integer, nullable
Description
The number of records per page, 1 to 200. Defaults to 15.
Name
modified_after
Type
string (date-time)
Description
Only return records modified after this timestamp (ISO 8601, or “Y-m-d H:i:s”).
Name
modified_before
Type
string (date-time)
Description
Only return records modified before or at this timestamp (ISO 8601, or “Y-m-d H:i:s”).
Name
employee_id
Type
string, nullable
Description
Only return balances for this employee, given as their username.

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
        }
      ]
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

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.

Workhour Balances and Vacation Entitlements GET Get a single work-hour balance