Hrmony Embedded API — Admin (DE) (1.0.0)

Download OpenAPI specification:

License: LicenseRef-Hrmony-Proprietary

Hrmony Embedded API — Admin-Tier. Nicht manuell bearbeiten.

Mitarbeiter

Einzelnen Mitarbeiter erstellen

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

personalnummer required	string Personalnummer des Mitarbeiters. Eindeutig innerhalb der Organisation; Duplikat führt zu 409.
vorname required	string Vorname des Mitarbeiters.
nachname required	string Nachname des Mitarbeiters.
externeMitarbeiterId	string Optionale stabile Kennung des Mitarbeiters aus dem Partner-System. Nach dem Erstellen unveränderlich. Wird als `sub`-Claim auf User-Tokens verwendet (§AU9).

Responses

Request samples

Payload

Content type

application/json

{"personalnummer": "P-10023",
"vorname": "Anna",
"nachname": "Schmidt",
"externeMitarbeiterId": "ext-ma-9f72e3"
}

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"organisationsId": "84ee9480-84e2-49e3-9786-76c07c4036f7",
"personalnummer": "string",
"vorname": "string",
"nachname": "string",
"status": "aktiv",
"externeMitarbeiterId": "string"
}
}

Einzelnen Mitarbeiter abrufen

Authorizations:

clientCredentials

path Parameters

mitarbeiterId

required

string <uuid>

UUID des Mitarbeiters.

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "550e8400-e29b-41d4-a716-446655440000",
"organisationsId": "550e8400-e29b-41d4-a716-446655440001",
"personalnummer": "P-10023",
"vorname": "Anna",
"nachname": "Schmidt",
"status": "aktiv"
}
}

Mitarbeiter auflisten

Authorizations:

clientCredentials

query Parameters

limit	integer >= 1 Seitengröße.
cursor	string Opaker Cursor aus `meta.pagination.nextCursor`.

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": [{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"organisationsId": "84ee9480-84e2-49e3-9786-76c07c4036f7",
"personalnummer": "string",
"vorname": "string",
"nachname": "string",
"status": "aktiv",
"externeMitarbeiterId": "string"
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Mehrere Mitarbeiter erstellen

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

required

Array of objects [ 1 .. 1000 ] items

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiter": [{"personalnummer": "string",
"vorname": "string",
"nachname": "string",
"externeMitarbeiterId": "string"
}
]
}

Response samples

Content type

application/json

{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"typ": "mitarbeiter.mehrere_erstellen",
"status": "laeuft",
"pollUrl": "http://example.com",
"erstelltAm": "2019-08-24T14:15:22Z",
"abgeschlossenAm": "2019-08-24T14:15:22Z"
}
}

Mitarbeiter deaktivieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

mitarbeiterId required	string <uuid>
deaktiviertZum required	string^\d{4}-(0[1-9]\|1[012])$ Leistungsmonat im Format `YYYY-MM`.

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"deaktiviertZum": "string"
}

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"status": "aktiv"
}
}

Mitarbeiter reaktivieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

mitarbeiterId required	string <uuid>
aktiviertZum required	string^\d{4}-(0[1-9]\|1[012])$ Leistungsmonat im Format `YYYY-MM`.

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"aktiviertZum": "string"
}

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"status": "aktiv"
}
}

Stammdaten eines Mitarbeiters setzen

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

mitarbeiterId required	string <uuid>
personalnummer required	string
vorname required	string
nachname required	string

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"personalnummer": "string",
"vorname": "string",
"nachname": "string"
}

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"status": "aktiv"
}
}

Organisation

Aktive Organisation abrufen

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": {"organisationsId": "84ee9480-84e2-49e3-9786-76c07c4036f7",
"externeKundenId": "string",
"name": "string"
}
}

Externe Kunden-ID ändern

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

externeKundenId

required

string

Responses

Request samples

Payload

Content type

application/json

{"externeKundenId": "string"
}

Response samples

Content type

application/json

{"data": {"organisationsId": "84ee9480-84e2-49e3-9786-76c07c4036f7",
"externeKundenId": "string",
"name": "string"
}
}

Benefit-Übersicht der Organisation abrufen

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": [{"benefitTyp": "essenszuschuss",
"status": "aktiv",
"aktivAb": "string"
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Organisation · Essenszuschuss

Essenszuschuss freischalten

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

wirksamAb

required

string^\d{4}-(0[1-9]|1[012])$

Leistungsmonat im Format YYYY-MM.

