Neue API-Version v7.12 wurde veröffentlicht! 🎉
REST DokumentationMitarbeiterGET Beschäftigungszeiträume eines Mitarbeiters auflisten

Beschäftigungszeiträume eines Mitarbeiters auflisten

Liefert die paginierte Liste der für den angegebenen Mitarbeiter erfassten Beschäftigungszeiträume.

Verfügbarkeit: Vollversion und ZEP Clock

Request

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

Pfad-Parameter

  • Name
    username
    Type
    string
    Description

    Der Benutzername des Mitarbeiters

Query-Parameter

  • Name
    page
    Type
    integer, nullable
    Description

    Die zurückzugebende Ergebnisseite, beginnend bei 1.

Response

{
  "data": [
    {
      "id": 1,
      "employee_id": "max.mustermann",
      "start_date": "2024-01-15T00:00:00.000000Z",
      "end_date": "2024-01-16T00:00:00.000000Z",
      "note": "Familienurlaub",
      "beginning_of_year": "2024-01-01T00:00:00.000000Z",
      "annual_leave_entitlement": 30,
      "period_holiday_entitlement": 30,
      "is_holiday_per_year": true,
      "day_absent_in_hours": 8,
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    }
  ],
  "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 Beschäftigungszeitraums.

  • Name
    employee_id
    Type
    string
    Description

    Benutzername des Mitarbeiters, zu dem dieser Beschäftigungszeitraum gehört.

  • Name
    start_date
    Type
    string (date-time), nullable
    Description

    Erster Kalendertag, an dem der Mitarbeiter in diesem Zeitraum beschäftigt war.

  • Name
    end_date
    Type
    string (date-time), nullable
    Description

    Letzter Kalendertag, an dem der Mitarbeiter in diesem Zeitraum beschäftigt war, sofern beendet.

  • Name
    note
    Type
    string, nullable
    Description

    Freitextnotiz zum Beschäftigungszeitraum.

  • Name
    beginning_of_year
    Type
    string (date-time), nullable
    Description

    Kalendertag, an dem das Urlaubsjahr für diesen Beschäftigungszeitraum beginnt.

  • Name
    annual_leave_entitlement
    Type
    number, nullable
    Description

    Anzahl der Urlaubstage, auf die der Mitarbeiter pro vollem Urlaubsjahr Anspruch hat.

  • Name
    period_holiday_entitlement
    Type
    number, nullable
    Description

    Anzahl der Urlaubstage, auf die der Mitarbeiter Anspruch hat, anteilig für diesen Zeitraum.

  • Name
    is_holiday_per_year
    Type
    boolean, nullable
    Description

    Ob der Urlaubsanspruch pro Kalenderjahr und nicht pro Beschäftigungszeitraum angegeben ist.

  • Name
    day_absent_in_hours
    Type
    number, nullable
    Description

    Anzahl der Stunden, mit denen ein ganzer Fehltag für diesen Beschäftigungszeitraum gebucht wird.

  • Name
    created
    Type
    string (date-time), nullable
    Description

    Zeitstempel der Erstellung des Beschäftigungszeitraums.

  • Name
    modified
    Type
    string (date-time), nullable
    Description

    Zeitstempel der letzten Änderung des Beschäftigungszeitraums.

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