Star Logo

Implementation Guideline

Cancel Retail Delivery Reporting
Repository Version Rev4.5.4












Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved












Cancel Retail Delivery Reporting

Table of Contents

top

Overview

This document is a guideline on how to use the Cancel Retail Delivery Reporting Business Object Document (BOD). Cancel Retail Delivery Reporting has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Cancel Retail Delivery Reporting process for individual consumers who service their automobiles through their OEM’s authorized Dealers. The focus is on Dealer and OEM interactions, not third party organizations. NOTE: Although this is the traditional use of the Cancel Retail Delivery Reporting, this BOD could be used to send Cancel Retail Delivery Reporting information between any two business parties.

The Cancel Retail Delivery Reporting Implementation Guidelines provide detailed information regarding the structure and meaning of the Cancel Retail Delivery Reporting BOD and corresponds directly to the Cancel Retail Delivery Reporting schema. In addition to structure and meaning, the Implementation Guidelines identify various business rules for specific fields/components that due to their nature, i.e. field interdependence, are not possible to express using schema. Please note that although these business rules are not included in the schema, they MUST be followed to be STAR Compliant. Therefore, the Cancel Retail Delivery Reporting Implementation Guidelines must be used in concert with the Cancel Retail Delivery Reporting schema during development and should NOT be considered a supplement or substitution to the schema. For more information regarding STAR XML Data Compliance, please review the STAR Data Compliance Guidelines document located on the STAR Web site.

For a copy of the corresponding Cancel Retail Delivery Reporting schema, please download the appropriate STAR schema repository from the XML portion of the STAR website (www.starstandard.org). Prior to downloading the schema, users are encouraged to download the STAR XML Reference/Implementation document also located on the XML portion of the STAR website. This document provides an overview of the STAR BOD development methodology, how to download and read STAR schema, and various frequently asked questions related to the implementation of STAR BODs.

STAR has followed the Open Application Group’s Business Object Document methodology to develop the Cancel Retail Delivery Reporting BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Cancel Retail Delivery Reporting BOD is unique to the Retail Automotive industry and is not an extension of any existing OAGIS BODs.

For more information on the Open Applications Group's BODs and related documentation please refer to the Open Applications Group’s Web site at www.openapplications.org.

top

Schema Field Usage

STAR uses the same Noun in the schema for all the Noun/Verb combinations of the Cancel Retail Delivery Reporting except the Get verb. Please refer to each Noun/Verb combination within this document to understand the requirements for each specific BOD. Although the Noun will always have every field defined for the Noun in the schema, each Noun/Verb combination may not use all of the fields. If a field is not used by a BOD, it will be noted in the business rules.

top

Business Scenario

The Retail Delivery Reporting Binary Collaboration starts with the transmission of the retail delivery report from a dealer to a lender. This submission may be done multiple times. The lender then verifies the contract and responds. This process occurs on demand as is needed. Note: This scenario is an example of how the Credit Contract BOD can be used. Implementations may vary.

top

Relationship Diagram

The relationship diagram identifies all of the various components or building blocks of information used in the Cancel Retail Delivery Reporting BOD. This diagram visually depicts the relationships of the components using symbolic indentation and their occurrence in the BOD. Note: That this is an approximation of the Components, and may not reflect the exact implementation. Also, some fields are displayed in the diagram. This diagram should only be used as a starting point and not an absolute reference. Relationship Diagram for RetailDeliveryReporting

top

Schema Document Properties

Target Namespacehttp://www.starstandards.org/STAR
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
DocumentationThis schema is made available under an Eclipse Public Licenses 1.0. This license may be found in the STAR/License directory as well as the STAR BOD Guidelines.
More information at: http://www.starstandard.org/.

Declared Namespaces

PrefixNamespace
Default namespacehttp://www.starstandards.org/STAR
xmlhttp://www.w3.org/XML/1998/namespace
xsdhttp://www.w3.org/2001/XMLSchema

Schema Component Representation
<xsd:schema targetNamespace="http://www.starstandards.org/STAR" elementFormDefault="qualified" attributeFormDefault="unqualified">
...
</xsd:schema>
top

Global Declarations

Element: ApplicationArea

NameApplicationArea
TypeApplicationArea
Nillableno
Abstractno
DocumentationProvides 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.
More information at: http://www.openapplications.org/oagis.

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.
More information at: http://www.openapplications.org/oagis.

XML Instance Representation
<ApplicationArea>
<Sender> Sender </Sender> [1] ?
<CreationDateTime> DateTime </CreationDateTime> [1] ?
<Signature> Signature </Signature> [0..1] ?
<BODId> Code </BODId> [0..1] ?
<Destination> Destination </Destination> [1] ?
</ApplicationArea>
Schema Component Representation
<xsd:element name="ApplicationArea" type="ApplicationArea"/>
top

Element: Cancel

  • This element can be used wherever the following element is referenced:

NameCancel
TypeCancel
Nillableno
Abstractno
DocumentationThe 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.
More information at: http://www.openapplications.org/oagis.

XML Instance Representation
<Cancel
confirm="ConfirmType [0..1]"
/>
Schema Component Representation
<xsd:element name="Cancel" type="Cancel" substitutionGroup="Verb"/>
top

Element: CancelRetailDeliveryReporting

NameCancelRetailDeliveryReporting
TypeCancelRetailDeliveryReporting
Nillableno
Abstractno

XML Instance Representation
<CancelRetailDeliveryReporting
revision="Text [0..1] ?"

release="8.1-Lite [0..1] ?"

environment="Text [0..1] ?"

lang="Language [0..1] ?"

bodVersion="Text [0..1] ?"
>
<DataArea> CancelRetailDeliveryReportingDataArea </DataArea> [1]
</CancelRetailDeliveryReporting>
Schema Component Representation
<xsd:element name="CancelRetailDeliveryReporting" type="CancelRetailDeliveryReporting"/>
top

Element: Header

NameHeader
TypeRetailDeliveryReportingHeader
Nillableno
Abstractno
Documentation More information at: http://www.starstandards.org.

XML Instance Representation
<Header>
<DocumentDateTime> DocumentDateTime </DocumentDateTime> [0..1] ?
<SecondaryPassword> SecondaryPassword </SecondaryPassword> [0..1] ?
<SecondaryDealerNumber> SecondaryDealerNumber </SecondaryDealerNumber> [0..1] ?
<DocumentId> DocumentId </DocumentId> [0..1] ?
<SalesDate> SalesDate </SalesDate> [0..1] ?
<DealerTransferDate> DealerTransferDate </DealerTransferDate> [0..1] ?
<AcquisitionMethod> AcquisitionMethod </AcquisitionMethod> [0..1] ?
<SaleCategory> SaleCategory </SaleCategory> [0..1] ?
<SaleSubCategory> SaleSubCategory </SaleSubCategory> [0..*] ?
<TransferringDealer> RDRDealerExtendedAddress </TransferringDealer> [0..1] ?
<SalesPerson> SalesPersonAddress </SalesPerson> [0..*] ?
<SalesManager> SalesPersonParty </SalesManager> [0..1] ?
<FIManager> SalesPersonParty </FIManager> [0..1] ?
<SellingSource> SellingSource </SellingSource> [0..1] ?
<IndividualBuyer> IndividualBuyerPartyExtended </IndividualBuyer> [0..1] ?
<OrganizationalBuyer> OrganizationalBuyerPartyExtended </OrganizationalBuyer> [0..1] ?
<IndividualCo-Buyer> IndividualBuyerParty </IndividualCo-Buyer> [0..*] ?
<OrganizationalCo-Buyer> OrganizationalBuyerParty </OrganizationalCo-Buyer> [0..*] ?
<PrimaryDriver> IndividualBuyerParty </PrimaryDriver> [0..1] ?
<SecondaryDriver> IndividualBuyerParty </SecondaryDriver> [0..*] ?
<Financing> SoldFinancing </Financing> [0..1] ?
<TradeIn> TradeIn </TradeIn> [0..*] ?
<LocationId> LocationId </LocationId> [0..1] ?
</Header>
Schema Component Representation
<xsd:element name="Header" type="RetailDeliveryReportingHeader"/>
top

Element: RetailDeliveryReporting

NameRetailDeliveryReporting
TypeRetailDeliveryReporting
Nillableno
Abstractno
Documentation More information at: http://www.starstandards.org.

XML Instance Representation
<RetailDeliveryReporting>
<Header> ... </Header> [1]
<Vehicle> ... </Vehicle> [0..*]
</RetailDeliveryReporting>
Schema Component Representation
<xsd:element name="RetailDeliveryReporting" type="RetailDeliveryReporting"/>
top

Element: Vehicle

NameVehicle
TypeSoldVehicle
Nillableno
Abstractno
Documentation More information at: http://www.starstandards.org.

XML Instance Representation
<Vehicle>
<Model> Model </Model> [0..1] ?
<ModelYear> ModelYear </ModelYear> [0..1] ?
<ModelDescription> ModelDescription </ModelDescription> [0..1] ?
<Make> Make </Make> [0..1] ?
<SaleClass> SaleClass </SaleClass> [0..1] ?
<Condition> Condition </Condition> [0..1] ?
<CertifiedPreownedInd> CertifiedPreownedInd </CertifiedPreownedInd> [0..1] ?
<VehicleNote> VehicleNote </VehicleNote> [0..*] ?
<VIN> VIN </VIN> [0..1] ?
<DeliveryMileage> DeliveryMileage </DeliveryMileage> [0..1] ?
<VehicleStock> VehicleStock </VehicleStock> [0..1] ?
<TrimCode> TrimCode </TrimCode> [0..1] ?
<DoorsQuantity> DoorsQuantity </DoorsQuantity> [0..1] ?
<BodyStyle> BodyStyle </BodyStyle> [0..1] ?
<InteriorColor> InteriorColor </InteriorColor> [0..*] ?
<ExteriorColor> ExteriorColor </ExteriorColor> [0..*] ?
<TransmissionType> TransmissionType </TransmissionType> [0..1] ?
<OdometerStatus> OdometerStatus </OdometerStatus> [0..1] ?
<NonUSVehicleInd> NonUSVehicleInd </NonUSVehicleInd> [0..1] ?
<VehicleDemoInd> VehicleDemoInd </VehicleDemoInd> [0..1] ?
<LicenseNumber> LicenseNumber </LicenseNumber> [0..1] ?
<BrandedInfo> BrandedInfo </BrandedInfo> [0..1] ?
<RestrictionInd> RestrictionInd </RestrictionInd> [0..1] ?
<RestrictionDescription> RestrictionDescription </RestrictionDescription> [0..1] ?
<TelematicsServiceInd> TelematicsServiceInd </TelematicsServiceInd> [0..1] ?
<Option> ExpandedOption </Option> [0..*] ?
<TransmissionCode> TransmissionCode </TransmissionCode> [0..1] ?
<DeliveryDate> DeliveryDate </DeliveryDate> [0..1] ?
<EngineNumber> EngineNumber </EngineNumber> [0..1] ?
<IgnitionKeyNumber> IgnitionKeyNumber </IgnitionKeyNumber> [0..1] ?
<AxleCode> AxleCode </AxleCode> [0..1] ?
<FleetAccount> FleetAccount </FleetAccount> [0..1] ?
<FleetVehicleId> FleetVehicleId </FleetVehicleId> [0..1] ?
<FleetPurchaseOrderNumber> FleetPurchaseOrderNumber </FleetPurchaseOrderNumber> [0..1] ?
<DoorKeyNumber> DoorKeyNumber </DoorKeyNumber> [0..1] ?
<VehicleWeight> VehicleWeight </VehicleWeight> [0..1] ?
<ExteriorColorCode> ExteriorColorCode </ExteriorColorCode> [0..*] ?
<InteriorColorCode> InteriorColorCode </InteriorColorCode> [0..*] ?
<PDIDate> PDIDate </PDIDate> [0..1] ?
<RegistrationState> RegistrationState </RegistrationState> [0..1] ?
<SecurityCode> SecurityCode </SecurityCode> [0..1] ?
<Warranty> WarrantyAdditional </Warranty> [0..*] ?
<ServiceContract> SoldServiceContract </ServiceContract> [0..*] ?
<PDITechnician> ServiceTechnician </PDITechnician> [0..1] ?
<MarketingInitiatives> MarketingInitiatives </MarketingInitiatives> [0..*] ?
<Tire> Tire </Tire> [0..*] ?
<EngineDisplacement> EngineDisplacement </EngineDisplacement> [0..1] ?
<EngineDescription> EngineDescription </EngineDescription> [0..1] ?
<CommercialUsageInd> CommercialUsageInd </CommercialUsageInd> [0..1] ?
</Vehicle>
Schema Component Representation
<xsd:element name="Vehicle" type="SoldVehicle"/>
top

