REST DokumentationFehlzeitenPOST Fehlzeit anlegen

Fehlzeit anlegen

Erfasst eine neue Fehlzeit für einen Mitarbeiter. Die timezone ist für jede Fehlzeitart optional und ist standardmäßig die Zeitzone des Servers. Eine Anfrage, die ZEP fachlich ablehnt (zum Beispiel eine Fehlzeit vor dem Einführungsdatum des Fehlzeitenmoduls), wird mit 422 und dem code business_rule_violation, der message von ZEP und der ZEP-Nummer unter zep_code beantwortet; das gilt nur für den ZEP-Code 104 (ZEP beantwortet auch einen Speicherfehler in ZEP mit demselben Code). Jeder andere Fehler auf ZEP-Seite wird mit 502 beantwortet.

Verfügbarkeit: Vollversion und ZEP Clock

Request

POST /api/v1/absences
curl --request POST \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/absences' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}' \
     --header 'Content-Type: application/json' \
     --data '{
       "employee_id": "max.mustermann",
       "type": 0,
       "hours": 1.5,
       "from": "string",
       "to": "string",
       "timezone": "Asia/Oral",
       "note": "Familienurlaub",
       "planned": true,
       "start_date": "2024-01-15T00:00:00.000000Z",
       "end_date": "2024-01-16T00:00:00.000000Z",
       "absence_reason_id": "UB"
     }'

Request-Body

  • Name
    employee_id
    Type
    string, erforderlich
    Description

    Benutzername des Mitarbeiters, für den diese Fehlzeit erfasst wird.

  • Name
    type
    Type
    integer, nullable
    Description

    Ob die Fehlzeit einen ganzen Tag, einen halben Tag oder eine Anzahl von Stunden umfasst.

    Einer der Werte: 0, 1, 2

  • Name
    hours
    Type
    number, nullable
    Description

    Anzahl der Fehlstunden, erforderlich bei einer stundenweisen Fehlzeit.

  • Name
    from
    Type
    string, nullable
    Description

    Uhrzeit, zu der die stundenweise Fehlzeit beginnt, erforderlich bei einer stundenweisen Fehlzeit.

  • Name
    to
    Type
    string, nullable
    Description

    Uhrzeit, zu der die stundenweise Fehlzeit endet, erforderlich bei einer stundenweisen Fehlzeit.

  • Name
    timezone
    Type
    string, nullable
    Description

    IANA-Zeitzone, in der die Von-/Bis-Zeiten der Fehlzeit angegeben sind. Für jede Fehlzeitart optional; ohne Angabe gilt die Zeitzone des Servers.

  • Name
    note
    Type
    string, nullable
    Description

    Freitextnotiz zur Fehlzeit.

  • Name
    planned
    Type
    boolean, nullable
    Description

    Ob die Fehlzeit nur geplant und noch nicht genehmigt ist.

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

    Erster Kalendertag, den die Fehlzeit umfasst.

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

    Letzter Kalendertag, den die Fehlzeit umfasst.

  • Name
    absence_reason_id
    Type
    string, erforderlich
    Description

    Kennung des Fehlgrundes (Urlaub, Krankheit, …), unter dem diese Fehlzeit abgelegt ist.

Response

{
  "data": {
    "id": 1,
    "employee_id": "max.mustermann",
    "type": 0,
    "start_date": "2024-01-15T00:00:00.000000Z",
    "end_date": "2024-01-16T00:00:00.000000Z",
    "hours": 1.5,
    "from": "string",
    "to": "string",
    "note": "Familienurlaub",
    "approved": true,
    "timezone": "Asia/Oral",
    "created": "2024-07-20T11:30:00.000000Z",
    "modified": "2024-07-20T12:30:00.000000Z",
    "absence_reason_id": "UB",
    "absenceReason": {
      "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"
    },
    "leaveApprovalApplication": {
      "id": 1,
      "employee_id": "max.mustermann",
      "requested_at": "2024-01-10 13:04:34",
      "number_of_days": 1.5,
      "start_date": "2024-01-15T00:00:00.000000Z",
      "end_date": "2024-01-16T00:00:00.000000Z",
      "note": "Familienurlaub",
      "status": {
        "id": 1,
        "name": "Requested"
      },
      "recipient": "vorgesetzter@beispiel.de",
      "recipient_cc": "personal@beispiel.de",
      "recipient_bcc": "string",
      "status_edited_since": "2024-01-11 10:30:00",
      "status_edited_by": "vorgesetzter.nutzer",
      "status_note": "Genehmigt - Schönen Urlaub!",
      "absence_text": "Urlaubsantrag für Familienausflug"
    }
  }
}

