SalesLead

STAR 6

Repository Release 6.2.1


Table of Contents

Preface
License
Eclipse Public License - v1.0
1. Introduction
Guideline Organization
2. BOD Design
XML Instance Namespaces
Schema Namespaces
BOD Structure
3. BOD Components
Business Object Document - BOD
Business Object Document Attributes
Business Object Document Fields and Components
4. Data Area Components
AcknowledgeCreditApplicationDataArea
Fields and Components
Sample XML
5. Verbs
Acknowledge
Fields and Components
Sample XML
Cancel
Fields and Components
Sample XML
Change
Fields and Components
Sample XML
Get
Fields and Components
Sample XML
Process
Fields and Components
Sample XML
Respond
Fields and Components
Sample XML
Show
Fields and Components
Sample XML
Update
Fields and Components
Sample XML
ActionCriteria
Fields and Components
Sample XML
ActionExpression
Fields and Components
Sample XML
Expression
Fields and Components
Sample XML
OriginalApplicationArea
ResponseCriteria
Fields and Components
Sample XML
ResponseExpression
Fields and Components
Sample XML
ChangeStatus
Fields and Components
Sample XML
StateChange
Fields and Components
Sample XML
6. Sales Lead Noun
SalesLead
Fields and Components
Sample XML
SalesLeadHeader
Fields and Components
Sample XML
DocumentIdentification
Fields and Components
Sample XML
DocumentIdentifier
Fields and Components
Sample XML
AlternateDocumentIdentifier
Fields and Components
Sample XML
ProviderParty
Fields and Components
Sample XML
ConsumerParty
Fields and Components
Sample XML
CustomerParty
Fields and Components
Sample XML
Party
Fields and Components
Sample XML
PartyBase
Fields and Components
Sample XML
SpecifiedOrganization
Fields and Components
Sample XML
PrimaryContact
Fields and Components
Sample XML
SpecifiedPerson
Fields and Components
Sample XML
ResidenceAddress
Fields and Components
Sample XML
TelephoneCommunication
Fields and Components
Sample XML
FaxCommunication
Fields and Components
Sample XML
URICommunication
Fields and Components
Sample XML
PostalAddress
Fields and Components
Sample XML
SpecifiedOccupation
Fields and Components
Sample XML
UsagePreference
Fields and Components
Sample XML
PartyActionEvent
Fields and Components
Sample XML
SalesLeadInfo
Fields and Components
Sample XML
Vehicle
Fields and Components
Sample XML
VehicleBase
Fields and Components
Sample XML
VehicleModel
Fields and Components
Sample XML
VehicleDetails
Fields and Components
Sample XML
Color
Fields and Components
Sample XML
OdometerReading
Fields and Components
Sample XML
CountryOfOrigin
Fields and Components
Sample XML
VehicleConfiguration
Fields and Components
Sample XML
Transmission
Fields and Components
Sample XML
Chassis
Fields and Components
Sample XML
Tank
Fields and Components
Sample XML
Engine
Fields and Components
Sample XML
ItemIdentifier
Fields and Components
Sample XML
Battery
Fields and Components
Sample XML
VehicleConfigItem
Fields and Components
Sample XML
EffectivePeriod
Fields and Components
Sample XML
Price
Fields and Components
Sample XML
ConfigurationAlternative
Fields and Components
Sample XML
TelematicUnit
Fields and Components
Sample XML
TelematicUnitSoftware
Fields and Components
Sample XML
VehicleStatus
Fields and Components
Sample XML
VehicleEvent
Fields and Components
Sample XML
ImageAttachmentExtended
Fields and Components
Sample XML
EmbeddedData
Fields and Components
Sample XML
FreeFormTextGroup
Fields and Components
Sample XML
CertificationGroup
Fields and Components
Sample XML
PreviousOwnerParty
Fields and Components
Sample XML
SalesLeadDetail
Fields and Components
Sample XML
Financing
Fields and Components
Sample XML
CreditorFinancialInstitution
Fields and Components
Sample XML
SpecifiedFinancialAccount
Fields and Components
Sample XML
CreditFinancing
Fields and Components
Sample XML
FinancialOrganization
Fields and Components
Sample XML
FleetAccount
Fields and Components
Sample XML
FleetQuantity
Fields and Components
Sample XML
EstimatedFinancingAmounts
Fields and Components
Sample XML
Tax
Fields and Components
Sample XML
Fee
Fields and Components
Sample XML
OtherDownPaymentsGroup
Fields and Components
Sample XML
OtherDownPayments
Fields and Components
Sample XML
PaymentActivity
Fields and Components
Sample XML
FinalFinancingAmounts
Fields and Components
Sample XML
CreditScoreGroup
Fields and Components
Sample XML
Insurance
Fields and Components
Sample XML
SpecifiedAddress
Fields and Components
Sample XML
InsuranceDetail
Fields and Components
Sample XML
LossPayee
Fields and Components
Sample XML
PolicyHolderParty
Fields and Components
Sample XML
SalesAppointment
Fields and Components
Sample XML
RequestedAppointmentPeriod
Fields and Components
Sample XML
AppointmentContactParty
Fields and Components
Sample XML
SalesActivity
Fields and Components
Sample XML
SalesActivityDocument
Fields and Components
Sample XML
SalesActivityActionEvent
Fields and Components
Sample XML
SalesOffer
Fields and Components
Sample XML
Pricing
Fields and Components
Sample XML
Option
Fields and Components
Sample XML
OptionPricing
Fields and Components
Sample XML
DefinedContact
Fields and Components
Sample XML
VehicleMajorPartsProductItem
Fields and Components
Sample XML
VehicleMajorPartsProductItemConfiguration
Fields and Components
Sample XML
Part
Fields and Components
Sample XML
ItemIdentification
Fields and Components
Sample XML
Service
Fields and Components
Sample XML
SalesCampaign
Fields and Components
Sample XML
A. Data Types
Unqualified Data Types
AmountType
BinaryObjectType
GraphicType
PictureType
SoundType
SoundType
CodeType
DateTimeType
DateType
TimeType
IdentifierType
TimeType
MeasureType
NumericType
ValueType
PercentType
RateType
QuantityType
TextType
NameType
Qualified Data Types
HexBinaryObjectType
YearDateType
YearMonthDateType
FloatNumericType
DoubleNumericType
IntegerNumericType
PositiveIntegerNumericType
NegativeIntegerNumericType
NonPositiveIntegerNumericType
NonNegativeIntegerNumericType
DurationMeasureType
StringType
NormalizedStringType
TokenType
URIType
LanguageCodeType
MonthDateType
DayDateType
MonthDayDateType
STAR Qualified Data Types
DistanceType
VINType
NormalizedStringType
PeriodMeasureType
WeightMeasureType
LengthMeasureType
VolumeMeasureType
AreaMeasureType
SpeedMeasureType
TemperatureMeasureType
FuelConsumptionMeasureType
PowerMeasureType
TimeMeasureType
BoatLengthCodeType
BoatDraftCodeType
BoatCategoryCodeType
BoatClassCodeType
BoatHullDesignCodeType
BoatHullMaterialCodeType
BoatKeelCodeType
ElectricityMeasureType
ForceMeasureType
BoatEngineLocationCodeType
PressureMeasureType
DeliveryTypeCodeType
PartActivityTransactionCodeType
FuelTypeCodeType
SalesStatusType
LanguageCodeType
CrossShipmentRestrictionCodeType
ComputerStorageMeasureType
JobNumberSchemeIDType
TimeUntiSchemeIDType
AssigningOrganizationPartyIdType
AgencyRoleCodeType
CountryCodeType
DisplacementMeasureType
ContactMethodTypeCodeType
VehicleUseCodeType
ShipmentCarrierCompanyCodeType
ShipmentCarrierTransportMethodTypeCodeType
ShipmentCarrierServiceLevelCodeType
ShipmentCarrierDeliveryCodeType
ShipmentCarrierCollectionMethodCodeType
OrderTypeCodeType
RequestedAmountTypeCodeType
ItemIDCategoryTypeCodeType
DealerServiceTypeCodeType
HoursTypeCodeType
DayOfWeekCodeType
LocationTypeCodeType
LocationIDTypeCodeType
DeliveryProcessStateCodeType
EventTypeCodeType
FleetAccountCodeType
SubtotalTypeCodeType
DealerProductsTypeCodeType
LeaseEndOptionVehicleDecisionCodeType
LeaseEndOptionFinanceDecisionCodeType
RepairStatusCodeType
QuantityContentType
QuantityType
AcquisitionMethodTypeCodeType
PartConditionCodeType
StockingLevelIndicatorCodeType
DistributionMethodCodeType
BuyPercentageRateAdjustmentTypeCodeType
TaxCreditTypeCodeType
TransferStatusCodeType
PaymentLineTypeCodeType
DisplacementMeasureTypeCodeType
TankUsageCodeType
TankMaterialCodeType
AccommodationTypeCodeType
WindlassTypeCodeType
TaxStatusCodeType
B. Code Lists
STAR 6 Code Lists
AccountingTermEnumeratedType
AccountingTermContentType
SecondaryAccountingTermEnumeratedType
SecondaryAccountingTermContentType
AcknowledgmentCodeEnumeratedType
AcknowledgmentCodeContentType
AddressQualifierEnumeratedType
AddressQualifierContentType
AllowBackOrderPartialShipEnumeratedType
AllowBackOrderPartialShipContentType
ApplicationNumberDescriptionEnumeratedType
ApplicationNumberDescriptionContentType
ApplicationStatusEnumeratedType
ApplicationStatusContentType
AssigningOrganizationPartyIdEnumeratedType
AssigningOrganizationPartyIdContentType
AssigningPartyIdEnumeratedType
AssigningPartyIdContentType
AvailabilityStatusEnumeratedType
AvailabilityStatusContentType
BoatEngineTypeEnumeratedType
BoatEngineTypeContentType
CaseTypeEnumeratedType
CaseTypeContentType
CashPriceInclusionTypeEnumeratedType
CashPriceInclusionTypeContentType
ChildLineReasonCodeEnumeratedType
ChildLineReasonCodeContentType
CodesActionEnumeratedType
CodesActionContentType
CollisionDeductibleTypeEnumeratedType
CollisionDeductibleTypeContentType
ComponentTypeEnumeratedType
ComponentTypeContentType
ConfirmationEnumeratedType
ConfirmationContentType
ConfirmationEntityEnumeratedType
ConfirmationEntityContentType
ContactTelephoneNumberDescriptionEnumeratedType
ContactTelephoneNumberDescriptionContentType
ContactTelephoneNumberOrganizationDescriptionEnumeratedType
ContactTelephoneNumberOrganizationDescriptionContentType
CreditCardTypeEnumeratedType
CreditCardTypeContentType
DeliveryTypeEnumeratedType
DeliveryTypeContentType
DeltaEnumeratedType
DeltaContentType
DimensionMeasureEnumeratedType
DimensionMeasureContentType
DriveTypeEnumeratedType
DriveTypeContentType
EncodingBaseEnumeratedType
EncodingBaseContentType
EngineConfigurationEnumeratedType
EngineConfigurationContentType
EngineDisplacementEnumeratedType
EngineDisplacementContentType
EngineInductionEnumeratedType
EngineInductionContentType
FeeTypeEnumeratedType
FeeTypeContentType
FuelTypeEnumeratedType
FuelTypeContentType
GenderEnumeratedType
GenderContentType
GeographicalConstraintTypeEnumeratedType
GeographicalConstraintTypeContentType
HomeWorkEnumeratedType
HomeWorkContentType
HouseholdIncomeRangeEnumeratedType
HouseholdIncomeRangeContentType
IncomePeriodEnumeratedType
IncomePeriodContentType
IndebtednessResponsibilityEnumeratedType
IndebtednessResponsibilityContentType
InitiativeCategoryEnumeratedType
InitiativeCategoryContentType
InitiativeFinanceTypeEnumeratedType
InitiativeFinanceTypeContentType
InitiativeTypeEnumeratedType
InitiativeTypeContentType
InsuranceDetailTypeEnumeratedType
InsuranceDetailTypeContentType
InsuranceTypeEnumeratedType
InsuranceTypeContentType
InventoryTypeEnumeratedType
InventoryTypeContentType
InvoiceShipmentEnumeratedType
InvoiceShipmentContentType
LeadIndustryTypeEnumeratedType
LeadIndustryTypeContentType
LeadInterestEnumeratedType
LeadInterestContentType
LeadTypeEnumeratedType
LeadTypeContentType
LineStateTypeEnumeratedType
LineStateTypeContentType
MaritalStatusEnumeratedType
MaritalStatusContentType
MessageReasonCodeEnumeratedType
MessageReasonCodeContentType
MileageMeasureEnumeratedType
MileageMeasureContentType
OptionPricingTypeEnumeratedType
OptionPricingTypeContentType
OrderStateTypeEnumeratedType
OrderStateTypeContentType
OrderTypeEnumeratedType
OrderTypeContentType
OwnedTypeEnumeratedType
OwnedTypeContentType
PartsShipmentLineBoxingTypeEnumeratedType
PartsShipmentLineBoxingTypeContentType
PartTypeEnumeratedType
PartTypeContentType
PartSaleTypeEnumeratedType
PartSaleTypeContentType
PartyTypeEnumeratedType
PartyTypeContentType
PaymentMethodEnumeratedType
PaymentMethodContentType
PayrollFrequencyEnumeratedType
PayrollFrequencyContentType
PlanOptionTypeEnumeratedType
PlanOptionTypeContentType
OriginalContactMethodContentType
OriginalContactMethodEnumeratedType
PreferredContactMethodEnumeratedType
PreferredContactMethodContentType
PreferredContactMethodOrganizationEnumeratedType
PreferredContactMethodOrganizationContentType
PriceTypeContentType
RebateTypeEnumeratedType
RebateTypeContentType
RelativeToEnumeratedType
RelativeToContentType
RequestEnumeratedType
RequestContentType
RequestedSearchCriteriaTypeEnumeratedType
RequestedSearchCriteriaTypeContentType
RequiredOptionEnumeratedType
RequiredOptionContentType
SaleClassEnumeratedType
SaleClassContentType
TypeSalesEnumeratedType
TypeSalesContentType
SearchCriteriaEnumeratedType
SearchCriteriaContentType
ServiceTypeEnumeratedType
ServiceTypeContentType
SettlementTypeEnumeratedType
SettlementTypeContentType
ShipmentCarrierEnumeratedType
ShipmentCarrierContentType
ShipPriorityEnumeratedType
ShipPriorityContentType
SplitsTypeEnumeratedType
SplitsTypeContentType
StatusCodeEnumeratedType
StatusCodeContentType
StatusTypeEnumeratedType
StatusTypeContentType
TaxTypeEnumeratedType
TaxTypeContentType
TaxTypeIdEnumeratedType
TaxTypeIdContentType
TermLengthEnumeratedType
TermLengthContentType
TransactionTypeEnumeratedType
TransactionTypeContentType
TransferFrequencyEnumeratedType
TransferFrequencyContentType
TransmissionTypeEnumeratedType
TransmissionTypeContentType
UOMEnumeratedType
UOMContentType
UrgentSearchMessageCodeEnumeratedType
UrgentSearchMessageCodeContentType
ValidationResultsEnumeratedType
ValidationResultsContentType
VehicleClassEnumeratedType
VehicleClassContentType
VehicleOwnerTypeEnumeratedType
VehicleOwnerTypeContentType
VehiclePricingTypeEnumeratedType
VehiclePricingTypeContentType
VolumeMeasureEnumeratedType
VolumeMeasureContentType
WeightMeasureEnumeratedType
WeightMeasureContentType
LanguageEnumeratedType
LanguageContentType
CountryEnumeratedType
CountryContentType
IncentiveEnumeratedType
IncentiveContentType
VehicleOwnershipTypeEnumeratedType
VehicleOwnershipTypeContentType
TireTypeEnumeratedType
TireTypeContentType
TrailerTypeEnumeratedType
TrailerTypeContentType
BrakeTypeEnumeratedType
BrakeTypeContentType
WinchTypeEnumeratedType
WinchTypeContentType
StartingSystemTypeEnumeratedType
StartingSystemTypeContentType
ImagePerspectiveEnumeratedType
ImagePersectiveContentType
PriceEnumeratedType
PriceContentType
ColorItemEnumeratedType
ColorItemContentType
CylinderConfigurationEnumeratedType
CylinderConfigurationContentType
PartActivityTransactionEnumeratedType
PartActivityTransactionContentType
SalesStatusEnumeratedType
SalesStatusContentType
CrossShipmentRestrictionEnumeratedType
CrossShipmentRestrictionContentType
AgencyRoleCodeEnumeratedType
AgencyRoleCodeContentType
ContactMethodTypeEnumeratedType
ContactMethodTypeContentType
VehicleUseEnumeratedType
VehicleUseContentType
ShipmentCarrierTransportMethodTypeEnumeratedType
ShipmentCarrierTransportMethodTypeContentType
ShipmentCarrierCompanyEnumeratedType
ShipmentCarrierCompanyContentType
ShipmentCarrierServiceLevelEnumeratedType
ShipmentCarrierServiceLevelContentType
ShipmentCarrierDeliveryEnumeratedType
ShipmentCarrierDeliveryContentType
ShipmentCarrierCollectionMethodEnumeratedType
ShipmentCarrierCollectionMethodContentType
RequestedAmountTypeEnumeratedType
RequestedAmountTypeContentType
ItemIDCategoryTypeEnumeratedType
ItemIDCategoryTypeContentType
DealerServiceTypeEnumeratedType
DealerServiceTypeContentType
HoursTypeEnumeratedType
HoursTypeContentType
DayOfWeekEnumeratedType
DayOfWeekContentType
LocationTypeEnumeratedType
LocationTypeContentType
LocationIDTypeEnumeratedType
LocationIDTypeContentType
DeliveryProcessStateEnumeratedType
DeliveryProcessStateContentType
EventTypeEnumeratedType
EventTypeContentType
FleetAccountEnumeratedType
FleetAccountContentType
SubtotalTypeCodeEnumeratedType
SubtotalTypeCodeContentType
DealerProductsTypeCodeEnumeratedType
DealerProductsTypeCodeContentType
LeaseEndOptionVehicleDecisionEnumeratedType
LeaseEndOptionVehicleDecisionContentType
LeaseEndOptionFinanceDecisionContentType
LeaseEndOptionFinanceDecisionEnumeratedType
RepairStatusCodeContentType
RepairStatusCodeEnumeratedType
AcquisitionMethodTypeCodeContentType
AcquisitionMethodTypeCodeEnumeratedType
PartConditionCodeContentType
PartConditionCodeEnumeratedType
PartSalesRestrictionCodeContentType
PartSalesRestrictionCodeEnumeratedType
PartOrderingRestrictionCodeContentType
PartOrderingRestrictionCodeEnumeratedType
StockingLevelIndicatorCodeContentType
StockingLevelIndicatorCodeEnumeratedType
DistributionMethodCodeContentType
DistributionMethodCodeEnumeratedType
BuyPercentageRateAdjustmentTypeContentType
BuyPercentageRateAdjustmentTypeEnumeratedType
TaxCreditTypeContentType
TaxCreditTypeEnumeratedType
TransferStatusContentType
TransferStatusEnumeratedType
PaymentLineTypeContentType
PaymentLineTypeEnumeratedType
TaxStatusCodeContentType
DateTypeCodeEnumeratedType
PartQuantityEnumeratedType
InventoryQuantityEnumeratedType
IncoTermsEnumeratedType
VehicleStatusEnumeratedType
PriceTypeEnumeratedType
DiscountTypeEnumeratedType
SurchargeTypeEnumeratedType
CostTypeEnumeratedType
TaxTypesEnumeratedType
TaxJurisdictionEnumeratedType
PriceScopeEnumeratedType
TypeOfShipDateEnumeratedType
OAGIS 9 Code Lists
ActionCodeEnumerationType
ActionCodeContentType
AgencyRoleCodeEnumerationType
AgencyRoleContentType
CategoryCodeEnumerationType
CategoryCodeContentType
ChargeBearerCodeEnumerationType
ChargeBearerCodeContentType
ChargeCodeEnumerationType
ChargeCodeContentType
ClassificationCodeEnumerationType
ClassificationCodeContentType
ChequeDeliveryMethodCodeEnumerationType
ChequeDeliveryMethodCodeContentType
ChequeInstructionCodeEnumerationType
ChequeInstructionCodeContentType
ContactLocationCodeEnumerationType
ContactLocationCodeContentType
ControlAssertionEnumerationType
ControlAssertionContentType
ControlCodeEnumerationType
ControlCodeContentType
ControlComponentEnumerationType
ControlComponentContentType
CountryCodeEnumerationType
CountryCodeContentType
CountrySubdivisionCodeEnumerationType
CountrySubdivisionCodeContentType
CreditTransferCodeEnumerationType
CreditTransferCodeContentType
CurrencyCodeContentType
DayOfWeekCodeEnumerationType
DayOfWeekCodeContentType
DebitCreditCodeEnumerationType
DebitCreditCodeContentType
DeliveryPointCodeEnumerationType
DeliveryPointCodeContentType
EMailFormatCodeEnumerationType
EMailFormatCodeContentType
EngineeringActivityCodeEnumerationType
EngineeringActivityCodeContentType
EngineeringWorkOrderCodeEnumerationType
EngineeringWorkOrderCodeContentType
EngineeringWorkRequestCodeEnumerationType
EngineeringWorkRequestCodeContentType
EngineeringWorkRequestStatusCodeEnumerationType
EngineeringWorkRequestStatusCodeContentType
FinalAgentInstructionCodeEnumerationType
FinalAgentInstructionCodeContentType
FreightTermCodeEnumerationType
FreightTermCodeContentType
GenderCodeEnumerationType
GenderCodeContentType
IncotermsCodeEnumerationType
IncotermsCodeContentType
LanguageCodeContentType
LicenseTypeCodeEnumerationType
LicenseTypeCodeContentType
MaritalStatusCodeEnumerationType
MaritalStatusCodeContentType
MatchCodeEnumerationType
MatchCodeContentType
MatchDocumentEnumerationType
MatchDocumentContentType
MIMECodeContentType
PartyCategoryCodeEnumerationType
PartyCategoryCodeContentType
PartyRoleCodeEnumerationType
PartyRoleCodeContentType
PaymentBasisCodeEnumerationType
PaymentBasisCodeContentType
PaymentPurposeCodeEnumerationType
PaymentPurposeCodeContentType
PaymentMethodCodeEnumerationType
PaymentMethodCodeContentType
PaymentSchemeCodeEnumerationType
PaymentSchemeCodeContentType
PaymentTermCodeEnumerationType
PaymentTermCodeContentType
ProcessCategoryEnumerationType
ProcessCategoryContentType
ReasonCodeEnumerationType
ReasonCodeContentType
RecurrencePatternCodeEnumerationType
RecurrencePatternCodeContentType
RemitLocationMethodCodeEnumerationType
RemitLocationMethodCodeContentType
ResourceTypeCodeEnumerationType
ResourceTypeCodeContentType
ResponseActionCodeEnumerationType
ResponseActionCodeContentType
ResponseCodeEnumerationType
ResponseCodeContentType
RiskTypeEnumerationType
RiskCodeContentType
SalesActivityCodeEnumerationType
SalesActivityCodeContentType
SalesTaskCodeEnumerationType
SalesTaskCodeContentType
StateCodeEnumerationType
StateCodeContentType
SystemEnvironmentCodeEnumerationType
SystemEnvironmentCodeContentType
TaxCodeEnumerationType
TaxCodeContentType
TransferCodeEnumerationType
TransferCodeContentType
UnitCodeContentType
NMMA Code Lists
BoatLengthContentType
BoatDraftContentType
BoatCategoryContentType
BoatClassContentType
BoatHullMaterialContentType
BoatKeelContentType
BoatHullDesignContentType
BoatEngineLocationContentType
DisplacementMeasureTypeContentType
TankUsageCodeContentType
TankMaterialCodeContentType
AccommodationTypeCodeContentType
WindlassTypeCodeContentType
XFront.com Units of Measure
TemperatureUnitsContentType
LengthUnitsContentType
WeightUnitsContentType
VolumeUnitsContentType
AreaUnitsContentType
CookingUnitsContentType
SpeedUnitsContentType
TimeUnitsContentType
PowerUnitsContentType
FuelConsumptionUnitsContentType
ElectricityUnitsContentType
ForceUnitsContentType
PressureUnitsContentType
ComputerStorageUnitsContentType
DisplacementUnitsContentType

List of Figures

2.1. BOD Structure
2.2. Message Hierarchy

Preface

License

The STAR Schemas and STAR BOD Guidelines are released under an Eclipse Public License. When the word "program" is used in the Eclipse Public License for this case, it means the XML Schemas and the BOD Guideline. It does not mean the software application that uses the schema.

If modifications are made to this guideline they must follow rules outlined in the Eclipse Public License v1.0.

Eclipse Public License - v1.0

THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

Definition. 

"Contribution" means:

  • in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and

  • in the case of each subsequent Contributor:

  • changes to the Program, and

  • additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents" mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS. 

  • Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

  • Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

  • Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. Requirements. 

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

  • it complies with the terms and conditions of this Agreement; and

  • its license agreement:

    • effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

    • effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

    • states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

    • states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

  • it must be made available under this Agreement; and

    a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. Commercial Distribution. 

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. No Warranty. 

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement , including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY. 

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL. 

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Chapter 1. Introduction

Table of Contents

Guideline Organization

The STAR Business Object Document (BOD) Guidelines provide the data dictionary information for a particular business process. This document is broken into several sections, and to help reduce the overall size of the document, components are only documented once when they first occur. This section will cover both the organization of the document, and some of the common terminology used. More detailed information about the BOD methodology used can be found in the BOD XML Implementation Reference document available on the STAR web site.

Documentation for elements coming from OAGIS, is maintained by the Open Applications Group, and not maintained by STAR. BOD is a registered trademark of the Opena Applications Group.

The STAR BOD Guideline information is generated directly from the STAR schemas, and is created using the Docbook publishing specification format. The Docbook source format is available to members upon request.

Guideline Organization

This guideline is broken into several sections:

  • Use Cases - describe typical use case scenarios for the Verb and Noun combination in a particular guideline. This section may provide more detailed information on the use of particular components in various scenarios.

  • BOD Design - covers briefly the XML Namespaces used, and the overall structure of a BOD.

  • BOD Components - information regarding the attributes and components that are common to all BODs. This is the information that is found at the root element level of a business object document. This also includes information regarding the ApplicationArea that is sent with every BOD.

  • Data Area - The data area is where the noun and verb for a BOD reside.

  • Verbs - There may be several BODs that related to a particular noun, and several verbs used by the noun. To help reduce the overall number of guidelines that need to be generated, all verbs that a particular noun may use are documented in one area.

  • Noun - The noun contains the detailed information about the data that is carried by the BOD. This section will always be noun specific and is the main section implementors should focus their attention.

The order in which the data elements show up in the BOD Guideline is the order in which they occur in the XML instance. In order to help reduce the overall size of the guidelines, a component is only documented the first time it occurs. Fields may occur in multiple components and so may be documented multiple times. So as the user goes through the guidelines, they should be able to match up a component to a particular XML instance. It is recommended at the minimum that a sample XML Instance for the BOD being mapped be generated to help seeing the hierarchical structure of the document. Many XML editors will provide a tree view of the XML Instance that can be used in conjunction with these guidelines during the mapping exercise. Also, there is space intentionally left over for users to add their own notes and annotations to the guidelines.

Chapter 2. BOD Design

This section covers the fundamentals of the STAR BOD architecture. This is provided for reference only, and more details can be found in the documentation mentioned within this section.

XML Instance Namespaces

Namespaces are unique identifiers for an element or attribute. It allows for the same element or attribute name to come from different sources and have uniquie meanings. The namespace identifies the source of the definition for the element or attribute. STAR XML Instances currently only require the use of two namespaces:

  • http://www.starstandard.org/STAR/6 - This identifies the items that come from a STAR 6 repository, and is usally used with a prefix of "star" or "star6".

  • http://www.openapplications.org/oagis/10 - This identifies the items that come from the OAGI 10 repository. The prefix used for these is typically "oag" or "oagis10".

Note: Namespaces do not have to be resolvable. They are just unique identifiers. If a namespace is assigned to the default namespace, then a prefix does not need to be used. Only one namespace can be assigned to the default namespace. Prefixes are just short cuts to the namespace identifier, systems should not rely on the prefix, but the namespace iteself when identifying elements and attributes.

Schema Namespaces

The STAR XML Schemas use several namespaces internally. Depending on software that is being used to create the XML instances that are transmitted some of these namespaces may show up in the BOD itself. All references to these namespaces can be safely removed. For more information on the namespaces that are used by the schemas, please see the STAR XML Naming and Design Rules document.

  • http://www.starstandard.org/STAR/6/qualifieddatatypes/1.0 - Defines the namespace for the STAR Qualified Data Types. The prefix is sqdt .

  • http://www.starstandard.org/STAR/6/codelists - Defines the namespace for the STAR Code Lists. The prefix is scl .

  • http://www.nmma.org/CodeLists - Defines the namespace for the National Marine Manufacture Association Code Lists. The prefix is nmmacl .

  • http://www.xfront.com/UnitsOfMeasure - Defines the namespace for XFront.com's Unit of Measure code lists. STAR has contributed to and enhanced the initial list and all changes are included in the codelist available at www.xfront.com. The prefix is xfUOMcl .

These namespaces are used primarily in the construction of the data types and code lists that the elements and attributes use. They are used internally by the schema and are here for documentation purposes only. These should not show up in the XML Instance.

BOD Structure

A BOD's structure is depicted in Figure 2.1, “BOD Structure” . A BOD will always be made up of the ApplicationArea, DataArea, Noun and components.

Figure 2.1. BOD Structure

BOD Structure

A typical BOD will have the following message hierarchy:

Figure 2.2. Message Hierarchy

Message Hierarchy

The Application Area is standard across the BODs. Every BOD may have a different set of verbs that can be used with it. The verbs describes the various actions that can occur. More detail about these components can be found in the appropriate sections with in this guideline. For a more detailed explanation of the BODs design structure, please refer to the BOD XML Implementation Reference document available from the STAR Web Site.

Chapter 3. BOD Components

Business Object Document - BOD

A BOD is made up of the combination of the Application Area, Data Area, Verb, and Noun. The name of a particular BOD is made up of the Verb and the Noun being used. For example, a Credit Application, may have several BODs that are involved to complete a business transaction. The BOD names may be:

  • Process CreditApplication - where Process is the Verb and CreditApplication is the name of the Noun .

  • Acknowledge CreditApplication - where Acknowledge is the Verb and CreditApplication is the name of the Noun .

The Verb documentation section in this guideline lists the available verbs that can be used with the Noun included in this guideline. There will be a corresponding Verb/Noun schema combination in the STAR Schema Repository.

The root element, top element, of the XML Instance will also be the Verb/Noun Combination. So for the AcknowledgeCreditApplication BOD, the root element would look like the following:

Example 3.1. Root Element Example

<AcknowledgeCreditApplication>
   <ApplicationArea>......</ApplicationArea>     [1..1]
   <AcknowledgeCreditApplicationDataArea>......</AcknowledgeCreditApplicationDataArea>     [1..*]
</AcknowledgeCreditApplication>
         

Business Object Document Attributes

All root elements of all the STAR BODs have several attributes that can be included with them. These attributes

Table 3.1. Attributes

NameDescriptionOccurrenceTypeData TypeUser Notes
releaseID

STAR Release this BOD Instances belongs.

1..1Attributeudt:string 
versionID

Deprecated. Recommended to use releaseID to identify the repository and noun. This field may be removed in the next major version of the STAR repository.

Indicates the version of the given Noun.

0..1Attributeudt:string 
systemEnvironmentCode

Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s).

0..1Code Listoacl:SystemEnvironmentCodeContentType 
languageCode

Indicates the language that the contents of the BOD is in unless otherwise stated.

0..1Code Listscl:LanguageEnumeratedType 

Business Object Document Fields and Components

The following are the components and fields that make up the Business Object Document. The name of the Data Area will vary by BOD, and be the combination of the Verb and Noun, with the word DataArea added to the end.

Fields and Components

Table 3.2. Fields and Components

NameDescriptionOccurrenceTypeData TypeUser Notes
ApplicationArea

Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of.

0..1ComponentApplicationAreaType 
[Verb][Noun]DataArea

The Data Area contains the verb and noun to be used. And is represented by the verb and noun combination for the BOD.

1..1Component  

Sample XML

The XML Sample provided here is an approximation of the generated XML for this component. Not all of the fields are required for implementation. This sample is the same regardless of the BOD only the Root Element and the Data Area names will be different.

Example 3.2. AcknowledgeCreditApplication

<AcknowledgeCreditApplication>
   <ApplicationArea>......</ApplicationArea>     [1..1]
   <AcknowledgeCreditApplicationDataArea>......</AcknowledgeCreditApplicationDataArea>     [1..*]
</AcknowledgeCreditApplication>
               

ApplicationArea

Uses the Component: ApplicationAreaType

Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of.

Fields and Components

Table 3.3. Fields and Components

NameDescriptionOccurrenceTypeData TypeUser Notes
Sender

This identifies characteristics and control identifiers that relate to the application that created the Business Object Document.

0..1ComponentSenderType 
Intermediary

This identifies characteristics and control identifiers that relate to an intermediary application that interacts with the Business Object Document.

0..*ComponentIntermediaryType 
Receiver

Identifies the intended receiver of the given BOD instance.

0..*ComponentReceiverType 
CreationDateTime

is the date time stamp that the given instance of the Business Object Document was created. This date must not be modified during the life of the Business Object Document.

1..1Fieldoag:DateTimeType 
Signature

If the BOD is to be signed the signature element is included, otherwise it is not. Signature supports any digital signature that maybe used by an implementation of OAGIS. The qualifyingAgency identifies the agency that provided the format for the signature.

0..1Componentoag:SignatureType 
ScenarioID

0..1Fieldoag:IDType 
CorrelationID

0..1Fieldoag:IDType 
BODID

The BODId provides a place to carry a Globally Unique Identifier (GUID) that will make each Business Object Document instance uniquely identifiable. This is a critical success factor to enable software developers to use the Globally Unique Identifier (GUID) to build services or capabilities:

0..1Fieldoag:IDType 

Sample XML

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 3.3. ApplicationArea

<ApplicationArea>
     <Sender>......</Sender>     [0..1]
     <Intermediary>......</Intermediary>     [0..*]
     <Receiver>......</Receiver>     [0..*]
     <CreationDateTime>......</CreationDateTime>     [1..1]
     <oag:Signature>......</oag:Signature>     [0..1]
     <ScenarioID>......</ScenarioID>     [0..1]
     <CorrelationID>......</CorrelationID>     [0..1]
     <BODID>......</BODID>     [0..1]
</ApplicationArea>

Sender

Uses the Component: SenderType

This identifies characteristics and control identifiers that relate to the application that created the Business Object Document.

Fields and Components

Table 3.4. Fields and Components

NameDescriptionOccurrenceTypeData TypeUser Notes
LogicalID

