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

Vehicle Schema

Schema-ID
vehicle
Collection
vehicles
Permissions
  • Lesenvehicle_view
  • Anlegenvehicle_create
  • Ändernvehicle_edit
  • Löschenvehicle_delete

Felder

Vehicle Schema

vehicles4 Permissions

Schema for validating vehicle / Fahrzeug entities

licensePlatestringoptional

Vehicle license plate number (Kennzeichen)

max 20 Zeichennullable
vinstringoptional

Vehicle Identification Number (FIN)

max 17 Zeichennullable
makestringerforderlich

Manufacturer / Hersteller

1–100 Zeichen
modelstringerforderlich

Vehicle model

1–100 Zeichen
yearintegeroptional

Year of manufacture

1900 – 2100nullable
colorstringoptional

Vehicle color

max 50 Zeichennullable
displayNamestringoptional

Display name / Anzeigename

max 200 Zeichennullable
internalIdstringoptional

Internal identifier (e.g. fleet number)

max 100 Zeichennullable
additionalNumberstringoptional

Additional reference number

max 100 Zeichennullable
vehicleTypestringoptional

Vehicle type classification

PKWTRANSPORTERLKWMOTORRADANHAENGEROTHER
Default: "PKW"
acquisitionModestringoptional

How this vehicle entered the fleet: EXISTING (already on site/in use), PROCUREMENT (ordered, not yet delivered), VIRTUAL (no physical vehicle — used as a cost target for fleet-wide expenses)

EXISTINGPROCUREMENTVIRTUAL
Default: "EXISTING"
fuelTypestringoptional

Fuel / drive type

BENZINDIESELELEKTROHYBRID_BENZINHYBRID_DIESELERDGASWASSERSTOFFOTHER
nullable
organizationstringoptional

Owning organization / Gesellschaft

max 200 ZeichenDefault: "IT Fabrik"nullable
subsidiarystringoptional

Subsidiary / Niederlassung

max 200 Zeichennullable
costCenterstringoptional

Cost center / Kostenstelle

max 100 Zeichennullable
locationIdstringoptional

Reference to a location entity (Standort)

1–200 Zeichennullable
locationNamestringoptional

Denormalized location name for display

max 200 Zeichennullable
internalOrderNumberstringoptional

Internal order number / Interne Auftragsnummer

max 100 Zeichennullable
licenseNumberstringoptional

License number / Zulassungsnummer

max 100 Zeichennullable
firstRegistrationDatedateoptional

Date of first registration / Erstzulassung

nullable
commissioningDatedateoptional

Date of commissioning / Inbetriebnahme

nullable
registrationCountrystringoptional

Country of registration / Zulassungsland

max 100 Zeichennullable
licensePlateColorstringoptional

License plate color (e.g. standard, green, electric)

max 50 Zeichennullable
interiorColorstringoptional

Interior color / Innenfarbe

max 100 Zeichennullable
upholsteryColorstringoptional

Upholstery color / Polsterfarbe

max 100 Zeichennullable
engineDisplacementCcmintegeroptional

Engine displacement in ccm / Hubraum

≥ 0nullable
powerKwnumberoptional

Engine power in kW / Leistung

≥ 0nullable
transmissionTypestringoptional

Transmission type / Getriebe

MANUALAUTOMATICDSGCVTOTHERnull
nullable
emissionStandardstringoptional

Emission standard / Abgasnorm

EURO_1EURO_2EURO_3EURO_4EURO_5EURO_6EURO_6DEURO_6D_TEMPEURO_7OTHERnull
nullable
co2EmissionGkmnumberoptional

CO2 emissions in g/km

≥ 0nullable
annualVehicleTaxnumberoptional

Annual vehicle tax in EUR / Kfz-Steuer

≥ 0nullable
annualVehicleTaxSourcestringoptional

Source of vehicle tax information

max 100 Zeichennullable
grossListPricenumberoptional

Gross list price in EUR / Bruttolistenpreis

≥ 0nullable
batteryCapacityKwhnumberoptional

Battery capacity in kWh (electric/hybrid vehicles)

≥ 0nullable
consumptionCombinednumberoptional

Combined fuel/energy consumption

≥ 0nullable
consumptionCitynumberoptional

City fuel/energy consumption

≥ 0nullable
consumptionHighwaynumberoptional

Highway fuel/energy consumption

≥ 0nullable
consumptionUnitstringoptional

Consumption unit (e.g. l/100km, kWh/100km)

max 50 Zeichennullable
curbWeightKgnumberoptional

Curb weight in kg / Leergewicht

≥ 0nullable
payloadKgnumberoptional

Payload in kg / Zuladung

≥ 0nullable
grossWeightKgnumberoptional

Gross vehicle weight in kg / Zulässiges Gesamtgewicht

≥ 0nullable
trainWeightKgnumberoptional

