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

Employment Contract Schema

Schema-ID
employment_contract
Collection
employment_contracts
Permissions
  • Lesenemployment_contract_view
  • Anlegenemployment_contract_create
  • Ändernemployment_contract_edit
  • Löschenemployment_contract_delete

Felder

Employment Contract Schema

employment_contracts4 Permissions

Schema for versioned employment contracts (Arbeitsverträge)

employeeProfileIduuiderforderlich

UUID of the employee_profile this contract version belongs to

revisionintegererforderlich

Sequential contract revision per employee (1 = initial contract, 2 = first amendment, ...)

≥ 1read-only
effectiveFromdateerforderlich

First day on which this version is in effect (YYYY-MM-DD)

effectiveUntildateoptional

Last day this version is in effect. null on the currently active version. Set automatically when a new version is created.

read-onlynullable
supersededByuuidoptional

UUID of the employment_contract that supersedes this one

read-onlynullable
supersededAtdatetimeoptional

When this version was superseded

read-onlynullable
changeReasonstringoptional

Free-text reason for this contract change (e.g. "Gehaltserhöhung 2026", "Wechsel auf 30h"). Required when creating a v>=2.

max 500 Zeichennullable
contractTypestringerforderlich

Permanent (unbefristet), fixed-term (befristet), or other forms

PERMANENTFIXED_TERMTEMPORARYTRAININGINTERNSHIP
contractEndDatedateoptional

End date of the contract (only set for FIXED_TERM/TEMPORARY)

nullable
probationEndDatedateoptional

End of probation period (Probezeit). null if no probation.

nullable
noticePeriodDaysintegeroptional

Notice period in days (Kündigungsfrist), null = legal default

0 – 730nullable
roleDescriptionstringoptional

Free-text role description (Tätigkeitsbeschreibung)

max 5000 Zeichennullable
positionTitlestringoptional

Job title for this contract version (Stellenbezeichnung)

max 200 Zeichennullable
workingTimeModelstringerforderlich

Working-time model for this contract

FULL_TIMEPART_TIMEMINI_JOBWORKING_STUDENTINTERNFREELANCER
weeklyHoursnumberoptional

Contracted weekly hours

0 – 168nullable
workingTimeModelIduuidoptional

Reference to a working_time_model entity (shift pattern, flex windows, ...)

nullable
vacationDaysPerYearnumberoptional

Annual vacation entitlement in days

0 – 365nullable
encryptedFieldsobjectoptional

Map of field-name → encrypted envelope. Encrypted client-side with the employee DEK; the server never sees plaintext. See EMPLOYMENT_CONTRACT_ZK_FIELDS for the registered field set and their visibility category.

nullable
statusstringoptional

DRAFT = work in progress, ACTIVE = currently in force, SUPERSEDED = replaced by newer version, TERMINATED = employment ended

DRAFTACTIVESUPERSEDEDTERMINATED
Default: "DRAFT"read-only
signedDocumentIduuidoptional

UUID of the dms_document containing the signed PDF of this contract version

nullable
attachmentDocumentIdsuuid[]optional

Additional dms_document IDs (annexes, side letters)

Default: []nullable
notesstringoptional

Free-text internal notes

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

Suche