Provides the logical location of the server and applications from which the Business Object Document originated. It can be used to establish a logical to physical mapping, however its use is optional. Each system or combination of systems should maintain an external central reference table containing the logical names or logical addresses of the application systems in the integration configuration. This enables the logical names to be mapped to the physical network addresses of the resources needed on the network. Note: The technical implementation of this Domain Naming Service is not dictated by this specification. This logical to physical mapping may be done at execution time by the application itself or by a middleware transport mechanism, depending on the integration architecture used. This provides for a simple but effective directory access capability while maintaining application independence from the physical location of those resources on the network.

0..1Fieldoag:IDType 
ComponentID

Provides a finer level of control than Logical Identifier and represents the business application that issued the Business Object Document. Its use is optional. The Open Applications Group has not constructed the list of valid Component names. A suggestion for naming is to use the application component names used in the scenario diagrams in section two of OAGIS. Example Components may be Inventory, or Payroll.

0..1Fieldoag:IDType 
TaskID

This describes the business event that initiated the need for the Business Object Document to be created.

0..1Fieldoag:IDType 
ReferenceID

Enables the sending application to indicate the instance identifier of the event or task that caused the BOD to be created.  This is used to correlate a response BOD to an originating BOD. *The Sender of the originating application will populate the Reference Id with business level information. *Reference ID does not have to be a GUID. It must be a locally unique application value for the transaction type, for example a database sequence number. *The receiving application puts the value in Reference ID of the incoming message in the Reference ID of any acknowledgment messages. *The Reference Id will not be required to tie two collaborations together such as Parts Order and Parts Shipment.

0..1Fieldoag:IDType 
ConfirmationCodes

Confirmation Codes.

0..1ComponentConfirmationCodesType 
AuthorizationID

Identifies the authorization level of the user or application that is sending the Business Object Document Message. Used as User ID.

0..1Fieldoag:OpenIDType 
ID

Is the Identifiers of the given instance of an entity within the scope of the integration. The schemeAgencyID attribute identifies the party that provided or knows this party by the given identifier.

0..1Fieldoag:OpenIDType 

Sample XML

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 3.4. Sender

<Sender>
     <LogicalID>......</LogicalID>     [0..1]
     <ComponentID>......</ComponentID>     [0..1]
     <TaskID>......</TaskID>     [0..1]
     <ReferenceID>......</ReferenceID>     [0..1]
     <ConfirmationCode>......</ConfirmationCode>     [0..1]
     <AuthorizationID>......</AuthorizationID>     [0..1]
     <ID>......</ID>     [0..1]
</Sender>

Intermediary

Uses the Component: IntermediaryType

Identifies the intended receiver of the given BOD instance.

Fields and Components

Table 3.5. Fields and Components

NameDescriptionOccurrenceTypeData TypeUser Notes
LogicalID

Provides the logical location of the server and applications from which the Business Object Document originated. It can be used to establish a logical to physical mapping, however its use is optional. Each system or combination of systems should maintain an external central reference table containing the logical names or logical addresses of the application systems in the integration configuration. This enables the logical names to be mapped to the physical network addresses of the resources needed on the network. Note: The technical implementation of this Domain Naming Service is not dictated by this specification. This logical to physical mapping may be done at execution time by the application itself or by a middleware transport mechanism, depending on the integration architecture used. This provides for a simple but effective directory access capability while maintaining application independence from the physical location of those resources on the network.

0..1Fieldoag:IDType 
ComponentID

Provides a finer level of control than Logical Identifier and represents the business application that issued the Business Object Document. Its use is optional. The Open Applications Group has not constructed the list of valid Component names. A suggestion for naming is to use the application component names used in the scenario diagrams in section two of OAGIS. Example Components may be Inventory, or Payroll.

0..1Fieldoag:IDType 
ID

Is the Identifiers of the given instance of an entity within the scope of the integration. The schemeAgencyID attribute identifies the party that provided or knows this party by the given identifier.

0..1Fieldoag:OpenIDType 
ReceivedDateTime

The date and time that the associated object was received.

0..1Fieldoag:xbt_DateTimeType 
SentDateTime

The date and time that the associated object was sent.

0..1Fieldoag:xbt_DateTimeType 

Sample XML

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 3.5. Intermediary

<Intermediary>
     <LogicalID>......</LogicalID>     [0..1]
     <ComponentID>......</ComponentID>     [0..1]
     <ID>......</ID>     [0..*]
     <ReceivedDateTime>......</TaskID>     [0..1]
     <SentDateTime>......</ReferenceID>     [0..1]
</Intermediary>

Receiver

Uses the Component: ReceiverType

Identifies the intended receiver of the given BOD instance.

Fields and Components

Table 3.6. Fields and Components

NameDescriptionOccurrenceTypeData TypeUser Notes
LogicalID

Provides the logical location of the server and applications from which the Business Object Document originated. It can be used to establish a logical to physical mapping, however its use is optional. Each system or combination of systems should maintain an external central reference table containing the logical names or logical addresses of the application systems in the integration configuration. This enables the logical names to be mapped to the physical network addresses of the resources needed on the network. Note: The technical implementation of this Domain Naming Service is not dictated by this specification. This logical to physical mapping may be done at execution time by the application itself or by a middleware transport mechanism, depending on the integration architecture used. This provides for a simple but effective directory access capability while maintaining application independence from the physical location of those resources on the network.

0..1Fieldoag:IDType 
ComponentID

Provides a finer level of control than Logical Identifier and represents the business application that issued the Business Object Document. Its use is optional. The Open Applications Group has not constructed the list of valid Component names. A suggestion for naming is to use the application component names used in the scenario diagrams in section two of OAGIS. Example Components may be Inventory, or Payroll.

0..1Fieldoag:IDType 
ID

Is the Identifiers of the given instance of an entity within the scope of the integration. The schemeAgencyID attribute identifies the party that provided or knows this party by the given identifier.

0..1Fieldoag:OpenIDType 

Sample XML

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 3.6. Receiver

<Receiver>
     <LogicalID>......</LogicalID>     [0..1]
     <ComponentID>......</ComponentID>     [0..1]
     <ID>......</ID>     [0..*] 
</Receiver>

ConfirmationCodes

Uses the Component: ConfirmationCodesType

Confirmation Codes.

Fields and Components

Table 3.7. Fields and Components

NameDescriptionOccurrenceTypeData TypeUser Notes
ProcessingConfirmationCode

The processing confirmation code.

0..1Fieldoag:CodeType 
ConfirmationCode

Is an option controlled by the Sender business application. It is a request to the receiving application to send back a confirmation BOD to the sender. The confirmation Business Object Document may indicate the successful processing of the original Business Object Document or return error conditions if the original Business Object Document was unsuccessful.

The confirmation request has the following valid values:

  • Never - No confirmation Business Object Document requested

  • OnError - OnError send back a confirmation Business Object Document only if an error has occurred

  • Always - Always send a confirmation Business Object Document regardless

0..1Code Listoag:ConfirmationCodeContentType 

Sample XML

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 3.7. ConfirmationCodes

<ConfirmationCodes>
     <ProcessConfirmationCode>......</LogicalID>     [0..*]
     <ConfirmationCode>......</ComponentID>     [0..1]
     <ID>......</ID>     [0..*] 
</ConfirmationCodes>

Chapter 4. Data Area Components

AcknowledgeCreditApplicationDataArea

Uses the Component:AcknowledgeCreditApplicationDataAreaType

Process Credit Application Data Area

Fields and Components

Table 4.1. Fields and Components

Name Description Occurrence Type Data Type User Notes
Acknowledge

The Acknowledge verb is used to acknowledge the application receipt of a Process request. This function conveys the result of the original request. An example of this is Acknowledge PO, where a Process PO has been issued and the corresponding business application acknowledges the receipt of the PO and responds with an acceptance or a counter offer.

0..1ComponentAcknowledgeType 
CreditApplication

CreditApplication is the root element of the Credit Application Business Object Document.

0..*ComponentCreditApplicationType 

Sample XML

The XML Sample provided here is an approximation of the genrated XML for this component. Not all of the fields are required for implementation.

Example 4.1. AcknowledgeCreditApplicationDataArea

<AcknowledgeCreditApplicationDataArea>
   <Acknowledge>......</Acknowledge>     [0..1]
   <CreditApplication>......</CreditApplication>     [0..*]
</AcknowledgeCreditApplicationDataArea>
               

Chapter 5. Verbs

Acknowledge

Uses the Component: AcknowledgeType

The Acknowledge verb is used to acknowledge the application receipt of a Process request. This function conveys the result of the original request. An example of this is Acknowledge PO, where a Process PO has been issued and the corresponding business application acknowledges the receipt of the PO and responds with an acceptance or a counter offer.

Fields and Components

Table 5.1. Fields and Components

Name Description Occurrence Type Data Type User Notes
OriginalApplicationArea

A copy of the ApplicationArea for the original BOD that was processed. Present either as additional reference information, or for use in identifying the BOD in situations where a BODReference is not known.

0..1ComponentApplicationAreaType 
ResponseCriteria

ResponseCriteria identifies the content that is returned, given a Get query success or the response from the Process. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned.

ReturnCriteria plays no role in the query itself or the process. That is handled as a match against the request BOD's noun exemplar.

ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns.

That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated.

The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies.

0..*ComponentResponseActionCriteriaType 

Sample XML

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 5.1. Acknowledge

<Acknowledge>
     <OriginalApplicationArea>......</OriginalApplicationArea>     [0..1]
     <oagis:ResponseCriteria>......</oagis:ResponseCriteria>     [0..*]
</Acknowledge>
                
            

Cancel

Uses the Component: CancelType

The Cancel verb is used when the sender of the BOD is not the owner of the data, but is sending a request for the document to be canceled.An example is the Cancel PO where the business implications must be calculated and a simple data processing term such as delete can not fully convey the business meaning and required processing associated with the meaning.

Fields and Components

Table 5.2. Fields and Components

Name Description Occurrence Type Data Type User Notes
ActionCriteria

Identifies with the ActionExpression the level by carrying a value of the expressionLanguage (this is typically XPath) within the BOD that the actionCode is to be performed. The ChangeStatus communicates just that the Change Status.

0..*ComponentActionCriteriaType 

Sample XML

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 5.2. Cancel

<Cancel>
</Cancel>
                
            

Change

Uses the Component: ChangeType

The Change verb is used when the sender of the BOD is not the owner of the data, but is sending a request for the document to be changed.An example of this is Change REQUISITN, where the original document needs to be changed based on a specific business event.

Fields and Components

Table 5.3. Fields and Components

Name Description Occurrence Type Data Type User Notes
responseCode

See the code list for a list of possible values.

0..1Attributeoacl:ResponseActionCodeContentType 
ActionCriteria

Identifies with the ActionExpression the level by carrying a value of the expressionLanguage (this is typically XPath) within the BOD that the actionCode is to be performed. The ChangeStatus communicates just that the Change Status.

0..*ComponentActionCriteriaType 

Sample XML

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 5.3. Change

<Change>
</Change>
                
            

Get

Uses the Component: GetType

The Get verb is to communicate to a business software component a request for an existing piece or pieces of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.

The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across the nouns it is paired with.The Get is designed for retrieval of information by using that information's primary retrieval field, or key field. The Get verb may also be used to request several documents at once.

Selection Criteria:  There are two types of selection capabilities for most BOD's that use the Get verb.

  • The first selection capability is called Field-Based Selection. Within a Get-base Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.

  • The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned.

Fields and Components

Table 5.4. Fields and Components

Name Description Occurrence Type Data Type User Notes
uniqueIndicator

Only return unique items, remove any duplicates. This has the same effect as an SQL statements DISTINCT command.

0..1Attribute udt:IndicatorType  
maxItems

Communicates the maximum number of records which should be returned in a segment from a recordSet.

0..1Attribute qdt:PositiveIntegerNumericType  
recordSetSaveIndicator

A true value indicates that receiver should save the record set

0..1Attribute udt:IndicatorType  
recordSetStartNumber

The record number identifying the first record that should be returned in the Show response.  This attribute is specified on subsequent Get requests, not the initial Get request.  The systems may determine this number from the prior Show message (see the Show verb attributes for more information).

0..1Attribute qdt:PositiveIntegerNumericType  
recordSetReferenceId

Unique identifier of the RecordSet.  It is generated by the producer of the Show response as a result of the original Get request.

0..1Attribute xsd:normalizedString  
Expression The expression used to specify the selection or filter criteria.1..*ComponentExpressionType 

Sample XML

The XML Sample provided here is an approximation of the genrated XML for this component. Not all of the fields are required for implementation.

Example 5.4. Get

<Get uniqueIndicator="true" maxItems="10">
   <Expression>......</Expression>    [0..*]
</Get>
            

Process

Uses the Component: ProcessType

The Process verb is used to request processing of the associated noun by the receiving application or business to party. In a typical external exchange scenario a Process BOD is considered to be a legally binding message. For example, if a customer sends a ProcessPurchaseOrder BOD to a supplier and the supplier acknowledges with a positive AcknowledgePurchaseOrder, then the customer is obligated to fulfill the agreement, unless of course other BODs are allowed to cancel or change the original order.

Fields and Components

Table 5.5. Fields and Components

Name Description Occurrence Type Data Type User Notes
acknowledgeCode

A value that indicates when an Acknowledgment should be sent back to the sender.

0..1Attributeoacl:ResponseCodeContentType 
ActionCriteria

Identifies with the ActionExpression the level by carrying a value of the expressionLanguage (this is typically XPath) within the BOD that the actionCode is to be performed. The ChangeStatus communicates just that the Change Status.

0..*ComponentActionCriteriaType 

Sample XML

The XML Sample provided here is an approximation of the genrated XML for this component. Not all of the fields are required for implementation.

Example 5.5. Process

<Process>
   <ActionCriteria>......</ActionCriteria>    [0..*]
</Process>
                
            

Respond

Uses the Component: RespondType

The Respond verb is used to communicate relative to another document. It may be used to communicate agreement, questions, answers to a question, or disagreement with the related document. An example is the RequestForQuote and Quote document pair. An RequestForQuote is issued to a set of business partners. If one of the partners needs clarification on an item, a RespondRequestForQuote is sent to the originating partner.

Fields and Components

Table 5.6. Fields and Components

Name Description Occurrence Type Data Type User Notes
OriginalApplicationArea

A copy of the ApplicationArea for the original BOD that was processed. Present either as additional reference information, or for use in identifying the BOD in situations where a BODReference is not known.

0..1ComponentApplicationAreaType 
ResponseCriteria

ResponseCriteria identifies the content that is returned, given a Get query success or the response from the Process. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself or the process. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies.

0..*ComponentResponseActionCriteriaType 

Sample XML

The XML Sample provided here is an approximation of the genrated XML for this component. Not all of the fields are required for implementation.

Example 5.6. Respond

<Respond>
     <OriginalApplicationArea>......</OriginalApplicationArea>     [0..1]
     <oagis:ResponseCriteria>......</oagis:ResponseCriteria>     [0..*]
</Respond>
                
            

Show

Uses the Component: ShowType

The Show verb is used when sending the information about a specific instance of a business document or entity. The Show verb may be used to respond to a Get request or it can be used in a publish scenario, where it pushes information to other applications based on a business event.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the Show decides to use the information it receives to update. This is entirely the decision of the receiving software component and is not forbidden.The behavior of the Show verb is quite straight forward with one exception. The Show response to any Get request needs to read the request carefully to ensure the response is returning the requested Data Types.

Fields and Components

Table 5.7. Fields and Components

Name Description Occurrence Type Data Type User Notes
recordSetStartNumber

The record number identifying the first record returned in the Show response.  The producer of the Show response generates this number. It used by the requesting system to determine the start number of the subsequent Get request.

0..1Attributeqdt_PositiveIntegerNumericType 
recordSetCount

Number of records in the recordSet.

0..1Attributeqdt_PositiveIntegerNumericType 
recordSetTotal

Number of records in the recordSet.

0..1Attributeqdt_PositiveIntegerNumericType 
recordSetCompleteIndicator

Indicates whether this is the last segment of the recordSet.

0..1Attributeudt_IndicatorType 
recordSetReferenceId

Unique identifier of the RecordSet. It is generated by the producer of the Show response as a result of the original Get request.

0..1Attributexsd:normalizedString 
OriginalApplicationArea

A copy of the ApplicationArea for the original BOD that was processed. Present either as additional reference information, or for use in identifying the BOD in situations where a BODReference is not known.

0..1ComponentApplicationAreaType 
ResponseCriteria

ResponseCriteria identifies the content that is returned, given a Get query success or the response from the Process. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself or the process. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies.

0..*ComponentResponseActionCriteriaType 

Sample XML

The XML Sample provided here is an approximation of the genrated XML for this component. Not all of the fields are required for implementation.

Example 5.7. Show

<Show>
     <OriginalApplicationArea>......</OriginalApplicationArea>     [0..1]
     <oagis:ResponseCriteria>......</oagis:ResponseCriteria>     [0..*]
</Show>
            

Update

Uses the Component: UpdateType

The Update verb is used to describe specific processing in a more fine-grained manner beyond add, change or delete processing. An example is the update of inspection information from one business application to another. The event is not adding a document, or changing fields per se, it is communicating the occurrence of an event as well as the corresponding data that accompanies the event.

Fields and Components

Table 5.8. Fields and Components

Name Description Occurrence Type Data Type User Notes
ActionCriteria

Identifies with the ActionExpression the level by carrying a value of the expressionLanguage (this is typically XPath) within the BOD that the actionCode is to be performed. The ChangeStatus communicates just that the Change Status.

0..*ComponentActionCriteriaType 

Sample XML

The XML Sample provided here is an approximation of the genrated XML for this component. Not all of the fields are required for implementation.

Example 5.8. Update

<Update>
</Update>
                
            

ActionCriteria

Uses the Component: ActionCriteriaType

Identifies with the ActionExpression the level by carrying a value of the expressionLanguage (this is typically XPath) within the BOD that the actionCode is to be performed. The ChangeStatus communicates just that the Change Status.

Fields and Components

Table 5.9. Fields and Components

Name Description Occurrence Type Data Type User Notes
ActionExpression Identifies the level or field items that the specified action is to be performed upon.0..*ComponentActionExpressionType 
ChangeStatus Communicates the Change Status.0..1ComponentChangeStatusType 

Sample XML

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 5.9. ActionCriteria

<ActionCriteria>
     <ActionExpression>......</ActionExpression>     [0..*]
     <ChangeStatus>......</ChangeStatus>     [0..1]
</ActionCriteria>
                
            

ActionExpression

Uses the Component: ActionExpressionType

Awaiting clear definition for OAGI.

Fields and Components

Table 5.10. Attributes

Name Description Occurrence Type Data Type User Notes
actionCode The action to be performed. This could be Add, Change, Replace, Delete, etc. See the code list for acceptable values. 1..1Attributeoacl:ActionCodeContentType 
expressionLanguage

The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies.

1..1Attributexsd:token 

Sample XML

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 5.10. ActionExpression

<ActionExpression @actionCode="Add" expressionLanguage="XPATH">
    An XPath Expression would go here
</ActionExpression>
            

Expression

Uses the Component: ExpressionType

Expression is used to specify a filter or selection criteria.

Fields and Components

Table 5.11. Fields and Components

Name Description Occurrence Type Data Type User Notes
expressionLanguage

The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies.

0..1Attributexsd:token 

Sample XML

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 5.11. Expression

<Expression @expressionLanguage="XPATH">
    An XPATH or other Expression Language syntax.
</Expression>
            

OriginalApplicationArea

Uses the Component: ApplicationAreaType

A copy of the ApplicationArea for the original BOD that was processed. Present either as additional reference information, or for use in identifying the BOD in situations where a BODReference is not known.

For the definition of the fields and components in this component, please refer to the ApplicationArea component defined earlier.

ResponseCriteria

Uses the Component: ResponseActionCriteriaType

ResponseCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned.

ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar.

ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns.

That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated.

The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies.

Fields and Components

Table 5.12. Fields and Components

Name Description Occurrence Type Data Type User Notes
ResponseExpression

ResponseExpression identifies a pointer to the Component being provided as a response to a request. This point is provided using an appropriate value of the given expressionLanguage indicated. The actionCode is intended to indicate what has occured with the given component and/or instance of the given component.

0..1ComponentResponseExpressionType 
ChangeStatus  0..1ComponentChangeStatusType 

Sample XML

The XML Sample provided here is an approximation of the genrated XML for this component. Not all of the fields are required for implementation.

Example 5.12. ResponseCriteria

<ResponseCriteria>
     <ResponseExpression>......</ResponseExpression>     [0..1]
     <ChangeStatus>......</ChangeStatus>     [0..1]
</ResponseCriteria>
                
            

ResponseExpression

Uses the Component: ResponseExpressionType

ResponseExpression identifies a pointer to the Component being provided as a response to a request. This point is provided using an appropriate value of the given expressionLanguage indicated. The actionCode is intended to indicate what has occurred with the given component and/or instance of the given component.

Fields and Components

Table 5.13. Fields and Components

Name Description Occurrence Type Data Type User Notes
actionCode

Indicates what has occured with a particular expression.

0..1Attributeoacl:ResponseActionCodeContentType 
expressionLanguage

The expression language used. This is typically XPATH.

0..1Attributexsd:token 

Sample XML

The XML Sample provided here is an approximation of the genrated XML for this component. Not all of the fields are required for implementation.

Example 5.13. ResponseExpression

<ResponseExpression>
   An expression.
</ResponseExpression>
            

ChangeStatus

Uses the Component: ChangeStatusType

Fields and Components

Table 5.14. Fields and Components

Name Description Occurrence Type Data Type User Notes
Code

Element for the communication of all codes.

0..1Field udt:CodeType  
Description 0..1Field udt:TextType  
EffectiveDateTime

This is the DateTime the associated object is made effective

0..1Fieldudt:DateTimeType 
ReasonCode

Identifies the reason for an activity

0..1Field udt:CodeType  
Reason  0..*Fieldudt:TextType 
StateChange  0..*ComponentStateChangeType 

Sample XML

The XML Sample provided here is an approximation of the genrated XML for this component. Not all of the fields are required for implementation.

Example 5.14. ChangeStatus

<ChangeStatus>
     <Code>......</Code>     [0..1]
     <Description>......</Description>     [0..1]
     <EffectiveDateTime>......</EffectiveDateTime>     [0..1]
     <ReasonCode>......</ReasonCode>     [0..1]
     <Reason>......</Reason>     [0..*]
     <StateChange>......</StateChange>     [0..*]
</ChangeStatus>
            

StateChange

Uses the Component: StateChangeType

Fields and Components

Table 5.15. Fields and Components

Name Description Occurrence Type Data Type User Notes
FromStateCode  0..1Fieldudt:CodeType 
ToStateCode  0..1Fieldudt:CodeType 
ChangeDateTime

Indicates when the status change occured.

0..1Fieldudt:DateTimeType 

Sample XML

The XML Sample provided here is an approximation of the genrated XML for this component. Not all of the fields are required for implementation.

Example 5.15. StateChange

<StateChange>
     <FromStateCode>......</FromStateCode>     [0..1]
     <ToStateCode>......</ToStateCode>     [0..1]
     <ChangeDateTime>......</ChangeDateTime>     [0..1]
</StateChange>
            

Chapter 6. Sales Lead Noun

Table of Contents

SalesLead
Fields and Components
Sample XML
SalesLeadHeader
Fields and Components
Sample XML
DocumentIdentification
Fields and Components
Sample XML
DocumentIdentifier
Fields and Components
Sample XML
AlternateDocumentIdentifier
Fields and Components
Sample XML
ProviderParty
Fields and Components
Sample XML
ConsumerParty
Fields and Components
Sample XML
CustomerParty
Fields and Components
Sample XML
Party
Fields and Components
Sample XML
PartyBase
Fields and Components
Sample XML
SpecifiedOrganization
Fields and Components
Sample XML
PrimaryContact
Fields and Components
Sample XML
SpecifiedPerson
Fields and Components
Sample XML
ResidenceAddress
Fields and Components
Sample XML
TelephoneCommunication
Fields and Components
Sample XML
FaxCommunication
Fields and Components
Sample XML
URICommunication
Fields and Components
Sample XML
PostalAddress
Fields and Components
Sample XML
SpecifiedOccupation
Fields and Components
Sample XML
UsagePreference
Fields and Components
Sample XML
PartyActionEvent
Fields and Components
Sample XML
SalesLeadInfo
Fields and Components
Sample XML
Vehicle
Fields and Components
Sample XML
VehicleBase
Fields and Components
Sample XML
VehicleModel
Fields and Components
Sample XML
VehicleDetails
Fields and Components
Sample XML
Color
Fields and Components
Sample XML
OdometerReading
Fields and Components
Sample XML
CountryOfOrigin
Fields and Components
Sample XML
VehicleConfiguration
Fields and Components
Sample XML
Transmission
Fields and Components
Sample XML
Chassis
Fields and Components
Sample XML
Tank
Fields and Components
Sample XML
Engine
Fields and Components
Sample XML
ItemIdentifier
Fields and Components
Sample XML
Battery
Fields and Components
Sample XML
VehicleConfigItem
Fields and Components
Sample XML
EffectivePeriod
Fields and Components
Sample XML
Price
Fields and Components
Sample XML
ConfigurationAlternative
Fields and Components
Sample XML
TelematicUnit
Fields and Components
Sample XML
TelematicUnitSoftware
Fields and Components
Sample XML
VehicleStatus
Fields and Components
Sample XML
VehicleEvent
Fields and Components
Sample XML
ImageAttachmentExtended
Fields and Components
Sample XML
EmbeddedData
Fields and Components
Sample XML
FreeFormTextGroup
Fields and Components
Sample XML
CertificationGroup
Fields and Components
Sample XML
PreviousOwnerParty
Fields and Components
Sample XML
SalesLeadDetail
Fields and Components
Sample XML
Financing
Fields and Components
Sample XML
CreditorFinancialInstitution
Fields and Components
Sample XML
SpecifiedFinancialAccount
Fields and Components
Sample XML
CreditFinancing
Fields and Components
Sample XML
FinancialOrganization
Fields and Components
Sample XML
FleetAccount
Fields and Components
Sample XML
FleetQuantity
Fields and Components
Sample XML
EstimatedFinancingAmounts
Fields and Components
Sample XML
Tax
Fields and Components
Sample XML
Fee
Fields and Components
Sample XML
OtherDownPaymentsGroup
Fields and Components
Sample XML
OtherDownPayments
Fields and Components
Sample XML
PaymentActivity
Fields and Components
Sample XML
FinalFinancingAmounts
Fields and Components
Sample XML
CreditScoreGroup
Fields and Components
Sample XML
Insurance
Fields and Components
Sample XML
SpecifiedAddress
Fields and Components
Sample XML
InsuranceDetail
Fields and Components
Sample XML
LossPayee
Fields and Components
Sample XML
PolicyHolderParty
Fields and Components
Sample XML
SalesAppointment
Fields and Components
Sample XML
RequestedAppointmentPeriod
Fields and Components
Sample XML
AppointmentContactParty
Fields and Components
Sample XML
SalesActivity
Fields and Components
Sample XML
SalesActivityDocument
Fields and Components
Sample XML
SalesActivityActionEvent
Fields and Components
Sample XML
SalesOffer
Fields and Components
Sample XML
Pricing
Fields and Components
Sample XML
Option
Fields and Components
Sample XML
OptionPricing
Fields and Components
Sample XML
DefinedContact
Fields and Components
Sample XML
VehicleMajorPartsProductItem
Fields and Components
Sample XML
VehicleMajorPartsProductItemConfiguration
Fields and Components
Sample XML
Part
Fields and Components
Sample XML
ItemIdentification
Fields and Components
Sample XML
Service
Fields and Components
Sample XML
SalesCampaign
Fields and Components
Sample XML

SalesLead

Uses the Component:SalesLeadType

SalesLead defines the Sales Lead for individual consumers who purchase/lease automobiles through dealers for vehicle products only.

Fields and Components

Table 6.1. Fields and Components

Name Description Occurrence Type Data Type User Notes
SalesLeadHeader

Sales Lead Header

1..1ComponentSalesLeadHeaderType 
SalesLeadDetail

Sales Lead Detail

0..*ComponentSalesLeadDetailType 

Sample XML

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.1. SalesLead

<SalesLead>
     <SalesLeadHeader>......</SalesLeadHeader>     [1..1]
     <SalesLeadDetail>......</SalesLeadDetail>     [0..*]
</SalesLead>
                
            

SalesLeadHeader

Uses the Component:SalesLeadHeaderType

Sales Lead Header

Fields and Components

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..1Field oag:xbt_DateTimeType  
DocumentIdentification

A group of identifications that uniquely identifies this document

0..1ComponentDocumentIdentificationType 
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..1Field oag:clm542173A20090305_ISO3AlphaCurrencyCodeContentType  
DefaultLanguage

Default language. It can be overwrittten in individual data elements in the BOD if needed.

0..1Field sqdt:LanguageCodeType  
ProviderParty

The party that provides a lead.

0..1ComponentPartyBBIEType 
ConsumerParty

Consumer information

0..1ComponentPartyBBIEType 
CustomerParty

Customer information

0..1ComponentCustomerPartyType 
SalesLeadInfo

Sales Lead Inforrmation

0..1ComponentSalesLeadInfoType 

Sample XML

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. SalesLeadHeader

<SalesLeadHeader>
     <DocumentDateTime>......</DocumentDateTime>     [0..1]
     <DocumentIdentification>......</DocumentIdentification>     [0..1]
     <DefaultCurrency>......</DefaultCurrency>     [0..1]
     <DefaultLanguage>......</DefaultLanguage>     [0..1]
     <ProviderParty>......</ProviderParty>     [0..1]
     <ConsumerParty>......</ConsumerParty>     [0..1]
     <CustomerParty>......</CustomerParty>     [0..1]
     <SalesLeadInfo>......</SalesLeadInfo>     [0..1]
</SalesLeadHeader>
                
            

DocumentIdentification

Uses the Component:DocumentIdentificationType

A group of identifications that uniquely identifies this document

Fields and Components

Table 6.3. Fields and Components

Name Description Occurrence Type Data Type User Notes
DocumentIdentifier

A group of identifications that uniquely identifies this document

0..1ComponentDocumentIdentifierType 
AlternateDocumentIdentifier

An alternate identification that uniquely identifies this document in addition to the Document ID, e.g., Part Order Number, Parts Purchase Order Number or Parts Invoice Number.

0..*ComponentDocumentIdentifierType 

Sample XML

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.3. DocumentIdentification

<DocumentIdentification>
     <DocumentIdentifier>......</DocumentIdentifier>     [0..1]
     <AlternateDocumentIdentifier>......</AlternateDocumentIdentifier>     [0..*]
</DocumentIdentification>
                
            

DocumentIdentifier

Uses the Component:DocumentIdentifierType

A group of identifications that uniquely identifies this document

Fields and Components

Table 6.4. Fields and Components

Name Description Occurrence Type Data Type User Notes
DocumentID

The DocumentID is the identifier for the document. This identifier is a GUID or other unique identifier set by the creator of the document.

1..1Field oag:OpenIDType  
AgencyRole

The agency role that defined the Document ID. An example of an agency may be a manufacturer, a retail system provider, etc. This list does not contain specific entity names, only roles. See enumerated list.

0..1Field sqdt:AgencyRoleCodeType  

Sample XML

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.4. DocumentIdentifier

<DocumentIdentifier>
     <DocumentID>......</DocumentID>     [1..1]
     <AgencyRole>......</AgencyRole>     [0..1]
</DocumentIdentifier>
                
            

AlternateDocumentIdentifier

Uses the Component:DocumentIdentifierType

An alternate identification that uniquely identifies this document in addition to the Document ID, e.g., Part Order Number, Parts Purchase Order Number or Parts Invoice Number.

Fields and Components

Table 6.5. Fields and Components

Name Description Occurrence Type Data Type User Notes
DocumentID

The DocumentID is the identifier for the document. This identifier is a GUID or other unique identifier set by the creator of the document.

1..1Field oag:OpenIDType  
AgencyRole

The agency role that defined the Document ID. An example of an agency may be a manufacturer, a retail system provider, etc. This list does not contain specific entity names, only roles. See enumerated list.

0..1Field sqdt:AgencyRoleCodeType  

Sample XML

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.5. AlternateDocumentIdentifier

<AlternateDocumentIdentifier>
     <DocumentID>......</DocumentID>     [1..1]
     <AgencyRole>......</AgencyRole>     [0..1]
</AlternateDocumentIdentifier>
                
            

ProviderParty

Uses the Component:PartyBBIEType

The party that provides a lead.

Fields and Components

Table 6.6. Fields and Components

Name Description Occurrence Type Data Type User Notes
PartyID

Party ID.

0..*Field oag:OpenIDType  
Name

Party Name.

0..*Field oag:OpenNameType  
RelationshipType

Relationship type.

0..1Field oag:CodeType  

Sample XML

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.6. ProviderParty

<ProviderParty>
     <PartyID>......</PartyID>     [0..*]
     <Name>......</Name>     [0..*]
     <RelationshipType>......</RelationshipType>     [0..1]
</ProviderParty>
                
            

ConsumerParty

Uses the Component:PartyBBIEType

Consumer information

Fields and Components

Table 6.7. Fields and Components

Name Description Occurrence Type Data Type User Notes
PartyID

Party ID.

0..*Field oag:OpenIDType  
Name

Party Name.

0..*Field oag:OpenNameType  
RelationshipType

Relationship type.

0..1Field oag:CodeType  

Sample XML

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.7. ConsumerParty

<ConsumerParty>
     <PartyID>......</PartyID>     [0..*]
     <Name>......</Name>     [0..*]
     <RelationshipType>......</RelationshipType>     [0..1]
</ConsumerParty>
                
            

CustomerParty

Uses the Component:CustomerPartyType

Customer information

Fields and Components

Table 6.8. Fields and Components

Name Description Occurrence Type Data Type User Notes
Party

Party Aggregated Business Information Entity Type.

0..1ComponentPartyABIEType 
CustomerComments

Customer comments.

0..1Field oag:TextType  

Sample XML

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.8. CustomerParty

<CustomerParty>
     <Party>......</Party>     [0..1]
     <CustomerComments>......</CustomerComments>     [0..1]
</CustomerParty>
                
            

Party

Uses the Component:PartyABIEType

Party Aggregated Business Information Entity Type.

Fields and Components

Table 6.9. Fields and Components

Name Description Occurrence Type Data Type User Notes
PartyBase

Party Basic Business Information Entity Type.

0..1ComponentPartyBBIEType 
SpecifiedOrganization

A specific organization represented in a party, or other component.

0..1ComponentOrganizationABIEType 
SpecifiedPerson

Identifies a specific individual or person.

0..1ComponentPersonType 
PartyActionEvent

An action taken for an event by or in behalf of the party. This can be used to track the creation of the party, deletion, or end date. This action is dirrectly related to the party.

0..1ComponentEventType 
TimeZone

Time Zone - Free format to allow the use of any of the Time Zone standards.

