Neue API-Version v7.12 wurde veröffentlicht! 🎉
REST DokumentationMitarbeiterPOST Regelarbeitszeit anlegen

Regelarbeitszeit anlegen

Erfasst eine neue Regelarbeitszeit für den angegebenen Mitarbeiter.

Verfügbarkeit: Vollversion und ZEP Clock

Request

POST /api/v1/employees/{username}/regular-working-times
curl --request POST \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/employees/{username}/regular-working-times' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}' \
     --header 'Content-Type: application/json' \
     --data '{
       "employee_id": "max.mustermann",
       "start_date": "2024-01-15T00:00:00.000000Z",
       "monday": 8,
       "tuesday": 8,
       "wednesday": 4,
       "thursday": 8,
       "friday": 6,
       "saturday": 0,
       "sunday": 0,
       "monday_workday": true,
       "tuesday_workday": true,
       "wednesday_workday": true,
       "thursday_workday": true,
       "friday_workday": true,
       "saturday_workday": true,
       "sunday_workday": true,
       "is_monthly": true,
       "monthly_hours": 150.34,
       "max_hours_in_month": 137.51,
       "max_hours_in_week": 74.25,
       "break_regulation_type_id": 1,
       "holiday_calendar_id": 1
     }'

Pfad-Parameter

  • Name
    username
    Type
    string
    Description

    Der Benutzername des Mitarbeiters

Request-Body

  • Name
    employee_id
    Type
    string, erforderlich
    Description

    Benutzername des Mitarbeiters, für den diese Regelarbeitszeit gilt.

  • Name
    start_date
    Type
    string (date-time)
    Description

    Kalendertag, ab dem diese Regelarbeitszeit gilt.

  • Name
    monday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Montag.

  • Name
    tuesday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Dienstag.

  • Name
    wednesday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Mittwoch.

  • Name
    thursday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Donnerstag.

  • Name
    friday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Freitag.

  • Name
    saturday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Samstag.

  • Name
    sunday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Sonntag.

  • Name
    monday_workday
    Type
    boolean, nullable
    Description

    Ob Montag in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    tuesday_workday
    Type
    boolean, nullable
    Description

    Ob Dienstag in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    wednesday_workday
    Type
    boolean, nullable
    Description

    Ob Mittwoch in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    thursday_workday
    Type
    boolean, nullable
    Description

    Ob Donnerstag in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    friday_workday
    Type
    boolean, nullable
    Description

    Ob Freitag in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    saturday_workday
    Type
    boolean, nullable
    Description

    Ob Samstag in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    sunday_workday
    Type
    boolean, nullable
    Description

    Ob Sonntag in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    is_monthly
    Type
    boolean, nullable
    Description

    Ob die Regelarbeitszeit als Monatssumme statt pro Wochentag definiert ist.

  • Name
    monthly_hours
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden pro Monat, nur verwendet, wenn die Regelarbeitszeit monatlich definiert ist.

  • Name
    max_hours_in_month
    Type
    number, nullable
    Description

    Maximal zulässige Arbeitsstunden pro Monat gemäß dieser Regelarbeitszeit.

  • Name
    max_hours_in_week
    Type
    number, nullable
    Description

    Maximal zulässige Arbeitsstunden pro Woche gemäß dieser Regelarbeitszeit.

  • Name
    break_regulation_type_id
    Type
    integer, nullable
    Description

    Kennung der Pausenregelung, die auf diese Regelarbeitszeit angewendet wird.

  • Name
    holiday_calendar_id
    Type
    integer, nullable
    Description

    Kennung des Feiertagskalenders, aus dem die gesetzlichen Feiertage dieser Regelarbeitszeit stammen.

Response

{
  "data": {
    "id": 1,
    "employee_id": "max.mustermann",
    "start_date": "2024-01-15T00:00:00.000000Z",
    "monday": 8,
    "monday_workday": true,
    "tuesday": 8,
    "tuesday_workday": true,
    "wednesday": 4,
    "wednesday_workday": true,
    "thursday": 8,
    "thursday_workday": true,
    "friday": 6,
    "friday_workday": true,
    "saturday": 0,
    "saturday_workday": true,
    "sunday": 0,
    "sunday_workday": true,
    "is_monthly": true,
    "monthly_hours": 150.34,
    "max_hours_in_month": 137.51,
    "max_hours_in_week": 74.25,
    "holidayCalendar": {
      "id": 1,
      "name": "EU",
      "note": "Familienurlaub",
      "country": "Deutschland",
      "region": "East Tabitha",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    },
    "breakRegulationType": {
      "id": 1,
      "name": "EU",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    }
  }
}

