Zum Inhalt springen
Developer

NonWorkTimeRequest

Personal10 EndpunkteTimeTracking / NonWorkTimeRequest

Der genehmigte Antrag als druckbares Dokument

GET/api/time/non_work_time_request/{id}/pdf

Die Papierregel, die der digitale Antrag ersetzt hat, gilt weiterhin auf Papier: Der genehmigte Antrag geht an den Teamleiter zurück, und die Mitarbeitenden erhalten auf Wunsch einen Ausdruck. Zurückgezogene Tage werden als zurückgezogen benannt und nicht nur als fehlend – die Regeln verlangen genau das.

Pfad-Parameter

idPflichtstring

Antworten

200PDF des Abwesenheitsantrags

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/time/non_work_time_request/42/pdf \
  --header 'x-iw-jwt-token: <TOKEN>'

Alle NonWorkTimeRequest abrufen

GET/api/time/non_work_time_request

Query-Parameter

searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Alle NonWorkTimeRequest abrufenarray<NonWorkTimeRequest>

Felder anzeigen (35)
  • overdueboolean

    U04: noch offen nach Ablauf der Bearbeitungsfrist.

  • approval_versioninteger

    Version des Genehmigungsprozesses.

  • change_modestring

    Art der Änderung an der Anfrage.

  • balance_override_reasonstring

    L11: warum ein Planer diesen Antrag genehmigt hat, obwohl der prognostizierte Urlaubssaldo negativ war.

  • coverage_override_reasonstring

    L54: warum der Genehmiger einen Tag unter der Mindestbesetzung akzeptiert hat.

  • coverage_hintboolean

    L53: eingereicht, obwohl er den Personalpuffer angreift - die Genehmiger sehen den Hinweis.

  • sick_during_vacationboolean

    U13: eine Krankmeldung innerhalb genehmigten Urlaubs - vom Server gesetzt, angezeigt als "während Urlaub".

  • consultation_notestring

    Wer vor der Anfrage von Tagen, die ein blockierender Zeitraum als nur mit Abstimmung markiert (U14), konsultiert wurde.

  • daily_absence_start_timestring

    Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.

  • daily_absence_end_timestring

    Endzeit der ganztägigen Abwesenheit.

  • idinteger

    Primärschlüssel der Anfrage. Interne ID.

  • userUser14

    Benutzer, zu dem die Anfrage gehört.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • descriptionstring

    Beschreibung des Antrags.

  • startstring (date-time)

    Beginn des angefragten Zeitraums.

  • start_datestring

    Startdatum des angefragten Zeitraums.

  • start_monthinteger

    Startmonat des angefragten Zeitraums.

  • start_yearinteger

    Startjahr des angefragten Zeitraums.

  • endstring (date-time)

    Ende des angeforderten Zeitraums.

  • end_datestring

    Enddatum des angeforderten Zeitraums.

  • end_monthinteger

    Endmonat des angeforderten Zeitraums.

  • end_yearinteger

    Endjahr des angeforderten Zeitraums.

  • durationnumber (float)

    Dauer in Tagen, verknüpft mit NonWorkTimePlan – ein Halbtagstyp zählt 0,5 (Z6)

  • statusstring

    Status der Anfrage.

  • content_typestring

    Art des Antrags, z. B. Urlaub oder Abwesenheit.

  • secondary_content_typestring

    Sekundärer Typ der Anfrage.

  • linked_content_typeNonWorkTimePlanSelectionType3

    Mit der Anfrage verknüpfter Planauswahltyp.

    Felder anzeigen (15)
    • effective_colorstring

      Die anzuzeigende Farbe: die konfigurierte, sonst die Standardfarbe des Typs.

    • namestring

      Name der Abwesenheitsart, zum Beispiel Urlaub oder Krankheit.

    • valueinteger

      Numerischer Wert der Abwesenheitsart.

    • priorityinteger

      Priorität des Abwesenheitstyps, wenn sich mehrere Typen überschneiden.

    • processed_content_typestring

      Inhaltstyp, der bei der Bearbeitung der Abwesenheit verwendet wird.

    • secondary_content_type_optionsstring

      Optionen für den sekundären Inhaltstyp, durch Komma getrennt

    • iconstring

      Symbol des Abwesenheitstyps.

    • is_vacationboolean

      Die Abwesenheitsart zählt als Urlaub.

    • is_sickboolean

      Die Abwesenheitsart zählt als Krankheit.

    • status_change_requires_hr_approvalboolean

      Die Änderung des Status dieses Abwesenheitstyps erfordert eine HR-Genehmigung.

    • selectable_for_requestboolean

      Ob mit diesem Typ eine neue Abwesenheitsanfrage angelegt werden darf. Typen, die nur einen Tag in einer Übersicht beschreiben – Feiertag, Schulferien, Arbeitstag –, werden in den Editoren nicht angeboten.

    • requires_management_approvalboolean

      Anträge dieses Typs benötigen eine abschließende schriftliche Entscheidung der Geschäftsführung (der Organisationsleitung), die nach der regulären Genehmigungskette (U10) angehängt wird.

    • max_days_per_requestinteger

      Obergrenze der Kalendertage, die eine Anfrage dieses Typs umfassen darf; null = unbegrenzt.

    • colorstring

      R5: Farbe dieses Abwesenheitstyps im Schichtplan und im Teamkalender ("#RRGGBB"); null = der Standardwert des Typs (getEffectiveColor). Wird mit absence_type_colors_enabled verwendet.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • parent_requestNonWorkTimeRequest

    Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.

  • annual_requestNonWorkTimeAnnualRequest4

    L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.

    Felder anzeigen (9)
    • idinteger

      Primärschlüssel der Jahresanfrage. Interne ID.

    • userUser14

      Benutzer, zu dem der Jahresantrag gehört.

    • personCRMPerson10

      Person, zu der der Jahresantrag gehört.

    • yearinteger

      Das Urlaubsjahr, zu dem die Zeiträume gehören.

    • content_typeinteger

      Abwesenheitstyp jedes Zeitraums (Wert von NonWorkTimePlanSelectionType).

    • descriptionstring

      Beschreibung des Jahresantrags.

    • statusstring

      Abgeleitet aus den Zeiträumen, siehe Klassenkommentar.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • request_kindstring

    U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.

  • processing_due_datestring (date-time)

    U04/U20: der Tag, bis zu dem über den Antrag entschieden werden muss, gerechnet ab Eingang.

  • escalated_atstring (date-time)

    U04: Zeitpunkt, zu dem die Eskalation wegen Überfälligkeit gesendet wurde; null = noch nicht eskaliert.

  • written_approval_reasonstring

    U21: warum dieser Antrag um den Schritt der Geschäftsführung mit schriftlichem Kommentar ergänzt wurde (z. B. SUMMER_CANCELLATION); null = keine zusätzliche schriftliche Genehmigung nötig.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/time/non_work_time_request \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "description": "Text",
    "overdue": true,
    "approval_version": 1,
    "change_mode": "string",
    "balance_override_reason": "string",
    "coverage_override_reason": "string",
    "coverage_hint": true,
    "sick_during_vacation": true,
    "consultation_note": "string"
  }
]

Einzelnen NonWorkTimeRequest anlegen

POST/api/time/non_work_time_request

Request-Body application/json

  • dataNonWorkTimeRequest2
    Felder anzeigen (17)
    • change_modestring

      Art der Änderung an der Anfrage.

    • daily_absence_start_timestring

      Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.

    • daily_absence_end_timestring

      Endzeit der ganztägigen Abwesenheit.

    • personCRMPerson37

      Person, zu der der Antrag gehört.

    • contractEmploymentContract8

      Arbeitsvertrag, zu dem der Antrag gehört.

    • descriptionstring

      Beschreibung des Antrags.

    • startstring (date-time)

      Beginn des angefragten Zeitraums.

    • endstring (date-time)

      Ende des angeforderten Zeitraums.

    • statusstring

      Status der Anfrage.

    • content_typestring

      Art des Antrags, z. B. Urlaub oder Abwesenheit.

    • secondary_content_typestring

      Sekundärer Typ der Anfrage.

    • attachmentsarray<Attachment12>

      Anhänge der Anfrage.

    • commentsarray<NonWorkTimeRequestComment3>

      Kommentare zum Antrag.

    • plan_entriesarray<NonWorkTimePlan>

      Für die Anfrage erzeugte Planeinträge.

    • parent_requestNonWorkTimeRequest2

      Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.

    • annual_requestNonWorkTimeAnnualRequest5

      L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.

    • request_kindstring

      U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.

Antworten

200Einzelnen NonWorkTimeRequest anlegenNonWorkTimeRequest3

Felder anzeigen (39)
  • overdueboolean

    U04: noch offen nach Ablauf der Bearbeitungsfrist.

  • approval_versioninteger

    Version des Genehmigungsprozesses.

  • change_modestring

    Art der Änderung an der Anfrage.

  • balance_override_reasonstring

    L11: warum ein Planer diesen Antrag genehmigt hat, obwohl der prognostizierte Urlaubssaldo negativ war.

  • coverage_override_reasonstring

    L54: warum der Genehmiger einen Tag unter der Mindestbesetzung akzeptiert hat.

  • coverage_hintboolean

    L53: eingereicht, obwohl er den Personalpuffer angreift - die Genehmiger sehen den Hinweis.

  • sick_during_vacationboolean

    U13: eine Krankmeldung innerhalb genehmigten Urlaubs - vom Server gesetzt, angezeigt als "während Urlaub".

  • consultation_notestring

    Wer vor der Anfrage von Tagen, die ein blockierender Zeitraum als nur mit Abstimmung markiert (U14), konsultiert wurde.

  • daily_absence_start_timestring

    Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.

  • daily_absence_end_timestring

    Endzeit der ganztägigen Abwesenheit.

  • idinteger

    Primärschlüssel der Anfrage. Interne ID.

  • userUser14

    Benutzer, zu dem die Anfrage gehört.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • contractEmploymentContract9

    Arbeitsvertrag, zu dem der Antrag gehört.

    Felder anzeigen (43)
    • staged_absence_approvalboolean

      null übernimmt zuerst die Gruppen- und dann die Organisationsrichtlinie; bestehende Installationen bleiben aus.

    • idinteger

      Primärschlüssel des Arbeitsvertrags. Interne ID.

    • tokenstring

      Öffentlicher Token des Vertrags. Anstelle der ID verwendet.

    • userUser14

      Benutzer des Mitarbeiters.

    • week_total_hoursnumber (float)

      Gesamte Arbeitsstunden pro Woche.

    • week_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche.

    • reserved_hours_preparationnumber (float)

      L03: wöchentliche Stunden, die für Vorbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_follow_upnumber (float)

      L03: wöchentliche Stunden, die für Nachbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_travelnumber (float)

      L03: wöchentliche Stunden, die für Fahrt reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_flexiblenumber (float)

      L03: wöchentliche Stunden, die für freie Einteilung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • week_full_time_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche bei einem Vollzeitvertrag.

    • year_vacation_daysnumber (float)

      Urlaubstage pro Jahr.

    • month_vacation_daysnumber (float)

      Urlaubstage pro Monat.

    • year_vacation_weeksnumber (float)

      Urlaubswochen pro Jahr.

    • monday_hoursnumber (float)

      Arbeitsstunden am Montag.

    • tuesday_hoursnumber (float)

      Arbeitsstunden am Dienstag.

    • wednesday_hoursnumber (float)

      Arbeitsstunden am Mittwoch.

    • thursday_hoursnumber (float)

      Arbeitsstunden am Donnerstag.

    • friday_hoursnumber (float)

      Arbeitsstunden am Freitag.

    • saturday_hoursnumber (float)

      Arbeitsstunden am Samstag.

    • sunday_hoursnumber (float)

      Arbeitsstunden am Sonntag.

    • netto_hour_costnumber (float)

      Nettokosten je Stunde.

    • brutto_hour_costnumber (float)

      Bruttokosten pro Stunde.

    • startstring (date-time)

      Startdatum des Vertrags.

    • endstring (date-time)

      Enddatum des Vertrags.

    • fixed_term_statusstring

      Befristung: PERMANENT (unbefristet, Standard), FIXED_TERM oder EXTENDED (FIXED_TERM_STATUS_*).

    • fixed_term_endstring (date-time)

      Befristet bis (erster Zeitraum).

    • fixed_term_extension_endstring (date-time)

      Befristet bis nach Verlängerung.

    • probation_endstring (date-time)

      Probezeit bis; wird aus den probationMonths der Vorlage gefüllt, wenn ein Vertrag ohne diese Angabe angelegt wird.

    • numberstring

      Vertragsnummer.

    • descriptionstring

      Beschreibung des Vertrags.

    • archivedboolean

      Der Vertrag ist archiviert.

    • allow_app_time_trackingboolean

      Der Mitarbeitende darf Zeiten in der App erfassen.

    • allow_scanner_time_trackingboolean

      Der Mitarbeitende darf Zeiten mit dem Scanner erfassen.

    • allow_app_non_work_time_managementboolean

      Der Mitarbeitende darf Abwesenheiten in der App verwalten.

    • force_no_auto_breakboolean

      Für diesen Vertrag werden keine automatischen Pausen hinzugefügt.

    • work_time_modestring

      Wie die Sollarbeitszeit definiert ist - null verhält sich wie WEEKDAY_HOURS, damit bestehende Verträge ihr bisheriges Verhalten unverändert beibehalten.

    • holiday_credit_modestring

      Feiertagsguthaben für WEEK_TOTAL-Verträge - null verhält sich wie WEEKDAY_TARGET (bisheriges Verhalten, nur bei WEEKDAY_HOURS-Verträgen sinnvoll).

    • holiday_credit_fixed_secondsinteger

      Fester Feiertagsguthaben in Sekunden.

    • planning_weekdays_bitmaskinteger

      ISO-Wochentagsbitmaske (Mo=1 ... So=64) der Tage, an denen dieser WEEK_TOTAL-Vertrag eingeplant werden bzw. Urlaub nehmen kann - null verhält sich wie Mo-Fr.

    • request_lead_time_daysinteger

      Tage, die ein Abwesenheitsantrag vor seinem ersten Tag eingereicht werden muss ("Bearbeitungs- frist"). null greift zunächst auf die Vertragsgruppe und von dort auf die Einstellung der Installation zurück, damit ein bestehender Vertrag genau wie bisher funktioniert.

    • shift_booking_syncboolean

      L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Gruppe (die wiederum die Organisation übernimmt).

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • descriptionstring

    Beschreibung des Antrags.

  • startstring (date-time)

    Beginn des angefragten Zeitraums.

  • start_datestring

    Startdatum des angefragten Zeitraums.

  • start_monthinteger

    Startmonat des angefragten Zeitraums.

  • start_yearinteger

    Startjahr des angefragten Zeitraums.

  • endstring (date-time)

    Ende des angeforderten Zeitraums.

  • end_datestring

    Enddatum des angeforderten Zeitraums.

  • end_monthinteger

    Endmonat des angeforderten Zeitraums.

  • end_yearinteger

    Endjahr des angeforderten Zeitraums.

  • durationnumber (float)

    Dauer in Tagen, verknüpft mit NonWorkTimePlan – ein Halbtagstyp zählt 0,5 (Z6)

  • statusstring

    Status der Anfrage.

  • content_typestring

    Art des Antrags, z. B. Urlaub oder Abwesenheit.

  • secondary_content_typestring

    Sekundärer Typ der Anfrage.

  • linked_content_typeNonWorkTimePlanSelectionType3

    Mit der Anfrage verknüpfter Planauswahltyp.

    Felder anzeigen (15)
    • effective_colorstring

      Die anzuzeigende Farbe: die konfigurierte, sonst die Standardfarbe des Typs.

    • namestring

      Name der Abwesenheitsart, zum Beispiel Urlaub oder Krankheit.

    • valueinteger

      Numerischer Wert der Abwesenheitsart.

    • priorityinteger

      Priorität des Abwesenheitstyps, wenn sich mehrere Typen überschneiden.

    • processed_content_typestring

      Inhaltstyp, der bei der Bearbeitung der Abwesenheit verwendet wird.

    • secondary_content_type_optionsstring

      Optionen für den sekundären Inhaltstyp, durch Komma getrennt

    • iconstring

      Symbol des Abwesenheitstyps.

    • is_vacationboolean

      Die Abwesenheitsart zählt als Urlaub.

    • is_sickboolean

      Die Abwesenheitsart zählt als Krankheit.

    • status_change_requires_hr_approvalboolean

      Die Änderung des Status dieses Abwesenheitstyps erfordert eine HR-Genehmigung.

    • selectable_for_requestboolean

      Ob mit diesem Typ eine neue Abwesenheitsanfrage angelegt werden darf. Typen, die nur einen Tag in einer Übersicht beschreiben – Feiertag, Schulferien, Arbeitstag –, werden in den Editoren nicht angeboten.

    • requires_management_approvalboolean

      Anträge dieses Typs benötigen eine abschließende schriftliche Entscheidung der Geschäftsführung (der Organisationsleitung), die nach der regulären Genehmigungskette (U10) angehängt wird.

    • max_days_per_requestinteger

      Obergrenze der Kalendertage, die eine Anfrage dieses Typs umfassen darf; null = unbegrenzt.

    • colorstring

      R5: Farbe dieses Abwesenheitstyps im Schichtplan und im Teamkalender ("#RRGGBB"); null = der Standardwert des Typs (getEffectiveColor). Wird mit absence_type_colors_enabled verwendet.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • attachmentsarray<Attachment10>

    Anhänge der Anfrage.

    Felder anzeigen (25)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • commentsarray<NonWorkTimeRequestComment4>

    Kommentare zum Antrag.

    Felder anzeigen (5)
    • idinteger

      Primärschlüssel des Kommentars zur Abwesenheitsanfrage. Interne ID.

    • userUser14

      Benutzer, der den Kommentar verfasst hat.

    • descriptionstring

      Text des Kommentars.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • plan_entriesarray<NonWorkTimePlan2>

    Für die Anfrage erzeugte Planeinträge.

    Felder anzeigen (1)
    • idinteger

      Primärschlüssel des Abwesenheitsplan-Eintrags. Interne ID.

  • parent_requestNonWorkTimeRequest3

    Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.

  • annual_requestNonWorkTimeAnnualRequest6

    L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.

    Felder anzeigen (9)
    • idinteger

      Primärschlüssel der Jahresanfrage. Interne ID.

    • userUser14

      Benutzer, zu dem der Jahresantrag gehört.

    • personCRMPerson10

      Person, zu der der Jahresantrag gehört.

    • yearinteger

      Das Urlaubsjahr, zu dem die Zeiträume gehören.

    • content_typeinteger

      Abwesenheitstyp jedes Zeitraums (Wert von NonWorkTimePlanSelectionType).

    • descriptionstring

      Beschreibung des Jahresantrags.

    • statusstring

      Abgeleitet aus den Zeiträumen, siehe Klassenkommentar.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • request_kindstring

    U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.

  • processing_due_datestring (date-time)

    U04/U20: der Tag, bis zu dem über den Antrag entschieden werden muss, gerechnet ab Eingang.

  • escalated_atstring (date-time)

    U04: Zeitpunkt, zu dem die Eskalation wegen Überfälligkeit gesendet wurde; null = noch nicht eskaliert.

  • written_approval_reasonstring

    U21: warum dieser Antrag um den Schritt der Geschäftsführung mit schriftlichem Kommentar ergänzt wurde (z. B. SUMMER_CANCELLATION); null = keine zusätzliche schriftliche Genehmigung nötig.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/time/non_work_time_request \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "description": "Text",
    "change_mode": "string",
    "daily_absence_start_time": "string",
    "daily_absence_end_time": "string",
    "start": "2026-10-15T09:30:00+02:00",
    "end": "2026-10-15T09:30:00+02:00"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "description": "Text",
  "overdue": true,
  "approval_version": 1,
  "change_mode": "string",
  "balance_override_reason": "string",
  "coverage_override_reason": "string",
  "coverage_hint": true,
  "sick_during_vacation": true,
  "consultation_note": "string"
}