Element: Verb

  • The following elements can be used wherever this element is referenced:

NameVerb
TypeVerb
Nillableno
Abstractyes

XML Instance Representation
<Verb/>
Schema Component Representation
<xsd:element name="Verb" type="Verb" abstract="true"/>
top

Global Definitions

Components (Complex Type): Address

Super-types:AddressBase < Address (by extension)
Sub-types:

NameAddress
Abstractno

Attributes

AttributeDescriptionRequirementBusiness Rules
qualifier Required 

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AddressLineIndicates the multiple lines of an address. The first line is typically the street name and number. Required 
CityIs the City of the Address. Required 
CountyCounty in which the Address is in. Optional 
StateOrProvinceIs the State or Province of a given Address. Required 
CountryCountry in which the Address is in. Required 
PostalCodePostal Code of the Address. Required 

XML Instance Representation
<...
qualifier="AddressQualifier [0..1]"
>
<AddressLine> AddressLine </AddressLine> [1..*] ?
<City> City </City> [1] ?
<County> County </County> [0..1] ?
<StateOrProvince> StateOrProvince </StateOrProvince> [1] ?
<Country> Country </Country> [1] ?
<PostalCode> PostalCode </PostalCode> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="Address">
<xsd:complexContent>
<xsd:extension base="AddressBase">
<xsd:attribute name="qualifier" type="AddressQualifier"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): AddressBase

Super-types:None
Sub-types:

NameAddressBase
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AddressLineIndicates the multiple lines of an address. The first line is typically the street name and number. Required 
CityIs the City of the Address. Required 
CountyCounty in which the Address is in. Optional 
StateOrProvinceIs the State or Province of a given Address. Required 
CountryCountry in which the Address is in. Required 
PostalCodePostal Code of the Address. Required 

XML Instance Representation
<...>
<AddressLine> AddressLine </AddressLine> [1..*] ?
<City> City </City> [1] ?
<County> County </County> [0..1] ?
<StateOrProvince> StateOrProvince </StateOrProvince> [1] ?
<Country> Country </Country> [1] ?
<PostalCode> PostalCode </PostalCode> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="AddressBase">
<xsd:sequence>
<xsd:element name="AddressLine" type="AddressLine" maxOccurs="unbounded"/>
<xsd:element name="City" type="City"/>
<xsd:element name="County" type="County" minOccurs="0"/>
<xsd:element name="StateOrProvince" type="StateOrProvince"/>
<xsd:element name="Country" type="Country"/>
<xsd:element name="PostalCode" type="PostalCode"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): AlternatePartyId

Super-types:None
Sub-types:

NameAlternatePartyId
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
IdAlternate Party Identification Required 

XML Instance Representation
<...>
<Id> Id </Id> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="AlternatePartyId">
<xsd:sequence>
<xsd:element name="Id" type="Id"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): Amount

Super-types:xsd:decimal < Amount (by extension)
Sub-types:None

NameAmount
Abstractno
DocumentationBased on OAGI Amount. Simple content with the currency as an attrbute
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
currency Required 

XML Instance Representation
<...
currency="Currency [1]"
>
xsd:decimal
</...>
Schema Component Representation
<xsd:complexType name="Amount">
<xsd:simpleContent>
<xsd:extension base="xsd:decimal">
<xsd:attribute name="currency" type="Currency" use="required"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): AnnualPercentageRate

Super-types:xsd:decimal < Percent (by extension) < AnnualPercentageRate (by extension)
Sub-types:None

NameAnnualPercentageRate
Abstractno
DocumentationAnnual percentage rate.
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="AnnualPercentageRate">
<xsd:simpleContent>
<xsd:extension base="Percent"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ApplicationArea

Super-types:None
Sub-types:None

NameApplicationArea
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
SenderIdentifies characteristics and control identifiers that relate to the application that created the Business Object Document. The sender area can indicate the logical location of the application and/or database server, the application, and the task that was processing to create the BOD. Required 
CreationDateTimeis 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. Required
DateTime fields must be formatted as XML Schema Datetimes in UTC/GMT format without offsets. Example: 2003-11-05T13:15:30Z
 
SignatureIf 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. This element supports any digital signature specification that is available today and in the future. This is accomplished by not actually defining the content but by allowing the implementation to specify the digital signature to be used via an external XML Schema namespace declaration. The Signature element is defined to have any content from any other namespace. This allows the user to carry a digital signature in the xml instance of a BOD. The choice of which digital signature to use is left up to the user and their integration needs. Optional 
BODIdThe 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 the following services or capabilities: 1. Legally binding transactions, 2. Transaction logging, 3. Exception handling, 4. Re-sending, 5. Reporting, 6. Confirmations, 7. Security. Optional 
DestinationInformation related to the receiver of the BOD Required
See Destination Component.
 

XML Instance Representation
<...>
<Sender> Sender </Sender> [1] ?
<CreationDateTime> DateTime </CreationDateTime> [1] ?
<Signature> Signature </Signature> [0..1] ?
<BODId> Code </BODId> [0..1] ?
<Destination> Destination </Destination> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="ApplicationArea">
<xsd:sequence>
<xsd:element name="Sender" type="Sender"/>
<xsd:element name="CreationDateTime" type="DateTime"/>
<xsd:element name="Signature" type="Signature" minOccurs="0"/>
<xsd:element name="BODId" type="Code" minOccurs="0"/>
<xsd:element name="Destination" type="Destination"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): ApprovedAmount

Super-types:xsd:decimal < Amount (by extension) < ApprovedAmount (by extension)
Sub-types:None

NameApprovedAmount
Abstractno
DocumentationAmount pre-approved
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="ApprovedAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): BalanceAmount

Super-types:xsd:decimal < Amount (by extension) < BalanceAmount (by extension)
Sub-types:None

NameBalanceAmount
Abstractno
DocumentationRemaining balance on Current Vehicle
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="BalanceAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): BalloonResidualAmount

Super-types:xsd:decimal < Amount (by extension) < BalloonResidualAmount (by extension)
Sub-types:None

NameBalloonResidualAmount
Abstractno
DocumentationThe estimated amount of the vehicle at contract end.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="BalloonResidualAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): BalloonResidualPercentage

Super-types:xsd:decimal < Percent (by extension) < BalloonResidualPercentage (by extension)
Sub-types:None

NameBalloonResidualPercentage
Abstractno
DocumentationThe estimated percent of value at contract end
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="BalloonResidualPercentage">
<xsd:simpleContent>
<xsd:extension base="Percent"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): BaseInterestRate

Super-types:xsd:decimal < Percent (by extension) < BaseInterestRate (by extension)
Sub-types:None

NameBaseInterestRate
Abstractno
DocumentationThe base interest rate before any pre-paid interest or additional costs of financing.
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="BaseInterestRate">
<xsd:simpleContent>
<xsd:extension base="Percent"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): BrandedInfo

Super-types:None
Sub-types:None

NameBrandedInfo
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
BrandedTitleIndThis tag indicates if a vehicle's title has been branded. (i.e., vehicle totaled and state registration title branded as such) Optional
Values: 1 - Yes. 0 - No.
 
BrandedTitleDateBranding Date Optional
In YYYY-MM-DD format.
 
BrandingStateCodeBranding State Code Optional 
BrandingStateReferenceBranding State Reference Number Optional 
BrandingSourceBranding source √ƒ¬Ę¬€¬“ (i.e., source who says that the vehicle is branded) Optional 

XML Instance Representation
<...>
<BrandedTitleInd> BrandedTitleInd </BrandedTitleInd> [0..1] ?
<BrandedTitleDate> BrandedTitleDate </BrandedTitleDate> [0..1] ?
<BrandingStateCode> BrandingStateCode </BrandingStateCode> [0..1] ?
<BrandingStateReference> BrandingStateReference </BrandingStateReference> [0..1] ?
<BrandingSource> BrandingSource </BrandingSource> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="BrandedInfo">
<xsd:sequence>
<xsd:element name="BrandedTitleInd" type="BrandedTitleInd" minOccurs="0"/>
<xsd:element name="BrandedTitleDate" type="BrandedTitleDate" minOccurs="0"/>
<xsd:element name="BrandingStateCode" type="BrandingStateCode" minOccurs="0"/>
<xsd:element name="BrandingStateReference" type="BrandingStateReference" minOccurs="0"/>
<xsd:element name="BrandingSource" type="BrandingSource" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): BrandingStateCode

Super-types:xsd:string < StateOrProvince (by restriction) < BrandingStateCode (by extension)
Sub-types:None

NameBrandingStateCode
Abstractno
DocumentationBranding State Code
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="BrandingStateCode">
<xsd:simpleContent>
<xsd:extension base="StateOrProvince"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): BusinessObjectDocument

Super-types:None
Sub-types:

NameBusinessObjectDocument
Abstractno

Attributes

AttributeDescriptionRequirementBusiness Rules
revisionThis should contain the STAR repository version in the following recommended format. 4.2.1_M20080416. Where the first part indicates the version of the STAR repository and anything after the _ indicates the Milestone build that is being used. If referring to an official published version then only the STAR Repository version is required. Optional 
releaseIndicates the OAGIS release that this BOD belongs. Optional 
environmentIndicates 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). Optional 
langIndicates the language that the contents of the BOD is in unless otherwise stated. Optional 
bodVersionDeprecated as of STAR 4.2.2. It is recommended to use the revision attribute to identify the repository and the noun. May be removed in a new major version of the STAR repository. Optional 

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ApplicationAreaProvides 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. Required 

XML Instance Representation
<...
revision="Text [0..1] ?"

release="8.1-Lite [0..1] ?"

environment="Text [0..1] ?"

lang="Language [0..1] ?"