Train weight in kg / Zulässige Gesamtmasse des Zuges

≥ 0nullable
towingCapacityKgnumberoptional

Towing capacity in kg / Anhängelast

≥ 0nullable
standardEquipmentstring[]optional

Standard equipment list / Serienausstattung

Default: []nullable
specialEquipmentstring[]optional

Special equipment list / Sonderausstattung

Default: []nullable
tireStorageLocationstringoptional

Tire storage location / Reifenlagerort

max 200 Zeichennullable
statusstringoptional

Current vehicle status

DRAFTACTIVEMAINTENANCEDECOMMISSIONEDRESERVED
Default: "ACTIVE"
currentMileageKmnumberoptional

Current mileage in kilometers

≥ 0nullable
isPoolVehiclebooleanoptional

Whether this is a pool vehicle (available for reservation) or permanently assigned to an employee

Default: false
poolGroupstringoptional

Optional pool group tag (tenant-defined vehicle pools replace this field for filtering)

nullable
assignedDriverIduuidoptional

Assigned driver user ID (relevant when isPoolVehicle=false)

nullable
assignedLocationIdstringoptional

Assigned company location identifier

max 200 Zeichennullable
ownershipTypestringoptional

Vehicle ownership type

OWNEDLEASEDRENTED
Default: "OWNED"
leaseDetailsobjectoptional
nullable
providerstringoptional

Leasing provider

max 200 Zeichen
contractNumberstringoptional

Lease contract number

max 100 Zeichennullable
startDatedateoptional

Lease start date

endDatedateoptional

Lease end date

nullable
monthlyCoststringoptional

Monthly lease cost in EUR

Patternnullable
totalLeasingKmintegeroptional

Total allowed kilometers over lease term

≥ 0nullable
residualValuestringoptional

Residual value at end of lease in EUR

Patternnullable
excessKmRatestringoptional

Cost per excess kilometer in EUR (Mehrkilometer)

Patternnullable
shortfallKmRatestringoptional

Credit per shortfall kilometer in EUR (Minderkilometer)

Patternnullable
depositAmountstringoptional

Leasing deposit / Sonderzahlung in EUR

Patternnullable
contractIduuidoptional

Reference to linked contract entity

nullable
insuranceobjectoptional
nullable
companystringoptional

Insurance company

max 200 Zeichen
policyNumberstringoptional

Insurance policy number

max 100 Zeichennullable
typestringoptional

Insurance type

HAFTPFLICHTTEILKASKOVOLLKASKO
validFromdateoptional

Insurance valid from date

validUntildateoptional

Insurance valid until date

nullable
registrationobjectoptional
nullable
registrationDatedateoptional

Vehicle registration date

nullable
nextHuDatedateoptional

Next Hauptuntersuchung (HU/TUV) date

nullable
nextAuDatedateoptional

Next Abgasuntersuchung (AU) date

nullable
emissionStickerstringoptional

Emission sticker type (Feinstaubplakette)

NONEGREENYELLOWRED
nullable
inspectionScheduleobjectoptional
nullable
lastInspectionDatedateoptional

Last inspection date

nullable
nextDueDatedateoptional

Next inspection due date

nullable
intervalKmintegeroptional

Inspection interval in kilometers

≥ 0nullable
intervalMonthsintegeroptional

Inspection interval in months

≥ 0nullable
tiresobjectoptional
nullable
summerTiresobjectoptional
nullable
brandstringoptional
max 100 Zeichennullable
sizestringoptional
max 50 Zeichennullable
dotNumberstringoptional
max 20 Zeichennullable
treadDepthMmnumberoptional
≥ 0nullable
storageLocationstringoptional
max 200 Zeichennullable
winterTiresobjectoptional
nullable
brandstringoptional
max 100 Zeichennullable
sizestringoptional
max 50 Zeichennullable
dotNumberstringoptional
max 20 Zeichennullable
treadDepthMmnumberoptional
≥ 0nullable
storageLocationstringoptional
max 200 Zeichennullable
currentSetstringoptional

Currently mounted tire set

SUMMERWINTERALL_SEASON
nextChangeDatedateoptional

Next scheduled tire change date (YYYY-MM-DD)

nullable
ratePerKmstringoptional

Rate per kilometer in EUR (overrides global default)

Patternnullable
documentsobject[]optional
Default: []nullable
typestringerforderlich

Document type

REGISTRATIONINSURANCELEASESERVICETUVOTHER
titlestringerforderlich

Document title

max 200 Zeichen
attachmentIdstringerforderlich

Attachment file ID

uploadedAtdatetimeoptional

Upload timestamp

nullable
sharePointFolderIdstringoptional

Cached SharePoint folder ID (Graph driveItem ID) for this vehicle

max 200 Zeichennullable
notesstringoptional

Free-text notes

max 5000 Zeichennullable
tagsstring[]optional

Tags for categorization

Default: []

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

Suche