Uses the Component:VehiclePaymentsHeaderType
Vehicle Payments 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 | |
| VehiclePaymentCycleStartDate |
Indicates the start date of the vehicle payment cycle. | 1..1 | Field | udt:DateType | |
| VehiclePaymentCycleEndDate |
Indicates the date of the vehicle payment cycle ends. | 0..1 | Field | udt:DateType | |
| VehiclePaymentDate |
Indicates the date on which the payment was deposited to the dealer's bank account. | 0..1 | Field | udt:DateType | |
| VehiclePaymentID |
a unique identifier used by the dealer to track a vehicle payment. | 0..1 | Field | udt:IdentifierType | |
| TotalVehicleCalculationAmount |
The total of all Vehicle Calculation Amounts, i.e., the amount that is used ot calculate the holdback amount. | 0..1 | Field | udt:AmountType | |
| TotalHoldbackAmount |
The total of all Holdback Amounts, i.e., the amount that is paid to the dealer on a vehicle basis refunding the dealer for inflated vehicle invoice amounts. | 0..1 | Field | udt:AmountType | |
| TotalTransitAllowanceAmount |
The total of all Transit Allowance Amounts, i.e. the amount allocated to cover the interest cost associated with holding vehicles while in transit. | 0..1 | Field | udt:AmountType | |
| TotalHoldbackTransitAllowanceAmount |
The sum of the Total Holdback Amount and the Total Transit Allowance Amount. | 0..1 | Field | udt:AmountType | |
| BroughtForwardAmount |
Indicates the previous month's Total Holdback Transit Allowance Amount which is a total of all amounts allocated to cover the interest cost associated with holding vehicles while in transit. | 0..1 | Field | udt:AmountType | |
| TotalIncludingBroughtForwardAmount |
The sum of the Brought Forward Amount and the Total Holdback Transit Allowance Amount. | 0..1 | Field | udt:AmountType |
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. VehiclePaymentsHeader
<VehiclePaymentsHeader>
<DocumentDateTime>......</DocumentDateTime> [0..1]
<SecondaryPassword>......</SecondaryPassword> [0..1]
<SecondaryDealerNumberID>......</SecondaryDealerNumberID> [0..1]
<DocumentIdentificationGroup>......</DocumentIdentificationGroup> [1..1]
<VehiclePaymentCycleStartDate>......</VehiclePaymentCycleStartDate> [1..1]
<VehiclePaymentCycleEndDate>......</VehiclePaymentCycleEndDate> [0..1]
<VehiclePaymentDate>......</VehiclePaymentDate> [0..1]
<VehiclePaymentID>......</VehiclePaymentID> [0..1]
<TotalVehicleCalculationAmount>......</TotalVehicleCalculationAmount> [0..1]
<TotalHoldbackAmount>......</TotalHoldbackAmount> [0..1]
<TotalTransitAllowanceAmount>......</TotalTransitAllowanceAmount> [0..1]
<TotalHoldbackTransitAllowanceAmount>......</TotalHoldbackTransitAllowanceAmount> [0..1]
<BroughtForwardAmount>......</BroughtForwardAmount> [0..1]
<TotalIncludingBroughtForwardAmount>......</TotalIncludingBroughtForwardAmount> [0..1]
</VehiclePaymentsHeader>