Uses the Component:PartsInventoryHeaderType
For each PartsInventory represented in the DataArea of the PartsInventory BOD, there must be once occurrence of the Header Component. The Header component represents summary information that applies to the entire Parts Inventory transaction.
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 | |
| PartTypeCode |
Specifies whether the parts are indicated by manufacturer part code or Part Number - H = Manufacturer Part Code, P = Part Number | 0..1 | Field | scl:PartTypeEnumeratedType | |
| FileSequenceNumberString |
Sequence for sent files. The first file is 1. | 0..1 | Field | qdt:StringType | |
| InventoryTypeCode |
Identifies the type of inventory being transmitted, either full or incremental. Full inventory is an extract of the entire parts inventory. Incremental is the change in inventory since the last reported inventory (identifed by BOD Id). | 0..1 | Field | scl:InventoryTypeEnumeratedType | |
| LastSentInventoryBODID |
BOD Id of the last inventory message received. | 0..1 | Field | udt:IdentifierType | |
| Status |
Deprecated: Use AcknowledgmentStatus. | 0..* | Field | MinimumAcknowledgementStatusType | |
| AcknowledgementStatus | 0..* | Component | AcknowledgementStatusType | ||
| DatasourceURICode |
The a code that points to a datasource where the datasource value is stored. | 0..1 | Field | udt:CodeType | |
| FreeFormTextGroup |
This component allows for the free form entry of notes and text descriptions. Detailed data should use one of the existing fields or submit a modification request back to STAR to capture the appropriate data. | 0..1 | Component | FreeFormTextGroupType | |
| ReorderTransmitTime |
A time at which the DMS system can submit automatic replenishment orders to the OEM. | 0..1 | Field | udt:TimeType | |
| Period |
Month and Year of the parts activity being reported by the DMS. | 0..1 | Field | qdt:YearMonthDateType | |
| 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 |
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. PartsInventoryHeader
<PartsInventoryHeader>
<DocumentDateTime>......</DocumentDateTime> [0..1]
<SecondaryPassword>......</SecondaryPassword> [0..1]
<SecondaryDealerNumberID>......</SecondaryDealerNumberID> [0..1]
<DocumentIdentificationGroup>......</DocumentIdentificationGroup> [1..1]
<PartTypeCode>......</PartTypeCode> [0..1]
<FileSequenceNumberString>......</FileSequenceNumberString> [0..1]
<InventoryTypeCode>......</InventoryTypeCode> [0..1]
<LastSentInventoryBODID>......</LastSentInventoryBODID> [0..1]
<Status>......</Status> [0..*]
<AcknowledgementStatus>......</AcknowledgementStatus> [0..*]
<DatasourceURICode>......</DatasourceURICode> [0..1]
<FreeFormTextGroup>......</FreeFormTextGroup> [0..1]
<ReorderTransmitTime>......</ReorderTransmitTime> [0..1]
<Period>......</Period> [0..1]
<RequestDateRange>......</RequestDateRange> [0..*]
</PartsInventoryHeader>