REST DokumentationStundenkonten und UrlaubsansprücheGET Stundenkonten auflisten

Stundenkonten auflisten

Liefert die zwischengespeicherten Überstundensalden und Urlaubsansprüche, filterbar nach Mitarbeiter.

Verfügbarkeit: Vollversion und 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-Parameter

  • Name
    perPage
    Type
    integer, nullable
    Description

    Wird auf diesem Endpunkt ignoriert — senden Sie stattdessen limit. Ein hier angegebener Wert wird durch limit ersetzt, oder durch den Standardwert, wenn limit fehlt.

  • Name
    page
    Type
    integer, nullable
    Description

    Die zurückzugebende Ergebnisseite, beginnend bei 1.

  • Name
    orderBy
    Type
    string, nullable
    Description

    Name des Feldes, nach dem sortiert wird.

  • Name
    order
    Type
    string, nullable
    Description

    Sortierrichtung, aufsteigend oder absteigend.

    Einer der Werte: "asc", "desc"

  • Name
    limit
    Type
    integer, nullable
    Description

    Die Anzahl der Datensätze pro Seite, 1 bis 200. Standardwert ist 15.

  • Name
    modified_after
    Type
    string (date-time)
    Description

    Nur Datensätze zurückgeben, die nach diesem Zeitstempel geändert wurden (ISO 8601 oder “Y-m-d H:i:s”).

  • Name
    modified_before
    Type
    string (date-time)
    Description

    Nur Datensätze zurückgeben, die vor oder zu diesem Zeitstempel geändert wurden (ISO 8601 oder “Y-m-d H:i:s”).

  • Name
    employee_id
    Type
    string, nullable
    Description

    Nur Stundenkonten dieses Mitarbeiters zurückgeben, angegeben als Benutzername.

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-Felder

  • Name
    id
    Type
    integer
    Description

    Eindeutige Kennung des zwischengespeicherten Stundenkonto-Datensatzes.

  • Name
    employee_id
    Type
    string
    Description

    Benutzername des Mitarbeiters, dem dieses Stundenkonto gehört.

  • Name
    balance
    Type
    number
    Description

    Zwischengespeicherter Überstundensaldo zum Stand der Berechnung des Vortages.

  • Name
    calculated_at
    Type
    string (date-time)
    Description

    Zeitstempel, zu dem der Saldo zuletzt berechnet wurde.

  • Name
    vacation
    Type
    Liste von object
    Description

    Genehmigte, geplante, verbleibende und jährliche Urlaubsansprüche in Tagen, pro Zeitraum.

  • Name
    vacation.year
    Type
    string
    Description

    Das Kalenderjahr, auf das sich dieser Anspruchszeitraum bezieht.

  • Name
    vacation.approved
    Type
    number
    Description

    In diesem Zeitraum bereits genehmigte Urlaubstage.

  • Name
    vacation.planned
    Type
    number
    Description

    In diesem Zeitraum geplante, aber noch nicht genehmigte Urlaubstage.

  • Name
    vacation.remaining
    Type
    number
    Description

    In diesem Zeitraum noch verfügbare Urlaubstage.

  • Name
    vacation.annual_entitlement
    Type
    number
    Description

    Der volle jährliche Urlaubsanspruch für diesen Zeitraum, in Tagen.

Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.