API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · benefit_bookings

Benefit Booking Schema

Schema-ID
benefit_booking
Collection
benefit_bookings
Permissions
  • Lesenbenefit_booking_view
  • Anlegenbenefit_booking_create
  • Ändernbenefit_booking_edit
  • Löschenbenefit_booking_delete

Felder

Benefit Booking Schema

benefit_bookings4 Permissions

Schema for validating benefit booking requests submitted by employees and tracked by HR

benefitIduuiderforderlich

UUID of the benefit catalog entry

employeeIduuiderforderlich

UUID of the employee (user) who requested the benefit

statusstringerforderlich

Lifecycle status: REQUESTED (initial), APPROVED, REJECTED, ACTIVE (currently in use), CANCELLED

Werte
REQUESTEDAPPROVEDREJECTEDACTIVECANCELLED
Default: "REQUESTED"
requestedAtdatetimeoptional

Timestamp when the employee submitted the request

read-only
decidedAtdatetimeoptional

Timestamp when HR approved or rejected the request

nullable
decidedByIduuidoptional

UUID of the HR user who approved or rejected the request

nullable
employeeNotestringoptional

Optional note from the employee accompanying the request

max 2000 Zeichennullable
hrNotestringoptional

Internal HR note (e.g. processing status, external reference, rejection reason)

max 2000 Zeichennullable
validFromdateoptional

Optional start date of the benefit (set by HR on approval)

nullable
validUntildateoptional

Optional end date of the benefit

nullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/benefit_bookings — Liste, paginiert + filterbar
  • GET /api/v1/benefit_bookings/<id> — Einzelne Entity
  • POST /api/v1/benefit_bookings — Anlegen
  • PATCH /api/v1/benefit_bookings/<id> — Teil-Update
  • DELETE /api/v1/benefit_bookings/<id> — Soft-Delete
  • GET /api/v1/benefit_bookings/<id>/timeline — Audit + Aktivitäten

Suche