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

Compensation Component Template Schema

Schema-ID
compensation_component_template
Collection
compensation_component_templates
Permissions
  • Lesencompensation_component_template_view
  • Anlegencompensation_component_template_create
  • Änderncompensation_component_template_edit
  • Löschencompensation_component_template_delete

Felder

Compensation Component Template Schema

compensation_component_templates4 Permissions

Reusable defaults for contractual compensation components or recurring payout records (ADR 0114).

appliesTostringerforderlich

CONTRACTUAL = template is offered in the employment-contract drawer. RECORD = template is offered when creating a compensation_record.

Werte
CONTRACTUALRECORD
kindstringerforderlich

Either a ContractualComponentKind (when appliesTo=CONTRACTUAL) or a CompensationRecordKind (when appliesTo=RECORD). Validated server-side against the matching enum based on appliesTo.

max 60 Zeichen
defaultLabelstringerforderlich

Display label shown in the picker, e.g. „Urlaubsgeld 50% / Mai" or „Quartalsbonus Sales Q4".

max 200 Zeichen
descriptionstringoptional

Optional admin-facing notes explaining when to use this template.

max 1000 Zeichennullable
defaultValuesobjectoptional

Default values that the consumer copies into the new component/record. Shape depends on `appliesTo`: contractual templates carry calculation/recurrence/percentage/payoutMonth/taxable; record templates carry kind-specific hints (e.g. periodMonths for recurring commissions).

isActivebooleanoptional

Soft-disable without deletion — inactive templates stay searchable for history.

Default: true
sortOrderintegeroptional

Optional manual ordering inside the picker. Lower = higher in the list.

0 – 9999nullable

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

Suche