Einzelnen NonWorkTimeRequest abrufen

GET/api/time/non_work_time_request/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Einzelnen NonWorkTimeRequest abrufenNonWorkTimeRequest3

Felder anzeigen (39)
  • overdueboolean

    U04: noch offen nach Ablauf der Bearbeitungsfrist.

  • approval_versioninteger

    Version des Genehmigungsprozesses.

  • change_modestring

    Art der Änderung an der Anfrage.

  • balance_override_reasonstring

    L11: warum ein Planer diesen Antrag genehmigt hat, obwohl der prognostizierte Urlaubssaldo negativ war.

  • coverage_override_reasonstring

    L54: warum der Genehmiger einen Tag unter der Mindestbesetzung akzeptiert hat.

  • coverage_hintboolean

    L53: eingereicht, obwohl er den Personalpuffer angreift - die Genehmiger sehen den Hinweis.

  • sick_during_vacationboolean

    U13: eine Krankmeldung innerhalb genehmigten Urlaubs - vom Server gesetzt, angezeigt als "während Urlaub".

  • consultation_notestring

    Wer vor der Anfrage von Tagen, die ein blockierender Zeitraum als nur mit Abstimmung markiert (U14), konsultiert wurde.

  • daily_absence_start_timestring

    Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.

  • daily_absence_end_timestring

    Endzeit der ganztägigen Abwesenheit.

  • idinteger

    Primärschlüssel der Anfrage. Interne ID.

  • userUser14

    Benutzer, zu dem die Anfrage gehört.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • contractEmploymentContract9

    Arbeitsvertrag, zu dem der Antrag gehört.

    Felder anzeigen (43)
    • staged_absence_approvalboolean

      null übernimmt zuerst die Gruppen- und dann die Organisationsrichtlinie; bestehende Installationen bleiben aus.

    • idinteger

      Primärschlüssel des Arbeitsvertrags. Interne ID.

    • tokenstring

      Öffentlicher Token des Vertrags. Anstelle der ID verwendet.

    • userUser14

      Benutzer des Mitarbeiters.

    • week_total_hoursnumber (float)

      Gesamte Arbeitsstunden pro Woche.

    • week_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche.

    • reserved_hours_preparationnumber (float)

      L03: wöchentliche Stunden, die für Vorbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_follow_upnumber (float)

      L03: wöchentliche Stunden, die für Nachbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_travelnumber (float)

      L03: wöchentliche Stunden, die für Fahrt reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_flexiblenumber (float)

      L03: wöchentliche Stunden, die für freie Einteilung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • week_full_time_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche bei einem Vollzeitvertrag.

    • year_vacation_daysnumber (float)

      Urlaubstage pro Jahr.

    • month_vacation_daysnumber (float)

      Urlaubstage pro Monat.

    • year_vacation_weeksnumber (float)

      Urlaubswochen pro Jahr.

    • monday_hoursnumber (float)

      Arbeitsstunden am Montag.

    • tuesday_hoursnumber (float)

      Arbeitsstunden am Dienstag.

    • wednesday_hoursnumber (float)

      Arbeitsstunden am Mittwoch.

    • thursday_hoursnumber (float)

      Arbeitsstunden am Donnerstag.

    • friday_hoursnumber (float)

      Arbeitsstunden am Freitag.

    • saturday_hoursnumber (float)

      Arbeitsstunden am Samstag.

    • sunday_hoursnumber (float)

      Arbeitsstunden am Sonntag.

    • netto_hour_costnumber (float)

      Nettokosten je Stunde.

    • brutto_hour_costnumber (float)

      Bruttokosten pro Stunde.

    • startstring (date-time)

      Startdatum des Vertrags.

    • endstring (date-time)

      Enddatum des Vertrags.

    • fixed_term_statusstring

      Befristung: PERMANENT (unbefristet, Standard), FIXED_TERM oder EXTENDED (FIXED_TERM_STATUS_*).

    • fixed_term_endstring (date-time)

      Befristet bis (erster Zeitraum).

    • fixed_term_extension_endstring (date-time)

      Befristet bis nach Verlängerung.

    • probation_endstring (date-time)

      Probezeit bis; wird aus den probationMonths der Vorlage gefüllt, wenn ein Vertrag ohne diese Angabe angelegt wird.

    • numberstring

      Vertragsnummer.

    • descriptionstring

      Beschreibung des Vertrags.

    • archivedboolean

      Der Vertrag ist archiviert.

    • allow_app_time_trackingboolean

      Der Mitarbeitende darf Zeiten in der App erfassen.

    • allow_scanner_time_trackingboolean

      Der Mitarbeitende darf Zeiten mit dem Scanner erfassen.

    • allow_app_non_work_time_managementboolean

      Der Mitarbeitende darf Abwesenheiten in der App verwalten.

    • force_no_auto_breakboolean

      Für diesen Vertrag werden keine automatischen Pausen hinzugefügt.

    • work_time_modestring

      Wie die Sollarbeitszeit definiert ist - null verhält sich wie WEEKDAY_HOURS, damit bestehende Verträge ihr bisheriges Verhalten unverändert beibehalten.

    • holiday_credit_modestring

      Feiertagsguthaben für WEEK_TOTAL-Verträge - null verhält sich wie WEEKDAY_TARGET (bisheriges Verhalten, nur bei WEEKDAY_HOURS-Verträgen sinnvoll).

    • holiday_credit_fixed_secondsinteger

      Fester Feiertagsguthaben in Sekunden.

    • planning_weekdays_bitmaskinteger

      ISO-Wochentagsbitmaske (Mo=1 ... So=64) der Tage, an denen dieser WEEK_TOTAL-Vertrag eingeplant werden bzw. Urlaub nehmen kann - null verhält sich wie Mo-Fr.

    • request_lead_time_daysinteger

      Tage, die ein Abwesenheitsantrag vor seinem ersten Tag eingereicht werden muss ("Bearbeitungs- frist"). null greift zunächst auf die Vertragsgruppe und von dort auf die Einstellung der Installation zurück, damit ein bestehender Vertrag genau wie bisher funktioniert.

    • shift_booking_syncboolean

      L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Gruppe (die wiederum die Organisation übernimmt).

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • descriptionstring

    Beschreibung des Antrags.

  • startstring (date-time)

    Beginn des angefragten Zeitraums.

  • start_datestring

    Startdatum des angefragten Zeitraums.

  • start_monthinteger

    Startmonat des angefragten Zeitraums.

  • start_yearinteger

    Startjahr des angefragten Zeitraums.

  • endstring (date-time)

    Ende des angeforderten Zeitraums.

  • end_datestring

    Enddatum des angeforderten Zeitraums.

  • end_monthinteger

    Endmonat des angeforderten Zeitraums.

  • end_yearinteger

    Endjahr des angeforderten Zeitraums.

  • durationnumber (float)

    Dauer in Tagen, verknüpft mit NonWorkTimePlan – ein Halbtagstyp zählt 0,5 (Z6)

  • statusstring

    Status der Anfrage.

  • content_typestring

    Art des Antrags, z. B. Urlaub oder Abwesenheit.

  • secondary_content_typestring

    Sekundärer Typ der Anfrage.

  • linked_content_typeNonWorkTimePlanSelectionType3

    Mit der Anfrage verknüpfter Planauswahltyp.

    Felder anzeigen (15)
    • effective_colorstring

      Die anzuzeigende Farbe: die konfigurierte, sonst die Standardfarbe des Typs.

    • namestring

      Name der Abwesenheitsart, zum Beispiel Urlaub oder Krankheit.

    • valueinteger

      Numerischer Wert der Abwesenheitsart.

    • priorityinteger

      Priorität des Abwesenheitstyps, wenn sich mehrere Typen überschneiden.

    • processed_content_typestring

      Inhaltstyp, der bei der Bearbeitung der Abwesenheit verwendet wird.

    • secondary_content_type_optionsstring

      Optionen für den sekundären Inhaltstyp, durch Komma getrennt

    • iconstring

      Symbol des Abwesenheitstyps.

    • is_vacationboolean

      Die Abwesenheitsart zählt als Urlaub.

    • is_sickboolean

      Die Abwesenheitsart zählt als Krankheit.

    • status_change_requires_hr_approvalboolean

      Die Änderung des Status dieses Abwesenheitstyps erfordert eine HR-Genehmigung.

    • selectable_for_requestboolean

      Ob mit diesem Typ eine neue Abwesenheitsanfrage angelegt werden darf. Typen, die nur einen Tag in einer Übersicht beschreiben – Feiertag, Schulferien, Arbeitstag –, werden in den Editoren nicht angeboten.

    • requires_management_approvalboolean

      Anträge dieses Typs benötigen eine abschließende schriftliche Entscheidung der Geschäftsführung (der Organisationsleitung), die nach der regulären Genehmigungskette (U10) angehängt wird.

    • max_days_per_requestinteger

      Obergrenze der Kalendertage, die eine Anfrage dieses Typs umfassen darf; null = unbegrenzt.

    • colorstring

      R5: Farbe dieses Abwesenheitstyps im Schichtplan und im Teamkalender ("#RRGGBB"); null = der Standardwert des Typs (getEffectiveColor). Wird mit absence_type_colors_enabled verwendet.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • attachmentsarray<Attachment10>

    Anhänge der Anfrage.

    Felder anzeigen (25)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • commentsarray<NonWorkTimeRequestComment4>

    Kommentare zum Antrag.

    Felder anzeigen (5)
    • idinteger

      Primärschlüssel des Kommentars zur Abwesenheitsanfrage. Interne ID.

    • userUser14

      Benutzer, der den Kommentar verfasst hat.

    • descriptionstring

      Text des Kommentars.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • plan_entriesarray<NonWorkTimePlan2>

    Für die Anfrage erzeugte Planeinträge.

    Felder anzeigen (1)
    • idinteger

      Primärschlüssel des Abwesenheitsplan-Eintrags. Interne ID.

  • parent_requestNonWorkTimeRequest3

    Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.

  • annual_requestNonWorkTimeAnnualRequest6

    L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.

    Felder anzeigen (9)
    • idinteger

      Primärschlüssel der Jahresanfrage. Interne ID.

    • userUser14

      Benutzer, zu dem der Jahresantrag gehört.

    • personCRMPerson10

      Person, zu der der Jahresantrag gehört.

    • yearinteger

      Das Urlaubsjahr, zu dem die Zeiträume gehören.

    • content_typeinteger

      Abwesenheitstyp jedes Zeitraums (Wert von NonWorkTimePlanSelectionType).

    • descriptionstring

      Beschreibung des Jahresantrags.

    • statusstring

      Abgeleitet aus den Zeiträumen, siehe Klassenkommentar.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • request_kindstring

    U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.

  • processing_due_datestring (date-time)

    U04/U20: der Tag, bis zu dem über den Antrag entschieden werden muss, gerechnet ab Eingang.

  • escalated_atstring (date-time)

    U04: Zeitpunkt, zu dem die Eskalation wegen Überfälligkeit gesendet wurde; null = noch nicht eskaliert.

  • written_approval_reasonstring

    U21: warum dieser Antrag um den Schritt der Geschäftsführung mit schriftlichem Kommentar ergänzt wurde (z. B. SUMMER_CANCELLATION); null = keine zusätzliche schriftliche Genehmigung nötig.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/time/non_work_time_request/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "description": "Text",
  "overdue": true,
  "approval_version": 1,
  "change_mode": "string",
  "balance_override_reason": "string",
  "coverage_override_reason": "string",
  "coverage_hint": true,
  "sick_during_vacation": true,
  "consultation_note": "string"
}

