Uses the Component:RepairOrderHeaderType
Repair Order Header
Table 6.2. Fields and Components
Name | Description | Occurrence | Type | Data Type | User Notes |
---|---|---|---|---|---|
DocumentDateTime |
Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. | 0..1 | Field | udt:DateTimeType | |
SecondaryPassword |
Secondary password used to validate access to the dealer information | 0..1 | Field | udt:TextType | |
SecondaryDealerNumberID |
Identifies secondary dealer number if different than primary "Dealer Number" | 0..1 | Field | udt:IdentifierType | |
DocumentIdentificationGroup |
A group of identifications that uniquely identifies this document | 1..1 | Component | DocumentIdentificationGroupType | |
SecondaryReferenceNumberString |
Secondary Repair Order reference number | 0..1 | Field | qdt:StringType | |
DealerParty |
Represents a Dealer | 0..1 | Component | PartyABIEType | |
OwnerParty |
The owner of a vehicle, boat, engine, truck, trailer, or other item. | 0..1 | Component | PartyABIEType | |
Co-OwnerParty |
The co-owner of a veheicle, boat, engine, truck, trailer, or other item. | 0..1 | Component | PartyABIEType | |
PrimaryDriver |
The Primary Driver of a vehicle, boat, or other transportation item. | 0..1 | Component | PrimaryDriverType | |
SecondaryPrimaryDriver |
The Secondary Primary Driver of a vehicle, boat, or other transportation item. | 0..* | Component | PrimaryDriverType | |
RepairOrderVehicleLineItem |
Detail information regarding a vehicle for a particular repair order. Detail information regarding a vehicle for a particular repair order. Detail information regarding a vehicle for a particular repair order. | 0..1 | Component | RepairOrderVehicleLineItemType | |
RepairOrderIndependentVehicleComponentLineItem |
Detail information regarding a vehicle component that is independent from a VIN (vehicle), and the Repair Order is submitted wihout attached to a particularVIN | 0..1 | Component | RepairOrderIndependentVehicleComponentLineItemType | |
Warranty |
Warranty information associated with a vehicle. | 0..* | Component | WarrantyType | |
ServiceContract |
The ServiceContract component represents information about the extended service agreement on the vehicle. | 0..* | Component | ServiceContractType | |
CASE |
Customer arbitration information associated with job | 0..* | Component | CASEType | |
RepairOrderOpenedDate |
System date when Repair Order was opened | 0..1 | Field | udt:DateType | |
RepairOrderCompletedDate |
The date the last line was closed on the repair order | 0..1 | Field | udt:DateType | |
RepairOrderInvoiceDate |
The date the repair order transaction moves to accounting | 0..1 | Field | udt:DateType | |
ServiceAdvisorParty |
Represents the Service Advisor responsible for a repair, service appointment, etc. | 0..* | Component | PartyABIEType | |
InDistanceMeasure |
Odometer reading of vehicle when repair order was opened | 0..1 | Field | sqdt:LengthMeasureType | |
OutDistanceMeasure |
Odometer reading of vehicle when repair order was closed | 0..1 | Field | sqdt:LengthMeasureType | |
OrderNotes |
Free form text for general repair order comment which will be printed on the invoice | 0..1 | Field | udt:TextType | |
OrderInternalNotes |
Free form text for internal repair order remarks that will NOT be printed on the invoice | 0..1 | Field | udt:TextType | |
DepartmentType |
Identifies the type of department | 0..1 | Field | udt:TextType | |
RentLoaner |
Rent Loaner related to Warranty Claim | 0..* | Component | RentLoanerType | |
ServiceComponents |
Service Components associated with sublet(Miscellaneous, GasOilGrease, PaintMaterials, ShopSupplies and Freight | 0..* | Component | ServiceComponentsType | |
Sublet |
Sublet related to Warranty Claim | 0..* | Component | SubletType | |
LaborRateAmount | 0..1 | Field | udt:AmountType | ||
Price |
Price information | 0..* | Component | PriceABIEType | |
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 | |
DataCollectionStatus |
Indicates status of data for the record it appears on | 0..1 | Field | udt:IndicatorType | |
ESCFranchiseIndicator |
Extended Service Competitive (ESC) flag indicates if dealer has franchise for Extended Service Program (ESP) repair for competitive make | 0..1 | Field | udt:IndicatorType | |
Splits |
Splits assoicated with service component | 0..1 | Component | SplitsType | |
TreadActIndicator |
Transportation Recall Enhancement, Accountability, and Documentation (TREAD) Act (i.e., - Indicates if there has been fire damage) | 0..1 | Field | udt:IndicatorType | |
LocationID |
Code identifying a physical location | 0..1 | Field | udt:IdentifierType | |
RepairOrderStatus |
Indicates the status of a repair order. | 0..* | Component | ServiceContractStatusType | |
ReturnDisallowedPartsIndicator |
Overrides the default action for how the OEM handles parts when investigating a waranty claim. | 0..1 | Field | udt:IndicatorType | |
JobCountNumeric |
Identifies the total number of jobs | 0..1 | Field | udt:NumericType | |
LaborAllowanceHoursNumeric |
Flat rate labor hour allowance for this operation Depractated: Should use LaborAllowanceMeasure | 0..1 | Field | udt:NumericType | |
LaborActualHoursNumeric |
Actual hours required to complete job | 0..1 | Field | udt:NumericType | |
RepairOrderPriorityCode |
A code list that describes the priority of the repair order. | 0..1 | Field | udt:CodeType | |
PromisedRepairCompletionDate |
Date the repair completion was promised by | 0..1 | Field | udt:DateType | |
VehiclePickupDateTime |
Customer's request pick up date and time for the vehicle | 0..1 | Field | udt:DateTimeType | |
CustomerPaymentMethods |
How the customer is paying for the repairs | 0..* | Field | scl:PaymentMethodEnumeratedType | |
CustomerAppointmentFlag |
Indicator that the customer had an appointment for this vehicle. Vues are "True" or "False". | 0..1 | Field | udt:IndicatorType | |
ServiceLeadID |
The Service Lead that lead associated with this Repair Order | 0..1 | Field | udt:IdentifierType | |
CustomerAppointmentNumber |
Customer appointment number for this vehicle | 0..1 | Field | udt:TextType | |
RequestDateRange |
A date range that is used to request transactions belonging to a specific start and end date range. For example, to request RetailDeliveryReporting, PartsInvoice, RepairOrder transactions belonging to a date range. This component was implemented to facilitate third party - dealer integrations, however it can be used in other scenarios. | 0..* | Component | PeriodABIEType | |
CustomerDataProtectionStatement |
Exchange information about the customers permission regarding storage of workshop order information in the OEM system Allowed values are: “Yes - Customer agreement obtained” “No -Customer agreement refused” “Open - Awaiting customer agreement.” | 0..1 | Field | udt:CodeType | |
VehicleAcceptanceDate |
Date when the vehicle was accepted. | 0..1 | Field | udt:DateType | |
RepairStartDate |
Date when the repair started. | 0..1 | Field | udt:DateType | |
RepairEndDate |
The date the last line was closed on the repair order. | 0..1 | Field | udt:DateType | |
PromisedRepairCompletionDateTime |
Date and time value the repair completion was promised by. | 0..1 | Field | udt:DateTimeType | |
VehicleHatNumber |
Vehicle service tag or hat number. This is the identifier attached to the keys and vehicle, used to identify and track both, while in the care of the dealership. | 0..1 | Field | udt:IdentifierType | |
RepairOrderOpenedDateTime |
The date and time the repair order was first created. | 0..1 | Field | udt:DateTimeType | |
RepairOrderCompletedDateTime |
The date and time the repair order was completed. | 0..1 | Field | udt:DateTimeType | |
AppointmentType |
The method used to initiate an appointment. Example: "A" = Dealership Initiated by employees, other than the Service Advisor (e.g. first appointment), "I" = Internet, "P" = Phone, "S" = Service Advisor Initiated, "W" = Walk In, "U" = Unknown | 0..1 | Field | udt:TextType | |
AppointmentScheduledDateTime |
The date and time the customer contacted the service location for an appointment | 0..1 | Field | udt:DateTimeType | |
AdditionalWorkRequestedDateTime |
Date when additional work on the repair order has been requested by the customer. | 0..1 | Field | udt:DateTimeType | |
RepairOrderInvoiceDateTime |
Date and time when all charges have been applied to the repair order and the vehicle is ready to be picked up by the customer. | 0..1 | Field | udt:DateTimeType | |
DateAppointmentInitiated |
Date the customer contacted the ser- vice location for an appointment. | 0..1 | Field | udt:DateTimeType | |
PayerType |
Bill to party for Repair Order - type of party responsible for paying the invoice. Possible values: Customer, Dealer, Wholesaler, OEM, Insurance, Lessor. | 0..1 | Field | udt:TextType | |
ROType |
Stardard Repair Order Code. Possible values: Express, Fleet, Internal etc. | 0..* | Field | udt:CodeType |
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.2. RepairOrderHeader
<RepairOrderHeader> <DocumentDateTime>......</DocumentDateTime> [0..1] <SecondaryPassword>......</SecondaryPassword> [0..1] <SecondaryDealerNumberID>......</SecondaryDealerNumberID> [0..1] <DocumentIdentificationGroup>......</DocumentIdentificationGroup> [1..1] <SecondaryReferenceNumberString>......</SecondaryReferenceNumberString> [0..1] <DealerParty>......</DealerParty> [0..1] <OwnerParty>......</OwnerParty> [0..1] <Co-OwnerParty>......</Co-OwnerParty> [0..1] <PrimaryDriver>......</PrimaryDriver> [0..1] <SecondaryPrimaryDriver>......</SecondaryPrimaryDriver> [0..*] <RepairOrderVehicleLineItem>......</RepairOrderVehicleLineItem> [0..1] <RepairOrderIndependentVehicleComponentLineItem>......</RepairOrderIndependentVehicleComponentLineItem> [0..1] <Warranty>......</Warranty> [0..*] <ServiceContract>......</ServiceContract> [0..*] <CASE>......</CASE> [0..*] <RepairOrderOpenedDate>......</RepairOrderOpenedDate> [0..1] <RepairOrderCompletedDate>......</RepairOrderCompletedDate> [0..1] <RepairOrderInvoiceDate>......</RepairOrderInvoiceDate> [0..1] <ServiceAdvisorParty>......</ServiceAdvisorParty> [0..*] <InDistanceMeasure>......</InDistanceMeasure> [0..1] <OutDistanceMeasure>......</OutDistanceMeasure> [0..1] <OrderNotes>......</OrderNotes> [0..1] <OrderInternalNotes>......</OrderInternalNotes> [0..1] <DepartmentType>......</DepartmentType> [0..1] <RentLoaner>......</RentLoaner> [0..*] <ServiceComponents>......</ServiceComponents> [0..*] <Sublet>......</Sublet> [0..*] <LaborRateAmount>......</LaborRateAmount> [0..1] <Price>......</Price> [0..*] <Tax>......</Tax> [0..*] <DataCollectionStatus>......</DataCollectionStatus> [0..1] <ESCFranchiseIndicator>......</ESCFranchiseIndicator> [0..1] <Splits>......</Splits> [0..1] <TreadActIndicator>......</TreadActIndicator> [0..1] <LocationID>......</LocationID> [0..1] <RepairOrderStatus>......</RepairOrderStatus> [0..*] <ReturnDisallowedPartsIndicator>......</ReturnDisallowedPartsIndicator> [0..1] <JobCountNumeric>......</JobCountNumeric> [0..1] <LaborAllowanceHoursNumeric>......</LaborAllowanceHoursNumeric> [0..1] <LaborActualHoursNumeric>......</LaborActualHoursNumeric> [0..1] <RepairOrderPriorityCode>......</RepairOrderPriorityCode> [0..1] <PromisedRepairCompletionDate>......</PromisedRepairCompletionDate> [0..1] <VehiclePickupDateTime>......</VehiclePickupDateTime> [0..1] <CustomerPaymentMethods>......</CustomerPaymentMethods> [0..*] <CustomerAppointmentFlag>......</CustomerAppointmentFlag> [0..1] <ServiceLeadID>......</ServiceLeadID> [0..1] <CustomerAppointmentNumber>......</CustomerAppointmentNumber> [0..1] <RequestDateRange>......</RequestDateRange> [0..*] <CustomerDataProtectionStatement>......</CustomerDataProtectionStatement> [0..1] <VehicleAcceptanceDate>......</VehicleAcceptanceDate> [0..1] <RepairStartDate>......</RepairStartDate> [0..1] <RepairEndDate>......</RepairEndDate> [0..1] <PromisedRepairCompletionDateTime>......</PromisedRepairCompletionDateTime> [0..1] <VehicleHatNumber>......</VehicleHatNumber> [0..1] <RepairOrderOpenedDateTime>......</RepairOrderOpenedDateTime> [0..1] <RepairOrderCompletedDateTime>......</RepairOrderCompletedDateTime> [0..1] <AppointmentType>......</AppointmentType> [0..1] <AppointmentScheduledDateTime>......</AppointmentScheduledDateTime> [0..1] <AdditionalWorkRequestedDateTime>......</AdditionalWorkRequestedDateTime> [0..1] <RepairOrderInvoiceDateTime>......</RepairOrderInvoiceDateTime> [0..1] <DateAppointmentInitiated>......</DateAppointmentInitiated> [0..1] <PayerType>......</PayerType> [0..1] <ROType>......</ROType> [0..*] </RepairOrderHeader>