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 | oag:xbt_DateTimeType | |
| DocumentIdentification |
A group of identifications that uniquely identifies this document | 0..1 | Component | DocumentIdentificationType | |
| DefaultCurrency |
Default global currency that can be used in all amounts. It can be overwrittten in individual amounts by populating the "currency" attribute in the Amount Data Type. | 0..1 | Field | oag:clm542173A20090305_ISO3AlphaCurrencyCodeContentType | |
| DefaultLanguage |
Default language. It can be overwrittten in individual data elements in the BOD if needed. | 0..1 | Field | sqdt:LanguageCodeType | |
| InventoryType |
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 | |
| AcknowledgementStatus | 0..* | Component | AcknowledgementStatusType | ||
| 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 | oag:TimePeriodType | |
| DealerParty |
Represents a Dealer | 0..* | Component | PartyABIEType | |
| WarehouseParty |
Represents a Wearhouse | 0..* | Component | PartyABIEType | |
| PeriodsInYear |
Periods in a year. | 0..1 | Field | oag:NumberType | |
| PeriodID |
The period ID. | 0..1 | Field | oag:OpenIDType | |
| 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..* | Component | FreeFormTextGroupType |
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]
<DocumentIdentification>......</DocumentIdentification> [0..1]
<DefaultCurrency>......</DefaultCurrency> [0..1]
<DefaultLanguage>......</DefaultLanguage> [0..1]
<InventoryType>......</InventoryType> [0..1]
<AcknowledgementStatus>......</AcknowledgementStatus> [0..*]
<RequestDateRange>......</RequestDateRange> [0..*]
<DealerParty>......</DealerParty> [0..*]
<WarehouseParty>......</WarehouseParty> [0..*]
<PeriodsInYear>......</PeriodsInYear> [0..1]
<PeriodID>......</PeriodID> [0..1]
<FreeFormTextGroup>......</FreeFormTextGroup> [0..*]
</PartsInventoryHeader>