Octibiz
Demo

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

Personal & HR — API und MCP

Überblick

Dieser Bereich stellt 87 Operationen bereit. Jede davon ist zugleich ein MCP-Werkzeug.

Der Bereich hängt am Modul-Schalter module.hr. Ist das Modul aus, antworten diese Operationen mit 404.

Operationen

MethodePfadZweckRechtParameter
GET/api/v1/hr-absence-balancesListe der HrAbsenceBalancehr.absence.view_ownpage, employeeId, year, retentionDue
DELETE/api/v1/hr-absence-balances/{ulid}Lösch-Vorschlag der Aufbewahrung bestätigen — Löscht ein Urlaubskonto endgültig — nur, wenn der Aufbewahrungslauf es zur Löschung vorgeschlagen hat (retentionDueAt gesetzt; Regel hr_absence, 6 Jahre, Lohnunterlagen). Sonst 409: Urlaubskonten pflegt der Ablauf, nicht die Hand.hr.document.manage · Objektregel hr.absence.viewulid
GET/api/v1/hr-absence-balances/{ulid}Eine HrAbsenceBalance lesenhr.absence.view_ownulid
PATCH/api/v1/hr-absence-balances/{ulid}Urlaubskonto von Hand korrigieren — Überschreibt den anteilig berechneten Jahresanspruch (entitlementDays, danach als „von Hand" markiert), den Übertrag (carryoverDays) oder den Eröffnungsbestand genommener Tage zum Stichtag (openingTakenDays). Genommen/geplant leitet das System weiter aus den Abwesenheiten ab.hr.employee.edit · Objektregel hr.absence.viewulid, + Rumpf
POST/api/v1/hr-absence-balances/{ulid}/retention-keepLösch-Vorschlag verwerfen und Aufbewahrung verlängern — Verwirft den Lösch-Vorschlag der Aufbewahrung und hält das Urlaubskonto bis retentionUntil (Pflicht, Y-m-d, in der Zukunft). Gelöscht wird ausschließlich über DELETE.hr.document.manage · Objektregel hr.absence.viewulid, + Rumpf
GET/api/v1/hr-absence-typesListe der HrAbsenceTypehr.absence.view_ownpage
POST/api/v1/hr-absence-typesEine HrAbsenceType anlegenhr.absencetype.manage+ Rumpf
DELETE/api/v1/hr-absence-types/{ulid}Eine HrAbsenceType löschenhr.absencetype.manageulid
GET/api/v1/hr-absence-types/{ulid}Eine HrAbsenceType lesenhr.absence.view_ownulid
PATCH/api/v1/hr-absence-types/{ulid}Eine HrAbsenceType ändernhr.absencetype.manageulid, + Rumpf
GET/api/v1/hr-absencesListe der HrAbsencehr.absence.view_ownpage, employeeId, status, from, to, typeCode, q, retentionDue, order[startDate], order[period]
POST/api/v1/hr-absencesEine HrAbsence anlegenhr.absence.request_own+ Rumpf
POST/api/v1/hr-absences/bulk-decisionMehrere Abwesenheitsantraege auf einmal entscheiden — Genehmigt bzw. lehnt bis zu 100 Antraege ab. Jeder Antrag wird EINZELN gegen den objektbezogenen Voter geprueft; die Antwort nennt je Antrag den Ausgang (Teilerfolg ist erlaubt).hr.absence.approve+ Rumpf
DELETE/api/v1/hr-absences/{ulid}Lösch-Vorschlag der Aufbewahrung bestätigen — Löscht eine Abwesenheit endgültig — nur, wenn der Aufbewahrungslauf sie zur Löschung vorgeschlagen hat (retentionDueAt gesetzt; Regel 6 Jahre, Lohnunterlagen). Sonst 409: im laufenden Betrieb wird storniert, nicht gelöscht.hr.document.manage · Objektregel hr.absence.viewulid
GET/api/v1/hr-absences/{ulid}Eine HrAbsence lesenObjektregel hr.absence.viewulid
POST/api/v1/hr-absences/{ulid}/approveApprove hr absence — Approve hr absence. Dedicated action endpoint — not a standard CRUD create.hr.absence.approveulid, + Rumpf
POST/api/v1/hr-absences/{ulid}/cancelCancel hr absence — Cancel hr absence. Dedicated action endpoint — not a standard CRUD create.hr.absence.cancelulid, + Rumpf
POST/api/v1/hr-absences/{ulid}/eaueAU-Stand einer Krankmeldung festhalten — HR vermerkt den Stand der elektronischen AU (pending = erwartet, retrieved = vom Lohnbüro abgerufen, not_available = keine eAU, z. B. Privatarzt/Ausland) mit Abrufdatum und Kennung. Der Abruf selbst läuft über die Software des Lohnbüros; leerer Stand entfernt den Vermerk.hr.document.manage · Objektregel hr.absence.viewulid, + Rumpf
POST/api/v1/hr-absences/{ulid}/provide-proofNachweis zur Abwesenheit nachreichen — Reicht den geforderten Nachweis nach: verknüpft das Dokument mit der Abwesenheit und setzt proofProvidedAt.hr.absence.cancelulid, + Rumpf
POST/api/v1/hr-absences/{ulid}/rejectAbwesenheitsantrag ablehnen — Endgültige Ablehnung: Status rejected, Entscheider und Zeitpunkt werden festgehalten, das Urlaubskonto bleibt unberührt. Nur aus requested möglich (sonst 409) — eine bereits genehmigte Abwesenheit wird über /cancel zurückgenommen, nicht hier. Body optional {decisionNote}.hr.absence.approveulid, + Rumpf
POST/api/v1/hr-absences/{ulid}/retention-keepLösch-Vorschlag verwerfen und Aufbewahrung verlängern — Verwirft den Lösch-Vorschlag der Aufbewahrung und hält die Abwesenheit bis retentionUntil (Pflicht, Y-m-d, in der Zukunft). Gelöscht wird ausschließlich über DELETE.hr.document.manage · Objektregel hr.absence.viewulid, + Rumpf
GET/api/v1/hr-availabilityListe der HrAvailabilityhr.absence.view_team · hr.employee.viewfrom, to, employeeId
GET/api/v1/hr-checklist-proceduresAbläufe (SOPs), aus denen eine Checklisten-Vorlage entstehen kann — Veröffentlichte Arbeitsanweisungen mit Referenz, Titel und Zahl der Schritte. Die Referenz an POST /v1/hr-checklist-templates als procedureRef übergeben — die Schritte werden dann als Vorlagen-Schritte übernommen.hr.onboarding.managesearch, limit
GET/api/v1/hr-checklist-templatesListe der HrChecklistTemplatehr.onboarding.managepage, mode
POST/api/v1/hr-checklist-templatesEine HrChecklistTemplate anlegenhr.onboarding.manage+ Rumpf
DELETE/api/v1/hr-checklist-templates/{ulid}Eine HrChecklistTemplate löschenhr.onboarding.manageulid
GET/api/v1/hr-checklist-templates/{ulid}Eine HrChecklistTemplate lesenhr.onboarding.manageulid
PATCH/api/v1/hr-checklist-templates/{ulid}Eine HrChecklistTemplate ändernhr.onboarding.manageulid, + Rumpf
GET/api/v1/hr-employee-change-requestsListe der HrEmployeeChangeRequesthr.employee.view_self · hr.employee.edit · hr.skill.managepage, status, kind, employeeId, mine
GET/api/v1/hr-employee-change-requests/{ulid}Änderungsantrag mit Nutzlast — Zeigt zusätzlich die beantragten Werte (entschlüsselt) — nur für den Antragsteller und die Entscheider der Art.hr.employee.view_self · hr.employee.edit · hr.skill.manageulid
POST/api/v1/hr-employee-change-requests/{ulid}/approveAntrag freigeben — Übernimmt die beantragten Werte — Kontaktdaten in die verschlüsselte Ablage, eine Fähigkeit ins Profil. Payload {note?}.hr.employee.edit · hr.skill.manageulid, + Rumpf
POST/api/v1/hr-employee-change-requests/{ulid}/rejectAntrag ablehnen — Lehnt den Antrag ab; der Mitarbeiter wird benachrichtigt. Payload {note?} — die Begründung steht am Antrag.hr.employee.edit · hr.skill.manageulid, + Rumpf
GET/api/v1/hr-employee-documentsListe der HrEmployeeDocumenthr.document.view · hr.document.manage · hr.employee.view_selfpage, employeeId, type, q, retentionDue
POST/api/v1/hr-employee-documentsEine HrEmployeeDocument anlegenhr.document.manage+ Rumpf
DELETE/api/v1/hr-employee-documents/{ulid}Eine HrEmployeeDocument löschenhr.document.manageulid
GET/api/v1/hr-employee-documents/{ulid}Eine HrEmployeeDocument lesenhr.document.view · hr.document.manage · hr.employee.view_selfulid
POST/api/v1/hr-employee-documents/{ulid}/retention-keepLösch-Vorschlag verwerfen und Aufbewahrung verlängern — Verwirft den Lösch-Vorschlag der Aufbewahrungsfrist und setzt eine neue, ausdrückliche Aufbewahrung bis retentionUntil (Pflichtangabe, Y-m-d, in der Zukunft). Gelöscht wird ausschließlich über DELETE — dieser Aufruf hält das Dokument.hr.document.manageulid, + Rumpf
GET/api/v1/hr-employee-goalsListe der HrEmployeeGoalhr.goal.view · hr.goal.view_team · hr.employee.view_selfpage, employeeId, mine, current
POST/api/v1/hr-employee-goalsEine HrEmployeeGoal anlegenhr.goal.manage · hr.goal.manage_team+ Rumpf
DELETE/api/v1/hr-employee-goals/{ulid}Eine HrEmployeeGoal löschenhr.goal.manageulid
GET/api/v1/hr-employee-goals/{ulid}Eine HrEmployeeGoal lesenhr.goal.viewulid
PATCH/api/v1/hr-employee-goals/{ulid}Eine HrEmployeeGoal ändernhr.goal.manageulid, + Rumpf
GET/api/v1/hr-feedback-entriesListe der HrFeedbackEntryhr.feedback.view · hr.feedback.view_team · hr.employee.view_selfpage, employeeId, kind
POST/api/v1/hr-feedback-entriesEine HrFeedbackEntry anlegenhr.feedback.manage · hr.feedback.manage_team+ Rumpf
DELETE/api/v1/hr-feedback-entries/{ulid}Eine HrFeedbackEntry löschenhr.feedback.manageulid
GET/api/v1/hr-feedback-entries/{ulid}Eine HrFeedbackEntry lesenhr.feedback.viewulid
PATCH/api/v1/hr-feedback-entries/{ulid}Eine HrFeedbackEntry ändernhr.feedback.manageulid, + Rumpf
GET/api/v1/hr-occasionsAnstehende Geburtstage und Dienstjubiläen — Nur Personen, die zugestimmt haben. Geburtstage ohne Jahr (Tag + Monat). Fenster ab from (Y-m-d, Standard heute) über days Tage (1–366, Standard 30); kind schränkt auf birthday oder anniversary ein.hr.occasion.viewfrom, days, kind
POST/api/v1/hr-onboarding-assistantOnboarding-Frage beantworten — Beantwortet eine Frage zum eigenen Einstieg im Kontext der Personaldaten und der offenen Checklisten-Schritte. Ohne employeeUlid gilt die eigene Person; eine fremde Person setzt das Recht zur Checklisten-Pflege voraus.hr.employee.view_self · hr.onboarding.manage+ Rumpf
GET/api/v1/hr-onboarding-checklistsListe der HrOnboardingChecklisthr.onboarding.managepage, employeeId, mode, status, responsibleId
POST/api/v1/hr-onboarding-checklists/from-templateEine HrOnboardingChecklist anlegenhr.onboarding.manage+ Rumpf
GET/api/v1/hr-onboarding-checklists/{ulid}Eine HrOnboardingChecklist lesenhr.onboarding.manageulid
POST/api/v1/hr-onboarding-checklists/{ulid}/complete-itemChecklisten-Eintrag erledigen — Markiert einen Eintrag als erledigt und löst idempotent die daran hängenden Schritte aus (Provisionierung, Betriebsmittel, Aufgabe).hr.onboarding.manageulid, + Rumpf
POST/api/v1/hr-onboarding-checklists/{ulid}/itemsChecklisten-Eintrag hinzufügen — Fügt der On- bzw. Offboarding-Checkliste einen Eintrag hinzu.hr.onboarding.manageulid, + Rumpf
POST/api/v1/hr-onboarding-checklists/{ulid}/skip-itemChecklisten-Eintrag überspringen — Überspringt einen Eintrag, ohne die daran hängenden Schritte auszulösen.hr.onboarding.manageulid, + Rumpf
GET/api/v1/hr-payroll-export-checksRetrieves a HrPayrollExportCheck resource. — Vorab-Prüfung des Lohn-Exports: ist der Zeitraum für die Lohnabrechnung gesperrt, wie viele Anwesenheitstage sind nicht freigegeben, welche Warnungen verlangt der Export als Bestätigung (confirmWarnings). Liest nur; fremde Marke 404, ohne Arbeitszeit-Modul 409.hr.payroll.exportfrom, to, brandId
GET/api/v1/hr-payroll-export-runsListe der HrPayrollExportRunhr.payroll.exportpage, format, brandId
GET/api/v1/hr-payroll-export-runs/{ulid}Eine HrPayrollExportRun lesenhr.payroll.exportulid
POST/api/v1/hr-payroll-exportsCreates a HrPayrollExport resource. — Lohn-Export eines Zeitraums (max. 366 Tage) mit Protokoll. format=csv Übersicht je Mitarbeiter, format=datev DATEV-LODAS-Bewegungsdaten, format=wage-types Lohnarten-CSV — beide nur für genau einen Kalendermonat (422). brandId schneidet auf eine Marke (fremde Marke 404, ohne brandId alle Marken des Rechts). Ist der Zeitraum nicht gesperrt oder sind Anwesenheitstage nicht freigegeben, antwortet der Export mit 409 und den Warnungen — erst confirmWarnings=true exportiert trotzdem (Vorab-Prüfung: GET /v1/hr-payroll-export-checks). Ohne aktives Arbeitszeit-Modul 409. Freelancer sind ausgenommen.hr.payroll.export+ Rumpf
GET/api/v1/hr-role-optionsRollen zur Auswahl im Onboarding-Schritt „Rolle zuweisen" — Kennung und Name aller Rollen, alphabetisch — die Auswahlliste für On-/Offboarding-Schritte, die einem neuen Mitarbeiter eine Rolle geben. Ohne Rechte und Mitglieder der Rollen.hr.onboarding.manage—
GET/api/v1/hr-skillsListe der HrSkillhr.skill.view · hr.employee.edit_self_limitedpage, category, active
POST/api/v1/hr-skillsEine HrSkill anlegenhr.skill.manage+ Rumpf
DELETE/api/v1/hr-skills/{ulid}Eine HrSkill löschenhr.skill.manageulid
GET/api/v1/hr-skills/{ulid}Eine HrSkill lesenhr.skill.view · hr.employee.edit_self_limitedulid
PATCH/api/v1/hr-skills/{ulid}Eine HrSkill ändernhr.skill.manageulid, + Rumpf
GET/api/v1/hr-team-calendarTeam-Abwesenheitskalender — Abwesenheiten der Belegschaft im Zeitraum (höchstens ein Jahr) mit Engpass-Tagen und Urlaubssperren. Die Art der Abwesenheit und offene Anträge sieht nur, wer Team-Abwesenheiten lesen darf; alle anderen sehen nur, wer fehlt.hr.absence.view_ownfrom, to, teamId
GET/api/v1/hr-vacation-blocksListe der HrVacationBlockhr.absence.view_ownpage, status, from, to, teamId
POST/api/v1/hr-vacation-blocksUrlaubssperre anlegen oder vorschlagen — HR legt die Sperre sofort aktiv an; die Teamleitung schlägt sie für ein eigenes Team vor (Status proposed). Für die ganze Belegschaft (ohne teamId) nur HR.hr.vacation_block.manage · hr.vacation_block.propose+ Rumpf
GET/api/v1/hr-vacation-blocks/{ulid}Eine HrVacationBlock lesenhr.absence.view_ownulid
POST/api/v1/hr-vacation-blocks/{ulid}/activateVorgeschlagene Urlaubssperre in Kraft setzen — Nur HR. Ab dann werden Urlaubsanträge im Zeitraum abgewiesen.hr.vacation_block.manageulid, + Rumpf
POST/api/v1/hr-vacation-blocks/{ulid}/releaseUrlaubssperre aufheben bzw. Vorschlag ablehnen — Nur HR. Eine aktive Sperre wird aufgehoben, ein Vorschlag abgelehnt.hr.vacation_block.manageulid, + Rumpf
GET/api/v1/hr/absence-statusesListe der HrAbsenceStatushr.absence.view_ownpage
POST/api/v1/hr/absence-statusesEine HrAbsenceStatus anlegenhr.config.manage+ Rumpf
DELETE/api/v1/hr/absence-statuses/{key}Eine HrAbsenceStatus löschenhr.config.managekey
GET/api/v1/hr/absence-statuses/{key}Eine HrAbsenceStatus lesenhr.absence.view_ownkey
PATCH/api/v1/hr/absence-statuses/{key}Eine HrAbsenceStatus ändernhr.config.managekey, + Rumpf
GET/api/v1/hr/employee-calendar-connectionsListe der EmployeeCalendarConnectionhr.calendar.manage—
POST/api/v1/hr/employee-calendar-connectionsEine EmployeeCalendarConnection anlegenhr.calendar.manage+ Rumpf
DELETE/api/v1/hr/employee-calendar-connections/{ulid}Eine EmployeeCalendarConnection löschenhr.calendar.manageulid
GET/api/v1/hr/employee-calendar-connections/{ulid}Eine EmployeeCalendarConnection lesenhr.calendar.manageulid
PATCH/api/v1/hr/employee-calendar-connections/{ulid}Eine EmployeeCalendarConnection ändernhr.calendar.manageulid, + Rumpf
POST/api/v1/hr/employee-calendar-connections/{ulid}/syncSync employee calendar connection — Sync employee calendar connection. Dedicated action endpoint — not a standard CRUD create.hr.calendar.manageulid, + Rumpf
GET/api/v1/hr/goal-statusesListe der HrGoalStatushr.goal.view · hr.goal.view_team · hr.employee.view_selfpage
POST/api/v1/hr/goal-statusesEine HrGoalStatus anlegenhr.config.manage+ Rumpf
DELETE/api/v1/hr/goal-statuses/{key}Eine HrGoalStatus löschenhr.config.managekey
GET/api/v1/hr/goal-statuses/{key}Eine HrGoalStatus lesenhr.goal.view · hr.goal.view_team · hr.employee.view_selfkey
PATCH/api/v1/hr/goal-statuses/{key}Eine HrGoalStatus ändernhr.config.managekey, + Rumpf

Zweckangaben, die nicht dem Standardmuster folgen, stammen unverändert aus der Schnittstellen-Beschreibung im Code.

referenz.api-hr · Gilt ab Version 0.5.4