bodVersion="Text [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="BusinessObjectDocument">
<xsd:sequence>
<xsd:element ref="ApplicationArea"/>
</xsd:sequence>
<xsd:attribute name="revision" use="optional">
<xsd:simpleType>
<xsd:restriction base="Text"/>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="release" type="Text" use="optional" fixed="8.1-Lite"/>
<xsd:attribute name="environment" use="optional" default="Production">
<xsd:simpleType>
<xsd:restriction base="Text">
<xsd:enumeration value="Test"/>
<xsd:enumeration value="Production"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="lang" type="Language" use="optional"/>
<xsd:attribute name="bodVersion" use="optional">
<xsd:simpleType>
<xsd:restriction base="Text"/>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
top

Components (Complex Type): BuyerDemographics

Super-types:None
Sub-types:None

NameBuyerDemographics
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
GenderGender of party Optional
Values: M - Male. F - Female
 
LanguageBusiness party native language Optional 
BirthDateBirth date of party Optional
In YYYY-MM-DD format.
 
FirstTimeBuyerIndIdentifies customer as first time buyer Optional
Values: 1 - First Time Buyer. 0 - Not a First Time Buyer.
 
PreferredLanguageCustomer's preferred language Optional 

XML Instance Representation
<...>
<Gender> Gender </Gender> [0..1] ?
<Language> Language </Language> [0..1] ?
<BirthDate> BirthDate </BirthDate> [0..1] ?
<FirstTimeBuyerInd> FirstTimeBuyerInd </FirstTimeBuyerInd> [0..1] ?
<PreferredLanguage> PreferredLanguage </PreferredLanguage> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="BuyerDemographics">
<xsd:sequence>
<xsd:element name="Gender" type="Gender" minOccurs="0"/>
<xsd:element name="Language" type="Language" minOccurs="0"/>
<xsd:element name="BirthDate" type="BirthDate" minOccurs="0"/>
<xsd:element name="FirstTimeBuyerInd" type="FirstTimeBuyerInd" minOccurs="0"/>
<xsd:element name="PreferredLanguage" type="PreferredLanguage" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): Cancel

Super-types:Verb < ConfirmableVerb (by extension) < Cancel (by extension)
Sub-types:None

NameCancel
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
Verb Required 

XML Instance Representation
<...
confirm="ConfirmType [0..1]"
/>
Schema Component Representation
<xsd:complexType name="Cancel">
<xsd:complexContent>
<xsd:extension base="ConfirmableVerb"/>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): CancelRetailDeliveryReporting

Super-types:BusinessObjectDocument < CancelRetailDeliveryReporting (by extension)
Sub-types:None

NameCancelRetailDeliveryReporting
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ApplicationAreaProvides 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. Required 
DataArea Required 

XML Instance Representation
<...
revision="Text [0..1] ?"

release="8.1-Lite [0..1] ?"

environment="Text [0..1] ?"

lang="Language [0..1] ?"

bodVersion="Text [0..1] ?"
>
<DataArea> CancelRetailDeliveryReportingDataArea </DataArea> [1]
</...>
Schema Component Representation
<xsd:complexType name="CancelRetailDeliveryReporting">
<xsd:complexContent>
<xsd:extension base="BusinessObjectDocument">
<xsd:sequence>
<xsd:element name="DataArea" type="CancelRetailDeliveryReportingDataArea"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): CancelRetailDeliveryReportingDataArea

Super-types:None
Sub-types:None

NameCancelRetailDeliveryReportingDataArea
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
CancelThe 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. Required 
RetailDeliveryReporting Required 

XML Instance Representation
<...>
<Cancel> ... </Cancel> [1]
</...>
Schema Component Representation
<xsd:complexType name="CancelRetailDeliveryReportingDataArea">
<xsd:sequence>
<xsd:element ref="Cancel"/>
<xsd:element ref="RetailDeliveryReporting" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): CodeType

Super-types:xsd:string < CodeType (by extension)
Sub-types:None

NameCodeType
Abstractno
DocumentationUnique code name
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
listID Optional 
listName Optional 
listAgencyID Optional 
listAgencyName Optional 
listVersionID Optional 
listURI Optional 

XML Instance Representation
<...
listID="xsd:token [0..1]"

listName="xsd:string [0..1]"

listAgencyID="xsd:token [0..1]"

listAgencyName="xsd:string [0..1]"

listVersionID="xsd:token [0..1]"

listURI="xsd:anyURI [0..1]"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="CodeType">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="listID" type="xsd:token" use="optional"/>
<xsd:attribute name="listName" type="xsd:string" use="optional"/>
<xsd:attribute name="listAgencyID" type="xsd:token" use="optional"/>
<xsd:attribute name="listAgencyName" type="xsd:string" use="optional"/>
<xsd:attribute name="listVersionID" type="xsd:token" use="optional"/>
<xsd:attribute name="listURI" type="xsd:anyURI" use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ConfirmableVerb

Super-types:Verb < ConfirmableVerb (by extension)
Sub-types:

NameConfirmableVerb
Abstractno

Attributes

AttributeDescriptionRequirementBusiness Rules
confirm Required 

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
Verb Required 

XML Instance Representation
<...
confirm="ConfirmType [0..1]"
/>
Schema Component Representation
<xsd:complexType name="ConfirmableVerb">
<xsd:complexContent>
<xsd:extension base="Verb">
<xsd:attribute name="confirm" type="ConfirmType"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): ContactBase

Super-types:None
Sub-types:

NameContactBase
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
TelephoneContact telephone numbers Optional 
EMailAddressContact Email addresses Optional 
FaxContact Fax numbers Optional 
PreferredContactMethodPreferred contact method Optional 
ContactTimePreferred contact time (i.e. Best day/time to reach the contact. Optional 
PrimaryContactIndIndicates if contact is primary contact Optional
Values: 0 - Not Primary Contact. 1 - Primary Contact.
 

XML Instance Representation
<...>
<Telephone> IndividualPartyContactTelephoneNumber </Telephone> [0..*] ?
<EMailAddress> IndividualPartyContactEMail </EMailAddress> [0..*] ?
<Fax> IndividualPartyContactFax </Fax> [0..*] ?
<PreferredContactMethod> PreferredContactMethod </PreferredContactMethod> [0..1] ?
<ContactTime> ContactTime </ContactTime> [0..1] ?
<PrimaryContactInd> PrimaryContactInd </PrimaryContactInd> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="ContactBase">
<xsd:sequence>
<xsd:element name="Telephone" type="IndividualPartyContactTelephoneNumber" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="EMailAddress" type="IndividualPartyContactEMail" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Fax" type="IndividualPartyContactFax" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="PreferredContactMethod" type="PreferredContactMethod" minOccurs="0"/>
<xsd:element name="ContactTime" type="ContactTime" minOccurs="0"/>
<xsd:element name="PrimaryContactInd" type="PrimaryContactInd" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): ContractDeductible

Super-types:xsd:decimal < Amount (by extension) < ContractDeductible (by extension)
Sub-types:None

NameContractDeductible
Abstractno
DocumentationAmount of Contract Deductible
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="ContractDeductible">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ContractExpirationDistance

Super-types:xsd:integer < Count (by extension) < Mileage (by extension) < ContractExpirationDistance (by extension)
Sub-types:None

NameContractExpirationDistance
Abstractno
DocumentationThe odometer reading (distance) of the vehicle when the service contract expires.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
uom="MileageMeasure [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="ContractExpirationDistance">
<xsd:simpleContent>
<xsd:extension base="Mileage"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ContractId

Super-types:xsd:string < Id (by extension) < ContractId (by extension)
Sub-types:None

NameContractId
Abstractno
DocumentationIdentification of Contract
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="ContractId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ContractInstallments

Super-types:xsd:integer < Count (by extension) < ContractInstallments (by restriction)
Sub-types:None

NameContractInstallments
Abstractno
DocumentationNumber of months of payments (Ex: 1,5,11,17).
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="ContractInstallments">
<xsd:simpleContent>
<xsd:restriction base="Count"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ContractOptionDescription

Super-types:xsd:string < Description (by extension) < ContractOptionDescription (by extension)
Sub-types:None

NameContractOptionDescription
Abstractno
DocumentationDescription of the plan option.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="ContractOptionDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ContractPlanDescription

Super-types:xsd:string < Description (by extension) < ContractPlanDescription (by extension)
Sub-types:None

NameContractPlanDescription
Abstractno
DocumentationDescription of contract plan. Example: 36 MONTH/36000 MILE"
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="ContractPlanDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ContractPlanOption

Super-types:None
Sub-types:None

NameContractPlanOption
Abstractno
DocumentationThe Contract Plan Options.
More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ContractOptionStartDateThe date the contract option takes effect. Optional
In YYYY-MM-DD format.
 
ContractOptionEndDateThe date the contract option expires. Optional
In YYYY-MM-DD foramt.
 
ContractOptionCodeUnique Identifier for a Plan Option. Optional 
ContractOptionDescriptionDescription of the plan option Optional 
PlanOptionPriceThe suggested sale price of the plan option Optional 

XML Instance Representation
<...>
<ContractOptionStartDate> ContractOptionStartDate </ContractOptionStartDate> [0..1] ?
<ContractOptionEndDate> ContractOptionEndDate </ContractOptionEndDate> [0..1] ?
<ContractOptionCode> ContractOptionCode </ContractOptionCode> [0..1] ?
<ContractOptionDescription> ContractOptionDescription </ContractOptionDescription> [0..1] ?
<PlanOptionPrice> PlanOptionPrice </PlanOptionPrice> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="ContractPlanOption">
<xsd:sequence>
<xsd:element name="ContractOptionStartDate" type="ContractOptionStartDate" minOccurs="0"/>
<xsd:element name="ContractOptionEndDate" type="ContractOptionEndDate" minOccurs="0"/>
<xsd:element name="ContractOptionCode" type="ContractOptionCode" minOccurs="0"/>
<xsd:element name="ContractOptionDescription" type="ContractOptionDescription" minOccurs="0"/>
<xsd:element name="PlanOptionPrice" type="PlanOptionPrice" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): ContractStartMileage

Super-types:xsd:integer < Count (by extension) < Mileage (by extension) < ContractStartMileage (by extension)
Sub-types:None

NameContractStartMileage
Abstractno
DocumentationOdometer reading when contract becomes effective
More information at: http://www.starstandard.org.

XML Instance Representation
<...
uom="MileageMeasure [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="ContractStartMileage">
<xsd:simpleContent>
<xsd:extension base="Mileage"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ContractTermMileage

Super-types:xsd:integer < Count (by extension) < Mileage (by extension) < ContractTermMileage (by extension)
Sub-types:None

NameContractTermMileage
Abstractno
DocumentationMileage allowed under terms of contract
More information at: http://www.starstandard.org.

XML Instance Representation
<...
uom="MileageMeasure [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="ContractTermMileage">
<xsd:simpleContent>
<xsd:extension base="Mileage"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Count

Super-types:xsd:integer < Count (by extension)
Sub-types:None

NameCount
Abstractno
DocumentationSimple quantity type with no attributes
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
xsd:integer
</...>
Schema Component Representation
<xsd:complexType name="Count">
<xsd:simpleContent>
<xsd:extension base="xsd:integer"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Coupon

Super-types:None
Sub-types:

NameCoupon
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
CouponIdIdentification of Coupon dealership service application Optional 
CouponDescriptionText identification of Coupon Optional 
CouponDiscountAmountCredit Price for coupons Optional 
CouponCommentComments associated with the coupon (e.g., Please rotate tire to front left). Optional 