NonWorkTimeRequest einzeln aktualisieren

PUT/api/time/non_work_time_request/{id}

Pfad-Parameter

idPflichtstring

Query-Parameter

actionstringCANCEL_OWN zieht einen eigenen offenen Antrag ohne verbindliche Body-Felder zurückErlaubt: CANCEL_OWN
approval_versionintegerAngezeigte Antragsversion; erforderlich für CANCEL_OWN und gestufte Entscheidungen
approval_commentstringSchriftliche Entscheidung des aktuellen Genehmigungsschritts; Pflicht für den Schritt der Geschäftsleitung
balance_override_reasonstringL11: Begründung für die Genehmigung, obwohl der prognostizierte Urlaubssaldo zum Jahresende negativ ist; erforderlich, wenn non_work_time_negative_balance_override_required aktiv ist
coverage_override_reasonstringL54: Begründung für die Genehmigung, obwohl ein Tag unter die Mindestbesetzung fällt; erforderlich, wenn staffing_coverage_override_reason_required aktiv ist

Request-Body application/json

  • dataNonWorkTimeRequest2
    Felder anzeigen (17)
    • change_modestring

      Art der Änderung an der Anfrage.

    • daily_absence_start_timestring

      Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.

    • daily_absence_end_timestring

      Endzeit der ganztägigen Abwesenheit.

    • personCRMPerson37

      Person, zu der der Antrag gehört.

    • contractEmploymentContract8

      Arbeitsvertrag, zu dem der Antrag gehört.

    • descriptionstring

      Beschreibung des Antrags.

    • startstring (date-time)

      Beginn des angefragten Zeitraums.

    • endstring (date-time)

      Ende des angeforderten Zeitraums.

    • statusstring

      Status der Anfrage.

    • content_typestring

      Art des Antrags, z. B. Urlaub oder Abwesenheit.

    • secondary_content_typestring

      Sekundärer Typ der Anfrage.

    • attachmentsarray<Attachment12>

      Anhänge der Anfrage.

    • commentsarray<NonWorkTimeRequestComment3>

      Kommentare zum Antrag.

    • plan_entriesarray<NonWorkTimePlan>

      Für die Anfrage erzeugte Planeinträge.

    • parent_requestNonWorkTimeRequest2

      Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.

    • annual_requestNonWorkTimeAnnualRequest5

      L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.

    • request_kindstring

      U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.

Antworten

200NonWorkTimeRequest einzeln aktualisierenNonWorkTimeRequest3

Felder anzeigen (39)
  • overdueboolean

    U04: noch offen nach Ablauf der Bearbeitungsfrist.

  • approval_versioninteger

    Version des Genehmigungsprozesses.

  • change_modestring

    Art der Änderung an der Anfrage.

  • balance_override_reasonstring

    L11: warum ein Planer diesen Antrag genehmigt hat, obwohl der prognostizierte Urlaubssaldo negativ war.

  • coverage_override_reasonstring

    L54: warum der Genehmiger einen Tag unter der Mindestbesetzung akzeptiert hat.

  • coverage_hintboolean

    L53: eingereicht, obwohl er den Personalpuffer angreift - die Genehmiger sehen den Hinweis.

  • sick_during_vacationboolean

    U13: eine Krankmeldung innerhalb genehmigten Urlaubs - vom Server gesetzt, angezeigt als "während Urlaub".

  • consultation_notestring

    Wer vor der Anfrage von Tagen, die ein blockierender Zeitraum als nur mit Abstimmung markiert (U14), konsultiert wurde.

  • daily_absence_start_timestring

    Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.

  • daily_absence_end_timestring

    Endzeit der ganztägigen Abwesenheit.

  • idinteger

    Primärschlüssel der Anfrage. Interne ID.

  • userUser14

    Benutzer, zu dem die Anfrage gehört.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • contractEmploymentContract9

    Arbeitsvertrag, zu dem der Antrag gehört.

    Felder anzeigen (43)
    • staged_absence_approvalboolean

      null übernimmt zuerst die Gruppen- und dann die Organisationsrichtlinie; bestehende Installationen bleiben aus.

    • idinteger

      Primärschlüssel des Arbeitsvertrags. Interne ID.

    • tokenstring

      Öffentlicher Token des Vertrags. Anstelle der ID verwendet.

    • userUser14

      Benutzer des Mitarbeiters.

    • week_total_hoursnumber (float)

      Gesamte Arbeitsstunden pro Woche.

    • week_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche.

    • reserved_hours_preparationnumber (float)

      L03: wöchentliche Stunden, die für Vorbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_follow_upnumber (float)

      L03: wöchentliche Stunden, die für Nachbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_travelnumber (float)

      L03: wöchentliche Stunden, die für Fahrt reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_flexiblenumber (float)

      L03: wöchentliche Stunden, die für freie Einteilung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • week_full_time_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche bei einem Vollzeitvertrag.

    • year_vacation_daysnumber (float)

      Urlaubstage pro Jahr.

    • month_vacation_daysnumber (float)

      Urlaubstage pro Monat.

    • year_vacation_weeksnumber (float)

      Urlaubswochen pro Jahr.

    • monday_hoursnumber (float)

      Arbeitsstunden am Montag.

    • tuesday_hoursnumber (float)

      Arbeitsstunden am Dienstag.

    • wednesday_hoursnumber (float)

      Arbeitsstunden am Mittwoch.

    • thursday_hoursnumber (float)

      Arbeitsstunden am Donnerstag.

    • friday_hoursnumber (float)

      Arbeitsstunden am Freitag.

    • saturday_hoursnumber (float)

      Arbeitsstunden am Samstag.

    • sunday_hoursnumber (float)

      Arbeitsstunden am Sonntag.

    • netto_hour_costnumber (float)

      Nettokosten je Stunde.

    • brutto_hour_costnumber (float)

      Bruttokosten pro Stunde.

    • startstring (date-time)

      Startdatum des Vertrags.

    • endstring (date-time)

      Enddatum des Vertrags.

    • fixed_term_statusstring

      Befristung: PERMANENT (unbefristet, Standard), FIXED_TERM oder EXTENDED (FIXED_TERM_STATUS_*).

    • fixed_term_endstring (date-time)

      Befristet bis (erster Zeitraum).

    • fixed_term_extension_endstring (date-time)

      Befristet bis nach Verlängerung.

    • probation_endstring (date-time)

      Probezeit bis; wird aus den probationMonths der Vorlage gefüllt, wenn ein Vertrag ohne diese Angabe angelegt wird.

    • numberstring

      Vertragsnummer.

    • descriptionstring

      Beschreibung des Vertrags.

    • archivedboolean

      Der Vertrag ist archiviert.

    • allow_app_time_trackingboolean

      Der Mitarbeitende darf Zeiten in der App erfassen.

    • allow_scanner_time_trackingboolean

      Der Mitarbeitende darf Zeiten mit dem Scanner erfassen.

    • allow_app_non_work_time_managementboolean

      Der Mitarbeitende darf Abwesenheiten in der App verwalten.

    • force_no_auto_breakboolean

      Für diesen Vertrag werden keine automatischen Pausen hinzugefügt.

    • work_time_modestring

      Wie die Sollarbeitszeit definiert ist - null verhält sich wie WEEKDAY_HOURS, damit bestehende Verträge ihr bisheriges Verhalten unverändert beibehalten.

    • holiday_credit_modestring

      Feiertagsguthaben für WEEK_TOTAL-Verträge - null verhält sich wie WEEKDAY_TARGET (bisheriges Verhalten, nur bei WEEKDAY_HOURS-Verträgen sinnvoll).

    • holiday_credit_fixed_secondsinteger

      Fester Feiertagsguthaben in Sekunden.

    • planning_weekdays_bitmaskinteger

      ISO-Wochentagsbitmaske (Mo=1 ... So=64) der Tage, an denen dieser WEEK_TOTAL-Vertrag eingeplant werden bzw. Urlaub nehmen kann - null verhält sich wie Mo-Fr.

    • request_lead_time_daysinteger

      Tage, die ein Abwesenheitsantrag vor seinem ersten Tag eingereicht werden muss ("Bearbeitungs- frist"). null greift zunächst auf die Vertragsgruppe und von dort auf die Einstellung der Installation zurück, damit ein bestehender Vertrag genau wie bisher funktioniert.

    • shift_booking_syncboolean

      L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Gruppe (die wiederum die Organisation übernimmt).

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • descriptionstring

    Beschreibung des Antrags.

  • startstring (date-time)

    Beginn des angefragten Zeitraums.

  • start_datestring

    Startdatum des angefragten Zeitraums.

  • start_monthinteger

    Startmonat des angefragten Zeitraums.

  • start_yearinteger

    Startjahr des angefragten Zeitraums.

  • endstring (date-time)

    Ende des angeforderten Zeitraums.

  • end_datestring

    Enddatum des angeforderten Zeitraums.

  • end_monthinteger

    Endmonat des angeforderten Zeitraums.

  • end_yearinteger

    Endjahr des angeforderten Zeitraums.

  • durationnumber (float)

    Dauer in Tagen, verknüpft mit NonWorkTimePlan – ein Halbtagstyp zählt 0,5 (Z6)

  • statusstring

    Status der Anfrage.

  • content_typestring

    Art des Antrags, z. B. Urlaub oder Abwesenheit.

  • secondary_content_typestring

    Sekundärer Typ der Anfrage.

  • linked_content_typeNonWorkTimePlanSelectionType3

    Mit der Anfrage verknüpfter Planauswahltyp.

    Felder anzeigen (15)
    • effective_colorstring

      Die anzuzeigende Farbe: die konfigurierte, sonst die Standardfarbe des Typs.

    • namestring

      Name der Abwesenheitsart, zum Beispiel Urlaub oder Krankheit.

    • valueinteger

      Numerischer Wert der Abwesenheitsart.

    • priorityinteger

      Priorität des Abwesenheitstyps, wenn sich mehrere Typen überschneiden.

    • processed_content_typestring

      Inhaltstyp, der bei der Bearbeitung der Abwesenheit verwendet wird.

    • secondary_content_type_optionsstring

      Optionen für den sekundären Inhaltstyp, durch Komma getrennt

    • iconstring

      Symbol des Abwesenheitstyps.

    • is_vacationboolean

      Die Abwesenheitsart zählt als Urlaub.

    • is_sickboolean

      Die Abwesenheitsart zählt als Krankheit.

    • status_change_requires_hr_approvalboolean

      Die Änderung des Status dieses Abwesenheitstyps erfordert eine HR-Genehmigung.

    • selectable_for_requestboolean

      Ob mit diesem Typ eine neue Abwesenheitsanfrage angelegt werden darf. Typen, die nur einen Tag in einer Übersicht beschreiben – Feiertag, Schulferien, Arbeitstag –, werden in den Editoren nicht angeboten.

    • requires_management_approvalboolean

      Anträge dieses Typs benötigen eine abschließende schriftliche Entscheidung der Geschäftsführung (der Organisationsleitung), die nach der regulären Genehmigungskette (U10) angehängt wird.

    • max_days_per_requestinteger

      Obergrenze der Kalendertage, die eine Anfrage dieses Typs umfassen darf; null = unbegrenzt.

    • colorstring

      R5: Farbe dieses Abwesenheitstyps im Schichtplan und im Teamkalender ("#RRGGBB"); null = der Standardwert des Typs (getEffectiveColor). Wird mit absence_type_colors_enabled verwendet.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • attachmentsarray<Attachment10>

    Anhänge der Anfrage.

    Felder anzeigen (25)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • commentsarray<NonWorkTimeRequestComment4>

    Kommentare zum Antrag.

    Felder anzeigen (5)
    • idinteger

      Primärschlüssel des Kommentars zur Abwesenheitsanfrage. Interne ID.

    • userUser14

      Benutzer, der den Kommentar verfasst hat.

    • descriptionstring

      Text des Kommentars.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • plan_entriesarray<NonWorkTimePlan2>

    Für die Anfrage erzeugte Planeinträge.

    Felder anzeigen (1)
    • idinteger

      Primärschlüssel des Abwesenheitsplan-Eintrags. Interne ID.

  • parent_requestNonWorkTimeRequest3

    Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.

  • annual_requestNonWorkTimeAnnualRequest6

    L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.

    Felder anzeigen (9)
    • idinteger

      Primärschlüssel der Jahresanfrage. Interne ID.

    • userUser14

      Benutzer, zu dem der Jahresantrag gehört.

    • personCRMPerson10

      Person, zu der der Jahresantrag gehört.

    • yearinteger

      Das Urlaubsjahr, zu dem die Zeiträume gehören.

    • content_typeinteger

      Abwesenheitstyp jedes Zeitraums (Wert von NonWorkTimePlanSelectionType).

    • descriptionstring

      Beschreibung des Jahresantrags.

    • statusstring

      Abgeleitet aus den Zeiträumen, siehe Klassenkommentar.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • request_kindstring

    U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.

  • processing_due_datestring (date-time)

    U04/U20: der Tag, bis zu dem über den Antrag entschieden werden muss, gerechnet ab Eingang.

  • escalated_atstring (date-time)

    U04: Zeitpunkt, zu dem die Eskalation wegen Überfälligkeit gesendet wurde; null = noch nicht eskaliert.

  • written_approval_reasonstring

    U21: warum dieser Antrag um den Schritt der Geschäftsführung mit schriftlichem Kommentar ergänzt wurde (z. B. SUMMER_CANCELLATION); null = keine zusätzliche schriftliche Genehmigung nötig.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/time/non_work_time_request/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "description": "Text",
    "change_mode": "string",
    "daily_absence_start_time": "string",
    "daily_absence_end_time": "string",
    "start": "2026-10-15T09:30:00+02:00",
    "end": "2026-10-15T09:30:00+02:00"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "description": "Text",
  "overdue": true,
  "approval_version": 1,
  "change_mode": "string",
  "balance_override_reason": "string",
  "coverage_override_reason": "string",
  "coverage_hint": true,
  "sick_during_vacation": true,
  "consultation_note": "string"
}

NonWorkTimeRequest einzeln aktualisieren

PATCH/api/time/non_work_time_request/{id}

Pfad-Parameter

idPflichtstring

Query-Parameter

