Octibiz
Demo

Durchsucht Website und Dokumentation gemeinsam. Enter zeigt alle Treffer, Esc schließt.

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

MethodPathPurposePermissionParameters
GET/api/v1/workforce/accountCollection of WorkforceWorkTimeAccountworkforce.account.view_own · workforce.account.view_anyemployeeId
POST/api/v1/workforce/account/adjustCreate a WorkforceWorkTimeAccountworkforce.account.adjust+ body
GET/api/v1/workforce/attendance-daysCollection of WorkforceAttendanceDayworkforce.attendance.view_own · workforce.attendance.view_team · workforce.attendance.view_anypage, employeeId, status, from, to
GET/api/v1/workforce/attendance-days/{ulid}Read one WorkforceAttendanceDayworkforce.attendance.view_own · workforce.attendance.view_team · workforce.attendance.view_anyulid
POST/api/v1/workforce/attendance-days/{ulid}/approveApprove attendance day — Approve attendance day. Dedicated action endpoint — not a standard CRUD create.workforce.attendance.approveulid, + body
POST/api/v1/workforce/attendance-days/{ulid}/correctCorrect attendance day — Correct attendance day. Dedicated action endpoint — not a standard CRUD create.workforce.attendance.correctulid, + body
POST/api/v1/workforce/attendance-days/{ulid}/lockArbeitstag sperren — Sperrt einen freigegebenen Arbeitstag gegen weitere Änderungen (Führungskraft, gleiches Recht wie die Freigabe); nur freigegebene Tage.workforce.attendance.approveulid, + body
GET/api/v1/workforce/attendance-eventsCollection of WorkforceAttendanceEventworkforce.attendance.view_own · workforce.attendance.view_team · workforce.attendance.view_anypage, employeeId, from, to
POST/api/v1/workforce/attendance-events/syncSync attendance event — Sync attendance event. Dedicated action endpoint — not a standard CRUD create.workforce.attendance.clock_own+ body
POST/api/v1/workforce/clockRecord 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-stateCollection of WorkforceClockStateworkforce.attendance.view_own—
GET/api/v1/workforce/period-locksCollection of WorkforcePeriodLockworkforce.period_lock.view · workforce.period_lock.manage · workforce.period_lock.releasepage, brandId, from, to
POST/api/v1/workforce/period-locksCreate a WorkforcePeriodLockworkforce.period_lock.manage+ body
DELETE/api/v1/workforce/period-locks/{ulid}Delete a WorkforcePeriodLockworkforce.period_lock.releaseulid
GET/api/v1/workforce/plan-actualPlan/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_anyfrom, to, employeeId
GET/api/v1/workforce/reportArbeitszeit-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_anyfrom, to
GET/api/v1/workforce/settingsEinstellungen 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/settingsEinstellungen 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-templatesCollection of WorkforceShiftTemplateworkforce.shift.view_own · workforce.shift.view_team · workforce.shift.view_any · workforce.shift.managepage, active
POST/api/v1/workforce/shift-templatesCreate a WorkforceShiftTemplateworkforce.shift.manage+ body
DELETE/api/v1/workforce/shift-templates/{ulid}Delete a WorkforceShiftTemplateworkforce.shift.manageulid
GET/api/v1/workforce/shift-templates/{ulid}Read one WorkforceShiftTemplateworkforce.shift.view_own · workforce.shift.view_team · workforce.shift.view_any · workforce.shift.manageulid
PATCH/api/v1/workforce/shift-templates/{ulid}Update a WorkforceShiftTemplateworkforce.shift.manageulid, + body
GET/api/v1/workforce/shiftsCollection of WorkforceShiftworkforce.shift.view_own · workforce.shift.view_team · workforce.shift.view_any · workforce.shift.managepage, employeeId, status, from, to
POST/api/v1/workforce/shiftsCreate a WorkforceShiftworkforce.shift.manage+ body
POST/api/v1/workforce/shifts/publishCreate a WorkforceShiftworkforce.shift.publish+ body
DELETE/api/v1/workforce/shifts/{ulid}Delete a WorkforceShiftworkforce.shift.manageulid
GET/api/v1/workforce/shifts/{ulid}Read one WorkforceShiftworkforce.shift.view_own · workforce.shift.view_team · workforce.shift.view_any · workforce.shift.manageulid
PATCH/api/v1/workforce/shifts/{ulid}Update a WorkforceShiftworkforce.shift.manageulid, + body

Purpose texts that do not follow the standard pattern are taken verbatim from the interface description in the code.

referenz.api-workforce · Available from version 0.5.4