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

Benefit Schema

Schema-ID
benefit
Collection
benefits
Permissions
  • Lesenbenefit_view
  • Anlegenbenefit_create
  • Ändernbenefit_edit
  • Löschenbenefit_delete

Felder

Benefit Schema

benefits4 Permissions

Schema for validating benefit catalog entries (Mitarbeiterbenefits, von HR gepflegt)

namestringerforderlich

Display name of the benefit (e.g. "JobRad", "Urban Sports Club")

1–200 Zeichen
descriptionstringoptional

Short description shown on the benefit card

max 5000 Zeichennullable
longDescriptionstringoptional

Full description shown in the detail dialog (Markdown allowed)

max 20000 Zeichennullable
categorystringerforderlich

High-level category, drives icon/color in catalog view

Werte
MOBILITYHEALTHFOODFINANCEEDUCATIONEQUIPMENTFAMILYOTHER
iconKeystringoptional

Optional icon name from the shared Icons component (e.g. "Bike", "Heart", "GraduationCap")

max 64 Zeichennullable
coverImageUrlstringoptional

Optional URL to a cover image displayed on the benefit card

max 2000 Zeichennullable
bookingModestringerforderlich

INTERNAL = booked via app with HR approval; EXTERNAL_LINK = redirect to provider page only; HYBRID = both options available

Werte
INTERNALEXTERNAL_LINKHYBRID
externalUrlstringoptional

Landing page of the benefit provider (used for EXTERNAL_LINK and HYBRID modes)

max 2000 Zeichennullable
internalInstructionsstringoptional

Instructions shown to employees when booking via INTERNAL/HYBRID mode

max 10000 Zeichennullable
monthlyValuenumberoptional

Optional monetary value per month in EUR (for display purposes only)

≥ 0nullable
eligibilitystringoptional

Free-form eligibility criteria (e.g. "ab 6 Monaten Betriebszugehörigkeit") for display only

max 1000 Zeichennullable
availableSlotsnumberoptional

Optional cap on the number of active bookings; null means unlimited

≥ 0nullable
isActivebooleanoptional

Whether the benefit is visible to employees in the catalog

Default: true
sortOrdernumberoptional

Optional manual sort order for the catalog view (lower comes first)

nullable
tagsstring[]optional

Free-form tags for filtering

max 20 Itemsnullable

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

Suche