actionstringCANCEL_OWN zieht einen eigenen offenen Antrag ohne verbindliche Body-Felder zurückErlaubt: CANCEL_OWN
approval_versionintegerAngezeigte Antragsversion; erforderlich für CANCEL_OWN und gestufte Entscheidungen
approval_commentstringSchriftliche Entscheidung des aktuellen Genehmigungsschritts; Pflicht für den Schritt der Geschäftsleitung
balance_override_reasonstringL11: Begründung für die Genehmigung, obwohl der prognostizierte Urlaubssaldo zum Jahresende negativ ist; erforderlich, wenn non_work_time_negative_balance_override_required aktiv ist
coverage_override_reasonstringL54: Begründung für die Genehmigung, obwohl ein Tag unter die Mindestbesetzung fällt; erforderlich, wenn staffing_coverage_override_reason_required aktiv ist

Request-Body application/json

  • dataNonWorkTimeRequest2
    Felder anzeigen (17)
    • change_modestring

      Art der Änderung an der Anfrage.

    • daily_absence_start_timestring

      Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.

    • daily_absence_end_timestring

      Endzeit der ganztägigen Abwesenheit.

    • personCRMPerson37

      Person, zu der der Antrag gehört.

    • contractEmploymentContract8

      Arbeitsvertrag, zu dem der Antrag gehört.

    • descriptionstring

      Beschreibung des Antrags.

    • startstring (date-time)

      Beginn des angefragten Zeitraums.

    • endstring (date-time)

      Ende des angeforderten Zeitraums.

    • statusstring

      Status der Anfrage.

    • content_typestring

      Art des Antrags, z. B. Urlaub oder Abwesenheit.

    • secondary_content_typestring

      Sekundärer Typ der Anfrage.

    • attachmentsarray<Attachment12>

      Anhänge der Anfrage.

    • commentsarray<NonWorkTimeRequestComment3>

      Kommentare zum Antrag.

    • plan_entriesarray<NonWorkTimePlan>

      Für die Anfrage erzeugte Planeinträge.

    • parent_requestNonWorkTimeRequest2

      Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.

    • annual_requestNonWorkTimeAnnualRequest5

      L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.

    • request_kindstring

      U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.

Antworten

200NonWorkTimeRequest einzeln aktualisierenNonWorkTimeRequest3

Felder anzeigen (39)
  • overdueboolean

    U04: noch offen nach Ablauf der Bearbeitungsfrist.

  • approval_versioninteger

    Version des Genehmigungsprozesses.

  • change_modestring

    Art der Änderung an der Anfrage.

  • balance_override_reasonstring

    L11: warum ein Planer diesen Antrag genehmigt hat, obwohl der prognostizierte Urlaubssaldo negativ war.

  • coverage_override_reasonstring

    L54: warum der Genehmiger einen Tag unter der Mindestbesetzung akzeptiert hat.

  • coverage_hintboolean

    L53: eingereicht, obwohl er den Personalpuffer angreift - die Genehmiger sehen den Hinweis.

  • sick_during_vacationboolean

    U13: eine Krankmeldung innerhalb genehmigten Urlaubs - vom Server gesetzt, angezeigt als "während Urlaub".

  • consultation_notestring

    Wer vor der Anfrage von Tagen, die ein blockierender Zeitraum als nur mit Abstimmung markiert (U14), konsultiert wurde.

  • daily_absence_start_timestring

    Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.

  • daily_absence_end_timestring

    Endzeit der ganztägigen Abwesenheit.

  • idinteger

    Primärschlüssel der Anfrage. Interne ID.

  • userUser14

    Benutzer, zu dem die Anfrage gehört.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • contractEmploymentContract9

    Arbeitsvertrag, zu dem der Antrag gehört.

    Felder anzeigen (43)
    • staged_absence_approvalboolean

      null übernimmt zuerst die Gruppen- und dann die Organisationsrichtlinie; bestehende Installationen bleiben aus.

    • idinteger

      Primärschlüssel des Arbeitsvertrags. Interne ID.

    • tokenstring

      Öffentlicher Token des Vertrags. Anstelle der ID verwendet.

    • userUser14

      Benutzer des Mitarbeiters.

    • week_total_hoursnumber (float)

      Gesamte Arbeitsstunden pro Woche.

    • week_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche.

    • reserved_hours_preparationnumber (float)

      L03: wöchentliche Stunden, die für Vorbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_follow_upnumber (float)

      L03: wöchentliche Stunden, die für Nachbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_travelnumber (float)

      L03: wöchentliche Stunden, die für Fahrt reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_flexiblenumber (float)

      L03: wöchentliche Stunden, die für freie Einteilung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • week_full_time_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche bei einem Vollzeitvertrag.

    • year_vacation_daysnumber (float)

      Urlaubstage pro Jahr.

    • month_vacation_daysnumber (float)

      Urlaubstage pro Monat.

    • year_vacation_weeksnumber (float)

      Urlaubswochen pro Jahr.

    • monday_hoursnumber (float)

      Arbeitsstunden am Montag.

    • tuesday_hoursnumber (float)

      Arbeitsstunden am Dienstag.

    • wednesday_hoursnumber (float)

      Arbeitsstunden am Mittwoch.

    • thursday_hoursnumber (float)

      Arbeitsstunden am Donnerstag.

    • friday_hoursnumber (float)

      Arbeitsstunden am Freitag.

    • saturday_hoursnumber (float)

      Arbeitsstunden am Samstag.

    • sunday_hoursnumber (float)

      Arbeitsstunden am Sonntag.

    • netto_hour_costnumber (float)

      Nettokosten je Stunde.

    • brutto_hour_costnumber (float)

      Bruttokosten pro Stunde.

    • startstring (date-time)

      Startdatum des Vertrags.

    • endstring (date-time)

      Enddatum des Vertrags.

    • fixed_term_statusstring

      Befristung: PERMANENT (unbefristet, Standard), FIXED_TERM oder EXTENDED (FIXED_TERM_STATUS_*).

    • fixed_term_endstring (date-time)

      Befristet bis (erster Zeitraum).

    • fixed_term_extension_endstring (date-time)

      Befristet bis nach Verlängerung.

    • probation_endstring (date-time)

      Probezeit bis; wird aus den probationMonths der Vorlage gefüllt, wenn ein Vertrag ohne diese Angabe angelegt wird.

    • numberstring

      Vertragsnummer.

    • descriptionstring

      Beschreibung des Vertrags.

    • archivedboolean

      Der Vertrag ist archiviert.

    • allow_app_time_trackingboolean

      Der Mitarbeitende darf Zeiten in der App erfassen.

    • allow_scanner_time_trackingboolean

      Der Mitarbeitende darf Zeiten mit dem Scanner erfassen.

    • allow_app_non_work_time_managementboolean

      Der Mitarbeitende darf Abwesenheiten in der App verwalten.

    • force_no_auto_breakboolean

      Für diesen Vertrag werden keine automatischen Pausen hinzugefügt.

    • work_time_modestring

      Wie die Sollarbeitszeit definiert ist - null verhält sich wie WEEKDAY_HOURS, damit bestehende Verträge ihr bisheriges Verhalten unverändert beibehalten.

    • holiday_credit_modestring

      Feiertagsguthaben für WEEK_TOTAL-Verträge - null verhält sich wie WEEKDAY_TARGET (bisheriges Verhalten, nur bei WEEKDAY_HOURS-Verträgen sinnvoll).

    • holiday_credit_fixed_secondsinteger

      Fester Feiertagsguthaben in Sekunden.

    • planning_weekdays_bitmaskinteger

      ISO-Wochentagsbitmaske (Mo=1 ... So=64) der Tage, an denen dieser WEEK_TOTAL-Vertrag eingeplant werden bzw. Urlaub nehmen kann - null verhält sich wie Mo-Fr.

    • request_lead_time_daysinteger

      Tage, die ein Abwesenheitsantrag vor seinem ersten Tag eingereicht werden muss ("Bearbeitungs- frist"). null greift zunächst auf die Vertragsgruppe und von dort auf die Einstellung der Installation zurück, damit ein bestehender Vertrag genau wie bisher funktioniert.

    • shift_booking_syncboolean

      L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Gruppe (die wiederum die Organisation übernimmt).

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • descriptionstring

    Beschreibung des Antrags.

  • startstring (date-time)

    Beginn des angefragten Zeitraums.

  • start_datestring

    Startdatum des angefragten Zeitraums.

  • start_monthinteger

    Startmonat des angefragten Zeitraums.

  • start_yearinteger

    Startjahr des angefragten Zeitraums.

  • endstring (date-time)

    Ende des angeforderten Zeitraums.

  • end_datestring

    Enddatum des angeforderten Zeitraums.

  • end_monthinteger

    Endmonat des angeforderten Zeitraums.

  • end_yearinteger

    Endjahr des angeforderten Zeitraums.

  • durationnumber (float)

    Dauer in Tagen, verknüpft mit NonWorkTimePlan – ein Halbtagstyp zählt 0,5 (Z6)

  • statusstring

    Status der Anfrage.

  • content_typestring

    Art des Antrags, z. B. Urlaub oder Abwesenheit.

  • secondary_content_typestring

    Sekundärer Typ der Anfrage.

  • linked_content_typeNonWorkTimePlanSelectionType3

    Mit der Anfrage verknüpfter Planauswahltyp.

    Felder anzeigen (15)
    • effective_colorstring

      Die anzuzeigende Farbe: die konfigurierte, sonst die Standardfarbe des Typs.

    • namestring

      Name der Abwesenheitsart, zum Beispiel Urlaub oder Krankheit.

    • valueinteger

      Numerischer Wert der Abwesenheitsart.

    • priorityinteger

      Priorität des Abwesenheitstyps, wenn sich mehrere Typen überschneiden.

    • processed_content_typestring

      Inhaltstyp, der bei der Bearbeitung der Abwesenheit verwendet wird.

    • secondary_content_type_optionsstring

      Optionen für den sekundären Inhaltstyp, durch Komma getrennt

    • iconstring

      Symbol des Abwesenheitstyps.

    • is_vacationboolean

      Die Abwesenheitsart zählt als Urlaub.

    • is_sickboolean

      Die Abwesenheitsart zählt als Krankheit.

    • status_change_requires_hr_approvalboolean

      Die Änderung des Status dieses Abwesenheitstyps erfordert eine HR-Genehmigung.

    • selectable_for_requestboolean

      Ob mit diesem Typ eine neue Abwesenheitsanfrage angelegt werden darf. Typen, die nur einen Tag in einer Übersicht beschreiben – Feiertag, Schulferien, Arbeitstag –, werden in den Editoren nicht angeboten.

    • requires_management_approvalboolean

      Anträge dieses Typs benötigen eine abschließende schriftliche Entscheidung der Geschäftsführung (der Organisationsleitung), die nach der regulären Genehmigungskette (U10) angehängt wird.

    • max_days_per_requestinteger

      Obergrenze der Kalendertage, die eine Anfrage dieses Typs umfassen darf; null = unbegrenzt.

    • colorstring

      R5: Farbe dieses Abwesenheitstyps im Schichtplan und im Teamkalender ("#RRGGBB"); null = der Standardwert des Typs (getEffectiveColor). Wird mit absence_type_colors_enabled verwendet.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • attachmentsarray<Attachment10>

    Anhänge der Anfrage.

    Felder anzeigen (25)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • commentsarray<NonWorkTimeRequestComment4>

    Kommentare zum Antrag.

    Felder anzeigen (5)
    • idinteger

      Primärschlüssel des Kommentars zur Abwesenheitsanfrage. Interne ID.

    • userUser14

      Benutzer, der den Kommentar verfasst hat.

    • descriptionstring

      Text des Kommentars.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • plan_entriesarray<NonWorkTimePlan2>

    Für die Anfrage erzeugte Planeinträge.

    Felder anzeigen (1)
    • idinteger

      Primärschlüssel des Abwesenheitsplan-Eintrags. Interne ID.

  • parent_requestNonWorkTimeRequest3

    Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.

  • annual_requestNonWorkTimeAnnualRequest6

    L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.

    Felder anzeigen (9)
    • idinteger

      Primärschlüssel der Jahresanfrage. Interne ID.

    • userUser14

      Benutzer, zu dem der Jahresantrag gehört.

    • personCRMPerson10

      Person, zu der der Jahresantrag gehört.

    • yearinteger

      Das Urlaubsjahr, zu dem die Zeiträume gehören.

    • content_typeinteger

      Abwesenheitstyp jedes Zeitraums (Wert von NonWorkTimePlanSelectionType).

    • descriptionstring

      Beschreibung des Jahresantrags.

    • statusstring

      Abgeleitet aus den Zeiträumen, siehe Klassenkommentar.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • request_kindstring

    U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.

  • processing_due_datestring (date-time)

    U04/U20: der Tag, bis zu dem über den Antrag entschieden werden muss, gerechnet ab Eingang.

  • escalated_atstring (date-time)

    U04: Zeitpunkt, zu dem die Eskalation wegen Überfälligkeit gesendet wurde; null = noch nicht eskaliert.

  • written_approval_reasonstring

    U21: warum dieser Antrag um den Schritt der Geschäftsführung mit schriftlichem Kommentar ergänzt wurde (z. B. SUMMER_CANCELLATION); null = keine zusätzliche schriftliche Genehmigung nötig.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/time/non_work_time_request/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "description": "Text",
    "change_mode": "string",
    "daily_absence_start_time": "string",
    "daily_absence_end_time": "string",
    "start": "2026-10-15T09:30:00+02:00",
    "end": "2026-10-15T09:30:00+02:00"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "description": "Text",
  "overdue": true,
  "approval_version": 1,
  "change_mode": "string",
  "balance_override_reason": "string",
  "coverage_override_reason": "string",
  "coverage_hint": true,
  "sick_during_vacation": true,
  "consultation_note": "string"
}

Eine einzelne NonWorkTimeRequest testen

POST/api/time/non_work_time_request_test

Request-Body application/json

  • dataNonWorkTimeRequest2
    Felder anzeigen (17)
    • change_modestring

      Art der Änderung an der Anfrage.

    • daily_absence_start_timestring

      Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.

    • daily_absence_end_timestring

      Endzeit der ganztägigen Abwesenheit.

    • personCRMPerson37

      Person, zu der der Antrag gehört.

    • contractEmploymentContract8

      Arbeitsvertrag, zu dem der Antrag gehört.

    • descriptionstring

      Beschreibung des Antrags.

    • startstring (date-time)

      Beginn des angefragten Zeitraums.

    • endstring (date-time)

      Ende des angeforderten Zeitraums.

    • statusstring

      Status der Anfrage.

    • content_typestring

      Art des Antrags, z. B. Urlaub oder Abwesenheit.

    • secondary_content_typestring

      Sekundärer Typ der Anfrage.

    • attachmentsarray<Attachment12>

      Anhänge der Anfrage.

    • commentsarray<NonWorkTimeRequestComment3>

      Kommentare zum Antrag.

    • plan_entriesarray<NonWorkTimePlan>

      Für die Anfrage erzeugte Planeinträge.

    • parent_requestNonWorkTimeRequest2

      Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.

    • annual_requestNonWorkTimeAnnualRequest5

      L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.

    • request_kindstring

      U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.

Antworten

200Eine einzelne NonWorkTimeRequest testenNonWorkTimeRequest3