XML Instance Representation
<...>
<CouponId> CouponId </CouponId> [0..1] ?
<CouponDescription> CouponDescription </CouponDescription> [0..1] ?
<CouponDiscountAmount> CouponDiscountAmount </CouponDiscountAmount> [0..1] ?
<CouponComment> CouponComment </CouponComment> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="Coupon">
<xsd:sequence>
<xsd:element name="CouponId" type="CouponId" minOccurs="0"/>
<xsd:element name="CouponDescription" type="CouponDescription" minOccurs="0"/>
<xsd:element name="CouponDiscountAmount" type="CouponDiscountAmount" minOccurs="0"/>
<xsd:element name="CouponComment" type="CouponComment" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): CouponDescription

Super-types:xsd:string < Description (by extension) < CouponDescription (by extension)
Sub-types:None

NameCouponDescription
Abstractno
DocumentationText identification of Coupon
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="CouponDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): CouponDiscountAmount

Super-types:xsd:decimal < Amount (by extension) < CouponDiscountAmount (by extension)
Sub-types:None

NameCouponDiscountAmount
Abstractno
DocumentationCredit Price for coupons
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="CouponDiscountAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): CouponId

Super-types:xsd:string < Id (by extension) < CouponId (by extension)
Sub-types:None

NameCouponId
Abstractno
DocumentationIdentification of Coupon dealership service application
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="CouponId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): CreditContractCoupon

Super-types:Coupon < CreditContractCoupon (by extension)
Sub-types:None

NameCreditContractCoupon
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
CouponIdIdentification of Coupon dealership service application Optional 
CouponDescriptionText identification of Coupon Optional 
CouponDiscountAmountCredit Price for coupons Optional 
CouponCommentComments associated with the coupon (e.g., Please rotate tire to front left). Optional 
DiscountPercentagePercentage of discount. Optional 

XML Instance Representation
<...>
<CouponId> CouponId </CouponId> [0..1] ?
<CouponDescription> CouponDescription </CouponDescription> [0..1] ?
<CouponDiscountAmount> CouponDiscountAmount </CouponDiscountAmount> [0..1] ?
<CouponComment> CouponComment </CouponComment> [0..1] ?
<DiscountPercentage> DiscountPercentage </DiscountPercentage> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="CreditContractCoupon">
<xsd:complexContent>
<xsd:extension base="Coupon">
<xsd:sequence>
<xsd:element name="DiscountPercentage" type="DiscountPercentage" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): DealerExtendedAddress

Super-types:PartyBase < DealerPartyBase (by extension) < DealerExtendedAddress (by extension)
Sub-types:

NameDealerExtendedAddress
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
DealerNameDealer name Optional 
DistrictCodeManufacturer Assigned District Code Optional 
URIDealer URI Optional 
ZoneCodeManufacturer Assigned Zone Code Optional 
AddressDealer party address Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<DealerName> DealerName </DealerName> [0..1] ?
<DistrictCode> DistrictCode </DistrictCode> [0..1] ?
<URI> URI </URI> [0..1] ?
<ZoneCode> ZoneCode </ZoneCode> [0..1] ?
<Address> OrganizationAddress </Address> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="DealerExtendedAddress">
<xsd:complexContent>
<xsd:extension base="DealerPartyBase">
<xsd:sequence>
<xsd:element name="Address" type="OrganizationAddress" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): DealerPartyBase

Super-types:PartyBase < DealerPartyBase (by extension)
Sub-types:

NameDealerPartyBase
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
DealerNameDealer name Optional 
DistrictCodeManufacturer Assigned District Code Optional 
URIDealer URI Optional 
ZoneCodeManufacturer Assigned Zone Code Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<DealerName> DealerName </DealerName> [0..1] ?
<DistrictCode> DistrictCode </DistrictCode> [0..1] ?
<URI> URI </URI> [0..1] ?
<ZoneCode> ZoneCode </ZoneCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="DealerPartyBase">
<xsd:complexContent>
<xsd:extension base="PartyBase">
<xsd:sequence>
<xsd:element name="DealerName" type="DealerName" minOccurs="0"/>
<xsd:element name="DistrictCode" type="DistrictCode" minOccurs="0"/>
<xsd:element name="URI" type="URI" minOccurs="0"/>
<xsd:element name="ZoneCode" type="ZoneCode" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): DeliveryMileage

Super-types:xsd:integer < Count (by extension) < Mileage (by extension) < DeliveryMileage (by extension)
Sub-types:None

NameDeliveryMileage
Abstractno
DocumentationOdometer reading of vehicle at time of delivery
More information at: http://www.starstandard.org.

XML Instance Representation
<...
uom="MileageMeasure [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="DeliveryMileage">
<xsd:simpleContent>
<xsd:extension base="Mileage"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): DemoCount

Super-types:xsd:integer < Count (by extension) < DemoCount (by restriction)
Sub-types:None

NameDemoCount
Abstractno
DocumentationNumber of times vehicle was driven as a demo.
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="DemoCount">
<xsd:simpleContent>
<xsd:restriction base="Count"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Description

Super-types:xsd:string < Description (by extension)
Sub-types:None

NameDescription
Abstractno
DocumentationDescription
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
languageThe ISO language code that the description is written. Optional 

XML Instance Representation
<...
language="Language [0..1] ?"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="Description">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="language" type="Language" use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Destination

Super-types:None
Sub-types:None

NameDestination
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
DestinationNameCodeCode for destination of file (i.e.Short Manufacturer or DSP code) Optional
Must use a valid code from the ShortMfg/RSP list on http://www.starstandards.org
 
DestinationURIPhysical address of the destination Optional 
DestinationSoftwareCodeAdditional information about the destination application Optional 
DestinationSoftwareFor which software destination file is intended (may not be known). Optional 
DealerNumberTarget Dealer Code receiving information Optional 
StoreNumberDealer code store number (DMS assigned) Optional 
AreaNumberDealer code area number (DMS vendor assigned) Optional 
DealerCountryTarget Dealer country location Optional 
PartyIdThe Party Id field uniquely identifies the Receiver of the message. This element can be used for parties within the Automotive Community as well as external parties. Party Id is not intended as a replacement for the Dealer Number. Suggested formats for OEMs or other large institutions include: DUNs Number, ShortMfgCode + DUNs, or ShortMfgCode. The suggested format for Dealers is: ShortMfgCode+Dealer Number. Optional 
LocationIdThe Location Id field uniquely identifies the location of the Receiver of a message. This Id may be aligned with a physical address or data centers. This field provides an additional level of granularity beyond the usage of the Party Id for additional routing and deliver of data. Optional 
ServiceIdThe Service Id field identifies the particular service to which a message is being sent, e.g., an inventory service. Optional 

XML Instance Representation
<...>
<DestinationNameCode> ShortMfg </DestinationNameCode> [0..1] ?
<DestinationURI> URI </DestinationURI> [0..1] ?
<DestinationSoftwareCode> Text </DestinationSoftwareCode> [0..1] ?
<DestinationSoftware> Text </DestinationSoftware> [0..1] ?
<DealerNumber> PartyId </DealerNumber> [0..1] ?
<StoreNumber> Text </StoreNumber> [0..1] ?
<AreaNumber> Text </AreaNumber> [0..1] ?
<DealerCountry> Country </DealerCountry> [0..1] ?
<PartyId> PartyId </PartyId> [0..1] ?
<LocationId> LocationId </LocationId> [0..1] ?
<ServiceId> ServiceId </ServiceId> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="Destination">
<xsd:sequence>
<xsd:element name="DestinationNameCode" type="ShortMfg" minOccurs="0"/>
<xsd:element name="DestinationURI" type="URI" minOccurs="0"/>
<xsd:element name="DestinationSoftwareCode" type="Text" minOccurs="0"/>
<xsd:element name="DestinationSoftware" type="Text" minOccurs="0"/>
<xsd:element name="DealerNumber" type="PartyId" minOccurs="0"/>
<xsd:element name="StoreNumber" type="Text" minOccurs="0"/>
<xsd:element name="AreaNumber" type="Text" minOccurs="0"/>
<xsd:element name="DealerCountry" type="Country" minOccurs="0"/>
<xsd:element name="PartyId" type="PartyId" minOccurs="0"/>
<xsd:element name="LocationId" type="LocationId" minOccurs="0"/>
<xsd:element name="ServiceId" type="ServiceId" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): DiscountPercentage

Super-types:xsd:decimal < Percent (by extension) < DiscountPercentage (by extension)
Sub-types:None

NameDiscountPercentage
Abstractno
DocumentationPercentage of discount.
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="DiscountPercentage">
<xsd:simpleContent>
<xsd:extension base="Percent"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): DMSCustomerId

Super-types:xsd:string < Id (by extension) < DMSCustomerId (by extension)
Sub-types:None

NameDMSCustomerId
Abstractno
DocumentationThe DMS system assigned number associated with a customer entity
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="DMSCustomerId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): DocumentId

Super-types:xsd:string < Id (by extension) < DocumentId (by extension)
Sub-types:None

NameDocumentId
Abstractno
DocumentationIs the identifier for the document.
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="DocumentId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): DoorsQuantity

Super-types:xsd:integer < Count (by extension) < DoorsQuantity (by restriction)
Sub-types:None

NameDoorsQuantity
Abstractno
DocumentationNumber of doors on vehicle
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="DoorsQuantity">
<xsd:simpleContent>
<xsd:restriction base="Count"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): DownPaymentAmount

Super-types:xsd:decimal < Amount (by extension) < DownPaymentAmount (by extension)
Sub-types:None

NameDownPaymentAmount
Abstractno
DocumentationDown Payment amount or amount of cap cost reduction.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="DownPaymentAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): EngineDescription

Super-types:xsd:string < Description (by extension) < EngineDescription (by extension)
Sub-types:None

NameEngineDescription
Abstractno
DocumentationText description of engine (e.g. dohc, 32 valves)
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="EngineDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ExpandedOption

Super-types:OptionBase < Option (by extension) < ExpandedOption (by extension)
Sub-types:None

NameExpandedOption
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
OptionTypeAn option type for a vehicle or other component. Usually references an OEM supplied list of codes. Optional 
OptionNameName of vehicle option Optional 
OptionStockNumberStock Number of Vehicle Option Optional 
ManufacturerManufacturer of Vehicle Option Optional 
OptionPricePrice of Vehicle Option Optional 
OptionSecurityCodeSecurity code to unlock option. (i.e, radio code)n Optional 
ManufacturerInstalledIndIndicates manufacturer-installed accessories Optional 
OptionCostActual Dealer cost of option Optional 
OptionMSRPOption MSRP Optional 
OptionOriginIdentifies the option installer Optional 
OptionSerialNumberSerial number of Option Optional 
ItemIdPart number identifier of Option Optional 
PartTypeSpecifies whether the parts are indicated by manufacturer part code or Part Number Optional 
OptionNotesFree form text related to option Optional 
DealerInstallationIndDealer installed accessories, before delivery of vehicle - Could be used for new or used vehicle, if applicable Optional 
MiscellaneousCodeMiscellaneous codes relating to vehicle (i.e., sales codes) Optional
May occur multiple times.
 