0..1Field oag:OpenIDType  

Sample XML

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.9. Party

<Party>
     <PartyBase>......</PartyBase>     [0..1]
     <SpecifiedOrganization>......</SpecifiedOrganization>     [0..1]
     <SpecifiedPerson>......</SpecifiedPerson>     [0..1]
     <PartyActionEvent>......</PartyActionEvent>     [0..1]
     <TimeZone>......</TimeZone>     [0..1]
</Party>
                
            

PartyBase

Uses the Component:PartyBBIEType

Party Basic Business Information Entity Type.

Fields and Components

Table 6.10. Fields and Components

Name Description Occurrence Type Data Type User Notes
PartyID

Party ID.

0..*Field oag:OpenIDType  
Name

Party Name.

0..*Field oag:OpenNameType  
RelationshipType

Relationship type.

0..1Field oag:CodeType  

Sample XML

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.10. PartyBase

<PartyBase>
     <PartyID>......</PartyID>     [0..*]
     <Name>......</Name>     [0..*]
     <RelationshipType>......</RelationshipType>     [0..1]
</PartyBase>
                
            

SpecifiedOrganization

Uses the Component:OrganizationABIEType

A specific organization represented in a party, or other component.

Fields and Components

Table 6.11. Fields and Components

Name Description Occurrence Type Data Type User Notes
BusinessType

A code identifying type of Business.

0..1Field oag:CodeType  
CompanyName

Company name of business entity.

0..1Field oag:NameType  
OrganizationID

Member Identification number of affiliate organization

0..1Field oag:OpenIDType  
DistrictID

An identifier for the District an organization resides.

0..1Field oag:OpenIDType  
Branch

Manufacture branch code.

0..1Field oag:CodeType  
Company

Manufacture company code..

0..1Field oag:CodeType  
Division

Manufacture division code.

0..1Field oag:CodeType  
ServiceCenter

Manufacturer service center code.

0..1Field oag:CodeType  
HoldingCompanyName

The company that is securing or underwriting the loan.

0..1Field oag:NameType  
PrimaryContact

ABIE A primary person or department that acts as a point of contact with another peson or department. PrimaryContact

0..*ComponentContactABIEType 
PostalAddress

The location at which mail is delivered.

0..*Componentoag:AddressBaseType 
DoingBusinessAsName

Indicates the Business Party's relationship to the primary Party (e.g., mother, father, husband, etc.).

0..1Field oag:TextType  
LegalClassification

The code specifying the legal classification of this organization such as those representing Incorporated (Inc), limited liability corporation (LLC) or non-profit.

0..1Field oag:CodeType  
InceptionDateTime

The creation date and time that a business was started.

0..1Field oag:xbt_DateTimeType  
NumberOfEmployees

Number of employees in the organization.

0..1Field oag:NumberType  
CompanyDescription

Full description of the company or organization.

0..*Field oag:TextType  

Sample XML

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.11. SpecifiedOrganization

<SpecifiedOrganization>
     <BusinessType>......</BusinessType>     [0..1]
     <CompanyName>......</CompanyName>     [0..1]
     <OrganizationID>......</OrganizationID>     [0..1]
     <DistrictID>......</DistrictID>     [0..1]
     <Branch>......</Branch>     [0..1]
     <Company>......</Company>     [0..1]
     <Division>......</Division>     [0..1]
     <ServiceCenter>......</ServiceCenter>     [0..1]
     <HoldingCompanyName>......</HoldingCompanyName>     [0..1]
     <PrimaryContact>......</PrimaryContact>     [0..*]
     <PostalAddress>......</PostalAddress>     [0..*]
     <DoingBusinessAsName>......</DoingBusinessAsName>     [0..1]
     <LegalClassification>......</LegalClassification>     [0..1]
     <InceptionDateTime>......</InceptionDateTime>     [0..1]
     <NumberOfEmployees>......</NumberOfEmployees>     [0..1]
     <CompanyDescription>......</CompanyDescription>     [0..*]
</SpecifiedOrganization>
                
            

PrimaryContact

Uses the Component:ContactABIEType

ABIE A primary person or department that acts as a point of contact with another peson or department. Primary Contact

Fields and Components

Table 6.12. Fields and Components

Name Description Occurrence Type Data Type User Notes
ID

A unique identifier for this contact.

0..*Field oag:OpenIDType  
JobTitle

The job title, position or designation, expressed as text, of this contact person within an organization such as Director, Software Engineer, Purchasing Manager.

0..1Field oag:TextType  
Responsibility

The responsibilities, expressed as text, of this contact.

0..1Field oag:TextType  
DepartmentName

The name, expressed as text, of the department to which this contact belongs within an organization such as a support department.

0..1Field oag:TextType  
Type

A code specifying the type of contact.

1..1Field oag:CodeType  

Begin Choice

PersonName

The name, expressed as text, of this contact person.

0..1Field oag:TextType  

or

SpecifiedPerson

Identifies a specific individual or person.

0..1ComponentPersonType 

End Choice

TelephoneCommunication

Telephone communication information for this contact.

0..*Componentoag:CommunicationBaseType 
UsagePreference

The preference for usage of this contact such as type, order of importance, availability, or some other criteria.

0..1Componentoag:PreferenceBaseType 
PostalAddress

Postal address information for this contact.

0..1Componentoag:AddressBaseType 
FaxCommunication

Fax communication information for this contact.

0..*Componentoag:CommunicationBaseType 
URICommunication

Uniform Resource Identifier (URI) communication information for this contact such as an email address.

0..*Componentoag:CommunicationBaseType 
ContactMethodType

Indicates the preferred method of contact.

0..1Field sqdt:ContactMethodTypeCodeType  

Sample XML

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.12. PrimaryContact

<PrimaryContact>
     <ID>......</ID>     [0..*]
     <JobTitle>......</JobTitle>     [0..1]
     <Responsibility>......</Responsibility>     [0..1]
     <DepartmentName>......</DepartmentName>     [0..1]
     <Type>......</Type>     [1..1]
     <!--  Begin Choice -->
     <PersonName>......</PersonName>     [0..1]
     <!-- or -->                    
     <SpecifiedPerson>......</SpecifiedPerson>     [0..1]
     <!--  End Choice -->
     <TelephoneCommunication>......</TelephoneCommunication>     [0..*]
     <UsagePreference>......</UsagePreference>     [0..1]
     <PostalAddress>......</PostalAddress>     [0..1]
     <FaxCommunication>......</FaxCommunication>     [0..*]
     <URICommunication>......</URICommunication>     [0..*]
     <ContactMethodType>......</ContactMethodType>     [0..1]
</PrimaryContact>
                
            

SpecifiedPerson

Uses the Component:PersonType

Identifies a specific individual or person.

Fields and Components

Table 6.13. Fields and Components

Name Description Occurrence Type Data Type User Notes
ID

0..*Field oag:OpenIDType  
GivenName

0..*Field oag:NameType  
Alias

Another name that a person is also known.

0..1Field oag:TextType  
MiddleName

Middle Initial of business party

0..1Field oag:NameType  
FamilyName

0..*Field oag:NameType  
Title

A general or descriptive heading given to a person, or item.

0..1Field oag:TextType  
Salutation

A word or phrase of greeting used to begin a letter or message.

0..1Field oag:TextType  
NameSuffix

A word or phrase added to the end of a name

0..1Field oag:TextType  
MaritalStatus

Identifies marital status of business party - M = Married, U = Unmarried, S = Separated, O = Other

0..1Field scl:MaritalStatusEnumeratedType  
Gender

Gender of party - M = Male, F= Female

0..1Field scl:GenderEnumeratedType  
BirthDate

Birth date of party

0..1Field oag:xbt_DateType  
AgeMeasure

The numeric value of a person or parties age.

0..1Field sqdt:TimeMeasureType  
MaidenName

The family name for a woman before she was married.

0..1Field oag:TextType  
PreferredName

A name that a person preferrs to be known.

0..1Field oag:TextType  
ResidenceAddress

The location at which a particular person may be found or reached.

0..1Componentoag:AddressBaseType 
TelephoneCommunication

Telephone Communication information like phone number

0..*Componentoag:CommunicationBaseType 
FaxCommunication

Fax communication includes fax number or mailto address

0..1Componentoag:CommunicationBaseType 
URICommunication

Email or web communication

0..*Componentoag:CommunicationBaseType 
NationalityCountryID

The ISO Country Codelist used to indicate a person's nationality.

0..1Field sqdt:CountryCodeType  
ContactMethodType

Indicates the preferred method of contact.

0..1Field sqdt:ContactMethodTypeCodeType  
Language

The spoken language for a person. This may occur multiple times if they speak more than one language.

0..*Field sqdt:LanguageCodeType  
PostalAddress

The location at which mail is delivered.

0..*Componentoag:AddressBaseType 
OriginalContactMethodType

Original contact method for this person.

0..1Field sqdt:ContactMethodTypeCodeType  
SpecifiedOccupation

Occupation for this person.

0..*ComponentOccupationABIEType 
Trait

Personal trait.

0..*Field TraitType  
CustomerStatus

Code which indicates the customer status of the person (e.g. Deceased, Gone Away)

0..1Field oag:CodeType  
DateOfBirthTolerance

Number of days tolerance for recorded date of birth.

0..1Field oag:NumberType  

Sample XML

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.13. SpecifiedPerson

<SpecifiedPerson>
     <ID>......</ID>     [0..*]
     <GivenName>......</GivenName>     [0..*]
     <Alias>......</Alias>     [0..1]
     <MiddleName>......</MiddleName>     [0..1]
     <FamilyName>......</FamilyName>     [0..*]
     <Title>......</Title>     [0..1]
     <Salutation>......</Salutation>     [0..1]
     <NameSuffix>......</NameSuffix>     [0..1]
     <MaritalStatus>......</MaritalStatus>     [0..1]
     <Gender>......</Gender>     [0..1]
     <BirthDate>......</BirthDate>     [0..1]
     <AgeMeasure>......</AgeMeasure>     [0..1]
     <MaidenName>......</MaidenName>     [0..1]
     <PreferredName>......</PreferredName>     [0..1]
     <ResidenceAddress>......</ResidenceAddress>     [0..1]
     <TelephoneCommunication>......</TelephoneCommunication>     [0..*]
     <FaxCommunication>......</FaxCommunication>     [0..1]
     <URICommunication>......</URICommunication>     [0..*]
     <NationalityCountryID>......</NationalityCountryID>     [0..1]
     <ContactMethodType>......</ContactMethodType>     [0..1]
     <Language>......</Language>     [0..*]
     <PostalAddress>......</PostalAddress>     [0..*]
     <OriginalContactMethodType>......</OriginalContactMethodType>     [0..1]
     <SpecifiedOccupation>......</SpecifiedOccupation>     [0..*]
     <Trait>......</Trait>     [0..*]
     <CustomerStatus>......</CustomerStatus>     [0..1]
     <DateOfBirthTolerance>......</DateOfBirthTolerance>     [0..1]
</SpecifiedPerson>
                
            

ResidenceAddress

Uses the Component:oag:AddressBaseType

The location at which a particular person may be found or reached.

Fields and Components

Sample XML

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.14. ResidenceAddress

<ResidenceAddress>
</ResidenceAddress>
                
            

TelephoneCommunication

Uses the Component:oag:CommunicationBaseType

Telephone Communication information like phone number

Fields and Components

Sample XML

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.15. TelephoneCommunication

<TelephoneCommunication>
</TelephoneCommunication>
                
            

FaxCommunication

Uses the Component:oag:CommunicationBaseType

Fax communication includes fax number or mailto address

Fields and Components

Sample XML

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.16. FaxCommunication

<FaxCommunication>
</FaxCommunication>
                
            

URICommunication

Uses the Component:oag:CommunicationBaseType

Email or web communication

Fields and Components

Sample XML

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.17. URICommunication

<URICommunication>
</URICommunication>
                
            

PostalAddress

Uses the Component:oag:AddressBaseType

The location at which mail is delivered.

Fields and Components

Sample XML

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.18. PostalAddress

<PostalAddress>
</PostalAddress>
                
            

SpecifiedOccupation

Uses the Component:OccupationABIEType

Occupation for this person.

Fields and Components

Table 6.14. Fields and Components

Name Description Occurrence Type Data Type User Notes
TypeCode

The code specifying the type of the occupation.

0..1Field oag:CodeType  
Title

The occupation title.

0..*Field oag:TextType  
Description

The textual description of the occupation.

0..*Field oag:TextType  
Class

The code specifying the class of the occupation, such as accountancy, banking, car delivery.

0..1Field oag:CodeType  
Ranking

The code specifying the relative importance (ranking) of this occupation with respect to the person's other occupations such as main occupation, secondary occupation.

0..1Field oag:CodeType  
FullTimeIndicator

The indication of whether or not the occupation is full-time.

0..1Field oag:IndicatorType  
PeriodHeld

A period of time during which this occupation has been held.

0..1Field oag:TimePeriodType  

Sample XML

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.19. SpecifiedOccupation

<SpecifiedOccupation>
     <TypeCode>......</TypeCode>     [0..1]
     <Title>......</Title>     [0..*]
     <Description>......</Description>     [0..*]
     <Class>......</Class>     [0..1]
     <Ranking>......</Ranking>     [0..1]
     <FullTimeIndicator>......</FullTimeIndicator>     [0..1]
     <PeriodHeld>......</PeriodHeld>     [0..1]
</SpecifiedOccupation>
                
            

UsagePreference

Uses the Component:oag:PreferenceBaseType

Precedence, advantage, or choice of one person or thing over another.

Fields and Components

Sample XML

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.20. UsagePreference

<UsagePreference>
</UsagePreference>
                
            

PartyActionEvent

Uses the Component:EventType

An action taken for an event by or in behalf of the party. This can be used to track the creation of the party, deletion, or end date. This action is dirrectly related to the party.

Fields and Components

Table 6.15. Fields and Components

Name Description Occurrence Type Data Type User Notes
EventID

A unique identifier for an event.

0..1Field oag:OpenIDType  
EventType

Enumerated list of unusual event types.

0..1Field sqdt:EventTypeCodeType  
EventDescription

A textual description of the event.

0..1Field oag:TextType  
EventOccurrenceDateTime

A date, time, date time, or other date time value of an occurrence of this event. This could be used to track such dates and times of creation, deletion, etc.

0..1Field oag:xbt_DateTimeType  

Sample XML

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.21. PartyActionEvent

<PartyActionEvent>
     <EventID>......</EventID>     [0..1]
     <EventType>......</EventType>     [0..1]
     <EventDescription>......</EventDescription>     [0..1]
     <EventOccurrenceDateTime>......</EventOccurrenceDateTime>     [0..1]
</PartyActionEvent>
                
            

SalesLeadInfo

Uses the Component:SalesLeadInfoType

Sales Lead Inforrmation

Fields and Components

Table 6.16. Fields and Components

Name Description Occurrence Type Data Type User Notes
LeadID

The ID of the lead.

0..1Field oag:OpenIDType  
LeadTypeCode

The type of lead.

0..1Field oag:CodeType  
LeadInterestCode

Lead interest.

0..1Field oag:CodeType  
LeadSourceCode

The source of lead.

0..1Field oag:CodeType  
LeadReceiptCode

Lead receipt code.

0..1Field oag:CodeType  
LeadDescription

The description of the lead.

0..1Field oag:TextType  
LeadComments

Lead comments.

0..1Field oag:TextType  
Vehicle

Common vehicle component

0..1ComponentVehicleABIEType 

Sample XML

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.22. SalesLeadInfo

<SalesLeadInfo>
     <LeadID>......</LeadID>     [0..1]
     <LeadTypeCode>......</LeadTypeCode>     [0..1]
     <LeadInterestCode>......</LeadInterestCode>     [0..1]
     <LeadSourceCode>......</LeadSourceCode>     [0..1]
     <LeadReceiptCode>......</LeadReceiptCode>     [0..1]
     <LeadDescription>......</LeadDescription>     [0..1]
     <LeadComments>......</LeadComments>     [0..1]
     <Vehicle>......</Vehicle>     [0..1]
</SalesLeadInfo>
                
            

Vehicle

Uses the Component:VehicleABIEType

Common vehicle component

Fields and Components

Table 6.17. Fields and Components

Name Description Occurrence Type Data Type User Notes
VehicleBase

Vehicle Basic Business Information Entity.

0..1ComponentVehicleBBIEType 
VehicleDetails

Vehicle Details Information.

0..1ComponentVehicleDetailsType 
VehicleConfiguration

A group of elements to define the configuration of a vehicle such as axle, transmission curb weight, etc.

0..1ComponentVehicleConfigurationType 
VehicleStatus

A group of elements to define a Status of a Vehicle such as Built, Sold, Shipped, Schedule, etc. A date and description are available in this group.

0..1ComponentVehicleStatusType 
VehicleEvent

Component to communicate important dates and events for a vehicle.

0..1ComponentVehicleEventType 
Measurement

Measurement details.

0..1Field BaseMeasurementType  
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..1ComponentImageAttachmentExtendedType 
CertificationGroup

0..1ComponentCertificationGroupType 

Sample XML

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.23. Vehicle

<Vehicle>
     <VehicleBase>......</VehicleBase>     [0..1]
     <VehicleDetails>......</VehicleDetails>     [0..1]
     <VehicleConfiguration>......</VehicleConfiguration>     [0..1]
     <VehicleStatus>......</VehicleStatus>     [0..1]
     <VehicleEvent>......</VehicleEvent>     [0..1]
     <Measurement>......</Measurement>     [0..1]
     <ImageAttachmentExtended>......</ImageAttachmentExtended>     [0..1]
     <CertificationGroup>......</CertificationGroup>     [0..1]
</Vehicle>
                
            

VehicleBase

Uses the Component:VehicleBBIEType

Vehicle Basic Business Information Entity.

Fields and Components

Table 6.18. Fields and Components

Name Description Occurrence Type Data Type User Notes
VehicleIdentifier

Manufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code)

0..*Field oag:OpenIDType  
VehicleModel

Vehicle Model Information.

0..*ComponentVehicleModelType 

Sample XML

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.24. VehicleBase

<VehicleBase>
     <VehicleIdentifier>......</VehicleIdentifier>     [0..*]
     <VehicleModel>......</VehicleModel>     [0..*]
</VehicleBase>
                
            

VehicleModel

Uses the Component:VehicleModelType

Vehicle Model Information.

Fields and Components

Table 6.19. Fields and Components

Name Description Occurrence Type Data Type User Notes
Model

Manufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code)

0..*Field oag:OpenNameType  
ModelClass

Indicates the specific class of vehicle attached to the model description (ie: GT, XLE, SE)

0..1Field oag:TextType  
ModelYear

Vehicle designated model year

0..1Field oag:YearDateType  
ModelDescription

Descriptive vehicle model name

0..*Field oag:TextType  

Sample XML

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.25. VehicleModel

<VehicleModel>
     <Model>......</Model>     [0..*]
     <ModelClass>......</ModelClass>     [0..1]
     <ModelYear>......</ModelYear>     [0..1]
     <ModelDescription>......</ModelDescription>     [0..*]
</VehicleModel>
                
            

VehicleDetails

Uses the Component:VehicleDetailsType

Vehicle Details Information.

Fields and Components

Table 6.20. Fields and Components

Name Description Occurrence Type Data Type User Notes
VehicleDescription

A detailed description of the vehicle.

0..1Field oag:TextType  
VehicleNote

Vehicle notes

0..*Field oag:TextType  
VehicleClass

Vehicle Class

0..1Field scl:VehicleClassEnumeratedType  
VehicleOperation

Indicates industry/area where the vehicle operates. Possible values are: Truck Timber; Truck Tipper, Truck Tanker.

0..*Field oag:TextType  
VehicleApplication

Indicates type of operations the vehicle is used in. Possible values are: Normal; Heavy; Severe; Other.

0..*Field oag:TextType  
VehicleUse

Indicates the use of the vehicle (i.e., Agricultural, Commercial, Personal, Other).

0..*Field oag:TextType  
Make

Vehicle make code - Usually available in the VIN number (use NCIC code).

0..1Field oag:StringType  
Series

The model series code for the specified vehicle (i.e., trim level). This is different from Make and Model. Example, Limited Edition

0..1Field oag:CodeType  
SeriesName

The name corresponding to the SeriesCode (i.e., trim level). This is different from Make and Model. Example, Limited Edition

0..1Field oag:CodeType  
ProductClass

Used to communicate product class codes.

0..1Field oag:CodeType  
ProductClassDescription

Used to communicate product class code description.

0..1Field oag:TextType  
MarketConfiguration

A code identifying a particular market-specific configuration.

0..1Field oag:TextType  
Trim

Manufacturer assigned trim code

0..1Field oag:CodeType  
BodyStyle

Manufacturer-assigned vehicle body style

0..1Field oag:TextType  
Color

0..*ComponentColorType 
DoorsQuantity

Number of doors on vehicle

0..1Field oag:NumberType  
SeatQuantity

Passenger/seat capacity count of vehicle

0..1Field oag:NumberType  
InteriorDescription

Description of the interior condition of a preowned vehicle

0..1Field oag:TextType  
Condition

Condition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown

0..1Field oag:TextType  
OdometerReading

Odometer reading.

0..*ComponentOdometerReadingType 
DoorKeyNumber

Door Key Number

0..1Field oag:StringType  
IgnitionKeyNumber

Vehicle Ignition Key Number

0..1Field oag:StringType  
DriveTrain

Indicates whether the vehicle is 2 or 4 wheel drive (i.e., 2WD, 4WD, 4x4, 4x2)

0..1Field oag:TextType  
DriveType

Designates Vehicle drive type

0..1Field scl:DriveTypeEnumeratedType  
RestrictionIndicator

Indication that vehicle has restrictions on its use

0..1Field oag:IndicatorType  
RestrictionDescription

Description of vehicle use restrictions

0..1Field oag:TextType  
Project

Used to identify if the vehicle is in project mode or in serial production.

0..1Field oag:TextType  
Development

Used to identify if a vehicle is development or design vehicle.

0..1Field oag:TextType  
RegistrationStateProvince

State or Province where vehicle is registered.

0..1Field oag:TextType  
RegistrationCountry

Country where vehicle is registered.

0..1Field sqdt:CountryCodeType  
CriticalRecallIndicator

Provides indicator information on Critical Recalls, based on which important decisions can be made i.e to block incentives or not display the vehicles.

0..1Field oag:IndicatorType  
Inactive

Status code to indicate the reason why the vehicle became inactive; used to filter out campaigns.

0..1Field oag:TextType  
BrandCode

Vehicle brand code

0..1Field oag:CodeType  
BrandName

Vehicle brand name

0..1Field oag:TextType  
MaximumSpeedMeasure

The maximum speed at which a particular vehicle configuration may obtain. This includes the entire configuration of the vehicle.

0..1Field sqdt:SpeedMeasureType  
WheelBase

Wheel base legnth.

0..1Field oag:TextType  
WheelBaseUOM

Wheel base unit of measure.

0..1Field oag:TextType  
TelematicsEnabled

Indicates if the vehicle has the telematics system enabled.

0..1Field oag:IndicatorType  
CustomerTelematicsAgreement

Indicates if owner of the vehicle has agreed to share the telematics data.

0..1Field oag:IndicatorType  
Comodity

Comodity description.

0..1Field oag:TextType  
CountryOfOrigin

Country of origing component.

0..1ComponentCountryOfOriginType 

Sample XML

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.26. VehicleDetails

<VehicleDetails>
     <VehicleDescription>......</VehicleDescription>     [0..1]
     <VehicleNote>......</VehicleNote>     [0..*]
     <VehicleClass>......</VehicleClass>     [0..1]
     <VehicleOperation>......</VehicleOperation>     [0..*]
     <VehicleApplication>......</VehicleApplication>     [0..*]
     <VehicleUse>......</VehicleUse>     [0..*]
     <Make>......</Make>     [0..1]
     <Series>......</Series>     [0..1]
     <SeriesName>......</SeriesName>     [0..1]
     <ProductClass>......</ProductClass>     [0..1]
     <ProductClassDescription>......</ProductClassDescription>     [0..1]
     <MarketConfiguration>......</MarketConfiguration>     [0..1]
     <Trim>......</Trim>     [0..1]
     <BodyStyle>......</BodyStyle>     [0..1]
     <Color>......</Color>     [0..*]
     <DoorsQuantity>......</DoorsQuantity>     [0..1]
     <SeatQuantity>......</SeatQuantity>     [0..1]
     <InteriorDescription>......</InteriorDescription>     [0..1]
     <Condition>......</Condition>     [0..1]
     <OdometerReading>......</OdometerReading>     [0..*]
     <DoorKeyNumber>......</DoorKeyNumber>     [0..1]
     <IgnitionKeyNumber>......</IgnitionKeyNumber>     [0..1]
     <DriveTrain>......</DriveTrain>     [0..1]
     <DriveType>......</DriveType>     [0..1]
     <RestrictionIndicator>......</RestrictionIndicator>     [0..1]
     <RestrictionDescription>......</RestrictionDescription>     [0..1]
     <Project>......</Project>     [0..1]
     <Development>......</Development>     [0..1]
     <RegistrationStateProvince>......</RegistrationStateProvince>     [0..1]
     <RegistrationCountry>......</RegistrationCountry>     [0..1]
     <CriticalRecallIndicator>......</CriticalRecallIndicator>     [0..1]
     <Inactive>......</Inactive>     [0..1]
     <BrandCode>......</BrandCode>     [0..1]
     <BrandName>......</BrandName>     [0..1]
     <MaximumSpeedMeasure>......</MaximumSpeedMeasure>     [0..1]
     <WheelBase>......</WheelBase>     [0..1]
     <WheelBaseUOM>......</WheelBaseUOM>     [0..1]
     <TelematicsEnabled>......</TelematicsEnabled>     [0..1]
     <CustomerTelematicsAgreement>......</CustomerTelematicsAgreement>     [0..1]
     <Comodity>......</Comodity>     [0..1]
     <CountryOfOrigin>......</CountryOfOrigin>     [0..1]
</VehicleDetails>
                
            

Color

Uses the Component:ColorType

Fields and Components

Table 6.21. Fields and Components

Name Description Occurrence Type Data Type User Notes
ColorItem

Identifies the item for which color is being described.

1..1Field scl:ColorItemEnumeratedType  
ManufacturerColor

Manufacturer-assigned color code.

0..1Field oag:CodeType  
ColorDescription

Description of a color.

0..*Field oag:TextType  
ColorName

The name of a color, e.g. Hawthorn Green.

0..1Field oag:NameType  
ColorCodeChangeIndicator

Indicates whether or not the color code (e.g., Interior Color Code, Exterior Color Code) can be changed.

0..1Field oag:IndicatorType  

Sample XML

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.27. Color

<Color>
     <ColorItem>......</ColorItem>     [1..1]
     <ManufacturerColor>......</ManufacturerColor>     [0..1]
     <ColorDescription>......</ColorDescription>     [0..*]
     <ColorName>......</ColorName>     [0..1]
     <ColorCodeChangeIndicator>......</ColorCodeChangeIndicator>     [0..1]
</Color>
                
            

OdometerReading

Uses the Component:OdometerReadingType

Odometer reading.

Fields and Components

Table 6.22. Fields and Components

Name Description Occurrence Type Data Type User Notes
UnitOfMeasure

The unit of measuer used by the motor vehicle. Examples: hours, km, miles.

0..1Field oag:TextType  
Date

Date and time the odometer measure was taken.

0..1Field oag:DateTimeType  
Value

This is the value recorded from the odometer reading.

0..1Field oag:NumberType  

Sample XML

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.28. OdometerReading

<OdometerReading>
     <UnitOfMeasure>......</UnitOfMeasure>     [0..1]
     <Date>......</Date>     [0..1]
     <Value>......</Value>     [0..1]
</OdometerReading>
                
            

CountryOfOrigin

Uses the Component:CountryOfOriginType

Country of origing component.

Fields and Components

Table 6.23. Fields and Components

Name Description Occurrence Type Data Type User Notes
CountryCode

The Country Code.

0..1Field sqdt:CountryCodeType  
Quantity

The Product quantity associated with the country of origin.

0..1Field sqdt:QuantityType  
PreferredOrigin

The country of origin of goods is a factor in determining the amount of duty payable. Other factors include the type and value of the goods.

0..*Field oag:IndicatorType  

Sample XML

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.29. CountryOfOrigin

<CountryOfOrigin>
     <CountryCode>......</CountryCode>     [0..1]
     <Quantity>......</Quantity>     [0..1]
     <PreferredOrigin>......</PreferredOrigin>     [0..*]
</CountryOfOrigin>
                
            

VehicleConfiguration

Uses the Component:VehicleConfigurationType

A group of elements to define the configuration of a vehicle such as axle, transmission curb weight, etc.

Fields and Components

Table 6.24. Fields and Components

Name Description Occurrence Type Data Type User Notes
Transmission

Vehicle Transmission type

0..1ComponentTransmissionType 
Axle

The code on the axle of the vehicle.

0..1Field oag:CodeType  
Chassis

A general term that refers to all of the mechanical parts of a car attached to a structural frame. In cars with unitized construction, the chassis comprises everything but the body of the car.

0..1ComponentChassisType 
Tank

Indicates the weight of the item when all fluids are added.

0..*ComponentTankType 
Engine

Information describing the components that are part of an engine.

0..*ComponentEngineType 
Battery

Detail information about a battery.

0..*ComponentBatteryType 
VehicleConfigItem

Configuration alternative.

0..*ComponentVehicleConfigItemType 
TelematicUnit

Telematics Unit Information.

0..*ComponentTelematicUnitType 

Sample XML

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.30. VehicleConfiguration

<VehicleConfiguration>
     <Transmission>......</Transmission>     [0..1]
     <Axle>......</Axle>     [0..1]
     <Chassis>......</Chassis>     [0..1]
     <Tank>......</Tank>     [0..*]
     <Engine>......</Engine>     [0..*]
     <Battery>......</Battery>     [0..*]
     <VehicleConfigItem>......</VehicleConfigItem>     [0..*]
     <TelematicUnit>......</TelematicUnit>     [0..*]
</VehicleConfiguration>
                
            

Transmission

Uses the Component:TransmissionType

Details describing the transmission of a vehicle, truck, boat, etc..

Fields and Components

Table 6.25. Fields and Components

Name Description Occurrence Type Data Type User Notes
Transmission

Transmission Serial Number

0..1Field oag:CodeType  
TransmissionType

Vehicle Transmission type - 3 = 3 speed, 4 = 4 speed, 5 = 5 speed, 6 = 6 speed, A - Automatic

0..1Field scl:TransmissionTypeEnumeratedType  
TransmissionTypeName

Name of transmission type (i.e., Hydromatic, Shiftronic, Manual, Automatic, etc.)

0..1Field oag:TextType  

Sample XML

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.31. Transmission

<Transmission>
     <Transmission>......</Transmission>     [0..1]
     <TransmissionType>......</TransmissionType>     [0..1]
     <TransmissionTypeName>......</TransmissionTypeName>     [0..1]
</Transmission>
                
            

Chassis

Uses the Component:ChassisType

A general term that refers to all of the mechanical parts of a car attached to a structural frame. In cars with unitized construction, the chassis comprises everything but the body of the car.

Fields and Components

Table 6.26. Fields and Components

Name Description Occurrence Type Data Type User Notes
ChassisMake

Make of chassis.

1..1Field oag:TextType  
ChassisModel

Model of chassis.

0..1Field oag:TextType  
ChassisSerial

Unique identifier for the chassis.

0..1Field oag:OpenIDType  

Sample XML

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.32. Chassis

<Chassis>
     <ChassisMake>......</ChassisMake>     [1..1]
     <ChassisModel>......</ChassisModel>     [0..1]
     <ChassisSerial>......</ChassisSerial>     [0..1]
</Chassis>
                
            

Tank

Uses the Component:TankType

A large, often metallic container for holding or storing liquids or gases.

Fields and Components

Table 6.27. Fields and Components

Name Description Occurrence Type Data Type User Notes
TankUsage

The purpose or usage of this tank.

1..1Field sqdt:TankUsageCodeType  
TankMaterial

The type of Material the Tank is constructed from.

0..1Field sqdt:TankMaterialCodeType  
TankCapacityMeasure

How much the tank can hold.

0..1Field sqdt:VolumeMeasureType  
TankCount

The number of tanks.

0..1Field oag:NumberType  
UsagePreference

Precedence, advantage, or choice of one person or thing over another.

0..1Componentoag:PreferenceBaseType 
TankSerial

Unique identifier for the tank.

0..1Field oag:OpenIDType  

Sample XML

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.33. Tank

<Tank>
     <TankUsage>......</TankUsage>     [1..1]
     <TankMaterial>......</TankMaterial>     [0..1]
     <TankCapacityMeasure>......</TankCapacityMeasure>     [0..1]
     <TankCount>......</TankCount>     [0..1]
     <UsagePreference>......</UsagePreference>     [0..1]
     <TankSerial>......</TankSerial>     [0..1]
</Tank>
                
            

Engine

Uses the Component:EngineType

Information describing the components that are part of an engine.

Fields and Components

Table 6.28. Fields and Components

Name Description Occurrence Type Data Type User Notes
EngineType

Describes the type of engine i.e., combustion, electric, hybrid, etc.

0..1Field oag:TextType  
FuelType

Type of vehicle fuel

0..1Field sqdt:FuelTypeCodeType  
EngineEmissionLevel

Enegine emission level.

0..*Field oag:TextType  
EngineModel

Engine Model.

0..1Field oag:TextType  
EngineSerial

Engine Serial Number.

0..1Field oag:TextType  
Brand

The Brand of the engine.

0..1Field oag:TextType  
Manufacturer

The Manufacturer of the Engine.

0..1Field oag:TextType  
ItemIdentifier

A group of identifications that uniquely identifies this document

0..*ComponentItemIdentifierType 

Sample XML

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.34. Engine

<Engine>
     <EngineType>......</EngineType>     [0..1]
     <FuelType>......</FuelType>     [0..1]
     <EngineEmissionLevel>......</EngineEmissionLevel>     [0..*]
     <EngineModel>......</EngineModel>     [0..1]
     <EngineSerial>......</EngineSerial>     [0..1]
     <Brand>......</Brand>     [0..1]
     <Manufacturer>......</Manufacturer>     [0..1]
     <ItemIdentifier>......</ItemIdentifier>     [0..*]
</Engine>
                
            

ItemIdentifier

Uses the Component:ItemIdentifierType

A group of identifications that uniquely identifies this document

Fields and Components

Table 6.29. Fields and Components

Name Description Occurrence Type Data Type User Notes
ItemID

The identifier of an item (e.g, a part number)

1..1Field oag:OpenIDType  
AgencyRole

The agency role that defined the Item. An example of an agency may be a manufacturer, a retail system provider, etc. This list does not contain specific entity names, only roles. Use of the schemaAgencyName should be used to identify the agency defining the Role. Roles are defined in the enumeration.

0..1Field sqdt:AgencyRoleCodeType  

Sample XML

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.35. ItemIdentifier

<ItemIdentifier>
     <ItemID>......</ItemID>     [1..1]
     <AgencyRole>......</AgencyRole>     [0..1]