Responses

Request samples

Payload

Content type

application/json

{"wirksamAb": "string"
}

Response samples

Content type

application/json

{"data": {"organisationsId": "84ee9480-84e2-49e3-9786-76c07c4036f7",
"wirksamAb": "string"
}
}

Essenszuschuss sperren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

wirksamAb

required

string^\d{4}-(0[1-9]|1[012])$

Leistungsmonat im Format YYYY-MM.

Responses

Request samples

Payload

Content type

application/json

{"wirksamAb": "string"
}

Response samples

Content type

application/json

{"data": {"organisationsId": "84ee9480-84e2-49e3-9786-76c07c4036f7",
"wirksamAb": "string"
}
}

Organisation · Mobilitaet

Mobilität freischalten

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

wirksamAb

required

string^\d{4}-(0[1-9]|1[012])$

Leistungsmonat im Format YYYY-MM.

Responses

Request samples

Payload

Content type

application/json

{"wirksamAb": "string"
}

Response samples

Content type

application/json

{"data": {"organisationsId": "84ee9480-84e2-49e3-9786-76c07c4036f7",
"wirksamAb": "string"
}
}

Mobilität sperren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

wirksamAb

required

string^\d{4}-(0[1-9]|1[012])$

Leistungsmonat im Format YYYY-MM.

Responses

Request samples

Payload

Content type

application/json

{"wirksamAb": "string"
}

Response samples

Content type

application/json

{"data": {"organisationsId": "84ee9480-84e2-49e3-9786-76c07c4036f7",
"wirksamAb": "string"
}
}

Mitarbeiter · Essenszuschuss

Essenszuschuss-Konfigurationswerte abrufen

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": {"jahresWerte": [{"jahr": 0,
"maximaleTageserstattung": 0,
"maximaleMonatserstattung": 0
}
]
}
}

Essenszuschuss-Konfigurationen auflisten

Authorizations:

clientCredentials

query Parameters

limit	integer [ 1 .. 200 ] Default: 50 Seitengröße.
cursor	string Opaker Cursor.

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": [{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string",
"guthaben": 0,
"tageswert": 0,
"eigenanteil": true,
"bruttoausgleichszahlung": true
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Essenszuschuss-Status auflisten

Authorizations:

clientCredentials

query Parameters

limit	integer [ 1 .. 200 ] Default: 50 Seitengröße.
cursor	string Opaker Cursor.

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": [{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"status": "aktiviert"
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Essenszuschuss-Konfiguration abrufen

Authorizations:

clientCredentials

path Parameters

mitarbeiterId

required

string <uuid>

UUID des Mitarbeiters.

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string",
"guthaben": 0,
"tageswert": 0,
"eigenanteil": true,
"bruttoausgleichszahlung": true
}
}

Essenszuschuss-Status abrufen

Authorizations:

clientCredentials

path Parameters

mitarbeiterId

required

string <uuid>

UUID des Mitarbeiters.

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"status": "aktiviert"
}
}

Essenszuschuss konfigurieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

mitarbeiterId required	string <uuid>
wirksamAb required	string^\d{4}-(0[1-9]\|1[012])$ Leistungsmonat im Format `YYYY-MM`.
guthaben required	number decimal places <= 2 >= 0 Geldbetrag in Euro mit zwei Nachkommastellen.
tageswert required	number decimal places <= 2 >= 0 Geldbetrag in Euro mit zwei Nachkommastellen.
eigenanteil required	boolean
bruttoausgleichszahlung required	boolean

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string",
"guthaben": 0,
"tageswert": 0,
"eigenanteil": true,
"bruttoausgleichszahlung": true
}

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}
}

Mehrere Essenszuschuss-Konfigurationen setzen

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

required

Array of objects [ 1 .. 1000 ] items

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiter": [{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string",
"guthaben": 0,
"tageswert": 0,
"eigenanteil": true,
"bruttoausgleichszahlung": true
}
]
}

Response samples

Content type

application/json

{"data": [{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Essenszuschuss aktivieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

mitarbeiterId required	string <uuid>
wirksamAb required	string^\d{4}-(0[1-9]\|1[012])$ Leistungsmonat im Format `YYYY-MM`.

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}
}

Mehrere Essenszuschuss aktivieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

mitarbeiterId required	Array of strings <uuid> [ 1 .. 1000 ] items [ items <uuid > ]
wirksamAb required	string^\d{4}-(0[1-9]\|1[012])$ Leistungsmonat im Format `YYYY-MM`.

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiterId": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"wirksamAb": "string"
}