Felder anzeigen (39)
  • overdueboolean

    U04: noch offen nach Ablauf der Bearbeitungsfrist.

  • approval_versioninteger

    Version des Genehmigungsprozesses.

  • change_modestring

    Art der Änderung an der Anfrage.

  • balance_override_reasonstring

    L11: warum ein Planer diesen Antrag genehmigt hat, obwohl der prognostizierte Urlaubssaldo negativ war.

  • coverage_override_reasonstring

    L54: warum der Genehmiger einen Tag unter der Mindestbesetzung akzeptiert hat.

  • coverage_hintboolean

    L53: eingereicht, obwohl er den Personalpuffer angreift - die Genehmiger sehen den Hinweis.

  • sick_during_vacationboolean

    U13: eine Krankmeldung innerhalb genehmigten Urlaubs - vom Server gesetzt, angezeigt als "während Urlaub".

  • consultation_notestring

    Wer vor der Anfrage von Tagen, die ein blockierender Zeitraum als nur mit Abstimmung markiert (U14), konsultiert wurde.

  • daily_absence_start_timestring

    Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.

  • daily_absence_end_timestring

    Endzeit der ganztägigen Abwesenheit.

  • idinteger

    Primärschlüssel der Anfrage. Interne ID.

  • userUser14

    Benutzer, zu dem die Anfrage gehört.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • contractEmploymentContract9

    Arbeitsvertrag, zu dem der Antrag gehört.

    Felder anzeigen (43)
    • staged_absence_approvalboolean

      null übernimmt zuerst die Gruppen- und dann die Organisationsrichtlinie; bestehende Installationen bleiben aus.

    • idinteger

      Primärschlüssel des Arbeitsvertrags. Interne ID.

    • tokenstring

      Öffentlicher Token des Vertrags. Anstelle der ID verwendet.

    • userUser14

      Benutzer des Mitarbeiters.

    • week_total_hoursnumber (float)

      Gesamte Arbeitsstunden pro Woche.

    • week_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche.

    • reserved_hours_preparationnumber (float)

      L03: wöchentliche Stunden, die für Vorbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_follow_upnumber (float)

      L03: wöchentliche Stunden, die für Nachbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_travelnumber (float)

      L03: wöchentliche Stunden, die für Fahrt reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_flexiblenumber (float)

      L03: wöchentliche Stunden, die für freie Einteilung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • week_full_time_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche bei einem Vollzeitvertrag.

    • year_vacation_daysnumber (float)

      Urlaubstage pro Jahr.

    • month_vacation_daysnumber (float)

      Urlaubstage pro Monat.

    • year_vacation_weeksnumber (float)

      Urlaubswochen pro Jahr.

    • monday_hoursnumber (float)

      Arbeitsstunden am Montag.

    • tuesday_hoursnumber (float)

      Arbeitsstunden am Dienstag.

    • wednesday_hoursnumber (float)

      Arbeitsstunden am Mittwoch.

    • thursday_hoursnumber (float)

      Arbeitsstunden am Donnerstag.

    • friday_hoursnumber (float)

      Arbeitsstunden am Freitag.

    • saturday_hoursnumber (float)

      Arbeitsstunden am Samstag.

    • sunday_hoursnumber (float)

      Arbeitsstunden am Sonntag.

    • netto_hour_costnumber (float)

      Nettokosten je Stunde.

    • brutto_hour_costnumber (float)

      Bruttokosten pro Stunde.

    • startstring (date-time)

      Startdatum des Vertrags.

    • endstring (date-time)

      Enddatum des Vertrags.

    • fixed_term_statusstring

      Befristung: PERMANENT (unbefristet, Standard), FIXED_TERM oder EXTENDED (FIXED_TERM_STATUS_*).

    • fixed_term_endstring (date-time)

      Befristet bis (erster Zeitraum).

    • fixed_term_extension_endstring (date-time)

      Befristet bis nach Verlängerung.

    • probation_endstring (date-time)

      Probezeit bis; wird aus den probationMonths der Vorlage gefüllt, wenn ein Vertrag ohne diese Angabe angelegt wird.

    • numberstring

      Vertragsnummer.

    • descriptionstring

      Beschreibung des Vertrags.

    • archivedboolean

      Der Vertrag ist archiviert.

    • allow_app_time_trackingboolean

      Der Mitarbeitende darf Zeiten in der App erfassen.

    • allow_scanner_time_trackingboolean

      Der Mitarbeitende darf Zeiten mit dem Scanner erfassen.

    • allow_app_non_work_time_managementboolean

      Der Mitarbeitende darf Abwesenheiten in der App verwalten.

    • force_no_auto_breakboolean

      Für diesen Vertrag werden keine automatischen Pausen hinzugefügt.

    • work_time_modestring

      Wie die Sollarbeitszeit definiert ist - null verhält sich wie WEEKDAY_HOURS, damit bestehende Verträge ihr bisheriges Verhalten unverändert beibehalten.

    • holiday_credit_modestring

      Feiertagsguthaben für WEEK_TOTAL-Verträge - null verhält sich wie WEEKDAY_TARGET (bisheriges Verhalten, nur bei WEEKDAY_HOURS-Verträgen sinnvoll).

    • holiday_credit_fixed_secondsinteger

      Fester Feiertagsguthaben in Sekunden.

    • planning_weekdays_bitmaskinteger

      ISO-Wochentagsbitmaske (Mo=1 ... So=64) der Tage, an denen dieser WEEK_TOTAL-Vertrag eingeplant werden bzw. Urlaub nehmen kann - null verhält sich wie Mo-Fr.

    • request_lead_time_daysinteger

      Tage, die ein Abwesenheitsantrag vor seinem ersten Tag eingereicht werden muss ("Bearbeitungs- frist"). null greift zunächst auf die Vertragsgruppe und von dort auf die Einstellung der Installation zurück, damit ein bestehender Vertrag genau wie bisher funktioniert.

    • shift_booking_syncboolean

      L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Gruppe (die wiederum die Organisation übernimmt).

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • descriptionstring

    Beschreibung des Antrags.

  • startstring (date-time)

    Beginn des angefragten Zeitraums.

  • start_datestring

    Startdatum des angefragten Zeitraums.

  • start_monthinteger

    Startmonat des angefragten Zeitraums.

  • start_yearinteger

    Startjahr des angefragten Zeitraums.

  • endstring (date-time)

    Ende des angeforderten Zeitraums.

  • end_datestring

    Enddatum des angeforderten Zeitraums.

  • end_monthinteger

    Endmonat des angeforderten Zeitraums.

  • end_yearinteger

    Endjahr des angeforderten Zeitraums.

  • durationnumber (float)

    Dauer in Tagen, verknüpft mit NonWorkTimePlan – ein Halbtagstyp zählt 0,5 (Z6)

  • statusstring

    Status der Anfrage.

  • content_typestring

    Art des Antrags, z. B. Urlaub oder Abwesenheit.

  • secondary_content_typestring

    Sekundärer Typ der Anfrage.

  • linked_content_typeNonWorkTimePlanSelectionType3

    Mit der Anfrage verknüpfter Planauswahltyp.

    Felder anzeigen (15)
    • effective_colorstring

      Die anzuzeigende Farbe: die konfigurierte, sonst die Standardfarbe des Typs.

    • namestring

      Name der Abwesenheitsart, zum Beispiel Urlaub oder Krankheit.

    • valueinteger

      Numerischer Wert der Abwesenheitsart.

    • priorityinteger

      Priorität des Abwesenheitstyps, wenn sich mehrere Typen überschneiden.

    • processed_content_typestring

      Inhaltstyp, der bei der Bearbeitung der Abwesenheit verwendet wird.

    • secondary_content_type_optionsstring

      Optionen für den sekundären Inhaltstyp, durch Komma getrennt

    • iconstring

      Symbol des Abwesenheitstyps.

    • is_vacationboolean

      Die Abwesenheitsart zählt als Urlaub.

    • is_sickboolean

      Die Abwesenheitsart zählt als Krankheit.

    • status_change_requires_hr_approvalboolean

      Die Änderung des Status dieses Abwesenheitstyps erfordert eine HR-Genehmigung.

    • selectable_for_requestboolean

      Ob mit diesem Typ eine neue Abwesenheitsanfrage angelegt werden darf. Typen, die nur einen Tag in einer Übersicht beschreiben – Feiertag, Schulferien, Arbeitstag –, werden in den Editoren nicht angeboten.

    • requires_management_approvalboolean

      Anträge dieses Typs benötigen eine abschließende schriftliche Entscheidung der Geschäftsführung (der Organisationsleitung), die nach der regulären Genehmigungskette (U10) angehängt wird.

    • max_days_per_requestinteger

      Obergrenze der Kalendertage, die eine Anfrage dieses Typs umfassen darf; null = unbegrenzt.

    • colorstring

      R5: Farbe dieses Abwesenheitstyps im Schichtplan und im Teamkalender ("#RRGGBB"); null = der Standardwert des Typs (getEffectiveColor). Wird mit absence_type_colors_enabled verwendet.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • attachmentsarray<Attachment10>

    Anhänge der Anfrage.

    Felder anzeigen (25)
    • idinteger

      Primärschlüssel des Anhangs. Interne ID.

    • filenamestring

      Ursprünglicher Dateiname.

    • filesizestring

      Größe der Datei in Bytes.

    • mimetypestring

      MIME-Typ der Datei.

    • createdbyusernamestring

      Name des Benutzers, der die Datei hochgeladen hat, als Text.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Anhang angelegt wurde.

    • googleidstring

      ID der Datei in Google Drive.

    • scopestring

      Scope, der steuert, wer den Anhang sehen kann.

    • ocr_document_typestring

      Dokumenttyp, der per OCR erkannt wurde.

    • ocr_from_namestring

      Per OCR erkannter Absendername.

    • ocr_from_companystring

      Per OCR erkanntes Absenderunternehmen.

    • ocr_from_addressstring

      Per OCR erkannte Absenderadresse.

    • ocr_from_emailstring

      Per OCR erkannte Absender-E-Mail-Adresse.

    • ocr_from_phonestring

      Per OCR erkannte Absender-Telefonnummer.

    • ocr_to_namestring

      Per OCR erkannter Name des Empfängers.

    • ocr_to_companystring

      Per OCR erkanntes Empfängerunternehmen.

    • ocr_to_addressstring

      Per OCR erkannte Empfängeradresse.

    • ocr_to_emailstring

      Per OCR erkannte E-Mail-Adresse des Empfängers.

    • ocr_to_phonestring

      Per OCR erkannte Telefonnummer des Empfängers.

    • ocr_summarystring

      Zusammenfassung des per OCR erstellten Dokuments.

    • ocr_statusstring

      OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error

    • ocr_errorstring

      Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war

    • ocr_processed_atstring (date-time)

      Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.

    • virus_checkedboolean

      1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.

    • virus_checked_atstring (date-time)

      Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.

  • commentsarray<NonWorkTimeRequestComment4>

    Kommentare zum Antrag.

    Felder anzeigen (5)
    • idinteger

      Primärschlüssel des Kommentars zur Abwesenheitsanfrage. Interne ID.

    • userUser14

      Benutzer, der den Kommentar verfasst hat.

    • descriptionstring

      Text des Kommentars.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • plan_entriesarray<NonWorkTimePlan2>

    Für die Anfrage erzeugte Planeinträge.

    Felder anzeigen (1)
    • idinteger

      Primärschlüssel des Abwesenheitsplan-Eintrags. Interne ID.

  • parent_requestNonWorkTimeRequest3

    Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.

  • annual_requestNonWorkTimeAnnualRequest6

    L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.

    Felder anzeigen (9)
    • idinteger

      Primärschlüssel der Jahresanfrage. Interne ID.

    • userUser14

      Benutzer, zu dem der Jahresantrag gehört.

    • personCRMPerson10

      Person, zu der der Jahresantrag gehört.

    • yearinteger

      Das Urlaubsjahr, zu dem die Zeiträume gehören.

    • content_typeinteger

      Abwesenheitstyp jedes Zeitraums (Wert von NonWorkTimePlanSelectionType).

    • descriptionstring

      Beschreibung des Jahresantrags.

    • statusstring

      Abgeleitet aus den Zeiträumen, siehe Klassenkommentar.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • request_kindstring

    U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.

  • processing_due_datestring (date-time)

    U04/U20: der Tag, bis zu dem über den Antrag entschieden werden muss, gerechnet ab Eingang.

  • escalated_atstring (date-time)

    U04: Zeitpunkt, zu dem die Eskalation wegen Überfälligkeit gesendet wurde; null = noch nicht eskaliert.

  • written_approval_reasonstring

    U21: warum dieser Antrag um den Schritt der Geschäftsführung mit schriftlichem Kommentar ergänzt wurde (z. B. SUMMER_CANCELLATION); null = keine zusätzliche schriftliche Genehmigung nötig.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/time/non_work_time_request_test \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "description": "Text",
    "change_mode": "string",
    "daily_absence_start_time": "string",
    "daily_absence_end_time": "string",
    "start": "2026-10-15T09:30:00+02:00",
    "end": "2026-10-15T09:30:00+02:00"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "description": "Text",
  "overdue": true,
  "approval_version": 1,
  "change_mode": "string",
  "balance_override_reason": "string",
  "coverage_override_reason": "string",
  "coverage_hint": true,
  "sick_during_vacation": true,
  "consultation_note": "string"
}

Jahresantrag ("Jahresurlaubsantrag") mit mehreren getrennten Zeiträumen anlegen (L47/L48)

POST/api/time/non_work_time_annual_request

Jede Periode wird zu einem gewöhnlichen Antrag des Pakets und läuft über dieselben Regeln wie ein einzelner Antrag; scheitert eine Periode, wird das gesamte Paket abgelehnt.

Request-Body application/json

  • dataNonWorkTimeAnnualRequest2
    Felder anzeigen (5)
    • personCRMPerson38

      Person, zu der der Jahresantrag gehört.

    • contractEmploymentContract10

      Arbeitsvertrag, zu dem der Jahresantrag gehört.

    • yearinteger

      Das Urlaubsjahr, zu dem die Zeiträume gehören.

    • content_typeinteger

      Abwesenheitstyp jedes Zeitraums (Wert von NonWorkTimePlanSelectionType).

    • descriptionstring

      Beschreibung des Jahresantrags.

Antworten

200Jahresantrag mit mehreren Zeiträumen anlegenNonWorkTimeAnnualRequest3

