Hrmony Embedded API — Client (DE) (1.0.0)

Kompakte Liste der Benefits, die für den aufrufenden Mitarbeiter verfügbar sind, mit aktuellem Status (aktiviert, pausiert, deaktiviert). Detaillierte Konfiguration und Budgetnutzung pro Benefit über GET /benefits/{benefit}/konfiguration abrufen.

Liefert ausschließlich die aktuell aktive Essenszuschuss-Konfiguration des aufrufenden Mitarbeiters. Existiert keine aktive Konfiguration, ist der Benefit nicht aktiv und der Endpunkt antwortet mit 404.

Detailansicht der Essenszuschuss-Erstattung für den genannten Leistungsmonat: Benefit-Status, konfiguriertes Guthaben, Gesamt-Summe, Anzahl der beitragenden Belege sowie Erstattungstage mit jeweiliger Tages-Summe. Bei status: deaktiviert oder pausiert sind erstattungstage leer und summe ist 0. Vollständige Tagesansicht (inkl. Belege) über GET /benefits/essenszuschuss/tageserstattungen/{datum}.

Essenszuschuss-Erstattung des aufrufenden Mitarbeiters am genannten Leistungstag: Tages-Summe und Liste der beitragenden Belege mit ID und direkter URL — kein separater Beleg-Aufruf erforderlich.

Liefert den Status des aufrufenden Mitarbeiters bezüglich Essenszuschuss im angegebenen Leistungsmonat: aktiv, deaktiviert oder pausiert. Erlaubt Frontends, retroaktiv darzustellen, ob der Benefit in einem Monat wirksam war, unabhängig davon ob Erstattungen anfielen.

Liefert ausschließlich die aktuell aktive Mobilitaets-Konfiguration des aufrufenden Mitarbeiters. Existiert keine aktive Konfiguration, ist der Benefit nicht aktiv und der Endpunkt antwortet mit 404.

Detailansicht der Mobilitaets-Erstattung für den genannten Leistungsmonat: Benefit-Status, konfiguriertes Guthaben, Gesamt-Summe, Anzahl der beitragenden Belege sowie Erstattungstage mit jeweiliger Tages-Summe. Bei status: deaktiviert oder pausiert sind erstattungstage leer und summe ist 0. Vollständige Tagesansicht (inkl. Belege) über GET /benefits/mobilitaet/tageserstattungen/{datum}.

Mobilitaets-Erstattung des aufrufenden Mitarbeiters am genannten Leistungstag: Tages-Summe und Liste der beitragenden Belege mit ID und direkter URL — kein separater Beleg-Aufruf erforderlich.

Liefert den Status des aufrufenden Mitarbeiters bezüglich Mobilitaet im angegebenen Leistungsmonat: aktiv, deaktiviert oder pausiert. Erlaubt Frontends, retroaktiv darzustellen, ob der Benefit in einem Monat wirksam war, unabhängig davon ob Erstattungen anfielen.

Belege werden in zwei Schritten eingereicht. Dieser Endpunkt liefert eine vorsignierte Upload-URL, die zugehörigen uploadFields und eine dauerhafte belegId. Im zweiten Schritt postet der Client multipart/form-data direkt an die Upload-URL.

Liefert den Beleg inklusive vorsignierter Download-URL (belegUrl). Die Antwort ist eine diskriminierte Union über benefitTyp — Essenszuschuss- und Mobilitaets-Belege haben strukturell leicht abweichende Felder.

Liefert Belege aller Benefit-Typen des Mitarbeiters, sortiert nach eingereichtAm absteigend. belegUrl ist in Listenelementen nicht enthalten — pro Beleg über GET /belege/{belegId} abrufen.

Löscht einen Beleg unabhängig vom Benefit-Typ — die belegId ist global eindeutig und das Backend leitet aus ihr den Typ ab.

Anfechtbare Felder unterscheiden sich nach Benefit-Typ. Für Essenszuschuss sind das mahlzeitsumme und belegdatum (beide Hüllen erforderlich, mindestens eine mit angefochten: true). Für Mobilitaet ist es belegsumme. Der Benefit-Typ wird über das benefitTyp-Diskriminator-Feld angegeben.