OptionPackageIdOption package number or identifier used as a method for grouping option package items from manufacturer(s) Ex: OptPkg1,cost,OptPkg1; Item1,nocost,OptPkg1; Item2,nocost,Optpkg1; Item3,cost,nullOptPkg; OptPkg2,cost,Optpkg2; Item5,nocost,OptPkg2√ƒ¬Ę¬€√‚¬¶ Optional 
OptionSalesCodeFurther definition of accessories and option packages - Indicates whether ordered option, special package, standard, etc. Optional 
PortInstalledIndIndicates Port-installed accessories Optional 

XML Instance Representation
<...>
<OptionType> OptionType </OptionType> [0..1] ?
<OptionName> OptionName </OptionName> [0..1] ?
<OptionStockNumber> OptionStockNumber </OptionStockNumber> [0..1] ?
<Manufacturer> Manufacturer </Manufacturer> [0..1] ?
<OptionPrice> OptionPrice </OptionPrice> [0..1] ?
<OptionSecurityCode> OptionSecurityCode </OptionSecurityCode> [0..1] ?
<ManufacturerInstalledInd> ManufacturerInstalledInd </ManufacturerInstalledInd> [0..1] ?
<OptionCost> OptionCost </OptionCost> [0..1] ?
<OptionMSRP> OptionMSRP </OptionMSRP> [0..1] ?
<OptionOrigin> OptionOrigin </OptionOrigin> [0..1] ?
<OptionSerialNumber> OptionSerialNumber </OptionSerialNumber> [0..1] ?
<ItemId> ItemId </ItemId> [0..1] ?
<PartType> PartType </PartType> [0..1] ?
<OptionNotes> OptionNotes </OptionNotes> [0..1] ?
<DealerInstallationInd> DealerInstallationInd </DealerInstallationInd> [0..1] ?
<MiscellaneousCode> MiscellaneousCode </MiscellaneousCode> [0..*] ?
<OptionPackageId> OptionPackageId </OptionPackageId> [0..1] ?
<OptionSalesCode> OptionSalesCode </OptionSalesCode> [0..1] ?
<PortInstalledInd> PortInstalledInd </PortInstalledInd> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="ExpandedOption">
<xsd:complexContent>
<xsd:extension base="Option">
<xsd:sequence>
<xsd:element name="OptionSecurityCode" type="OptionSecurityCode" minOccurs="0"/>
<xsd:element name="ManufacturerInstalledInd" type="ManufacturerInstalledInd" minOccurs="0"/>
<xsd:element name="OptionCost" type="OptionCost" minOccurs="0"/>
<xsd:element name="OptionMSRP" type="OptionMSRP" minOccurs="0"/>
<xsd:element name="OptionOrigin" type="OptionOrigin" minOccurs="0"/>
<xsd:element name="OptionSerialNumber" type="OptionSerialNumber" minOccurs="0"/>
<xsd:element name="ItemId" type="ItemId" minOccurs="0"/>
<xsd:element name="PartType" type="PartType" minOccurs="0"/>
<xsd:element name="OptionNotes" type="OptionNotes" minOccurs="0"/>
<xsd:element name="DealerInstallationInd" type="DealerInstallationInd" minOccurs="0"/>
<xsd:element name="MiscellaneousCode" type="MiscellaneousCode" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="OptionPackageId" type="OptionPackageId" minOccurs="0"/>
<xsd:element name="OptionSalesCode" type="OptionSalesCode" minOccurs="0"/>
<xsd:element name="PortInstalledInd" type="PortInstalledInd" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): ExpandedVehicle

Super-types:Vehicle < VehicleBase (by extension) < ExpandedVehicle (by extension)
Sub-types:

NameExpandedVehicle
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ModelManufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) Optional 
ModelYearVehicle designated model year Optional 
ModelDescriptionDescriptive vehicle model name Optional 
MakeVehicle make code - Usually available in the VIN number (use NCIC code). Optional 
SaleClassClass of Sale Optional 
ConditionCondition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown Optional 
CertifiedPreownedIndIdentifies as a certified Pre-Owned Vehicle Optional 
VehicleNoteAny vehicle related notes Optional 
VINFederally defined 17 position vehicle identification number Optional 
DeliveryMileageOdometer reading of vehicle at time of delivery Optional
Values on uom attribute: K - Kilometers, M - Miles
 
VehicleStockDealer assigned vehicle stock number Optional 
TrimCodeManufacturer assigned trim code Optional 
DoorsQuantityNumber of doors on vehicle Optional 
BodyStyleManufacturer-assigned vehicle body style Optional 
InteriorColorVehicle Interior Color(s) Optional
May occur multiple times.
 
ExteriorColorVehicle Exterior Color(s) Optional
May occur multiple times.
 
TransmissionTypeVehicle Transmission type Optional
Values: 3 - 3 speed, 4 - 4 speed, 5 - 5 speed, 6 - 6 speed, A - Automatic
 
OdometerStatusStatus of odometer at trade-in. Example:: Replaced, Tampered, Miles> 90,000, etc. Optional 
NonUSVehicleIndIndicates whether the vehicle was produced for the United States or not Optional
Values: 0 - Created fo US Sale. 1 - Created for sale outside of the US.
 
VehicleDemoIndIndicates whether vehicle was ever a demo Optional
Values: 0 - Was or is not a demo. 1 - Was or is a demo.
 
LicenseNumberState License plate number of vehicle Optional 
BrandedInfoVehicle Branding Information Optional 
RestrictionIndIndication that vehicle has restrictions on its use Optional
Values: 1 - Yes, 0 - No.
 
RestrictionDescriptionDescription of vehicle use restrictions Optional 
TelematicsServiceIndIndication whether Telematics Service Subscription is turned on Optional 
OptionVehicle Options Optional 
TransmissionCodeTransmission Serial Number Optional 
DeliveryDateThe date of original retail vehicle sale Optional
In YYYY-MM-DD format.
 
EngineNumberSerial number of the engine if vehicle not made for US sale Optional 
IgnitionKeyNumberVehicle Ignition Key Number Optional 
AxleCodeThe code on the axle of the vehicle. Optional 
FleetAccountManufacturer defined fleet account number Optional 
FleetVehicleIdUniquely identifies the vehicle as part of a fleet company Optional 
FleetPurchaseOrderNumberFleet Purchase Order Number vehicle was purchased under Optional 
DoorKeyNumberDoor key number Optional 
VehicleWeightVehicle weight Optional 
ExteriorColorCodeVehicle exterior color code Optional 
InteriorColorCodeVehicle Interior color code Optional 

XML Instance Representation
<...>
<Model> Model </Model> [0..1] ?
<ModelYear> ModelYear </ModelYear> [0..1] ?
<ModelDescription> ModelDescription </ModelDescription> [0..1] ?
<Make> Make </Make> [0..1] ?
<SaleClass> SaleClass </SaleClass> [0..1] ?
<Condition> Condition </Condition> [0..1] ?
<CertifiedPreownedInd> CertifiedPreownedInd </CertifiedPreownedInd> [0..1] ?
<VehicleNote> VehicleNote </VehicleNote> [0..*] ?
<VIN> VIN </VIN> [0..1] ?
<DeliveryMileage> DeliveryMileage </DeliveryMileage> [0..1] ?
<VehicleStock> VehicleStock </VehicleStock> [0..1] ?
<TrimCode> TrimCode </TrimCode> [0..1] ?
<DoorsQuantity> DoorsQuantity </DoorsQuantity> [0..1] ?
<BodyStyle> BodyStyle </BodyStyle> [0..1] ?
<InteriorColor> InteriorColor </InteriorColor> [0..*] ?
<ExteriorColor> ExteriorColor </ExteriorColor> [0..*] ?
<TransmissionType> TransmissionType </TransmissionType> [0..1] ?
<OdometerStatus> OdometerStatus </OdometerStatus> [0..1] ?
<NonUSVehicleInd> NonUSVehicleInd </NonUSVehicleInd> [0..1] ?
<VehicleDemoInd> VehicleDemoInd </VehicleDemoInd> [0..1] ?
<LicenseNumber> LicenseNumber </LicenseNumber> [0..1] ?
<BrandedInfo> BrandedInfo </BrandedInfo> [0..1] ?
<RestrictionInd> RestrictionInd </RestrictionInd> [0..1] ?
<RestrictionDescription> RestrictionDescription </RestrictionDescription> [0..1] ?
<TelematicsServiceInd> TelematicsServiceInd </TelematicsServiceInd> [0..1] ?
<Option> ExpandedOption </Option> [0..*] ?
<TransmissionCode> TransmissionCode </TransmissionCode> [0..1] ?
<DeliveryDate> DeliveryDate </DeliveryDate> [0..1] ?
<EngineNumber> EngineNumber </EngineNumber> [0..1] ?
<IgnitionKeyNumber> IgnitionKeyNumber </IgnitionKeyNumber> [0..1] ?
<AxleCode> AxleCode </AxleCode> [0..1] ?
<FleetAccount> FleetAccount </FleetAccount> [0..1] ?
<FleetVehicleId> FleetVehicleId </FleetVehicleId> [0..1] ?
<FleetPurchaseOrderNumber> FleetPurchaseOrderNumber </FleetPurchaseOrderNumber> [0..1] ?
<DoorKeyNumber> DoorKeyNumber </DoorKeyNumber> [0..1] ?
<VehicleWeight> VehicleWeight </VehicleWeight> [0..1] ?
<ExteriorColorCode> ExteriorColorCode </ExteriorColorCode> [0..*] ?
<InteriorColorCode> InteriorColorCode </InteriorColorCode> [0..*] ?
</...>
Schema Component Representation
<xsd:complexType name="ExpandedVehicle">
<xsd:complexContent>
<xsd:extension base="VehicleBase">
<xsd:sequence>
<xsd:element name="Option" type="ExpandedOption" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="TransmissionCode" type="TransmissionCode" minOccurs="0"/>
<xsd:element name="DeliveryDate" type="DeliveryDate" minOccurs="0"/>
<xsd:element name="EngineNumber" type="EngineNumber" minOccurs="0"/>
<xsd:element name="IgnitionKeyNumber" type="IgnitionKeyNumber" minOccurs="0"/>
<xsd:element name="AxleCode" type="AxleCode" minOccurs="0"/>
<xsd:element name="FleetAccount" type="FleetAccount" minOccurs="0"/>
<xsd:element name="FleetVehicleId" type="FleetVehicleId" minOccurs="0"/>
<xsd:element name="FleetPurchaseOrderNumber" type="FleetPurchaseOrderNumber" minOccurs="0"/>
<xsd:element name="DoorKeyNumber" type="DoorKeyNumber" minOccurs="0"/>
<xsd:element name="VehicleWeight" type="VehicleWeight" minOccurs="0"/>
<xsd:element name="ExteriorColorCode" type="ExteriorColorCode" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="InteriorColorCode" type="InteriorColorCode" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): FinalAmount

Super-types:xsd:decimal < Amount (by extension) < FinalAmount (by extension)
Sub-types:None

NameFinalAmount
Abstractno
DocumentationLast month payment amount
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="FinalAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): FinancePlan

Super-types:xsd:string < Description (by extension) < FinancePlan (by extension)
Sub-types:None

NameFinancePlan
Abstractno
DocumentationDescription of standard finance plan applied to deal.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="FinancePlan">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): FleetVehicleId

