Uses the Component:VehicleInvoiceVehicleLineItemType
Detail information regarding a vehicle for a particular invoice.
Table 6.40. Fields and Components
Name | Description | Occurrence | Type | Data Type | User Notes |
---|---|---|---|---|---|
Vehicle |
Common vehicle component | 0..1 | Component | VehicleABIEType | |
BrandedInfo |
Vehicle Branding Information | 0..1 | Component | BrandedInfoType | |
OriginalSoldDate |
The date the item, e.g., a vehicle, engine, boat, part, etc. was sold. | 0..1 | Field | udt:DateType | |
DeliveryDistanceMeasure |
Odometer reading of vehicle at time of delivery | 0..1 | Field | sqdt:LengthMeasureType | |
DoorKeyNumberString |
Door Key Number | 0..1 | Field | qdt:StringType | |
IgnitionKeyNumberString |
Vehicle Ignition Key Number | 0..1 | Field | qdt:StringType | |
NonUSVehicleIndicator |
Indicates whether the vehicle was produced for the United States or not | 0..1 | Field | udt:IndicatorType | |
OdometerStatus |
Status of odometer at trade-in. Example:: Replaced, Tampered, Miles> 90,000, etc. | 0..1 | Field | udt:TextType | |
OwnerParty |
The owner of a vehicle, boat, engine, truck, trailer, or other item. | 0..1 | Component | PartyABIEType | |
RestrictionIndicator |
Indication that vehicle has restrictions on its use | 0..1 | Field | udt:IndicatorType | |
RestrictionDescription |
Description of vehicle use restrictions | 0..1 | Field | udt:TextType | |
ShipToParty |
The party receiving the goods or services. | 0..1 | Component | PartyABIEType | |
SoldToParty |
The party to which good or services were sold. | 0..1 | Component | PartyABIEType | |
TelematicsServiceIndicator |
Indication whether Telematics Service Subscription is turned on | 0..1 | Field | udt:IndicatorType | |
VehicleAllocatedDate |
Date vehicle was allocated and/or a delivery work order was cut | 0..1 | Field | udt:DateType | |
VehicleDemoIndicator |
Indicates whether vehicle was ever a demo | 0..1 | Field | udt:IndicatorType | |
VehicleOrderNumber |
Vehicle Order Number (VON) | 0..1 | Field | udt:TextType | |
VehicleShipDate |
Date shipped from warehouse or distribution center | 0..1 | Field | udt:DateType | |
VehicleStockString |
Dealer assigned vehicle stock number | 0..1 | Field | qdt:StringType | |
Pricing |
Provides pricing infomation. | 0..* | Component | PricingABIEType | |
Tax |
The Tax component represents information about a particular tax including information about the type of tax and the amount of the tax. | 0..* | Component | TaxType | |
FleetAccount | 0..1 | Component | FleetAccountType | ||
LicenseNumberString |
State License plate number of vehicle | 0..1 | Field | qdt:StringType | |
VehicleStatusCode |
Vehicle status code - Example status could be Built, Scheduled, Shipped, In-Transit, Sold, etc. | 0..1 | Field | udt:CodeType | |
PresellID |
Prohibit dealers from pre-selling cars that have not yet been ordered | 0..1 | Field | udt:IdentifierType | |
Option |
The Option represents information about a vehicle's options. | 0..* | Component | OptionABIEType | |
oagis:Note |
Free-form text field describing a note. | 0..* | Field | udt:TextType | |
VehicleOrderTypeDescription |
Order type in description format example “Retail - Stock” “Retail – Sold” “Fleet” | 0..1 | Field | udt:TextType | |
VehicleOrderType |
Vehicle Order Management code used to classify dealer order type example “TRE”, “SRE”, “FDR”, | 0..1 | Field | udt:TextType | |
IncludeInvoiceDocText |
Invoice request parameter for including Invoice document text in response, default value is False True indicates the Invoice document is included in response. False indicates the Invoice document is not included in response. | 0..1 | Field | udt:IndicatorType | |
DocumentIdentificationGroup |
A group of identifications that uniquely identifies this document | 0..1 | Component | DocumentIdentificationGroupType | |
DocumentReferenceIdentificationGroup |
A group of identifications that uniquely identifies this document | 0..1 | Component | DocumentReferenceIdentificationGroupType | |
OrderQuantity |
Quantity Ordered. | 0..1 | Field | udt:QuantityType |
The XML Sample provided here is an approximation of the generated XML for this component. Not all of the fields are required for implementation.
Example 6.40. VehicleInvoiceVehicleLineItem
<VehicleInvoiceVehicleLineItem> <Vehicle>......</Vehicle> [0..1] <BrandedInfo>......</BrandedInfo> [0..1] <OriginalSoldDate>......</OriginalSoldDate> [0..1] <DeliveryDistanceMeasure>......</DeliveryDistanceMeasure> [0..1] <DoorKeyNumberString>......</DoorKeyNumberString> [0..1] <IgnitionKeyNumberString>......</IgnitionKeyNumberString> [0..1] <NonUSVehicleIndicator>......</NonUSVehicleIndicator> [0..1] <OdometerStatus>......</OdometerStatus> [0..1] <OwnerParty>......</OwnerParty> [0..1] <RestrictionIndicator>......</RestrictionIndicator> [0..1] <RestrictionDescription>......</RestrictionDescription> [0..1] <ShipToParty>......</ShipToParty> [0..1] <SoldToParty>......</SoldToParty> [0..1] <TelematicsServiceIndicator>......</TelematicsServiceIndicator> [0..1] <VehicleAllocatedDate>......</VehicleAllocatedDate> [0..1] <VehicleDemoIndicator>......</VehicleDemoIndicator> [0..1] <VehicleOrderNumber>......</VehicleOrderNumber> [0..1] <VehicleShipDate>......</VehicleShipDate> [0..1] <VehicleStockString>......</VehicleStockString> [0..1] <Pricing>......</Pricing> [0..*] <Tax>......</Tax> [0..*] <FleetAccount>......</FleetAccount> [0..1] <LicenseNumberString>......</LicenseNumberString> [0..1] <VehicleStatusCode>......</VehicleStatusCode> [0..1] <PresellID>......</PresellID> [0..1] <Option>......</Option> [0..*] <oagis:Note>......</oagis:Note> [0..*] <VehicleOrderTypeDescription>......</VehicleOrderTypeDescription> [0..1] <VehicleOrderType>......</VehicleOrderType> [0..1] <IncludeInvoiceDocText>......</IncludeInvoiceDocText> [0..1] <DocumentIdentificationGroup>......</DocumentIdentificationGroup> [0..1] <DocumentReferenceIdentificationGroup>......</DocumentReferenceIdentificationGroup> [0..1] <OrderQuantity>......</OrderQuantity> [0..1] </VehicleInvoiceVehicleLineItem>