Response samples

Content type

application/json

{"data": [{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Essenszuschuss deaktivieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

mitarbeiterId required	string <uuid>
wirksamAb required	string^\d{4}-(0[1-9]\|1[012])$ Leistungsmonat im Format `YYYY-MM`.

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}
}

Mehrere Essenszuschuss deaktivieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

mitarbeiterId required	Array of strings <uuid> [ 1 .. 1000 ] items [ items <uuid > ]
wirksamAb required	string^\d{4}-(0[1-9]\|1[012])$ Leistungsmonat im Format `YYYY-MM`.

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiterId": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"wirksamAb": "string"
}

Response samples

Content type

application/json

{"data": [{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Mitarbeiter · Mobilitaet

Mobilitäts-Konfigurationen auflisten

Authorizations:

clientCredentials

query Parameters

limit	integer [ 1 .. 200 ] Default: 50 Seitengröße.
cursor	string Opaker Cursor.

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": [{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string",
"guthaben": 0
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Mobilitäts-Status auflisten

Authorizations:

clientCredentials

query Parameters

limit	integer [ 1 .. 200 ] Default: 50 Seitengröße.
cursor	string Opaker Cursor.

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": [{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"status": "aktiviert"
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Mobilitäts-Konfiguration abrufen

Authorizations:

clientCredentials

path Parameters

mitarbeiterId

required

string <uuid>

UUID des Mitarbeiters.

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string",
"guthaben": 0
}
}

Mobilitäts-Status abrufen

Authorizations:

clientCredentials

path Parameters

mitarbeiterId

required

string <uuid>

UUID des Mitarbeiters.

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"status": "aktiviert"
}
}

Mobilität konfigurieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

mitarbeiterId required	string <uuid>
wirksamAb required	string^\d{4}-(0[1-9]\|1[012])$ Leistungsmonat im Format `YYYY-MM`.
guthaben required	number decimal places <= 2 >= 0 Geldbetrag in Euro mit zwei Nachkommastellen.

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string",
"guthaben": 0
}

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}
}

Mehrere Mobilität konfigurieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

required

Array of objects [ 1 .. 1000 ] items

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiter": [{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string",
"guthaben": 0
}
]
}

Response samples

Content type

application/json

{"data": [{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Mobilität aktivieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

mitarbeiterId required	string <uuid>
wirksamAb required	string^\d{4}-(0[1-9]\|1[012])$ Leistungsmonat im Format `YYYY-MM`.

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}
}

Mehrere Mobilität aktivieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

mitarbeiterId required	Array of strings <uuid> [ 1 .. 1000 ] items [ items <uuid > ]
wirksamAb required	string^\d{4}-(0[1-9]\|1[012])$ Leistungsmonat im Format `YYYY-MM`.

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiterId": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"wirksamAb": "string"
}

Response samples

Content type

application/json

{"data": [{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Mobilität deaktivieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

mitarbeiterId required	string <uuid>
wirksamAb required	string^\d{4}-(0[1-9]\|1[012])$ Leistungsmonat im Format `YYYY-MM`.

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}

Response samples

Content type

application/json

{"data": {"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}
}

Mehrere Mobilität deaktivieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

mitarbeiterId required	Array of strings <uuid> [ 1 .. 1000 ] items [ items <uuid > ]
wirksamAb required	string^\d{4}-(0[1-9]\|1[012])$ Leistungsmonat im Format `YYYY-MM`.

Responses

Request samples

Payload

Content type

application/json

{"mitarbeiterId": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"wirksamAb": "string"
}

Response samples

Content type

application/json

{"data": [{"mitarbeiterId": "68a7cfa5-5754-45f8-80d8-cc22ea1fd117",
"wirksamAb": "string"
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Webhooks

Webhook registrieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

url

required

string <uri>

Responses

Request samples

Payload

Content type

application/json

{"url": "http://example.com"
}

Response samples

Content type

application/json

{"data": {"webhookId": "ed71eef4-4c34-46dc-81fe-954e560454fd",
"url": "http://example.com",
"signingSecret": "string",
"registriertAm": "2019-08-24T14:15:22Z"
}
}

Webhook deregistrieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

webhookId

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"webhookId": "ed71eef4-4c34-46dc-81fe-954e560454fd"
}

Response samples

Content type

application/json

{"data": {"webhookId": "ed71eef4-4c34-46dc-81fe-954e560454fd"
}
}

Webhooks auflisten

Authorizations:

clientCredentials

query Parameters

limit	integer [ 1 .. 200 ] Default: 50 Seitengröße.
cursor	string Opaker Cursor.

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": [{"webhookId": "ed71eef4-4c34-46dc-81fe-954e560454fd",
"url": "http://example.com",
"registriertAm": "2019-08-24T14:15:22Z"
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Lohndaten · Lohndateien

Lohndatei-Formate abrufen

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": {"formate": [{"format": "csv",
"label": "string",
"felder": [{"name": "string",
"label": "string",
"typ": "string",
"erforderlich": true
}
]
}
]
}
}

Lohndatei-Format konfigurieren

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

required	"csv" (string) or "excel" (string) or "datev" (string) or "lodas" (string) or "sage" (string)
lohnartSteuerfrei	string
mandantenNummer	string
beraterNummer	string

Responses

Request samples

Payload

Content type

application/json

{"format": "csv",
"lohnartSteuerfrei": "string",
"mandantenNummer": "string",
"beraterNummer": "string"
}

Response samples

Content type

application/json

{"data": {"format": "csv",
"lohnartSteuerfrei": "string",
"mandantenNummer": "string",
"beraterNummer": "string"
}
}

Lohndatei-Format abrufen

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": {"format": "csv",
"lohnartSteuerfrei": "string",
"mandantenNummer": "string",
"beraterNummer": "string"
}
}

