Service Item

Represents a service item available for a vehicle — includes its type (free/paid), status (pending/processed/expired), validity period, cost, claimability, and an HMAC signature for secure claiming.

Property Summary
Group
VehicleServiceItemGroup
The group this service item belongs to (for UI tab grouping).
ShowDocumentUploader
bool
Whether to show a document uploader when claiming this item.
Warnings
List<VehicleItemWarning>?
A list of warnings to display before claiming this item.
PrintUrl
string?
URL for printing the service item certificate.
DocumentUploaderIsRequired
bool
Whether the document uploader is required (not just shown) when claiming.
Name
string
The localized name of the service item.
Description
string
The localized description of the service item.
Title
string
The localized printout title.
Image
string
The localized image URL for the service item.
Type
string
The human-readable type label (e.g., "Free", "Paid").
TypeEnum
VehcileServiceItemTypes
The service item type as an enum value.
ActivatedAt
DateTime
The date this service item was activated for this vehicle.
ExpiresAt
DateTime?
The date this service item expires. Null if no expiration.
Status
string
The human-readable status label (e.g., "Pending", "Processed", "Expired").
StatusEnum
VehcileServiceItemStatuses
The service item status as an enum value.
CampaignID
long?
The ID of the campaign this item belongs to.
CampaignUniqueReference
string
The unique reference of the parent campaign.
PackageCode
string
The package code grouping related service items together.
Cost
decimal?
The cost of this service item for this vehicle.
ClaimDate
DateTimeOffset?
The date this item was claimed, if already claimed.
ModelCostID
long?
The model-specific cost ID used when costing type is 'Per Model'.
ServiceItemID
string
The unique identifier of the service item definition.
PaidServiceInvoiceLineID
string?
The paid service invoice line ID, if this is a paid service item.
CompanyName
string
The localized company name that performed or will perform the service.
InvoiceNumber
string
The invoice number associated with the claim.
JobNumber
string
The job number associated with the claim.
MaximumMileage
long?
The maximum mileage for sequential validity calculations.
Claimable
bool
Whether this service item can currently be claimed.
ClaimingMethodEnum
ClaimableItemClaimingMethod
The method used to claim this item (e.g., QR Code scan, Invoice + Job Number).
VehicleInspectionID
string
The vehicle inspection ID associated with this claim, if applicable.
VehicleInspectionTypeID
string
The vehicle inspection type ID required for claiming, if applicable.
Signature
string
The HMAC signature used to securely validate claim requests.
SignatureExpiry
DateTime
The UTC expiry time of the signature.