Super-types:xsd:string < Id (by extension) < FleetVehicleId (by extension)
Sub-types:None

NameFleetVehicleId
Abstractno
DocumentationUniquely identifies the vehicle as part of a fleet company
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="FleetVehicleId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): FullServiceContract

Super-types:ServiceContractBase < FullServiceContract (by extension)
Sub-types:

NameFullServiceContract
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ContractCompanyNameService contract company name Optional 
ContractIdIdentification of Service Contract Optional 
ContractPlanCodeService Contract Plan Code Optional 
ContractTypeService contract type and/or area of coverage Optional
Examples: Aftermarket; OEM Prepaid
 
ContractPlanDescriptionDescription of service plan. Example: 36 MONTH/36000 MILE" Optional 
TermNumber of months in contract plan Optional
'length' attribute needs to be Months.
 
ContractStartDateService Contract sale Date Optional
In YYYY-MM-DD format.
 
ContractDeductibleAmount of Deductible at time of service Eg:$50.00 Optional 
ContractExpirationDateDate the Service contract expires Optional
In YYYY-MM-DD format.
 
ContractStartMileageOdometer reading when contract becomes effective Optional
Values on uom attribute: K - Kilometers, M - Miles.
 
ContractTermMileageMileage allowed under terms of service contract Optional
Values on uom attribute: K - Kilometers, M - Miles
 
ContractOwnerNameName on service Contract (i.e., full name - First Last) Optional
Format should be 'First Last' with no commas between first and last.
 
InsuranceCompanyNameMemo Field for carrier covering extended service contract Optional 
TotalContractAmountTotal amount of the service contract. Optional 
ContractNoteFree form comments that relate to the contract Optional 
ContractEffectiveDateStart Date of Service Contract Optional
In YYYY-MM-DD format.
 
ContractPlanStatesStates where the plan is valid Optional
May occur multiple times.
 
ContractTransferIndIndicates if the contract is transferable Optional
Values: 1 - Yes, 0 - No.
 
ContractTransferredIndIndicates if the contract has been transferred Optional
Values: 1 - Yes, 0 - No.
 
ContractTripInterruptIndIndicates if the contract allows for trip interruption Optional 
LoanerVehicleIndService contract loaner vehicle indicator Optional 
RoadsideAssistanceIndIndicates whether coverage includes roadside assistance Optional
Values: 1 - Yes, 0 - No.
 
RoadHazardIndIndicates whether Roadside hazard is covered in the contract Optional
Values: 1 - Yes, 0 - No.
 
FirstDayRentalIndIf first day rental for service is covered in contract Optional
Values: 1 - Yes, 0 - No.
 
RentalAllowanceLimit for Rental Allowance per day Optional 
MaximumRentalAmountMax Rental Allowance per occurrence Optional 
TowingAllowanceAmount allowed for towing of RENTAL car Optional 

XML Instance Representation
<...>
<ContractCompanyName> ContractCompanyName </ContractCompanyName> [0..1] ?
<ContractId> ContractId </ContractId> [0..1] ?
<ContractPlanCode> ContractPlanCode </ContractPlanCode> [0..1] ?
<ContractType> ContractType </ContractType> [0..1] ?
<ContractPlanDescription> ContractPlanDescription </ContractPlanDescription> [0..1] ?
<Term> Term </Term> [0..1] ?
<ContractStartDate> ContractStartDate </ContractStartDate> [0..1] ?
<ContractDeductible> ContractDeductible </ContractDeductible> [0..1] ?
<ContractExpirationDate> ContractExpirationDate </ContractExpirationDate> [0..1] ?
<ContractStartMileage> ContractStartMileage </ContractStartMileage> [0..1] ?
<ContractTermMileage> ContractTermMileage </ContractTermMileage> [0..1] ?
<ContractOwnerName> ContractOwnerName </ContractOwnerName> [0..1] ?
<InsuranceCompanyName> InsuranceCompanyName </InsuranceCompanyName> [0..1] ?
<TotalContractAmount> TotalContractAmount </TotalContractAmount> [0..1] ?
<ContractNote> ContractNote </ContractNote> [0..1] ?
<ContractEffectiveDate> ContractEffectiveDate </ContractEffectiveDate> [0..1] ?
<ContractPlanStates> ContractPlanStates </ContractPlanStates> [0..*] ?
<ContractTransferInd> ContractTransferInd </ContractTransferInd> [0..1] ?
<ContractTransferredInd> ContractTransferredInd </ContractTransferredInd> [0..1] ?
<ContractTripInterruptInd> ContractTripInterruptInd </ContractTripInterruptInd> [0..1] ?
<LoanerVehicleInd> LoanerVehicleInd </LoanerVehicleInd> [0..1] ?
<RoadsideAssistanceInd> RoadsideAssistanceInd </RoadsideAssistanceInd> [0..1] ?
<RoadHazardInd> RoadHazardInd </RoadHazardInd> [0..1] ?
<FirstDayRentalInd> FirstDayRentalInd </FirstDayRentalInd> [0..1] ?
<RentalAllowance> RentalAllowance </RentalAllowance> [0..1] ?
<MaximumRentalAmount> MaximumRentalAmount </MaximumRentalAmount> [0..1] ?
<TowingAllowance> TowingAllowance </TowingAllowance> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="FullServiceContract">
<xsd:complexContent>
<xsd:extension base="ServiceContractBase">
<xsd:sequence>
<xsd:element name="ContractEffectiveDate" type="ContractEffectiveDate" minOccurs="0"/>
<xsd:element name="ContractPlanStates" type="ContractPlanStates" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="ContractTransferInd" type="ContractTransferInd" minOccurs="0"/>
<xsd:element name="ContractTransferredInd" type="ContractTransferredInd" minOccurs="0"/>
<xsd:element name="ContractTripInterruptInd" type="ContractTripInterruptInd" minOccurs="0"/>
<xsd:element name="LoanerVehicleInd" type="LoanerVehicleInd" minOccurs="0"/>
<xsd:element name="RoadsideAssistanceInd" type="RoadsideAssistanceInd" minOccurs="0"/>
<xsd:element name="RoadHazardInd" type="RoadHazardInd" minOccurs="0"/>
<xsd:element name="FirstDayRentalInd" type="FirstDayRentalInd" minOccurs="0"/>
<xsd:element name="RentalAllowance" type="RentalAllowance" minOccurs="0"/>
<xsd:element name="MaximumRentalAmount" type="MaximumRentalAmount" minOccurs="0"/>
<xsd:element name="TowingAllowance" type="TowingAllowance" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): HeaderBase

Super-types:None
Sub-types:

NameHeaderBase
Abstractno
DocumentationUsed on all STAR BODs
More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
DocumentDateTimeIs the date and time the document was last created. This is not the date and time that the BOD message instance was created. Optional
DateTime fields must be formatted as XML Schema DateTimes in UTC/GMT format without offsets. Example: 2003-11-05T13:15:30Z
 
SecondaryPasswordSecondary password used to validate access to the dealer information Optional 
SecondaryDealerNumberIdentifies secondary dealer number if different than primary "Dealer Number" Optional 

XML Instance Representation
<...>
<DocumentDateTime> DocumentDateTime </DocumentDateTime> [0..1] ?
<SecondaryPassword> SecondaryPassword </SecondaryPassword> [0..1] ?
<SecondaryDealerNumber> SecondaryDealerNumber </SecondaryDealerNumber> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="HeaderBase">
<xsd:sequence>
<xsd:element name="DocumentDateTime" type="DocumentDateTime" minOccurs="0"/>
<xsd:element name="SecondaryPassword" type="SecondaryPassword" minOccurs="0"/>
<xsd:element name="SecondaryDealerNumber" type="SecondaryDealerNumber" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): Id

Super-types:xsd:string < Id (by extension)
Sub-types:None

NameId
Abstractno
DocumentationParty Identification number
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="Id">
<xsd:simpleContent>
<xsd:extension base="xsd:string"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): IncentivesForCashCustomerAmt

Super-types:xsd:decimal < Amount (by extension) < IncentivesForCashCustomerAmt (by extension)
Sub-types:None

NameIncentivesForCashCustomerAmt
Abstractno
DocumentationIncentives available to ONLY cash customers.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="IncentivesForCashCustomerAmt">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): IndividualBuyerParty

Super-types:PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension) < IndividualBuyerParty (by extension)
Sub-types:

NameIndividualBuyerParty
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsIndividual party alternate party Identification Optional 
PersonNameIndividual party name Optional 
AddressIndividual party address Optional 
ContactIndividual party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 
DemographicsIndividual party demographic information Optional 
MarketingMailIndIndicates customers whom have requested no marketing mail Optional
Values: 0 - Cannot send mail. 1 - Can send mail.
 
PrimaryDriverIndIdentifies customer as primary driver Optional
Values: 1 - Primary Driver. 0 - Not Primary Driver.
 
DriverActionDriver action (Ex: Drop-Off, Pick-Up, etc) Optional
Service action related to this RO (Ex: Drop-Off, Pick-Up, etc)
 
PrivacyIndividual Privacy options Optional 
DMSCustomerIdThe DMS system assigned number associated with a customer entity Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> IndividualPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
<Address> IndividualPartyAddress </Address> [0..*] ?
<Contact> IndividualPartyContact </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
<Demographics> BuyerDemographics </Demographics> [0..1] ?
<MarketingMailInd> MarketingMailInd </MarketingMailInd> [0..1] ?
<PrimaryDriverInd> PrimaryDriverInd </PrimaryDriverInd> [0..1] ?
<DriverAction> DriverAction </DriverAction> [0..1] ?
<Privacy> Privacy </Privacy> [0..*] ?
<DMSCustomerId> DMSCustomerId </DMSCustomerId> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualBuyerParty">
<xsd:complexContent>
<xsd:extension base="IndividualOwnerParty">
<xsd:sequence>
<xsd:element name="Demographics" type="BuyerDemographics" minOccurs="0"/>
<xsd:element name="MarketingMailInd" type="MarketingMailInd" minOccurs="0"/>
<xsd:element name="PrimaryDriverInd" type="PrimaryDriverInd" minOccurs="0"/>
<xsd:element name="DriverAction" type="DriverAction" minOccurs="0"/>
<xsd:element name="Privacy" type="Privacy" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="DMSCustomerId" type="DMSCustomerId" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualBuyerPartyExtended

Super-types:PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension) < IndividualBuyerParty (by extension) < IndividualBuyerPartyExtended (by extension)
Sub-types:None

NameIndividualBuyerPartyExtended
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsIndividual party alternate party Identification Optional 
PersonNameIndividual party name Optional 
AddressIndividual party address Optional 
ContactIndividual party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 
DemographicsIndividual party demographic information Optional 
MarketingMailIndIndicates customers whom have requested no marketing mail Optional
Values: 0 - Cannot send mail. 1 - Can send mail.
 
PrimaryDriverIndIdentifies customer as primary driver Optional
Values: 1 - Primary Driver. 0 - Not Primary Driver.
 
DriverActionDriver action (Ex: Drop-Off, Pick-Up, etc) Optional
Service action related to this RO (Ex: Drop-Off, Pick-Up, etc)
 
