Uses the Component:PartsInvoiceHeaderType
For each PartsInvoice represented in the DataArea of the PartsInvoice Business Object Document, there must be once occurrence of the Header Component.
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 | |
TransactionTypeCode |
Type of transaction | 0..1 | Field | scl:TransactionTypeEnumeratedType | |
InvoiceDate |
Date of invoice. | 0..1 | Field | udt:DateType | |
ReferenceNumberString | 0..1 | Field | qdt:StringType | ||
ShipmentCarrierCode |
Deprecated: Use ShipmentCarrierDetail | 0..1 | Field | scl:ShipmentCarrierEnumeratedType | |
ShipDate |
Indicates the date of shipment for an item. | 0..1 | Field | udt:DateType | |
ShipmentNumberString |
Number assigned to shipment. | 0..1 | Field | qdt:StringType | |
PDC |
Parts distribution center. | 0..1 | Field | udt:TextType | |
ShippingPDC |
Parts Distribution Center (PDC) for shipment | 0..1 | Field | udt:TextType | |
TotalPartPiecesNumeric |
The total number of part pieces to be contained in the transaction. | 0..1 | Field | udt:NumericType | |
ProcessDate |
Effective date of process | 0..1 | Field | udt:DateType | |
PaymentTerms |
The PaymentTerms component represents the payment due dates and payment discount information. | 0..1 | Component | PaymentTermsType | |
StockOrderNetAmount |
Net amount of stock order | 0..1 | Field | udt:AmountType | |
StockAdjustmentValueAmount |
Net amount of stock order | 0..1 | Field | udt:AmountType | |
TotalPartsAmount |
Total for parts only. | 0..1 | Field | udt:AmountType | |
TotalAccessoriesAmount |
Total for accessories only. | 0..1 | Field | udt:AmountType | |
TotalOtherAmount |
Total miscellaneous only | 0..1 | Field | udt:AmountType | |
SubtotalBeforeDiscountsAmount |
Interim total prior to adjustments | 0..1 | Field | udt:AmountType | |
PartsDiscountAmount |
Discount amount for parts only | 0..1 | Field | udt:AmountType | |
AccessoriesDiscountAmount |
Discount Amount for accessories only | 0..1 | Field | udt:AmountType | |
OtherDiscountAmount |
Discount amount for miscellaneous only | 0..1 | Field | udt:AmountType | |
TotalDiscountAmount |
Total discounts | 0..1 | Field | udt:AmountType | |
SubtotalIncludingDiscount |
Interim total less discounts | 0..1 | Field | udt:AmountType | |
ExtendedAmount |
Value times quantity | 0..1 | Field | udt:AmountType | |
Allowance |
The Allowance Component represents the allowance information associated with the Invoice. | 0..1 | Component | AllowanceType | |
TotalMiscellaneousExpense |
Total Miscellaneous expense. | 0..1 | Field | udt:AmountType | |
Charges |
Charges associated with an Invoice. | 0..1 | Component | ChargesType | |
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 | |
TotalAmount |
Total price (cost + markup) | 0..1 | Field | udt:AmountType | |
SalesPromotionCode |
Sales promotion code | 0..1 | Field | udt:CodeType | |
ProcessCode |
Code designating how the order was processed | 0..1 | Field | udt:CodeType | |
ManufacturerOrderNumberString |
Manufacturer Order Number | 0..1 | Field | qdt:StringType | |
FundsCode |
Fund coding for all monetary values of this transaction | 0..1 | Field | udt:CodeType | |
DiscountCode |
Discount or Pricing Code. | 0..1 | Field | udt:CodeType | |
TotalSubjectToDutyAmount |
Total Subject To Duty Amount | 0..1 | Field | udt:AmountType | |
ExtendedCoreAmount |
Total core value | 0..1 | Field | udt:AmountType | |
BulkDiscountAmount |
Bulk Discount Amount | 0..1 | Field | udt:AmountType | |
LetterOfCredit |
Letter Of Credit | 0..1 | Field | udt:TextType | |
LOCExpirationDate |
LOC Expiration Date | 0..1 | Field | udt:DateType | |
DeclarationStatement |
Declaration statement made by manufacturer. | 0..1 | Field | udt:TextType | |
TotalRackContainerDepositAmount |
Total deposit amount for a Rack or Container | 0..1 | Field | udt:AmountType | |
FOBTermsString |
Transit Ownership terms | 0..1 | Field | qdt:StringType | |
FreightTermsString |
Designates who pays freight - - Collect / Prepaid | 0..1 | Field | qdt:StringType | |
SoldToParty |
The party to which good or services were sold. | 0..1 | Component | PartyABIEType | |
ShipToParty |
The party receiving the goods or services. | 0..1 | Component | PartyABIEType | |
HTSSummary |
Harmonized Tariff Schedule (HTS)information associated with a particular Invoice/Shipment | 0..* | Component | HTSSummaryType | |
PartCountrySummary | 0..* | Component | PartCountrySummaryType | ||
PartsInvoiceType |
Identifies the type of financial transaction associated with the part invoice (Material Return, Claims, Warranty). | 0..1 | Field | udt:CodeType | |
PartsInvoiceDueDate |
The date that the part invoice is due to be paid. | 0..1 | Field | udt:DateType | |
DealerOrderNumberString |
A Dealer assigned identifier for the order. i.e. The Part Order number. | 0..1 | Field | qdt:StringType | |
OrderDate |
Date order originally placed | 0..1 | Field | udt:DateType | |
ReceivableID |
An OEM-assigned reference number. This number is for OEM use, not for Dealer use. The purpose of a receivable number is for dealers that are set up to pay cash in advance. This type of payment is may be set up through a consolidated accounts receivable system When a dealer is billed through consolidated accounts receivable system, he gets a ReceivableID. | 0..1 | Field | udt:IdentifierType | |
OrderTypeCode |
Part Order Type entered or selected at dealership. Stock-STK, Vehicle Off Road-VOR, Daily-DPO, Emergency-EMG, Supplemental-SUP, Promotional-PRO, Solicited-SOL, Vehicle Off Road Parts Inquiry-VPI, Weekly-WKL, Interim-INT, Export-EXP, Dropship Stock-DSS, Dropship Vehicle Off Road-DVR, Lock and Key-LAK, Will Call-WCL, Return Request w/ Reference-RRR, Return Request w/o Reference-RWR, Credit Request w/ Reference-CRR, Credit Request w/o Reference-CWR, Debit Request w/ Reference-DRR, Debit Request w/o Reference-DWR, Rush-RUS, Urgent-URG, Other-OTH, N/A-N/A, Hold-HLD, Dating-DTG. Part Order Type entered or selected at dealership. | 0..1 | Field | sqdt:OrderTypeCodeType | |
PartsOrderReceivedDateTime |
The date and time a parts order was received. | 0..1 | Field | udt:DateTimeType | |
ShipmentCarrierDetail |
The ShipmentCarrierDetail component is used to describe the shipment carrier to be used for a shipment and the method by which the shipment will be made. | 0..* | Component | ShipmentCarrierDetailType | |
oagis:Note |
Free form notes that are entered by the dealer at the time of order entry. These notes are for informational purposes only, no system processing or business logic that would require extraction of data requirements is to appear in this field. | 0..* | Field | udt:TextType | |
AllowBackOrderIndicator |
Inidcates that a part can be back ordered. | 0..1 | Field | udt:IndicatorType | |
TotalShipmentWeightMeasure |
Weight of the total shipment. | 0..1 | Field | sqdt:WeightMeasureType | |
TotalQuantityShippedNumeric |
The total quantity of all parts that have been shipped. | 0..1 | Field | udt:NumericType | |
AccountCode |
Account number/AR# for the customer if charged. | 0..1 | Field | udt:TextType | |
SoldByParty |
Counter person who sold the parts | 0..1 | Component | PartyABIEType | |
PayerParty |
Party Responsible for payment | 0..1 | Component | PartyABIEType | |
PartsAccessoriesLeadID |
The PA Lead that lead associated with this Parts Invoice | 0..1 | Field | udt:IdentifierType | |
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 | |
ImageAttachmentExtended |
The ImageAttachmentExtended component contains information about an image being attached to a BOD, e.g., image size, image type, image file name, etc. | 0..1 | Component | ImageAttachmentExtendedType | |
PartsCustomerTypeCode |
Identifies the type of customer that purchased the part(s). Example: Retail, Internal, Wholesale, Bodyshop. | 0..1 | Field | udt:CodeType | |
PartsInvoiceTypeDescription |
Description of the Sale Type. Example: eCommerce, Phone, Walk-in. | 0..1 | Field | udt:TextType | |
IncoTerms |
The Incoterms (international Chamber of Commerce) rules have become an essential part of the daily language of trade. They have been incorporated in contracts for the sale of goods worldwide and provide rules and guidance to importers, exporters, lawyers, transporters, insurers and students of international trade. | 0..1 | Component | IncoTermsType | |
Price |
Price information | 0..* | Component | PriceABIEType |
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. PartsInvoiceHeader
<PartsInvoiceHeader> <DocumentDateTime>......</DocumentDateTime> [0..1] <SecondaryPassword>......</SecondaryPassword> [0..1] <SecondaryDealerNumberID>......</SecondaryDealerNumberID> [0..1] <DocumentIdentificationGroup>......</DocumentIdentificationGroup> [1..1] <TransactionTypeCode>......</TransactionTypeCode> [0..1] <InvoiceDate>......</InvoiceDate> [0..1] <ReferenceNumberString>......</ReferenceNumberString> [0..1] <ShipmentCarrierCode>......</ShipmentCarrierCode> [0..1] <ShipDate>......</ShipDate> [0..1] <ShipmentNumberString>......</ShipmentNumberString> [0..1] <PDC>......</PDC> [0..1] <ShippingPDC>......</ShippingPDC> [0..1] <TotalPartPiecesNumeric>......</TotalPartPiecesNumeric> [0..1] <ProcessDate>......</ProcessDate> [0..1] <PaymentTerms>......</PaymentTerms> [0..1] <StockOrderNetAmount>......</StockOrderNetAmount> [0..1] <StockAdjustmentValueAmount>......</StockAdjustmentValueAmount> [0..1] <TotalPartsAmount>......</TotalPartsAmount> [0..1] <TotalAccessoriesAmount>......</TotalAccessoriesAmount> [0..1] <TotalOtherAmount>......</TotalOtherAmount> [0..1] <SubtotalBeforeDiscountsAmount>......</SubtotalBeforeDiscountsAmount> [0..1] <PartsDiscountAmount>......</PartsDiscountAmount> [0..1] <AccessoriesDiscountAmount>......</AccessoriesDiscountAmount> [0..1] <OtherDiscountAmount>......</OtherDiscountAmount> [0..1] <TotalDiscountAmount>......</TotalDiscountAmount> [0..1] <SubtotalIncludingDiscount>......</SubtotalIncludingDiscount> [0..1] <ExtendedAmount>......</ExtendedAmount> [0..1] <Allowance>......</Allowance> [0..1] <TotalMiscellaneousExpense>......</TotalMiscellaneousExpense> [0..1] <Charges>......</Charges> [0..1] <Tax>......</Tax> [0..*] <TotalAmount>......</TotalAmount> [0..1] <SalesPromotionCode>......</SalesPromotionCode> [0..1] <ProcessCode>......</ProcessCode> [0..1] <ManufacturerOrderNumberString>......</ManufacturerOrderNumberString> [0..1] <FundsCode>......</FundsCode> [0..1] <DiscountCode>......</DiscountCode> [0..1] <TotalSubjectToDutyAmount>......</TotalSubjectToDutyAmount> [0..1] <ExtendedCoreAmount>......</ExtendedCoreAmount> [0..1] <BulkDiscountAmount>......</BulkDiscountAmount> [0..1] <LetterOfCredit>......</LetterOfCredit> [0..1] <LOCExpirationDate>......</LOCExpirationDate> [0..1] <DeclarationStatement>......</DeclarationStatement> [0..1] <TotalRackContainerDepositAmount>......</TotalRackContainerDepositAmount> [0..1] <FOBTermsString>......</FOBTermsString> [0..1] <FreightTermsString>......</FreightTermsString> [0..1] <SoldToParty>......</SoldToParty> [0..1] <ShipToParty>......</ShipToParty> [0..1] <HTSSummary>......</HTSSummary> [0..*] <PartCountrySummary>......</PartCountrySummary> [0..*] <PartsInvoiceType>......</PartsInvoiceType> [0..1] <PartsInvoiceDueDate>......</PartsInvoiceDueDate> [0..1] <DealerOrderNumberString>......</DealerOrderNumberString> [0..1] <OrderDate>......</OrderDate> [0..1] <ReceivableID>......</ReceivableID> [0..1] <OrderTypeCode>......</OrderTypeCode> [0..1] <PartsOrderReceivedDateTime>......</PartsOrderReceivedDateTime> [0..1] <ShipmentCarrierDetail>......</ShipmentCarrierDetail> [0..*] <oagis:Note>......</oagis:Note> [0..*] <AllowBackOrderIndicator>......</AllowBackOrderIndicator> [0..1] <TotalShipmentWeightMeasure>......</TotalShipmentWeightMeasure> [0..1] <TotalQuantityShippedNumeric>......</TotalQuantityShippedNumeric> [0..1] <AccountCode>......</AccountCode> [0..1] <SoldByParty>......</SoldByParty> [0..1] <PayerParty>......</PayerParty> [0..1] <PartsAccessoriesLeadID>......</PartsAccessoriesLeadID> [0..1] <RequestDateRange>......</RequestDateRange> [0..*] <ImageAttachmentExtended>......</ImageAttachmentExtended> [0..1] <PartsCustomerTypeCode>......</PartsCustomerTypeCode> [0..1] <PartsInvoiceTypeDescription>......</PartsInvoiceTypeDescription> [0..1] <IncoTerms>......</IncoTerms> [0..1] <Price>......</Price> [0..*] </PartsInvoiceHeader>