</ItemIdentifier>
                
            

Battery

Uses the Component:BatteryType

Detail information about a battery.

Fields and Components

Table 6.30. Fields and Components

Name Description Occurrence Type Data Type User Notes
Power

The battery's voltage measure.

0..1Field sqdt:ElectricityMeasureType  
BatteryModel

The model of the battery.

0..1Field oag:TextType  
Brand

the brand of the battery.

0..1Field oag:TextType  
Manufacturer

The manufacturer of the battery.

0..1Field oag:TextType  
Capacity

The capacity of the battery in Amp Hours (Ah).

0..1Field sqdt:ElectricityMeasureType  
BatterySerial

The serial number of the battery.

0..1Field oag:TextType  
ItemIdentifier

A group of identifications that uniquely identifies this document

0..*ComponentItemIdentifierType 

Sample XML

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.36. Battery

<Battery>
     <Power>......</Power>     [0..1]
     <BatteryModel>......</BatteryModel>     [0..1]
     <Brand>......</Brand>     [0..1]
     <Manufacturer>......</Manufacturer>     [0..1]
     <Capacity>......</Capacity>     [0..1]
     <BatterySerial>......</BatterySerial>     [0..1]
     <ItemIdentifier>......</ItemIdentifier>     [0..*]
</Battery>
                
            

VehicleConfigItem

Uses the Component:VehicleConfigItemType

Configuration alternative.

Fields and Components

Table 6.31. Fields and Components

Name Description Occurrence Type Data Type User Notes
Name

Item name.

0..1Field oag:TextType  
Description

Item description.

0..1Field oag:TextType  
ItemIdentifier

A group of identifications that uniquely identifies this document

0..*ComponentItemIdentifierType 
SerialNumber

Item serial number.

0..1Field oag:TextType  
Model

Item model.

0..1Field oag:TextType  
Brand

Item brand.

0..1Field oag:TextType  
Manufacturer

The manufacturer of the item.

0..1Field oag:TextType  
EffectivePeriod

A specific period of time such as the length of time between two known date/time points, from a start date onwards, or up to an end date of when something is effective.

0..*Componentoag:TimePeriodType 
Price

Base Price Component.

0..*ComponentBasePriceType 
ConfigurationAlternative

Configuration alternative.

0..*ComponentConfigurationAlternativeType 
VehicleConfigItem

Configuration alternative.

0..*ComponentVehicleConfigItemType 

Sample XML

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.37. VehicleConfigItem

<VehicleConfigItem>
     <Name>......</Name>     [0..1]
     <Description>......</Description>     [0..1]
     <ItemIdentifier>......</ItemIdentifier>     [0..*]
     <SerialNumber>......</SerialNumber>     [0..1]
     <Model>......</Model>     [0..1]
     <Brand>......</Brand>     [0..1]
     <Manufacturer>......</Manufacturer>     [0..1]
     <EffectivePeriod>......</EffectivePeriod>     [0..*]
     <Price>......</Price>     [0..*]
     <ConfigurationAlternative>......</ConfigurationAlternative>     [0..*]
     <VehicleConfigItem>......</VehicleConfigItem>     [0..*]
</VehicleConfigItem>
                
            

EffectivePeriod

Uses the Component:oag:TimePeriodType

A specific period of time such as the length of time between two known date/time points, from a start date onwards, or up to an end date of when something is effective.

Fields and Components

Sample XML

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.38. EffectivePeriod

<EffectivePeriod>
</EffectivePeriod>
                
            

Price

Uses the Component:BasePriceType

Base Price Component.

Fields and Components

Table 6.32. Fields and Components

Name Description Occurrence Type Data Type User Notes
PriceTypeCode

Price type code.

0..1Field scl:PriceTypeEnumeratedType  
OtherPriceTypeCode

Other Price type code.

0..1Field oag:CodeType  
Description

Price Description.

0..1Field oag:TextType  
PriceScope

Describes the aggregation level of the price. If it's a unit price, extended price, sub total, or total price.

0..1Field scl:PriceScopeEnumeratedType  
PriceObject

Specifies what has been priced in case the BOD doesn't include the object itself e.g., in an invoice.

0..1Field oag:TextType  
PriceAmount

Price amount.

0..1Field oag:AmountType  
BasisQuantity

Basis Quantity.

0..1Field sqdt:QuantityType  
EffectivePeriod

A specific period of time such as the length of time between two known date/time points, from a start date onwards, or up to an end date of when something is effective.

0..1Componentoag:TimePeriodType 

Sample XML

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.39. Price

<Price>
     <PriceTypeCode>......</PriceTypeCode>     [0..1]
     <OtherPriceTypeCode>......</OtherPriceTypeCode>     [0..1]
     <Description>......</Description>     [0..1]
     <PriceScope>......</PriceScope>     [0..1]
     <PriceObject>......</PriceObject>     [0..1]
     <PriceAmount>......</PriceAmount>     [0..1]
     <BasisQuantity>......</BasisQuantity>     [0..1]
     <EffectivePeriod>......</EffectivePeriod>     [0..1]
</Price>
                
            

ConfigurationAlternative

Uses the Component:ConfigurationAlternativeType

Configuration alternative.

Fields and Components

Table 6.33. Fields and Components

Name Description Occurrence Type Data Type User Notes
Name

Configuration name.

0..1Field oag:TextType  
Value

Configuration value

0..1Field oag:TextType  

Sample XML

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.40. ConfigurationAlternative

<ConfigurationAlternative>
     <Name>......</Name>     [0..1]
     <Value>......</Value>     [0..1]
</ConfigurationAlternative>
                
            

TelematicUnit

Uses the Component:TelematicUnitType

Telematics Unit Information.

Fields and Components

Table 6.34. Fields and Components

Name Description Occurrence Type Data Type User Notes
Name

The telematatics unit's Name.

0..1Field oag:TextType  
ID

The telematics unit identification.

0..1Field oag:OpenIDType  
HardwareVersion

The telematatics unit's hardware version.

0..1Field oag:TextType  
TelematicUnitSoftware

Telematic Unit software information.

0..*ComponentTelematicUnitSoftwareType 

Sample XML

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.41. TelematicUnit

<TelematicUnit>
     <Name>......</Name>     [0..1]
     <ID>......</ID>     [0..1]
     <HardwareVersion>......</HardwareVersion>     [0..1]
     <TelematicUnitSoftware>......</TelematicUnitSoftware>     [0..*]
</TelematicUnit>
                
            

TelematicUnitSoftware

Uses the Component:TelematicUnitSoftwareType

Telematic Unit software information.

Fields and Components

Table 6.35. Fields and Components

Name Description Occurrence Type Data Type User Notes
Name

The telematic unit's software name.

0..1Field oag:TextType  
VersionID

The telematic unit's software version.

0..1Field oag:OpenIDType  
DateTime

The date and time when the software version was installed.

0..1Field oag:DateTimeType  

Sample XML

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.42. TelematicUnitSoftware

<TelematicUnitSoftware>
     <Name>......</Name>     [0..1]
     <VersionID>......</VersionID>     [0..1]
     <DateTime>......</DateTime>     [0..1]
</TelematicUnitSoftware>
                
            

VehicleStatus

Uses the Component:VehicleStatusType

A group of elements to define a Status of a Vehicle such as Built, Sold, Shipped, Schedule, etc. A date and description are available in this group.

Fields and Components

Table 6.36. Fields and Components

Name Description Occurrence Type Data Type User Notes
VehicleStatus

Vehicle status code - Example status could be Built, Scheduled, Shipped, In-Transit, Sold, etc.

0..1Field scl:VehicleStatusEnumeratedType  
VehicleStatusDescription

Vehicle status description to further describe the vehicle status code.

0..1Field oag:TextType  
VehicleStatusDate

Date of the Vehicle Status change. It should be used with the VehicleStatusCode element above.

0..1Field oag:xbt_DateType  

Sample XML

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.43. VehicleStatus

<VehicleStatus>
     <VehicleStatus>......</VehicleStatus>     [0..1]
     <VehicleStatusDescription>......</VehicleStatusDescription>     [0..1]
     <VehicleStatusDate>......</VehicleStatusDate>     [0..1]
</VehicleStatus>
                
            

VehicleEvent

Uses the Component:VehicleEventType

Component to communicate important dates and events for a vehicle.

Fields and Components

Table 6.37. Fields and Components

Name Description Occurrence Type Data Type User Notes
VehicleHistoryDate

Date when an important event took place for the vehicle.

1..1Field oag:xbt_DateType  
VehicleHistoryType

Type code of the event that took place on the Vehicle History Date.

0..1Field oag:CodeType  
VehicleHistoryTypeDescription

Description of the event that took place on VehicleHistoryDate.

0..1Field oag:TextType  

Sample XML

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.44. VehicleEvent

<VehicleEvent>
     <VehicleHistoryDate>......</VehicleHistoryDate>     [1..1]
     <VehicleHistoryType>......</VehicleHistoryType>     [0..1]
     <VehicleHistoryTypeDescription>......</VehicleHistoryTypeDescription>     [0..1]
</VehicleEvent>
                
            

ImageAttachmentExtended

Uses the Component:ImageAttachmentExtendedType

The ImageAttachmentExtended component contains information about an image being attached to a BOD, e.g., image size, image type, image file name, etc.

Fields and Components

Table 6.38. Fields and Components

Name Description Occurrence Type Data Type User Notes
ID

A unique identifer for this image. Can be used to help uniquely identify multiple images but of different sizes and types.

0..1Field oag:OpenIDType  
URI

URI

0..1Field oag:URIType  
ImageWidthMeasure

Image tag width. Example: "100"

0..1Field sqdt:LengthMeasureType  
ImageHeightMeasure

Image tag height Example: "120"

0..1Field sqdt:LengthMeasureType  
ImageAlternateText

Image alternate text. Example: "1997 Honda Accord"

0..*Field oag:TextType  
ImageAttachmentTitle

Image attachment title

0..1Field oag:TextType  
EmbeddedData

Holder for embedded data. (Will have an attribute for type of enbedded document)

0..*ComponentEmbeddedDataType 
ImageFileSizeMeasure

Size of image file.

0..1Field sqdt:ComputerStorageMeasureType  
ImageLastModifiedDateTime

The date and time the image was last modified.

0..1Field oag:xbt_DateTimeType  
ImageDescription

Free-form text description of the image. This field is used to provide a more detailed description than the ImageTitle.

0..*Field oag:TextType  
ImagePerspective

Indicates the perspective from which the photo was taken.

0..1Field scl:ImagePerspectiveEnumeratedType  
UsagePreference

Indicates the usage preference.

0..1Componentoag:PreferenceBaseType 
FreeFormTextGroup

Used to provide additional information that helps describe the image. Can be used to add additional notes about the image and information beyond a general description.

0..1ComponentFreeFormTextGroupType 

Sample XML

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.45. ImageAttachmentExtended

<ImageAttachmentExtended>
     <ID>......</ID>     [0..1]
     <URI>......</URI>     [0..1]
     <ImageWidthMeasure>......</ImageWidthMeasure>     [0..1]
     <ImageHeightMeasure>......</ImageHeightMeasure>     [0..1]
     <ImageAlternateText>......</ImageAlternateText>     [0..*]
     <ImageAttachmentTitle>......</ImageAttachmentTitle>     [0..1]
     <EmbeddedData>......</EmbeddedData>     [0..*]
     <ImageFileSizeMeasure>......</ImageFileSizeMeasure>     [0..1]
     <ImageLastModifiedDateTime>......</ImageLastModifiedDateTime>     [0..1]
     <ImageDescription>......</ImageDescription>     [0..*]
     <ImagePerspective>......</ImagePerspective>     [0..1]
     <UsagePreference>......</UsagePreference>     [0..1]
     <FreeFormTextGroup>......</FreeFormTextGroup>     [0..1]
</ImageAttachmentExtended>
                
            

EmbeddedData

Uses the Component:EmbeddedDataType

Embedded data witin a BOD

Fields and Components

Table 6.39. Fields and Components

Name Description Occurrence Type Data Type User Notes
Data

Container to carry the embedded data

1..1Field oag:StringType  

Sample XML

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.46. EmbeddedData

<EmbeddedData>
     <Data>......</Data>     [1..1]
</EmbeddedData>
                
            

FreeFormTextGroup

Uses the Component:FreeFormTextGroupType

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.

Fields and Components

Table 6.40. Fields and Components

Name Description Occurrence Type Data Type User Notes
Note

Free-form text field describing a note.

0..*Field oag:TextType  
Description

0..*Field oag:TextType  

Sample XML

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.47. FreeFormTextGroup

<FreeFormTextGroup>
     <Note>......</Note>     [0..*]
     <Description>......</Description>     [0..*]
</FreeFormTextGroup>
                
            

CertificationGroup

Uses the Component:CertificationGroupType

Fields and Components

Table 6.41. Fields and Components

Name Description Occurrence Type Data Type User Notes
CertificationIssuerName

Name of issuer of certification

0..1Field oag:NameType  
CertificationValue

certification value (i.e., gold)

0..1Field oag:TextType  
CertificationDate

Date when the car completed the certification testing.

0..1Field oag:xbt_DateType  
CertifiedWarranty

Warranty applicable for the certified vehicle.

0..1Field oag:TextType  
ActualOdometer

Odometer reading when the vehicle was certifiied

0..1Field sqdt:LengthMeasureType  
VehiclePreviousUse

A code indicating how the vehicle was previously used. Refer to the Vehicle UseEnumeratedType code list

0..1Field scl:VehicleUseContentType  
PreviousOwnerParty

Individual or company that owned the vehicle previously

0..1ComponentPartyABIEType 
ClassAndWarranty

A code indicating how the vehicle was previously used. Refer to the Vehicle UseEnumeratedType code list

0..*Field oag:TextType  
RepairOrderNumber

A code indicating how the vehicle was previously used. Refer to the Vehicle UseEnumeratedType code list

0..*Field oag:StringType  

Sample XML

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.48. CertificationGroup

<CertificationGroup>
     <CertificationIssuerName>......</CertificationIssuerName>     [0..1]
     <CertificationValue>......</CertificationValue>     [0..1]
     <CertificationDate>......</CertificationDate>     [0..1]
     <CertifiedWarranty>......</CertifiedWarranty>     [0..1]
     <ActualOdometer>......</ActualOdometer>     [0..1]
     <VehiclePreviousUse>......</VehiclePreviousUse>     [0..1]
     <PreviousOwnerParty>......</PreviousOwnerParty>     [0..1]
     <ClassAndWarranty>......</ClassAndWarranty>     [0..*]
     <RepairOrderNumber>......</RepairOrderNumber>     [0..*]
</CertificationGroup>
                
            

PreviousOwnerParty

Uses the Component:PartyABIEType

Individual or company that owned the vehicle previously

Fields and Components

Table 6.42. Fields and Components

Name Description Occurrence Type Data Type User Notes
PartyBase

Party Basic Business Information Entity Type.

0..1ComponentPartyBBIEType 
SpecifiedOrganization

A specific organization represented in a party, or other component.

0..1ComponentOrganizationABIEType 
SpecifiedPerson

Identifies a specific individual or person.

0..1ComponentPersonType 
PartyActionEvent

An action taken for an event by or in behalf of the party. This can be used to track the creation of the party, deletion, or end date. This action is dirrectly related to the party.

0..1ComponentEventType 
TimeZone

Time Zone - Free format to allow the use of any of the Time Zone standards.

0..1Field oag:OpenIDType  

Sample XML

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.49. PreviousOwnerParty

<PreviousOwnerParty>
     <PartyBase>......</PartyBase>     [0..1]
     <SpecifiedOrganization>......</SpecifiedOrganization>     [0..1]
     <SpecifiedPerson>......</SpecifiedPerson>     [0..1]
     <PartyActionEvent>......</PartyActionEvent>     [0..1]
     <TimeZone>......</TimeZone>     [0..1]
</PreviousOwnerParty>
                
            

SalesLeadDetail

Uses the Component:SalesLeadDetailType

Sales Lead Detail

Fields and Components

Table 6.43. Fields and Components

Name Description Occurrence Type Data Type User Notes
Financing

0..1ComponentFinancingABIEType 
SalesAppointment

Sales Appontment Inforrmation

0..*ComponentSalesAppointmentType 
SalesActivity

Represents the activities that occur for a Sales Lead

0..*ComponentSalesActivityType 
SalesOffer

Sales Offer Information.

0..*ComponentSalesOfferType 
SalesCampaign

Sales Campaign Component to communicate sales promotions or sales programs.

0..*ComponentSalesCampaignType 

Sample XML

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.50. SalesLeadDetail

<SalesLeadDetail>
     <Financing>......</Financing>     [0..1]
     <SalesAppointment>......</SalesAppointment>     [0..*]
     <SalesActivity>......</SalesActivity>     [0..*]
     <SalesOffer>......</SalesOffer>     [0..*]
     <SalesCampaign>......</SalesCampaign>     [0..*]
</SalesLeadDetail>
                
            

Financing

Uses the Component:FinancingABIEType

Fields and Components

Table 6.44. Fields and Components

Name Description Occurrence Type Data Type User Notes
PreApprovalID

The pre-approval identifier assigned by the finance source.

0..1Field oag:OpenIDType  
ApprovedIndicator

Approved Indicator

0..1Field oag:IndicatorType  
FinanceType

Type of financing Examples may be F- Finance, L - Lease, C-Cash, 1-Retail, 2-Lease, 3-Balloon, etc.

0..1Field oag:StringType  
LeaseMaturityDate

The date that the lease matures.

0..1Field oag:xbt_DateType  
RatingIndex

Deprecated: Use CreditScoreGroup

0..1Field oag:CodeType  
CreditorFinancialInstitution

0..1ComponentFinancialInstitutionType 
ClientAdvisorName

Indicates the name of the Client Advisor responsible for creating the Financing comments

0..1Field oag:NameType  
NumberOfTaxCreditMonths

Number of months that the tax credit will cover.

0..1Field oag:NumberType  
ExpirationDate

Expiration Date

0..1Field oag:xbt_DateType  
MaturityDateYearMonthDate

Month and year of contract maturity

0..1Field oag:YearMonthDateType  
AnnualPercentageRate

Annual percentage rate.

0..1Field oag:PercentType  
ApplicationType

Type of application being submitted for financing (e.g., individual, individual + co-applicant, business, business + coapplicant, employee).

0..1Field oag:StringType  
CreditApplicationDate

The date the credit application is completed.

0..1Field oag:xbt_DateType  
FinancingComments

Free form text area for Client Advisor to provide general comments about the Financing

0..*Field oag:TextType  
FICOScore

Deprecated: Use CreditScoreGroup

0..1Field oag:CodeType  
FleetAccount

0..1ComponentFleetAccountType 
FirstPaymentDate

Indicates the first date of payment.

0..1Field oag:xbt_DateType  
LastPaymentDate

The date the last payment was made

0..1Field oag:xbt_DateType  
LeaseRateMoneyFactor

Money factor multiplier used to determine finance costs for a lease.

0..1Field oag:StringType  
NumberOfPayments

Indicates the number of payments.

0..1Field oag:NumberType  
OfferingType

Source type of credit contract being offered.

0..1Field oag:StringType  
OfferStatus

Code describing the type of offer (e.g., Pre-approval, Consumer, Dealer)

0..1Field oag:CodeType  
PaymentsDeferredPeriodMeasure

The amount of time by which the vehicle payments have been deferred. HR = Hour, WK = Week, BiWK = Bi-Weekly, MO = Month, YR = Year, SmMO=SemiMonthly, SmAN=SemiAnnually

0..1Field sqdt:PeriodMeasureType  
PreApprovedProgramName

A text description of preapproval codes.

0..1Field oag:NameType  
PromotionalRateIndicator

Promotional rate was used

0..1Field oag:IndicatorType  
SalesOrderNumber

A vehicle order number used by dealers and OEMS to track customer orders.

0..1Field oag:StringType  
SpecialPrograms

