Konfigurierte Fehlgründe auflisten

Liefert alle buchbaren Fehlgründe, z. B. Urlaub oder Krankheit, zusammen mit den Regeln, die festlegen, wie sie gebucht werden dürfen.

Verfügbarkeit: Nur Vollversion — eine Clock-Instanz antwortet auf diesen Endpunkt mit 404.

Request

GET /api/v1/absence-reasons

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/absence-reasons' \
     --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
external_id
Type
string, nullable
Description
Beschränkt die Liste auf den Fehlgrund, der in einem angebundenen externen System auf diese Kennung abgebildet ist.

Response

{
  "data": [
    {
      "name": "EU",
      "comment": "Elternurlaub|en:Parental leave",
      "approve": true,
      "allow_self_entry": true,
      "allow_half_day_holiday": 1,
      "allow_hours_of_vacation": 1,
      "anyone_can_see_name": true,
      "color": "#664599",
      "type": {
        "id": 1,
        "name": "annual holiday"
      },
      "client_calendar_category": "string",
      "inform_employee_upon_approval_or_revocation": 1,
      "external_id": "string",
      "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
name
Type
string
Description
Eindeutiges Kürzel, das den Grund identifiziert; zugleich sein Routenschlüssel.
Name
comment
Type
string, nullable
Description
Freitextnotiz, die neben dem Grund im Kalender und in Berichten angezeigt wird.
Name
approve
Type
boolean, nullable
Description
Ob eine Buchung mit diesem Grund genehmigt werden muss, bevor sie angerechnet wird.
Name
allow_self_entry
Type
boolean
Description
Ob Mitarbeiter diesen Grund selbst buchen dürfen, ohne einen Vorgesetzten einzubeziehen.
Name
allow_half_day_holiday
Type
integer, nullable
Description
Ob dieser Grund für einen halben Tag statt nur für ganze Tage gebucht werden kann.
Name
allow_hours_of_vacation
Type
integer, nullable
Description
Ob dieser Grund in einzelnen Stunden statt nur in ganzen Tagen gebucht werden kann.
Name
anyone_can_see_name
Type
boolean, nullable
Description
Ob Kollegen, die die Fehlzeit nicht gebucht haben, den Namen dieses Grundes trotzdem sehen können.
Name
color
Type
string
Description
Farbe, mit der Buchungen dieses Grundes im Kalender hervorgehoben werden.
Name
type
Type
object, nullable
Description
Die Kategorie der Fehlzeit, die dieser Grund darstellt, z. B. Jahresurlaub, bezahlte oder unbezahlte Fehlzeit, Gleitzeit oder Homeoffice.
Name
type.id
Type
integer
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
type.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "annual holiday", "paid absence", "unpaid absence", "flexitime", "time off in lieu for business travel", "homeoffice"
Name
client_calendar_category
Type
string, nullable
Description
Kategorie, auf die dieser Grund in einem vom Client synchronisierten externen Kalender abgebildet wird.
Name
inform_employee_upon_approval_or_revocation
Type
integer, nullable
Description
Ob der Mitarbeiter per E-Mail benachrichtigt wird, wenn eine Buchung mit diesem Grund genehmigt oder widerrufen wird.
Name
external_id
Type
string, nullable
Description
Kennung, mit der dieser Grund auf den passenden Fehlzeittyp in einem angebundenen externen System abgebildet wird.
Name
created
Type
string (date-time), nullable
Description
Zeitstempel der Erstellung des Grundes.
Name
modified
Type
string (date-time), nullable
Description
Zeitstempel der letzten Änderung des Grundes.

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

Fehlgründe GET Einzelnen Fehlgrund abrufen