PrivacyIndividual Privacy options Optional 
DMSCustomerIdThe DMS system assigned number associated with a customer entity Optional 
AuthorizationNumberBuyers are assigned an Authorization Number if employee purchase or preferred vendor Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> IndividualPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
<Address> IndividualPartyAddress </Address> [0..*] ?
<Contact> IndividualPartyContact </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
<Demographics> BuyerDemographics </Demographics> [0..1] ?
<MarketingMailInd> MarketingMailInd </MarketingMailInd> [0..1] ?
<PrimaryDriverInd> PrimaryDriverInd </PrimaryDriverInd> [0..1] ?
<DriverAction> DriverAction </DriverAction> [0..1] ?
<Privacy> Privacy </Privacy> [0..*] ?
<DMSCustomerId> DMSCustomerId </DMSCustomerId> [0..1] ?
<AuthorizationNumber> AuthorizationNumber </AuthorizationNumber> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualBuyerPartyExtended">
<xsd:complexContent>
<xsd:extension base="IndividualBuyerParty">
<xsd:sequence>
<xsd:element name="AuthorizationNumber" type="AuthorizationNumber" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualOwnerParty

Super-types:PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension)
Sub-types:

NameIndividualOwnerParty
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsIndividual party alternate party Identification Optional 
PersonNameIndividual party name Optional 
AddressIndividual party address Optional 
ContactIndividual party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> IndividualPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
<Address> IndividualPartyAddress </Address> [0..*] ?
<Contact> IndividualPartyContact </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualOwnerParty">
<xsd:complexContent>
<xsd:extension base="IndividualPartyBase">
<xsd:sequence>
<xsd:element name="Contact" type="IndividualPartyContact" minOccurs="0"/>
<xsd:element name="RelationshipCode" type="RelationshipCode" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyAddress

Super-types:AddressBase < Address (by extension) < IndividualPartyAddress (by extension)
Sub-types:None

NameIndividualPartyAddress
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AddressLineIndicates the multiple lines of an address. The first line is typically the street name and number. Required 
CityIs the City of the Address. Required 
CountyCounty in which the Address is in. Optional 
StateOrProvinceIs the State or Province of a given Address. Required 
CountryCountry in which the Address is in. Required 
PostalCodePostal Code of the Address. Required 
UrbanizationCodeGeographic definition of a metropolitan or suburban area Optional 

XML Instance Representation
<...
qualifier="AddressQualifier [0..1]"
>
<AddressLine> AddressLine </AddressLine> [1..*] ?
<City> City </City> [1] ?
<County> County </County> [0..1] ?
<StateOrProvince> StateOrProvince </StateOrProvince> [1] ?
<Country> Country </Country> [1] ?
<PostalCode> PostalCode </PostalCode> [1] ?
<UrbanizationCode> UrbanizationCode </UrbanizationCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyAddress">
<xsd:complexContent>
<xsd:extension base="Address">
<xsd:sequence>
<xsd:element name="UrbanizationCode" type="UrbanizationCode" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyAlternatePartyId

Super-types:AlternatePartyId < IndividualPartyAlternatePartyId (by extension)
Sub-types:None

NameIndividualPartyAlternatePartyId
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
IdAlternate Party Identification Required 
AssigningPartyIdAgency or entity that validates the Party Id Required 
IssuingStateIndicates that State where the license was issued. Optional 
ExpirationDateExpiration date of the alternate party id (e.g., Driver's License expiration date). Optional 

XML Instance Representation
<...>
<Id> Id </Id> [1] ?
<AssigningPartyId> AssigningPartyId </AssigningPartyId> [1] ?
<IssuingState> IssuingState </IssuingState> [0..1] ?
<ExpirationDate> ExpirationDate </ExpirationDate> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyAlternatePartyId">
<xsd:complexContent>
<xsd:extension base="AlternatePartyId">
<xsd:sequence>
<xsd:element name="AssigningPartyId" type="AssigningPartyId"/>
<xsd:element name="IssuingState" type="IssuingState" minOccurs="0"/>
<xsd:element name="ExpirationDate" type="ExpirationDate" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyBase

Super-types:PartyBase < IndividualPartyBase (by extension)
Sub-types:

NameIndividualPartyBase
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsIndividual party alternate party Identification Optional 
PersonNameIndividual party name Optional 
AddressIndividual party address Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> IndividualPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
<Address> IndividualPartyAddress </Address> [0..*] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyBase">
<xsd:complexContent>
<xsd:extension base="PartyBase">
<xsd:sequence>
<xsd:element name="AlternatePartyIds" type="IndividualPartyAlternatePartyId" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="PersonName" type="IndividualPartyPersonName" minOccurs="0"/>
<xsd:element name="Address" type="IndividualPartyAddress" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyContact

Super-types:ContactBase < IndividualPartyContact (by extension)
Sub-types:None

NameIndividualPartyContact
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
TelephoneContact telephone numbers Optional 
EMailAddressContact Email addresses Optional 
FaxContact Fax numbers Optional 
PreferredContactMethodPreferred contact method Optional 
ContactTimePreferred contact time (i.e. Best day/time to reach the contact. Optional 
PrimaryContactIndIndicates if contact is primary contact Optional
Values: 0 - Not Primary Contact. 1 - Primary Contact.
 
PersonNameContact name Optional 

XML Instance Representation
<...>
<Telephone> IndividualPartyContactTelephoneNumber </Telephone> [0..*] ?
<EMailAddress> IndividualPartyContactEMail </EMailAddress> [0..*] ?
<Fax> IndividualPartyContactFax </Fax> [0..*] ?
<PreferredContactMethod> PreferredContactMethod </PreferredContactMethod> [0..1] ?
<ContactTime> ContactTime </ContactTime> [0..1] ?
<PrimaryContactInd> PrimaryContactInd </PrimaryContactInd> [0..1] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyContact">
<xsd:complexContent>
<xsd:extension base="ContactBase">
<xsd:sequence>
<xsd:element name="PersonName" type="IndividualPartyPersonName" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyContactEMail

Super-types:xsd:string < IndividualPartyContactEMail (by extension)
Sub-types:None

NameIndividualPartyContactEMail
Abstractno
DocumentationIndividual Party email
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
desc Required 

XML Instance Representation
<...
desc="HomeWork [0..1]"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyContactEMail">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="desc" type="HomeWork"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyContactFax

Super-types:xsd:string < IndividualPartyContactFax (by extension)
Sub-types:None

NameIndividualPartyContactFax
Abstractno
DocumentationIndividual Party Fax number
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
desc Required 

XML Instance Representation
<...
desc="HomeWork [0..1]"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyContactFax">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="desc" type="HomeWork"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyContactTelephoneNumber

Super-types:xsd:string < IndividualPartyContactTelephoneNumber (by extension)
Sub-types:None

NameIndividualPartyContactTelephoneNumber
Abstractno
DocumentationIndividualParty telephone number
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
desc Required 
exten Required 

XML Instance Representation
<...

exten="Note [0..1]"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyContactTelephoneNumber">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="desc" type="ContactTelephoneNumberDescription"/>
<xsd:attribute name="exten" type="Note"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyPersonName

Super-types:None
Sub-types:None

NameIndividualPartyPersonName
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
SalutationTitle or greeting of business party Optional 
GivenNameFirst Name of business party Required 
MiddleNameMiddle Initial of business party Optional 
FamilyNameLast Name of business party Required 
SuffixBusiness Party name suffix designation if individual Ex: Sr, Jr, III, etc. Optional 
FormattedNameFull Name of business party. Format for name should be "First Last" with no commas between first and last name Optional 
SortNameIndex name used as a sort for report purposes Optional 

XML Instance Representation
<...>
<Salutation> Salutation </Salutation> [0..1] ?
<GivenName> GivenName </GivenName> [1] ?
<MiddleName> MiddleName </MiddleName> [0..1] ?
<FamilyName> FamilyName </FamilyName> [1] ?
<Suffix> Suffix </Suffix> [0..1] ?
<FormattedName> FormattedName </FormattedName> [0..1] ?
<SortName> SortName </SortName> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyPersonName">
<xsd:sequence>
<xsd:element name="Salutation" type="Salutation" minOccurs="0"/>
<xsd:element name="GivenName" type="GivenName"/>
<xsd:element name="MiddleName" type="MiddleName" minOccurs="0"/>
<xsd:element name="FamilyName" type="FamilyName"/>
<xsd:element name="Suffix" type="Suffix" minOccurs="0"/>
<xsd:element name="FormattedName" type="FormattedName" minOccurs="0"/>
<xsd:element name="SortName" type="SortName" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): InitiativeId

Super-types:xsd:string < Id (by extension) < InitiativeId (by extension)
Sub-types:None

NameInitiativeId
Abstractno
DocumentationInitiative Identification (i.e., Manufacturer incentive reimbursement program identification or dealer offerings)
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="InitiativeId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ItemId

Super-types:xsd:string < Id (by extension) < ItemId (by extension)
Sub-types:None

NameItemId
Abstractno
DocumentationItem part number
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="ItemId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): LienholderParty

Super-types:PartyBase < OrganizationPartyBase (by extension) < LienholderParty (by extension)
Sub-types:None

NameLienholderParty
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsAlternate organizational party Identification Optional
Values: LegalId, NationalId, DUNS, Other
 
NameCompany name of organizational party Optional 
AddressOrganizational Party address Optional 
DBANameDoing Business As name. Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> OrganizationalPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<Name> CompanyName </Name> [0..1] ?
<Address> OrganizationAddress </Address> [0..1] ?
<DBAName> DBAName </DBAName> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="LienholderParty">
<xsd:complexContent>
<xsd:extension base="OrganizationPartyBase"/>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): LocationId

Super-types:xsd:string < Id (by extension) < LocationId (by extension)
Sub-types:None

NameLocationId
Abstractno
DocumentationCode identifying a physical location
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="LocationId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): MarketingInitiatives

Super-types:None
Sub-types:None

NameMarketingInitiatives
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
InitiativeTypeType of program - Incentive or program related initiatives Optional 
InitiativeIdInitiative Identification (i.e., Manufacturer incentive reimbursement program identification or dealer offerings) Optional 
ReimbursementIdReimbursement certificate or coupon identification Optional
May occur multiple times.
 
ReimbursementCommentReimbursement dealer comments Optional 
ReimbursementAmountAmount returned to payee Optional 
ReimbursementPayeeIndicates who is paid - It can be either a code (D - Dealer or C - Customer) or the recipient name of reimbursement Optional 
FleetAccountManufacturer Fleet number Optional 
InitiativeDateThe date the initiative was processed. Optional 
DemoCountNumber of times vehicle was driven as a demo Optional 