Felder anzeigen (12)
  • idinteger

    Primärschlüssel der Jahresanfrage. Interne ID.

  • userUser14

    Benutzer, zu dem der Jahresantrag gehört.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • personCRMPerson10

    Person, zu der der Jahresantrag gehört.

    Felder anzeigen (81)
    • idinteger

      Primärschlüssel der Person. Interne ID.

    • first_namestring

      Vorname der Person.

    • last_namestring

      Nachname der Person.

    • numberinteger

      Mitglieds- oder Kundennummer der Person.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

    • genderstring

      Geschlecht der Person.

    • titlestring

      Akademischer oder sonstiger Titel der Person.

    • positionstring

      Position oder Rolle der Person.

    • languagestring

      Bevorzugte Sprache der Person.

    • special_salutationstring

      Besonderer Anredetext für Briefe.

    • form_of_salutationstring

      Form der Anrede, zum Beispiel förmlich oder informell.

    • birthdaystring (date-time)

      Geburtstag der Person.

    • known_allergiesstring

      Bekannte Allergien der Person.

    • confirmed_no_allergiesboolean

      Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.

    • allow_photosboolean

      Fotos der Person dürfen aufgenommen und veröffentlicht werden.

    • allow_leaving_aloneboolean

      Die Person darf die Veranstaltung allein verlassen.

    • authorized_pickupstring

      Personen, die die Person abholen dürfen.

    • needs_supportboolean

      Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.

    • support_descriptionstring

      Beschreibung der Unterstützung, die die Person benötigt.

    • financial_supportboolean

      Die Person erhält finanzielle Unterstützung.

    • financial_support_numberstring

      Nummer der finanziellen Förderung.

    • municipal_supportboolean

      Die Person erhält kommunale Unterstützung.

    • municipal_support_numberstring

      Nummer der kommunalen Förderung.

    • grade_levelinteger

      Schuljahrgang der Person.

    • school_classstring

      Schulklasse der Person.

    • start_timestring (date-time)

      Beginn der Mitgliedschaft oder Aktivität.

    • start_time_reasonstring

      Grund für den Beginn.

    • end_timestring (date-time)

      Ende der Mitgliedschaft oder Aktivität.

    • end_time_reasonstring

      Grund für das Ende.

    • confirmed_gtc_timestring (date-time)

      Zeitpunkt, zu dem die AGB bestätigt wurden.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.

    • archivedboolean

      Ob die Person archiviert ist.

    • subscribed_newsletterboolean

      Ob die Person den Newsletter abonniert hat.

    • subscribed_magazineboolean

      Ob die Person das Magazin abonniert hat.

    • printed_member_cardboolean

      Ob für die Person ein Mitgliedsausweis gedruckt wurde.

    • has_login_userboolean

      Ob die Person einen Anmelde-Benutzer hat.

    • profile_picture_urlstring

      URL des Profilbilds der Person.

    • log_book_staffboolean

      Logbuch-Kennzeichen: Personal.

    • log_book_staff1boolean

      Logbuch-Kennzeichen: Personal, Stufe 1.

    • log_book_staff2boolean

      Logbuch-Kennzeichen: Personal, Stufe 2.

    • log_book_memberboolean

      Logbuch-Kennzeichen: Mitglied.

    • log_book_trainerboolean

      Logbuch-Kennzeichen: Trainer.

    • log_book_trainer1boolean

      Logbuch-Kennzeichen: Trainer, Stufe 1.

    • log_book_trainer2boolean

      Logbuch-Kennzeichen: Trainer, Stufe 2.

    • log_book_head_of_departmentboolean

      Logbuch-Kennzeichen: Abteilungsleitung.

    • log_book_supervisory_boardboolean

      Logbuch-Kennzeichen: Aufsichtsrat.

    • log_book_board_of_directorsboolean

      Logbuch-Kennzeichen: Vorstand.

    • log_book_honorary_memberboolean

      Logbuch-Kennzeichen: Ehrenmitglied.

    • log_book_club_card_oneboolean

      Logbuch-Kennzeichen: Vereinskarte.

    • log_book_health_recoveredboolean

      Logbuch-Kennzeichen: von Krankheit genesen.

    • log_book_health_vaccinatedboolean

      Logbuch-Kennzeichen: geimpft.

    • log_book_health_vaccinated_additionstring

      Details der Impfung.

    • log_book_good_conductboolean

      Logbuch-Kennzeichen: Führungszeugnis.

    • log_book_first_aidboolean

      Logbuch-Kennzeichen: Erste-Hilfe-Schulung.

    • log_book_measles_vaccinationboolean

      Logbuch-Kennzeichen: Masernimpfung.

    • sync_lanistaboolean

      Ob die Person mit Lanista synchronisiert ist.

    • categoryCRMPersonCategory

      Personenkategorie.

    • nicknamestring

      Spitzname der Person.

    • preferred_color_hexstring

      Bevorzugte Farbe der Person als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • … 2 weitere Felder
  • contractEmploymentContract11

    Arbeitsvertrag, zu dem der Jahresantrag gehört.

    Felder anzeigen (43)
    • staged_absence_approvalboolean

      null übernimmt zuerst die Gruppen- und dann die Organisationsrichtlinie; bestehende Installationen bleiben aus.

    • idinteger

      Primärschlüssel des Arbeitsvertrags. Interne ID.

    • tokenstring

      Öffentlicher Token des Vertrags. Anstelle der ID verwendet.

    • userUser14

      Benutzer des Mitarbeiters.

    • week_total_hoursnumber (float)

      Gesamte Arbeitsstunden pro Woche.

    • week_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche.

    • reserved_hours_preparationnumber (float)

      L03: wöchentliche Stunden, die für Vorbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_follow_upnumber (float)

      L03: wöchentliche Stunden, die für Nachbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_travelnumber (float)

      L03: wöchentliche Stunden, die für Fahrt reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_flexiblenumber (float)

      L03: wöchentliche Stunden, die für freie Einteilung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • week_full_time_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche bei einem Vollzeitvertrag.

    • year_vacation_daysnumber (float)

      Urlaubstage pro Jahr.

    • month_vacation_daysnumber (float)

      Urlaubstage pro Monat.

    • year_vacation_weeksnumber (float)

      Urlaubswochen pro Jahr.

    • monday_hoursnumber (float)

      Arbeitsstunden am Montag.

    • tuesday_hoursnumber (float)

      Arbeitsstunden am Dienstag.

    • wednesday_hoursnumber (float)

      Arbeitsstunden am Mittwoch.

    • thursday_hoursnumber (float)

      Arbeitsstunden am Donnerstag.

    • friday_hoursnumber (float)

      Arbeitsstunden am Freitag.

    • saturday_hoursnumber (float)

      Arbeitsstunden am Samstag.

    • sunday_hoursnumber (float)

      Arbeitsstunden am Sonntag.

    • netto_hour_costnumber (float)

      Nettokosten je Stunde.

    • brutto_hour_costnumber (float)

      Bruttokosten pro Stunde.

    • startstring (date-time)

      Startdatum des Vertrags.

    • endstring (date-time)

      Enddatum des Vertrags.

    • fixed_term_statusstring

      Befristung: PERMANENT (unbefristet, Standard), FIXED_TERM oder EXTENDED (FIXED_TERM_STATUS_*).

    • fixed_term_endstring (date-time)

      Befristet bis (erster Zeitraum).

    • fixed_term_extension_endstring (date-time)

      Befristet bis nach Verlängerung.

    • probation_endstring (date-time)

      Probezeit bis; wird aus den probationMonths der Vorlage gefüllt, wenn ein Vertrag ohne diese Angabe angelegt wird.

    • numberstring

      Vertragsnummer.

    • descriptionstring

      Beschreibung des Vertrags.

    • archivedboolean

      Der Vertrag ist archiviert.

    • allow_app_time_trackingboolean

      Der Mitarbeitende darf Zeiten in der App erfassen.

    • allow_scanner_time_trackingboolean

      Der Mitarbeitende darf Zeiten mit dem Scanner erfassen.

    • allow_app_non_work_time_managementboolean

      Der Mitarbeitende darf Abwesenheiten in der App verwalten.

    • force_no_auto_breakboolean

      Für diesen Vertrag werden keine automatischen Pausen hinzugefügt.

    • work_time_modestring

      Wie die Sollarbeitszeit definiert ist - null verhält sich wie WEEKDAY_HOURS, damit bestehende Verträge ihr bisheriges Verhalten unverändert beibehalten.

    • holiday_credit_modestring

      Feiertagsguthaben für WEEK_TOTAL-Verträge - null verhält sich wie WEEKDAY_TARGET (bisheriges Verhalten, nur bei WEEKDAY_HOURS-Verträgen sinnvoll).

    • holiday_credit_fixed_secondsinteger

      Fester Feiertagsguthaben in Sekunden.

    • planning_weekdays_bitmaskinteger

      ISO-Wochentagsbitmaske (Mo=1 ... So=64) der Tage, an denen dieser WEEK_TOTAL-Vertrag eingeplant werden bzw. Urlaub nehmen kann - null verhält sich wie Mo-Fr.

    • request_lead_time_daysinteger

      Tage, die ein Abwesenheitsantrag vor seinem ersten Tag eingereicht werden muss ("Bearbeitungs- frist"). null greift zunächst auf die Vertragsgruppe und von dort auf die Einstellung der Installation zurück, damit ein bestehender Vertrag genau wie bisher funktioniert.

    • shift_booking_syncboolean

      L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Gruppe (die wiederum die Organisation übernimmt).

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • created_by_userUser14

    Benutzer, der den Jahresantrag angelegt hat.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • yearinteger

    Das Urlaubsjahr, zu dem die Zeiträume gehören.

  • content_typeinteger

    Abwesenheitstyp jedes Zeitraums (Wert von NonWorkTimePlanSelectionType).

  • descriptionstring

    Beschreibung des Jahresantrags.

  • statusstring

    Abgeleitet aus den Zeiträumen, siehe Klassenkommentar.

  • requestsarray<NonWorkTimeRequest6>

    Aus dem Jahresantrag erzeugte Anträge auf arbeitsfreie Zeit.

    Felder anzeigen (39)
    • overdueboolean

      U04: noch offen nach Ablauf der Bearbeitungsfrist.

    • approval_versioninteger

      Version des Genehmigungsprozesses.

    • change_modestring

      Art der Änderung an der Anfrage.

    • balance_override_reasonstring

      L11: warum ein Planer diesen Antrag genehmigt hat, obwohl der prognostizierte Urlaubssaldo negativ war.

    • coverage_override_reasonstring

      L54: warum der Genehmiger einen Tag unter der Mindestbesetzung akzeptiert hat.

    • coverage_hintboolean

      L53: eingereicht, obwohl er den Personalpuffer angreift - die Genehmiger sehen den Hinweis.

    • sick_during_vacationboolean

      U13: eine Krankmeldung innerhalb genehmigten Urlaubs - vom Server gesetzt, angezeigt als "während Urlaub".

    • consultation_notestring

      Wer vor der Anfrage von Tagen, die ein blockierender Zeitraum als nur mit Abstimmung markiert (U14), konsultiert wurde.

    • daily_absence_start_timestring

      Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.

    • daily_absence_end_timestring

      Endzeit der ganztägigen Abwesenheit.

    • idinteger

      Primärschlüssel der Anfrage. Interne ID.

    • userUser14

      Benutzer, zu dem die Anfrage gehört.

    • contractEmploymentContract11

      Arbeitsvertrag, zu dem der Antrag gehört.

    • descriptionstring

      Beschreibung des Antrags.

    • startstring (date-time)

      Beginn des angefragten Zeitraums.

    • start_datestring

      Startdatum des angefragten Zeitraums.

    • start_monthinteger

      Startmonat des angefragten Zeitraums.

    • start_yearinteger

      Startjahr des angefragten Zeitraums.

    • endstring (date-time)

      Ende des angeforderten Zeitraums.

    • end_datestring

      Enddatum des angeforderten Zeitraums.

    • end_monthinteger

      Endmonat des angeforderten Zeitraums.

    • end_yearinteger

      Endjahr des angeforderten Zeitraums.

    • durationnumber (float)

      Dauer in Tagen, verknüpft mit NonWorkTimePlan – ein Halbtagstyp zählt 0,5 (Z6)

    • statusstring

      Status der Anfrage.

    • content_typestring

      Art des Antrags, z. B. Urlaub oder Abwesenheit.

    • secondary_content_typestring

      Sekundärer Typ der Anfrage.

    • linked_content_typeNonWorkTimePlanSelectionType3

      Mit der Anfrage verknüpfter Planauswahltyp.

    • attachmentsarray<Attachment10>

      Anhänge der Anfrage.

    • commentsarray<NonWorkTimeRequestComment5>

      Kommentare zum Antrag.

    • plan_entriesarray<NonWorkTimePlan2>

      Für die Anfrage erzeugte Planeinträge.

    • parent_requestNonWorkTimeRequest6

      Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.

    • annual_requestNonWorkTimeAnnualRequest3

      L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.

    • request_kindstring

      U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.

    • processing_due_datestring (date-time)

      U04/U20: der Tag, bis zu dem über den Antrag entschieden werden muss, gerechnet ab Eingang.

    • escalated_atstring (date-time)

      U04: Zeitpunkt, zu dem die Eskalation wegen Überfälligkeit gesendet wurde; null = noch nicht eskaliert.

    • written_approval_reasonstring

      U21: warum dieser Antrag um den Schritt der Geschäftsführung mit schriftlichem Kommentar ergänzt wurde (z. B. SUMMER_CANCELLATION); null = keine zusätzliche schriftliche Genehmigung nötig.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/time/non_work_time_annual_request \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "description": "Text",
    "year": 1,
    "content_type": 1
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "description": "Text",
  "user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "language": "de",
    "support_description": "Text",
    "profile_picture_url": "https://vynst.de",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "contract": {
    "id": 42,
    "description": "Text",
    "staged_absence_approval": true,
    "token": "string",
    "user": {
      "id": 42,
      "name": "Beispiel",
      "username": "lena.hartmann@example.org",
      "email": "lena.hartmann@example.org",
      "profile_picture_url": "https://vynst.de",
      "positioningeneral": "string",
      "archived": true,
      "require2fa": true,
      "search_string": "string"
    },
    "week_total_hours": 1.5,
    "week_total_days": 1.5,
    "reserved_hours_preparation": 1.5,
    "reserved_hours_follow_up": 1.5,
    "reserved_hours_travel": 1.5
  },
  "created_by_user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "year": 1,
  "content_type": 1,
  "status": "string",
  "requests": [
    {
      "id": 42,
      "description": "Text",
      "overdue": true,
      "approval_version": 1,
      "change_mode": "string",
      "balance_override_reason": "string",
      "coverage_override_reason": "string",
      "coverage_hint": true,
      "sick_during_vacation": true,
      "consultation_note": "string"
    }
  ]
}

Jahresantrag als Ganzes entscheiden (L48): Jeder offene Zeitraum, den die aktuelle Sitzung entscheiden darf, erhält dieselbe Entscheidung; `declined_requests` listet Zeitraum-IDs, die abzulehnen sind, während der Rest genehmigt wird.

PUT/api/time/non_work_time_annual_request/{id}/decide

Pfad-Parameter

idPflichtstring

Query-Parameter

decisionPflichtstringAPPROVED oder DECLINEDErlaubt: APPROVEDDECLINED
approval_commentstringSchriftliche Entscheidung, Pflicht für den Schritt der Geschäftsleitung
declined_requestsstringKommagetrennte IDs der Zeiträume, die abgelehnt werden, während der Rest genehmigt wird
balance_override_reasonstringL11-Begründung für die Übersteuerung

Antworten

200Alle offenen Zeiträume eines Jahresantrags entscheidenNonWorkTimeAnnualRequest3

