Working Time — API and MCP
Overview
This area exposes 29 operations. Each of them is at the same time an MCP tool.
This area is behind the module switch module.workforce. With the module off, these operations answer 404.
Operations
| Method | Path | Purpose | Permission | Parameters |
|---|---|---|---|---|
GET | /api/v1/workforce/account | Collection of WorkforceWorkTimeAccount | workforce.account.view_own · workforce.account.view_any | employeeId |
POST | /api/v1/workforce/account/adjust | Create a WorkforceWorkTimeAccount | workforce.account.adjust | + body |
GET | /api/v1/workforce/attendance-days | Collection of WorkforceAttendanceDay | workforce.attendance.view_own · workforce.attendance.view_team · workforce.attendance.view_any | page, employeeId, status, from, to |
GET | /api/v1/workforce/attendance-days/{ulid} | Read one WorkforceAttendanceDay | workforce.attendance.view_own · workforce.attendance.view_team · workforce.attendance.view_any | ulid |
POST | /api/v1/workforce/attendance-days/{ulid}/approve | Approve attendance day — Approve attendance day. Dedicated action endpoint — not a standard CRUD create. | workforce.attendance.approve | ulid, + body |
POST | /api/v1/workforce/attendance-days/{ulid}/correct | Correct attendance day — Correct attendance day. Dedicated action endpoint — not a standard CRUD create. | workforce.attendance.correct | ulid, + body |
POST | /api/v1/workforce/attendance-days/{ulid}/lock | Arbeitstag sperren — Sperrt einen freigegebenen Arbeitstag gegen weitere Änderungen (Führungskraft, gleiches Recht wie die Freigabe); nur freigegebene Tage. | workforce.attendance.approve | ulid, + body |
GET | /api/v1/workforce/attendance-events | Collection of WorkforceAttendanceEvent | workforce.attendance.view_own · workforce.attendance.view_team · workforce.attendance.view_any | page, employeeId, from, to |
POST | /api/v1/workforce/attendance-events/sync | Sync attendance event — Sync attendance event. Dedicated action endpoint — not a standard CRUD create. | workforce.attendance.clock_own | + body |
POST | /api/v1/workforce/clock | Record time-clock event for workforce — Record time-clock event for workforce. Dedicated action endpoint — not a standard CRUD create. | workforce.attendance.clock_own | + body |
GET | /api/v1/workforce/clock-state | Collection of WorkforceClockState | workforce.attendance.view_own | — |
GET | /api/v1/workforce/period-locks | Collection of WorkforcePeriodLock | workforce.period_lock.view · workforce.period_lock.manage · workforce.period_lock.release | page, brandId, from, to |
POST | /api/v1/workforce/period-locks | Create a WorkforcePeriodLock | workforce.period_lock.manage | + body |
DELETE | /api/v1/workforce/period-locks/{ulid} | Delete a WorkforcePeriodLock | workforce.period_lock.release | ulid |
GET | /api/v1/workforce/plan-actual | Plan/Ist der Arbeitszeit je Mitarbeiter und Tag — Stellt je Mitarbeiter und Tag die Anwesenheit (Netto) der geplanten Schicht (abzüglich Pause) und der gebuchten Projektzeit gegenüber und nennt beide Abweichungen. Sichtbar ist, was auch in der Anwesenheitsliste sichtbar wäre; Schicht und Projektzeit nur, soweit der Nutzer sie lesen darf (null = nicht vorhanden bzw. nicht lesbar). Standard-Zeitraum ist der laufende Monat, höchstens 92 Tage. | workforce.attendance.view_own · workforce.attendance.view_team · workforce.attendance.view_any | from, to, employeeId |
GET | /api/v1/workforce/report | Arbeitszeit-Auswertung je Mitarbeiter — Verdichtet die Anwesenheitstage eines Zeitraums: Ist- und Sollminuten, Abweichung, Überstunden-Buchungen, gutgeschriebene Abwesenheit, Schichten und offene Tage. Standard-Zeitraum ist der laufende Monat. Sortiert nach der größten Abweichung. | workforce.attendance.view_own · workforce.attendance.view_team · workforce.attendance.view_any | from, to |
GET | /api/v1/workforce/settings | Einstellungen der Arbeitszeit lesen — Pausen-Schwellen und Mindestpausen, Tageshöchstzeit und Ruhezeit (ArbZG), Standortpflicht der Stempeluhr, Lohnarten und DATEV-Kopf des Lohn-Exports — alles in Minuten bzw. als Lohnart-Schlüssel. Recht workforce.config.manage. | workforce.config.manage | — |
PATCH | /api/v1/workforce/settings | Einstellungen der Arbeitszeit ändern — Nur gesendete Felder ändern sich; Minuten außerhalb des Bereichs 422. Wirkt auf die nächste Prüfung und den nächsten Lohn-Export. Recht workforce.config.manage markenübergreifend (sonst 403). | workforce.config.manage | + body |
GET | /api/v1/workforce/shift-templates | Collection of WorkforceShiftTemplate | workforce.shift.view_own · workforce.shift.view_team · workforce.shift.view_any · workforce.shift.manage | page, active |
POST | /api/v1/workforce/shift-templates | Create a WorkforceShiftTemplate | workforce.shift.manage | + body |
DELETE | /api/v1/workforce/shift-templates/{ulid} | Delete a WorkforceShiftTemplate | workforce.shift.manage | ulid |
GET | /api/v1/workforce/shift-templates/{ulid} | Read one WorkforceShiftTemplate | workforce.shift.view_own · workforce.shift.view_team · workforce.shift.view_any · workforce.shift.manage | ulid |
PATCH | /api/v1/workforce/shift-templates/{ulid} | Update a WorkforceShiftTemplate | workforce.shift.manage | ulid, + body |
GET | /api/v1/workforce/shifts | Collection of WorkforceShift | workforce.shift.view_own · workforce.shift.view_team · workforce.shift.view_any · workforce.shift.manage | page, employeeId, status, from, to |
POST | /api/v1/workforce/shifts | Create a WorkforceShift | workforce.shift.manage | + body |
POST | /api/v1/workforce/shifts/publish | Create a WorkforceShift | workforce.shift.publish | + body |
DELETE | /api/v1/workforce/shifts/{ulid} | Delete a WorkforceShift | workforce.shift.manage | ulid |
GET | /api/v1/workforce/shifts/{ulid} | Read one WorkforceShift | workforce.shift.view_own · workforce.shift.view_team · workforce.shift.view_any · workforce.shift.manage | ulid |
PATCH | /api/v1/workforce/shifts/{ulid} | Update a WorkforceShift | workforce.shift.manage | ulid, + body |
Purpose texts that do not follow the standard pattern are taken verbatim from the interface description in the code.