XML Instance Representation
<...>
<InitiativeType> InitiativeType </InitiativeType> [0..1] ?
<InitiativeId> InitiativeId </InitiativeId> [0..1] ?
<ReimbursementId> ReimbursementId </ReimbursementId> [0..*] ?
<ReimbursementComment> ReimbursementComment </ReimbursementComment> [0..1] ?
<ReimbursementAmount> ReimbursementAmount </ReimbursementAmount> [0..1] ?
<ReimbursementPayee> ReimbursementPayee </ReimbursementPayee> [0..1] ?
<FleetAccount> FleetAccount </FleetAccount> [0..1] ?
<InitiativeDate> InitiativeDate </InitiativeDate> [0..1] ?
<DemoCount> DemoCount </DemoCount> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="MarketingInitiatives">
<xsd:sequence>
<xsd:element name="InitiativeType" type="InitiativeType" minOccurs="0"/>
<xsd:element name="InitiativeId" type="InitiativeId" minOccurs="0"/>
<xsd:element name="ReimbursementId" type="ReimbursementId" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="ReimbursementComment" type="ReimbursementComment" minOccurs="0"/>
<xsd:element name="ReimbursementAmount" type="ReimbursementAmount" minOccurs="0"/>
<xsd:element name="ReimbursementPayee" type="ReimbursementPayee" minOccurs="0"/>
<xsd:element name="FleetAccount" type="FleetAccount" minOccurs="0"/>
<xsd:element name="InitiativeDate" type="InitiativeDate" minOccurs="0"/>
<xsd:element name="DemoCount" type="DemoCount" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): MaximumRentalAmount

Super-types:xsd:decimal < Amount (by extension) < MaximumRentalAmount (by extension)
Sub-types:None

NameMaximumRentalAmount
Abstractno
DocumentationMax Rental Allowance per occurrence
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="MaximumRentalAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Measurement

Super-types:xsd:decimal < Measurement (by extension)
Sub-types:None

NameMeasurement
Abstractno
DocumentationDecimal measurement
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
xsd:decimal
</...>
Schema Component Representation
<xsd:complexType name="Measurement">
<xsd:simpleContent>
<xsd:extension base="xsd:decimal"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Mileage

Super-types:xsd:integer < Count (by extension) < Mileage (by extension)
Sub-types:None

NameMileage
Abstractno
DocumentationMileage definition
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
uom Optional 

XML Instance Representation
<...
uom="MileageMeasure [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="Mileage">
<xsd:simpleContent>
<xsd:extension base="Count">
<xsd:attribute name="uom" type="MileageMeasure" use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): NetAnnualPercentageRate

Super-types:xsd:decimal < Percent (by extension) < NetAnnualPercentageRate (by extension)
Sub-types:None

NameNetAnnualPercentageRate
Abstractno
DocumentationThe rate charged to the dealer
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="NetAnnualPercentageRate">
<xsd:simpleContent>
<xsd:extension base="Percent"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): NewFinancing

Super-types:None
Sub-types:

NameNewFinancing
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
FinanceTypeType of financing Examples may be F- Finance, L - Lease, C-Cash, 1-Retail, 2-Lease, 3-Balloon, etc.. Optional 
PaymentAmountMonthly Payment Amount Optional 
BalanceAmountRemaining balance on Current Vehicle Optional 
FinalAmountLast month payment amount Optional 
ResidualAmountRemaining residual on current vehicle Optional 
TermNumber of months of contract term Optional 
MaturityDateMonth and year of contract maturity Optional 
FinanceCompanyNameName of Finance Company Optional 
DownPaymentAmountDown Payment amount or amount of cap cost reduction. Optional 
PurchasePricePurchase Price or Gross Cap cost specified in deal. Total payments at end of purchase Optional 
ApprovedIndApproved Indicator Optional
Values: 0 - Not Pre-Approved. 1 - Pre-Approved.
 
ApprovedAmountAmount pre-approved Optional 
ExpirationDateDate pre-approval expires Optional 
RatingIndexRating Index Used for Credit Approval Optional 

XML Instance Representation
<...>
<FinanceType> FinanceType </FinanceType> [0..1] ?
<PaymentAmount> PaymentAmount </PaymentAmount> [0..1] ?
<BalanceAmount> BalanceAmount </BalanceAmount> [0..1] ?
<FinalAmount> FinalAmount </FinalAmount> [0..1] ?
<ResidualAmount> ResidualAmount </ResidualAmount> [0..1] ?
<Term> Term </Term> [0..1] ?
<MaturityDate> MaturityDate </MaturityDate> [0..1] ?
<FinanceCompanyName> FinanceCompanyName </FinanceCompanyName> [0..1] ?
<DownPaymentAmount> DownPaymentAmount </DownPaymentAmount> [0..1] ?
<PurchasePrice> PurchasePrice </PurchasePrice> [0..1] ?
<ApprovedInd> ApprovedInd </ApprovedInd> [0..1] ?
<ApprovedAmount> ApprovedAmount </ApprovedAmount> [0..1] ?
<ExpirationDate> ExpirationDate </ExpirationDate> [0..1] ?
<RatingIndex> RatingIndex </RatingIndex> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="NewFinancing">
<xsd:sequence>
<xsd:element name="FinanceType" type="FinanceType" minOccurs="0"/>
<xsd:element name="PaymentAmount" type="PaymentAmount" minOccurs="0"/>
<xsd:element name="BalanceAmount" type="BalanceAmount" minOccurs="0"/>
<xsd:element name="FinalAmount" type="FinalAmount" minOccurs="0"/>
<xsd:element name="ResidualAmount" type="ResidualAmount" minOccurs="0"/>
<xsd:element name="Term" type="Term" minOccurs="0"/>
<xsd:element name="MaturityDate" type="MaturityDate" minOccurs="0"/>
<xsd:element name="FinanceCompanyName" type="FinanceCompanyName" minOccurs="0"/>
<xsd:element name="DownPaymentAmount" type="DownPaymentAmount" minOccurs="0"/>
<xsd:element name="PurchasePrice" type="PurchasePrice" minOccurs="0"/>
<xsd:element name="ApprovedInd" type="ApprovedInd" minOccurs="0"/>
<xsd:element name="ApprovedAmount" type="ApprovedAmount" minOccurs="0"/>
<xsd:element name="ExpirationDate" type="ExpirationDate" minOccurs="0"/>
<xsd:element name="RatingIndex" type="RatingIndex" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): NonTaxableAmount

Super-types:xsd:decimal < Amount (by extension) < NonTaxableAmount (by extension)
Sub-types:None

NameNonTaxableAmount
Abstractno
DocumentationTotal non-taxable price.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="NonTaxableAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Option

Super-types:OptionBase < Option (by extension)
Sub-types:

NameOption
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
OptionTypeAn option type for a vehicle or other component. Usually references an OEM supplied list of codes. Optional 
OptionNameName of vehicle option Optional 
OptionStockNumberStock Number of Vehicle Option Optional 
ManufacturerManufacturer of Vehicle Option Optional 
OptionPricePrice of Vehicle Option Optional 

XML Instance Representation
<...>
<OptionType> OptionType </OptionType> [0..1] ?
<OptionName> OptionName </OptionName> [0..1] ?
<OptionStockNumber> OptionStockNumber </OptionStockNumber> [0..1] ?
<Manufacturer> Manufacturer </Manufacturer> [0..1] ?
<OptionPrice> OptionPrice </OptionPrice> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="Option">
<xsd:complexContent>
<xsd:extension base="OptionBase">
<xsd:sequence>
<xsd:element name="OptionPrice" type="OptionPrice" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OptionBase

Super-types:None
Sub-types:

NameOptionBase
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
OptionTypeAn option type for a vehicle or other component. Usually references an OEM supplied list of codes. Optional 
OptionNameName of vehicle option Optional 
OptionStockNumberStock Number of Vehicle Option Optional 
ManufacturerManufacturer of Vehicle Option Optional 

XML Instance Representation
<...>
<OptionType> OptionType </OptionType> [0..1] ?
<OptionName> OptionName </OptionName> [0..1] ?
<OptionStockNumber> OptionStockNumber </OptionStockNumber> [0..1] ?
<Manufacturer> Manufacturer </Manufacturer> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OptionBase">
<xsd:sequence>
<xsd:element name="OptionType" type="OptionType" minOccurs="0"/>
<xsd:element name="OptionName" type="OptionName" minOccurs="0"/>
<xsd:element name="OptionStockNumber" type="OptionStockNumber" minOccurs="0"/>
<xsd:element name="Manufacturer" type="Manufacturer" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): OptionCost

Super-types:xsd:decimal < Amount (by extension) < OptionCost (by extension)
Sub-types:None

NameOptionCost
Abstractno
DocumentationActual Dealer cost of option
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="OptionCost">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OptionMSRP

Super-types:xsd:decimal < Amount (by extension) < OptionMSRP (by extension)
Sub-types:None

NameOptionMSRP
Abstractno
DocumentationOption MSRP
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="OptionMSRP">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OptionPackageId

Super-types:xsd:string < Id (by extension) < OptionPackageId (by extension)
Sub-types:None

NameOptionPackageId
Abstractno
DocumentationOption package number or identifier used as a method for grouping option package items from manufacturer(s) Ex: OptPkg1,cost,
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="OptionPackageId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OptionPrice

Super-types:xsd:decimal < Amount (by extension) < OptionPrice (by extension)
Sub-types:None

NameOptionPrice
Abstractno
DocumentationPrice of Vehicle Option
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="OptionPrice">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OptionType

Super-types:xsd:string < CodeType (by extension) < OptionType (by extension)
Sub-types:None

NameOptionType
Abstractno
DocumentationOption Type from an OEM or other sources list of codes.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
listID="xsd:token [0..1]"

listName="xsd:string [0..1]"

listAgencyID="xsd:token [0..1]"

listAgencyName="xsd:string [0..1]"

listVersionID="xsd:token [0..1]"

listURI="xsd:anyURI [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="OptionType">
<xsd:simpleContent>
<xsd:extension base="CodeType"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationAddress

Super-types:AddressBase < OrganizationAddress (by extension)
Sub-types:None

NameOrganizationAddress
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AddressLineIndicates the multiple lines of an address. The first line is typically the street name and number. Required 
CityIs the City of the Address. Required 
CountyCounty in which the Address is in. Optional 
StateOrProvinceIs the State or Province of a given Address. Required 
CountryCountry in which the Address is in. Required 
PostalCodePostal Code of the Address. Required 
UrbanizationCodeGeographic definition of a metropolitan or suburban area Optional 

XML Instance Representation
<...>
<AddressLine> AddressLine </AddressLine> [1..*] ?
<City> City </City> [1] ?
<County> County </County> [0..1] ?
<StateOrProvince> StateOrProvince </StateOrProvince> [1] ?
<Country> Country </Country> [1] ?
<PostalCode> PostalCode </PostalCode> [1] ?
<UrbanizationCode> UrbanizationCode </UrbanizationCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationAddress">
<xsd:complexContent>
<xsd:extension base="AddressBase">
<xsd:sequence>
<xsd:element name="UrbanizationCode" type="UrbanizationCode" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationalBuyerParty

Super-types:PartyBase < OrganizationPartyBase (by extension) < OrganizationalOwnerParty (by extension) < OrganizationalOwnerPartyExtended (by extension) < OrganizationalBuyerParty (by extension)
Sub-types:

NameOrganizationalBuyerParty
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsAlternate organizational party Identification Optional
Values: LegalId, NationalId, DUNS, Other
 
NameCompany name of organizational party Optional 
AddressOrganizational Party address Optional 
DBANameDoing Business As name. Optional 
ContactOrganizational Party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 
MarketingMailIndIndicates customers whom have requested no marketing mail Optional 
PrimaryDriverIndIdentifies customer as primary driver Optional 
DriverActionDriver action (Ex: Drop-Off, Pick-Up, etc) Optional 
PrivacyOrganization privacy options Optional 
DMSCustomerIdThe DMS system assigned number associated with a customer entity Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> OrganizationalPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<Name>