Code identifying the type of special program (First Time Buyer, College Graduate, etc.

0..*Field oag:CodeType  
AmortizationPeriodMeasure

The length of time over which the repayment of a loan is calculated.

0..*Field sqdt:PeriodMeasureType  
TermMeasure

Number of months of contract term

0..1Field sqdt:TimeMeasureType  
TotalNumberOfPaymentsRemaining

The remaining total of payments to be made after receipt of the payment at inception. For Lease Only

0..1Field oag:NumberType  
MiscellaneousNotes

Free form miscellaneous comments

0..*Field oag:TextType  
PriceSource

Indicates the source (e.g., Quote, MSRP, Invoice, BlueBook) of the price type of this price.

0..1Field oag:CodeType  
EstimatedFinancingAmounts

Estimated Finance amounts.

0..1ComponentFinancingAmountsType 
FinalFinancingAmounts

Estimated Finance amounts.

0..1ComponentFinancingAmountsType 
CreditScoreGroup

The Credit Score Group component provides information about an individual's credit score(s).

0..*ComponentCreditScoreGroupType 
FinanceSubType

Used to specify details the financial contract linked to the vehicle. For instance leasing with buy back. This is related to the FinanceTypeString.

0..1Field oag:CodeType  
Insurance

Insurance information associated with the vehicle.

0..*ComponentInsuranceType 
CashOutAmount

Amount of net trade paid out to customer as cash.

0..1Field oag:AmountType  

Sample XML

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.51. Financing

<Financing>
     <PreApprovalID>......</PreApprovalID>     [0..1]
     <ApprovedIndicator>......</ApprovedIndicator>     [0..1]
     <FinanceType>......</FinanceType>     [0..1]
     <LeaseMaturityDate>......</LeaseMaturityDate>     [0..1]
     <RatingIndex>......</RatingIndex>     [0..1]
     <CreditorFinancialInstitution>......</CreditorFinancialInstitution>     [0..1]
     <ClientAdvisorName>......</ClientAdvisorName>     [0..1]
     <NumberOfTaxCreditMonths>......</NumberOfTaxCreditMonths>     [0..1]
     <ExpirationDate>......</ExpirationDate>     [0..1]
     <MaturityDateYearMonthDate>......</MaturityDateYearMonthDate>     [0..1]
     <AnnualPercentageRate>......</AnnualPercentageRate>     [0..1]
     <ApplicationType>......</ApplicationType>     [0..1]
     <CreditApplicationDate>......</CreditApplicationDate>     [0..1]
     <FinancingComments>......</FinancingComments>     [0..*]
     <FICOScore>......</FICOScore>     [0..1]
     <FleetAccount>......</FleetAccount>     [0..1]
     <FirstPaymentDate>......</FirstPaymentDate>     [0..1]
     <LastPaymentDate>......</LastPaymentDate>     [0..1]
     <LeaseRateMoneyFactor>......</LeaseRateMoneyFactor>     [0..1]
     <NumberOfPayments>......</NumberOfPayments>     [0..1]
     <OfferingType>......</OfferingType>     [0..1]
     <OfferStatus>......</OfferStatus>     [0..1]
     <PaymentsDeferredPeriodMeasure>......</PaymentsDeferredPeriodMeasure>     [0..1]
     <PreApprovedProgramName>......</PreApprovedProgramName>     [0..1]
     <PromotionalRateIndicator>......</PromotionalRateIndicator>     [0..1]
     <SalesOrderNumber>......</SalesOrderNumber>     [0..1]
     <SpecialPrograms>......</SpecialPrograms>     [0..*]
     <AmortizationPeriodMeasure>......</AmortizationPeriodMeasure>     [0..*]
     <TermMeasure>......</TermMeasure>     [0..1]
     <TotalNumberOfPaymentsRemaining>......</TotalNumberOfPaymentsRemaining>     [0..1]
     <MiscellaneousNotes>......</MiscellaneousNotes>     [0..*]
     <PriceSource>......</PriceSource>     [0..1]
     <EstimatedFinancingAmounts>......</EstimatedFinancingAmounts>     [0..1]
     <FinalFinancingAmounts>......</FinalFinancingAmounts>     [0..1]
     <CreditScoreGroup>......</CreditScoreGroup>     [0..*]
     <FinanceSubType>......</FinanceSubType>     [0..1]
     <Insurance>......</Insurance>     [0..*]
     <CashOutAmount>......</CashOutAmount>     [0..1]
</Financing>
                
            

CreditorFinancialInstitution

Uses the Component:FinancialInstitutionType

Fields and Components

Table 6.45. Fields and Components

Name Description Occurrence Type Data Type User Notes
SpecifiedFinancialAccount

A specified account whereby debits and/or credits arising from transactions are recorded.

0..*ComponentFinancialAccountABIEType 
FinancialOrganization

An organization dealing with finacial transactions.

0..1ComponentOrganizationABIEType 

Sample XML

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.52. CreditorFinancialInstitution

<CreditorFinancialInstitution>
     <SpecifiedFinancialAccount>......</SpecifiedFinancialAccount>     [0..*]
     <FinancialOrganization>......</FinancialOrganization>     [0..1]
</CreditorFinancialInstitution>
                
            

SpecifiedFinancialAccount

Uses the Component:FinancialAccountABIEType

A specified account whereby debits and/or credits arising from transactions are recorded.

Fields and Components

Table 6.46. Fields and Components

Name Description Occurrence Type Data Type User Notes
AccountID

Identifies an account number or similary identifier.

0..1Field oag:OpenIDType  
AccountType

Identifies the type of account.

0..1Field oag:StringType  
AccountName

The name that provides descriptive meaning to an account.

0..1Field oag:TextType  
DefaultCurrency

Currency used for transactions

0..1Field oag:CurrencyCodeContentType  
BalanceAmount

Remaining balance on Current Vehicle

0..1Field oag:AmountType  
CreditFinancing

Financing related to credit, lease, or loans.

0..1ComponentFinancingType 
RoutingTransitID

A nine-digit number (eight digits and a check digit) that identifies a specific financial institution. Also referred to as the ABA number.

0..1Field oag:OpenIDType  

Sample XML

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.53. SpecifiedFinancialAccount

<SpecifiedFinancialAccount>
     <AccountID>......</AccountID>     [0..1]
     <AccountType>......</AccountType>     [0..1]
     <AccountName>......</AccountName>     [0..1]
     <DefaultCurrency>......</DefaultCurrency>     [0..1]
     <BalanceAmount>......</BalanceAmount>     [0..1]
     <CreditFinancing>......</CreditFinancing>     [0..1]
     <RoutingTransitID>......</RoutingTransitID>     [0..1]
</SpecifiedFinancialAccount>
                
            

CreditFinancing

Uses the Component:FinancingType

Financing related to credit, lease, or loans.

Fields and Components

Table 6.47. Fields and Components

Name Description Occurrence Type Data Type User Notes
FinanceType

Type of financing Examples may be F- Finance, L - Lease, C-Cash, 1-Retail, 2-Lease, 3-Balloon, etc.

0..1Field oag:StringType  
PaymentAmount

Monthly Payment Amount

0..1Field oag:AmountType  
FinalAmount

Last month payment amount

0..1Field oag:AmountType  
ResidualAmount

Remaining residual on current vehicle

0..1Field oag:AmountType  
TermMeasure

Number of months of contract term

0..1Field sqdt:TimeMeasureType  
MaturityDateYearMonthDate

Month and year of contract maturity

0..1Field oag:YearMonthDateType  
WholesaleValueAmount

Actual wholesale value of a used vehicle.

0..1Field oag:AmountType  
TradeAllowanceAmount

Trade Allowance is the second component of the negotiated trade vehicle amount, the primary portion being the wholesale amount of the trade vehicle.

0..1Field oag:AmountType  
DownPaymentAmount

Down Payment amount or amount of cap cost reduction.

0..1Field oag:AmountType  
PurchasePriceAmount

Purchase Price or Gross Cap cost specified in deal. Total payments at end of purchase

0..1Field oag:AmountType  
ApprovedIndicator

Approved Indicator

0..1Field oag:IndicatorType  
ApprovedAmount

Amount pre-approved

0..1Field oag:AmountType  
ExpirationDate

Expiration Date

0..1Field oag:xbt_DateType  
RatingIndex

Rating Index Used for Credit Approval

0..1Field oag:CodeType  
MaximumLimitAmount

Maximum Limit Amount for financing

0..1Field oag:AmountType  
MinimumLimitAmount

Minimum Limit Amount for financing

0..1Field oag:AmountType  
ClientAdvisorName

Indicates the name of the Client Advisor responsible for creating the Financing comments

0..1Field oag:NameType  
FinancingComments

Free form text area for Client Advisor to provide general comments about the Financing

0..*Field oag:TextType  
PreApprovalID

The pre-approval identifier assigned by the finance source.

0..1Field oag:OpenIDType  
LeaseMaturityDate

The date that the lease matures.

0..1Field oag:xbt_DateType  
GrossAmount

The gross calculated amount of a financial transaction.

0..1Field oag:AmountType  
PaymentFrequency

Frequency that customer makes regularly scheduled payments to their lien holder.

0..1Field oag:RecurrencePatternCodeContentType  

Sample XML

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.54. CreditFinancing

<CreditFinancing>
     <FinanceType>......</FinanceType>     [0..1]
     <PaymentAmount>......</PaymentAmount>     [0..1]
     <FinalAmount>......</FinalAmount>     [0..1]
     <ResidualAmount>......</ResidualAmount>     [0..1]
     <TermMeasure>......</TermMeasure>     [0..1]
     <MaturityDateYearMonthDate>......</MaturityDateYearMonthDate>     [0..1]
     <WholesaleValueAmount>......</WholesaleValueAmount>     [0..1]
     <TradeAllowanceAmount>......</TradeAllowanceAmount>     [0..1]
     <DownPaymentAmount>......</DownPaymentAmount>     [0..1]
     <PurchasePriceAmount>......</PurchasePriceAmount>     [0..1]
     <ApprovedIndicator>......</ApprovedIndicator>     [0..1]
     <ApprovedAmount>......</ApprovedAmount>     [0..1]
     <ExpirationDate>......</ExpirationDate>     [0..1]
     <RatingIndex>......</RatingIndex>     [0..1]
     <MaximumLimitAmount>......</MaximumLimitAmount>     [0..1]
     <MinimumLimitAmount>......</MinimumLimitAmount>     [0..1]
     <ClientAdvisorName>......</ClientAdvisorName>     [0..1]
     <FinancingComments>......</FinancingComments>     [0..*]
     <PreApprovalID>......</PreApprovalID>     [0..1]
     <LeaseMaturityDate>......</LeaseMaturityDate>     [0..1]
     <GrossAmount>......</GrossAmount>     [0..1]
     <PaymentFrequency>......</PaymentFrequency>     [0..1]
</CreditFinancing>
                
            

FinancialOrganization

Uses the Component:OrganizationABIEType

An organization dealing with finacial transactions.

Fields and Components

Table 6.48. Fields and Components

Name Description Occurrence Type Data Type User Notes
BusinessType

A code identifying type of Business.

0..1Field oag:CodeType  
CompanyName

Company name of business entity.

0..1Field oag:NameType  
OrganizationID

Member Identification number of affiliate organization

0..1Field oag:OpenIDType  
DistrictID

An identifier for the District an organization resides.

0..1Field oag:OpenIDType  
Branch

Manufacture branch code.

0..1Field oag:CodeType  
Company

Manufacture company code..

0..1Field oag:CodeType  
Division

Manufacture division code.

0..1Field oag:CodeType  
ServiceCenter

Manufacturer service center code.

0..1Field oag:CodeType  
HoldingCompanyName

The company that is securing or underwriting the loan.

0..1Field oag:NameType  
PrimaryContact

ABIE A primary person or department that acts as a point of contact with another peson or department. PrimaryContact

0..*ComponentContactABIEType 
PostalAddress

The location at which mail is delivered.

0..*Componentoag:AddressBaseType 
DoingBusinessAsName

Indicates the Business Party's relationship to the primary Party (e.g., mother, father, husband, etc.).

0..1Field oag:TextType  
LegalClassification

The code specifying the legal classification of this organization such as those representing Incorporated (Inc), limited liability corporation (LLC) or non-profit.

0..1Field oag:CodeType  
InceptionDateTime

The creation date and time that a business was started.

0..1Field oag:xbt_DateTimeType  
NumberOfEmployees

Number of employees in the organization.

0..1Field oag:NumberType  
CompanyDescription

Full description of the company or organization.

0..*Field oag:TextType  

Sample XML

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.55. FinancialOrganization

<FinancialOrganization>
     <BusinessType>......</BusinessType>     [0..1]
     <CompanyName>......</CompanyName>     [0..1]
     <OrganizationID>......</OrganizationID>     [0..1]
     <DistrictID>......</DistrictID>     [0..1]
     <Branch>......</Branch>     [0..1]
     <Company>......</Company>     [0..1]
     <Division>......</Division>     [0..1]
     <ServiceCenter>......</ServiceCenter>     [0..1]
     <HoldingCompanyName>......</HoldingCompanyName>     [0..1]
     <PrimaryContact>......</PrimaryContact>     [0..*]
     <PostalAddress>......</PostalAddress>     [0..*]
     <DoingBusinessAsName>......</DoingBusinessAsName>     [0..1]
     <LegalClassification>......</LegalClassification>     [0..1]
     <InceptionDateTime>......</InceptionDateTime>     [0..1]
     <NumberOfEmployees>......</NumberOfEmployees>     [0..1]
     <CompanyDescription>......</CompanyDescription>     [0..*]
</FinancialOrganization>
                
            

FleetAccount

Uses the Component:FleetAccountType

Fields and Components

Table 6.49. Fields and Components

Name Description Occurrence Type Data Type User Notes
FleetAccountString

Manufacturer defined fleet account number

0..1Field oag:StringType  
FleetVehicleID

Uniquely identifies the vehicle as part of a fleet company

0..1Field oag:OpenIDType  
FleetPurchaseOrderNumber

Fleet Purchase Order Number vehicle was purchased under

0..1Field oag:StringType  
FleetAvailableIndicator

Vehicle available To Fleet Indicator

0..1Field oag:IndicatorType  
FleetOnlyIndicator

Indicates that this vehicle only available to Fleet

0..1Field oag:IndicatorType  
RegistrationFleetID

Identifies to which fleet this vehicle belongs. This number is assigned based on state licensing and registration of the vehicle.

0..1Field oag:OpenIDType  
FleetAccount

Describes the contents of the Fleet Account.

0..1Field sqdt:FleetAccountCodeType  
FleetQuantity

This component keeps track of the number of vehicles, make, and vehicle class that are currently on the Fleet Account.

0..*ComponentFleetQuantityType 

Sample XML

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.56. FleetAccount

<FleetAccount>
     <FleetAccountString>......</FleetAccountString>     [0..1]
     <FleetVehicleID>......</FleetVehicleID>     [0..1]
     <FleetPurchaseOrderNumber>......</FleetPurchaseOrderNumber>     [0..1]
     <FleetAvailableIndicator>......</FleetAvailableIndicator>     [0..1]
     <FleetOnlyIndicator>......</FleetOnlyIndicator>     [0..1]
     <RegistrationFleetID>......</RegistrationFleetID>     [0..1]
     <FleetAccount>......</FleetAccount>     [0..1]
     <FleetQuantity>......</FleetQuantity>     [0..*]
</FleetAccount>
                
            

FleetQuantity

Uses the Component:FleetQuantityType

This component keeps track of the number of vehicles, make, and vehicle class that are currently on the Fleet Account.

Fields and Components

Table 6.50. Fields and Components

Name Description Occurrence Type Data Type User Notes
FleetCount

This value represents the number of vehicles.

1..1Field oag:NumberType  
Make

Depracated: Use VehicleMake

0..1Field oag:StringType  
VehicleClass

Class of vehicle

0..1Field scl:VehicleClassEnumeratedType  

Sample XML

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.57. FleetQuantity

<FleetQuantity>
     <FleetCount>......</FleetCount>     [1..1]
     <Make>......</Make>     [0..1]
     <VehicleClass>......</VehicleClass>     [0..1]
</FleetQuantity>
                
            

EstimatedFinancingAmounts

Uses the Component:FinancingAmountsType

Estimated Finance amounts.

Fields and Components

Table 6.51. Fields and Components

Name Description Occurrence Type Data Type User Notes
BalanceAmount

Remaining balance on Current Vehicle

0..1Field oag:AmountType  
DownPaymentAmount

Down Payment amount or amount of cap cost reduction.

0..1Field oag:AmountType  
ApprovedAmount

Amount pre-approved

0..1Field oag:AmountType  
GrossAmount

The gross calculated amount of a financial transaction.

0..1Field oag:AmountType  
GrossTradeInAmount

The negotiated value of the trade-in vehicle.

0..1Field oag:AmountType  
MaximumLimitAmount

Maximum Limit Amount for financing

0..1Field oag:AmountType  
MinimumLimitAmount

Minimum Limit Amount for financing

0..1Field oag:AmountType  
PurchasePriceAmount

Purchase Price or Gross Cap cost specified in deal. Total payments at end of purchase

0..1Field oag:AmountType  
ResidualAmount

Remaining residual on current vehicle

0..1Field oag:AmountType  
TradeAllowanceAmount

Trade Allowance is the second component of the negotiated trade vehicle amount, the primary portion being the wholesale amount of the trade vehicle.

0..1Field oag:AmountType  
NetTradeAllowanceAmount

The gross trade-in amount minus the payoff amount.

0..1Field oag:AmountType  
WholesaleValueAmount

Actual wholesale value of a used vehicle.

0..1Field oag:AmountType  
TradeInSalesTaxCreditAmount

Rebate on sales tax previously paid on the vehicle.

0..1Field oag:AmountType  
PriorCreditOrLeaseOwedOnTradeAmount

The balance owed on lease that is being terminated. This balance is amount being financed.

0..1Field oag:AmountType  
FinalAmount

Last month payment amount

0..1Field oag:AmountType  
UpfrontNetTradePayoffAmount

The balance owed on lease that is being terminated. This balance is amount being paid upfront. This is the amount paid upfront to cover negative equity on a trade-in.

0..1Field oag:AmountType  
MonthlySalesTaxExemptionAmount

An sales tax amount that is exempted on a monthly basis.

0..1Field oag:AmountType  
SalesTaxExemptionAmount

An amount that is exempted from a sales tax.

0..1Field oag:AmountType  
SecurityDepositAmount

Security deposit is the amount paid to cover damage, excess mileage or excess wear and tear on a leased vehicle.

0..1Field oag:AmountType  
AnnualAllowedDistanceMeasure

The number of miles, kilometers, etc. allowed annually for a balloon contract.

0..1Field sqdt:LengthMeasureType  
ApprovedEquipmentAmount

Equipment allowed by finance source to be added to the residual value of a vehicle.

0..1Field oag:AmountType  
BasePaymentAmount

Monthly payment amount before dealer add-ons (i.e., does not include fees, taxes, etc.)

0..1Field oag:AmountType  
ContractTermDistanceMeasure

Mileage allowed under terms of contract

0..1Field sqdt:LengthMeasureType  
CostPerDistanceAmount

The cost per mile in excess of the lease agreement.

0..1Field oag:AmountType  
DealerRebateAmount

Dealer Rebate amount.

0..1Field oag:AmountType  
DeferredDownPaymentAmount

Deferred Down Payment amount.

0..1Field oag:AmountType  
ExcessDistanceRateAmount

The rate charged per mile over the annual miles allowed.

0..1Field oag:AmountType  
ExcessPerYearDistanceMeasure

Estimated number of miles above the contracted annual mileage.

0..1Field sqdt:LengthMeasureType  
FinanceChargeAmount

The total interest paid on the contract.

0..1Field oag:AmountType  
InsuranceTotalExtendedWarrantyAmount

Total of life, accidental and health insurance cost/extended warranty cost.

0..1Field oag:AmountType  
LeaseRatePercentage

Percentage used to determine finance cost of a lease.

0..1Field oag:PercentType  
ManufacturerRebateAmount

Manufacturer rebate amount

0..1Field oag:AmountType  
MSRPGuidePercentage

The ration of the amount financed compared to the value of the vehicle identified in a vehicle evaluation guide (EX: Nada Guide)

0..1Field oag:PercentType  
NetAmountFinanced

Total net financed amount after all trade-in, incentives, etc. The total amount of the loan.

0..1Field oag:AmountType  
NetCapitalizedCostAmount

Leasing value derived from the cash selling price.

0..1Field oag:AmountType  
TotalReductionsAmount

Sum of Down Payment, Dealer Rebates, and any other cash payments that reduce the amount financed.

0..1Field oag:AmountType  
Tax

Base Tax Component.

0..*ComponentBaseTaxType 
Fee

The Fee component represents the fees associated with the vehicle being financed.

0..*ComponentFeeType 
CreditLifePremiumAmount

Indicates the amount of credit life premium insurance being purchased for the vehicle.

0..1Field oag:AmountType  
DisabilityPremiumAmount

Indicates amount of disability premium insurance being purchased for the vehicle.

0..1Field oag:AmountType  
PaymentAmount

Monthly Payment Amount

0..1Field oag:AmountType  
OtherDownPaymentsGroup

The purpose of the OtherDownPayments component is to group detailed information regarding other downpayment information such as Manufacturer Rebate, Deferred Downpayment, Millitary Rebates, College Rebates, Loyalty Cash, etc. together.

0..1ComponentOtherDownPaymentsGroupType 
DownPaymentPercent

The percentage of the total amount given in cash by the customer to buy the vehicle.

0..1Field oag:PercentType  
FinanceReserve

Amount paid by financial lender to dealer for arranging financing on credit contract.  Note:  this is the dealer’s participation, if lender does not pay 100% finance reserve to the dealer.

0..1Field oag:AmountType  
MSRP

Manufacturer’s Suggested Retail Price for vehicle.  Primary component used for a vehicle’s residual value basis (balloon/lease deal types.)

0..1Field oag:AmountType  
PackageDiscounts

Package discount applied to a lease or balloon deal that affect the total residual for the deal.

0..1Field oag:AmountType  
DesiredMonthlyPaymentAmount

Amount the customer would like to pay monthly for the vehicle.

0..1Field oag:AmountType  
PaymentActivity

To communicate all of the activities during a sales lead or a final sale.

0..*ComponentActivityType 
DueOnAmount

Use this "Price" element to describe "Due On Amounts" such as DealerIncentiveAmount, OEM Incentives (Military, Loyalty, and more), Vehicle Registration Transfer Fee, Dealer Custom Fee. And also to descibe "Payments Totals".

0..*Field PriceABIEType  
PaymentTotals

Payments total amount.

0..*Field PriceABIEType  
Profitability

Dealer profitability.

0..1Field oag:AmountType  

Sample XML

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.58. EstimatedFinancingAmounts

<EstimatedFinancingAmounts>
     <BalanceAmount>......</BalanceAmount>     [0..1]
     <DownPaymentAmount>......</DownPaymentAmount>     [0..1]
     <ApprovedAmount>......</ApprovedAmount>     [0..1]
     <GrossAmount>......</GrossAmount>     [0..1]
     <GrossTradeInAmount>......</GrossTradeInAmount>     [0..1]
     <MaximumLimitAmount>......</MaximumLimitAmount>     [0..1]
     <MinimumLimitAmount>......</MinimumLimitAmount>     [0..1]
     <PurchasePriceAmount>......</PurchasePriceAmount>     [0..1]
     <ResidualAmount>......</ResidualAmount>     [0..1]
     <TradeAllowanceAmount>......</TradeAllowanceAmount>     [0..1]
     <NetTradeAllowanceAmount>......</NetTradeAllowanceAmount>     [0..1]
     <WholesaleValueAmount>......</WholesaleValueAmount>     [0..1]
     <TradeInSalesTaxCreditAmount>......</TradeInSalesTaxCreditAmount>     [0..1]
     <PriorCreditOrLeaseOwedOnTradeAmount>......</PriorCreditOrLeaseOwedOnTradeAmount>     [0..1]
     <FinalAmount>......</FinalAmount>     [0..1]
     <UpfrontNetTradePayoffAmount>......</UpfrontNetTradePayoffAmount>     [0..1]
     <MonthlySalesTaxExemptionAmount>......</MonthlySalesTaxExemptionAmount>     [0..1]
     <SalesTaxExemptionAmount>......</SalesTaxExemptionAmount>     [0..1]
     <SecurityDepositAmount>......</SecurityDepositAmount>     [0..1]
     <AnnualAllowedDistanceMeasure>......</AnnualAllowedDistanceMeasure>     [0..1]
     <ApprovedEquipmentAmount>......</ApprovedEquipmentAmount>     [0..1]
     <BasePaymentAmount>......</BasePaymentAmount>     [0..1]
     <ContractTermDistanceMeasure>......</ContractTermDistanceMeasure>     [0..1]
     <CostPerDistanceAmount>......</CostPerDistanceAmount>     [0..1]
     <DealerRebateAmount>......</DealerRebateAmount>     [0..1]
     <DeferredDownPaymentAmount>......</DeferredDownPaymentAmount>     [0..1]
     <ExcessDistanceRateAmount>......</ExcessDistanceRateAmount>     [0..1]
     <ExcessPerYearDistanceMeasure>......</ExcessPerYearDistanceMeasure>     [0..1]
     <FinanceChargeAmount>......</FinanceChargeAmount>     [0..1]
     <InsuranceTotalExtendedWarrantyAmount>......</InsuranceTotalExtendedWarrantyAmount>     [0..1]
     <LeaseRatePercentage>......</LeaseRatePercentage>     [0..1]
     <ManufacturerRebateAmount>......</ManufacturerRebateAmount>     [0..1]
     <MSRPGuidePercentage>......</MSRPGuidePercentage>     [0..1]
     <NetAmountFinanced>......</NetAmountFinanced>     [0..1]
     <NetCapitalizedCostAmount>......</NetCapitalizedCostAmount>     [0..1]
     <TotalReductionsAmount>......</TotalReductionsAmount>     [0..1]
     <Tax>......</Tax>     [0..*]
     <Fee>......</Fee>     [0..*]
     <CreditLifePremiumAmount>......</CreditLifePremiumAmount>     [0..1]
     <DisabilityPremiumAmount>......</DisabilityPremiumAmount>     [0..1]
     <PaymentAmount>......</PaymentAmount>     [0..1]
     <OtherDownPaymentsGroup>......</OtherDownPaymentsGroup>     [0..1]
     <DownPaymentPercent>......</DownPaymentPercent>     [0..1]
     <FinanceReserve>......</FinanceReserve>     [0..1]
     <MSRP>......</MSRP>     [0..1]
     <PackageDiscounts>......</PackageDiscounts>     [0..1]
     <DesiredMonthlyPaymentAmount>......</DesiredMonthlyPaymentAmount>     [0..1]
     <PaymentActivity>......</PaymentActivity>     [0..*]
     <DueOnAmount>......</DueOnAmount>     [0..*]
     <PaymentTotals>......</PaymentTotals>     [0..*]
     <Profitability>......</Profitability>     [0..1]
</EstimatedFinancingAmounts>
                
            

Tax

Uses the Component:BaseTaxType

Base Tax Component.

Fields and Components

Table 6.52. Fields and Components

Name Description Occurrence Type Data Type User Notes
TaxTypeCode

Tax type code.

0..1Field scl:TaxTypesEnumeratedType  
OtherTaxTypeCode

Other Tax type code.

0..1Field oag:CodeType  
TaxJurisdictionCode

The Tax Jurisdiction such as Country, State, Province, County, etc.

0..1Field scl:TaxJurisdictionEnumeratedType  
Description

Tax Description.

0..1Field oag:TextType  
TaxScope

Describes the aggregation level of the Tax. If it's a unit Tax, extended Tax, sub total, or total Tax.

0..1Field oag:TextType  
TaxObject

Specifies the Tax of the item in case the BOD doesn't include the object itself e.g., in an invoice.

0..1Field oag:TextType  
TaxAmount

Tax amount.

0..1Field oag:AmountType  
TaxPercent

Tax percent.

0..1Field oag:PercentType  
BasisQuantity

Basis Quantity.

0..1Field sqdt:QuantityType  
EffectivePeriod

A specific period of time such as the length of time between two known date/time points, from a start date onwards, or up to an end date of when something is effective.

0..1Componentoag:TimePeriodType 

Sample XML

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.59. Tax

<Tax>
     <TaxTypeCode>......</TaxTypeCode>     [0..1]
     <OtherTaxTypeCode>......</OtherTaxTypeCode>     [0..1]
     <TaxJurisdictionCode>......</TaxJurisdictionCode>     [0..1]
     <Description>......</Description>     [0..1]
     <TaxScope>......</TaxScope>     [0..1]
     <TaxObject>......</TaxObject>     [0..1]
     <TaxAmount>......</TaxAmount>     [0..1]
     <TaxPercent>......</TaxPercent>     [0..1]
     <BasisQuantity>......</BasisQuantity>     [0..1]
     <EffectivePeriod>......</EffectivePeriod>     [0..1]
</Tax>
                
            

Fee

Uses the Component:FeeType

The Fee component represents the fees associated with the vehicle being financed.

Fields and Components

Table 6.53. Fields and Components

Name Description Occurrence Type Data Type User Notes
FeeType

Designates the type of fee being applied.

0..1Field scl:FeeTypeEnumeratedType  
FeeDescription

Describes the type of fee being applied.

0..*Field oag:TextType  
FeeAmount

Describes the type of fee being applied.

0..1Field oag:AmountType  
FeePaidTo

Describes to whom the fee is to be paid.

0..1Field oag:TextType  
CapitalizedFeeIndicator

Indicates whether the fee is capitalized, meaning whether it is included in the monthly payments. If the fee is not capitalized it is to be paid up front.

0..1Field oag:IndicatorType  
MaximumAllowableFeeAmount

The maximum amount of the fee that can be charged.

0..1Field oag:AmountType  
PublicOfficialFeeIndicator

Indicator of whether a fee is considered as paid to a public official

0..1Field oag:IndicatorType  
TaxabilityIndicator

Determines whether an item or amount is taxable.

0..1Field oag:IndicatorType  

Sample XML

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.60. Fee

<Fee>
     <FeeType>......</FeeType>     [0..1]
     <FeeDescription>......</FeeDescription>     [0..*]
     <FeeAmount>......</FeeAmount>     [0..1]
     <FeePaidTo>......</FeePaidTo>     [0..1]
     <CapitalizedFeeIndicator>......</CapitalizedFeeIndicator>     [0..1]
     <MaximumAllowableFeeAmount>......</MaximumAllowableFeeAmount>     [0..1]
     <PublicOfficialFeeIndicator>......</PublicOfficialFeeIndicator>     [0..1]
     <TaxabilityIndicator>......</TaxabilityIndicator>     [0..1]
</Fee>
                
            

OtherDownPaymentsGroup

Uses the Component:OtherDownPaymentsGroupType

The purpose of the OtherDownPayments component is to group detailed information regarding other downpayment information such as Manufacturer Rebate, Deferred Downpayment, Millitary Rebates, College Rebates, Loyalty Cash, etc. together.

Fields and Components

Table 6.54. Fields and Components

Name Description Occurrence Type Data Type User Notes
OtherDownPayments

The purpose of the OtherDownPayments component is to represent other downpayment information such as Manufacturer Rebate, Deferred Downpayment, Millitary Rebates, College Rebates, Loyalty Cash, etc.

1..*ComponentOtherDownPaymentsType 

Sample XML

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.61. OtherDownPaymentsGroup

<OtherDownPaymentsGroup>
     <OtherDownPayments>......</OtherDownPayments>     [1..*]
</OtherDownPaymentsGroup>
                
            

OtherDownPayments

Uses the Component:OtherDownPaymentsType

The purpose of the OtherDownPayments component is to represent other downpayment information such as Manufacturer Rebate, Deferred Downpayment, Millitary Rebates, College Rebates, Loyalty Cash, etc.

Fields and Components

Table 6.55. Fields and Components

Name Description Occurrence Type Data Type User Notes
OtherDownPaymentDescription

Free form text description of Other Down Payments.

0..1Field oag:TextType  
OtherDownPaymentAmount

Amount of other downpayment (i.e., Manufacturer Rebate, Deferred Downpayment).

1..1Field oag:AmountType  
CapReductionOtherDownPaymentAmount

Amount of other down payment applied to capitalized cost reduction (for lease.

0..1Field oag:AmountType  
UpfrontOtherDownPaymentAmount

Amount of other down payment applied to upfront costs (for lease).

0..1Field oag:AmountType  
OtherDownPaymentPoints

For rewards points points programs, the number of points redeemed for use as downpayment.

0..1Field oag:NumberType  

Sample XML

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.62. OtherDownPayments

<OtherDownPayments>
     <OtherDownPaymentDescription>......</OtherDownPaymentDescription>     [0..1]
     <OtherDownPaymentAmount>......</OtherDownPaymentAmount>     [1..1]
     <CapReductionOtherDownPaymentAmount>......</CapReductionOtherDownPaymentAmount>     [0..1]
     <UpfrontOtherDownPaymentAmount>......</UpfrontOtherDownPaymentAmount>     [0..1]
     <OtherDownPaymentPoints>......</OtherDownPaymentPoints>     [0..1]
</OtherDownPayments>
                
            

PaymentActivity

Uses the Component:ActivityType

To communicate all of the activities during a sales lead or a final sale.

Fields and Components

Table 6.56. Fields and Components

Name Description Occurrence Type Data Type User Notes
MerchantReferenceCode

Merchant reference code.

0..1Field oag:CodeType  
RequestID

The request identificaton.

0..1Field oag:TextType  
Decision

The decision taken on the activity.

0..1Field oag:TextType  
ReasonCode

Reason code.

0..1Field oag:CodeType  
PaymentTotals

Payment Totals.

0..*Field PriceABIEType  

Sample XML

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.63. PaymentActivity

<PaymentActivity>
     <MerchantReferenceCode>......</MerchantReferenceCode>     [0..1]
     <RequestID>......</RequestID>     [0..1]
     <Decision>......</Decision>     [0..1]
     <ReasonCode>......</ReasonCode>     [0..1]
     <PaymentTotals>......</PaymentTotals>     [0..*]
</PaymentActivity>
                
            

FinalFinancingAmounts

Uses the Component:FinancingAmountsType

Estimated Finance amounts.

Fields and Components

Table 6.57. Fields and Components

Name Description Occurrence Type Data Type User Notes
BalanceAmount

Remaining balance on Current Vehicle

0..1Field oag:AmountType  
DownPaymentAmount

Down Payment amount or amount of cap cost reduction.

0..1Field oag:AmountType  
ApprovedAmount

Amount pre-approved

0..1Field oag:AmountType  
GrossAmount

The gross calculated amount of a financial transaction.

0..1Field oag:AmountType  
GrossTradeInAmount

The negotiated value of the trade-in vehicle.

0..1Field oag:AmountType  
MaximumLimitAmount

Maximum Limit Amount for financing

0..1Field oag:AmountType  
MinimumLimitAmount

Minimum Limit Amount for financing

0..1Field oag:AmountType  
PurchasePriceAmount

Purchase Price or Gross Cap cost specified in deal. Total payments at end of purchase

0..1Field oag:AmountType  
ResidualAmount

Remaining residual on current vehicle

0..1Field oag:AmountType  
TradeAllowanceAmount

Trade Allowance is the second component of the negotiated trade vehicle amount, the primary portion being the wholesale amount of the trade vehicle.

0..1Field oag:AmountType  
NetTradeAllowanceAmount

The gross trade-in amount minus the payoff amount.

0..1Field oag:AmountType  
WholesaleValueAmount

Actual wholesale value of a used vehicle.

0..1Field oag:AmountType  
TradeInSalesTaxCreditAmount

Rebate on sales tax previously paid on the vehicle.

0..1Field oag:AmountType  
PriorCreditOrLeaseOwedOnTradeAmount

The balance owed on lease that is being terminated. This balance is amount being financed.

0..1Field oag:AmountType  
FinalAmount

Last month payment amount

0..1Field oag:AmountType  
UpfrontNetTradePayoffAmount

The balance owed on lease that is being terminated. This balance is amount being paid upfront. This is the amount paid upfront to cover negative equity on a trade-in.

0..1Field oag:AmountType  
MonthlySalesTaxExemptionAmount

An sales tax amount that is exempted on a monthly basis.

0..1Field oag:AmountType  
SalesTaxExemptionAmount

An amount that is exempted from a sales tax.

0..1Field oag:AmountType  
SecurityDepositAmount

Security deposit is the amount paid to cover damage, excess mileage or excess wear and tear on a leased vehicle.

0..1Field oag:AmountType  
AnnualAllowedDistanceMeasure

The number of miles, kilometers, etc. allowed annually for a balloon contract.

0..1Field sqdt:LengthMeasureType  
ApprovedEquipmentAmount

Equipment allowed by finance source to be added to the residual value of a vehicle.

0..1Field oag:AmountType  
BasePaymentAmount

Monthly payment amount before dealer add-ons (i.e., does not include fees, taxes, etc.)

0..1Field oag:AmountType  
ContractTermDistanceMeasure

Mileage allowed under terms of contract

0..1Field sqdt:LengthMeasureType  
CostPerDistanceAmount

The cost per mile in excess of the lease agreement.

0..1Field oag:AmountType  
DealerRebateAmount

Dealer Rebate amount.

0..1Field oag:AmountType  
DeferredDownPaymentAmount

Deferred Down Payment amount.

0..1Field oag:AmountType  
ExcessDistanceRateAmount

The rate charged per mile over the annual miles allowed.

0..1Field oag:AmountType  
ExcessPerYearDistanceMeasure

Estimated number of miles above the contracted annual mileage.

0..1Field sqdt:LengthMeasureType  
FinanceChargeAmount

The total interest paid on the contract.

0..1Field oag:AmountType  
InsuranceTotalExtendedWarrantyAmount

Total of life, accidental and health insurance cost/extended warranty cost.

0..1Field oag:AmountType  
LeaseRatePercentage

Percentage used to determine finance cost of a lease.

0..1Field oag:PercentType  
ManufacturerRebateAmount

Manufacturer rebate amount

0..1Field oag:AmountType  
MSRPGuidePercentage

The ration of the amount financed compared to the value of the vehicle identified in a vehicle evaluation guide (EX: Nada Guide)

0..1Field oag:PercentType  
NetAmountFinanced

Total net financed amount after all trade-in, incentives, etc. The total amount of the loan.

0..1Field oag:AmountType  
NetCapitalizedCostAmount

Leasing value derived from the cash selling price.

0..1Field oag:AmountType  
TotalReductionsAmount

Sum of Down Payment, Dealer Rebates, and any other cash payments that reduce the amount financed.

0..1Field oag:AmountType  
Tax

Base Tax Component.

0..*ComponentBaseTaxType 
Fee

The Fee component represents the fees associated with the vehicle being financed.

0..*ComponentFeeType 
CreditLifePremiumAmount

Indicates the amount of credit life premium insurance being purchased for the vehicle.

0..1Field oag:AmountType  
DisabilityPremiumAmount

Indicates amount of disability premium insurance being purchased for the vehicle.

0..1Field oag:AmountType  
PaymentAmount

Monthly Payment Amount

0..1Field oag:AmountType  
OtherDownPaymentsGroup

The purpose of the OtherDownPayments component is to group detailed information regarding other downpayment information such as Manufacturer Rebate, Deferred Downpayment, Millitary Rebates, College Rebates, Loyalty Cash, etc. together.

0..1ComponentOtherDownPaymentsGroupType 
DownPaymentPercent

The percentage of the total amount given in cash by the customer to buy the vehicle.

0..1Field oag:PercentType  
FinanceReserve

Amount paid by financial lender to dealer for arranging financing on credit contract.  Note:  this is the dealer’s participation, if lender does not pay 100% finance reserve to the dealer.

0..1Field oag:AmountType  
MSRP

Manufacturer’s Suggested Retail Price for vehicle.  Primary component used for a vehicle’s residual value basis (balloon/lease deal types.)

0..1Field oag:AmountType  
PackageDiscounts

Package discount applied to a lease or balloon deal that affect the total residual for the deal.

0..1Field oag:AmountType  
DesiredMonthlyPaymentAmount

Amount the customer would like to pay monthly for the vehicle.

0..1Field oag:AmountType  
PaymentActivity

To communicate all of the activities during a sales lead or a final sale.

0..*ComponentActivityType 
DueOnAmount

Use this "Price" element to describe "Due On Amounts" such as DealerIncentiveAmount, OEM Incentives (Military, Loyalty, and more), Vehicle Registration Transfer Fee, Dealer Custom Fee. And also to descibe "Payments Totals".

0..*Field PriceABIEType  
PaymentTotals

Payments total amount.

0..*Field PriceABIEType  
Profitability

Dealer profitability.

0..1Field oag:AmountType  

Sample XML

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.64. FinalFinancingAmounts

<FinalFinancingAmounts>
     <BalanceAmount>......</BalanceAmount>     [0..1]
     <DownPaymentAmount>......</DownPaymentAmount>     [0..1]
     <ApprovedAmount>......</ApprovedAmount>     [0..1]
     <GrossAmount>......</GrossAmount>     [0..1]
     <GrossTradeInAmount>......</GrossTradeInAmount>     [0..1]
     <MaximumLimitAmount>......</MaximumLimitAmount>     [0..1]
     <MinimumLimitAmount>......</MinimumLimitAmount>     [0..1]
     <PurchasePriceAmount>......</PurchasePriceAmount>     [0..1]
     <ResidualAmount>......</ResidualAmount>     [0..1]
     <TradeAllowanceAmount>......</TradeAllowanceAmount>     [0..1]
     <NetTradeAllowanceAmount>......</NetTradeAllowanceAmount>     [0..1]
     <WholesaleValueAmount>......</WholesaleValueAmount>     [0..1]
     <TradeInSalesTaxCreditAmount>......</TradeInSalesTaxCreditAmount>     [0..1]
     <PriorCreditOrLeaseOwedOnTradeAmount>......</PriorCreditOrLeaseOwedOnTradeAmount>     [0..1]
     <FinalAmount>......</FinalAmount>     [0..1]
     <UpfrontNetTradePayoffAmount>......</UpfrontNetTradePayoffAmount>     [0..1]
     <MonthlySalesTaxExemptionAmount>......</MonthlySalesTaxExemptionAmount>     [0..1]
     <SalesTaxExemptionAmount>......</SalesTaxExemptionAmount>     [0..1]
     <SecurityDepositAmount>......</SecurityDepositAmount>     [0..1]
     <AnnualAllowedDistanceMeasure>......</AnnualAllowedDistanceMeasure>     [0..1]
     <ApprovedEquipmentAmount>......</ApprovedEquipmentAmount>     [0..1]
     <BasePaymentAmount>......</BasePaymentAmount>     [0..1]
     <ContractTermDistanceMeasure>......</ContractTermDistanceMeasure>     [0..1]
     <CostPerDistanceAmount>......</CostPerDistanceAmount>     [0..1]
     <DealerRebateAmount>......</DealerRebateAmount>     [0..1]
     <DeferredDownPaymentAmount>......</DeferredDownPaymentAmount>     [0..1]
     <ExcessDistanceRateAmount>......</ExcessDistanceRateAmount>     [0..1]
     <ExcessPerYearDistanceMeasure>......</ExcessPerYearDistanceMeasure>     [0..1]
     <FinanceChargeAmount>......</FinanceChargeAmount>     [0..1]
     <InsuranceTotalExtendedWarrantyAmount>......</InsuranceTotalExtendedWarrantyAmount>     [0..1]
     <LeaseRatePercentage>......</LeaseRatePercentage>     [0..1]
     <ManufacturerRebateAmount>......</ManufacturerRebateAmount>     [0..1]
     <MSRPGuidePercentage>......</MSRPGuidePercentage>     [0..1]
     <NetAmountFinanced>......</NetAmountFinanced>     [0..1]
     <NetCapitalizedCostAmount>......</NetCapitalizedCostAmount>     [0..1]
     <TotalReductionsAmount>......</TotalReductionsAmount>     [0..1]
     <Tax>......</Tax>     [0..*]
     <Fee>......</Fee>     [0..*]
     <CreditLifePremiumAmount>......</CreditLifePremiumAmount>     [0..1]
     <DisabilityPremiumAmount>......</DisabilityPremiumAmount>     [0..1]
     <PaymentAmount>......</PaymentAmount>     [0..1]
     <OtherDownPaymentsGroup>......</OtherDownPaymentsGroup>     [0..1]
     <DownPaymentPercent>......</DownPaymentPercent>     [0..1]
     <FinanceReserve>......</FinanceReserve>     [0..1]
     <MSRP>......</MSRP>     [0..1]
     <PackageDiscounts>......</PackageDiscounts>     [0..1]
     <DesiredMonthlyPaymentAmount>......</DesiredMonthlyPaymentAmount>     [0..1]
     <PaymentActivity>......</PaymentActivity>     [0..*]
     <DueOnAmount>......</DueOnAmount>     [0..*]
     <PaymentTotals>......</PaymentTotals>     [0..*]
     <Profitability>......</Profitability>     [0..1]
</FinalFinancingAmounts>
                
            

CreditScoreGroup

Uses the Component:CreditScoreGroupType

The Credit Score Group component provides information about an individual's credit score(s).

Fields and Components

Table 6.58. Fields and Components

Name Description Occurrence Type Data Type User Notes
RatingIndex

Rating Index Used for Credit Approval

1..1Field oag:CodeType  
Score

A score is a number representing a value that results from an assessment of an individual, an item, etc.

0..1Field oag:NumberType  

Sample XML

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.65. CreditScoreGroup

<CreditScoreGroup>
     <RatingIndex>......</RatingIndex>     [1..1]
     <Score>......</Score>     [0..1]
</CreditScoreGroup>
                
            

Insurance

Uses the Component:InsuranceType

Insurance information associated with the vehicle.

Fields and Components

Table 6.59. Fields and Components

Name Description Occurrence Type Data Type User Notes
InsuranceType

Identifies the type insurance.

1..1Field scl:InsuranceTypeEnumeratedType  
InsuranceCompanyName

Insurance company name.

0..1Field oag:NameType  
InsuranceAgentName

Name of insurance agent.

0..1Field oag:NameType  
SpecifiedAddress

Address of insurance agent.

0..1Componentoag:AddressBaseType 
OrganizationPartyTelephone

Address of insurance agent.

0..1Field oag:StringType  
PolicyNumber

Unique number to identify a policy.

0..1Field oag:StringType  
CoverageExpirationDate

Identifies when the coverage expires.

0..1Field oag:xbt_DateType  
TermMeasure

Term of insurance coverage.

0..1Field sqdt:TimeMeasureType  
DealerCostAmount

The cost incurred by the dealer.

0..1Field oag:AmountType  
InsuranceDetail

Communicates the different types of insurance associated with the vehicle.

0..*ComponentInsuranceDetailType 
BodilyInjuryUnits

Bodily injury units.

0..1Field oag:NumberType  
BodilyInjuryPremiumAmount

Bodily injury premium.

0..1Field oag:AmountType  
TotalPremiumAmount

The total amount of insurance being purchased.

0..1Field oag:AmountType  
OrganizationPartyFax

Insurance agent fax number.

0..1Field oag:StringType  
CreditLifePremiumAmount

Indicates the amount of credit life premium insurance being purchased for the vehicle.

0..1Field oag:AmountType  
MaximumInsuranceAmount

The maximum benefit.

0..1Field oag:AmountType  
SpecifiedPerson

Person being insured

0..*ComponentPersonType 
InsuredPersonType

Identifies persons covered insurance (e.g., Buyer, Co-Buyer, or Joint).

0..1Field oag:StringType  
DisabilityPremiumAmount

Indicates amount of disability premium insurance being purchased for the vehicle.

0..1Field oag:AmountType  
MaximumMonthlyBenefitAmount

The maximum monthly benefit amount.

0..1Field oag:AmountType  
PremiumAmount

The total amount the customer pays for a policy.

0..1Field oag:AmountType  
FinancedIndicator

Indicates whether the insurance is being financed through the retail credit contract or capitalized for lease.

0..1Field oag:IndicatorType  
OtherInsuranceDescription

Text description of Other Insurance.

0..*Field oag:TextType  
PremiumApprovedIndicator

Indicator of whether premium is approved by state commission.

0..1Field oag:IndicatorType  
InsuranceEffectiveDate

Date insurance policy is effective.

0..1Field oag:xbt_DateType  
InsideCarrierTypeIndicator

Indicates whether the insurance is provided by the finance source (inside) or an outside company.

0..1Field oag:IndicatorType  
TaxabilityIndicator

Indicates if the insurance is taxable.

0..1Field oag:IndicatorType  
InsuranceDeductible

Amount of deductible for insurance.

0..1Field oag:AmountType  
PaymentMethod

Indicates how the customer pays for the insurance product.

0..1Field scl:PaymentMethodEnumeratedType  
DeliveryDays

This field is the number of days the Insurance Policy must be delivered to the seller within, from the date of this agreement.

0..1Field oag:NumberType  
ContractTermDistanceMeasure

The ContractTermMileage Compound represents the odometer mileage allowed under terms of the warranty.

0..1Field sqdt:LengthMeasureType  
InsuranceFormNumber

Form number associated with insurance.

0..1Field oag:StringType  
PolicyHolderParty

Insurance policy holder information.

0..1ComponentPartyABIEType 
PreferredProviderIndicator

Indicates whether the provider is a preferred provider.

0..1Field oag:IndicatorType  
CapitalizedInsuranceIndicator

Indicates whether or not his is a capitalized insurance contract. Values: true or false

0..1Field oag:IndicatorType  
MonthlyInsuranceAmount

Monthly Insurance Amount.

0..1Field oag:AmountType  

Sample XML

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.66. Insurance

<Insurance>
     <InsuranceType>......</InsuranceType>     [1..1]
     <InsuranceCompanyName>......</InsuranceCompanyName>     [0..1]
     <InsuranceAgentName>......</InsuranceAgentName>     [0..1]
     <SpecifiedAddress>......</SpecifiedAddress>     [0..1]
     <OrganizationPartyTelephone>......</OrganizationPartyTelephone>     [0..1]
     <PolicyNumber>......</PolicyNumber>     [0..1]
     <CoverageExpirationDate>......</CoverageExpirationDate>     [0..1]
     <TermMeasure>......</TermMeasure>     [0..1]
     <DealerCostAmount>......</DealerCostAmount>     [0..1]
     <InsuranceDetail>......</InsuranceDetail>     [0..*]
     <BodilyInjuryUnits>......</BodilyInjuryUnits>     [0..1]
     <BodilyInjuryPremiumAmount>......</BodilyInjuryPremiumAmount>     [0..1]
     <TotalPremiumAmount>......</TotalPremiumAmount>     [0..1]
     <OrganizationPartyFax>......</OrganizationPartyFax>     [0..1]
     <CreditLifePremiumAmount>......</CreditLifePremiumAmount>     [0..1]
     <MaximumInsuranceAmount>......</MaximumInsuranceAmount>     [0..1]
     <SpecifiedPerson>......</SpecifiedPerson>     [0..*]
     <InsuredPersonType>......</InsuredPersonType>     [0..1]
     <DisabilityPremiumAmount>......</DisabilityPremiumAmount>     [0..1]
     <MaximumMonthlyBenefitAmount>......</MaximumMonthlyBenefitAmount>     [0..1]
     <PremiumAmount>......</PremiumAmount>     [0..1]
     <FinancedIndicator>......</FinancedIndicator>     [0..1]
     <OtherInsuranceDescription>......</OtherInsuranceDescription>     [0..*]
     <PremiumApprovedIndicator>......</PremiumApprovedIndicator>     [0..1]
     <InsuranceEffectiveDate>......</InsuranceEffectiveDate>     [0..1]
     <InsideCarrierTypeIndicator>......</InsideCarrierTypeIndicator>     [0..1]
     <TaxabilityIndicator>......</TaxabilityIndicator>     [0..1]
     <InsuranceDeductible>......</InsuranceDeductible>     [0..1]
     <PaymentMethod>......</PaymentMethod>     [0..1]
     <DeliveryDays>......</DeliveryDays>     [0..1]
     <ContractTermDistanceMeasure>......</ContractTermDistanceMeasure>     [0..1]
     <InsuranceFormNumber>......</InsuranceFormNumber>     [0..1]
     <PolicyHolderParty>......</PolicyHolderParty>     [0..1]
     <PreferredProviderIndicator>......</PreferredProviderIndicator>     [0..1]
     <CapitalizedInsuranceIndicator>......</CapitalizedInsuranceIndicator>     [0..1]
     <MonthlyInsuranceAmount>......</MonthlyInsuranceAmount>     [0..1]
</Insurance>
                
            

SpecifiedAddress

Uses the Component:oag:AddressBaseType

Fields and Components

Sample XML

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.67. SpecifiedAddress

<SpecifiedAddress>
</SpecifiedAddress>
                
            

InsuranceDetail

Uses the Component:InsuranceDetailType

Identifies a type of insurance.

Fields and Components

Table 6.60. Fields and Components

Name Description Occurrence Type Data Type User Notes
InsuranceDetailType

Identifies a type of insurance.

1..1Field scl:InsuranceDetailTypeEnumeratedType  
DeductibleAmount

The Customer Deductible and/or Co/pay amount Amount. Eg:$50.00

0..1Field oag:AmountType  
TermMeasure

Term of insurance component

0..1Field sqdt:TimeMeasureType  
PremiumAmount

The total amount the customer pays for a policy.

0..1Field oag:AmountType  
LossPayee

The LossPayee component represents the entity that is named as a payee in the event of a loss.

0..*ComponentLossPayeeType 
Confirmation

The Confirmation component represents the confirmation of the consumer’s vehicle insurance.

0..1Field scl:ConfirmationEnumeratedType  
CollisionDeductibleType

Type of collision insurance deductible.

0..1Field scl:CollisionDeductibleTypeEnumeratedType  
InsuranceDetailDeductible

Deductible amount for the property insurance.

0..1Field oag:AmountType  
OtherInsuranceDescription

Additional description of insurance.

0..*Field oag:TextType  
MaximumInsuranceAmount

Maximum payout amount.

0..1Field oag:AmountType  

Sample XML

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.68. InsuranceDetail

<InsuranceDetail>
     <InsuranceDetailType>......</InsuranceDetailType>     [1..1]
     <DeductibleAmount>......</DeductibleAmount>     [0..1]
     <TermMeasure>......</TermMeasure>     [0..1]
     <PremiumAmount>......</PremiumAmount>     [0..1]
     <LossPayee>......</LossPayee>     [0..*]
     <Confirmation>......</Confirmation>     [0..1]
     <CollisionDeductibleType>......</CollisionDeductibleType>     [0..1]
     <InsuranceDetailDeductible>......</InsuranceDetailDeductible>     [0..1]
     <OtherInsuranceDescription>......</OtherInsuranceDescription>     [0..*]
     <MaximumInsuranceAmount>......</MaximumInsuranceAmount>     [0..1]
</InsuranceDetail>
                
            

LossPayee

Uses the Component:LossPayeeType

The LossPayee component represents the entity that is named as a payee in the event of a loss.

Fields and Components

Table 6.61. Fields and Components

Name Description Occurrence Type Data Type User Notes
CompanyName

The Company Name of the Loss Payee.

0..1Field oag:NameType  
SpecifiedAddress

The Address component represents the address for the Loss Payee.

0..1Componentoag:AddressBaseType 
FinanceSourceLossPayeeIndicator

Indicates whether the finance source is either the loss payee or an additional insured party.

0..1Field oag:IndicatorType  

Sample XML

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.69. LossPayee

<LossPayee>
     <CompanyName>......</CompanyName>     [0..1]
     <SpecifiedAddress>......</SpecifiedAddress>     [0..1]
     <FinanceSourceLossPayeeIndicator>......</FinanceSourceLossPayeeIndicator>     [0..1]
</LossPayee>
                
            

PolicyHolderParty

Uses the Component:PartyABIEType

Insurance policy holder information.

Fields and Components

Table 6.62. Fields and Components

Name Description Occurrence Type Data Type User Notes
PartyBase

Party Basic Business Information Entity Type.

0..1ComponentPartyBBIEType 
SpecifiedOrganization

A specific organization represented in a party, or other component.

0..1ComponentOrganizationABIEType 
SpecifiedPerson

Identifies a specific individual or person.

0..1ComponentPersonType 
PartyActionEvent

An action taken for an event by or in behalf of the party. This can be used to track the creation of the party, deletion, or end date. This action is dirrectly related to the party.

0..1ComponentEventType 
TimeZone

Time Zone - Free format to allow the use of any of the Time Zone standards.

0..1Field oag:OpenIDType  

Sample XML

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.70. PolicyHolderParty

<PolicyHolderParty>
     <PartyBase>......</PartyBase>     [0..1]
     <SpecifiedOrganization>......</SpecifiedOrganization>     [0..1]
     <SpecifiedPerson>......</SpecifiedPerson>     [0..1]
     <PartyActionEvent>......</PartyActionEvent>     [0..1]
     <TimeZone>......</TimeZone>     [0..1]
</PolicyHolderParty>
                
            

SalesAppointment

Uses the Component:SalesAppointmentType

Sales Appontment Inforrmation

Fields and Components

Table 6.63. Fields and Components

Name Description Occurrence Type Data Type User Notes
AppointmentDateTime

Date and time of the appointment

0..1Field oag:xbt_DateTimeType  
AppointmentLocation

Location of the appointment... For example: Office; Home

0..1Field oag:TextType  
AppointmentNotes

Comments that relate to the appointment.

0..1Field oag:TextType  
AppointmentStatus

Notes the status of the appointment (e.g, in progress).

0..1Field oag:TextType  
AppointmentMethod

Free form text indicating the method used to make appointment (e.g., Web, Walk-in, etc.).

0..1Field oag:TextType  
AppointmentRequestDate

Date and time the appointment was requested

0..*Field oag:xbt_DateTimeType  
RequestedAppointmentPeriod

The periods that an appointment has been requested. This can include the start date and end dates.

0..*Componentoag:TimePeriodType 
AppointmentContactParty

The party to contact in regards to a service appointment.

0..*ComponentPartyABIEType 

Sample XML

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.71. SalesAppointment

<SalesAppointment>
     <AppointmentDateTime>......</AppointmentDateTime>     [0..1]
     <AppointmentLocation>......</AppointmentLocation>     [0..1]
     <AppointmentNotes>......</AppointmentNotes>     [0..1]
     <AppointmentStatus>......</AppointmentStatus>     [0..1]
     <AppointmentMethod>......</AppointmentMethod>     [0..1]
     <AppointmentRequestDate>......</AppointmentRequestDate>     [0..*]
     <RequestedAppointmentPeriod>......</RequestedAppointmentPeriod>     [0..*]
     <AppointmentContactParty>......</AppointmentContactParty>     [0..*]
</SalesAppointment>
                
            

RequestedAppointmentPeriod

Uses the Component:oag:TimePeriodType

The periods that an appointment has been requested. This can include the start date and end dates.

Fields and Components

Sample XML

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.72. RequestedAppointmentPeriod

<RequestedAppointmentPeriod>
</RequestedAppointmentPeriod>
                
            

AppointmentContactParty

Uses the Component:PartyABIEType

The party to contact in regards to a service appointment.

Fields and Components

Table 6.64. Fields and Components

Name Description Occurrence Type Data Type User Notes
PartyBase

Party Basic Business Information Entity Type.

0..1ComponentPartyBBIEType 
SpecifiedOrganization

A specific organization represented in a party, or other component.

0..1ComponentOrganizationABIEType 
SpecifiedPerson

Identifies a specific individual or person.

0..1ComponentPersonType 
PartyActionEvent

An action taken for an event by or in behalf of the party. This can be used to track the creation of the party, deletion, or end date. This action is dirrectly related to the party.

0..1ComponentEventType 
TimeZone

Time Zone - Free format to allow the use of any of the Time Zone standards.

0..1Field oag:OpenIDType  

Sample XML

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.73. AppointmentContactParty

<AppointmentContactParty>
     <PartyBase>......</PartyBase>     [0..1]
     <SpecifiedOrganization>......</SpecifiedOrganization>     [0..1]
     <SpecifiedPerson>......</SpecifiedPerson>     [0..1]
     <PartyActionEvent>......</PartyActionEvent>     [0..1]
     <TimeZone>......</TimeZone>     [0..1]
</AppointmentContactParty>
                
            

SalesActivity

Uses the Component:SalesActivityType

Represents the activities that occur for a Sales Lead

Fields and Components

Table 6.65. Fields and Components

Name Description Occurrence Type Data Type User Notes
ActivityID

Source-assigned unique event ID

0..1Field oag:OpenIDType  
ActivityDateTime

Date and time that the activity took place

0..1Field oag:xbt_DateTimeType  
MaterialRequested

Name of the materials the customer requested. (i.e., brochure, materials, etc.)

0..1Field oag:TextType  
MaterialSent

Name of the materials sent to the customer. (i.e., brochure, materials, etc.)

0..1Field oag:TextType  
EmailResult

Indicates Whether an Email was Sent. Example could be: S - Sent, digit- - number of times sent, R-Received, N-Not Sent, U-Undeliverable, b - Email address not available

0..1Field oag:CodeType  
RequestContactIndicator

Indicates whether customer would like to be contacted.

0..1Field oag:IndicatorType  
ActivityResult

Result of Activity - Ex: Bought competing Vehicle

0..1Field oag:TextType  
ActivityNote

Free form comments that relate to the activity

0..1Field oag:TextType  
SalesPersonName

Name of the salesperson or person creating the lead status or note

0..1Field oag:NameType  
LeadResponseTime

Response Time is the time (minutes) that it took the salesperson at the dealership to first respond (not auto-respond) to the prospect. This is time in business minutes (minus hours closed business time).

0..1Field oag:NumberType  
OriginalContactMethodType

Original contact method for a given encounter.

0..1Field sqdt:ContactMethodTypeCodeType  
Marketing

Marketing Campaign Information for this Activity

0..1Field MarketingType  
ActivityEndDateTime

Activity end date.

0..1Field oag:xbt_DateTimeType  
Vehicle

Common vehicle component

0..1ComponentVehicleABIEType 
SalesActivityDocument

A Document that is part of a Sales Activity.

0..*ComponentSalesActivityDocumentABIEType 
LeaseEndOptionVehicleDecision

Enables the customers decision at the end of an option to be recorded along with other associated information. It records whether the client has decided to refinance, return, or retain the vehicle or whether they have not made up their mind etc.

0..1Field sqdt:LeaseEndOptionVehicleDecisionCodeType  
LeaseEndOptionFinanceDecision

Enables the customers decision at the end of an option to be recorded along with other associated information. It records whether the client has decided to finance their next vehicle or whether they have not made up their mind etc.

0..1Field sqdt:LeaseEndOptionFinanceDecisionCodeType  
SalesActivityActionEvent

Event information in regards to the sales activity. This can be dates that the activity were created, updated, or deleted.

0..*ComponentEventType 

Sample XML

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.74. SalesActivity

<SalesActivity>
     <ActivityID>......</ActivityID>     [0..1]
     <ActivityDateTime>......</ActivityDateTime>     [0..1]
     <MaterialRequested>......</MaterialRequested>     [0..1]
     <MaterialSent>......</MaterialSent>     [0..1]
     <EmailResult>......</EmailResult>     [0..1]
     <RequestContactIndicator>......</RequestContactIndicator>     [0..1]
     <ActivityResult>......</ActivityResult>     [0..1]
     <ActivityNote>......</ActivityNote>     [0..1]
     <SalesPersonName>......</SalesPersonName>     [0..1]
     <LeadResponseTime>......</LeadResponseTime>     [0..1]
     <OriginalContactMethodType>......</OriginalContactMethodType>     [0..1]
     <Marketing>......</Marketing>     [0..1]
     <ActivityEndDateTime>......</ActivityEndDateTime>     [0..1]
     <Vehicle>......</Vehicle>     [0..1]
     <SalesActivityDocument>......</SalesActivityDocument>     [0..*]
     <LeaseEndOptionVehicleDecision>......</LeaseEndOptionVehicleDecision>     [0..1]
     <LeaseEndOptionFinanceDecision>......</LeaseEndOptionFinanceDecision>     [0..1]
     <SalesActivityActionEvent>......</SalesActivityActionEvent>     [0..*]
</SalesActivity>
                
            

SalesActivityDocument

Uses the Component:SalesActivityDocumentABIEType

A Document that is part of a Sales Activity.

Fields and Components

Table 6.66. Fields and Components

Name Description Occurrence Type Data Type User Notes
DocumentID

The DocumentID is the identifier for the document. This identifier is a GUID or other unique identifier set by the creator of the document.

1..1Field oag:OpenIDType  
DocumentType

Specifies the code that identifies the type of document being sent. This is a user defined code, and implementors should use the attributes on the element to identify the specific code list to be used during business rule validation.

0..1Field oag:CodeType  
IssuingName

An issuing name for this document like a state, or other agency.

0..1Field oag:TextType  
EffectivePeriod

The period which this document is effective

0..1Componentoag:TimePeriodType 

Sample XML

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.75. SalesActivityDocument

<SalesActivityDocument>
     <DocumentID>......</DocumentID>     [1..1]
     <DocumentType>......</DocumentType>     [0..1]
     <IssuingName>......</IssuingName>     [0..1]
     <EffectivePeriod>......</EffectivePeriod>     [0..1]
</SalesActivityDocument>
                
            

SalesActivityActionEvent

Uses the Component:EventType

Event information in regards to the sales activity. This can be dates that the activity were created, updated, or deleted.

Fields and Components

Table 6.67. Fields and Components

Name Description Occurrence Type Data Type User Notes
EventID

A unique identifier for an event.

0..1Field oag:OpenIDType  
EventType

Enumerated list of unusual event types.

0..1Field sqdt:EventTypeCodeType  
EventDescription

A textual description of the event.

0..1Field oag:TextType  
EventOccurrenceDateTime

A date, time, date time, or other date time value of an occurrence of this event. This could be used to track such dates and times of creation, deletion, etc.

0..1Field oag:xbt_DateTimeType  

Sample XML

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.76. SalesActivityActionEvent

<SalesActivityActionEvent>
     <EventID>......</EventID>     [0..1]
     <EventType>......</EventType>     [0..1]
     <EventDescription>......</EventDescription>     [0..1]
     <EventOccurrenceDateTime>......</EventOccurrenceDateTime>     [0..1]
</SalesActivityActionEvent>
                
            

SalesOffer

Uses the Component:SalesOfferType

Sales Offer Information.

Fields and Components

Table 6.68. Fields and Components

Name Description Occurrence Type Data Type User Notes
DocumentIdentification

A group of identifications that uniquely identifies this document

0..*ComponentDocumentIdentificationType 
Pricing

Provides pricing infomation.

0..*ComponentPricingABIEType 
Vehicle

Common vehicle component

0..*ComponentVehicleABIEType 
Option

The Option represents information about a vehicle's options.

0..*ComponentOptionABIEType 
VehicleMajorPartsProductItem

The vehicle's major assemblies.

0..*ComponentVehicleMajorPartsProductItemType 
Part

This is the basic information to identify a Part.

0..*ComponentPartType 
Service

Credit Application Service

0..*ComponentServiceType 
DealerProduct

Dealer Products description.

0..*Field oag:TextType  

Sample XML

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.77. SalesOffer

<SalesOffer>
     <DocumentIdentification>......</DocumentIdentification>     [0..*]
     <Pricing>......</Pricing>     [0..*]
     <Vehicle>......</Vehicle>     [0..*]
     <Option>......</Option>     [0..*]
     <VehicleMajorPartsProductItem>......</VehicleMajorPartsProductItem>     [0..*]
     <Part>......</Part>     [0..*]
     <Service>......</Service>     [0..*]
     <DealerProduct>......</DealerProduct>     [0..*]
</SalesOffer>
                
            

Pricing

Uses the Component:PricingABIEType

Provides pricing infomation.

Fields and Components

Table 6.69. Fields and Components

Name Description Occurrence Type Data Type User Notes
PriceSource

Indicates the source (e.g., Quote, MSRP, Invoice, BlueBook) of the price type of this price.

0..*Field oag:CodeType  
PricingDeltaPercent

Used to express delta between to multiple price types .

0..1Field oag:PercentType  
PriceHideIndicator

This field indicates whether or not this price should be displayed.

0..1Field oag:IndicatorType  
Price

A sum of money for which something is or may be bought or sold.

1..*ComponentBasePriceType 
PriceEffectiveDate

It represents the date a price became effective. The Date a vehicle was priced, Date a bid was accepted, etc.

0..1Field oag:xbt_DateType  

Sample XML

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.78. Pricing

<Pricing>
     <PriceSource>......</PriceSource>     [0..*]
     <PricingDeltaPercent>......</PricingDeltaPercent>     [0..1]
     <PriceHideIndicator>......</PriceHideIndicator>     [0..1]
     <Price>......</Price>     [1..*]
     <PriceEffectiveDate>......</PriceEffectiveDate>     [0..1]
</Pricing>
                
            

Option

Uses the Component:OptionABIEType

The Option represents information about a vehicle's options.

Fields and Components

Table 6.70. Fields and Components

Name Description Occurrence Type Data Type User Notes
OptionID

A unique identifier for a vehicle, boat, or other item's option.

0..1Field oag:OpenIDType  
OptionType

The type supplied by an external code list that specifies a particular option. Source of the code list should be specified in the appropriate attributes for this field, and the option type specified in this field. This may be different than the OptionID which is a unique identifer for an option.

0..1Field oag:CodeType  
OptionShortDescription

Abbreviated description of the option

0..*Field oag:TextType  
OptionName

Name of vehicle option

0..1Field oag:TextType  
OptionStockNumber

Stock Number of Vehicle Option

0..1Field oag:StringType  
ManufacturerName

Item manufacturer name.

0..1Field oag:NameType  
OptionNotes

Free form text related to option

0..*Field oag:TextType  
OptionPricing

Option pricing.

0..*ComponentPricingABIEType 
OptionActiveIndicator

Indicates if the option has been activated.

0..1Field oag:IndicatorType  
DefinedContact

A defined person or department that acts as a point of contact with another peson or department.

0..1ComponentContactABIEType 
OptionResidualValueAmount

Residual value of option.

0..1Field oag:AmountType  
CapitalizedOptionIndicator

Indicates whether or not this is a capitalized option. Values: true or false.

0..1Field oag:IndicatorType  

Sample XML

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.79. Option

<Option>
     <OptionID>......</OptionID>     [0..1]
     <OptionType>......</OptionType>     [0..1]
     <OptionShortDescription>......</OptionShortDescription>     [0..*]
     <OptionName>......</OptionName>     [0..1]
     <OptionStockNumber>......</OptionStockNumber>     [0..1]
     <ManufacturerName>......</ManufacturerName>     [0..1]
     <OptionNotes>......</OptionNotes>     [0..*]
     <OptionPricing>......</OptionPricing>     [0..*]
     <OptionActiveIndicator>......</OptionActiveIndicator>     [0..1]
     <DefinedContact>......</DefinedContact>     [0..1]
     <OptionResidualValueAmount>......</OptionResidualValueAmount>     [0..1]
     <CapitalizedOptionIndicator>......</CapitalizedOptionIndicator>     [0..1]
</Option>
                
            

OptionPricing

Uses the Component:PricingABIEType

Option pricing.

Fields and Components

Table 6.71. Fields and Components

Name Description Occurrence Type Data Type User Notes
PriceSource

Indicates the source (e.g., Quote, MSRP, Invoice, BlueBook) of the price type of this price.

0..*Field oag:CodeType  
PricingDeltaPercent

Used to express delta between to multiple price types .

0..1Field oag:PercentType  
PriceHideIndicator

This field indicates whether or not this price should be displayed.

0..1Field oag:IndicatorType  
Price

A sum of money for which something is or may be bought or sold.

1..*ComponentBasePriceType 
PriceEffectiveDate

It represents the date a price became effective. The Date a vehicle was priced, Date a bid was accepted, etc.

0..1Field oag:xbt_DateType  

Sample XML

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.80. OptionPricing

<OptionPricing>
     <PriceSource>......</PriceSource>     [0..*]
     <PricingDeltaPercent>......</PricingDeltaPercent>     [0..1]
     <PriceHideIndicator>......</PriceHideIndicator>     [0..1]
     <Price>......</Price>     [1..*]
     <PriceEffectiveDate>......</PriceEffectiveDate>     [0..1]
</OptionPricing>
                
            

DefinedContact

Uses the Component:ContactABIEType

A defined person or department that acts as a point of contact with another peson or department.

Fields and Components

Table 6.72. Fields and Components

Name Description Occurrence Type Data Type User Notes
ID

A unique identifier for this contact.

0..*Field oag:OpenIDType  
JobTitle

The job title, position or designation, expressed as text, of this contact person within an organization such as Director, Software Engineer, Purchasing Manager.

0..1Field oag:TextType  
Responsibility

The responsibilities, expressed as text, of this contact.

0..1Field oag:TextType  
DepartmentName

The name, expressed as text, of the department to which this contact belongs within an organization such as a support department.

0..1Field oag:TextType  
Type

A code specifying the type of contact.

1..1Field oag:CodeType  

Begin Choice

PersonName

The name, expressed as text, of this contact person.

0..1Field oag:TextType  

or

SpecifiedPerson

Identifies a specific individual or person.

0..1ComponentPersonType 

End Choice

TelephoneCommunication

Telephone communication information for this contact.

0..*Componentoag:CommunicationBaseType 
UsagePreference

The preference for usage of this contact such as type, order of importance, availability, or some other criteria.

0..1Componentoag:PreferenceBaseType 
PostalAddress

Postal address information for this contact.

0..1Componentoag:AddressBaseType 
FaxCommunication

Fax communication information for this contact.

0..*Componentoag:CommunicationBaseType 
URICommunication

Uniform Resource Identifier (URI) communication information for this contact such as an email address.

0..*Componentoag:CommunicationBaseType 
ContactMethodType

Indicates the preferred method of contact.

0..1Field sqdt:ContactMethodTypeCodeType  

Sample XML

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.81. DefinedContact

<DefinedContact>
     <ID>......</ID>     [0..*]
     <JobTitle>......</JobTitle>     [0..1]
     <Responsibility>......</Responsibility>     [0..1]
     <DepartmentName>......</DepartmentName>     [0..1]
     <Type>......</Type>     [1..1]
     <!--  Begin Choice -->
     <PersonName>......</PersonName>     [0..1]
     <!-- or -->                    
     <SpecifiedPerson>......</SpecifiedPerson>     [0..1]
     <!--  End Choice -->
     <TelephoneCommunication>......</TelephoneCommunication>     [0..*]
     <UsagePreference>......</UsagePreference>     [0..1]
     <PostalAddress>......</PostalAddress>     [0..1]
     <FaxCommunication>......</FaxCommunication>     [0..*]
     <URICommunication>......</URICommunication>     [0..*]
     <ContactMethodType>......</ContactMethodType>     [0..1]
</DefinedContact>
                
            

VehicleMajorPartsProductItem

Uses the Component:VehicleMajorPartsProductItemType

The vehicle's major assemblies.

Fields and Components

Table 6.73. Fields and Components

Name Description Occurrence Type Data Type User Notes
Pricing

Provides pricing infomation.

0..1ComponentPricingABIEType 
VehicleMajorPartsProductItemConfiguration

Specific configuration available for a limited time period.

0..*ComponentVehicleMajorPartsProductItemConfigurationType 

Sample XML

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.82. VehicleMajorPartsProductItem

<VehicleMajorPartsProductItem>
     <Pricing>......</Pricing>     [0..1]
     <VehicleMajorPartsProductItemConfiguration>......</VehicleMajorPartsProductItemConfiguration>     [0..*]
</VehicleMajorPartsProductItem>
                
            

VehicleMajorPartsProductItemConfiguration

Uses the Component:VehicleMajorPartsProductItemConfigurationType

Specific configuration available for a limited time period.

Fields and Components

Table 6.74. Fields and Components

Name Description Occurrence Type Data Type User Notes
Code

Configuration code.

0..1Field oag:CodeType  
Description

Configuration code description.

0..1Field oag:TextType  
EffectivePeriod

Time period this configuration is available.

0..1Field oag:TimePeriodType  

Sample XML

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.83. VehicleMajorPartsProductItemConfiguration

<VehicleMajorPartsProductItemConfiguration>
     <Code>......</Code>     [0..1]
     <Description>......</Description>     [0..1]
     <EffectivePeriod>......</EffectivePeriod>     [0..1]
</VehicleMajorPartsProductItemConfiguration>
                
            

Part

Uses the Component:PartType

This is the basic information to identify a Part.

Fields and Components

Table 6.75. Fields and Components

Name Description Occurrence Type Data Type User Notes
ItemIdentification

An identifer for an item.

0..*ComponentItemIdentificationType 
Name

The name of a Part or Product Item as text.

0..*Field oag:TextType  
Description

The description of a Part or Product Item as text.

0..*Field oag:TextType  
Quantity

Part Quantity

0..1Field sqdt:QuantityType  
Vendor

Part Vendor

0..1Field oag:TextType  

Sample XML

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.84. Part

<Part>
     <ItemIdentification>......</ItemIdentification>     [0..*]
     <Name>......</Name>     [0..*]
     <Description>......</Description>     [0..*]
     <Quantity>......</Quantity>     [0..1]
     <Vendor>......</Vendor>     [0..1]
</Part>
                
            

ItemIdentification

Uses the Component:ItemIdentificationType

An identifer for an item.

Fields and Components

Table 6.76. Fields and Components

Name Description Occurrence Type Data Type User Notes
ItemIdentifier

A group of identifications that uniquely identifies this document

1..*ComponentItemIdentifierType 

Sample XML

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.85. ItemIdentification

<ItemIdentification>
     <ItemIdentifier>......</ItemIdentifier>     [1..*]
</ItemIdentification>
                
            

Service

Uses the Component:ServiceType

Credit Application Service

Fields and Components

Table 6.77. Fields and Components

Name Description Occurrence Type Data Type User Notes
ServiceID

The Service ID.

0..*Field oag:OpenIDType  
ServiceName

The Service name.

0..*Field oag:OpenNameType  
ServiceTypeCode

Service type code.

0..1Field oag:CodeType  
ServiceDescription

The description of the service.

0..*Field oag:TextType  
ServiceNote

Service Notes.

0..*Field oag:TextType  

Sample XML

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.86. Service

<Service>
     <ServiceID>......</ServiceID>     [0..*]
     <ServiceName>......</ServiceName>     [0..*]
     <ServiceTypeCode>......</ServiceTypeCode>     [0..1]
     <ServiceDescription>......</ServiceDescription>     [0..*]
     <ServiceNote>......</ServiceNote>     [0..*]
</Service>
                
            

SalesCampaign

Uses the Component:SalesCampaignType

Sales Campaign Component to communicate sales promotions or sales programs.

Fields and Components

Table 6.78. Fields and Components

Name Description Occurrence Type Data Type User Notes
CampaignTypeCode

Campaign type code. Possible values are "Promotion", "Program", etc.

0..1Field oag:CodeType  
CampaignID

The campaing identifier,

0..1Field oag:OpenIDType  
CampaignDescription

The description of the campaign

0..1Field oag:TextType  
MinimumBuyQuantity

A minimum buy quantity may be required to qualify for the promotion.

0..1Field sqdt:QuantityType  

Sample XML

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.87. SalesCampaign

<SalesCampaign>
     <CampaignTypeCode>......</CampaignTypeCode>     [0..1]
     <CampaignID>......</CampaignID>     [0..1]
     <CampaignDescription>......</CampaignDescription>     [0..1]
     <MinimumBuyQuantity>......</MinimumBuyQuantity>     [0..1]
</SalesCampaign>
                
            

Appendix A. Data Types

The STAR XML Schema repository makes use of several different data types. The base of which come from the UNCEFACT Core Components specification.

Unqualified Data Types

The unqualified data types come from UNCEFACT and are the base types for all of the STAR BODs. See the "Core Components Technical Specification" for more information.

Note: udt:string refers to a string that must be at least 1 character in length.

AmountType

A number of monetary units specified in a currency where the unit of the currency is explicit or implied.

Data Type Format: xsd:decimal

Table A.1. Attributes

NameDescriptionOccurrenceTypeData TypeUser Notes
currencyID

The currency of the amount.

1..1Code List oacl:CurrencyCodeContentType  

BinaryObjectType

A set of finite-length sequences of binary octets.

Data Type Format: xsd:base64Binary

Table A.2. Attributes

NameDescriptionOccurrenceTypeData TypeUser Notes
format

The format of the binary content.

0..1Attributeudt:string 
mimeCode

The mime type of the binary object.

0..1Code List oacl:MIMECodeContentType  
encodingCode

Specifies the decoding algorithm of the binary object.

0..1Attributeudt:string 
characterSet

The character set of the binary object if the mime type is text.

0..1Attributeudt:string 
uri

The Uniform Resource Identifier that identifies where the binary object is located.

0..1Attributexsd:anyURI 
filename

The filename of the binary object.

0..1Attributeudt:string 

GraphicType

A diagram, graph, mathematical curves, or similar representation.

Data Type Format: xsd:base64Binary

Table A.3. Attributes

NameDescriptionOccurrenceTypeData TypeUser Notes
format

The format of the graphic content.

0..1Attributeudt:string 
mimeCode

The mime type of the graphic object.

0..1Code List oacl:MIMECodeContentType  
encodingCode

Specifies the decoding algorithm of the graphic object.

0..1Attributeudt:string 
uri

The Uniform Resource Identifier that identifies where the graphic object is located.

0..1Attributexsd:anyURI 
filename

The filename of the graphic object.

0..1Attributeudt:string 

PictureType

A diagram, graph, mathematical curves, or similar representation.

Data Type Format: xsd:base64Binary

Table A.4. Attributes

NameDescriptionOccurrenceTypeData TypeUser Notes
format

The format of the picture content.

0..1Attributeudt:string 
mimeCode

The mime type of the picture object.

0..1Code List oacl:MIMECodeContentType  
encodingCode

Specifies the decoding algorithm of the picture object.

0..1Attributeudt:string 
uri

The Uniform Resource Identifier that identifies where the picture object is located.

0..1Attributexsd:anyURI 
filename

The filename of the picture object.

0..1Attributeudt:string 

SoundType

A diagram, graph, mathematical curves, or similar representation.

Data Type Format: xsd:base64Binary

Table A.5. Attributes

NameDescriptionOccurrenceTypeData TypeUser Notes
format

The format of the sound content.

0..1Attributeudt:string 
mimeCode

The mime type of the sound object.

0..1Code List oacl:MIMECodeContentType  
encodingCode

Specifies the decoding algorithm of the sound object.

0..1Attributeudt:string 
uri

The Uniform Resource Identifier that identifies where the sound object is located.

0..1Attributexsd:anyURI 
filename

The filename of the sound object.

0..1Attributeudt:string 

SoundType

A diagram, graph, mathematical curves, or similar representation.

Data Type Format: xsd:base64Binary

Table A.6. Attributes

NameDescriptionOccurrenceTypeData TypeUser Notes
format

The format of the video content.

0..1Attributeudt:string 
mimeCode

The mime type of the video object.

0..1Code List oacl:MIMECodeContentType  
encodingCode

Specifies the decoding algorithm of the video object.

0..1Attributeudt:string 
uri

The Uniform Resource Identifier that identifies where the video object is located.

0..1Attributexsd:anyURI 
filename

The filename of the video object.

0..1Attributeudt:string 

CodeType

A character string (letters, figures, or symbols) that for brevity and/or languange independence may be used to represent or replace a definitive value or text of an attribute together with relevant supplementary information.

Data Type Format: udt:string

Table A.7. Attributes

NameDescriptionOccurrenceTypeData TypeUser Notes
listID

The identification of a list of codes.

0..1Attributeudt:string 
listAgencyID

An agency that maintains one or more lists of codes.

0..1Attributeudt:string 
listAgencyName

The name of the agency that maintains the list of codes.

0..1Attributeudt:string 
listName

The name of a list of codes.

0..1Attributeudt:string 
listVersionID

The identification of a list of codes.

0..1Attributeudt:string 
name

The textual equivalent of the code content component.

0..1Attributeudt:string 
languageID

The identifier of the language used in the code name.

0..1Attributeudt:string 
listURI

The Uniform Resource Identifier that identifies where the code list is located.

0..1Attributexsd:anyURI 
listSchemeURI

The Uniform Resource Identifier that identifies where the code list scheme is located.

0..1Attributexsd:anyURI 

DateTimeType

A particular point in the progression of time together with the relevant supplementary information.

Data Type Format: xsd:datetime

DateType

One calendar day according the Gregorian calendar

Data Type Format: xsd:date

TimeType

The instance of time that occurs every day.

Data Type Format: xsd:time

IdentifierType

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.

Data Type Format: udt:string

Table A.8. Attributes

NameDescriptionOccurrenceTypeData TypeUser Notes
schemeID

The identification of the identification scheme.

0..1Attributeudt:string 
schemeAgencyID

The identification of the agency that maintains the identification scheme.

0..1Attributeudt:string 
schemeAgencyName

The name of the agency that maintains the identification scheme.

0..1Attributeudt:string 
schemeName

The name of a scheme.

0..1Attributeudt:string 
schemeVersionID

The version of the identification scheme.

0..1Attributeudt:string 
schemeDataURI

The Uniform Resource Identifier that identifies where the identification scheme data is located.

0..1Attributexsd:anyURI 
schemeURI

The Uniform Resource Identifier that identifies where the identification scheme is located.

0..1Attributexsd:anyURI 

TimeType

A list of two mutually exclusive Boolean values that express the only possible states of a property. The values are true or false .

Data Type Format: xsd:boolean

MeasureType

A numeric value determined by measuring an object along with the specified unit of measure.

Data Type Format: xsd:decimal

Table A.9. Attributes

NameDescriptionOccurrenceTypeData TypeUser Notes
unitCode

The type of unit of measure.

1..1Code List oacl:UnitCodeContentType  

NumericType

Numeric information that is assigned or is determined by calculation, counting, or sequencing. It does not require a unit of quantity or unit of measure.

Data Type Format: xsd:decimal

ValueType

Numeric information that is assigned or is determined by calculation, counting, or sequencing. It does not require a unit of quantity or unit of measure.

Data Type Format: xsd:decimal

PercentType

Numeric information that is assigned or is determined by calculation, counting, or sequencing. It does not require a unit of quantity or unit of measure.

Data Type Format: xsd:decimal

RateType

Numeric information that is assigned or is determined by calculation, counting, or sequencing. It does not require a unit of quantity or unit of measure.

Data Type Format: xsd:decimal

QuantityType

A counted number of non-monetary units possibly including fractions.

Data Type Format: xsd:decimal

Table A.10. Attributes

NameDescriptionOccurrenceTypeData TypeUser Notes
unitCode

The type of unit of measure.

1..1Code List oacl:UnitCodeContentType  

TextType

A character string (i.e. a finite set of characters) generally in the form of words of a language.

Data Type Format: xsd:decimal

Table A.11. Attributes

NameDescriptionOccurrenceTypeData TypeUser Notes
languageID

The identifier of the language used in the content component.

0..1Attributexsd:language 

NameType

A character string that consititues the distinctive designation of a person, place, thing or concept.

Data Type Format: xsd:decimal

Table A.12. Attributes

NameDescriptionOccurrenceTypeData TypeUser Notes
languageID

The identifier of the language used in the content component.

0..1Attributexsd:language 

Qualified Data Types

HexBinaryObjectType

Data Type Based On: xsd:hexBinary

hexBinary represents arbitrary hex-encoded binary data. The ·value space· of hexBinary is the set of finite-length sequences of binary octets.

YearDateType

Data Type Based On: xsd:gYear

Year represents a gregorian calendar year. The value space of gYear is the set of Gregorian calendar years as defined in section 5.2.1 of [ISO 8601]. Specifically, it is a set of one-year long, non-periodic instances e.g. lexical 1999 to represent the whole year 1999, independent of how many months and days this year has.

YearMonthDateType

Data Type Based On: xsd:gYearMonth

gYearMonth represents a specific gregorian month in a specific gregorian year. The value space of gYearMonth is the set of Gregorian calendar months as defined in section 5.2.1 of [ISO 8601]. Specifically, it is a set of one-month long, non-periodic instances e.g. 1999-10 to represent the whole month of 1999-10, independent of how many days this month has.

FloatNumericType

Data Type Based On: xsd:float

float corresponds to the IEEE single-precision 32-bit floating point type [IEEE 754-1985]. The basic value space of float consists of the values m × 2^e, where m is an integer whose absolute value is less than 2^24, and e is an integer between -149 and 104, inclusive. In addition to the basic value space described above, the value space of float also contains the following special values: positive and negative zero, positive and negative infinity and not-a-number. The order-relation on float is: x less than y iff y - x is positive. Positive zero is greater than negative zero. Not-a-number equals itself and is greater than all float values including positive infinity.

DoubleNumericType

Data Type Based On: xsd:double

The double datatype corresponds to IEEE double-precision 64-bit floating point type [IEEE 754-1985]. The basic value space of double consists of the values m × 2^e, where m is an integer whose absolute value is less than 2^53, and e is an integer between -1075 and 970, inclusive. In addition to the basic value space described above, the value space of double also contains the following special values: positive and negative zero, positive and negative infinity and not-a-number. The order-relation on double is: x less than y iff y - x is positive. Positive zero is greater than negative zero. Not-a-number equals itself and is greater than all double values including positive infinity.

IntegerNumericType

Data Type Based On: xsd:integer

Integer is derived from decimal by fixing the value of fractionDigits to be 0. This results in the standard mathematical concept of the integer numbers. The value space of integer is the infinite set {...,-2,-1,0,1,2,...}. The base type of integer is decimal. Numeric Integer decimal

PositiveIntegerNumericType

Data Type Based On: xsd:positiveInteger

PositiveInteger is derived from nonNegativeInteger by setting the value of ·minInclusive· to be 1. This results in the standard mathematical concept of the positive integer numbers. The value space of positiveInteger is the infinite set {1,2,...}. The base type of positiveInteger is nonNegativeInteger.

NegativeIntegerNumericType

Data Type Based On: xsd:negativeInteger

NegativeInteger is derived from nonPositiveInteger by setting the value of maxInclusive to be -1. This results in the standard mathematical concept of the negative integers. The value space of negativeInteger is the infinite set {...,-2,-1}. The base type of negativeInteger is nonPositiveInteger.

NonPositiveIntegerNumericType

Data Type Based On: xsd:nonPositiveInteger

NonPositiveInteger is derived from integer by setting the value of maxInclusive to be 0. This results in the standard mathematical concept of the non-positive integers. The value space of nonPositiveInteger is the infinite set {...,-2,-1,0}. The base type of nonPositiveInteger is integer.

NonNegativeIntegerNumericType

Data Type Based On: xsd:nonNegativeInteger

NonNegativeInteger is derived from integer by setting the value of minInclusive to be 0. This results in the standard mathematical concept of the non-negative integers. The value space of nonNegativeInteger is the infinite set {0,1,2,...}. The base type of nonNegativeInteger is integer.

DurationMeasureType

Data Type Based On: xsd:duration

Duration represents a duration of time. The value space of duration is a six-dimensional space where the coordinates designate the Gregorian year, month, day, hour, minute, and second components defined in section 5.5.3.2 of [ISO 8601], respectively. These components are ordered in their significance by their order of appearance i.e. as year, month, day, hour, minute, and second.

StringType

Data Type Based On: xsd:string

The string datatype represents character strings in XML. The value space of string is the set of finite-length sequences of characters (as defined in [XML 1.0 (Second Edition)]) that ·match· the Char production from [XML 1.0 (Second Edition)]. A character is an atomic unit of communication; it is not further specified except to note that every character has a corresponding Universal Character Set code point, which is an integer.

NormalizedStringType

Data Type Based On: xsd:normalizedString

NormalizedString represents white space normalized strings. The value space of normalizedString is the set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters. The lexical space of normalizedString is the set of strings that do not contain the carriage return (#xD) nor tab (#x9) characters. The base type of normalizedString is string.

TokenType

Data Type Based On: xsd:token

Token represents tokenized strings. The value space of token is the set of strings that do not contain the line feed (#xA) nor tab (#x9) characters, that have no leading or trailing spaces (#x20) and that have no internal sequences of two or more spaces. The lexical space of token is the set of strings that do not contain the line feed (#xA) nor tab (#x9) characters, that have no leading or trailing spaces (#x20) and that have no internal sequences of two or more spaces. The base type of token is normalizedString. Text Token string

URIType

Data Type Based On: xsd:anyURI

AnyURI represents a Uniform Resource Identifier Reference (URI). An anyURI value can be absolute or relative, and may have an optional fragment identifier (i.e., it may be a URI Reference). This type should be used to specify the intention that the value fulfills the role of a URI as defined by [RFC 2396], as amended by [RFC 2732].

LanguageCodeType

Data Type Based On: oacl:LanguageCodeContentType

language represents natural language identifiers as defined by [RFC 1766]. The value space of language is the set of all strings that are valid language identifiers as defined in the language identification section of [XML 1.0 (Second Edition)]. The lexical space of language is the set of all strings that are valid language identifiers as defined in the language identification section of [XML 1.0 (Second Edition)]. The base type of language is token.

MonthDateType

Data Type Based On: xsd:normalizedString

A SQL MonthDate formatted string.

DayDateType

Data Type Based On: xsd:normalizedString

A SQL DayDate formatted string.

MonthDayDateType

Data Type Based On: xsd:token

A SQL MonthDayDate formatted string.

STAR Qualified Data Types

DistanceType

Data Type Based On: oag:StringType

Distance in either miles or kilometers

VINType

Data Type Based On: oag:StringType

Vehicle Identifcation Number

NormalizedStringType

Data Type Based On: oag:NormalizedStringType

Derived from oagis NormalizeStringType

PeriodMeasureType

Used to indicate a length of time in months, years, or weeks.

Table A.13. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Indicates the duration of time in months, weeks, years, etc.

1..1 Code List xfUOMcl:TimeUnitsContentType  
qualifierCode

Use this to further qualify the scope of the measurement.

0..1 Code List xsd:normalizedString  

WeightMeasureType

Used to indicate a weight.

Table A.14. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Use to indicate how much something weighs.

1..1 Code List xfUOMcl:WeightUnitsContentType  
qualifierCode

Use this to further qualify the scope or type of the measurement.

0..1 Code List xsd:normalizedString  

LengthMeasureType

Used to indicate a length.

Table A.15. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Use to indicate the length or distance.

1..1 Code List xfUOMcl:LengthUnitsContentType  
qualifierCode

Use this to further qualify the scope of the measurement.

0..1 Code List xsd:normalizedString  

VolumeMeasureType

Used to indicate a volume.

Table A.16. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Used to indciate volume.

1..1 Code List xfUOMcl:VolumeUnitsContentType  
qualifierCode

Use this to further qualify the scope of the measurement.

0..1 Code List xsd:normalizedString  

AreaMeasureType

Used to indicate an area.

Table A.17. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Used to indciate area.

1..1 Code List xfUOMcl:AreaUnitsContentType  
qualifierCode

Use this to further qualify the scope of the measurement.

0..1 Code List xsd:normalizedString  

SpeedMeasureType

Used to indicate a speed.

Table A.18. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Used to indciate a speed type.

1..1 Code List xfUOMcl:SpeedUnitsContentType  
qualifierCode

Use this to further qualify the scope of the measurement.

0..1 Code List xsd:normalizedString  

TemperatureMeasureType

Used to indicate a speed.

Table A.19. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Used to indciate a temperature type.

1..1 Code List xfUOMcl:TemperatureUnitsContentType  
qualifierCode

Use this to further qualify the scope of the measurement.

0..1 Code List xsd:normalizedString  

FuelConsumptionMeasureType

Used to indicates fuel consumption speed.

Table A.20. Fields and Components

Name Description Occurrence Type Data Type User Notes
volumeUnitCode

Used to indicate the volume of consumption.

1..1 Code List xfUOMcl:VolumeUnitsContentType  
timeUnitCode

Used to indicate the duration or speed of consumption.

1..1 Code List xfUOMcl:TimeUnitsContentType  
qualifierCode

Use this to further qualify the scope of the measurement.

0..1 Code List xsd:normalizedString  

PowerMeasureType

Used to indicate power rating.

Table A.21. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Used to indciate a type of power.

1..1 Code List xfUOMcl:PowerUnitsContentType  
qualifierCode

Use this to further qualify the scope of the measurement.

0..1 Code List xsd:normalizedString  

TimeMeasureType

Used to indicate the amount of time in hours, minutues, seconds, etc.

Table A.22. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Used to indciate a the time measurement.

1..1 Code List xfUOMcl:TimeUnitsContentType  

BoatLengthCodeType

Data Type Based On: nmmacl:BoatLengthContentType

Indicates the type of boat length being measured.

BoatDraftCodeType

Data Type Based On: nmmacl:BoatDraftContentType

Indicates the type of draft being measured.

BoatCategoryCodeType

Data Type Based On: nmmacl:BoatCategoryContentType

Indicates the category in which a boat is defined. Note this is not the same as the BoatClass which identifies the intended usage of a boat. There may be multiple BoatClasses defined in one BoatCategory.

BoatClassCodeType

Data Type Based On: nmmacl:BoatClassContentType

Indicates the definition of the boat, i.e. the intended usage.

BoatHullDesignCodeType

Data Type Based On: nmmacl:BoatHullDesignContentType

Indicates the type of hull design on the boat.

BoatHullMaterialCodeType

Data Type Based On: nmmacl:BoatHullMaterialContentType

Indicates the primary material out of which the hull is made.

BoatKeelCodeType

Data Type Based On: nmmacl:BoatKeelContentType

Indicates the type of keel on the boat.

ElectricityMeasureType

Used to indicate pressure measurements.

Table A.23. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Used to indicate electricity measurements.

1..1 Code List xfUOMcl:ElectricityUnitsContentType  
qualifierCode

Use this to further qualify the scope of the measurement.

0..1 Code List xsd:normalizedString  

ForceMeasureType

Used to indicate force measurements.

Table A.24. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Used to indicate force measurements.

1..1 Code List xfUOMcl:ForceUnitsContentType  
qualifierCode

Use this to further qualify the scope of the measurement.

0..1 Code List xsd:normalizedString  

BoatEngineLocationCodeType

Data Type Based On: nmmacl:BoatEngineLocationContentType

Defines the location on the boat that the engine can be mounted.

PressureMeasureType

Used to indicate pressure measurements.

Table A.25. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Used to indicate pressure measurements.

1..1 Code List xfUOMcl:PressureUnitsContentType  
qualifierCode

Use this to further qualify the scope of the measurement.

0..1 Code List xsd:normalizedString  

DeliveryTypeCodeType

Data Type Based On: scl:DeliveryTypeContentType

Indicates the type of boat length being measured.

PartActivityTransactionCodeType

Data Type Based On: scl:PartActivityTransactionContentType

Part Activity Transactions

FuelTypeCodeType

Data Type Based On: scl:FuelTypeContentType

Type of vehicle fuel

SalesStatusType

Data Type Based On: scl:SalesStatusContentType

The status of the sale of the item.

LanguageCodeType

Data Type Based On: scl:LanguageContentType

The ISO Language Code used to represent a spoken or written language.

CrossShipmentRestrictionCodeType

Data Type Based On: scl:CrossShipmentRestrictionContentType

The restrictions to be applied to an OEM when shipping to a Dealer if cross shipment is allowed.

ComputerStorageMeasureType

Used to indicate the amount of computer storage needed.

Table A.26. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Used to indicate computer storage measurements.

1..1 Code List xfUOMcl:ComputerStorageUnitsContentType  
qualifierCode

Use this to further qualify the scope of the measurement.

0..1 Code List xsd:normalizedString  

JobNumberSchemeIDType

Used to identify a scheme

Table A.27. Fields and Components

Name Description Occurrence Type Data Type User Notes
schemeID

The identification of the identification scheme.

0..1 Code List oag:StringType  

TimeUntiSchemeIDType

Used in the RepairOder ServiceLabor.ServiceLaborTimeValue.TimeUnit element

Table A.28. Fields and Components

Name Description Occurrence Type Data Type User Notes
schemeID

The identification of the identification scheme.

0..1 Code List oag:StringType  

AssigningOrganizationPartyIdType

Data Type Based On: scl:AssigningOrganizationPartyIdContentType

Organization that Assigns the ID

AgencyRoleCodeType

Data Type Based On: scl:AgencyRoleCodeContentType

Indicates the type of keel on the boat.

CountryCodeType

Data Type Based On: scl:CountryContentType

The ISO Country Code.

DisplacementMeasureType

Used to indicate the amount of computer storage needed.

Table A.29. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

Used to indicate displace in either Volume or Weight

1..1 Code List xfUOMcl:DisplacementUnitsContentType  
qualifierCode

Use this to further qualify the scope of the measurement.

0..1 Code List xsd:normalizedString  

ContactMethodTypeCodeType

Data Type Based On: scl:ContactMethodTypeContentType

Indicates the preferred method of contact.

VehicleUseCodeType

Data Type Based On: scl:VehicleUseContentType

Indicates the preferred method of contact.

ShipmentCarrierCompanyCodeType

Data Type Based On: scl:ShipmentCarrierCompanyContentType

Preferred carrier of deliver of part.

ShipmentCarrierTransportMethodTypeCodeType

Data Type Based On: scl:ShipmentCarrierTransportMethodTypeContentType

Defines the method by which a shipment carrier transports an item (i.e., air, ground, etc.)

ShipmentCarrierServiceLevelCodeType

Data Type Based On: scl:ShipmentCarrierServiceLevelContentType

Indicates the priority of service to be provided by the Shipment Carrier

ShipmentCarrierDeliveryCodeType

Data Type Based On: scl:ShipmentCarrierDeliveryContentType

ShipmentCarrierCollectionMethodCodeType

Data Type Based On: scl:ShipmentCarrierCollectionMethodContentType

OrderTypeCodeType

Data Type Based On: scl:OrderTypeContentType

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.

RequestedAmountTypeCodeType

Data Type Based On: scl:RequestedAmountTypeContentType

Enumerated field that indicates the type of amount requested by the Dealer for a Warranty Submission Claim.

ItemIDCategoryTypeCodeType

Data Type Based On: scl:ItemIDCategoryTypeContentType

Indicates the category that a part number is associated with.

DealerServiceTypeCodeType

Data Type Based On: scl:DealerServiceTypeContentType

Indicates the type of services performed by the Dealer.

HoursTypeCodeType

Data Type Based On: scl:HoursTypeContentType

Indicates a type of hours such as Sales hours, Service hours, etc.

DayOfWeekCodeType

Data Type Based On: scl:DayOfWeekContentType

The DaysOfWeek component is used to identify availability based on days of the week.

LocationTypeCodeType

Data Type Based On: scl:LocationTypeContentType

Type of location.

LocationIDTypeCodeType

Data Type Based On: scl:LocationIDTypeContentType

Code representing the type of location.

DeliveryProcessStateCodeType

Data Type Based On: scl:DeliveryProcessStateContentType

Enumerated list of delivery states indicating what is going on with the vehicle.

EventTypeCodeType

Data Type Based On: scl:EventTypeContentType

Enumerated list of unusual event types.

FleetAccountCodeType

Data Type Based On: scl:FleetAccountContentType

Describes the contents of the Fleet Account.

SubtotalTypeCodeType

Data Type Based On: scl:SubtotalTypeCodeContentType

Describes the contents of the SubtotalAmount.

DealerProductsTypeCodeType

Data Type Based On: scl:DealerProductsTypeCodeContentType

Descibes the various dealer product types a dealer can sell. These are not related to other charges or programs and rates.

LeaseEndOptionVehicleDecisionCodeType

Data Type Based On: scl:LeaseEndOptionVehicleDecisionContentType

Enables the customers decision at the end of an option to keep the vehicle or not. It records whether the client has decided to refinance, return, or retain the vehicle or whether they have not made up their mind etc.

LeaseEndOptionFinanceDecisionCodeType

Data Type Based On: scl:LeaseEndOptionFinanceDecisionContentType

Enables the customers decision at the end of an option to be recorded along with other associated information. It records whether the client has decided to finance their next vehicle or whether they have not made up their mind etc.

RepairStatusCodeType

Data Type Based On: scl:RepairStatusCodeContentType

Allows the dealer to indicate to customer whether the problem has been inspected only or fixed as well.

QuantityContentType

Data Type Based On: ???

QuantityType

This is used to indicate general quantity information. It is combination of several code lists. Including The STAR Codelist UOMEnumeratedtype. The XFront code lists, LengthUnitsContentType, WeightUnitsContentType, and VolumeUnitsContentType

Table A.30. Fields and Components

Name Description Occurrence Type Data Type User Notes
unitCode

This is used to indicate general quantity information. It is combination of several code lists. Including The STAR Codelist UOMEnumeratedtype. The XFront code lists, LengthUnitsContentType, WeightUnitsContentType, and VolumeUnitsContentType

0..1 Code List QuantityContentType  

AcquisitionMethodTypeCodeType

Data Type Based On: scl:AcquisitionMethodTypeCodeContentType

Method of purchase normally used to acquire this item.

PartConditionCodeType

Data Type Based On: scl:PartConditionCodeContentType

The condition of a part.

StockingLevelIndicatorCodeType

Data Type Based On: scl:StockingLevelIndicatorCodeContentType

Indicates level of stocking maintained by OEM for this part. This pertains not only to the replentishment algorithm, but the number of stocking locations.

DistributionMethodCodeType

Data Type Based On: scl:DistributionMethodCodeContentType

Used to indicate how an item may be distributed to a buyer.

BuyPercentageRateAdjustmentTypeCodeType

Data Type Based On: scl:BuyPercentageRateAdjustmentTypeContentType

Indicates the type of adjustment, either an addition or subtraction, to be made to the buy rate.

TaxCreditTypeCodeType

Data Type Based On: scl:TaxCreditTypeContentType

Indicates the type of tax credit being applied.

TransferStatusCodeType

Data Type Based On: scl:TransferStatusContentType

A code that that identifies the recommended transfer as either Processed or Unprocessed.

PaymentLineTypeCodeType

Data Type Based On: scl:PaymentLineTypeContentType

Identifies the type of charge associted with this line item. The types are parts, labor, lubrication, core amount, freight, sublet and miscellaneous.

DisplacementMeasureTypeCodeType

Data Type Based On: nmmacl:DisplacementMeasureTypeContentType

Further qualifies the Displacement Measurement.

TankUsageCodeType

Data Type Based On: nmmacl:TankUsageCodeContentType

How the tank is going to be used. i.e. what type of liquids, gas, etc will it be used to contain.

TankMaterialCodeType

Data Type Based On: nmmacl:TankMaterialCodeContentType

The type of material the tank is constructed.

AccommodationTypeCodeType

Data Type Based On: nmmacl:AccommodationTypeCodeContentType

Describes the room / accommodations available on the vehicle including; type, Description, size and Number

WindlassTypeCodeType

Data Type Based On: nmmacl:WindlassTypeCodeContentType

An aparatus for moving heavy weights.

TaxStatusCodeType

Data Type Based On: scl:TaxStatusCodeContentType

Used to indicate the status of the tax.

Appendix B. Code Lists

STAR BODS use many different code lists, some maintained by STAR, some maintained by external organizations. This section documents all of the STAR Code Lists, not every code list may be used by a BOD. Please refer to the fields data type for information on if it uses a code list.

STAR 6 Code Lists

AccountingTermEnumeratedType

  • MTD - Month To Date

  • YTD - Year To Date

  • ME - Month End

AccountingTermContentType

This codelist is a combination of one or more code lists: AccountingTermEnumeratedType

SecondaryAccountingTermEnumeratedType

  • ME - Month End

  • PM - Prior Month

  • BOMYTD - Beginning of Month Year-To-Date

  • EOMYTD - End of Month Year-To-Date

  • PYTD - Prior Year-To-Date

  • CMPA - Current Month Plan Amount

  • YTDPA - Year-To-Date Plan Amount

  • AA - Aged Amount. The associated MonetaryValue is an aged amount

  • UA - Units Aged. The associated NonMonetaryValue is an aged amount

  • SA - Service department amount

  • SU - Service department units

SecondaryAccountingTermContentType

This codelist is a combination of one or more code lists: SecondaryAccountingTermEnumeratedType

AcknowledgmentCodeEnumeratedType

  • 0 - 0 = Accepted as received

  • 1 - 1 = Accepted with modifications in the Header only or in the Header and the Lines

  • 2 - 2 = Order has been rejected

AcknowledgmentCodeContentType

This codelist is a combination of one or more code lists: AcknowledgmentCodeEnumeratedType

AddressQualifierEnumeratedType

  • WorkAddress - Work Address

  • SeasonalAddress - Seasonal Address

  • DeliveryAddress - Delivery Address

  • HomeAddress - Home Address

  • PreviousAddress - Previous Address

  • Other - Other

  • Garage - Garage

  • Billing - Billing

  • NonSigningSpouseAddress - Non Signing Spouse Address

  • N/A - Not Applicable

AddressQualifierContentType

This codelist is a combination of one or more code lists: AddressQualifierEnumeratedType

AllowBackOrderPartialShipEnumeratedType

  • No Back Order - Dealer will not accept back orders

  • No Back Order Ship Available - Back order shipping is not available

  • Allow Back Order - Dealer will allow back orders

  • Allow Back Order No Partial - Dealer will allow back orders with no partial shipments

AllowBackOrderPartialShipContentType

This codelist is a combination of one or more code lists: AllowBackOrderPartialShipEnumeratedType

ApplicationNumberDescriptionEnumeratedType

  • Finance Source - Application number assigned by the Finance Source

  • Retail System Provider - Application Number assigned by the Retail System Provider

ApplicationNumberDescriptionContentType

This codelist is a combination of one or more code lists: ApplicationNumberDescriptionEnumeratedType

ApplicationStatusEnumeratedType

  • P - "P" = Pending

  • A - "A" = Approved

  • C - "C" = Approved with Conditions

  • D - "D" = Denied

  • B - "B" = Booked

  • N - "N" = New

  • M - "M" = Modified

  • R - "R" = Preliminary

  • I - "I" = Withdrawn

  • L - "L" = Canceled

  • O - "O" = Condition

  • E - "E" = Error

  • RO - "RO" = Reopened

  • OT - "OT" = Other

  • Pre-Approved - Pre-Approved

  • More Information Required - More Information Required

  • Not Submitted - Not Submitted

ApplicationStatusContentType

This codelist is a combination of one or more code lists: ApplicationStatusEnumeratedType

AssigningOrganizationPartyIdEnumeratedType

  • LegalId - Legal ID

  • NationalId - Government-assigned ID such as a social security Number

  • Other - Other type of Assigning Organization Party ID

  • DUNS - Dun and Bradstreet

  • MotorDealerRegistrationId - Department of Motor Vehicle Registration number for a dealer. This is the dealer's license number to do business.

  • GSTRegistrationId - Canadian Goods and Services Tax Id.

  • HSTRegistrationId - Canadian HarmonizedTax Id.

  • Certification Of Registration Id - Id of the certificate of registration assigned to a business to allow that business to collect and remit certain taxes or fees to a state.

  • QSTRegistrationId - Canadian Sales Tax Id.

AssigningOrganizationPartyIdContentType

This codelist is a combination of one or more code lists: AssigningOrganizationPartyIdEnumeratedType AssigningPartyIdEnumeratedType

AssigningPartyIdEnumeratedType

  • LegalId - Legal ID

  • DriversLicense - Drivers License

  • NationalId - Government-assigned ID such as a social security Number

  • Other - Other type of Assigning Party ID

  • GSTRegistrationId - Canadian Goods and Services Tax Id.

  • HSTRegistrationId - Canadian HarmonizedTax Id.

  • QSTRegistrationId - Canadian Sales Tax Id.

AssigningPartyIdContentType

This codelist is a combination of one or more code lists: AssigningOrganizationPartyIdEnumeratedType AssigningPartyIdEnumeratedType

AvailabilityStatusEnumeratedType

  • In Stock - Part is in stock.

  • Out Of Stock - Part is in stock.

  • Other - Other availability status.

  • N/A - Not Applicable.

  • In Transit - Indicates that the part is in transit to the warehouse facility.

AvailabilityStatusContentType

This codelist is a combination of one or more code lists: AvailabilityStatusEnumeratedType

BoatEngineTypeEnumeratedType

  • Inboard - Inboard

  • Inboard/Outboard - Inboard/Outboard

  • Jet - Jet

  • Outboard - Outboard

  • Outboard 2 Stroke - Outboard 2 Stroke

  • Outboard 4 Stroke - Outboard 4 Stroke

  • Stern Drive - Stern Drive

  • V Drive - V Drive

  • Electric - Electric

  • Other - A engine type that is not listed in the standard code list.

BoatEngineTypeContentType

This codelist is a combination of one or more code lists: BoatEngineTypeEnumeratedType

CaseTypeEnumeratedType

  • Arbitration - Customer Arbitration

  • Legal - Legal Action

  • Technical Analysis - Customer Arbitration Intervention or legal action related to technical analysis

  • Customer Relations - Customer Arbitration Intervention or legal action related to customer relations

  • Better Business - Customer Arbitration Intervention or legal action related to better business

  • Other - Other

CaseTypeContentType

This codelist is a combination of one or more code lists: CaseTypeEnumeratedType

CashPriceInclusionTypeEnumeratedType

  • Base - Description of an amount for items included in the base vehicle cash price.

  • Total - Description of an amount for items included in the total vehicle cash price.

CashPriceInclusionTypeContentType

This codelist is a combination of one or more code lists: CashPriceInclusionTypeEnumeratedType

ChildLineReasonCodeEnumeratedType

  • Multi-Condition - One or more child lines exist due to differences in allocation such as back orders and warehouse supply.

  • Kit Exploded - One or more child lines exists to express the availability of parts within the kit.

  • Superseded - One or more child lines exist to express the ordered part was superseded by the listed parts.

  • Substituted - One or more child lines exist to express the ordered part was substituted by the listed parts.

ChildLineReasonCodeContentType

This codelist is a combination of one or more code lists: ChildLineReasonCodeEnumeratedType

CodesActionEnumeratedType

  • A - Add to existing table

  • D - Delete existing table by code

  • DA - Delete total table

  • N - Initial table load

  • R - Replace existing table by code

  • RA - Replace total table

CodesActionContentType

This codelist is a combination of one or more code lists: CodesActionEnumeratedType

CollisionDeductibleTypeEnumeratedType

  • Regular -

  • Broadened -

  • Limited -

  • PassengerVehicle -

  • LimitedCommercialVehicle -

CollisionDeductibleTypeContentType

This codelist is a combination of one or more code lists: CollisionDeductibleTypeEnumeratedType

ComponentTypeEnumeratedType

  • Miscellaneous - Miscellaneous service type

  • GasOilGrease - Service type related to gas, oil and grease

  • PaintMaterials - Service type related to paint materials

  • ShopSupplies - Service type related to shop supplies

  • Freight - Service type related to freight

  • Other - Other

  • Core - Charges related to cores.

  • Parts - Charges related to parts.

  • Labor - Charges related to labor

  • Travel - Travel

  • Text Line - Text Line

  • Text Amount Line - Text Amount Line

  • Sublet Line - Sublet Line

ComponentTypeContentType

This codelist is a combination of one or more code lists: ComponentTypeEnumeratedType

ConfirmationEnumeratedType

  • 0 - Never send confirmation

  • 1 - Only send confirmation on error

  • 2 - Always send confirmation

  • Never - Never send confirmation

  • OnError - Only send confirmation on error

  • Always - Always send confirmation

ConfirmationContentType

This codelist is a combination of one or more code lists: ConfirmationEnumeratedType

ConfirmationEntityEnumeratedType

  • Insurance Company - Confirmation was performed by Insurance Company

  • Agency - Confirmation was performed by Insurance Agent

ConfirmationEntityContentType

This codelist is a combination of one or more code lists: ConfirmationEntityEnumeratedType

ContactTelephoneNumberDescriptionEnumeratedType

  • Evening Phone - Evening Phone

  • Day Phone - Day Phone

  • Cell Phone - Cell Phone

  • Pager - Pager

  • Other - Other

ContactTelephoneNumberDescriptionContentType

This codelist is a combination of one or more code lists: ContactTelephoneNumberDescriptionEnumeratedType

ContactTelephoneNumberOrganizationDescriptionEnumeratedType

  • Day Phone - Day Phone

  • Cell Phone - Cell Phone

  • Pager - Pager

  • Other - Other

ContactTelephoneNumberOrganizationDescriptionContentType

This codelist is a combination of one or more code lists: ContactTelephoneNumberOrganizationDescriptionEnumeratedType

CreditCardTypeEnumeratedType

  • Visa - Visa

  • MasterCard - MasterCard

  • AMEX - American Express

  • Discover - Discover

  • gmcard - GM Credit Rewards Card

  • Other - Other

  • N/A - N/A

CreditCardTypeContentType

This codelist is a combination of one or more code lists: CreditCardTypeEnumeratedType

DeliveryTypeEnumeratedType

  • Batch - The total accumulation of captured transactions sent at a set interval

  • Interactive - Transactions that take place in real-time

  • Detail - Contains detail or line item information.

  • Summary - Contains summary information.

DeliveryTypeContentType

This codelist is a combination of one or more code lists: DeliveryTypeEnumeratedType

DeltaEnumeratedType

  • absolute -

  • relative -

  • percentage -

  • other -

DeltaContentType

This codelist is a combination of one or more code lists: DeltaEnumeratedType

DimensionMeasureEnumeratedType

  • ft - ft = feet

  • yd - yd = yard

  • in - in = inch

  • m - m = meter

  • cm - cm = centimeter

DimensionMeasureContentType

This codelist is a combination of one or more code lists: DimensionMeasureEnumeratedType

DriveTypeEnumeratedType

  • Front - Front wheel drive

  • Rear - Rear wheel drive

  • 4X4 - Four wheel drive

  • AWD - All wheel drive

  • Stern - The engine is located inboard just forward transom (sterm) and delivers power via a shaft that goes through the transom to the drive unit.

  • Sail - An arrangement of an inboard motor that is about a sailboat's equivalent of a motorboat's stern drive. The difference is the motor sticks out of the bottom of the hull of the boat, instead of from the stern.

  • V - Consists of two drive shafts, a gearbox, and a propeller. In these types of "V-drive" boats the engine is mounted in the rear of the boat and the front of the engine faces aft. Connected to the rear of the engine is the transmission and out of the transmission comes the first of the two drive shafts. This drive shaft connects to the rear of the transmission and to the gearbox which is mounted in the center of the boat. Then out of the gearbox comes the second drive shaft which extends to the rear and out the bottom of the boat which gives this propulsion system it's V configuration. At the end of the second drive shaft the propeller is mounted.

  • Jet - Unlike a powerboat or motorboat that uses a propeller in the water below or behind the boat, a jet drive draws the water from under the boat into a pump-jet inside the boat, then expels it through a nozzle at the stern.

  • Direct - Configuration where a drive shaft is used to connect the transmission to the propeller.

  • Surface - Engine(s) located aft or amidships, mated to a transmission with an output shaft passing through the transom to a non-steering outdrive that locates the propeller near the water surface. Usually associated with high-performance boats and yachts.

  • Air Propeller - Engine drives a propeller spinning in the air to create thrust to move the craft forward. Used on hovercraft and air boats.

  • Pod - Engines located amidships and mated to pivoting drive units located below the hull that steer the boat by changing the direction of propeller thrust.

  • Other - Other drive type not available in the list.

DriveTypeContentType

This codelist is a combination of one or more code lists: DriveTypeEnumeratedType

EncodingBaseEnumeratedType

  • base64 - Base 64

  • octal - Octal

  • binary - Binary

  • plainText - Plain Text

  • other - Other

  • N/A - Not Applicable

EncodingBaseContentType

This codelist is a combination of one or more code lists: EncodingBaseEnumeratedType

EngineConfigurationEnumeratedType

  • horizontal - Horizontal engine configuration

  • in-line - In-line engine configuration

  • rotary - Rotary engine configuration

  • V-type - V-type engine configuration

  • W-type - W-type engine configuration

  • other - Other

  • N/A - Not Applicable

EngineConfigurationContentType

This codelist is a combination of one or more code lists: EngineConfigurationEnumeratedType

EngineDisplacementEnumeratedType

  • ci - ci - Cubic Inches

  • cc - cc - Cubic Centimeters

  • liters - liters

  • other - other

  • N/A - Not Applicable

EngineDisplacementContentType

This codelist is a combination of one or more code lists: EngineDisplacementEnumeratedType

EngineInductionEnumeratedType

  • turbo - Turbo engine induction

  • supercharger - Supercharger engine induction

  • twin-turbo - Twin-turbo engine induction

  • normally aspirated - Normally aspirated engine induction

  • other - Other

  • N/A - Not Applicable

EngineInductionContentType

This codelist is a combination of one or more code lists: EngineInductionEnumeratedType

FeeTypeEnumeratedType

  • DocumentPreparationFee - Documentary fees also typically referred to as document preparation fees , documentary service fees, closing fees, delivery fee, seller documentation fee, processing fee, administrative fee or other terminology permitted by law. Documentary fees are not official fees and not required by law.

  • SmogCertificateFeePaidToState - This fee is paid by the dealer on behalf of the buyer to the state. This fee is not charged on new vehicles.

  • DocumentationFee - Documentary fees also typically referred to as document preparation fees , documentary service fees, closing fees, delivery fee, seller documentation fee, processing fee, administrative fee or other terminology permitted by law. Documentary fees are not official fees and not required by law.

  • FloridaDocumentFee - A dealer may charge a "delivery" or "documentary" fee only if that charge is separately itemized by the dealer on the Buyer's Order. The delivery or documentary fee must not be separately itemized on the retail installment contract. The delivery or documentary fee may be financed only if it is included in the Cash Price in Section 1, line a. of the retail installment contract.

  • FilingFee - Filing fees (also typically referred to as recording, lien notations, or release of lien fees) are those fees actually paid by the dealer to public officials for determining the existence of, or for perfecting or satisfying any lien related to the retail contract.

  • TitleFee - Title fees are those fees actually paid by the dealer on behalf of the buyer to public officials for titling of the vehicle being purchased related to the contract.

  • RegistrationFee - Title fees are those fees actually paid by the dealer on behalf of the buyer to public officials for the registration of the vehicle being purchased related to the contract.

  • LicenseFee - Title fees are those fees actually paid by the dealer on behalf of the buyer to public officials for licensing of the vehicle being purchased related to the contract.

  • TireFee - This fee will be charged on the sale of new tires, including new tires that are sold or leased as part of a new or used motor vehicles (including spare).

  • MotorVehicleInspectionFee - The Motor Vehicle inspection Fee is a fee paid out by the dealer on behalf of the Buyer.

  • BatteryFee - Battery fee is charged for new or remanufactured batteries.

  • WarrantyRightsFee - This fee is charged on each sale of a motor vehicle, fees paid to public officials.

  • CanadaFilingFee -

  • OfficialFeesPaidToGovtAgencies - Fees paid to local government jurisdictions by the dealer on behalf of the buyer.

  • DocumentaryStampFee -

  • GAP - Guaranteed Auto Protection is an insurance that covers the deficiency balance on a customers account, in the event that the said customers vehicle insurance company claims the vehicle a total loss.

  • LoanOriginationFee - Fee charged by the dealer for completion and execution of the retail/lease contract, paid for by the buyer.

  • DeputyServiceFeePaidToDealer -

  • SmogCertificateFeePaidToSeller - This fee is charged by the Seller or other testing station. There is no legal minimum or maximum amount that may be charged for this fee. This fee is not charged on new vehicles.

  • SmogImpactFee - Vehicles that were subject to payment of the Smog Impact Fee were vehicles previously registered in another state or country prior to California registration. The Smog Impact Fee and, if appropriate, a penalty fee for late payment were imposed on 1975 or newer gasoline-powered, 1980 or newer diesel-powered passenger motor vehicles, and/or commercial motor vehicles with an unladen weight of 6,000 pounds or less, the Environmental Protection Agency (EPA) label did not indicate the vehicle met California emission control standards.

  • ServiceContract - A service agreement that is purchased by the customer for maintenance/service of the vehicle from the manufacturer's provider or approved 3rd party

  • PlateFee - Fee paid by the dealer on the customers behalf to public officials, when a customer requires a new license plate for the newly purchased vehicle.

  • LienNotationFee - Fee paid by the dealer on the customers behalf to public officials when laws require for the vehicle title to be noted with a recorded lien.

  • WasteTire - Waste Tire Fee is based on the size of the tire and applies to new vehicles

  • ArbitrationFee - The Arbitration Fee is used to fund a comprehensive arbitration program for the enforcement of warranties on new vehicles which includes the establishment of a consumer arbitration board for settling warranty disputes.

  • NotaryFee - A notary fee must actually be paid to a third-party notary for notarizing the back of the Certificate of Origin in connection with the purchase of a new vehicle.

  • SecurityInterestChargesFilingFee - This fee is actually paid by the dealer to public officials for determining the existence of, or perfecting, releasing, or satisfying any lien related to the retail sale.

  • ElectronicTitleFee - Fee to charge the buyer of the vehicle for the actual cost to the dealer of the electronic transmission service for issuing permanent registration plate

  • SafetyInspectionFee - Fee for safety inspection of vehicle as required by jurisdiction of where vehicle is registered.

  • ProcessingFee - Fee for processing the vehicles purchase, which includes the obtaining of the title and license plates for the purchaser

  • EmergencyMedicalServiceAdministrationFee - Upon the retail sale or lease of any new or used motor vehicle by a vehicle dealer, the dealer shall collect from the consumer an emergency medical services fee which shall be an administrative fee to be retained by the vehicle dealer.

  • EmissionInspectionFee - Fee for emission inspection of vehicle as required by jurisdiction of where vehicle is registered.

  • AcquisitionFee - The acquisition fee is charged to a customer at the inception of a lease contract.

  • Other - Describes the type of product, but unable to determine what product is.

  • DispositionFee - The disposition fee is charged when a customer turns in their lease vehicle and has paid all remaining payments.

  • TurnInFee - The vehicle turn-in fee is charged when a customer turns in their lease vehicle and has paid all remaining payments.

  • UDriveItPermit - The U Drive it permit is a fee paid for by the dealer on behalf of the customer when the vehicle is first registered with the state clerk’s office under the U-Drive-It program. It is based on the month of incorporation for the leasing company and the month the vehicle is registered.

  • SellPaidSmogFee - This fee is charged by the Seller or other testing station. There is no legal minimum or maximum amount that may be charged for this fee.This fee is not charged on new vehicle

  • TemporaryTagFee - Fee charged by licsensing state/jurisdiction for a temporary tag.

  • TransferFee -

  • SmogExemptionDonationFee - Fee for vehicles that do not qualify for regular smog fees where buyer still wants to donate a portion of funds.

  • LienFee - Lien fees are those fees actually paid by the dealer to public officials for determining the existence of, or for perfecting or satisfying any lien related to the retail contract.

  • WeightFee - Fee charged based on the weight of the vehicle, paid to public officials.

  • PostageFee - Fee charged by the Seller for mailing of documents to public officials and financing company.

  • N/A - Not Applicable

  • PurchaseOptionFee - Fee charged by Financing Company to Buyer if Buyer opts to purchase vehicle at the end of the lease agreement.

  • MonthlyLocalFee -

  • SPVFee - State Patrol Motor Vehicle Title Fee

  • OnlineRegistrationFee - Title fees are those fees actually paid by the dealer on behalf of the buyer to public officials for the registration of the vehicle being purchased related to the retail contract via the internet.

  • FloridaMVWEAFee - Motor Vehicle Warranty Enforcement Act is a fee charged at the sale of a new vehicle and paid to the Department of Revenue.

  • ExemptionFee -

  • LemonLawFeePaidToGovernmentAgency - The fee is collected from the purchaser or lessee by a motor vehicle dealer at the time of sale or at the time of entry into a lease agreement for a motor vehicle and paid to public officials.

  • TerminationFee - Amount customer would have to pay upon early termination of contract with the finance provider.

  • PublicSafetyFee -

  • VehicleTheftRecoveryFee -

  • RearEndDeterrentSafetyFee -

  • NonFilingInsuranceFee - Non filing insurance fee is property insurance utilized in connection with credit transactions in lieu of the actual recording, filing, or releasing of a security instrument or finance statement.

  • EnvironmentalProtectionFee - Environmental protection fee is a fee imposed on the consumers to protect and clean up the environment. This fee can be applied to clean up of underground storage tank site studies and clean up as well as other environmental protections.

  • FreightFee - Freight charges are the fee for hauling a vehicle to a dealership.

  • DealerProcessingFee - Dealer processing charge.

  • VendorSingleInterestFee - A fee charged by the Creditor to protect the creditor for loss or damage to the vehicle during the initial term of the contract.

  • AutoClubMembershipFee - Fee for membership to auto club such as AAA.

  • DPSHandlingFee - Fee for Louisiana. Department of Public Service Handling fee.

  • ElectronicFilingFee - Electronic Filing Fee for online system filing.

  • ConvenienceFee - Fee for Louisiana. Additional fee charged by the dealer.

  • PPSAFee - Personal Property Security Act - Fee charged to customer for registration of the vehicle contract (VIN) with the Government.

  • AdministrationFee - Fee charged for administration of records.

  • ERTFee - State regulated electronic registration and titling fee.

  • GasFee - State regulated gas fee.

  • TitlePrepFee - Fee charged for preparation of title.

  • SupplementalTitleFee - State regulated supplemental title fee.

  • GeorgiaMotorVehicleWarrantyRightsActFee - Companies that sell or lease new motor vehicles to consumers have certain responsibilities under the law. Pursuant to the Georgia Motor Vehicle Warranty Rights Act [O.C.G.A. Section 10-1-789(a)], a fee of $3.00 shall be collected by every dealer, lessor or distributor from each consumer at the completion of the sale or lease of a new motor vehicle.

  • RoadandBridgeFee - A fee on motor vehicle registrations to fund costs associated with road improvements. - Texas

  • MotorVehicleWarrantyTrustFundFee - The $2 fee is collected by the motor vehicle dealer when a new motor vehicle is sold or leased for one year or more. The fee is reported and paid by the selling dealer to the county tax collector or private tag agency when the dealer applies for title. The fees are transferred monthly by the Florida Department of Revenue to the Department of Legal Affairs for deposit into the Motor Vehicle Warranty Trust Fund. - Florida

  • InspectionStickerFees - A fee charged by the dealer for inspection purposes to protect unsafe vehicles from being operated on the road. The fee is used to inspect the vehicle ensuring it is mechanically sound and safe. - Mississippi

  • EmergencyMedicalServiceFees - Fee charged for EMS services for all drivers. - Washington

  • Smog Abatement Fee - The Smog Abatement Fee is the annual fee that must be paid upon registration renewal in lieu of the bi-annual smog inspection.

  • Greenhouse Gas Reduction - A fee that is placed on the registration or renewal of a vehicle that uses fossil fuels for propulsion.

  • Rental Car Surcharge Fee - Rental Car Surcharge is imposed upon a lease or rented motor vehicle

  • Messenger Fee - Messenger Fee pass through charge by dealers to have an outside company provide a public service of delivering and obtaining documents to and from the Department of Motor Vehicle

  • Encumbrance Fee - The Encumbrance Fee is charged to establish a claim against property. This fee is charged by the Dealer but handle by a third party.

  • Motor Vehicle Processing Fee - States like New Jersey that charge the consumer a processing fee for the Motor Vehicle.

  • Title and Registration Processing Fee - A fee charged to process the title and registration of a vehicle

  • DEQ Certification Fee - Air and qualify certification fee.

  • DMV Fee - Miscellaneous Department of Motor Vehicle Fees.

  • New Tag Fee - A fee to obtain a new plate tag.

  • Duplicate of Registration Fee - A fee to obtain a copy of an existing registration if lost, stolen, or destroyed.

  • Vehicle Theft Registration Fee - A fee charged to register theft deterrent products.

  • Total Annual Fees - Total of Annual Fees

  • Total Initial Fees - Total of Initial Fees

  • Document Service Fee - Fee charged to a buyer/lessee for the handling of documents and the performing of services related to the sale /lease and may include dealer profit.

  • Service and Handling Fee - Fee charged to a buyer/lessee for the performing services and handling related to the closing of a sale /lease and may include dealer profit.

  • Delivery and Handling Fee - Fee charged to a buyer/lessee for the handling related to the closing of a sale /lease and may include dealer profit.

  • Recording Fee - Fee charged to a buyer/lessee for the recording of the title (part of the title fee that must be disclosed separately) and is related to the closing of a sale /lease.

  • Air Quality Fee - Air Quality Fee

  • Lender and Member Fee - Lender and Member Fee

  • Mobility Fee - Fee paid to Texas Mobility Fund

  • Acquisition Fee Markup - An amount added to the finance company Acquisition Fee that is retained by the dealer.

  • Courtesy Delivery Fee - Fee for delivery of ordered vehicle(s) to multiple destinations.

  • Electronic Temp Tag Processing Fee - Electronic temporary tag processing fee paid to a vendor (not the state).

  • Special Monthly Fee - Finance source-specific monthly fee on a lease. This differs from "Monthly Local Fee" which is generally a monthly property tax that the vehicle owner (which is the lender in the case of a lease) passes on to the lessee. "Special Monthly Fee" is a fee that the lender collects and pays into a fund for a special purpose--for example, in New York, the fund is used to pay parking tickets that are by law the responsibility of the vehicle owner (the lender). Not all lenders handle this the same way, but those that do require that these two fees be accounted for differently.

FeeTypeContentType

This codelist is a combination of one or more code lists: FeeTypeEnumeratedType

FuelTypeEnumeratedType

  • diesel - Diesel Fuel

  • premium unleaded - Premium Unleaded Fuel

  • unleaded - Unleaded Fuel

  • natural gas - Natural Gas

  • electric - Electric

  • ethanol - Ethanol is an alternative automotive fuel derived from grain and corn; usually blended with gasoline to form gasohol.

  • propane - Propane

  • hybrid - Hybrid is a vehicle that uses two or more distinct power sources to propel the vehicle

  • Other - Other

  • N/A - Not Applicable

  • liquid propane gas - Liquid Propane Gas or LPG is typically a mixture of propane and butane

  • dual fuel - Dual Fuel indicates the engine is capable of running off two distinct, unmixed fuels (ie the boat can run off gas or diesel)

  • petrol - petrol

FuelTypeContentType

This codelist is a combination of one or more code lists: FuelTypeEnumeratedType

GenderEnumeratedType

  • M - Male

  • F - Female

  • N - Neuter

  • O - Other

GenderContentType

This codelist is a combination of one or more code lists: GenderEnumeratedType

GeographicalConstraintTypeEnumeratedType

  • Country - Geographical region by Country

  • State - Geographical region by State

  • Province - Geographical region by Province

  • ZipCode - Geographical region by Zip Code

  • PostalCode - Geographical region by Postal Code

GeographicalConstraintTypeContentType

This codelist is a combination of one or more code lists: GeographicalConstraintTypeEnumeratedType

HomeWorkEnumeratedType

  • Home - Home

  • Work - Work

  • Other - Other

HomeWorkContentType

This codelist is a combination of one or more code lists: HomeWorkEnumeratedType

HouseholdIncomeRangeEnumeratedType

  • Less than $20,000 - Income less than $20,000

  • $20,000 - 34,999 - Income between $20,000 - $34,999

  • $35,000 - 49,999 - Income between $35,000 - $49,999

  • $50,000 - 74,999 - Income between $50,000 - $74,999

  • $75,000 - 99,999 - Income between "75,000 - $99,000

  • $100,000 - 124,999 - Income between $100,000 - $124,999

  • $125,000 or more - Income of $125,000 or more

  • Other - Other income range

  • N/A - Not Applicable

HouseholdIncomeRangeContentType

This codelist is a combination of one or more code lists: HouseholdIncomeRangeEnumeratedType

IncomePeriodEnumeratedType

  • HR - Hour

  • WK - Week

  • BiWK - Bi-Weekly

  • MO - Monthly

  • YR - Year

  • SmMO - Semi-Monthly

  • SmAN - Semi-Annually. Semi-Annually is twice per year

  • Q - Quarterly. Quarterly is four times per year.

IncomePeriodContentType

This codelist is a combination of one or more code lists: IncomePeriodEnumeratedType

IndebtednessResponsibilityEnumeratedType

  • Buyer Paid - Indicates that the buyer will pay the indebtedness on the trade in vehicle.

  • Seller Paid - Indicates that the seller will pay the indebtedness on the trade in vehicle.

  • Other - Other Indebtedness Responsibility value.

  • N/A - Not Applicable.

IndebtednessResponsibilityContentType

This codelist is a combination of one or more code lists: IndebtednessResponsibilityEnumeratedType

InitiativeCategoryEnumeratedType

  • Customer - Initiative applies to Customer category, e.g. First Time Buyer, etc.

  • Vehicle - Initiative applies to Vehicle category.

InitiativeCategoryContentType

This codelist is a combination of one or more code lists: InitiativeCategoryEnumeratedType

InitiativeFinanceTypeEnumeratedType

  • Lease - Initiative applies to lease deals only.

  • Finance - Initiative applies to finance deals only.

InitiativeFinanceTypeContentType

This codelist is a combination of one or more code lists: InitiativeFinanceTypeEnumeratedType

InitiativeTypeEnumeratedType

  • Program - Program-related initiative

  • Incentives - Incentive-related initiative

  • N/A - Not Applicalbe

  • Other - Other

InitiativeTypeContentType

This codelist is a combination of one or more code lists: InitiativeTypeEnumeratedType

InsuranceDetailTypeEnumeratedType

  • Comprehensive -

  • Collision -

  • FireTheftCombinedAdditionalCoverage -

  • TowingAndLabor -

  • RentalReimbursement -

  • Limited -

  • LimitedCollision -

  • SoundEquipment -

  • Other -

  • Liability -

  • BodilyInjury -

  • PropertyDamage -

  • Medical -

  • CollateralProtection -

  • N/A -

  • 30DayElimination - Credit Disability option indicating coverage is active 30 days after the disability occurred.

  • 30DayRetroactive - Credit Disability option indicating coverage is retroactive to the time the disability occurred.

InsuranceDetailTypeContentType

This codelist is a combination of one or more code lists: InsuranceDetailTypeEnumeratedType

InsuranceTypeEnumeratedType

  • Vehicle -

  • Credit Life -

  • Credit Disability -

  • GAP -

  • Mechanical Breakdown -

  • Other -

  • Involuntary Unemployment -

  • Liability Coverage -

  • Single Interest -

  • Double Interest -

  • Public Liability -

  • Full Coverage -

  • N/A -

  • Debt Cancellation - Debt Cancellation is a form of insurance. In Maryland, Debt Cancellation can be selected as well as GAP Insurance.

  • Excess Protection Wear and Tear - Insurance purchased by customer to protect against mileage overage and incidental damage to the vehicle.

  • Etch - A theft deterent device that is applied to a window or other portion of the vehicle.

  • Service Plan - Service Plan. Certain states or regions require this to be displayed as insurance.

  • Tire and Wheel - Tire and Wheel. Certain states or regions require this to be displayed as insurance.

  • Warranty - Warranty. Certain states or regions require this to be displayed as insurance.

InsuranceTypeContentType

This codelist is a combination of one or more code lists: InsuranceTypeEnumeratedType

InventoryTypeEnumeratedType

  • Full - Full inventory transmission

  • Incremental - Incremental inventory transmission

  • Daily - End of Day Net Changes

  • Historical - Sales History

InventoryTypeContentType

This codelist is a combination of one or more code lists: InventoryTypeEnumeratedType

InvoiceShipmentEnumeratedType

  • Credit -

  • History -

  • Retail -

  • Return -

  • Wholesale -

  • Shipment -

  • Other -

InvoiceShipmentContentType

This codelist is a combination of one or more code lists: InvoiceShipmentEnumeratedType

LeadIndustryTypeEnumeratedType

  • Automotive - Automotive

  • Boats - Boats

  • Motorcycles - Motorcycles

  • RVs - RVs

  • Marine Engines - Marine Engines

  • PWC - PWC

  • Snowmobiles - Snowmobiles

  • Trailers - Trailers

  • ATVs - ATVs

  • Scooters - Scooters

LeadIndustryTypeContentType

This codelist is a combination of one or more code lists: LeadIndustryTypeEnumeratedType

LeadInterestEnumeratedType

  • C - Cash

  • B - Buy

  • F - Finance

  • L - Lease

  • S - Sell

  • T - Trade

  • Other - Other

LeadInterestContentType

This codelist is a combination of one or more code lists: LeadInterestEnumeratedType

LeadTypeEnumeratedType

  • I - Individual

  • B - Business

  • Other - Other

LeadTypeContentType

This codelist is a combination of one or more code lists: LeadTypeEnumeratedType

LineStateTypeEnumeratedType

  • Hold - Hold identifies the fact the part on the subject line has been put on hold.

  • Submitted - Submitted identifies the fact the part on the subject line has been submitted.

  • Rejected - Rejected identifies the fact the part on the subject line has been rejected

  • Back Ordered - Back Ordered identifies the fact the part on the subject line is on back order.

  • Allocated - Allocated identifies the fact the part on the subject line has been allocated.

  • Cancelled - Cancelled identifies the fact the order for the part on the subject line has been cancelled

  • Pick List Printed - Pick List Printed identifies the fact the pick list for the subject line has been printed.

  • Shipped - Shipped identifies the fact the part on the subject line has been shipped

  • Other - Other Line State

  • N/A - Not Applicable

  • Referral - Referral identifies the fact the part on the subject line has been referred to another supplier and will not be reported on through this parts order going forward. The Primary Supplier is giving a referral to another Supplier for this particular line. It is similar to canceling a line. The Primary Supplier will not report on this line any further with this order. The Dealer will still receive the part, however it will be a different Supplier providing the part.

  • Invoiced - Invoiced

  • Completed - Completed

  • Partially Invoiced - Partially invoiced

  • Partially Shipped - Partially shipped

LineStateTypeContentType

This codelist is a combination of one or more code lists: LineStateTypeEnumeratedType

MaritalStatusEnumeratedType

  • M - Married

  • U - Unmarried

  • S - Separated

  • O - Other

MaritalStatusContentType

This codelist is a combination of one or more code lists: MaritalStatusEnumeratedType

MessageReasonCodeEnumeratedType

  • Success - The operation completed successfully. This does not necessarily mean that the BOD was processed. Instead it means that the client's role is done and that it won't receive any error messages later. Type of Response Code: Success.

  • Accepted - The BOD was received, validated, and accepted. However, it may not have yet been processed. The client should expect to receive a response once process is complete. If no response will be generated, use the "Success" code instead. This is typically used for batch processing. Type of Response Code: Success.

  • Received - The BOD was received. However, it has not yet been validated or processed yet. The client may receive a response or a ConfirmBOD at a later time. Type of Response Code: Success.

  • Other - An unspecified outcome status. The accompanying description array contains the actual text to display to the user. Type of Response Code: Error, Warning.

  • Duplicate Document - This code refers to a document that already exists. This may happen for a BOD such as ProcessPartsOrder where the document identifiers to another existing parts order from the same dealer. Type of Response Code: Error, Warning.

  • Invalid Required Value - One or more required data elements have invalid values. Type of Response Code: Error.

  • Invalid Optional Value - One or more optional data elements have invalid values. Type of Response Code: Warning.

  • Already Performed - This code refers to an operation that has already been performed on a document. This may happen for a BOD such as CancelPartsOrder where the document identifier refer to a parts order that has already been cancelled. Type of Response Code: Error.

  • Cannot Perform - This code refers to an operation that cannot be performed such as Change or Cancel based on the receiver's business rules and the condition of the document. For example, the part order has already been shipped therefore the order cannot be cancelled. Type of Response Code: Error.

  • Required Field Missing - This occurs when one or more required fields are missing. Type of Response Code: Error.

  • Optional Field Missing - This occurs when one or more optional fields are missing. Type of Response Code: Warning.

  • Not Permitted - This code occurs when the client attempts to perform an operation that is not permitted. An example of when this may occur is if the dealer attempts to order a part when their account is placed on hold. This is to be used for authorization errors. Type of Response Code: Error.

  • Server Error - An error (e.g. database server is down) on the server prevented the execution of the BOD. The client will have to resend the BOD at a later time. Type of Response Code: Error.

  • BOD Not Supported - The received BOD or BOD version is not supported b the receiver. Type of Response Code: Error.

  • Invalid Structure - The structure of the BOD is not valid. For example, the BOD failed schema validation. Type of Response Code: Error.

MessageReasonCodeContentType

This codelist is a combination of one or more code lists: MessageReasonCodeEnumeratedType

MileageMeasureEnumeratedType

  • M - Miles

  • K - Kilometers

MileageMeasureContentType

This codelist is a combination of one or more code lists: MileageMeasureEnumeratedType

OptionPricingTypeEnumeratedType

  • Retail - Amount typically sold for to a retail customer (dealer to consumer, or consumer to consumer transactions).

  • Loan - Amount lenders typically loan on the listed vehicle.

  • Trade-In - Amount allowed by dealers on a trade.

OptionPricingTypeContentType

This codelist is a combination of one or more code lists: OptionPricingTypeEnumeratedType

OrderStateTypeEnumeratedType

  • Hold - The supplier should not process this order.

  • Submitted - The order is submitted from the dealer to the supplier.

  • Rejected - The order was rejected for some reason.

  • Pending Processing - The supplier has the order, has successfully parsed the order, but has not submitted the order to back end systems for processing.

  • Credit Hold - The order is on hold until credit is determined to be satisfactory for the order to complete.

  • Cancelled - The order in its entirety is cancelled.

  • Allocated - Parts for one or more order Lines have been reserved for the order.

  • Released - One or more Lines have been released to the warehouse for fulfillment.

  • Completed - All Lines are either Shipped, Cancelled, Referral, or Rejected.

  • Other - Other Order State not specified in enumerated list.

  • N/A - Not Applicable

  • Created - Created

  • Confirmed - Confirmed

  • Updated - Updated

  • Payment Terms Updated - Payment terms updated

  • Released to Production - Released to Production

  • Production Started - Production started

  • Production Finished - Production finished

  • Shipped - Shipped

  • Vehicle Identifier Assigned - Vehicle identifier assigned

  • Available - Available

  • Back Ordered - Back Ordered

  • Blocked - Blocked

  • Invoiced - Invoiced

  • Partially Invoiced - Partially Invoiced

  • Partially Shipped - Partially Shipped

  • Pick List Printed - Pick List Printed

OrderStateTypeContentType

This codelist is a combination of one or more code lists: OrderStateTypeEnumeratedType

OrderTypeEnumeratedType

  • STK - Stock. A stock order is an order generated by Dealer.

  • VOR - Vehicle Off Road

  • DPO - Daily. Suggested or automated order replenishment is generated daily by OEM. Suggested Orders are to be made using the Proposed verb. ASR orders are to be made using the Notify verb.

  • EMG - Emergency. An emergency order is an order generated by the Dealer where the Dealer is responsible for the freight costs and the order is expected to ship immediately (same day/time depending on the OEM policy).

  • SUP - Supplemental. A supplemental order is an order generated by the Dealer as an extra buy, e.g., a Dealer may want to have extra quantities of a particular part. This is for replenishment of items on the shelf.

  • PRO - Promotional. A promotional order is an order generated by a Dealer. In this case the Dealer will use a promotional code received at a trade show or advertisement when placing the order in order to receive a special rate.

  • SOL - Solicited. A solicited order is an order generated by the Dealer for a direct ship from a Supplier directly to the Dealer.

  • VPI - Vehicle Off Road Parts Inquiry

  • WKL - Weekly. A weekly order is an order replenishment this generated by Dealer on specific days (e.g., Order replenishment generated on Tuesdays).

  • WKE - Weekend. An order that could be processed over the weekend.

  • INT - Interim

  • EXP - Export

  • DSS - Dropship Stock

  • DVR - Dropship Vehicle Off Road

  • LAK - Lock and Key

  • WCL - Will Call

  • RRR - Return Request w/ Reference

  • RWR - Return without Reference

  • CRR - Credit Request with Reference

  • CWR - Credit Request without Reference

  • DRR - Debit Request with Reference

  • DWR - Debit Request without Reference

  • RUS - Rush

  • URG - Urgent. An urgent order is a critical order where the Dealer will pay for expediting of the order, e.g., for example the OEM will find the part even if it is indicated as a back ordered item. This is different from an emergency order due to the additional expediting process.

  • OTH - Other. Other Order Type not identified on the enumerated list. May be predetermined by a Dealer configuration.

  • N/A - Not Applicable

  • HLD - Hold

  • DTG - Dating

  • CUS - Customer. A basic customer order placed at the dealership, (e.g., a particular radio). The order generated by a Dealer.

  • PPI - Part Price Inquiry

  • HOL - Order to be processed on Holidays

  • LDO - Large Dealer Order (Confirms order was not placed in error)

  • SVC - Service Vehicle Campaign

  • TOS - Transient Owner Service

  • MAN - Manual Order

  • CSC - Customer Special Care

  • ASR - Automatic Stock Replenishment

  • SPC - Special Customer Care

  • FCO - Free of Charge Order

  • INI - Initial Orders (e.g. for a new model)

  • REP - Replenishment Orders

  • WRO - Warranty Rush Order

  • YOLR - Late Rush Order

  • YPMP - Production Memo Parts

  • YWAR - Warranty Order

  • YOR - YOR Stock

  • YVOR - YVOR Rush

  • YMAS - YMAS Mass

  • YOCV - YOCV Campaign

  • ZPLO - ZPLO PMP Stock

  • ZCAM - ZCAM Campaign

  • ZPRO - ZPRO Promotion Order

  • EOS - Extended Offer Stock order

  • EOD - Extended Offer Day order

OrderTypeContentType

This codelist is a combination of one or more code lists: OrderTypeEnumeratedType

OwnedTypeEnumeratedType

  • Current - Vehicle information related to the current vehicle

  • Previous - Vehicle information related to the previous vehicle

  • Household - Vehicle information related to the household vehicle

  • Other - Other type of vehicle information

OwnedTypeContentType

This codelist is a combination of one or more code lists: OwnedTypeEnumeratedType

PartsShipmentLineBoxingTypeEnumeratedType

  • Line Boxing Detail - Each line is associated with a specific box in the shipment. This provides a complete picture of what part is contained in which box.

  • Line Boxing Aggregate - Lines and Boxing data is available, however there is no detail as to which parts are contained in which boxes. The line data is aggregate.

  • Line Aggregate - There is no boxing detail provided and the line data is in aggregate for the shipment.

PartsShipmentLineBoxingTypeContentType

This codelist is a combination of one or more code lists: PartsShipmentLineBoxingTypeEnumeratedType

PartTypeEnumeratedType

  • H - Manufacturer Part Code

  • P - Part Number

PartTypeContentType

This codelist is a combination of one or more code lists: PartTypeEnumeratedType

PartSaleTypeEnumeratedType

  • RS - Repair Order Sale

  • RL - Repair Order Lost Sale

  • CS - Counter Ticket Sale

  • CL - Counter Ticket Lost Sale

  • SS - Service Appointment Sale

  • AS - All Sales

  • AL - All Lost Sales

PartSaleTypeContentType

This codelist is a combination of one or more code lists: PartSaleTypeEnumeratedType

PartyTypeEnumeratedType

  • Supplier - OEM or aftermarket distributor

  • Dealer - Dealer

  • Other - Other Party Type

  • N/A - Not Applicable

PartyTypeContentType

This codelist is a combination of one or more code lists: PartyTypeEnumeratedType

PaymentMethodEnumeratedType

  • Terms - Indicates that payment terms are provided.

  • COD - Cash On Delivery

  • Due On Receipt - Payment is due upon receipt of invoice.

  • Credit Card - Indicates that a credit card will be used as the method of payment.

  • Check - Indicates that a check will be used as the method of payment.

  • EFT - Electronic funds transfer.

  • Payroll Deduction - Indicates that a payment will be via deduction of an individual's payroll.

  • Cash - Indicates that cash will be used as the method of payment.

  • Finance - The payment has been included in the financing of the contract.

  • Other - Other type of payment method.

  • N/A - Payment method not applicable.

  • Exchange - Indicates the dealers intent to return parts in exchange for the monetary value of the order.

PaymentMethodContentType

This codelist is a combination of one or more code lists: PaymentMethodEnumeratedType

PayrollFrequencyEnumeratedType

  • HR - Hour

  • WK - Week

  • BiWK - Bi-Weekly

  • MO - Month

  • YR - Year

  • SmMO - Semi-Monthly

PayrollFrequencyContentType

This codelist is a combination of one or more code lists: PayrollFrequencyEnumeratedType

PlanOptionTypeEnumeratedType

  • Optional - Optional Plan

  • Mandatory - Mandatory Plan

  • Standard - Standard Plan

PlanOptionTypeContentType

This codelist is a combination of one or more code lists: PlanOptionTypeEnumeratedType

OriginalContactMethodContentType

This codelist is a combination of one or more code lists: OriginalContactMethodEnumeratedType

OriginalContactMethodEnumeratedType

  • Internet Channel - Internet Channel

  • Showroom Walk-In - Showroom Walk-In

  • Event/Trade Fair - Event/Trade Fair

  • Service Walk-In - Service Walk-In

  • Appointment at Customer - Appointment at Customer

PreferredContactMethodEnumeratedType

  • Day Phone - Day Phone

  • Evening Phone - Evening Phone

  • Cell Phone - Cell Phone

  • Work Fax - Work Fax

  • Home Fax - Home Fax

  • Pager - Pager

  • Work Email - Work Email

  • Home Email - Home Email

  • US Mail - US Mail

  • Text - SMS Text

  • WhatsApp - WhatsApp

  • IM - Instant Messaging

  • Other - Other

  • N/A - Not Applicable

PreferredContactMethodContentType

This codelist is a combination of one or more code lists: PreferredContactMethodEnumeratedType

PreferredContactMethodOrganizationEnumeratedType

  • Day Phone - Day Phone

  • Cell Phone - Cell Phone

  • Work Fax - Work Fax

  • Pager - Pager

  • Work Email - Work Email

  • US Mail - US Mail

  • Other - Other

PreferredContactMethodOrganizationContentType

This codelist is a combination of one or more code lists: PreferredContactMethodOrganizationEnumeratedType

PriceTypeContentType

This codelist is a combination of one or more code lists: PriceTypeEnumeratedType

RebateTypeEnumeratedType

  • Manufacturer - Manufacturer Rebate

  • Dealer - Dealer Rebate

  • Third Party - Third Party Rebate

RebateTypeContentType

This codelist is a combination of one or more code lists: RebateTypeEnumeratedType

<