Hrmony Embedded API — Client (EN) (1.0.0)

Compact list of benefits available to the calling employee, with current status (aktiviert, pausiert, deaktiviert). Retrieve detailed configuration and budget usage per benefit via GET /benefits/{benefit}/konfiguration.

Returns only the currently active meal allowance configuration for the calling employee. If no active configuration exists, the benefit is not active and the endpoint responds with 404.

Detail view of the meal allowance reimbursement for the specified service month: benefit status, configured budget, total amount, number of contributing receipts, and reimbursement days with their respective daily totals. When status: deaktiviert or pausiert, erstattungstage is empty and summe is 0. Full daily view (incl. receipts) via GET /benefits/essenszuschuss/tageserstattungen/{datum}.

Meal allowance reimbursement for the calling employee on the specified service day: daily total and list of contributing receipts with ID and direct URL — no separate receipt call required.

Returns the status of the calling employee regarding meal allowance in the specified service month: aktiv, deaktiviert, or pausiert. Allows frontends to show retroactively whether the benefit was effective in a month, regardless of whether any reimbursements occurred.

Returns only the currently active mobility configuration for the calling employee. If no active configuration exists, the benefit is not active and the endpoint responds with 404.

Detail view of the mobility reimbursement for the specified service month: benefit status, configured budget, total amount, number of contributing receipts, and reimbursement days with their respective daily totals. When status: deaktiviert or pausiert, erstattungstage is empty and summe is 0. Full daily view (incl. receipts) via GET /benefits/mobilitaet/tageserstattungen/{datum}.

Mobility reimbursement for the calling employee on the specified service day: daily total and list of contributing receipts with ID and direct URL — no separate receipt call required.

Returns the status of the calling employee regarding mobility in the specified service month: aktiv, deaktiviert, or pausiert. Allows frontends to show retroactively whether the benefit was effective in a month, regardless of whether any reimbursements occurred.

Receipts are submitted in two steps. This endpoint returns a presigned upload URL, the associated uploadFields, and a permanent belegId. In the second step, the client posts multipart/form-data directly to the upload URL.

Returns the receipt including a presigned download URL (belegUrl). The response is a discriminated union over benefitTyp — meal allowance and mobility receipts have slightly different structural fields.

Returns receipts of all benefit types for the employee, sorted by eingereichtAm descending. belegUrl is not included in list items — retrieve per receipt via GET /belege/{belegId}.

Deletes a receipt regardless of benefit type — the belegId is globally unique and the backend derives the type from it.

Disputable fields differ by benefit type. For meal allowance these are mahlzeitsumme and belegdatum (both wrappers required, at least one with angefochten: true). For mobility it is belegsumme. The benefit type is specified via the benefitTyp discriminator field.