Response-Felder

  • Name
    id
    Type
    integer
    Description

    Eindeutige Kennung der Regelarbeitszeit.

  • Name
    employee_id
    Type
    string
    Description

    Benutzername des Mitarbeiters, für den diese Regelarbeitszeit gilt.

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

    Kalendertag, ab dem diese Regelarbeitszeit gilt.

  • Name
    monday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Montag.

  • Name
    monday_workday
    Type
    boolean, nullable
    Description

    Ob Montag in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    tuesday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Dienstag.

  • Name
    tuesday_workday
    Type
    boolean, nullable
    Description

    Ob Dienstag in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    wednesday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Mittwoch.

  • Name
    wednesday_workday
    Type
    boolean, nullable
    Description

    Ob Mittwoch in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    thursday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Donnerstag.

  • Name
    thursday_workday
    Type
    boolean, nullable
    Description

    Ob Donnerstag in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    friday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Freitag.

  • Name
    friday_workday
    Type
    boolean, nullable
    Description

    Ob Freitag in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    saturday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Samstag.

  • Name
    saturday_workday
    Type
    boolean, nullable
    Description

    Ob Samstag in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    sunday
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden am Sonntag.

  • Name
    sunday_workday
    Type
    boolean, nullable
    Description

    Ob Sonntag in dieser Regelarbeitszeit als Arbeitstag zählt.

  • Name
    is_monthly
    Type
    boolean, nullable
    Description

    Ob die Regelarbeitszeit als Monatssumme statt pro Wochentag definiert ist.

  • Name
    monthly_hours
    Type
    number, nullable
    Description

    Geplante Arbeitsstunden pro Monat, nur gesetzt, wenn die Regelarbeitszeit monatlich definiert ist.

  • Name
    max_hours_in_month
    Type
    number, nullable
    Description

    Maximal zulässige Arbeitsstunden pro Monat gemäß dieser Regelarbeitszeit.

  • Name
    max_hours_in_week
    Type
    number, nullable
    Description

    Maximal zulässige Arbeitsstunden pro Woche gemäß dieser Regelarbeitszeit.

  • Name
    holidayCalendar
    Type
    object (HolidayCalendar)
    Description

    Feiertagskalender, aus dem die gesetzlichen Feiertage dieser Regelarbeitszeit stammen.

  • Name
    holidayCalendar.id
    Type
    integer
    Description

    Eindeutige Kennung des Feiertagskalenders.

  • Name
    holidayCalendar.name
    Type
    string
    Description

    Kurzbezeichnung des Feiertagskalenders.

  • Name
    holidayCalendar.note
    Type
    string, nullable
    Description

    Freitextnotiz zum Feiertagskalender.

  • Name
    holidayCalendar.country
    Type
    string, nullable
    Description

    Land, dessen gesetzliche Feiertage dieser Kalender abdeckt.

  • Name
    holidayCalendar.region
    Type
    string, nullable
    Description

    Region oder Bundesland innerhalb des Landes, das dieser Kalender abdeckt, sofern eingeschränkt.

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

    Zeitstempel der Erstellung des Feiertagskalenders.

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

    Zeitstempel der letzten Änderung des Feiertagskalenders.

  • Name
    breakRegulationType
    Type
    object (BreakRegulationType)
    Description

    Pausenregelung, die bei der Berechnung der Pausen für diese Regelarbeitszeit angewendet wird.

  • Name
    breakRegulationType.id
    Type
    integer
    Description

    Eindeutige Kennung der Pausenregelung.

  • Name
    breakRegulationType.name
    Type
    string
    Description

    Anzeigename der Pausenregelung.

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

    Zeitstempel, zu dem die Pausenregelung angelegt wurde.

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

    Zeitstempel, zu dem die Pausenregelung zuletzt geändert wurde.

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