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

Vehicle Contract Schema

Schema-ID
vehicle_contract
Collection
vehicle_contracts
Permissions
  • Lesenvehicle_contract_view
  • Anlegenvehicle_contract_create
  • Ändernvehicle_contract_edit
  • Löschenvehicle_contract_delete

Felder

Vehicle Contract Schema

vehicle_contracts4 Permissions

Schema for validating vehicle contract / Fahrzeugvertrag entities

vehicleIduuiderforderlich

Reference to the vehicle

contractTypestringerforderlich

Type of contract / Vertragsart

Werte
LEASINGINSURANCEMAINTENANCEFINANCINGRENTALSERVICEOTHER
contractNumberstringerforderlich

Contract number / Vertragsnummer

1–100 Zeichen
providerstringerforderlich

Contract partner / Vertragspartner

1–200 Zeichen
startDatedateerforderlich

Contract start date / Vertragsbeginn

endDatedateoptional

Contract end date / Vertragsende

nullable
monthlyCoststringoptional

Monthly cost in EUR / Monatliche Kosten

Patternnullable
totalCoststringoptional

Total contract value in EUR / Gesamtkosten

Patternnullable
paymentIntervalstringoptional

Payment interval / Zahlungsintervall

Werte
MONTHLYQUARTERLYSEMI_ANNUALANNUALONE_TIME
nullable
mileageLimitnumberoptional

Annual mileage limit in km (leasing) / Jährliche Kilometergrenze

≥ 0nullable
startMileageKmnumberoptional

Vehicle mileage at contract start / Kilometerstand bei Vertragsbeginn

≥ 0nullable
excessMileageCostPerKmstringoptional

Cost per excess km in EUR / Mehrkilometerkosten pro km

Patternnullable
depositAmountstringoptional

Deposit / Kaution in EUR

Patternnullable
noticePeriodDaysnumberoptional

Notice period in days / Kündigungsfrist in Tagen

≥ 0nullable
autoRenewalbooleanoptional

Auto-renewal / Automatische Verlängerung

Default: falsenullable
statusstringoptional

Contract status / Vertragsstatus

Werte
ACTIVEPENDINGEXPIREDCANCELLED
Default: "ACTIVE"
descriptionstringoptional

Contract description / Vertragsbeschreibung

max 2000 Zeichennullable
attachmentIdsstring[]optional

Attached document IDs (contract PDFs, etc.)

Default: []
notesstringoptional

Additional notes / Bemerkungen

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

Suche