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

Compensation Record Schema

Schema-ID
compensation_record
Collection
compensation_records
Permissions
  • Lesencompensation_record_view
  • Anlegencompensation_record_create
  • Änderncompensation_record_edit
  • Löschencompensation_record_delete

Felder

Compensation Record Schema

compensation_records4 Permissions

Outside-of-contract compensation events (ADR 0114): spot bonuses, commissions, off-cycle adjustments. ZK fields stored in encryptedFields.

employeeProfileIduuiderforderlich

FK to employee_profiles.

contractIduuidoptional

Optional FK to the employment_contract version that was active when this record was created. Used by reporting to attribute the payout.

nullable
kindstringerforderlich

Payout category. CUSTOM requires a non-empty note via encryptedFields.

Werte
SPOT_BONUSSIGN_ON_BONUSRETENTION_BONUSKPI_BONUSCOMMISSION_PAYOUTOFF_CYCLE_ADJUSTMENTOVERTIME_PAYOUTONE_TIMESEVERANCESETTLEMENTCUSTOM
encryptedFieldsobjectoptional

ZK envelope keyed by field name. Allowed keys: `amount` (JSON: { amount, currency }), `note`. Server validates against COMPENSATION_RECORD_ZK_FIELDS allowlist.

nullable
payoutDatedateoptional

Actual or scheduled payout date (ISO 8601).

nullable
periodStartdateoptional

For COMMISSION_PAYOUT / OVERTIME_PAYOUT: start of the accounting period.

nullable
periodEnddateoptional

For COMMISSION_PAYOUT / OVERTIME_PAYOUT: end of the accounting period.

nullable
payrollMonthstringoptional

YYYY-MM marker for the payroll run that should pick up this record. Decouples payoutDate (when the employee gets paid) from payrollMonth (which Lohnabrechnung carries the entry).

Patternnullable
statusstringerforderlich

Workflow status. State machine enforced server-side.

Werte
DRAFTPENDING_APPROVALAPPROVEDPAIDVOIDED
Default: "DRAFT"read-only
approvalRequestIduuidoptional

FK to approval_requests when an approval workflow is active.

read-onlynullable
approverUserIduuidoptional

User who approved (last in chain). Set together with approvedAt.

read-onlynullable
approvedAtdatetimeoptional
read-onlynullable
paidAtdatetimeoptional

When the payout was confirmed in payroll. Plain — not sensitive on its own.

read-onlynullable
templateIduuidoptional

Optional FK to compensation_component_template (appliesTo: RECORD).

nullable
referenceNumberstringoptional

Optional external reference (commission run id, settlement case number, etc.) — searchable in the records list.

max 80 Zeichennullable

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

Suche