Available Domains
The Canonical Data Model contains 22 domains, each representing a business entity. This page lists every domain with its description, key fields, and common use cases.
Core Business Domains
Vehicle
The central entity in automotive integrations. Represents a single vehicle across all systems.
| Field |
Type |
Required |
PII |
Description |
vin |
String |
Yes |
None |
17-character Vehicle Identification Number |
make |
String |
No |
None |
Vehicle manufacturer (e.g., Mercedes-Benz, Honda) |
model |
String |
No |
None |
Vehicle model name (e.g., C-Class, Accord) |
year |
Integer |
No |
None |
Model year |
trim |
String |
No |
None |
Trim level (e.g., AMG, Sport) |
body_class |
String |
No |
None |
Body type (Sedan, SUV, Truck) |
engine_type |
String |
No |
None |
Engine description |
fuel_type |
String |
No |
None |
Fuel type (Petrol, Diesel, Electric, Hybrid) |
transmission |
String |
No |
None |
Transmission type |
exterior_colour |
String |
No |
None |
Exterior colour |
interior_colour |
String |
No |
None |
Interior colour |
mileage_km |
Number |
No |
None |
Current odometer reading in kilometres |
status |
String |
No |
None |
Current status (In Stock, Sold, In Transit, etc.) |
stock_number |
String |
No |
None |
Dealer stock number |
first_registration_date |
DateTime |
No |
None |
Date of first registration |
list_price |
Number |
No |
None |
Listed price |
currency |
String |
No |
None |
Price currency (ISO 4217) |
Maps from/to: OEM portals, DMS inventory, CRM assets, finance collateral, telematics devices
Customer
Represents a customer or contact across all systems.
| Field |
Type |
Required |
PII |
Description |
customer_id |
String |
Yes |
None |
Unique customer identifier |
customer_name |
String |
No |
PII |
Full name |
first_name |
String |
No |
PII |
First name |
last_name |
String |
No |
PII |
Last name |
email |
String |
No |
PII |
Email address |
phone |
String |
No |
PII |
Phone number |
address_line_1 |
String |
No |
PII |
Street address |
city |
String |
No |
PII |
City |
state_province |
String |
No |
PII |
State or province |
postal_code |
String |
No |
PII |
Postal/ZIP code |
country |
String |
No |
None |
Country (ISO 3166) |
customer_type |
String |
No |
None |
Individual, Business, Fleet |
created_date |
DateTime |
No |
None |
When the customer record was created |
Maps from/to: CRM contacts, DMS customers, finance borrowers
Order
Represents a sales or purchase order.
| Field |
Type |
Required |
PII |
Description |
order_id |
String |
Yes |
None |
Unique order identifier |
order_date |
DateTime |
No |
None |
When the order was placed |
customer_id |
String |
No |
None |
Reference to Customer domain |
vin |
String |
No |
None |
Reference to Vehicle domain |
order_type |
String |
No |
None |
Purchase, Lease, Trade-In |
total_amount |
Number |
No |
None |
Total order value |
currency |
String |
No |
None |
Currency (ISO 4217) |
status |
String |
No |
None |
Pending, Confirmed, Completed, Cancelled |
Maps from/to: DMS sales, CRM opportunities, finance applications
Workshop Job
Represents a service or repair job.
| Field |
Type |
Required |
PII |
Description |
job_id |
String |
Yes |
None |
Unique job identifier |
vin |
String |
No |
None |
Vehicle being serviced |
customer_id |
String |
No |
None |
Customer who owns the vehicle |
job_type |
String |
No |
None |
Scheduled Service, Repair, Recall, Inspection |
description |
String |
No |
None |
Job description |
status |
String |
No |
None |
Open, In Progress, Completed, Invoiced |
scheduled_date |
DateTime |
No |
None |
Scheduled date |
completed_date |
DateTime |
No |
None |
Completion date |
labour_hours |
Number |
No |
None |
Total labour hours |
total_cost |
Number |
No |
None |
Total job cost |
Maps from/to: DMS service, OEM warranty, parts catalogues
Part
Represents a part or component.
| Field |
Type |
Required |
PII |
Description |
part_number |
String |
Yes |
None |
Unique part identifier |
part_name |
String |
No |
None |
Part description |
manufacturer |
String |
No |
None |
Part manufacturer |
category |
String |
No |
None |
Part category (Engine, Body, Electrical, etc.) |
unit_price |
Number |
No |
None |
Price per unit |
quantity_in_stock |
Integer |
No |
None |
Current stock level |
reorder_point |
Integer |
No |
None |
Minimum stock before reorder |
compatible_vins |
String[] |
No |
None |
Compatible vehicle VINs or patterns |
Maps from/to: Parts catalogues, DMS parts inventory, OEM parts orders
Lead
Represents a sales lead or opportunity.
| Field |
Type |
Required |
PII |
Description |
lead_id |
String |
Yes |
None |
Unique lead identifier |
customer_name |
String |
No |
PII |
Prospect name |
email |
String |
No |
PII |
Contact email |
phone |
String |
No |
PII |
Contact phone |
source |
String |
No |
None |
Lead source (Web, Walk-in, Referral, etc.) |
interest_type |
String |
No |
None |
New, Used, Service, Trade-In |
interest_make |
String |
No |
None |
Preferred make |
interest_model |
String |
No |
None |
Preferred model |
status |
String |
No |
None |
New, Contacted, Qualified, Converted, Lost |
assigned_to |
String |
No |
None |
Sales representative |
created_date |
DateTime |
No |
None |
When the lead was created |
Maps from/to: CRM leads, website forms, DMS prospect lists
Operational Domains
Vehicle Inspection
| Key Fields |
inspection_id, vin, inspection_type, result, inspector_name, inspection_date |
| Use Case |
Pre-delivery inspections, used vehicle appraisals, regulatory inspections |
Appointment
| Key Fields |
appointment_id, customer_id, appointment_type, scheduled_datetime, status, location |
| Use Case |
Service appointments, sales consultations, test drives |
Shipment
| Key Fields |
shipment_id, vin, origin, destination, carrier, status, estimated_delivery |
| Use Case |
Vehicle transport, parts delivery, inter-dealer transfers |
Location
| Key Fields |
location_id, location_name, address, location_type, latitude, longitude |
| Use Case |
Dealership locations, warehouses, service centres |
Parking Event
| Key Fields |
event_id, vin, location_id, arrival_time, departure_time, bay_number |
| Use Case |
Yard management, lot inventory tracking |
Vehicle Location
| Key Fields |
vin, latitude, longitude, timestamp, speed_kmh, heading, source |
| Use Case |
Real-time fleet tracking, geofencing, route history |
Financial Domains
Deal
| Key Fields |
deal_id, customer_id, vin, deal_type, sale_price, trade_in_value, gross_profit, deal_date |
| Use Case |
Completed vehicle sales, finance deal structuring |
Finance Agreement
| Key Fields |
agreement_id, customer_id, vin, agreement_type, principal, interest_rate, term_months, monthly_payment |
| Use Case |
Loan origination, lease contracts, payment tracking |
Payroll Run
| Key Fields |
payroll_id, employee_id, period_start, period_end, gross_pay, deductions, net_pay |
| Use Case |
Commission calculations, payroll processing |
Employee
| Key Fields |
employee_id, employee_name (PII), role, department, hire_date, status |
| Use Case |
Staff directories, performance tracking, commission assignment |
Recycling & End-of-Life Domains
EOL Vehicle
| Key Fields |
eol_id, vin, deregistration_date, reason, dismantler_id, location_id |
| Use Case |
End-of-life vehicle tracking, regulatory reporting |
Auction Transaction
| Key Fields |
auction_id, vin, auction_house, sale_price, buyer_id, auction_date, condition_grade |
| Use Case |
Wholesale vehicle auctions, trade-in remarketing |
Title Record
| Key Fields |
title_id, vin, owner_name (PII), title_state, lien_holder, issue_date |
| Use Case |
Vehicle title processing, lien management |
Recycler Part
| Key Fields |
recycler_part_id, part_number, source_vin, condition, price, recycler_id |
| Use Case |
Salvage parts inventory, recycler catalogues |
Depollution Record
| Key Fields |
depollution_id, vin, fluids_removed, hazmat_disposed, completion_date, operator_id |
| Use Case |
Environmental compliance, depollution certification |
Compliance Check
| Key Fields |
check_id, vin, check_type, result, authority, check_date, next_due_date |
| Use Case |
MOT checks, emissions testing, safety inspections |
Cross-Domain References
Many domains reference each other through shared identifiers:
| Reference |
Connects |
vin |
Vehicle to Order, Workshop Job, Shipment, Location, Finance Agreement, etc. |
customer_id |
Customer to Order, Lead, Appointment, Deal, Finance Agreement |
location_id |
Location to Parking Event, Shipment, Vehicle Location |
employee_id |
Employee to Payroll Run, Workshop Job (assigned technician) |
These references enable cross-domain queries and reporting through the Canonical Explorer.
Next Steps