Felder anzeigen (12)
  • idinteger

    Primärschlüssel der Jahresanfrage. Interne ID.

  • userUser14

    Benutzer, zu dem der Jahresantrag gehört.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • personCRMPerson10

    Person, zu der der Jahresantrag gehört.

    Felder anzeigen (81)
    • idinteger

      Primärschlüssel der Person. Interne ID.

    • first_namestring

      Vorname der Person.

    • last_namestring

      Nachname der Person.

    • numberinteger

      Mitglieds- oder Kundennummer der Person.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

    • genderstring

      Geschlecht der Person.

    • titlestring

      Akademischer oder sonstiger Titel der Person.

    • positionstring

      Position oder Rolle der Person.

    • languagestring

      Bevorzugte Sprache der Person.

    • special_salutationstring

      Besonderer Anredetext für Briefe.

    • form_of_salutationstring

      Form der Anrede, zum Beispiel förmlich oder informell.

    • birthdaystring (date-time)

      Geburtstag der Person.

    • known_allergiesstring

      Bekannte Allergien der Person.

    • confirmed_no_allergiesboolean

      Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.

    • allow_photosboolean

      Fotos der Person dürfen aufgenommen und veröffentlicht werden.

    • allow_leaving_aloneboolean

      Die Person darf die Veranstaltung allein verlassen.

    • authorized_pickupstring

      Personen, die die Person abholen dürfen.

    • needs_supportboolean

      Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.

    • support_descriptionstring

      Beschreibung der Unterstützung, die die Person benötigt.

    • financial_supportboolean

      Die Person erhält finanzielle Unterstützung.

    • financial_support_numberstring

      Nummer der finanziellen Förderung.

    • municipal_supportboolean

      Die Person erhält kommunale Unterstützung.

    • municipal_support_numberstring

      Nummer der kommunalen Förderung.

    • grade_levelinteger

      Schuljahrgang der Person.

    • school_classstring

      Schulklasse der Person.

    • start_timestring (date-time)

      Beginn der Mitgliedschaft oder Aktivität.

    • start_time_reasonstring

      Grund für den Beginn.

    • end_timestring (date-time)

      Ende der Mitgliedschaft oder Aktivität.

    • end_time_reasonstring

      Grund für das Ende.

    • confirmed_gtc_timestring (date-time)

      Zeitpunkt, zu dem die AGB bestätigt wurden.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.

    • archivedboolean

      Ob die Person archiviert ist.

    • subscribed_newsletterboolean

      Ob die Person den Newsletter abonniert hat.

    • subscribed_magazineboolean

      Ob die Person das Magazin abonniert hat.

    • printed_member_cardboolean

      Ob für die Person ein Mitgliedsausweis gedruckt wurde.

    • has_login_userboolean

      Ob die Person einen Anmelde-Benutzer hat.

    • profile_picture_urlstring

      URL des Profilbilds der Person.

    • log_book_staffboolean

      Logbuch-Kennzeichen: Personal.

    • log_book_staff1boolean

      Logbuch-Kennzeichen: Personal, Stufe 1.

    • log_book_staff2boolean

      Logbuch-Kennzeichen: Personal, Stufe 2.

    • log_book_memberboolean

      Logbuch-Kennzeichen: Mitglied.

    • log_book_trainerboolean

      Logbuch-Kennzeichen: Trainer.

    • log_book_trainer1boolean

      Logbuch-Kennzeichen: Trainer, Stufe 1.

    • log_book_trainer2boolean

      Logbuch-Kennzeichen: Trainer, Stufe 2.

    • log_book_head_of_departmentboolean

      Logbuch-Kennzeichen: Abteilungsleitung.

    • log_book_supervisory_boardboolean

      Logbuch-Kennzeichen: Aufsichtsrat.

    • log_book_board_of_directorsboolean

      Logbuch-Kennzeichen: Vorstand.

    • log_book_honorary_memberboolean

      Logbuch-Kennzeichen: Ehrenmitglied.

    • log_book_club_card_oneboolean

      Logbuch-Kennzeichen: Vereinskarte.

    • log_book_health_recoveredboolean

      Logbuch-Kennzeichen: von Krankheit genesen.

    • log_book_health_vaccinatedboolean

      Logbuch-Kennzeichen: geimpft.

    • log_book_health_vaccinated_additionstring

      Details der Impfung.

    • log_book_good_conductboolean

      Logbuch-Kennzeichen: Führungszeugnis.

    • log_book_first_aidboolean

      Logbuch-Kennzeichen: Erste-Hilfe-Schulung.

    • log_book_measles_vaccinationboolean

      Logbuch-Kennzeichen: Masernimpfung.

    • sync_lanistaboolean

      Ob die Person mit Lanista synchronisiert ist.

    • categoryCRMPersonCategory

      Personenkategorie.

    • nicknamestring

      Spitzname der Person.

    • preferred_color_hexstring

      Bevorzugte Farbe der Person als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • … 2 weitere Felder
  • contractEmploymentContract11

    Arbeitsvertrag, zu dem der Jahresantrag gehört.

    Felder anzeigen (43)
    • staged_absence_approvalboolean

      null übernimmt zuerst die Gruppen- und dann die Organisationsrichtlinie; bestehende Installationen bleiben aus.

    • idinteger

      Primärschlüssel des Arbeitsvertrags. Interne ID.

    • tokenstring

      Öffentlicher Token des Vertrags. Anstelle der ID verwendet.

    • userUser14

      Benutzer des Mitarbeiters.

    • week_total_hoursnumber (float)

      Gesamte Arbeitsstunden pro Woche.

    • week_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche.

    • reserved_hours_preparationnumber (float)

      L03: wöchentliche Stunden, die für Vorbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_follow_upnumber (float)

      L03: wöchentliche Stunden, die für Nachbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_travelnumber (float)

      L03: wöchentliche Stunden, die für Fahrt reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_flexiblenumber (float)

      L03: wöchentliche Stunden, die für freie Einteilung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • week_full_time_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche bei einem Vollzeitvertrag.

    • year_vacation_daysnumber (float)

      Urlaubstage pro Jahr.

    • month_vacation_daysnumber (float)

      Urlaubstage pro Monat.

    • year_vacation_weeksnumber (float)

      Urlaubswochen pro Jahr.

    • monday_hoursnumber (float)

      Arbeitsstunden am Montag.

    • tuesday_hoursnumber (float)

      Arbeitsstunden am Dienstag.

    • wednesday_hoursnumber (float)

      Arbeitsstunden am Mittwoch.

    • thursday_hoursnumber (float)

      Arbeitsstunden am Donnerstag.

    • friday_hoursnumber (float)

      Arbeitsstunden am Freitag.

    • saturday_hoursnumber (float)

      Arbeitsstunden am Samstag.

    • sunday_hoursnumber (float)

      Arbeitsstunden am Sonntag.

    • netto_hour_costnumber (float)

      Nettokosten je Stunde.

    • brutto_hour_costnumber (float)

      Bruttokosten pro Stunde.

    • startstring (date-time)

      Startdatum des Vertrags.

    • endstring (date-time)

      Enddatum des Vertrags.

    • fixed_term_statusstring

      Befristung: PERMANENT (unbefristet, Standard), FIXED_TERM oder EXTENDED (FIXED_TERM_STATUS_*).

    • fixed_term_endstring (date-time)

      Befristet bis (erster Zeitraum).

    • fixed_term_extension_endstring (date-time)

      Befristet bis nach Verlängerung.

    • probation_endstring (date-time)

      Probezeit bis; wird aus den probationMonths der Vorlage gefüllt, wenn ein Vertrag ohne diese Angabe angelegt wird.

    • numberstring

      Vertragsnummer.

    • descriptionstring

      Beschreibung des Vertrags.

    • archivedboolean

      Der Vertrag ist archiviert.

    • allow_app_time_trackingboolean

      Der Mitarbeitende darf Zeiten in der App erfassen.

    • allow_scanner_time_trackingboolean

      Der Mitarbeitende darf Zeiten mit dem Scanner erfassen.

    • allow_app_non_work_time_managementboolean

      Der Mitarbeitende darf Abwesenheiten in der App verwalten.

    • force_no_auto_breakboolean

      Für diesen Vertrag werden keine automatischen Pausen hinzugefügt.

    • work_time_modestring

      Wie die Sollarbeitszeit definiert ist - null verhält sich wie WEEKDAY_HOURS, damit bestehende Verträge ihr bisheriges Verhalten unverändert beibehalten.

    • holiday_credit_modestring

      Feiertagsguthaben für WEEK_TOTAL-Verträge - null verhält sich wie WEEKDAY_TARGET (bisheriges Verhalten, nur bei WEEKDAY_HOURS-Verträgen sinnvoll).

    • holiday_credit_fixed_secondsinteger

      Fester Feiertagsguthaben in Sekunden.

    • planning_weekdays_bitmaskinteger

      ISO-Wochentagsbitmaske (Mo=1 ... So=64) der Tage, an denen dieser WEEK_TOTAL-Vertrag eingeplant werden bzw. Urlaub nehmen kann - null verhält sich wie Mo-Fr.

    • request_lead_time_daysinteger

      Tage, die ein Abwesenheitsantrag vor seinem ersten Tag eingereicht werden muss ("Bearbeitungs- frist"). null greift zunächst auf die Vertragsgruppe und von dort auf die Einstellung der Installation zurück, damit ein bestehender Vertrag genau wie bisher funktioniert.

    • shift_booking_syncboolean

      L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Gruppe (die wiederum die Organisation übernimmt).

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • created_by_userUser14

    Benutzer, der den Jahresantrag angelegt hat.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • yearinteger

    Das Urlaubsjahr, zu dem die Zeiträume gehören.

  • content_typeinteger

    Abwesenheitstyp jedes Zeitraums (Wert von NonWorkTimePlanSelectionType).

  • descriptionstring

    Beschreibung des Jahresantrags.

  • statusstring

    Abgeleitet aus den Zeiträumen, siehe Klassenkommentar.

  • requestsarray<NonWorkTimeRequest6>

    Aus dem Jahresantrag erzeugte Anträge auf arbeitsfreie Zeit.

    Felder anzeigen (39)
    • overdueboolean

      U04: noch offen nach Ablauf der Bearbeitungsfrist.

    • approval_versioninteger

      Version des Genehmigungsprozesses.

    • change_modestring

      Art der Änderung an der Anfrage.

    • balance_override_reasonstring

      L11: warum ein Planer diesen Antrag genehmigt hat, obwohl der prognostizierte Urlaubssaldo negativ war.

    • coverage_override_reasonstring

      L54: warum der Genehmiger einen Tag unter der Mindestbesetzung akzeptiert hat.

    • coverage_hintboolean

      L53: eingereicht, obwohl er den Personalpuffer angreift - die Genehmiger sehen den Hinweis.

    • sick_during_vacationboolean

      U13: eine Krankmeldung innerhalb genehmigten Urlaubs - vom Server gesetzt, angezeigt als "während Urlaub".

    • consultation_notestring

      Wer vor der Anfrage von Tagen, die ein blockierender Zeitraum als nur mit Abstimmung markiert (U14), konsultiert wurde.

    • daily_absence_start_timestring

      Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.

    • daily_absence_end_timestring

      Endzeit der ganztägigen Abwesenheit.

    • idinteger

      Primärschlüssel der Anfrage. Interne ID.

    • userUser14

      Benutzer, zu dem die Anfrage gehört.

    • contractEmploymentContract11

      Arbeitsvertrag, zu dem der Antrag gehört.

    • descriptionstring

      Beschreibung des Antrags.

    • startstring (date-time)

      Beginn des angefragten Zeitraums.

    • start_datestring

      Startdatum des angefragten Zeitraums.

    • start_monthinteger

      Startmonat des angefragten Zeitraums.

    • start_yearinteger

      Startjahr des angefragten Zeitraums.

    • endstring (date-time)

      Ende des angeforderten Zeitraums.

    • end_datestring

      Enddatum des angeforderten Zeitraums.

    • end_monthinteger

      Endmonat des angeforderten Zeitraums.

    • end_yearinteger

      Endjahr des angeforderten Zeitraums.

    • durationnumber (float)

      Dauer in Tagen, verknüpft mit NonWorkTimePlan – ein Halbtagstyp zählt 0,5 (Z6)

    • statusstring

      Status der Anfrage.

    • content_typestring

      Art des Antrags, z. B. Urlaub oder Abwesenheit.

    • secondary_content_typestring

      Sekundärer Typ der Anfrage.

    • linked_content_typeNonWorkTimePlanSelectionType3

      Mit der Anfrage verknüpfter Planauswahltyp.

    • attachmentsarray<Attachment10>

      Anhänge der Anfrage.

    • commentsarray<NonWorkTimeRequestComment5>

      Kommentare zum Antrag.

    • plan_entriesarray<NonWorkTimePlan2>

      Für die Anfrage erzeugte Planeinträge.

    • parent_requestNonWorkTimeRequest6

      Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.

    • annual_requestNonWorkTimeAnnualRequest3

      L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.

    • request_kindstring

      U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.

    • processing_due_datestring (date-time)

      U04/U20: der Tag, bis zu dem über den Antrag entschieden werden muss, gerechnet ab Eingang.

    • escalated_atstring (date-time)

      U04: Zeitpunkt, zu dem die Eskalation wegen Überfälligkeit gesendet wurde; null = noch nicht eskaliert.

    • written_approval_reasonstring

      U21: warum dieser Antrag um den Schritt der Geschäftsführung mit schriftlichem Kommentar ergänzt wurde (z. B. SUMMER_CANCELLATION); null = keine zusätzliche schriftliche Genehmigung nötig.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PUT \
  --url 'https://eure-instanz.iw-erp.de/api/time/non_work_time_annual_request/42/decide?decision=APPROVED' \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "description": "Text",
  "user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "language": "de",
    "support_description": "Text",
    "profile_picture_url": "https://vynst.de",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "contract": {
    "id": 42,
    "description": "Text",
    "staged_absence_approval": true,
    "token": "string",
    "user": {
      "id": 42,
      "name": "Beispiel",
      "username": "lena.hartmann@example.org",
      "email": "lena.hartmann@example.org",
      "profile_picture_url": "https://vynst.de",
      "positioningeneral": "string",
      "archived": true,
      "require2fa": true,
      "search_string": "string"
    },
    "week_total_hours": 1.5,
    "week_total_days": 1.5,
    "reserved_hours_preparation": 1.5,
    "reserved_hours_follow_up": 1.5,
    "reserved_hours_travel": 1.5
  },
  "created_by_user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "year": 1,
  "content_type": 1,
  "status": "string",
  "requests": [
    {
      "id": 42,
      "description": "Text",
      "overdue": true,
      "approval_version": 1,
      "change_mode": "string",
      "balance_override_reason": "string",
      "coverage_override_reason": "string",
      "coverage_hint": true,
      "sick_during_vacation": true,
      "consultation_note": "string"
    }
  ]
}

Jahresantrag als Ganzes entscheiden (L48): Jeder offene Zeitraum, den die aktuelle Sitzung entscheiden darf, erhält dieselbe Entscheidung; `declined_requests` listet Zeitraum-IDs, die abzulehnen sind, während der Rest genehmigt wird.

PATCH/api/time/non_work_time_annual_request/{id}/decide

Pfad-Parameter

idPflichtstring

Query-Parameter

decisionPflichtstringAPPROVED oder DECLINEDErlaubt: APPROVEDDECLINED
approval_commentstringSchriftliche Entscheidung, Pflicht für den Schritt der Geschäftsleitung
declined_requestsstringKommagetrennte IDs der Zeiträume, die abgelehnt werden, während der Rest genehmigt wird
balance_override_reasonstringL11-Begründung für die Übersteuerung