Lohndateien auflisten

Authorizations:

clientCredentials

query Parameters

limit	integer [ 1 .. 200 ] Default: 50 Seitengröße.
cursor	string Opaker Cursor.

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": [{"lohndateiId": "1997c0fc-8c0c-4a45-be9f-506107d21695",
"importmonat": "string",
"korrekturVersion": 0,
"format": "csv",
"erstelltAm": "2019-08-24T14:15:22Z",
"heruntergeladenAm": "2019-08-24T14:15:22Z"
}
],
"meta": {"pagination": {"nextCursor": "string",
"hasMore": true
}
}
}

Lohndatei abrufen

Authorizations:

clientCredentials

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
Idempotency-Key	string Optionaler Idempotency-Key für mutierende Anfragen.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Request Body schema: application/json
required

lohndateiId

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"lohndateiId": "1997c0fc-8c0c-4a45-be9f-506107d21695"
}

Response samples

Content type

application/json

{"data": {"lohndateiId": "1997c0fc-8c0c-4a45-be9f-506107d21695",
"importmonat": "string",
"korrekturVersion": 0,
"format": "csv",
"erstelltAm": "2019-08-24T14:15:22Z",
"heruntergeladenAm": "2019-08-24T14:15:22Z",
"downloadUrl": "http://example.com",
"gueltigBis": "2019-08-24T14:15:22Z"
}
}

Jobs

Job-Status abrufen

Authorizations:

clientCredentials

path Parameters

jobId

required

string <uuid>

UUID des Jobs.

header Parameters

Accept-Language required	string Enum: "de" "en" Angeforderte Sprachoberfläche — `de` oder `en`.
X-Request-Id	string Korrelations-ID; wird auf der Antwort wiederholt.
traceparent	string W3C-Tracekontext.
tracestate	string W3C-Tracestatus.
X-Hrmony-Tenant-ID required	string Tenant (Organisation) ID — Pflichtfeld für den Admin-Tier.

Responses

Response samples

Content type

application/json

{"data": {"job": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"typ": "mitarbeiter.mehrere_erstellen",
"status": "laeuft",
"pollUrl": "http://example.com",
"erstelltAm": "2019-08-24T14:15:22Z",
"abgeschlossenAm": "2019-08-24T14:15:22Z"
}
}
}

Hrmony Embedded API — Admin (DE) (1.0.0)

Mitarbeiter

Einzelnen Mitarbeiter erstellen

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Einzelnen Mitarbeiter abrufen

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Mitarbeiter auflisten

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Mehrere Mitarbeiter erstellen

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Mitarbeiter deaktivieren

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Mitarbeiter reaktivieren

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Stammdaten eines Mitarbeiters setzen

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Organisation

Aktive Organisation abrufen

Authorizations:

header Parameters

Responses

Response samples

Externe Kunden-ID ändern

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Benefit-Übersicht der Organisation abrufen

Authorizations:

header Parameters

Responses

Response samples

Organisation · Essenszuschuss

Essenszuschuss freischalten

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Essenszuschuss sperren

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required