Response-Felder

  • Name
    id
    Type
    integer
    Description

    Eindeutige Kennung der Fehlzeit.

  • Name
    employee_id
    Type
    string
    Description

    Benutzername des Mitarbeiters, zu dem diese Fehlzeit gehört.

  • Name
    type
    Type
    integer
    Description

    Ob die Fehlzeit einen ganzen Tag, einen halben Tag oder eine Anzahl von Stunden umfasst.

    Einer der Werte: 0, 1, 2

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

    Erster Kalendertag, den die Fehlzeit umfasst.

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

    Letzter Kalendertag, den die Fehlzeit umfasst.

  • Name
    hours
    Type
    number, nullable
    Description

    Anzahl der Fehlstunden, nur bei einer stundenweisen Fehlzeit gesetzt.

  • Name
    from
    Type
    string, nullable
    Description

    Uhrzeit, zu der die stundenweise Fehlzeit beginnt, nur bei einer stundenweisen Fehlzeit gesetzt.

  • Name
    to
    Type
    string, nullable
    Description

    Uhrzeit, zu der die stundenweise Fehlzeit endet, nur bei einer stundenweisen Fehlzeit gesetzt.

  • Name
    note
    Type
    string, nullable
    Description

    Freitextnotiz zur Fehlzeit.

  • Name
    approved
    Type
    boolean
    Description

    Ob die Fehlzeit genehmigt und nicht nur geplant ist.

  • Name
    timezone
    Type
    string, nullable
    Description

    Zeitzone, in der die from/to-Zeiten der Fehlzeit angegeben sind.

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

    Zeitstempel der Erfassung der Fehlzeit.

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

    Zeitstempel der letzten Änderung der Fehlzeit.

  • Name
    absence_reason_id
    Type
    string
    Description

    Kennung des Fehlgrundes (Urlaub, Krankheit, …), unter dem diese Fehlzeit abgelegt ist.

  • Name
    absenceReason
    Type
    object (AbsenceReason)
    Description

    Der Fehlgrund, unter dem diese Fehlzeit abgelegt ist.

  • Name
    absenceReason.name
    Type
    string
    Description

    Eindeutiges Kürzel, das den Grund identifiziert; zugleich sein Routenschlüssel.

  • Name
    absenceReason.comment
    Type
    string, nullable
    Description

    Freitextnotiz, die neben dem Grund im Kalender und in Berichten angezeigt wird.

  • Name
    absenceReason.approve
    Type
    boolean, nullable
    Description

    Ob eine Buchung mit diesem Grund genehmigt werden muss, bevor sie angerechnet wird.

  • Name
    absenceReason.allow_self_entry
    Type
    boolean
    Description

    Ob Mitarbeiter diesen Grund selbst buchen dürfen, ohne einen Vorgesetzten einzubeziehen.

  • Name
    absenceReason.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
    absenceReason.allow_hours_of_vacation
    Type
    integer, nullable
    Description

    Ob dieser Grund in einzelnen Stunden statt nur in ganzen Tagen gebucht werden kann.

  • Name
    absenceReason.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
    absenceReason.color
    Type
    string
    Description

    Farbe, mit der Buchungen dieses Grundes im Kalender hervorgehoben werden.

  • Name
    absenceReason.type
    Type
    object, nullable
    Description

    Die Kategorie der Fehlzeit, die dieser Grund darstellt, z. B. Jahresurlaub, bezahlte oder unbezahlte Fehlzeit, Gleitzeit oder Homeoffice.

  • Name
    absenceReason.client_calendar_category
    Type
    string, nullable
    Description

    Kategorie, auf die dieser Grund in einem vom Client synchronisierten externen Kalender abgebildet wird.

  • Name
    absenceReason.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
    absenceReason.external_id
    Type
    string, nullable
    Description

    Kennung, mit der dieser Grund auf den passenden Fehlzeittyp in einem angebundenen externen System abgebildet wird.

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

    Zeitstempel der Erstellung des Grundes.

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

    Zeitstempel der letzten Änderung des Grundes.

  • Name
    leaveApprovalApplication
    Type
    object (LeaveApprovalApplication)
    Description

    Der Genehmigungsantrag, den diese Fehlzeit durchlaufen hat, sofern der Mandant verlangt, dass Fehlzeiten vor ihrem Wirksamwerden genehmigt werden.

  • Name
    leaveApprovalApplication.id
    Type
    integer
    Description

    Eindeutige Kennung des Urlaubsantrags.

  • Name
    leaveApprovalApplication.employee_id
    Type
    string
    Description

    Benutzername des Mitarbeiters, der den Urlaub beantragt hat.

  • Name
    leaveApprovalApplication.requested_at
    Type
    string (date-time), nullable
    Description

    Zeitstempel, zu dem der Urlaubsantrag eingereicht wurde.

  • Name
    leaveApprovalApplication.number_of_days
    Type
    number
    Description

    Anzahl der Tage, die der beantragte Urlaub umfasst.

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

    Erster Kalendertag des beantragten Urlaubs.

  • Name
    leaveApprovalApplication.end_date
    Type
    string, nullable
    Description

    Letzter Kalendertag des beantragten Urlaubs.

  • Name
    leaveApprovalApplication.note
    Type
    string
    Description

    Freitextnotiz zum Urlaubsantrag.

  • Name
    leaveApprovalApplication.status
    Type
    object
    Description

    Aktueller Genehmigungsstatus des Urlaubsantrags (z. B. offen, genehmigt, abgelehnt).

  • Name
    leaveApprovalApplication.recipient
    Type
    string
    Description

    Hauptempfänger, an den die Genehmigungsanfrage gesendet wurde.

  • Name
    leaveApprovalApplication.recipient_cc
    Type
    string
    Description

    Weitere Empfänger, die die Genehmigungsanfrage in Kopie erhalten haben.

  • Name
    leaveApprovalApplication.recipient_bcc
    Type
    string
    Description

    Weitere Empfänger, die die Genehmigungsanfrage in Blindkopie erhalten haben.

  • Name
    leaveApprovalApplication.status_edited_since
    Type
    string (date-time), nullable
    Description

    Zeitstempel, seit dem der aktuelle Status gilt.

  • Name
    leaveApprovalApplication.status_edited_by
    Type
    string
    Description

    Benutzername der Person, die den Genehmigungsstatus zuletzt geändert hat.

  • Name
    leaveApprovalApplication.status_note
    Type
    string
    Description

    Freitextnotiz, die bei der letzten Änderung des Genehmigungsstatus hinterlassen wurde.

  • Name
    leaveApprovalApplication.absence_text
    Type
    string
    Description

    Aufbereiteter Text, der die beantragte Fehlzeit zusammenfasst, wie er Genehmigenden angezeigt wird.

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