Antworten

200Alle offenen Zeiträume eines Jahresantrags entscheidenNonWorkTimeAnnualRequest3

Felder anzeigen (12)
  • idinteger

    Primärschlüssel der Jahresanfrage. Interne ID.

  • userUser14

    Benutzer, zu dem der Jahresantrag gehört.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • personCRMPerson10

    Person, zu der der Jahresantrag gehört.

    Felder anzeigen (81)
    • idinteger

      Primärschlüssel der Person. Interne ID.

    • first_namestring

      Vorname der Person.

    • last_namestring

      Nachname der Person.

    • numberinteger

      Mitglieds- oder Kundennummer der Person.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

    • genderstring

      Geschlecht der Person.

    • titlestring

      Akademischer oder sonstiger Titel der Person.

    • positionstring

      Position oder Rolle der Person.

    • languagestring

      Bevorzugte Sprache der Person.

    • special_salutationstring

      Besonderer Anredetext für Briefe.

    • form_of_salutationstring

      Form der Anrede, zum Beispiel förmlich oder informell.

    • birthdaystring (date-time)

      Geburtstag der Person.

    • known_allergiesstring

      Bekannte Allergien der Person.

    • confirmed_no_allergiesboolean

      Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.

    • allow_photosboolean

      Fotos der Person dürfen aufgenommen und veröffentlicht werden.

    • allow_leaving_aloneboolean

      Die Person darf die Veranstaltung allein verlassen.

    • authorized_pickupstring

      Personen, die die Person abholen dürfen.

    • needs_supportboolean

      Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.

    • support_descriptionstring

      Beschreibung der Unterstützung, die die Person benötigt.

    • financial_supportboolean

      Die Person erhält finanzielle Unterstützung.

    • financial_support_numberstring

      Nummer der finanziellen Förderung.

    • municipal_supportboolean

      Die Person erhält kommunale Unterstützung.

    • municipal_support_numberstring

      Nummer der kommunalen Förderung.

    • grade_levelinteger

      Schuljahrgang der Person.

    • school_classstring

      Schulklasse der Person.

    • start_timestring (date-time)

      Beginn der Mitgliedschaft oder Aktivität.

    • start_time_reasonstring

      Grund für den Beginn.

    • end_timestring (date-time)

      Ende der Mitgliedschaft oder Aktivität.

    • end_time_reasonstring

      Grund für das Ende.

    • confirmed_gtc_timestring (date-time)

      Zeitpunkt, zu dem die AGB bestätigt wurden.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.

    • archivedboolean

      Ob die Person archiviert ist.

    • subscribed_newsletterboolean

      Ob die Person den Newsletter abonniert hat.

    • subscribed_magazineboolean

      Ob die Person das Magazin abonniert hat.

    • printed_member_cardboolean

      Ob für die Person ein Mitgliedsausweis gedruckt wurde.

    • has_login_userboolean

      Ob die Person einen Anmelde-Benutzer hat.

    • profile_picture_urlstring

      URL des Profilbilds der Person.

    • log_book_staffboolean

      Logbuch-Kennzeichen: Personal.

    • log_book_staff1boolean

      Logbuch-Kennzeichen: Personal, Stufe 1.

    • log_book_staff2boolean

      Logbuch-Kennzeichen: Personal, Stufe 2.

    • log_book_memberboolean

      Logbuch-Kennzeichen: Mitglied.

    • log_book_trainerboolean

      Logbuch-Kennzeichen: Trainer.

    • log_book_trainer1boolean

      Logbuch-Kennzeichen: Trainer, Stufe 1.

    • log_book_trainer2boolean

      Logbuch-Kennzeichen: Trainer, Stufe 2.

    • log_book_head_of_departmentboolean

      Logbuch-Kennzeichen: Abteilungsleitung.

    • log_book_supervisory_boardboolean

      Logbuch-Kennzeichen: Aufsichtsrat.

    • log_book_board_of_directorsboolean

      Logbuch-Kennzeichen: Vorstand.

    • log_book_honorary_memberboolean

      Logbuch-Kennzeichen: Ehrenmitglied.

    • log_book_club_card_oneboolean

      Logbuch-Kennzeichen: Vereinskarte.

    • log_book_health_recoveredboolean

      Logbuch-Kennzeichen: von Krankheit genesen.

    • log_book_health_vaccinatedboolean

      Logbuch-Kennzeichen: geimpft.

    • log_book_health_vaccinated_additionstring

      Details der Impfung.

    • log_book_good_conductboolean

      Logbuch-Kennzeichen: Führungszeugnis.

    • log_book_first_aidboolean

      Logbuch-Kennzeichen: Erste-Hilfe-Schulung.

    • log_book_measles_vaccinationboolean

      Logbuch-Kennzeichen: Masernimpfung.

    • sync_lanistaboolean

      Ob die Person mit Lanista synchronisiert ist.

    • categoryCRMPersonCategory

      Personenkategorie.

    • nicknamestring

      Spitzname der Person.

    • preferred_color_hexstring

      Bevorzugte Farbe der Person als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • … 2 weitere Felder
  • contractEmploymentContract11

    Arbeitsvertrag, zu dem der Jahresantrag gehört.

    Felder anzeigen (43)
    • staged_absence_approvalboolean

      null übernimmt zuerst die Gruppen- und dann die Organisationsrichtlinie; bestehende Installationen bleiben aus.

    • idinteger

      Primärschlüssel des Arbeitsvertrags. Interne ID.

    • tokenstring

      Öffentlicher Token des Vertrags. Anstelle der ID verwendet.

    • userUser14

      Benutzer des Mitarbeiters.

    • week_total_hoursnumber (float)

      Gesamte Arbeitsstunden pro Woche.

    • week_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche.

    • reserved_hours_preparationnumber (float)

      L03: wöchentliche Stunden, die für Vorbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_follow_upnumber (float)

      L03: wöchentliche Stunden, die für Nachbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_travelnumber (float)

      L03: wöchentliche Stunden, die für Fahrt reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • reserved_hours_flexiblenumber (float)

      L03: wöchentliche Stunden, die für freie Einteilung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.

    • week_full_time_total_daysnumber (float)

      Gesamte Arbeitstage pro Woche bei einem Vollzeitvertrag.

    • year_vacation_daysnumber (float)

      Urlaubstage pro Jahr.

    • month_vacation_daysnumber (float)

      Urlaubstage pro Monat.

    • year_vacation_weeksnumber (float)

      Urlaubswochen pro Jahr.

    • monday_hoursnumber (float)

      Arbeitsstunden am Montag.

    • tuesday_hoursnumber (float)

      Arbeitsstunden am Dienstag.

    • wednesday_hoursnumber (float)

      Arbeitsstunden am Mittwoch.

    • thursday_hoursnumber (float)

      Arbeitsstunden am Donnerstag.

    • friday_hoursnumber (float)

      Arbeitsstunden am Freitag.

    • saturday_hoursnumber (float)

      Arbeitsstunden am Samstag.

    • sunday_hoursnumber (float)

      Arbeitsstunden am Sonntag.

    • netto_hour_costnumber (float)

      Nettokosten je Stunde.

    • brutto_hour_costnumber (float)

      Bruttokosten pro Stunde.

    • startstring (date-time)

      Startdatum des Vertrags.

    • endstring (date-time)

      Enddatum des Vertrags.

    • fixed_term_statusstring

      Befristung: PERMANENT (unbefristet, Standard), FIXED_TERM oder EXTENDED (FIXED_TERM_STATUS_*).

    • fixed_term_endstring (date-time)

      Befristet bis (erster Zeitraum).

    • fixed_term_extension_endstring (date-time)

      Befristet bis nach Verlängerung.

    • probation_endstring (date-time)

      Probezeit bis; wird aus den probationMonths der Vorlage gefüllt, wenn ein Vertrag ohne diese Angabe angelegt wird.

    • numberstring

      Vertragsnummer.

    • descriptionstring

      Beschreibung des Vertrags.

    • archivedboolean

      Der Vertrag ist archiviert.

    • allow_app_time_trackingboolean

      Der Mitarbeitende darf Zeiten in der App erfassen.

    • allow_scanner_time_trackingboolean

      Der Mitarbeitende darf Zeiten mit dem Scanner erfassen.

    • allow_app_non_work_time_managementboolean

      Der Mitarbeitende darf Abwesenheiten in der App verwalten.

    • force_no_auto_breakboolean

      Für diesen Vertrag werden keine automatischen Pausen hinzugefügt.

    • work_time_modestring

      Wie die Sollarbeitszeit definiert ist - null verhält sich wie WEEKDAY_HOURS, damit bestehende Verträge ihr bisheriges Verhalten unverändert beibehalten.

    • holiday_credit_modestring

      Feiertagsguthaben für WEEK_TOTAL-Verträge - null verhält sich wie WEEKDAY_TARGET (bisheriges Verhalten, nur bei WEEKDAY_HOURS-Verträgen sinnvoll).

    • holiday_credit_fixed_secondsinteger

      Fester Feiertagsguthaben in Sekunden.

    • planning_weekdays_bitmaskinteger

      ISO-Wochentagsbitmaske (Mo=1 ... So=64) der Tage, an denen dieser WEEK_TOTAL-Vertrag eingeplant werden bzw. Urlaub nehmen kann - null verhält sich wie Mo-Fr.

    • request_lead_time_daysinteger

      Tage, die ein Abwesenheitsantrag vor seinem ersten Tag eingereicht werden muss ("Bearbeitungs- frist"). null greift zunächst auf die Vertragsgruppe und von dort auf die Einstellung der Installation zurück, damit ein bestehender Vertrag genau wie bisher funktioniert.

    • shift_booking_syncboolean

      L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Gruppe (die wiederum die Organisation übernimmt).

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • created_by_userUser14

    Benutzer, der den Jahresantrag angelegt hat.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • yearinteger

    Das Urlaubsjahr, zu dem die Zeiträume gehören.

  • content_typeinteger

    Abwesenheitstyp jedes Zeitraums (Wert von NonWorkTimePlanSelectionType).

  • descriptionstring

    Beschreibung des Jahresantrags.

  • statusstring

    Abgeleitet aus den Zeiträumen, siehe Klassenkommentar.

  • requestsarray<NonWorkTimeRequest6>

    Aus dem Jahresantrag erzeugte Anträge auf arbeitsfreie Zeit.

    Felder anzeigen (39)
    • overdueboolean

      U04: noch offen nach Ablauf der Bearbeitungsfrist.

    • approval_versioninteger

      Version des Genehmigungsprozesses.

    • change_modestring

      Art der Änderung an der Anfrage.

    • balance_override_reasonstring

      L11: warum ein Planer diesen Antrag genehmigt hat, obwohl der prognostizierte Urlaubssaldo negativ war.

    • coverage_override_reasonstring

      L54: warum der Genehmiger einen Tag unter der Mindestbesetzung akzeptiert hat.

    • coverage_hintboolean

      L53: eingereicht, obwohl er den Personalpuffer angreift - die Genehmiger sehen den Hinweis.

    • sick_during_vacationboolean

      U13: eine Krankmeldung innerhalb genehmigten Urlaubs - vom Server gesetzt, angezeigt als "während Urlaub".

    • consultation_notestring

      Wer vor der Anfrage von Tagen, die ein blockierender Zeitraum als nur mit Abstimmung markiert (U14), konsultiert wurde.

    • daily_absence_start_timestring

      Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.

    • daily_absence_end_timestring

      Endzeit der ganztägigen Abwesenheit.

    • idinteger

      Primärschlüssel der Anfrage. Interne ID.

    • userUser14

      Benutzer, zu dem die Anfrage gehört.

    • contractEmploymentContract11

      Arbeitsvertrag, zu dem der Antrag gehört.

    • descriptionstring

      Beschreibung des Antrags.

    • startstring (date-time)

      Beginn des angefragten Zeitraums.

    • start_datestring

      Startdatum des angefragten Zeitraums.

    • start_monthinteger

      Startmonat des angefragten Zeitraums.

    • start_yearinteger

      Startjahr des angefragten Zeitraums.

    • endstring (date-time)

      Ende des angeforderten Zeitraums.

    • end_datestring

      Enddatum des angeforderten Zeitraums.

    • end_monthinteger

      Endmonat des angeforderten Zeitraums.

    • end_yearinteger

      Endjahr des angeforderten Zeitraums.

    • durationnumber (float)

      Dauer in Tagen, verknüpft mit NonWorkTimePlan – ein Halbtagstyp zählt 0,5 (Z6)

    • statusstring

      Status der Anfrage.

    • content_typestring

      Art des Antrags, z. B. Urlaub oder Abwesenheit.

    • secondary_content_typestring

      Sekundärer Typ der Anfrage.

    • linked_content_typeNonWorkTimePlanSelectionType3

      Mit der Anfrage verknüpfter Planauswahltyp.

    • attachmentsarray<Attachment10>

      Anhänge der Anfrage.

    • commentsarray<NonWorkTimeRequestComment5>

      Kommentare zum Antrag.

    • plan_entriesarray<NonWorkTimePlan2>

      Für die Anfrage erzeugte Planeinträge.

    • parent_requestNonWorkTimeRequest6

      Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.

    • annual_requestNonWorkTimeAnnualRequest3

      L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.

    • request_kindstring

      U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.

    • processing_due_datestring (date-time)

      U04/U20: der Tag, bis zu dem über den Antrag entschieden werden muss, gerechnet ab Eingang.

    • escalated_atstring (date-time)

      U04: Zeitpunkt, zu dem die Eskalation wegen Überfälligkeit gesendet wurde; null = noch nicht eskaliert.

    • written_approval_reasonstring

      U21: warum dieser Antrag um den Schritt der Geschäftsführung mit schriftlichem Kommentar ergänzt wurde (z. B. SUMMER_CANCELLATION); null = keine zusätzliche schriftliche Genehmigung nötig.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PATCH \
  --url 'https://eure-instanz.iw-erp.de/api/time/non_work_time_annual_request/42/decide?decision=APPROVED' \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "description": "Text",
  "user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "language": "de",
    "support_description": "Text",
    "profile_picture_url": "https://vynst.de",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "contract": {
    "id": 42,
    "description": "Text",
    "staged_absence_approval": true,
    "token": "string",
    "user": {
      "id": 42,
      "name": "Beispiel",
      "username": "lena.hartmann@example.org",
      "email": "lena.hartmann@example.org",
      "profile_picture_url": "https://vynst.de",
      "positioningeneral": "string",
      "archived": true,
      "require2fa": true,
      "search_string": "string"
    },
    "week_total_hours": 1.5,
    "week_total_days": 1.5,
    "reserved_hours_preparation": 1.5,
    "reserved_hours_follow_up": 1.5,
    "reserved_hours_travel": 1.5
  },
  "created_by_user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "year": 1,
  "content_type": 1,
  "status": "string",
  "requests": [
    {
      "id": 42,
      "description": "Text",
      "overdue": true,
      "approval_version": 1,
      "change_mode": "string",
      "balance_override_reason": "string",
      "coverage_override_reason": "string",
      "coverage_hint": true,
      "sick_during_vacation": true,
      "consultation_note": "string"
    }
  ]
}