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

Employee Supplier Contract Schema

Schema-ID
employee_supplier_contract
Collection
employee_supplier_contracts
Permissions
  • Lesenemployee_supplier_contract_view
  • Anlegenemployee_supplier_contract_create
  • Ändernemployee_supplier_contract_edit
  • Löschenemployee_supplier_contract_delete

Felder

Employee Supplier Contract Schema

employee_supplier_contracts4 Permissions

Lieferantenvertrag (ADR 0115), der einem Mitarbeiter zugeordnet ist und dessen Lifecycle aktiv überwacht wird. Renewal-Reminder via escalation_rule (ADR 0085).

employeeProfileIduuiderforderlich
kindstringerforderlich

Vertrags-Kategorie. CUSTOM via OTHER mit klarer notes-Beschreibung.

Werte
TELECOM_MOBILETELECOM_INTERNETGEZJOB_TICKETDEUTSCHLANDTICKETBAHNCARDGYM_MEMBERSHIPINSURANCE_GROUPSUBSCRIPTIONOTHER
vendorPartyIduuiderforderlich

Lieferanten-Party-Datensatz (z.B. „Telekom Deutschland GmbH"). Existing party-Modell wiederverwendet.

equipmentAssignmentIduuidoptional

Optionaler Bezug auf Equipment, z.B. SIM-Karte → Smartphone.

nullable
contractNumberstringerforderlich

Lieferanten-Vertragsnummer.

1–100 Zeichen
providerstringoptional

Marken-/Tarif-Name, falls abweichend von vendor (z.B. „congstar" mit vendor Telekom).

max 200 Zeichennullable
startDatedateerforderlich
endDatedateoptional

Festes Vertragsende. Null bei laufender Vertragsbeziehung mit autoRenew.

nullable
initialTermMonthsintegeroptional

Mindestlaufzeit in Monaten ab startDate.

0 – 600nullable
autoRenewbooleanoptional

Verlängert sich automatisch ohne Kündigung.

Default: false
renewalTermMonthsintegeroptional

Bei autoRenew=true: um wieviele Monate verlängert sich der Vertrag.

0 – 600nullable
terminationNoticeDaysintegeroptional

Kündigungsfrist in Tagen vor endDate / Renewal-Stichtag.

0 – 730nullable
monthlyCostnumberoptional

Monatliche Kosten brutto in EUR.

≥ 0nullable
totalCostnumberoptional

Gesamtkosten in EUR (bei ONE_TIME oder vertraglich gedeckelt).

≥ 0nullable
paymentIntervalstringoptional
Werte
MONTHLYQUARTERLYSEMI_ANNUALANNUALONE_TIME
nullable
costAllocationstringoptional

Wer trägt die Kosten? EMPLOYEE_REIMBURSED = MA hat eigenen Vertrag, AG erstattet (typisch bei privatem Handyvertrag + Pauschale → flankiert durch compensation_record/contractualComponent). EMPLOYEE_SUBSIDIZED = AG bezuschusst, Restbetrag per Gehaltsumwandlung.

Werte
EMPLOYER_PAYSEMPLOYEE_REIMBURSEDEMPLOYEE_SUBSIDIZED
Default: "EMPLOYER_PAYS"
specificsobjectoptional

Kind-spezifische Felder (Map). Validierung erfolgt server-seitig pro kind. Beispiele: TELECOM_MOBILE → { phoneNumber, simIccid, tariff, dataVolumeGB, includedMinutes, eulocation }; JOB_TICKET → { zoneId, validUntil, ticketNumber }; DEUTSCHLANDTICKET → { ticketNumber, validUntil }; BAHNCARD → { type: "25"|"50"|"100", class: "1"|"2", cardNumber }; GYM_MEMBERSHIP → { studio, contractTier }.

nullable
attachmentDocumentIdsuuid[]optional

FKs auf dms_documents (Vertrags-PDF, AGB, Rechnungs-Kopien).

max 20 ItemsDefault: []
renewalReminderDaysinteger[]optional

Tage vor endDate/Renewal-Stichtag, an denen Reminder feuern sollen, z.B. [60, 30, 14]. Brücke zum escalation_rule-System (ADR 0085) — Cron prüft täglich und erzeugt Tasks.

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

Suche