Implementation Guideline
Process Retail Delivery Reporting
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
This document is a guideline on how to use the Process Retail Delivery Reporting Business Object Document (BOD). Process 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 Process 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 Process Retail Delivery Reporting, this BOD could be used to send Process Retail Delivery Reporting information between any two business parties.
The Process Retail Delivery Reporting Implementation Guidelines provide detailed information regarding the structure and meaning of the Process Retail Delivery Reporting BOD and corresponds directly to the Process 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 Process Retail Delivery Reporting Implementation Guidelines must be used in concert with the Process 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 Process 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 Process Retail Delivery Reporting BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Process 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.
STAR uses the same Noun in the schema for all the Noun/Verb combinations of the Process 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.
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.
The relationship diagram identifies all of the various components or building blocks of information used in the Process 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.
Target Namespace | http://www.starstandards.org/STAR |
---|---|
Element and Attribute Namespaces |
|
Documentation | This 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/. |
Prefix | Namespace |
---|---|
Default namespace | http://www.starstandards.org/STAR |
xml | http://www.w3.org/XML/1998/namespace |
xsd | http://www.w3.org/2001/XMLSchema |
Name | ApplicationArea |
---|---|
Type | ApplicationArea |
Nillable | no |
Abstract | no |
Documentation | 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. 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. |
Name | Header |
---|---|
Type | RetailDeliveryReportingHeader |
Nillable | no |
Abstract | no |
Documentation | More information at: http://www.starstandards.org. |
|
Name | Process |
---|---|
Type | Process |
Nillable | no |
Abstract | no |
Documentation | The Process verb is used to request processing of the associated noun by the receiving application or business to party. In a typical external exchange scenario a Process BOD is considered to be a legally binding message. For example, if a customer sends a ProcessPurchaseOrder BOD to a supplier and the supplier acknowlegdes with a positive AcknowledgePurchaseOrder, then the customer is obligated to fullfil the agreement, unless of course other BODs are allowed to cancel or change the original order. More information at: http://www.openapplications.org/oagis. |
Name | ProcessRetailDeliveryReporting |
---|---|
Type | ProcessRetailDeliveryReporting |
Nillable | no |
Abstract | no |
Name | RetailDeliveryReporting |
---|---|
Type | RetailDeliveryReporting |
Nillable | no |
Abstract | no |
Documentation | More information at: http://www.starstandards.org. |
Name | Vehicle |
---|---|
Type | SoldVehicle |
Nillable | no |
Abstract | no |
Documentation | More information at: http://www.starstandards.org. |
|
Name | Verb |
---|---|
Type | Verb |
Nillable | no |
Abstract | yes |
Super-types: | Verb < ConfirmableVerb (by extension) < ActionVerb (by extension) < AcknowledgableVerb (by extension) |
---|---|
Sub-types: |
|
Name | AcknowledgableVerb |
---|---|
Abstract | yes |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
acknowledge | Required |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Verb | Required | ||
Criteria | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ActionExpressionCriteria |
---|---|
Abstract | no |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
expressionLanguage | Required |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Expression | Required |
Super-types: | Verb < ConfirmableVerb (by extension) < ActionVerb (by extension) |
---|---|
Sub-types: |
|
Name | ActionVerb |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Verb | Required | ||
Criteria | Optional |
Super-types: | AddressBase < Address (by extension) |
---|---|
Sub-types: |
|
Name | Address |
---|---|
Abstract | no |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
qualifier | Required |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
AddressLine | Indicates the multiple lines of an address. The first line is typically the street name and number. | Required | |
City | Is the City of the Address. | Required | |
County | County in which the Address is in. | Optional | |
StateOrProvince | Is the State or Province of a given Address. | Required | |
Country | Country in which the Address is in. | Required | |
PostalCode | Postal Code of the Address. | Required |
Super-types: | None |
---|---|
Sub-types: |
|
Name | AddressBase |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
AddressLine | Indicates the multiple lines of an address. The first line is typically the street name and number. | Required | |
City | Is the City of the Address. | Required | |
County | County in which the Address is in. | Optional | |
StateOrProvince | Is the State or Province of a given Address. | Required | |
Country | Country in which the Address is in. | Required | |
PostalCode | Postal Code of the Address. | Required |
Super-types: | None |
---|---|
Sub-types: |
|
Name | AlternatePartyId |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Id | Alternate Party Identification | Required |
Super-types: | xsd:decimal < Amount (by extension) |
---|---|
Sub-types: | None |
Name | Amount |
---|---|
Abstract | no |
Documentation | Based on OAGI Amount. Simple content with the currency as an attrbute More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
currency | Required |
Super-types: | xsd:decimal < Percent (by extension) < AnnualPercentageRate (by extension) |
---|---|
Sub-types: | None |
Name | AnnualPercentageRate |
---|---|
Abstract | no |
Documentation | Annual percentage rate. More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ApplicationArea |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Sender | Identifies 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 | |
CreationDateTime | is the date time stamp that the given instance of the Business Object Document was created. This date must not be modified during the life of the Business Object Document. | Required |
DateTime fields must be formatted as XML Schema
Datetimes in UTC/GMT format without offsets.
Example: 2003-11-05T13:15:30Z
|
Signature | If the BOD is to be signed the signature element is included, otherwise it is not. Signature supports any digital signature that maybe used by an implementation of OAGIS. The qualifyingAgency identifies the agency that provided the format for the signature. 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 | |
BODId | The BODId provides a place to carry a Globally Unique Identifier (GUID) that will make each Business Object Document instance uniquely identifiable. This is a critical success factor to enable software developers to use the Globally Unique Identifier (GUID) to build 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 | |
Destination | Information related to the receiver of the BOD | Required |
See Destination Component.
|
Super-types: | xsd:decimal < Amount (by extension) < ApprovedAmount (by extension) |
---|---|
Sub-types: | None |
Name | ApprovedAmount |
---|---|
Abstract | no |
Documentation | Amount pre-approved More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < BalanceAmount (by extension) |
---|---|
Sub-types: | None |
Name | BalanceAmount |
---|---|
Abstract | no |
Documentation | Remaining balance on Current Vehicle More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < BalloonResidualAmount (by extension) |
---|---|
Sub-types: | None |
Name | BalloonResidualAmount |
---|---|
Abstract | no |
Documentation | The estimated amount of the vehicle at contract end. More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Percent (by extension) < BalloonResidualPercentage (by extension) |
---|---|
Sub-types: | None |
Name | BalloonResidualPercentage |
---|---|
Abstract | no |
Documentation | The estimated percent of value at contract end More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Percent (by extension) < BaseInterestRate (by extension) |
---|---|
Sub-types: | None |
Name | BaseInterestRate |
---|---|
Abstract | no |
Documentation | The base interest rate before any pre-paid interest or additional costs of financing. More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: | None |
Name | BrandedInfo |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
BrandedTitleInd | This 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.
|
BrandedTitleDate | Branding Date | Optional | In YYYY-MM-DD format. |
BrandingStateCode | Branding State Code | Optional | |
BrandingStateReference | Branding State Reference Number | Optional | |
BrandingSource | Branding source â (i.e., source who says that the vehicle is branded) | Optional |
Super-types: | xsd:string < StateOrProvince (by restriction) < BrandingStateCode (by extension) |
---|---|
Sub-types: | None |
Name | BrandingStateCode |
---|---|
Abstract | no |
Documentation | Branding State Code More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: |
|
Name | BusinessObjectDocument |
---|---|
Abstract | no |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
revision | This 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 | |
release | Indicates the OAGIS release that this BOD belongs. | Optional | |
environment | Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s). | Optional | |
lang | Indicates the language that the contents of the BOD is in unless otherwise stated. | Optional | |
bodVersion | Deprecated 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 |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
ApplicationArea | Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of. | Required |
Super-types: | None |
---|---|
Sub-types: | None |
Name | BuyerDemographics |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Gender | Gender of party | Optional |
Values: M - Male. F - Female
|
Language | Business party native language | Optional | |
BirthDate | Birth date of party | Optional | In YYYY-MM-DD format. |
FirstTimeBuyerInd | Identifies customer as first time buyer | Optional |
Values: 1 - First Time Buyer. 0 - Not a First Time
Buyer.
|
PreferredLanguage | Customer's preferred language | Optional |
Super-types: | xsd:string < CodeType (by extension) |
---|---|
Sub-types: | None |
Name | CodeType |
---|---|
Abstract | no |
Documentation | Unique code name More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
listID | Optional | ||
listName | Optional | ||
listAgencyID | Optional | ||
listAgencyName | Optional | ||
listVersionID | Optional | ||
listURI | Optional |
Super-types: | Verb < ConfirmableVerb (by extension) |
---|---|
Sub-types: |
|
Name | ConfirmableVerb |
---|---|
Abstract | no |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
confirm | Required |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Verb | Required |
Super-types: | None |
---|---|
Sub-types: |
|
Name | ContactBase |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Telephone | Contact telephone numbers | Optional | |
EMailAddress | Contact Email addresses | Optional | |
Fax | Contact Fax numbers | Optional | |
PreferredContactMethod | Preferred contact method | Optional | |
ContactTime | Preferred contact time (i.e. Best day/time to reach the contact. | Optional | |
PrimaryContactInd | Indicates if contact is primary contact | Optional |
Values: 0 - Not Primary Contact. 1 - Primary
Contact.
|
Super-types: | xsd:decimal < Amount (by extension) < ContractDeductible (by extension) |
---|---|
Sub-types: | None |
Name | ContractDeductible |
---|---|
Abstract | no |
Documentation | Amount of Contract Deductible More information at: http://www.starstandard.org. |
Super-types: | xsd:integer < Count (by extension) < Mileage (by extension) < ContractExpirationDistance (by extension) |
---|---|
Sub-types: | None |
Name | ContractExpirationDistance |
---|---|
Abstract | no |
Documentation | The odometer reading (distance) of the vehicle when the service contract expires. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < ContractId (by extension) |
---|---|
Sub-types: | None |
Name | ContractId |
---|---|
Abstract | no |
Documentation | Identification of Contract More information at: http://www.starstandard.org. |
Super-types: | xsd:integer < Count (by extension) < ContractInstallments (by restriction) |
---|---|
Sub-types: | None |
Name | ContractInstallments |
---|---|
Abstract | no |
Documentation | Number of months of payments (Ex: 1,5,11,17). More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Description (by extension) < ContractOptionDescription (by extension) |
---|---|
Sub-types: | None |
Name | ContractOptionDescription |
---|---|
Abstract | no |
Documentation | Description of the plan option. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Description (by extension) < ContractPlanDescription (by extension) |
---|---|
Sub-types: | None |
Name | ContractPlanDescription |
---|---|
Abstract | no |
Documentation | Description of contract plan. Example: 36 MONTH/36000 MILE" More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ContractPlanOption |
---|---|
Abstract | no |
Documentation | The Contract Plan Options. More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
ContractOptionStartDate | The date the contract option takes effect. | Optional | In YYYY-MM-DD format. |
ContractOptionEndDate | The date the contract option expires. | Optional | In YYYY-MM-DD foramt. |
ContractOptionCode | Unique Identifier for a Plan Option. | Optional | |
ContractOptionDescription | Description of the plan option | Optional | |
PlanOptionPrice | The suggested sale price of the plan option | Optional |
Super-types: | xsd:integer < Count (by extension) < Mileage (by extension) < ContractStartMileage (by extension) |
---|---|
Sub-types: | None |
Name | ContractStartMileage |
---|---|
Abstract | no |
Documentation | Odometer reading when contract becomes effective More information at: http://www.starstandard.org. |
Super-types: | xsd:integer < Count (by extension) < Mileage (by extension) < ContractTermMileage (by extension) |
---|---|
Sub-types: | None |
Name | ContractTermMileage |
---|---|
Abstract | no |
Documentation | Mileage allowed under terms of contract More information at: http://www.starstandard.org. |
Super-types: | xsd:integer < Count (by extension) |
---|---|
Sub-types: | None |
Name | Count |
---|---|
Abstract | no |
Documentation | Simple quantity type with no attributes More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: |
|
Name | Coupon |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
CouponId | Identification of Coupon dealership service application | Optional | |
CouponDescription | Text identification of Coupon | Optional | |
CouponDiscountAmount | Credit Price for coupons | Optional | |
CouponComment | Comments associated with the coupon (e.g., Please rotate tire to front left). | Optional |
Super-types: | xsd:string < Description (by extension) < CouponDescription (by extension) |
---|---|
Sub-types: | None |
Name | CouponDescription |
---|---|
Abstract | no |
Documentation | Text identification of Coupon More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < CouponDiscountAmount (by extension) |
---|---|
Sub-types: | None |
Name | CouponDiscountAmount |
---|---|
Abstract | no |
Documentation | Credit Price for coupons More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < CouponId (by extension) |
---|---|
Sub-types: | None |
Name | CouponId |
---|---|
Abstract | no |
Documentation | Identification of Coupon dealership service application More information at: http://www.starstandard.org. |
Super-types: | Coupon < CreditContractCoupon (by extension) |
---|---|
Sub-types: | None |
Name | CreditContractCoupon |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
CouponId | Identification of Coupon dealership service application | Optional | |
CouponDescription | Text identification of Coupon | Optional | |
CouponDiscountAmount | Credit Price for coupons | Optional | |
CouponComment | Comments associated with the coupon (e.g., Please rotate tire to front left). | Optional | |
DiscountPercentage | Percentage of discount. | Optional |
Super-types: | PartyBase < DealerPartyBase (by extension) < DealerExtendedAddress (by extension) |
---|---|
Sub-types: |
|
Name | DealerExtendedAddress |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
DealerName | Dealer name | Optional | |
DistrictCode | Manufacturer Assigned District Code | Optional | |
URI | Dealer URI | Optional | |
ZoneCode | Manufacturer Assigned Zone Code | Optional | |
Address | Dealer party address | Optional |
Super-types: | PartyBase < DealerPartyBase (by extension) |
---|---|
Sub-types: |
|
Name | DealerPartyBase |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
DealerName | Dealer name | Optional | |
DistrictCode | Manufacturer Assigned District Code | Optional | |
URI | Dealer URI | Optional | |
ZoneCode | Manufacturer Assigned Zone Code | Optional |
Super-types: | xsd:integer < Count (by extension) < Mileage (by extension) < DeliveryMileage (by extension) |
---|---|
Sub-types: | None |
Name | DeliveryMileage |
---|---|
Abstract | no |
Documentation | Odometer reading of vehicle at time of delivery More information at: http://www.starstandard.org. |
Super-types: | xsd:integer < Count (by extension) < DemoCount (by restriction) |
---|---|
Sub-types: | None |
Name | DemoCount |
---|---|
Abstract | no |
Documentation | Number of times vehicle was driven as a demo. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Description (by extension) |
---|---|
Sub-types: | None |
Name | Description |
---|---|
Abstract | no |
Documentation | Description More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
language | The ISO language code that the description is written. | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | Destination |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
DestinationNameCode | Code 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
|
DestinationURI | Physical address of the destination | Optional | |
DestinationSoftwareCode | Additional information about the destination application | Optional | |
DestinationSoftware | For which software destination file is intended (may not be known). | Optional | |
DealerNumber | Target Dealer Code receiving information | Optional | |
StoreNumber | Dealer code store number (DMS assigned) | Optional | |
AreaNumber | Dealer code area number (DMS vendor assigned) | Optional | |
DealerCountry | Target Dealer country location | Optional | |
PartyId | The 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 | |
LocationId | The 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 | |
ServiceId | The Service Id field identifies the particular service to which a message is being sent, e.g., an inventory service. | Optional |
Super-types: | xsd:decimal < Percent (by extension) < DiscountPercentage (by extension) |
---|---|
Sub-types: | None |
Name | DiscountPercentage |
---|---|
Abstract | no |
Documentation | Percentage of discount. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < DMSCustomerId (by extension) |
---|---|
Sub-types: | None |
Name | DMSCustomerId |
---|---|
Abstract | no |
Documentation | The DMS system assigned number associated with a customer entity More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < DocumentId (by extension) |
---|---|
Sub-types: | None |
Name | DocumentId |
---|---|
Abstract | no |
Documentation | Is the identifier for the document. More information at: http://www.starstandard.org. |
Super-types: | xsd:integer < Count (by extension) < DoorsQuantity (by restriction) |
---|---|
Sub-types: | None |
Name | DoorsQuantity |
---|---|
Abstract | no |
Documentation | Number of doors on vehicle More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < DownPaymentAmount (by extension) |
---|---|
Sub-types: | None |
Name | DownPaymentAmount |
---|---|
Abstract | no |
Documentation | Down Payment amount or amount of cap cost reduction. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Description (by extension) < EngineDescription (by extension) |
---|---|
Sub-types: | None |
Name | EngineDescription |
---|---|
Abstract | no |
Documentation | Text description of engine (e.g. dohc, 32 valves) More information at: http://www.starstandard.org. |
Super-types: | OptionBase < Option (by extension) < ExpandedOption (by extension) |
---|---|
Sub-types: | None |
Name | ExpandedOption |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
OptionType | An option type for a vehicle or other component. Usually references an OEM supplied list of codes. | Optional | |
OptionName | Name of vehicle option | Optional | |
OptionStockNumber | Stock Number of Vehicle Option | Optional | |
Manufacturer | Manufacturer of Vehicle Option | Optional | |
OptionPrice | Price of Vehicle Option | Optional | |
OptionSecurityCode | Security code to unlock option. (i.e, radio code)n | Optional | |
ManufacturerInstalledInd | Indicates manufacturer-installed accessories | Optional | |
OptionCost | Actual Dealer cost of option | Optional | |
OptionMSRP | Option MSRP | Optional | |
OptionOrigin | Identifies the option installer | Optional | |
OptionSerialNumber | Serial number of Option | Optional | |
ItemId | Part number identifier of Option | Optional | |
PartType | Specifies whether the parts are indicated by manufacturer part code or Part Number | Optional | |
OptionNotes | Free form text related to option | Optional | |
DealerInstallationInd | Dealer installed accessories, before delivery of vehicle - Could be used for new or used vehicle, if applicable | Optional | |
MiscellaneousCode | Miscellaneous codes relating to vehicle (i.e., sales codes) | Optional |
May occur multiple times.
|
OptionPackageId | Option 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 | |
OptionSalesCode | Further definition of accessories and option packages - Indicates whether ordered option, special package, standard, etc. | Optional | |
PortInstalledInd | Indicates Port-installed accessories | Optional |
Super-types: | Vehicle < VehicleBase (by extension) < ExpandedVehicle (by extension) |
---|---|
Sub-types: |
|
Name | ExpandedVehicle |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Model | Manufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) | Optional | |
ModelYear | Vehicle designated model year | Optional | |
ModelDescription | Descriptive vehicle model name | Optional | |
Make | Vehicle make code - Usually available in the VIN number (use NCIC code). | Optional | |
SaleClass | Class of Sale | Optional | |
Condition | Condition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown | Optional | |
CertifiedPreownedInd | Identifies as a certified Pre-Owned Vehicle | Optional | |
VehicleNote | Any vehicle related notes | Optional | |
VIN | Federally defined 17 position vehicle identification number | Optional | |
DeliveryMileage | Odometer reading of vehicle at time of delivery | Optional |
Values on uom attribute: K - Kilometers, M - Miles
|
VehicleStock | Dealer assigned vehicle stock number | Optional | |
TrimCode | Manufacturer assigned trim code | Optional | |
DoorsQuantity | Number of doors on vehicle | Optional | |
BodyStyle | Manufacturer-assigned vehicle body style | Optional | |
InteriorColor | Vehicle Interior Color(s) | Optional |
May occur multiple times.
|
ExteriorColor | Vehicle Exterior Color(s) | Optional |
May occur multiple times.
|
TransmissionType | Vehicle Transmission type | Optional |
Values: 3 - 3 speed, 4 - 4 speed, 5 - 5 speed, 6 - 6
speed, A - Automatic
|
OdometerStatus | Status of odometer at trade-in. Example:: Replaced, Tampered, Miles> 90,000, etc. | Optional | |
NonUSVehicleInd | Indicates 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.
|
VehicleDemoInd | Indicates whether vehicle was ever a demo | Optional |
Values: 0 - Was or is not a demo. 1 - Was or is a
demo.
|
LicenseNumber | State License plate number of vehicle | Optional | |
BrandedInfo | Vehicle Branding Information | Optional | |
RestrictionInd | Indication that vehicle has restrictions on its use | Optional |
Values: 1 - Yes, 0 - No.
|
RestrictionDescription | Description of vehicle use restrictions | Optional | |
TelematicsServiceInd | Indication whether Telematics Service Subscription is turned on | Optional | |
Option | Vehicle Options | Optional | |
TransmissionCode | Transmission Serial Number | Optional | |
DeliveryDate | The date of original retail vehicle sale | Optional | In YYYY-MM-DD format. |
EngineNumber | Serial number of the engine if vehicle not made for US sale | Optional | |
IgnitionKeyNumber | Vehicle Ignition Key Number | Optional | |
AxleCode | The code on the axle of the vehicle. | Optional | |
FleetAccount | Manufacturer defined fleet account number | Optional | |
FleetVehicleId | Uniquely identifies the vehicle as part of a fleet company | Optional | |
FleetPurchaseOrderNumber | Fleet Purchase Order Number vehicle was purchased under | Optional | |
DoorKeyNumber | Door key number | Optional | |
VehicleWeight | Vehicle weight | Optional | |
ExteriorColorCode | Vehicle exterior color code | Optional | |
InteriorColorCode | Vehicle Interior color code | Optional |
Super-types: | xsd:decimal < Amount (by extension) < FinalAmount (by extension) |
---|---|
Sub-types: | None |
Name | FinalAmount |
---|---|
Abstract | no |
Documentation | Last month payment amount More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Description (by extension) < FinancePlan (by extension) |
---|---|
Sub-types: | None |
Name | FinancePlan |
---|---|
Abstract | no |
Documentation | Description of standard finance plan applied to deal. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < FleetVehicleId (by extension) |
---|---|
Sub-types: | None |
Name | FleetVehicleId |
---|---|
Abstract | no |
Documentation | Uniquely identifies the vehicle as part of a fleet company More information at: http://www.starstandard.org. |
Super-types: | ServiceContractBase < FullServiceContract (by extension) |
---|---|
Sub-types: |
|
Name | FullServiceContract |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
ContractCompanyName | Service contract company name | Optional | |
ContractId | Identification of Service Contract | Optional | |
ContractPlanCode | Service Contract Plan Code | Optional | |
ContractType | Service contract type and/or area of coverage | Optional |
Examples: Aftermarket; OEM Prepaid
|
ContractPlanDescription | Description of service plan. Example: 36 MONTH/36000 MILE" | Optional | |
Term | Number of months in contract plan | Optional |
'length' attribute needs to be Months.
|
ContractStartDate | Service Contract sale Date | Optional | In YYYY-MM-DD format. |
ContractDeductible | Amount of Deductible at time of service Eg:$50.00 | Optional | |
ContractExpirationDate | Date the Service contract expires | Optional | In YYYY-MM-DD format. |
ContractStartMileage | Odometer reading when contract becomes effective | Optional |
Values on uom attribute: K - Kilometers, M - Miles.
|
ContractTermMileage | Mileage allowed under terms of service contract | Optional |
Values on uom attribute: K - Kilometers, M - Miles
|
ContractOwnerName | Name on service Contract (i.e., full name - First Last) | Optional |
Format should be 'First Last' with no commas between
first and last.
|
InsuranceCompanyName | Memo Field for carrier covering extended service contract | Optional | |
TotalContractAmount | Total amount of the service contract. | Optional | |
ContractNote | Free form comments that relate to the contract | Optional | |
ContractEffectiveDate | Start Date of Service Contract | Optional | In YYYY-MM-DD format. |
ContractPlanStates | States where the plan is valid | Optional |
May occur multiple times.
|
ContractTransferInd | Indicates if the contract is transferable | Optional |
Values: 1 - Yes, 0 - No.
|
ContractTransferredInd | Indicates if the contract has been transferred | Optional |
Values: 1 - Yes, 0 - No.
|
ContractTripInterruptInd | Indicates if the contract allows for trip interruption | Optional | |
LoanerVehicleInd | Service contract loaner vehicle indicator | Optional | |
RoadsideAssistanceInd | Indicates whether coverage includes roadside assistance | Optional |
Values: 1 - Yes, 0 - No.
|
RoadHazardInd | Indicates whether Roadside hazard is covered in the contract | Optional |
Values: 1 - Yes, 0 - No.
|
FirstDayRentalInd | If first day rental for service is covered in contract | Optional |
Values: 1 - Yes, 0 - No.
|
RentalAllowance | Limit for Rental Allowance per day | Optional | |
MaximumRentalAmount | Max Rental Allowance per occurrence | Optional | |
TowingAllowance | Amount allowed for towing of RENTAL car | Optional |
Super-types: | None |
---|---|
Sub-types: |
|
Name | HeaderBase |
---|---|
Abstract | no |
Documentation | Used on all STAR BODs More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
DocumentDateTime | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. | Optional |
DateTime fields must be formatted as XML Schema
DateTimes in UTC/GMT format without offsets.
Example: 2003-11-05T13:15:30Z
|
SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | |
SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional |
Super-types: | xsd:string < Id (by extension) |
---|---|
Sub-types: | None |
Name | Id |
---|---|
Abstract | no |
Documentation | Party Identification number More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < IncentivesForCashCustomerAmt (by extension) |
---|---|
Sub-types: | None |
Name | IncentivesForCashCustomerAmt |
---|---|
Abstract | no |
Documentation | Incentives available to ONLY cash customers. More information at: http://www.starstandard.org. |
Super-types: | PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension) < IndividualBuyerParty (by extension) |
---|---|
Sub-types: |
|
Name | IndividualBuyerParty |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Individual party alternate party Identification | Optional | |
PersonName | Individual party name | Optional | |
Address | Individual party address | Optional | |
Contact | Individual party contact information | Optional | |
RelationshipCode | Indicates the Business PartyâÂÂs relationship to the primary Party (e.g., mother, father, husband, etc.)l | Optional | |
Demographics | Individual party demographic information | Optional | |
MarketingMailInd | Indicates customers whom have requested no marketing mail | Optional |
Values: 0 - Cannot send mail. 1 - Can send mail.
|
PrimaryDriverInd | Identifies customer as primary driver | Optional |
Values: 1 - Primary Driver. 0 - Not Primary Driver.
|
DriverAction | Driver action (Ex: Drop-Off, Pick-Up, etc) | Optional |
Service action related to this RO (Ex: Drop-Off,
Pick-Up, etc)
|
Privacy | Individual Privacy options | Optional | |
DMSCustomerId | The DMS system assigned number associated with a customer entity | Optional |
Super-types: | PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension) < IndividualBuyerParty (by extension) < IndividualBuyerPartyExtended (by extension) |
---|---|
Sub-types: | None |
Name | IndividualBuyerPartyExtended |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Individual party alternate party Identification | Optional | |
PersonName | Individual party name | Optional | |
Address | Individual party address | Optional | |
Contact | Individual party contact information | Optional | |
RelationshipCode | Indicates the Business PartyâÂÂs relationship to the primary Party (e.g., mother, father, husband, etc.)l | Optional | |
Demographics | Individual party demographic information | Optional | |
MarketingMailInd | Indicates customers whom have requested no marketing mail | Optional |
Values: 0 - Cannot send mail. 1 - Can send mail.
|
PrimaryDriverInd | Identifies customer as primary driver | Optional |
Values: 1 - Primary Driver. 0 - Not Primary Driver.
|
DriverAction | Driver action (Ex: Drop-Off, Pick-Up, etc) | Optional |
Service action related to this RO (Ex: Drop-Off,
Pick-Up, etc)
|
Privacy | Individual Privacy options | Optional | |
DMSCustomerId | The DMS system assigned number associated with a customer entity | Optional | |
AuthorizationNumber | Buyers are assigned an Authorization Number if employee purchase or preferred vendor | Optional |
Super-types: | PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension) |
---|---|
Sub-types: |
|
Name | IndividualOwnerParty |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Individual party alternate party Identification | Optional | |
PersonName | Individual party name | Optional | |
Address | Individual party address | Optional | |
Contact | Individual party contact information | Optional | |
RelationshipCode | Indicates the Business PartyâÂÂs relationship to the primary Party (e.g., mother, father, husband, etc.)l | Optional |
Super-types: | AddressBase < Address (by extension) < IndividualPartyAddress (by extension) |
---|---|
Sub-types: | None |
Name | IndividualPartyAddress |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
AddressLine | Indicates the multiple lines of an address. The first line is typically the street name and number. | Required | |
City | Is the City of the Address. | Required | |
County | County in which the Address is in. | Optional | |
StateOrProvince | Is the State or Province of a given Address. | Required | |
Country | Country in which the Address is in. | Required | |
PostalCode | Postal Code of the Address. | Required | |
UrbanizationCode | Geographic definition of a metropolitan or suburban area | Optional |
Super-types: | AlternatePartyId < IndividualPartyAlternatePartyId (by extension) |
---|---|
Sub-types: | None |
Name | IndividualPartyAlternatePartyId |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Id | Alternate Party Identification | Required | |
AssigningPartyId | Agency or entity that validates the Party Id | Required | |
IssuingState | Indicates that State where the license was issued. | Optional | |
ExpirationDate | Expiration date of the alternate party id (e.g., Driver's License expiration date). | Optional |
Super-types: | PartyBase < IndividualPartyBase (by extension) |
---|---|
Sub-types: |
|
Name | IndividualPartyBase |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Individual party alternate party Identification | Optional | |
PersonName | Individual party name | Optional | |
Address | Individual party address | Optional |
Super-types: | ContactBase < IndividualPartyContact (by extension) |
---|---|
Sub-types: | None |
Name | IndividualPartyContact |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Telephone | Contact telephone numbers | Optional | |
EMailAddress | Contact Email addresses | Optional | |
Fax | Contact Fax numbers | Optional | |
PreferredContactMethod | Preferred contact method | Optional | |
ContactTime | Preferred contact time (i.e. Best day/time to reach the contact. | Optional | |
PrimaryContactInd | Indicates if contact is primary contact | Optional |
Values: 0 - Not Primary Contact. 1 - Primary
Contact.
|
PersonName | Contact name | Optional |
Super-types: | xsd:string < IndividualPartyContactEMail (by extension) |
---|---|
Sub-types: | None |
Name | IndividualPartyContactEMail |
---|---|
Abstract | no |
Documentation | Individual Party email More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
desc | Required |
Super-types: | xsd:string < IndividualPartyContactFax (by extension) |
---|---|
Sub-types: | None |
Name | IndividualPartyContactFax |
---|---|
Abstract | no |
Documentation | Individual Party Fax number More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
desc | Required |
Super-types: | xsd:string < IndividualPartyContactTelephoneNumber (by extension) |
---|---|
Sub-types: | None |
Name | IndividualPartyContactTelephoneNumber |
---|---|
Abstract | no |
Documentation | IndividualParty telephone number More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
desc | Required | ||
exten | Required |
Super-types: | None |
---|---|
Sub-types: | None |
Name | IndividualPartyPersonName |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Salutation | Title or greeting of business party | Optional | |
GivenName | First Name of business party | Required | |
MiddleName | Middle Initial of business party | Optional | |
FamilyName | Last Name of business party | Required | |
Suffix | Business Party name suffix designation if individual Ex: Sr, Jr, III, etc. | Optional | |
FormattedName | Full Name of business party. Format for name should be "First Last" with no commas between first and last name | Optional | |
SortName | Index name used as a sort for report purposes | Optional |
Super-types: | xsd:string < Id (by extension) < InitiativeId (by extension) |
---|---|
Sub-types: | None |
Name | InitiativeId |
---|---|
Abstract | no |
Documentation | Initiative Identification (i.e., Manufacturer incentive reimbursement program identification or dealer offerings) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < ItemId (by extension) |
---|---|
Sub-types: | None |
Name | ItemId |
---|---|
Abstract | no |
Documentation | Item part number More information at: http://www.starstandard.org. |
Super-types: | PartyBase < OrganizationPartyBase (by extension) < LienholderParty (by extension) |
---|---|
Sub-types: | None |
Name | LienholderParty |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Alternate organizational party Identification | Optional |
Values: LegalId, NationalId, DUNS, Other
|
Name | Company name of organizational party | Optional | |
Address | Organizational Party address | Optional | |
DBAName | Doing Business As name. | Optional |
Super-types: | xsd:string < Id (by extension) < LocationId (by extension) |
---|---|
Sub-types: | None |
Name | LocationId |
---|---|
Abstract | no |
Documentation | Code identifying a physical location More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: | None |
Name | MarketingInitiatives |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
InitiativeType | Type of program - Incentive or program related initiatives | Optional | |
InitiativeId | Initiative Identification (i.e., Manufacturer incentive reimbursement program identification or dealer offerings) | Optional | |
ReimbursementId | Reimbursement certificate or coupon identification | Optional |
May occur multiple times.
|
ReimbursementComment | Reimbursement dealer comments | Optional | |
ReimbursementAmount | Amount returned to payee | Optional | |
ReimbursementPayee | Indicates who is paid - It can be either a code (D - Dealer or C - Customer) or the recipient name of reimbursement | Optional | |
FleetAccount | Manufacturer Fleet number | Optional | |
InitiativeDate | The date the initiative was processed. | Optional | |
DemoCount | Number of times vehicle was driven as a demo | Optional |
Super-types: | xsd:decimal < Amount (by extension) < MaximumRentalAmount (by extension) |
---|---|
Sub-types: | None |
Name | MaximumRentalAmount |
---|---|
Abstract | no |
Documentation | Max Rental Allowance per occurrence More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Measurement (by extension) |
---|---|
Sub-types: | None |
Name | Measurement |
---|---|
Abstract | no |
Documentation | Decimal measurement More information at: http://www.starstandard.org. |
Super-types: | xsd:integer < Count (by extension) < Mileage (by extension) |
---|---|
Sub-types: | None |
Name | Mileage |
---|---|
Abstract | no |
Documentation | Mileage definition More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
uom | Optional |
Super-types: | xsd:decimal < Percent (by extension) < NetAnnualPercentageRate (by extension) |
---|---|
Sub-types: | None |
Name | NetAnnualPercentageRate |
---|---|
Abstract | no |
Documentation | The rate charged to the dealer More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: |
|
Name | NewFinancing |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
FinanceType | Type of financing Examples may be F- Finance, L - Lease, C-Cash, 1-Retail, 2-Lease, 3-Balloon, etc.. | Optional | |
PaymentAmount | Monthly Payment Amount | Optional | |
BalanceAmount | Remaining balance on Current Vehicle | Optional | |
FinalAmount | Last month payment amount | Optional | |
ResidualAmount | Remaining residual on current vehicle | Optional | |
Term | Number of months of contract term | Optional | |
MaturityDate | Month and year of contract maturity | Optional | |
FinanceCompanyName | Name of Finance Company | Optional | |
DownPaymentAmount | Down Payment amount or amount of cap cost reduction. | Optional | |
PurchasePrice | Purchase Price or Gross Cap cost specified in deal. Total payments at end of purchase | Optional | |
ApprovedInd | Approved Indicator | Optional |
Values: 0 - Not Pre-Approved. 1 - Pre-Approved.
|
ApprovedAmount | Amount pre-approved | Optional | |
ExpirationDate | Date pre-approval expires | Optional | |
RatingIndex | Rating Index Used for Credit Approval | Optional |
Super-types: | xsd:decimal < Amount (by extension) < NonTaxableAmount (by extension) |
---|---|
Sub-types: | None |
Name | NonTaxableAmount |
---|---|
Abstract | no |
Documentation | Total non-taxable price. More information at: http://www.starstandard.org. |
Super-types: | OptionBase < Option (by extension) |
---|---|
Sub-types: |
|
Name | Option |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
OptionType | An option type for a vehicle or other component. Usually references an OEM supplied list of codes. | Optional | |
OptionName | Name of vehicle option | Optional | |
OptionStockNumber | Stock Number of Vehicle Option | Optional | |
Manufacturer | Manufacturer of Vehicle Option | Optional | |
OptionPrice | Price of Vehicle Option | Optional |
Super-types: | None |
---|---|
Sub-types: |
|
Name | OptionBase |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
OptionType | An option type for a vehicle or other component. Usually references an OEM supplied list of codes. | Optional | |
OptionName | Name of vehicle option | Optional | |
OptionStockNumber | Stock Number of Vehicle Option | Optional | |
Manufacturer | Manufacturer of Vehicle Option | Optional |
Super-types: | xsd:decimal < Amount (by extension) < OptionCost (by extension) |
---|---|
Sub-types: | None |
Name | OptionCost |
---|---|
Abstract | no |
Documentation | Actual Dealer cost of option More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < OptionMSRP (by extension) |
---|---|
Sub-types: | None |
Name | OptionMSRP |
---|---|
Abstract | no |
Documentation | Option MSRP More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < OptionPackageId (by extension) |
---|---|
Sub-types: | None |
Name | OptionPackageId |
---|---|
Abstract | no |
Documentation | Option 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. |
Super-types: | xsd:decimal < Amount (by extension) < OptionPrice (by extension) |
---|---|
Sub-types: | None |
Name | OptionPrice |
---|---|
Abstract | no |
Documentation | Price of Vehicle Option More information at: http://www.starstandard.org. |
Super-types: | xsd:string < CodeType (by extension) < OptionType (by extension) |
---|---|
Sub-types: | None |
Name | OptionType |
---|---|
Abstract | no |
Documentation | Option Type from an OEM or other sources list of codes. More information at: http://www.starstandard.org. |
Super-types: | AddressBase < OrganizationAddress (by extension) |
---|---|
Sub-types: | None |
Name | OrganizationAddress |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
AddressLine | Indicates the multiple lines of an address. The first line is typically the street name and number. | Required | |
City | Is the City of the Address. | Required | |
County | County in which the Address is in. | Optional | |
StateOrProvince | Is the State or Province of a given Address. | Required | |
Country | Country in which the Address is in. | Required | |
PostalCode | Postal Code of the Address. | Required | |
UrbanizationCode | Geographic definition of a metropolitan or suburban area | Optional |
Super-types: | PartyBase < OrganizationPartyBase (by extension) < OrganizationalOwnerParty (by extension) < OrganizationalOwnerPartyExtended (by extension) < OrganizationalBuyerParty (by extension) |
---|---|
Sub-types: |
|
Name | OrganizationalBuyerParty |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Alternate organizational party Identification | Optional |
Values: LegalId, NationalId, DUNS, Other
|
Name | Company name of organizational party | Optional | |
Address | Organizational Party address | Optional | |
DBAName | Doing Business As name. | Optional | |
Contact | Organizational Party contact information | Optional | |
RelationshipCode | Indicates the Business PartyâÂÂs relationship to the primary Party (e.g., mother, father, husband, etc.)l | Optional | |
MarketingMailInd | Indicates customers whom have requested no marketing mail | Optional | |
PrimaryDriverInd | Identifies customer as primary driver | Optional | |
DriverAction | Driver action (Ex: Drop-Off, Pick-Up, etc) | Optional | |
Privacy | Organization privacy options | Optional | |
DMSCustomerId | The DMS system assigned number associated with a customer entity | Optional |
Super-types: | PartyBase < OrganizationPartyBase (by extension) < OrganizationalOwnerParty (by extension) < OrganizationalOwnerPartyExtended (by extension) < OrganizationalBuyerParty (by extension) < OrganizationalBuyerPartyExtended (by extension) |
---|---|
Sub-types: | None |
Name | OrganizationalBuyerPartyExtended |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Alternate organizational party Identification | Optional |
Values: LegalId, NationalId, DUNS, Other
|
Name | Company name of organizational party | Optional | |
Address | Organizational Party address | Optional | |
DBAName | Doing Business As name. | Optional | |
Contact | Organizational Party contact information | Optional | |
RelationshipCode | Indicates the Business PartyâÂÂs relationship to the primary Party (e.g., mother, father, husband, etc.)l | Optional | |
MarketingMailInd | Indicates customers whom have requested no marketing mail | Optional | |
PrimaryDriverInd | Identifies customer as primary driver | Optional | |
DriverAction | Driver action (Ex: Drop-Off, Pick-Up, etc) | Optional | |
Privacy | Organization privacy options | Optional | |
DMSCustomerId | The DMS system assigned number associated with a customer entity | Optional | |
AuthorizationNumber | Buyers are assigned an Authorization Number if employee purchase or preferred vendor | Optional |
Super-types: | PartyBase < OrganizationPartyBase (by extension) < OrganizationalOwnerParty (by extension) |
---|---|
Sub-types: |
|
Name | OrganizationalOwnerParty |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Alternate organizational party Identification | Optional |
Values: LegalId, NationalId, DUNS, Other
|
Name | Company name of organizational party | Optional | |
Address | Organizational Party address | Optional | |
DBAName | Doing Business As name. | Optional | |
Contact | Organizational Party contact information | Optional | |
RelationshipCode | Indicates the Business PartyâÂÂs relationship to the primary Party (e.g., mother, father, husband, etc.)l | Optional |
Super-types: | PartyBase < OrganizationPartyBase (by extension) < OrganizationalOwnerParty (by extension) < OrganizationalOwnerPartyExtended (by extension) |
---|---|
Sub-types: |
|
Name | OrganizationalOwnerPartyExtended |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Alternate organizational party Identification | Optional |
Values: LegalId, NationalId, DUNS, Other
|
Name | Company name of organizational party | Optional | |
Address | Organizational Party address | Optional | |
DBAName | Doing Business As name. | Optional | |
Contact | Organizational Party contact information | Optional | |
RelationshipCode | Indicates the Business PartyâÂÂs relationship to the primary Party (e.g., mother, father, husband, etc.)l | Optional | |
MarketingMailInd | Indicates customers whom have requested no marketing mail | Optional | |
PrimaryDriverInd | Identifies customer as primary driver | Optional | |
DriverAction | Driver action (Ex: Drop-Off, Pick-Up, etc) | Optional |
Super-types: | AlternatePartyId < OrganizationalPartyAlternatePartyId (by extension) |
---|---|
Sub-types: | None |
Name | OrganizationalPartyAlternatePartyId |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Id | Alternate Party Identification | Required | |
AssigningPartyId | Agency or entity that validates the Party Id | Required | |
IssuingState | Indicates that State where the license was issued. | Optional | |
ExpirationDate | Expiration date of the alternate party id (e.g., Driver's License expiration date). | Optional | In YYYY-MM-DD format. |
Super-types: | None |
---|---|
Sub-types: |
|
Name | OrganizationContact |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PersonName | Contact name | Optional | |
Telephone | Contact telephone numbers | Optional | |
EMailAddress | Contact Email address | Optional | |
Fax | Contact Fax number | Optional | |
PreferredContactMethod | Preferred contact method | Optional | |
ContactTime | Preferred contact time (i.e. Best day/time to reach the contact. | Optional |
Super-types: | OrganizationContact < OrganizationContactExtended (by extension) |
---|---|
Sub-types: | None |
Name | OrganizationContactExtended |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PersonName | Contact name | Optional | |
Telephone | Contact telephone numbers | Optional | |
EMailAddress | Contact Email address | Optional | |
Fax | Contact Fax number | Optional | |
PreferredContactMethod | Preferred contact method | Optional | |
ContactTime | Preferred contact time (i.e. Best day/time to reach the contact. | Optional | |
PreferredLanguage | Organization's preferred language | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | OrganizationContactPersonName |
---|---|
Abstract | no |
Documentation | Derived from oa:PersonName More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
GivenName | First Name of business party | Required | |
FamilyName | Last Name of business party | Required | |
FormattedName | Full Name of business party. Format for name should be "First Last" with no commas between first and last name | Optional |
Super-types: | PartyBase < OrganizationPartyBase (by extension) |
---|---|
Sub-types: |
|
Name | OrganizationPartyBase |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Alternate organizational party Identification | Optional |
Values: LegalId, NationalId, DUNS, Other
|
Name | Company name of organizational party | Optional | |
Address | Organizational Party address | Optional | |
DBAName | Doing Business As name. | Optional |
Super-types: | xsd:string < OrganizationPartyEmail (by extension) |
---|---|
Sub-types: | None |
Name | OrganizationPartyEmail |
---|---|
Abstract | no |
Documentation | Organization email More information at: http://www.starstandard.org. |
Super-types: | xsd:string < OrganizationPartyFax (by extension) |
---|---|
Sub-types: | None |
Name | OrganizationPartyFax |
---|---|
Abstract | no |
Documentation | OrganizationFax number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < OrganizationPartyTelephone (by extension) |
---|---|
Sub-types: | None |
Name | OrganizationPartyTelephone |
---|---|
Abstract | no |
Documentation | OrganizationParty telephone number More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
desc | Required | ||
exten | Required |
Super-types: | None |
---|---|
Sub-types: |
|
Name | PartyBase |
---|---|
Abstract | no |
Documentation | Derived from oa:Party More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional |
Super-types: | xsd:string < Id (by extension) < PartyId (by extension) |
---|---|
Sub-types: | None |
Name | PartyId |
---|---|
Abstract | no |
Documentation | Party Identification Number More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < PaymentAmount (by extension) |
---|---|
Sub-types: | None |
Name | PaymentAmount |
---|---|
Abstract | no |
Documentation | Monthly Payment Amount More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Percent (by extension) |
---|---|
Sub-types: | None |
Name | Percent |
---|---|
Abstract | no |
Documentation | Percent More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < PlanBasePrice (by extension) |
---|---|
Sub-types: | None |
Name | PlanBasePrice |
---|---|
Abstract | no |
Documentation | The base cost on the contract without options. More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < PlanOptionPrice (by extension) |
---|---|
Sub-types: | None |
Name | PlanOptionPrice |
---|---|
Abstract | no |
Documentation | The suggested sale price of the plan option. More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: | None |
Name | Privacy |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PrivacyInd | Indicator to note that Business Party has requested to share or to not share information with third parties | Optional |
Values: 1 - Can share information with third
parties. 0 - Cannot share information with third
parties.
Values: 0 - Cannot share information with third
parties. 1 - Can share information with third
parties.
|
PrivacyType | Code identifying a Party's authorized privacy rights. (i.e., Financial, Demographics, etc.) | Optional |
Super-types: | Verb < ConfirmableVerb (by extension) < ActionVerb (by extension) < AcknowledgableVerb (by extension) < Process (by extension) |
---|---|
Sub-types: | None |
Name | Process |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Verb | Required | ||
Criteria | Optional |
Super-types: | BusinessObjectDocument < ProcessRetailDeliveryReporting (by extension) |
---|---|
Sub-types: | None |
Name | ProcessRetailDeliveryReporting |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
ApplicationArea | Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of. | Required | |
DataArea | Required |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ProcessRetailDeliveryReportingDataArea |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Process | The Process verb is used to request processing of the associated noun by the receiving application or business to party. In a typical external exchange scenario a Process BOD is considered to be a legally binding message. For example, if a customer sends a ProcessPurchaseOrder BOD to a supplier and the supplier acknowlegdes with a positive AcknowledgePurchaseOrder, then the customer is obligated to fullfil the agreement, unless of course other BODs are allowed to cancel or change the original order. | Required | |
RetailDeliveryReporting | Required |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ProgramsAndRates |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
NetAnnualPercentageRate | The rate charged to the dealer | Optional | |
SubventionCode | Identifies a subvention program. | Optional | |
BalloonResidualPercentage | The estimated percent of value at contract end. | Optional | |
BalloonResidualAmount | The estimated amount of the vehicle at contract end. | Optional | |
SpecialPrograms | Code identifying the type of special program (First Time Buyer, College Graduate, etc. | Optional | |
UpfrontMiles | The number of miles purchased at contract commencement | Optional | |
UpfrontMileageRate | The amount charged for miles purchased upfront | Optional | |
UpfrontMilesAmount | UpfrontMiles multiplied by the UpfrontMileageRate | Optional | |
Coupon | Coupons associated with Programs and Rates | Optional | |
FinalPaymentDate | Date that the final payment amount is due (e.g., Ballon, Fixed Value, Lease, etc.) | Optional | |
ContractTermMileage | Mileage allowed under the terms of contract | Optional | |
FinancePlan | Description of standard finance plan applied to deal. | Optional | |
InitiativeId | Initiative Identification (i.e., Manufacturer incentive reimbursement program identification or dealer offerings) | Optional | |
SpecialProgramDetail | Represents information related to the types of lending programs being applied to the deal. EX: College Graduate, 1st Time Buyer, Repeat Customer, Manufacturer Programs, etc. | Optional | |
LeaseBuyMoneyFactor | Lease Rate/Service Factor offered to the dealer by Finance Source. | Optional | |
LowMileageOption | Indicates whether a customer chooses low mileage. | Optional | |
DiscountRate | The rate/service factor being discounted off the net lease rate due to lease being a single pay lease or some other special program. | Optional | |
IncentivesForCashCustomerAmt | Incentives available to ONLY cash customers. | Optional | |
OriginalLeaseRateMoneyFactor | The original lease factor before the discount rate for single payment. | Optional | |
BaseInterestRate | The base interest rate before any pre-paid interest or additional costs of financing. | Optional | |
PreApprovedProgramName | A text description of pre-approval codes. | Optional |
Super-types: | xsd:decimal < Amount (by extension) < PurchaseNetPrice (by extension) |
---|---|
Sub-types: | None |
Name | PurchaseNetPrice |
---|---|
Abstract | no |
Documentation | The total amount paid by the customer net of taxes. More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < PurchasePrice (by extension) |
---|---|
Sub-types: | None |
Name | PurchasePrice |
---|---|
Abstract | no |
Documentation | Purchase Price or Gross Cap cost specified in deal. Total payments at end of purchase More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Rating (by extension) |
---|---|
Sub-types: | None |
Name | Rating |
---|---|
Abstract | no |
Documentation | Standing or position on a scale, e.g. credit score. More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
score | Optional |
Super-types: | xsd:string < Rating (by extension) < RatingIndex (by extension) |
---|---|
Sub-types: | None |
Name | RatingIndex |
---|---|
Abstract | no |
Documentation | Rating Index Used for Credit Approval More information at: http://www.starstandard.org. |
Super-types: | PartyBase < DealerPartyBase (by extension) < DealerExtendedAddress (by extension) < RDRDealerExtendedAddress (by extension) |
---|---|
Sub-types: | None |
Name | RDRDealerExtendedAddress |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
DealerName | Dealer name | Optional | |
DistrictCode | Manufacturer Assigned District Code | Optional | |
URI | Dealer URI | Optional | |
ZoneCode | Manufacturer Assigned Zone Code | Optional | |
Address | Dealer party address | Optional | |
MarketCode | A market code that designates the market area. | Optional |
Super-types: | xsd:string < StateOrProvince (by restriction) < RegistrationState (by extension) |
---|---|
Sub-types: | None |
Name | RegistrationState |
---|---|
Abstract | no |
Documentation | State or province of vehicle registration More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < ReimbursementAmount (by extension) |
---|---|
Sub-types: | None |
Name | ReimbursementAmount |
---|---|
Abstract | no |
Documentation | Amount returned to payee More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < ReimbursementId (by extension) |
---|---|
Sub-types: | None |
Name | ReimbursementId |
---|---|
Abstract | no |
Documentation | Reimbursement certificate or coupon identification More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < RentalAllowance (by extension) |
---|---|
Sub-types: | None |
Name | RentalAllowance |
---|---|
Abstract | no |
Documentation | Limit for Rental Allowance per day More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < ResidualAmount (by extension) |
---|---|
Sub-types: | None |
Name | ResidualAmount |
---|---|
Abstract | no |
Documentation | Remaining residual on current vehicle More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Description (by extension) < RestrictionDescription (by extension) |
---|---|
Sub-types: | None |
Name | RestrictionDescription |
---|---|
Abstract | no |
Documentation | Description of vehicle use restrictions More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: | None |
Name | RetailDeliveryReporting |
---|---|
Abstract | no |
Documentation | STAR Version 3.0 - Draft More information at: http://www.starstandards.org. STAR Version 2.1, STAR approved 04/20/2005; effective date 07/04/2005 More information at: http://www.starstandards.org. STAR Version 2.0, STAR approved 05/07/2004; effective date 07/04/2004 More information at: http://www.starstandards.org. STAR Version 1.1 STAR approved 04/09/2003; OAGI approved 3/15/2003 effective date 07/04/2003 More information at: http://www.starstandards.org. STAR Version 1.0 STAR approved 11/22/2002; OAGI reviewed 11/08/2002; effective date 01/01/2003 More information at: http://www.starstandards.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Header | Required | ||
Vehicle | Optional |
Super-types: | HeaderBase < RetailDeliveryReportingHeader (by extension) |
---|---|
Sub-types: | None |
Name | RetailDeliveryReportingHeader |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
DocumentDateTime | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. | Optional |
DateTime fields must be formatted as XML Schema
DateTimes in UTC/GMT format without offsets.
Example: 2003-11-05T13:15:30Z
|
SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | |
SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional | |
DocumentId | Dealer or DMS assigned deal number | Optional | |
SalesDate | Date sales paperwork signed | Optional | In YYYY-MM-DD format. |
DealerTransferDate | Date transferred to retailing dealer | Optional | In YYYY-MM-DD format. |
AcquisitionMethod | Indicates the way the vehicle was acquired by retailer | Optional | |
SaleCategory | Category of sale code - EX: Retail, Fleet, Lease, Demo, Transfer, Certified used, Used, Select, Export, etc. | Optional | |
SaleSubCategory | Code to extend the category of sale - EX: Standard APR, Special APR, Standard Lease, Special Lease, etc | Optional | |
TransferringDealer | business party (dealer) that is transferring the vehicle | Optional | |
SalesPerson | SalesPerson(s) of the vehicle sale being reported | Optional | |
SalesManager | Sales Manager of the vehicle sale being reported | Optional | |
FIManager | F and I Manager of the vehicle sale being reported | Optional | |
SellingSource | Code to determine souce brand of sale (i.e., OEM division | Optional | |
IndividualBuyer | Business Party who purchased the vehicle | Optional | |
OrganizationalBuyer | Organizational Business Party who purchased the vehicle | Optional | |
IndividualCo-Buyer | Business Party who co-purchased the vehicle | Optional | |
OrganizationalCo-Buyer | rganizational Business Party who co-purchased the vehicle | Optional | |
PrimaryDriver | Primary driver of vehicle | Optional | |
SecondaryDriver | Secondary driver of vehicle | Optional | |
Financing | information on the financing of the vehicle(s). | Optional | |
TradeIn | information on the vehicle(s) Traded In | Optional | |
LocationId | Code identifying the physical location of a dealer. | Optional |
Super-types: | PartyBase < SalesPersonParty (by extension) < SalesPersonAddress (by extension) |
---|---|
Sub-types: | None |
Name | SalesPersonAddress |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Social security number or other legal document Id of salesperson | Optional | |
Name | Person's name | Optional |
Name should be 'First Last' with no commas between
first and last name.
|
Address | Organizational Party address | Optional |
Super-types: | PartyBase < SalesPersonParty (by extension) |
---|---|
Sub-types: |
|
Name | SalesPersonParty |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Social security number or other legal document Id of salesperson | Optional | |
Name | Person's name | Optional |
Name should be 'First Last' with no commas between
first and last name.
|
Super-types: | xsd:string < Id (by extension) < SecondaryDealerNumber (by extension) |
---|---|
Sub-types: | None |
Name | SecondaryDealerNumber |
---|---|
Abstract | no |
Documentation | Identifies secondary dealer number if different than primary "Dealer Number" More information at: http://www.starstandard.org. |
Super-types: | SenderBase < Sender (by extension) |
---|---|
Sub-types: | None |
Name | Sender |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
LogicalId | Provides the logical location of the server and applications from which the Business Object Document originated. It can be used to establish a logical to physical mapping, however its use is optional. Each system or combination of systems should maintain an external central reference table containing the logical names or logical addresses of the application systems in the integration configuration. This enables the logical names to be mapped to the physical network addresses of the resources needed on the network. Note: The technical implementation of this Domain Naming Service is not dictated by this specification. This logical to physical mapping may be done at execution time by the application itself or by a middleware transport mechanism, depending on the integration architecture used. This provides for a simple but effective directory access capability while maintaining application independence from the physical location of those resources on the network | Optional | |
Component | Provides a finer level of control than Logical Identifier and represents the business application that issued the Business Object Document. Its use is optional. For STAR's use this is the DCS Software code name | Required | |
Task | Describes the business event that initiated the need for the Business Object Document to be created. For STAR, the task is defined in the Implementation Guidelines for each BOD. It is usually a short description of the BOD. Ex: SalesLead, CreditDecision, etc. | Required | |
ReferenceId | Enables the sending application to indicate the instance identifier of the event or task that caused the BOD to be created. This is used to correlate a response BOD to an originating BOD | Optional | |
AuthorizationId | Identifyies the authorization level of the user or application that is sending the Business Object Document Message. This authorization level being recognized be the receiving system indicates what can be done on the receiving system. For STAR, this is the User ID. | Optional | |
CreatorNameCode | DCS Software Creator Code | Required | |
SenderNameCode | Additional information about the sending platform (i.e., Short MFG or DSP code). | Required |
Must use a valid code from the ShortMfg/RSP list on
http://www.starstandards.org
|
SenderURI | Physical address of the sender | Optional | |
DealerNumber | Dealer Code of source of information | Optional | |
StoreNumber | Dealer code store number (DMS assigned) | Optional | |
AreaNumber | Dealer code area number (DMS vendor assigned) | Optional | |
DealerCountry | Source Dealer country location | Optional | |
Language | This code is used to define the language of the data used in this transaction | Optional | |
DeliverPendingMailInd | Indicates if the user requests to receive pending mail that has been stored and has yet not been delivered yet. By selecting 0, the user will only receive the response for the current transaction the user is performing. | Optional |
1 - Receive Pending Mail. 0 - Do not receive pending
mail.
|
Password | Token for application specific authentication. Used to authenticate dealership/users through application specific security | Optional | |
SystemVersion | The sender's software version number. | Optional | |
PartyId | The Party Id field uniquely identifies the Sender 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 | |
LocationId | The Location Id field uniquely identifies the location of the Sender 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 | |
ServiceId | The Service Id field identifies the particular service from which a message is being sent, e.g., an inventory service. | Optional |
Super-types: | None |
---|---|
Sub-types: |
|
Name | SenderBase |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
LogicalId | Provides the logical location of the server and applications from which the Business Object Document originated. It can be used to establish a logical to physical mapping, however its use is optional. Each system or combination of systems should maintain an external central reference table containing the logical names or logical addresses of the application systems in the integration configuration. This enables the logical names to be mapped to the physical network addresses of the resources needed on the network. Note: The technical implementation of this Domain Naming Service is not dictated by this specification. This logical to physical mapping may be done at execution time by the application itself or by a middleware transport mechanism, depending on the integration architecture used. This provides for a simple but effective directory access capability while maintaining application independence from the physical location of those resources on the network | Optional | |
Component | Provides a finer level of control than Logical Identifier and represents the business application that issued the Business Object Document. Its use is optional. For STAR's use this is the DCS Software code name | Required | |
Task | Describes the business event that initiated the need for the Business Object Document to be created. For STAR, the task is defined in the Implementation Guidelines for each BOD. It is usually a short description of the BOD. Ex: SalesLead, CreditDecision, etc. | Required | |
ReferenceId | Enables the sending application to indicate the instance identifier of the event or task that caused the BOD to be created. This is used to correlate a response BOD to an originating BOD | Optional | |
AuthorizationId | Identifyies the authorization level of the user or application that is sending the Business Object Document Message. This authorization level being recognized be the receiving system indicates what can be done on the receiving system. For STAR, this is the User ID. | Optional |
Super-types: | None |
---|---|
Sub-types: |
|
Name | ServiceContractBase |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
ContractCompanyName | Service contract company name | Optional | |
ContractId | Identification of Service Contract | Optional | |
ContractPlanCode | Service Contract Plan Code | Optional | |
ContractType | Service contract type and/or area of coverage | Optional |
Examples: Aftermarket; OEM Prepaid
|
ContractPlanDescription | Description of service plan. Example: 36 MONTH/36000 MILE" | Optional | |
Term | Number of months in contract plan | Optional |
'length' attribute needs to be Months.
|
ContractStartDate | Service Contract sale Date | Optional | In YYYY-MM-DD format. |
ContractDeductible | Amount of Deductible at time of service Eg:$50.00 | Optional | |
ContractExpirationDate | Date the Service contract expires | Optional | In YYYY-MM-DD format. |
ContractStartMileage | Odometer reading when contract becomes effective | Optional |
Values on uom attribute: K - Kilometers, M - Miles.
|
ContractTermMileage | Mileage allowed under terms of service contract | Optional |
Values on uom attribute: K - Kilometers, M - Miles
|
ContractOwnerName | Name on service Contract (i.e., full name - First Last) | Optional |
Format should be 'First Last' with no commas between
first and last.
|
InsuranceCompanyName | Memo Field for carrier covering extended service contract | Optional | |
TotalContractAmount | Total amount of the service contract. | Optional | |
ContractNote | Free form comments that relate to the contract | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ServiceContractStatus |
---|---|
Abstract | no |
Documentation | Status of the service contract More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
StatusType | Defines the type of status that occured. | Optional | |
StatusCode | A code identifying the reason for a status message. | Optional | |
StatusText | Descriptive status text. | Optional |
Super-types: | xsd:string < Id (by extension) < ServiceId (by extension) |
---|---|
Sub-types: | None |
Name | ServiceId |
---|---|
Abstract | no |
Documentation | The Service Id field identifies the particular service to or from which a message is being sent, e.g., an inventory service. More information at: http://www.starstandard.org. |
Super-types: | PartyBase < TechnicianBase (by extension) < ServiceTechnician (by extension) |
---|---|
Sub-types: | None |
Name | ServiceTechnician |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Social security number or other legal document Id of technician | Optional |
Values: LegalId, NationalId, Other
|
TechnicianName | Name of technician assigned to RO | Optional |
Should be in 'First Last' with no commas between
first and last name.
|
TeamName | Team assigned to Repair Order | Optional | |
TechnicianSkillArea | Type of training required to perform the labor operation | Optional | |
TechnicianSkillLevel | Level of training required to perform the labor operation | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | Signature |
---|---|
Abstract | no |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
qualifyingAgency | Optional |
Field/Component | Description | Requirement | Business Rules |
---|
Super-types: | NewFinancing < SoldFinancing (by extension) |
---|---|
Sub-types: | None |
Name | SoldFinancing |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
FinanceType | Type of financing Examples may be F- Finance, L - Lease, C-Cash, 1-Retail, 2-Lease, 3-Balloon, etc.. | Optional | |
PaymentAmount | Monthly Payment Amount | Optional | |
BalanceAmount | Remaining balance on Current Vehicle | Optional | |
FinalAmount | Last month payment amount | Optional | |
ResidualAmount | Remaining residual on current vehicle | Optional | |
Term | Number of months of contract term | Optional | |
MaturityDate | Month and year of contract maturity | Optional | |
FinanceCompanyName | Name of Finance Company | Optional | |
DownPaymentAmount | Down Payment amount or amount of cap cost reduction. | Optional | |
PurchasePrice | Purchase Price or Gross Cap cost specified in deal. Total payments at end of purchase | Optional | |
ApprovedInd | Approved Indicator | Optional |
Values: 0 - Not Pre-Approved. 1 - Pre-Approved.
|
ApprovedAmount | Amount pre-approved | Optional | |
ExpirationDate | Date pre-approval expires | Optional | |
RatingIndex | Rating Index Used for Credit Approval | Optional | |
MiscellaneousNotes | Free form miscellaneous comments. | Optional | |
AnnualPercentageRate | Annual percentage rate. | Optional | |
FleetAccount | Lessor Fleet Account number indicating that this is a Fleet Transaction | Optional | |
PromotionalRateInd | Promotional lease rate was used | Optional | |
Tax | Financing taxes | Optional | |
ProgramsAndRates | Programs And Rates associated with Financing | Optional | |
LienholderParty | Vehicle Lienholder | Optional | |
Address | Finance organization address | Optional | |
Contact | Finance organization contact information | Optional |
Super-types: | ServiceContractBase < FullServiceContract (by extension) < SoldServiceContract (by extension) |
---|---|
Sub-types: | None |
Name | SoldServiceContract |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
ContractCompanyName | Service contract company name | Optional | |
ContractId | Identification of Service Contract | Optional | |
ContractPlanCode | Service Contract Plan Code | Optional | |
ContractType | Service contract type and/or area of coverage | Optional |
Examples: Aftermarket; OEM Prepaid
|
ContractPlanDescription | Description of service plan. Example: 36 MONTH/36000 MILE" | Optional | |
Term | Number of months in contract plan | Optional |
'length' attribute needs to be Months.
|
ContractStartDate | Service Contract sale Date | Optional | In YYYY-MM-DD format. |
ContractDeductible | Amount of Deductible at time of service Eg:$50.00 | Optional | |
ContractExpirationDate | Date the Service contract expires | Optional | In YYYY-MM-DD format. |
ContractStartMileage | Odometer reading when contract becomes effective | Optional |
Values on uom attribute: K - Kilometers, M - Miles.
|
ContractTermMileage | Mileage allowed under terms of service contract | Optional |
Values on uom attribute: K - Kilometers, M - Miles
|
ContractOwnerName | Name on service Contract (i.e., full name - First Last) | Optional |
Format should be 'First Last' with no commas between
first and last.
|
InsuranceCompanyName | Memo Field for carrier covering extended service contract | Optional | |
TotalContractAmount | Total amount of the service contract. | Optional | |
ContractNote | Free form comments that relate to the contract | Optional | |
ContractEffectiveDate | Start Date of Service Contract | Optional | In YYYY-MM-DD format. |
ContractPlanStates | States where the plan is valid | Optional |
May occur multiple times.
|
ContractTransferInd | Indicates if the contract is transferable | Optional |
Values: 1 - Yes, 0 - No.
|
ContractTransferredInd | Indicates if the contract has been transferred | Optional |
Values: 1 - Yes, 0 - No.
|
ContractTripInterruptInd | Indicates if the contract allows for trip interruption | Optional | |
LoanerVehicleInd | Service contract loaner vehicle indicator | Optional | |
RoadsideAssistanceInd | Indicates whether coverage includes roadside assistance | Optional |
Values: 1 - Yes, 0 - No.
|
RoadHazardInd | Indicates whether Roadside hazard is covered in the contract | Optional |
Values: 1 - Yes, 0 - No.
|
FirstDayRentalInd | If first day rental for service is covered in contract | Optional |
Values: 1 - Yes, 0 - No.
|
RentalAllowance | Limit for Rental Allowance per day | Optional | |
MaximumRentalAmount | Max Rental Allowance per occurrence | Optional | |
TowingAllowance | Amount allowed for towing of RENTAL car | Optional | |
ServiceContractSalesPerson | SalesPerson of the Service Contract | Optional | |
CoverageCode | Identifies Service Contract coverage beyond plan code and contract type | Optional | |
LienholderParty | Name of the organization with lien on vehicle | Optional | |
NoChargeInd | Indicates customer was not charged for the service contract. | Optional |
Values: 1 - Yes, 0 - No.
|
OriginalInServiceDate | The date a used vehicle went in service | Optional | In YYYY-MM-DD format. |
ContractLienInd | Indicates the vehicle has a lien or the service contract was financed | Optional | |
EmployeeDiscountInd | Indicates if this registration should apply OEM Employee discount | Optional |
Values: 1 - Yes, 0 - No.
|
Tax | Tax calculations | Optional | |
ContractLanguageCode | Language code indicating contract language. Contract language could be different from message language. | Optional | |
DownPaymentAmount | Amount buyer puts down when purchasing contract. | Optional | |
ContractInstallments | Number of months of payments (ex. 1, 5, 11, 17) | Optional | |
PaymentMethod | Method of payment. | Optional | |
ContractExpirationDistance | The odometer reading (distance) of the vehicle when the service contract expires. | Optional |
Value on uom attribute: K - Kilometers, M - Miles.
|
ContractPlanOption | The contract plan options. | Optional | |
PlanBasePrice | The base cost of the contract without options. | Optional | |
TotalPlanOptionPrice | The sum of all Plan Option prices. | Optional | |
PurchaseNetPrice | The total amount paid by the customer net of taxes. | Optional | |
TotalDealerAmount | Total amount paid by the dealer to the external supplier including tax (i.e., dealer cost). | Optional | |
ContractRegistrationDate | The day the contract is registered in the originating system. (Ex. The database system). | Optional | In YYYY-MM-DD format. |
ServiceContractStatus | The status of the Service Contract. | Optional |
Super-types: | Vehicle < VehicleBase (by extension) < ExpandedVehicle (by extension) < SoldVehicle (by extension) |
---|---|
Sub-types: | None |
Name | SoldVehicle |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Model | Manufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) | Optional | |
ModelYear | Vehicle designated model year | Optional | |
ModelDescription | Descriptive vehicle model name | Optional | |
Make | Vehicle make code - Usually available in the VIN number (use NCIC code). | Optional | |
SaleClass | Class of Sale | Optional | |
Condition | Condition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown | Optional | |
CertifiedPreownedInd | Identifies as a certified Pre-Owned Vehicle | Optional | |
VehicleNote | Any vehicle related notes | Optional | |
VIN | Federally defined 17 position vehicle identification number | Optional | |
DeliveryMileage | Odometer reading of vehicle at time of delivery | Optional |
Values on uom attribute: K - Kilometers, M - Miles
|
VehicleStock | Dealer assigned vehicle stock number | Optional | |
TrimCode | Manufacturer assigned trim code | Optional | |
DoorsQuantity | Number of doors on vehicle | Optional | |
BodyStyle | Manufacturer-assigned vehicle body style | Optional | |
InteriorColor | Vehicle Interior Color(s) | Optional |
May occur multiple times.
|
ExteriorColor | Vehicle Exterior Color(s) | Optional |
May occur multiple times.
|
TransmissionType | Vehicle Transmission type | Optional |
Values: 3 - 3 speed, 4 - 4 speed, 5 - 5 speed, 6 - 6
speed, A - Automatic
|
OdometerStatus | Status of odometer at trade-in. Example:: Replaced, Tampered, Miles> 90,000, etc. | Optional | |
NonUSVehicleInd | Indicates 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.
|
VehicleDemoInd | Indicates whether vehicle was ever a demo | Optional |
Values: 0 - Was or is not a demo. 1 - Was or is a
demo.
|
LicenseNumber | State License plate number of vehicle | Optional | |
BrandedInfo | Vehicle Branding Information | Optional | |
RestrictionInd | Indication that vehicle has restrictions on its use | Optional |
Values: 1 - Yes, 0 - No.
|
RestrictionDescription | Description of vehicle use restrictions | Optional | |
TelematicsServiceInd | Indication whether Telematics Service Subscription is turned on | Optional | |
Option | Vehicle Options | Optional | |
TransmissionCode | Transmission Serial Number | Optional | |
DeliveryDate | The date of original retail vehicle sale | Optional | In YYYY-MM-DD format. |
EngineNumber | Serial number of the engine if vehicle not made for US sale | Optional | |
IgnitionKeyNumber | Vehicle Ignition Key Number | Optional | |
AxleCode | The code on the axle of the vehicle. | Optional | |
FleetAccount | Manufacturer defined fleet account number | Optional | |
FleetVehicleId | Uniquely identifies the vehicle as part of a fleet company | Optional | |
FleetPurchaseOrderNumber | Fleet Purchase Order Number vehicle was purchased under | Optional | |
DoorKeyNumber | Door key number | Optional | |
VehicleWeight | Vehicle weight | Optional | |
ExteriorColorCode | Vehicle exterior color code | Optional | |
InteriorColorCode | Vehicle Interior color code | Optional | |
PDIDate | Date Pre-Delivery Inspection completed at dealership | Optional | |
RegistrationState | State or province of vehicle registration | Optional | |
SecurityCode | Vehicle security code for entry or backup security | Optional | |
Warranty | represents information about the OEM warranty on the vehicle | Optional | |
ServiceContract | Service Contract | Optional | |
PDITechnician | Pre-Delivery Inspection Technician | Optional | |
MarketingInitiatives | Marketing Initiatives | Optional | |
Tire | Represents information regarding the vehicleâÂÂs tires | Optional | |
EngineDisplacement | Displacement of engine (i.e., amount of volume in the cylinders) | Optional | |
EngineDescription | Description of engine (e.g., 32 valves, hybrid, electronic, diesel, etc.) | Optional | |
CommercialUsageInd | Indicates that the vehicles is used for commercial purposes. | Optional |
Values: 1 - Yes, 0 - No.
|
Super-types: | xsd:string < Description (by extension) < SpecialProgramDescription (by extension) |
---|---|
Sub-types: | None |
Name | SpecialProgramDescription |
---|---|
Abstract | no |
Documentation | The description of the special program (First Time Buyer, College Graduate, etc.) being applied to the deal. More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: | None |
Name | SpecialProgramDetail |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
SpecialProgramDescription | The description of the special program (First Time Buyer, College Graduate, etc.) being applied to the deal. | Optional | |
SpecialPrograms | Code identifying the special program (First Time Buyer, College Graduate, etc.) being applied to the deal. | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | Tax |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
TaxType | Identifies the type tax. | Required | |
TaxDescription | Free form text description of tax amount. | Optional | |
TaxAmount | Actual amount of tax paid. | Optional | |
UnitSalesTaxAmount | Unit amount of sales tax. | Optional | |
TaxRate | Tax Percentage Rate | Optional | |
TotalTaxableAmount | Total taxble price | Optional | |
NonTaxableAmount | Total non-taxble price | Optional | |
TaxTypeId | Tax type identification | Optional |
Values: CS – City, CP – County, ST – State, OT –
Other, GST- Goods and Services tax, EX – Excise, VAT
– VAT, PST - Provincial Sales Tax, RT – Rental, Tax
HST - Harmonized Tax, ART - Air Tax, QST - Quebec
Sales Tax
|
TaxabilityInd | Determines whether the dealer wants to claim tax on the cost. | Optional |
Super-types: | xsd:decimal < Amount (by extension) < TaxAmount (by extension) |
---|---|
Sub-types: | None |
Name | TaxAmount |
---|---|
Abstract | no |
Documentation | Actual amount of tax paid. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Description (by extension) < TaxDescription (by extension) |
---|---|
Sub-types: | None |
Name | TaxDescription |
---|---|
Abstract | no |
Documentation | Free form text description of tax amount. More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Percent (by extension) < TaxRate (by extension) |
---|---|
Sub-types: | None |
Name | TaxRate |
---|---|
Abstract | no |
Documentation | Tax Percentage rate. More information at: http://www.starstandard.org. |
Super-types: | PartyBase < TechnicianBase (by extension) |
---|---|
Sub-types: |
|
Name | TechnicianBase |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
AlternatePartyIds | Social security number or other legal document Id of technician | Optional |
Values: LegalId, NationalId, Other
|
TechnicianName | Name of technician assigned to RO | Optional |
Should be in 'First Last' with no commas between
first and last name.
|
TeamName | Team assigned to Repair Order | Optional | |
TechnicianSkillArea | Type of training required to perform the labor operation | Optional | |
TechnicianSkillLevel | Level of training required to perform the labor operation | Optional |
Super-types: | xsd:integer < Count (by extension) < Term (by extension) |
---|---|
Sub-types: | None |
Name | Term |
---|---|
Abstract | no |
Documentation | Number of months of contract term More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
length | Required |
Super-types: | None |
---|---|
Sub-types: | None |
Name | Tire |
---|---|
Abstract | no |
Documentation | represents information regarding the vehicleâÂÂs tires More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Manufacturer | Tire manufacturer | Optional | |
TireSerialNumber | Tire Serial Number | Optional | |
TireLocation | Location of tire on vehicle (i.e., Front Passenger, Front Driver, Rear Passenger, etc) | Optional |
Super-types: | xsd:decimal < Amount (by extension) < TotalContractAmount (by extension) |
---|---|
Sub-types: | None |
Name | TotalContractAmount |
---|---|
Abstract | no |
Documentation | Total amount of the contract. More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < TotalDealerAmount (by extension) |
---|---|
Sub-types: | None |
Name | TotalDealerAmount |
---|---|
Abstract | no |
Documentation | Total amount paid by the dealer to the external supplier including tax (i.e., dealer cost). More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < TotalPlanOptionPrice (by extension) |
---|---|
Sub-types: | None |
Name | TotalPlanOptionPrice |
---|---|
Abstract | no |
Documentation | The sum of all the Plan Option prices. More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < TotalTaxableAmount (by extension) |
---|---|
Sub-types: | None |
Name | TotalTaxableAmount |
---|---|
Abstract | no |
Documentation | Total taxable price. More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < TowingAllowance (by extension) |
---|---|
Sub-types: | None |
Name | TowingAllowance |
---|---|
Abstract | no |
Documentation | towing alooowance More information at: http://www.starstandard.org. |
Super-types: | Vehicle < TradeIn (by extension) |
---|---|
Sub-types: | None |
Name | TradeIn |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Model | Manufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) | Optional | |
ModelYear | Vehicle designated model year | Optional | |
ModelDescription | Descriptive vehicle model name | Optional | |
Make | Vehicle make code - Usually available in the VIN number (use NCIC code). | Optional | |
VIN | VIN of trade in vehicle | Optional | |
ExteriorColor | Vehicle Exterior Color(s) | Optional | |
TradeInMileage | Odometer reading of vehicle at time of delivery | Optional |
Values on uom attribute: K - Kilometers, M - Miles.
|
Manufacturer | Manufacture of the trade-in | Optional | |
TradeInOffLeaseCode | Indicates if a vehicle is a trade-in or is coming off lease. Ex: T or O | Optional |
Super-types: | xsd:integer < Count (by extension) < Mileage (by extension) < TradeInMileage (by extension) |
---|---|
Sub-types: | None |
Name | TradeInMileage |
---|---|
Abstract | no |
Documentation | Odometer reading of vehicle at time of delivery More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < UnitSalesTaxAmount (by extension) |
---|---|
Sub-types: | None |
Name | UnitSalesTaxAmount |
---|---|
Abstract | no |
Documentation | Unit amount of sales tax. More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < UpfrontMileageRate (by extension) |
---|---|
Sub-types: | None |
Name | UpfrontMileageRate |
---|---|
Abstract | no |
Documentation | The amount of miles charged for miles purchased upfront. More information at: http://www.starstandard.org. |
Super-types: | xsd:integer < Count (by extension) < Mileage (by extension) < UpfrontMiles (by extension) |
---|---|
Sub-types: | None |
Name | UpfrontMiles |
---|---|
Abstract | no |
Documentation | The number of miles purchased at contract commencement More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < UpfrontMilesAmount (by extension) |
---|---|
Sub-types: | None |
Name | UpfrontMilesAmount |
---|---|
Abstract | no |
Documentation | UpfrontMiles multiplied by the UpfrontMileageRate. More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: |
|
Name | Vehicle |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Model | Manufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) | Optional | |
ModelYear | Vehicle designated model year | Optional | |
ModelDescription | Descriptive vehicle model name | Optional | |
Make | Vehicle make code - Usually available in the VIN number (use NCIC code). | Optional |
Super-types: | Vehicle < VehicleBase (by extension) |
---|---|
Sub-types: |
|
Name | VehicleBase |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Model | Manufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) | Optional | |
ModelYear | Vehicle designated model year | Optional | |
ModelDescription | Descriptive vehicle model name | Optional | |
Make | Vehicle make code - Usually available in the VIN number (use NCIC code). | Optional | |
SaleClass | Class of Sale | Optional | |
Condition | Condition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown | Optional | |
CertifiedPreownedInd | Identifies as a certified Pre-Owned Vehicle | Optional | |
VehicleNote | Any vehicle related notes | Optional | |
VIN | Federally defined 17 position vehicle identification number | Optional | |
DeliveryMileage | Odometer reading of vehicle at time of delivery | Optional |
Values on uom attribute: K - Kilometers, M - Miles
|
VehicleStock | Dealer assigned vehicle stock number | Optional | |
TrimCode | Manufacturer assigned trim code | Optional | |
DoorsQuantity | Number of doors on vehicle | Optional | |
BodyStyle | Manufacturer-assigned vehicle body style | Optional | |
InteriorColor | Vehicle Interior Color(s) | Optional |
May occur multiple times.
|
ExteriorColor | Vehicle Exterior Color(s) | Optional |
May occur multiple times.
|
TransmissionType | Vehicle Transmission type | Optional |
Values: 3 - 3 speed, 4 - 4 speed, 5 - 5 speed, 6 - 6
speed, A - Automatic
|
OdometerStatus | Status of odometer at trade-in. Example:: Replaced, Tampered, Miles> 90,000, etc. | Optional | |
NonUSVehicleInd | Indicates 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.
|
VehicleDemoInd | Indicates whether vehicle was ever a demo | Optional |
Values: 0 - Was or is not a demo. 1 - Was or is a
demo.
|
LicenseNumber | State License plate number of vehicle | Optional | |
BrandedInfo | Vehicle Branding Information | Optional | |
RestrictionInd | Indication that vehicle has restrictions on its use | Optional |
Values: 1 - Yes, 0 - No.
|
RestrictionDescription | Description of vehicle use restrictions | Optional | |
TelematicsServiceInd | Indication whether Telematics Service Subscription is turned on | Optional |
Super-types: | xsd:decimal < Measurement (by extension) < VehicleWeight (by extension) |
---|---|
Sub-types: | None |
Name | VehicleWeight |
---|---|
Abstract | no |
Documentation | Vehicle Weight More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: |
|
Name | Verb |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|
Super-types: | WarrantyBase < Warranty (by extension) |
---|---|
Sub-types: |
|
Name | Warranty |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
WarrantyStartMileage | Mileage at start date of vehicle warranty | Optional |
Values on uom attribute: K - Kilometers, M - Miles.
|
WarrantyEndMileage | Mileage limit for vehicle warranty coverage for warranty currently in force at time of repair | Optional |
Values on uom attribute: K - Kilometers, M - Miles.
|
WarrantyStartDate | Start date of vehicle warranty | Optional | In YYYY-MM-DD format. |
WarrantyExpirationDate | Last date of vehicle warranty coverage for warranty currently in force at time of repair | Optional | In YYYY-MM-DD format. |
RoadsideAssistanceInd | Indicates whether coverage includes roadside assistance | Optional |
Values: 1 - Yes, 0 - No.
|
MasterShieldInd | Indicates if vehicle is covered by the Master Shield Extended warranty | Optional |
Values: 1 - Yes, 0 - No.
|
WarrantyTransferInd | Indicates if warranty is transferable | Optional |
Values: 1 - Yes, 0 - No.
|
WarrantyTypeDescription | Description of type of warranty Example: Basic /Powertrain, etc. | Optional | |
WarrantyStatus | Whether warranty is still applicable | Optional | |
WarrantyRemaining | Defines how much warranty is left, either in time or miles | Optional | |
WarrantyNotes | Any Warranty related Notes | Optional |
Super-types: | WarrantyBase < Warranty (by extension) < WarrantyAdditional (by extension) |
---|---|
Sub-types: | None |
Name | WarrantyAdditional |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
WarrantyStartMileage | Mileage at start date of vehicle warranty | Optional |
Values on uom attribute: K - Kilometers, M - Miles.
|
WarrantyEndMileage | Mileage limit for vehicle warranty coverage for warranty currently in force at time of repair | Optional |
Values on uom attribute: K - Kilometers, M - Miles.
|
WarrantyStartDate | Start date of vehicle warranty | Optional | In YYYY-MM-DD format. |
WarrantyExpirationDate | Last date of vehicle warranty coverage for warranty currently in force at time of repair | Optional | In YYYY-MM-DD format. |
RoadsideAssistanceInd | Indicates whether coverage includes roadside assistance | Optional |
Values: 1 - Yes, 0 - No.
|
MasterShieldInd | Indicates if vehicle is covered by the Master Shield Extended warranty | Optional |
Values: 1 - Yes, 0 - No.
|
WarrantyTransferInd | Indicates if warranty is transferable | Optional |
Values: 1 - Yes, 0 - No.
|
WarrantyTypeDescription | Description of type of warranty Example: Basic /Powertrain, etc. | Optional | |
WarrantyStatus | Whether warranty is still applicable | Optional | |
WarrantyRemaining | Defines how much warranty is left, either in time or miles | Optional | |
WarrantyNotes | Any Warranty related Notes | Optional | |
ReceiptNumber | Numeric identifier found on the carrier's receipt when a vehicle is delivered to the dealer | Optional | |
DelayedInspectionCode | Explains why a vehicle cannot be initially inspected once it arrives at a dealer (ie: dealer closed, no one around to sign for vehicle) | Optional | |
VehicleArrivalDate | The date the original retail vehicle is delivered to a dealer. | Optional |
Super-types: | None |
---|---|
Sub-types: |
|
Name | WarrantyBase |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
WarrantyStartMileage | Mileage at start date of vehicle warranty | Optional |
Values on uom attribute: K - Kilometers, M - Miles.
|
WarrantyEndMileage | Mileage limit for vehicle warranty coverage for warranty currently in force at time of repair | Optional |
Values on uom attribute: K - Kilometers, M - Miles.
|
WarrantyStartDate | Start date of vehicle warranty | Optional | In YYYY-MM-DD format. |
WarrantyExpirationDate | Last date of vehicle warranty coverage for warranty currently in force at time of repair | Optional | In YYYY-MM-DD format. |
RoadsideAssistanceInd | Indicates whether coverage includes roadside assistance | Optional |
Values: 1 - Yes, 0 - No.
|
MasterShieldInd | Indicates if vehicle is covered by the Master Shield Extended warranty | Optional |
Values: 1 - Yes, 0 - No.
|
WarrantyTransferInd | Indicates if warranty is transferable | Optional |
Values: 1 - Yes, 0 - No.
|
WarrantyTypeDescription | Description of type of warranty Example: Basic /Powertrain, etc. | Optional | |
WarrantyStatus | Whether warranty is still applicable | Optional | |
WarrantyRemaining | Defines how much warranty is left, either in time or miles | Optional | |
WarrantyNotes | Any Warranty related Notes | Optional |
Super-types: | xsd:integer < Count (by extension) < Mileage (by extension) < WarrantyEndMileage (by extension) |
---|---|
Sub-types: | None |
Name | WarrantyEndMileage |
---|---|
Abstract | no |
Documentation | Mileage limit for vehicle warranty coverage for warranty currently in force at time of repair More information at: http://www.starstandard.org. |
Super-types: | xsd:integer < Count (by extension) < Mileage (by extension) < WarrantyStartMileage (by extension) |
---|---|
Sub-types: | None |
Name | WarrantyStartMileage |
---|---|
Abstract | no |
Documentation | Mileage at start Date of vehicle warranty More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Description (by extension) < WarrantyTypeDescription (by extension) |
---|---|
Sub-types: | None |
Name | WarrantyTypeDescription |
---|---|
Abstract | no |
Documentation | A code used to classify into coverage categories More information at: http://www.starstandard.org. |
Super-types: | xsd:gYearMonth < AccountingDate (by restriction) |
---|---|
Sub-types: |
|
Name | AccountingDate |
---|---|
Documentation | Month and year accounting date conforms to ISO 8601 format rules Ex: \d\d\d\d-\d\d More information at: http://www.starstandard.org. |
Super-types: | xsd:NMTOKEN < AcknowledgementType (by restriction) |
---|---|
Sub-types: | None |
Name | AcknowledgementType |
---|
Code Value | Description |
---|---|
Always | |
OnChange | |
Never |
Super-types: | xsd:string < Note (by restriction) < AcquisitionMethod (by restriction) |
---|---|
Sub-types: | None |
Name | AcquisitionMethod |
---|---|
Documentation | method of acquisition More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Action (by restriction) |
---|---|
Sub-types: | None |
Name | Action |
---|
Code Value | Description |
---|---|
Add | |
Delete | |
Change | |
Replace | |
A | |
D | |
C | |
R |
Super-types: | xsd:string < AddressLine (by restriction) |
---|---|
Sub-types: | None |
Name | AddressLine |
---|---|
Documentation | Indicates the multiple lines of an address. The first line is typically the street name and number. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < AddressQualifier (by restriction) |
---|---|
Sub-types: | None |
Name | AddressQualifier |
---|---|
Documentation | Address Qualifier More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
WorkAddress | Work Address |
SeasonalAddress | Seasonal Address |
DeliveryAddress | Delivery Address |
HomeAddress | Home Address |
PreviousAddress | Previous Address |
Other | Other |
Garage | Garage |
Billing | Billing |
NonSigningSpouseAddress | Non Signing Spouse Address |
N/A | Not Applicable |
Super-types: | xsd:string < Indicator (by restriction) < ApprovedInd (by restriction) |
---|---|
Sub-types: | None |
Name | ApprovedInd |
---|---|
Documentation | Approved Indicator More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < AssigningOrganizationPartyId (by restriction) |
---|---|
Sub-types: | None |
Name | AssigningOrganizationPartyId |
---|---|
Documentation | Assigning Organization Party Id More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
LegalId | Legal ID |
NationalId | Government-assigned ID such as a social security Number |
Other | Other |
DUNS | Dun and Bradstreet |
MotorDealerRegistrationId | Department of Motor Vehicle Registration number for a dealer. This is the dealer's license number to do business. |
GSTRegistrationId | Canadian Goods and Services Tax Id. |
HSTRegistrationId | Canadian HarmonizedTax Id. |
Certification Of Registration Id | Id of the certificate of registration assigned to a business to allow that business to collect and remit certain taxes or fees to a state. |
QSTRegistrationId | Quebec sales tax id. |
Super-types: | xsd:string < AssigningPartyId (by restriction) |
---|---|
Sub-types: | None |
Name | AssigningPartyId |
---|---|
Documentation | Agency or entity that validates the Party Id More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
LegalId | Legal ID |
DriversLicense | Drivers License |
NationalId | Government-assigned ID such as a social security Number |
Other | Other |
GSTRegistrationId | Canadian Goods and Services Tax Id. |
HSTRegistrationId | Canadian HarmonizedTax Id. |
PreviousAccountNumber | |
QSTRegistrationId | Quebec sales tax id. |
Super-types: | xsd:string < ReferenceNumber (by restriction) < AuthorizationNumber (by restriction) |
---|---|
Sub-types: | None |
Name | AuthorizationNumber |
---|---|
Documentation | Authorization Number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < AxleCode (by restriction) |
---|---|
Sub-types: | None |
Name | AxleCode |
---|---|
Documentation | The code on the axle of the vehicle. More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < BirthDate (by restriction) |
---|---|
Sub-types: | None |
Name | BirthDate |
---|---|
Documentation | Birth date of party More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Text (by restriction) < BodyStyle (by restriction) |
---|---|
Sub-types: | None |
Name | BodyStyle |
---|---|
Documentation | Manufacturer-assigned vehicle body style More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < BrandedTitleDate (by restriction) |
---|---|
Sub-types: | None |
Name | BrandedTitleDate |
---|---|
Documentation | Branding Date More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < BrandedTitleInd (by restriction) |
---|---|
Sub-types: | None |
Name | BrandedTitleInd |
---|---|
Documentation | This tag indicates if a vehicle's title has been branded. (i.e., vehicle totaled and state registration title branded as such) More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Note (by restriction) < BrandingSource (by restriction) |
---|---|
Sub-types: | None |
Name | BrandingSource |
---|---|
Documentation | Branding source (i.e., source who says that the vehicle is branded) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < ReferenceNumber (by restriction) < BrandingStateReference (by restriction) |
---|---|
Sub-types: | None |
Name | BrandingStateReference |
---|---|
Documentation | Branding State Reference Number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < CertifiedPreownedInd (by restriction) |
---|---|
Sub-types: | None |
Name | CertifiedPreownedInd |
---|---|
Documentation | Identifies as a certified Pre-Owned Vehicle More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < City (by restriction) |
---|---|
Sub-types: | None |
Name | City |
---|---|
Documentation | City of the Address. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) |
---|---|
Sub-types: |
|
Name | Code |
---|---|
Documentation | Unique code name More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < CommercialUsageInd (by restriction) |
---|---|
Sub-types: | None |
Name | CommercialUsageInd |
---|---|
Documentation | Indicates that the planned use of the vehicle is for commercial purposes. More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Name (by restriction) < CompanyName (by restriction) |
---|---|
Sub-types: | None |
Name | CompanyName |
---|---|
Documentation | Company name of customer More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < Condition (by restriction) |
---|---|
Sub-types: | None |
Name | Condition |
---|---|
Documentation | Condition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown More information at: http://www.starstandard.org. |
Super-types: | xsd:NMTOKEN < ConfirmType (by restriction) |
---|---|
Sub-types: | None |
Name | ConfirmType |
---|
Code Value | Description |
---|---|
Always | |
OnChange | |
Never |
Super-types: | xsd:string < ContactTelephoneNumberDescription (by restriction) |
---|---|
Sub-types: | None |
Name | ContactTelephoneNumberDescription |
---|---|
Documentation | Contact Telephone Number Description More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Evening Phone | Evening Phone |
Day Phone | Day Phone |
Cell Phone | Cell Phone |
Pager | Pager |
Other | Other |
Super-types: | xsd:string < ContactTelephoneNumberOrganizationDescription (by restriction) |
---|---|
Sub-types: | None |
Name | ContactTelephoneNumberOrganizationDescription |
---|---|
Documentation | Contact Telephone Number Organization Description More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Day Phone | Day Phone |
Cell Phone | Cell Phone |
Pager | Pager |
Other | Other |
Super-types: | xsd:string < Note (by restriction) < ContactTime (by restriction) |
---|---|
Sub-types: | None |
Name | ContactTime |
---|---|
Documentation | Preferred contact time (i.e. Best day/time to reach the contact. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < ContractCompanyName (by restriction) |
---|---|
Sub-types: | None |
Name | ContractCompanyName |
---|---|
Documentation | Contract company name More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < ContractEffectiveDate (by restriction) |
---|---|
Sub-types: | None |
Name | ContractEffectiveDate |
---|---|
Documentation | Start Date of Service Contract More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < ContractExpirationDate (by restriction) |
---|---|
Sub-types: | None |
Name | ContractExpirationDate |
---|---|
Documentation | Date the contract expires More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Language (by restriction) < ContractLanguageCode (by restriction) |
---|---|
Sub-types: | None |
Name | ContractLanguageCode |
---|---|
Documentation | Language code indicating contract language preference More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
en-US | |
en-CA | |
aa-ET | |
ab-GE | |
af-ZA | |
am- ET | |
ar-SA | |
as-IN | |
ay-BO | |
az-AZ | |
ba-RU | |
be-BY | |
bg-BG | |
bh-IN | |
bi-VU | |
bn-BD | |
bo-BT | |
br-FR | |
ca-ES | |
co-FR | |
cs-CZ | |
cy-GB | |
da-DE | |
de-DE | |
dz-BT | |
el-GR | |
es-ES | |
et-EE | |
eu-ES | |
fa-AF | |
fi-FI | |
fj-FJ | |
fo-FO | |
fr-CA | |
fr-FR | |
fy-NL | |
ga-IE | |
gd-GB | |
gl-ES | |
gn-PY | |
gu-IN | |
ha-NG | |
hi-IN | |
hr-HR | |
hu-HU | |
hy-AM | |
ik-GL | |
in-ID | |
is-IS | |
it-IT | |
iw-IL | |
ja-JP | |
ji-IL | |
jw-ID | |
ka-GE | |
kk-KZ | |
kl-GL | |
km-KH | |
kn-IN | |
ko-KP | |
ko-KR | |
ks-IN | |
ku-IQ | |
ky-CN | |
la-VA | |
ln-CD | |
lo-LA | |
lt-LT | |
lv-LV | |
mg-MG | |
mi-NZ | |
mk-MK | |
ml-IN | |
mn-MN | |
mo-MO | |
mr-IN | |
ms-MY | |
mt-MH | |
my-MM | |
na-NR | |
ne-NP | |
nl-NL | |
no-NO | |
oc-FR | |
om- ET | |
or-IN | |
pa-IN | |
pl-PL | |
ps-PK | |
pt-PT | |
qu-PE | |
rm-CH | |
rn-BI | |
ro-RO | |
ru-RU | |
rw-RW | |
sa-IN | |
sd-PK | |
sg-CF | |
sh-HR | |
si-LK | |
sk-SK | |
sl-SI | |
sm-WS | |
sn-ZW | |
so-SO | |
sq-AL | |
sr-CS | |
ss-ZA | |
st-ZA | |
su-SD | |
sv-SE | |
sw-TL | |
ta-IN | |
te-IN | |
tg-TJ | |
th-TH | |
ti-ET | |
tk-TM | |
tl-PH | |
tn-ZA | |
to-TO | |
tr-TR | |
ts-ZA | |
tt-RU | |
tw-GH | |
uk-UA | |
ur-PK | |
uz-UZ | |
vi-VN | |
wo-SN | |
xh-ZA | |
yo-NG | |
zh-CN | |
zu-ZA |
Super-types: | xsd:string < Indicator (by restriction) < ContractLienInd (by restriction) |
---|---|
Sub-types: | None |
Name | ContractLienInd |
---|---|
Documentation | Indicates the vehicle has a lien or the contract was financed More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Note (by restriction) < ContractNote (by restriction) |
---|---|
Sub-types: | None |
Name | ContractNote |
---|---|
Documentation | Free form comments that relate to the contract More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < ContractOptionCode (by restriction) |
---|---|
Sub-types: | None |
Name | ContractOptionCode |
---|---|
Documentation | Unique identifier for a plan option. More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < ContractOptionEndDate (by restriction) |
---|---|
Sub-types: | None |
Name | ContractOptionEndDate |
---|---|
Documentation | The date the contract option expires. More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < ContractOptionStartDate (by restriction) |
---|---|
Sub-types: | None |
Name | ContractOptionStartDate |
---|---|
Documentation | The date the contract option takes effect. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < ContractOwnerName (by restriction) |
---|---|
Sub-types: | None |
Name | ContractOwnerName |
---|---|
Documentation | Name on service Contract (i.e., full name - First Last) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < ContractPlanCode (by restriction) |
---|---|
Sub-types: | None |
Name | ContractPlanCode |
---|---|
Documentation | Contract Plan Code More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < ContractPlanStates (by restriction) |
---|---|
Sub-types: | None |
Name | ContractPlanStates |
---|---|
Documentation | States where the plan is valid More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < ContractRegistrationDate (by restriction) |
---|---|
Sub-types: | None |
Name | ContractRegistrationDate |
---|---|
Documentation | The day the contract is registered in the originating system. (Ex. The database system). More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < ContractStartDate (by restriction) |
---|---|
Sub-types: | None |
Name | ContractStartDate |
---|---|
Documentation | Contract sale Date More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < ContractTransferInd (by restriction) |
---|---|
Sub-types: | None |
Name | ContractTransferInd |
---|---|
Documentation | Indicates if the contract is transferable More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Indicator (by restriction) < ContractTransferredInd (by restriction) |
---|---|
Sub-types: | None |
Name | ContractTransferredInd |
---|---|
Documentation | Indicates if the contract has been transferred More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Indicator (by restriction) < ContractTripInterruptInd (by restriction) |
---|---|
Sub-types: | None |
Name | ContractTripInterruptInd |
---|---|
Documentation | Indicates if the contract allows for trip interruption More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Type (by restriction) < ContractType (by restriction) |
---|---|
Sub-types: | None |
Name | ContractType |
---|---|
Documentation | Contract type and/or area of coverage More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Country (by restriction) |
---|---|
Sub-types: | None |
Name | Country |
---|---|
Documentation | Country in which the Address is in. Conforms to ISO 3166-2. AF -AFGHANISTAN AL -ALBANIA DZ -ALGERIA AS -AMERICAN SAMOA AD -ANDORRA AO -ANGOLA AI -ANGUILLA AQ -ANTARCTICA AG -ANTIGUA AND BARBUDA AR -ARGENTINA AM -ARMENIA AW -ARUBA AU -AUSTRALIA AT -AUSTRIA AZ -AZERBAIJAN BS -BAHAMAS BH -BAHRAIN BD -BANGLADESH BB -BARBADOS BY -BELARUS BE -BELGIUM BZ -BELIZE BJ -BENIN BM -BERMUDA BT -BHUTAN BO -BOLIVIA BA -BOSNIA AND HERZEGOVINA BW -BOTSWANA BV -BOUVET ISLAND BR -BRAZIL IO-BRITISH INDIAN OCEAN TERRITORY BN -BRUNEI DARUSSALAM BG -BULGARIA BF -BURKINA FASO BI -BURUNDI KH -CAMBODIA CM -CAMEROON CA -CANADA CV -CAPE VERDE KY -CAYMAN ISLANDS CF -CENTRAL AFRICAN REPUBLIC TD -CHAD CL -CHILE CN -CHINA CX -CHRISTMAS ISLAND CC -COCOS (KEELING) ISLANDS CO -COLOMBIA KM -COMOROS CG -CONGO CD -CONGO, THE DEMOCRATIC REPUBLIC OF THE CK -COOK ISLANDS CR -COSTA RICA CI -CÃÂTE D'IVOIRE HR -CROATIA CU -CUBA CY -CYPRUS CZ -CZECH REPUBLIC DK -DENMARK DJ -DJIBOUTI DM -DOMINICA DO -DOMINICAN REPUBLIC EC -ECUADOR EG -EGYPT SV -EL SALVADOR GQ -EQUATORIAL GUINEA ER -ERITREA EE -ESTONIA ET -ETHIOPIA FK -FALKLAND ISLANDS (MALVINAS) FO -FAROE ISLANDS FJ -FIJI FI -FINLAND FR -FRANCE GF -FRENCH GUIANA PF -FRENCH POLYNESIA TF -FRENCH SOUTHERN TERRITORIES GA -GABON GM -GAMBIA GE -GEORGIA DE -GERMANY GH -GHANA GI -GIBRALTAR GR -GREECE GL -GREENLAND GD -GRENADA GP -GUADELOUPE GU -GUAM GT -GUATEMALA GN -GUINEA GW -GUINEA-BISSAU GY -GUYANA HT -HAITI HM -HEARD ISLAND AND MCDONALD ISLANDS VA -HOLY SEE (VATICAN CITY STATE) HN -HONDURAS HK -HONG KONG HU -HUNGARY IS -ICELAND IN -INDIA ID -INDONESIA IR -IRAN, ISLAMIC REPUBLIC OF IQ -IRAQ IE -IRELAND IL -ISRAEL IT -ITALY JM -JAMAICA JP -JAPAN JO -JORDAN KZ -KAZAKHSTAN KE -KENYA KI -KIRIBATI KP -KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF KR -KOREA, REPUBLIC OF KW -KUWAIT KG -KYRGYZSTAN LA -LAO PEOPLE'S DEMOCRATIC REPUBLIC LV -LATVIA LB -LEBANON LS -LESOTHO LR -LIBERIA LY -LIBYAN ARAB JAMAHIRIYA LI -LIECHTENSTEIN LT -LITHUANIA LU -LUXEMBOURG MO -MACAO MK -MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF MG -MADAGASCAR MW -MALAWI MY -MALAYSIA MV -MALDIVES ML -MALI MT -MALTA MH -MARSHALL ISLANDS MQ -MARTINIQUE MR -MAURITANIA MU -MAURITIUS YT -MAYOTTE MX -MEXICO FM -MICRONESIA, FEDERATED STATES OF MD -MOLDOVA, REPUBLIC OF MC -MONACO MN -MONGOLIA MS -MONTSERRAT MA -MOROCCO MZ -MOZAMBIQUE MM -MYANMAR NA -NAMIBIA NR -NAURU NP -NEPAL NL -NETHERLANDS AN -NETHERLANDS ANTILLES NC -NEW CALEDONIA NZ -NEW ZEALAND NI -NICARAGUA NE -NIGER NG -NIGERIA NU -NIUE NF -NORFOLK ISLAND MP -NORTHERN MARIANA ISLANDS NO -NORWAY OM -OMAN PK -PAKISTAN PW -PALAU PS -PALESTINIAN TERRITORY, OCCUPIED PA -PANAMA PG -PAPUA NEW GUINEA PY -PARAGUAY PE -PERU PH -PHILIPPINES PN -PITCAIRN PL -POLAND PT -PORTUGAL PR -PUERTO RICO QA -QATAR RE -RÃÂUNION RO -ROMANIA RU -RUSSIAN FEDERATION RW -RWANDA SH -SAINT HELENA KN -SAINT KITTS AND NEVIS LC -SAINT LUCIA PM -SAINT PIERRE AND MIQUELON VC -SAINT VINCENT AND THE GRENADINES WS -SAMOA SM -SAN MARINO ST -SAO TOME AND PRINCIPE SA -SAUDI ARABIA SN -SENEGAL CS -SERBIA AND MONTENEGRO SC -SEYCHELLES SL -SIERRA LEONE SG -SINGAPORE SK -SLOVAKIA SI -SLOVENIA SB -SOLOMON ISLANDS SO -SOMALIA ZA -SOUTH AFRICA GS -SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS ES -SPAIN LK -SRI LANKA SD -SUDAN SR -SURINAME SJ -SVALBARD AND JAN MAYEN SZ -SWAZILAND SE -SWEDEN CH -SWITZERLAND SY -SYRIAN ARAB REPUBLIC TW -TAIWAN, PROVINCE OF CHINA TJ -TAJIKISTAN TZ -TANZANIA, UNITED REPUBLIC OF TH -THAILAND TL -TIMOR-LESTE TG - TOGO TK -TOKELAU TO -TONGA TT -TRINIDAD AND TOBAGO TN -TUNISIA TR -TURKEY TM -TURKMENISTAN TC -TURKS AND CAICOS ISLANDS TV -TUVALU UG -UGANDA UA -UKRAINE AE -UNITED ARAB EMIRATES GB -UNITED KINGDOM US -UNITED STATES UM -UNITED STATES MINOR OUTLYING ISLANDS UY -URUGUAY UZ -UZBEKISTAN VU -VANUATU VE -VENEZUELA VN -VIET NAM VG -VIRGIN ISLANDS, BRITISH VI -VIRGIN ISLANDS, U.S. WF -WALLIS AND FUTUNA EH -WESTERN SAHARA YE -YEMEN ZM -ZAMBIA ZW -ZIMBABWE More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
US | |
AF | |
AL | |
DZ | |
AS | |
AD | |
AO | |
AI | |
AQ | |
AG | |
AR | |
AM | |
AW | |
AU | |
AT | |
AZ | |
BS | |
BH | |
BD | |
BB | |
BY | |
BE | |
BZ | |
BJ | |
BM | |
BT | |
BO | |
BA | |
BW | |
BV | |
BR | |
IO | |
BN | |
BG | |
BF | |
BI | |
KH | |
CM | |
CA | |
CV | |
KY | |
CF | |
TD | |
CL | |
CN | |
CX | |
CC | |
CO | |
KM | |
CG | |
CD | |
CK | |
CR | |
CI | |
HR | |
CU | |
CY | |
CZ | |
DK | |
DJ | |
DM | |
DO | |
EC | |
EG | |
SV | |
GQ | |
ER | |
EE | |
ET | |
FK | |
FO | |
FJ | |
FI | |
FR | |
GF | |
PF | |
TF | |
GA | |
GM | |
GE | |
DE | |
GH | |
GI | |
GR | |
GL | |
GD | |
GP | |
GU | |
GT | |
GN | |
GW | |
GY | |
HT | |
HM | |
VA | |
HN | |
HK | |
HU | |
IS | |
IN | |
ID | |
IR | |
IQ | |
IE | |
IL | |
IT | |
JM | |
JP | |
JO | |
KZ | |
KE | |
KI | |
KP | |
KR | |
KW | |
KG | |
LA | |
LV | |
LB | |
LS | |
LR | |
LY | |
LI | |
LT | |
LU | |
MO | |
MK | |
MG | |
MW | |
MY | |
MV | |
ML | |
MT | |
MH | |
MQ | |
MR | |
MU | |
YT | |
MX | |
FM | |
MD | |
MC | |
MN | |
MS | |
MA | |
MZ | |
MM | |
NA | |
NR | |
NP | |
NL | |
AN | |
NC | |
NZ | |
NI | |
NE | |
NG | |
NU | |
NF | |
MP | |
NO | |
OM | |
PK | |
PW | |
PS | |
PA | |
PG | |
PY | |
PE | |
PH | |
PN | |
PL | |
PT | |
PR | |
QA | |
RE | |
RO | |
RU | |
RW | |
SH | |
KN | |
LC | |
PM | |
VC | |
WS | |
SM | |
ST | |
SA | |
SN | |
CS | |
SC | |
SL | |
SG | |
SK | |
SI | |
SB | |
SO | |
ZA | |
GS | |
ES | |
LK | |
SD | |
SR | |
SJ | |
SZ | |
SE | |
CH | |
SY | |
TW | |
TJ | |
TZ | |
TH | |
TL | |
TG | |
TK | |
TO | |
TT | |
TN | |
TR | |
TM | |
TC | |
TV | |
UG | |
UA | |
AE | |
GB | |
UM | |
UY | |
UZ | |
VU | |
VE | |
VN | |
VG | |
VI | |
WF | |
EH | |
YE | |
ZM | |
ZW |
Super-types: | xsd:string < County (by restriction) |
---|---|
Sub-types: | None |
Name | County |
---|---|
Documentation | Business party county location More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < CouponComment (by restriction) |
---|---|
Sub-types: | None |
Name | CouponComment |
---|---|
Documentation | Comments associated with the coupon (e.g., Please rotate tire to front left). More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < CoverageCode (by restriction) |
---|---|
Sub-types: | None |
Name | CoverageCode |
---|---|
Documentation | Identifies Service Contract coverage beyond plan code and contract type More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Currency (by restriction) |
---|---|
Sub-types: | None |
Name | Currency |
---|---|
Documentation | The ISO code identifying the type of currency in use. More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
USD | |
ADP | |
AED | |
AFA | |
ALL | |
ANG | |
AOK | |
ARA | |
ATS | |
AUD | |
AWG | |
BBD | |
BDT | |
BEF | |
BGL | |
BHD | |
BIF | |
BMD | |
BND | |
BOB | |
BRC | |
BSD | |
BTN | |
BUK | |
BWP | |
BZD | |
CAD | |
CHF | |
CLF | |
CLP | |
CNY | |
COP | |
CRC | |
CSK | |
CUP | |
CVE | |
CYP | |
DDM | |
DEM | |
DJF | |
DKK | |
DOP | |
DZD | |
ECS | |
EGP | |
ESP | |
ETB | |
EUR | |
FIM | |
FKP | |
FRF | |
GBP | |
GHC | |
GIP | |
GMD | |
GNF | |
GRD | |
GTQ | |
GWP | |
GYD | |
HKD | |
HNL | |
HTG | |
HUF | |
IDR | |
IEP | |
ILS | |
INR | |
IQD | |
IRR | |
ISK | |
ITL | |
JMD | |
JOD | |
JPY | |
KES | |
KHR | |
KMF | |
KPW | |
KRW | |
KWD | |
KYD | |
LAK | |
LBP | |
LKR | |
LRD | |
LSL | |
LUF | |
LYD | |
MAD | |
MGF | |
MNT | |
MOP | |
MRO | |
MTL | |
MUR | |
MVR | |
MWK | |
MXN | |
MYR | |
MZM | |
NGN | |
NIC | |
NLG | |
NOK | |
NPR | |
NZD | |
OMR | |
PAB | |
PEI | |
PGK | |
PHP | |
PKR | |
PLZ | |
PTE | |
PYG | |
QAR | |
ROL | |
RWF | |
SAR | |
SBD | |
SCR | |
SDP | |
SEK | |
SGD | |
SHP | |
SLL | |
SKK | |
SOS | |
SRG | |
STD | |
SUR | |
SVC | |
SYP | |
SZL | |
THB | |
TND | |
TOP | |
TPE | |
TRL | |
TTD | |
TWD | |
TZS | |
UGS | |
UYP | |
VEB | |
VND | |
VUV | |
WST | |
YDD | |
YER | |
YUD | |
ZAR | |
ZRZ | |
ZWD | |
Other |
Super-types: | xsd:date < Date (by restriction) |
---|---|
Sub-types: |
|
Name | Date |
---|---|
Documentation | Date conforms to ISO 8601 format rules EX: \d\d\d\d-\d\d-\d\d More information at: http://www.starstandard.org. |
Super-types: | xsd:dateTime < DateTime (by restriction) |
---|---|
Sub-types: |
|
Name | DateTime |
---|---|
Documentation | Date and time conforms to ISO 8601format rules without offset EX:2003-11-05T13:15:30Z More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < DBAName (by restriction) |
---|---|
Sub-types: | None |
Name | DBAName |
---|---|
Documentation | Doing Business As name. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < DealerInstallationInd (by restriction) |
---|---|
Sub-types: | None |
Name | DealerInstallationInd |
---|---|
Documentation | Indicates whether or not the dealership installed the part More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Name (by restriction) < DealerName (by restriction) |
---|---|
Sub-types: | None |
Name | DealerName |
---|---|
Documentation | Dealer name More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < DealerTransferDate (by restriction) |
---|---|
Sub-types: | None |
Name | DealerTransferDate |
---|---|
Documentation | Date transferred to retailing dealer More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Decimal (by restriction) |
---|---|
Sub-types: | None |
Name | Decimal |
---|---|
Documentation | Decimal More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < DelayedInspectionCode (by restriction) |
---|---|
Sub-types: | None |
Name | DelayedInspectionCode |
---|---|
Documentation | Explains why a vehicle cannot be initially inspected once it arrives at a dealer (ie: dealer closed, no one around to sign for vehicle) More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < DeliveryDate (by restriction) |
---|---|
Sub-types: | None |
Name | DeliveryDate |
---|---|
Documentation | The date of original retail vehicle sale More information at: http://www.starstandard.org. |
Super-types: | xsd:string < ReferenceNumber (by restriction) < DiscountRate (by restriction) |
---|---|
Sub-types: | None |
Name | DiscountRate |
---|---|
Documentation | The rate/service factor being discounted off the net lease rate due to lease being a single pay lease or some other special program. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < DistrictCode (by restriction) |
---|---|
Sub-types: | None |
Name | DistrictCode |
---|---|
Documentation | Manufacturer Assigned District Code More information at: http://www.starstandard.org. |
Super-types: | xsd:dateTime < DateTime (by restriction) < DocumentDateTime (by restriction) |
---|---|
Sub-types: | None |
Name | DocumentDateTime |
---|---|
Documentation | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < SerialNumber (by restriction) < DoorKeyNumber (by restriction) |
---|---|
Sub-types: | None |
Name | DoorKeyNumber |
---|---|
Documentation | Door Key Number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < DriverAction (by restriction) |
---|---|
Sub-types: | None |
Name | DriverAction |
---|---|
Documentation | Driver action (Ex: Drop-Off, Pick-Up, etc) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < EmployeeDiscountInd (by restriction) |
---|---|
Sub-types: | None |
Name | EmployeeDiscountInd |
---|---|
Documentation | Indicates if this registration should apply OEM employee discount. More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < EngineDisplacement (by restriction) |
---|---|
Sub-types: | None |
Name | EngineDisplacement |
---|---|
Documentation | Displacement of engine (i.e., amount of volume in the cylinders) More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
ci | ci - Cubic Inches |
cc | cc - Cubic Centimeters |
liters | liters |
other | |
N/A | Not Applicable |
Super-types: | xsd:string < SerialNumber (by restriction) < EngineNumber (by restriction) |
---|---|
Sub-types: | None |
Name | EngineNumber |
---|---|
Documentation | Serial number of the engine if vehicle not made for US sale More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < ExpirationDate (by restriction) |
---|---|
Sub-types: | None |
Name | ExpirationDate |
---|---|
Documentation | Expiration Date More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Expression (by restriction) |
---|---|
Sub-types: | None |
Name | Expression |
---|
Super-types: | xsd:string < ExpressionLanguage (by restriction) |
---|---|
Sub-types: | None |
Name | ExpressionLanguage |
---|
Super-types: | xsd:string < Note (by restriction) < ExteriorColor (by restriction) |
---|---|
Sub-types: | None |
Name | ExteriorColor |
---|---|
Documentation | Vehicle Exterior Color(s) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < ExteriorColorCode (by restriction) |
---|---|
Sub-types: | None |
Name | ExteriorColorCode |
---|---|
Documentation | Vehicle exterior color code More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < FamilyName (by restriction) |
---|---|
Sub-types: | None |
Name | FamilyName |
---|---|
Documentation | Last Name of business party More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < FinalPaymentDate (by restriction) |
---|---|
Sub-types: | None |
Name | FinalPaymentDate |
---|---|
Documentation | Date that the final payment amount is due (e.g., Ballon, Fixed Value, Lease, etc.) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < FinanceCompanyName (by restriction) |
---|---|
Sub-types: | None |
Name | FinanceCompanyName |
---|---|
Documentation | Name of Finance Company More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Type (by restriction) < FinanceType (by restriction) |
---|---|
Sub-types: | None |
Name | FinanceType |
---|---|
Documentation | Type of financing Examples may be F- Finance, L - Lease, C-Cash, 1-Retail, 2-Lease, 3-Balloon, etc. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < FirstDayRentalInd (by restriction) |
---|---|
Sub-types: | None |
Name | FirstDayRentalInd |
---|---|
Documentation | If first day rental for service is covered in contract More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Indicator (by restriction) < FirstTimeBuyerInd (by restriction) |
---|---|
Sub-types: | None |
Name | FirstTimeBuyerInd |
---|---|
Documentation | Identifies customer as first time buyer More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < ReferenceNumber (by restriction) < FleetAccount (by restriction) |
---|---|
Sub-types: | None |
Name | FleetAccount |
---|---|
Documentation | Manufacturer defined fleet account number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < ReferenceNumber (by restriction) < FleetPurchaseOrderNumber (by restriction) |
---|---|
Sub-types: | None |
Name | FleetPurchaseOrderNumber |
---|---|
Documentation | Fleet Purchase Order Number vehicle was purchased under More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < FormattedName (by restriction) |
---|---|
Sub-types: | None |
Name | FormattedName |
---|---|
Documentation | Full Name of business party. Format for name should be "First Last" with no commas between first and last name More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Gender (by restriction) |
---|---|
Sub-types: | None |
Name | Gender |
---|---|
Documentation | Gender of party - M = Male, F= Female More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
M | "M" = Modified |
F | Female |
Super-types: | xsd:string < Name (by restriction) < GivenName (by restriction) |
---|---|
Sub-types: | None |
Name | GivenName |
---|---|
Documentation | First Name of business party More information at: http://www.starstandard.org. |
Super-types: | xsd:string < HomeWork (by restriction) |
---|---|
Sub-types: | None |
Name | HomeWork |
---|---|
Documentation | Home or Work More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Home | Home |
Work | Work |
Other | Other |
Super-types: | xsd:string < SerialNumber (by restriction) < IgnitionKeyNumber (by restriction) |
---|---|
Sub-types: | None |
Name | IgnitionKeyNumber |
---|---|
Documentation | Vehicle Ignition Key Number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) |
---|---|
Sub-types: |
|
Name | Indicator |
---|---|
Documentation | 0 = No, 1 = Yes More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:date < Date (by restriction) < InitiativeDate (by restriction) |
---|---|
Sub-types: | None |
Name | InitiativeDate |
---|---|
Documentation | The date the initiative was processed. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < InitiativeType (by restriction) |
---|---|
Sub-types: | None |
Name | InitiativeType |
---|---|
Documentation | Type of program - Incentive or program related initiatives More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Program | Program-related initiative |
Incentives | Incentive-related initiative |
N/A | Not Applicable |
Other | Other |
Super-types: | xsd:string < Name (by restriction) < InsuranceCompanyName (by restriction) |
---|---|
Sub-types: | None |
Name | InsuranceCompanyName |
---|---|
Documentation | Insurance company name More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < InteriorColor (by restriction) |
---|---|
Sub-types: | None |
Name | InteriorColor |
---|---|
Documentation | Vehicle Interior Color(s) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < InteriorColorCode (by restriction) |
---|---|
Sub-types: | None |
Name | InteriorColorCode |
---|---|
Documentation | Vehicle Interior color code More information at: http://www.starstandard.org. |
Super-types: | xsd:string < StateOrProvince (by restriction) < IssuingState (by restriction) |
---|---|
Sub-types: | None |
Name | IssuingState |
---|---|
Documentation | Indicates that State where the license was issued. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Language (by restriction) |
---|---|
Sub-types: |
|
Name | Language |
---|---|
Documentation | Language conforms to ISO 639-2 rules. Note the format for this field is language-Country (see Country data type for the list of countries with definitions). AA "Afar", AB "Abkhazian", AF "Afrikaans", AM "Amharic", AR "Arabic", AS "Assamese", AY "Aymara", AZ "Azerbaijani", BA "Bashkir", BE "Byelorussian", BG "Bulgarian", BH "Bihari", BI "Bislama", BN "Bengali" "Bangla", BO "Tibetan", BR "Breton", CA "Catalan", CO "Corsican", CS "Czech", CY "Welsh", DA "Danish", DE "German", DZ "Bhutani", EL "Greek", EN "English" "American", ES "Spanish", ET "Estonian", EU "Basque", FA "Persian", FI "Finnish", FJ "Fiji", FO "Faeroese", FR "French", FY "Frisian", GA "Irish", GD "Gaelic" "Scots Gaelic", GL "Galician", GN "Guarani", GU "Gujarati", HA "Hausa", HI "Hindi", HR "Croatian", HU "Hungarian", HY "Armenian", IK "Inupiak", IN "Indonesian", IS "Icelandic", IT "Italian", IW "Hebrew", JA "Japanese", JI "Yiddish", JW "Javanese", KA "Georgian", KK "Kazakh", KL "Greenlandic", KM "Cambodian", KN "Kannada", KO "Korean", KS "Kashmiri", KU "Kurdish", KY "Kirghiz", LA "Latin", LN "Lingala", LO "Laothian", LT "Lithuanian", LV "Latvian" "Lettish", MG "Malagasy". MI "Maori", MK "Macedonian", ML "Malayalam", MN "Mongolian", MO "Moldavian", MR "Marathi", MS "Malay", MT "Maltese", MY "Burmese", NA "Nauru", NE "Nepali", NL "Dutch", NO "Norwegian", OC "Occitan", OM "Oromo" "Afan", OR "Oriya", PA "Punjabi", PL "Polish", PS "Pashto" "Pushto", PT "Portuguese", QU "Quechua", RM "Rhaeto-Romance", RN "Kirundi", RO "Romanian", RU "Russian", RW "Kinyarwanda", SA "Sanskrit", SD "Sindhi", SG "Sangro", SH "Serbo-Croatian", SI "Singhalese", SK "Slovak", SL "Slovenian", SM "Samoan", SN "Shona", SO "Somali", SQ "Albanian", SR "Serbian", SS "Siswati", ST "Sesotho", SU "Sudanese", SV "Swedish", SW "Swahili", TA "Tamil", TE "Tegulu", TG "Tajik", TH "Thai", TI "Tigrinya", TK "Turkmen", TL "Tagalog", TN "Setswana", TO "Tonga", TR "Turkish", TS "Tsonga", TT "Tatar", TW "Twi", UK "Ukrainian", UR "Urdu", UZ "Uzbek", VI "Vietnamese", WO "Wolof", XH "Xhosa", YO "Yoruba", ZH "Chinese", ZU "Zulu" More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
en-US | |
en-CA | |
aa-ET | |
ab-GE | |
af-ZA | |
am- ET | |
ar-SA | |
as-IN | |
ay-BO | |
az-AZ | |
ba-RU | |
be-BY | |
bg-BG | |
bh-IN | |
bi-VU | |
bn-BD | |
bo-BT | |
br-FR | |
ca-ES | |
co-FR | |
cs-CZ | |
cy-GB | |
da-DE | |
de-DE | |
dz-BT | |
el-GR | |
es-ES | |
et-EE | |
eu-ES | |
fa-AF | |
fi-FI | |
fj-FJ | |
fo-FO | |
fr-CA | |
fr-FR | |
fy-NL | |
ga-IE | |
gd-GB | |
gl-ES | |
gn-PY | |
gu-IN | |
ha-NG | |
hi-IN | |
hr-HR | |
hu-HU | |
hy-AM | |
ik-GL | |
in-ID | |
is-IS | |
it-IT | |
iw-IL | |
ja-JP | |
ji-IL | |
jw-ID | |
ka-GE | |
kk-KZ | |
kl-GL | |
km-KH | |
kn-IN | |
ko-KP | |
ko-KR | |
ks-IN | |
ku-IQ | |
ky-CN | |
la-VA | |
ln-CD | |
lo-LA | |
lt-LT | |
lv-LV | |
mg-MG | |
mi-NZ | |
mk-MK | |
ml-IN | |
mn-MN | |
mo-MO | |
mr-IN | |
ms-MY | |
mt-MH | |
my-MM | |
na-NR | |
ne-NP | |
nl-NL | |
no-NO | |
oc-FR | |
om- ET | |
or-IN | |
pa-IN | |
pl-PL | |
ps-PK | |
pt-PT | |
qu-PE | |
rm-CH | |
rn-BI | |
ro-RO | |
ru-RU | |
rw-RW | |
sa-IN | |
sd-PK | |
sg-CF | |
sh-HR | |
si-LK | |
sk-SK | |
sl-SI | |
sm-WS | |
sn-ZW | |
so-SO | |
sq-AL | |
sr-CS | |
ss-ZA | |
st-ZA | |
su-SD | |
sv-SE | |
sw-TL | |
ta-IN | |
te-IN | |
tg-TJ | |
th-TH | |
ti-ET | |
tk-TM | |
tl-PH | |
tn-ZA | |
to-TO | |
tr-TR | |
ts-ZA | |
tt-RU | |
tw-GH | |
uk-UA | |
ur-PK | |
uz-UZ | |
vi-VN | |
wo-SN | |
xh-ZA | |
yo-NG | |
zh-CN | |
zu-ZA |
Super-types: | xsd:string < ReferenceNumber (by restriction) < LeaseBuyMoneyFactor (by restriction) |
---|---|
Sub-types: | None |
Name | LeaseBuyMoneyFactor |
---|---|
Documentation | Lease Rate/Service Factor offered to the dealer by Finance Source. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < ReferenceNumber (by restriction) < LicenseNumber (by restriction) |
---|---|
Sub-types: | None |
Name | LicenseNumber |
---|---|
Documentation | State License plate number of vehicle More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < LoanerVehicleInd (by restriction) |
---|---|
Sub-types: | None |
Name | LoanerVehicleInd |
---|---|
Documentation | Ioaner vehicle indicator More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < LocationDescription (by restriction) |
---|---|
Sub-types: |
|
Name | LocationDescription |
---|---|
Documentation | Location Description More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < LowMileageOption (by restriction) |
---|---|
Sub-types: | None |
Name | LowMileageOption |
---|---|
Documentation | Indicates whether a customer chooses low mileage. More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Make (by restriction) |
---|---|
Sub-types: | None |
Name | Make |
---|---|
Documentation | Vehicle make code - Usually available in the VIN number (use NCIC code). More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < Manufacturer (by restriction) |
---|---|
Sub-types: | None |
Name | Manufacturer |
---|---|
Documentation | Manufacturer Name More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < ManufacturerInstalledInd (by restriction) |
---|---|
Sub-types: | None |
Name | ManufacturerInstalledInd |
---|---|
Documentation | Indicates manufacturer-installed accessories More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Code (by restriction) < MarketCode (by restriction) |
---|---|
Sub-types: | None |
Name | MarketCode |
---|---|
Documentation | A market code which designates the market area. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < MarketingMailInd (by restriction) |
---|---|
Sub-types: | None |
Name | MarketingMailInd |
---|---|
Documentation | Indicates customers whom have requested no marketing mail More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Indicator (by restriction) < MasterShieldInd (by restriction) |
---|---|
Sub-types: | None |
Name | MasterShieldInd |
---|---|
Documentation | Indicates if vehicle is covered by the Master Shield Extended warranty More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:gYearMonth < AccountingDate (by restriction) < MaturityDate (by restriction) |
---|---|
Sub-types: | None |
Name | MaturityDate |
---|---|
Documentation | Month and year of contract maturity More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < MiddleName (by restriction) |
---|---|
Sub-types: | None |
Name | MiddleName |
---|---|
Documentation | Middle Initial of business party More information at: http://www.starstandard.org. |
Super-types: | xsd:string < MileageMeasure (by restriction) |
---|---|
Sub-types: | None |
Name | MileageMeasure |
---|---|
Documentation | M = Miles, K = KIlometers More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
M | "M" = Modified |
K | Kilometers |
Super-types: | xsd:string < Code (by restriction) < MiscellaneousCode (by restriction) |
---|---|
Sub-types: | None |
Name | MiscellaneousCode |
---|---|
Documentation | Miscellaneous code More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < MiscellaneousNotes (by restriction) |
---|---|
Sub-types: | None |
Name | MiscellaneousNotes |
---|---|
Documentation | Free form miscellaneous comments More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Text (by restriction) < Model (by restriction) |
---|---|
Sub-types: | None |
Name | Model |
---|---|
Documentation | Manufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Text (by restriction) < ModelDescription (by restriction) |
---|---|
Sub-types: | None |
Name | ModelDescription |
---|---|
Documentation | Descriptive vehicle model name More information at: http://www.starstandard.org. |
Super-types: | xsd:gYear < Year (by restriction) < ModelYear (by restriction) |
---|---|
Sub-types: | None |
Name | ModelYear |
---|---|
Documentation | Vehicle designated model year More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) |
---|---|
Sub-types: |
|
Name | Name |
---|---|
Documentation | Name of the Party. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < NoChargeInd (by restriction) |
---|---|
Sub-types: | None |
Name | NoChargeInd |
---|---|
Documentation | Indicates customer was not charged More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Indicator (by restriction) < NonUSVehicleInd (by restriction) |
---|---|
Sub-types: | None |
Name | NonUSVehicleInd |
---|---|
Documentation | Indicates whether the vehicle was produced for the United States or not More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Note (by restriction) |
---|---|
Sub-types: |
|
Name | Note |
---|---|
Documentation | A free form note. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < OdometerStatus (by restriction) |
---|---|
Sub-types: | None |
Name | OdometerStatus |
---|---|
Documentation | Status of odometer at trade-in. Example:: Replaced, Tampered, Miles> 90,000, etc. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < OptionName (by restriction) |
---|---|
Sub-types: | None |
Name | OptionName |
---|---|
Documentation | Name of vehicle option More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < OptionNotes (by restriction) |
---|---|
Sub-types: | None |
Name | OptionNotes |
---|---|
Documentation | Free form text related to option More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < OptionOrigin (by restriction) |
---|---|
Sub-types: | None |
Name | OptionOrigin |
---|---|
Documentation | Identifies the option installer More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < OptionSalesCode (by restriction) |
---|---|
Sub-types: | None |
Name | OptionSalesCode |
---|---|
Documentation | Further definition of accessories and option packages - Indicates whether ordered option, special package, standard, etc. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < OptionSecurityCode (by restriction) |
---|---|
Sub-types: | None |
Name | OptionSecurityCode |
---|---|
Documentation | Security code to unlock option. (i.e, radio code) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < SerialNumber (by restriction) < OptionSerialNumber (by restriction) |
---|---|
Sub-types: | None |
Name | OptionSerialNumber |
---|---|
Documentation | Serial number of Option More information at: http://www.starstandard.org. |
Super-types: | xsd:string < ReferenceNumber (by restriction) < OptionStockNumber (by restriction) |
---|---|
Sub-types: | None |
Name | OptionStockNumber |
---|---|
Documentation | Stock Number of Vehicle Option More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < OriginalInServiceDate (by restriction) |
---|---|
Sub-types: | None |
Name | OriginalInServiceDate |
---|---|
Documentation | The date a used vehicle went in service More information at: http://www.starstandard.org. |
Super-types: | xsd:string < ReferenceNumber (by restriction) < OriginalLeaseRateMoneyFactor (by restriction) |
---|---|
Sub-types: | None |
Name | OriginalLeaseRateMoneyFactor |
---|---|
Documentation | The original lease factor before the discount rate for single payment. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < PartType (by restriction) |
---|---|
Sub-types: | None |
Name | PartType |
---|---|
Documentation | Specifies whether the parts are indicated by manufacturer part code or Part Number - H = Manufacturer Part Code, P = Part Number More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
H | Manufacturer Part Code |
P | "P" = Pending |
Super-types: | xsd:string < PaymentMethod (by restriction) |
---|---|
Sub-types: | None |
Name | PaymentMethod |
---|---|
Documentation | Indicates the method of payment (e.g., cash, credit card, etc.). More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Terms | Indicates that payment terms are provided. |
COD | Cash On Delivery |
Due On Receipt | Payment is due upon receipt of invoice. |
Credit Card | Indicates that a credit card will be used as the method of payment. |
Check | Indicates that a check will be used as the method of payment. |
EFT | Electronic funds transfer. |
Payroll Deduction | Indicates that a payment will be via deduction of an individual's payroll. |
Cash | Indicates that cash will be used as the method of payment. |
Finance | |
Other | Other |
N/A | Not Applicable |
Exchange | Indicates the dealers intent to return parts in exchange for the monetary value of the order. |
Super-types: | xsd:date < Date (by restriction) < PDIDate (by restriction) |
---|---|
Sub-types: | None |
Name | PDIDate |
---|---|
Documentation | Date Pre-Delivery Inspection completed at dealership More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < PortInstalledInd (by restriction) |
---|---|
Sub-types: | None |
Name | PortInstalledInd |
---|---|
Documentation | Indicates Port-installed accessories More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Code (by restriction) < PostalCode (by restriction) |
---|---|
Sub-types: | None |
Name | PostalCode |
---|---|
Documentation | Postal Code of the Address. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < PreApprovedProgramName (by restriction) |
---|---|
Sub-types: | None |
Name | PreApprovedProgramName |
---|---|
Documentation | A text description of preapproval codes. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < PreferredContactMethod (by restriction) |
---|---|
Sub-types: | None |
Name | PreferredContactMethod |
---|---|
Documentation | Preferred contact method More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Day Phone | Day Phone |
Evening Phone | Evening Phone |
Cell Phone | Cell Phone |
Work Fax | Work Fax |
Home Fax | Home Fax |
Pager | Pager |
Work Email | Work Email |
Home Email | Home Email |
US Mail | US Mail |
Other | Other |
N/A | Not Applicable |
Super-types: | xsd:string < PreferredContactMethodOrganization (by restriction) |
---|---|
Sub-types: | None |
Name | PreferredContactMethodOrganization |
---|---|
Documentation | Preferred Contact Method Organization More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Day Phone | Day Phone |
Cell Phone | Cell Phone |
Work Fax | Work Fax |
Pager | Pager |
Work Email | Work Email |
US Mail | US Mail |
Other | Other |
Super-types: | xsd:string < Language (by restriction) < PreferredLanguage (by restriction) |
---|---|
Sub-types: | None |
Name | PreferredLanguage |
---|---|
Documentation | Preferred language More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
en-US | |
en-CA | |
aa-ET | |
ab-GE | |
af-ZA | |
am- ET | |
ar-SA | |
as-IN | |
ay-BO | |
az-AZ | |
ba-RU | |
be-BY | |
bg-BG | |
bh-IN | |
bi-VU | |
bn-BD | |
bo-BT | |
br-FR | |
ca-ES | |
co-FR | |
cs-CZ | |
cy-GB | |
da-DE | |
de-DE | |
dz-BT | |
el-GR | |
es-ES | |
et-EE | |
eu-ES | |
fa-AF | |
fi-FI | |
fj-FJ | |
fo-FO | |
fr-CA | |
fr-FR | |
fy-NL | |
ga-IE | |
gd-GB | |
gl-ES | |
gn-PY | |
gu-IN | |
ha-NG | |
hi-IN | |
hr-HR | |
hu-HU | |
hy-AM | |
ik-GL | |
in-ID | |
is-IS | |
it-IT | |
iw-IL | |
ja-JP | |
ji-IL | |
jw-ID | |
ka-GE | |
kk-KZ | |
kl-GL | |
km-KH | |
kn-IN | |
ko-KP | |
ko-KR | |
ks-IN | |
ku-IQ | |
ky-CN | |
la-VA | |
ln-CD | |
lo-LA | |
lt-LT | |
lv-LV | |
mg-MG | |
mi-NZ | |
mk-MK | |
ml-IN | |
mn-MN | |
mo-MO | |
mr-IN | |
ms-MY | |
mt-MH | |
my-MM | |
na-NR | |
ne-NP | |
nl-NL | |
no-NO | |
oc-FR | |
om- ET | |
or-IN | |
pa-IN | |
pl-PL | |
ps-PK | |
pt-PT | |
qu-PE | |
rm-CH | |
rn-BI | |
ro-RO | |
ru-RU | |
rw-RW | |
sa-IN | |
sd-PK | |
sg-CF | |
sh-HR | |
si-LK | |
sk-SK | |
sl-SI | |
sm-WS | |
sn-ZW | |
so-SO | |
sq-AL | |
sr-CS | |
ss-ZA | |
st-ZA | |
su-SD | |
sv-SE | |
sw-TL | |
ta-IN | |
te-IN | |
tg-TJ | |
th-TH | |
ti-ET | |
tk-TM | |
tl-PH | |
tn-ZA | |
to-TO | |
tr-TR | |
ts-ZA | |
tt-RU | |
tw-GH | |
uk-UA | |
ur-PK | |
uz-UZ | |
vi-VN | |
wo-SN | |
xh-ZA | |
yo-NG | |
zh-CN | |
zu-ZA |
Super-types: | xsd:string < Indicator (by restriction) < PrimaryContactInd (by restriction) |
---|---|
Sub-types: | None |
Name | PrimaryContactInd |
---|---|
Documentation | Indicates if contact is primary contact More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Indicator (by restriction) < PrimaryDriverInd (by restriction) |
---|---|
Sub-types: | None |
Name | PrimaryDriverInd |
---|---|
Documentation | Identifies customer as primary driver. More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Indicator (by restriction) < PrivacyInd (by restriction) |
---|---|
Sub-types: | None |
Name | PrivacyInd |
---|---|
Documentation | Indicator to note that Business Party has requested to share or to not share information with third parties. More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Type (by restriction) < PrivacyType (by restriction) |
---|---|
Sub-types: | None |
Name | PrivacyType |
---|---|
Documentation | Code identifying a Party's authorized privacy rights. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < PromotionalRateInd (by restriction) |
---|---|
Sub-types: | None |
Name | PromotionalRateInd |
---|---|
Documentation | Promotional rate was used More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < ReferenceNumber (by restriction) < ReceiptNumber (by restriction) |
---|---|
Sub-types: | None |
Name | ReceiptNumber |
---|---|
Documentation | Numeric identifier found on the carrier's receipt when a vehicle is delivered to the dealer More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Text (by restriction) < Reference (by restriction) |
---|---|
Sub-types: | None |
Name | Reference |
---|---|
Documentation | Reference notation More information at: http://www.starstandard.org. |
Super-types: | xsd:string < ReferenceNumber (by restriction) |
---|---|
Sub-types: |
|
Name | ReferenceNumber |
---|---|
Documentation | Reference number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < ReimbursementComment (by restriction) |
---|---|
Sub-types: | None |
Name | ReimbursementComment |
---|---|
Documentation | Reimbursement dealer comments More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < ReimbursementPayee (by restriction) |
---|---|
Sub-types: | None |
Name | ReimbursementPayee |
---|---|
Documentation | Indicates who is paid More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < RelationshipCode (by restriction) |
---|---|
Sub-types: | None |
Name | RelationshipCode |
---|---|
Documentation | Indicates the Business Party's relationship to the primary Party (e.g., mother, father, husband, etc.). More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < RestrictionInd (by restriction) |
---|---|
Sub-types: | None |
Name | RestrictionInd |
---|---|
Documentation | Indication that vehicle has restrictions on its use More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Indicator (by restriction) < RoadHazardInd (by restriction) |
---|---|
Sub-types: | None |
Name | RoadHazardInd |
---|---|
Documentation | Indicates whether Roadside hazard is covered in the contract More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Indicator (by restriction) < RoadsideAssistanceInd (by restriction) |
---|---|
Sub-types: | None |
Name | RoadsideAssistanceInd |
---|---|
Documentation | Indicates whether coverage includes roadside assistance More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Type (by restriction) < SaleCategory (by restriction) |
---|---|
Sub-types: | None |
Name | SaleCategory |
---|---|
Documentation | Category of sale More information at: http://www.starstandard.org. |
Super-types: | xsd:string < SaleClass (by restriction) |
---|---|
Sub-types: | None |
Name | SaleClass |
---|---|
Documentation | Class of sale. More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
New | Never owned. |
Used | Previously Owned |
Demo | Demonstration item. |
Other | Other |
N/A | Not Applicable |
Floor Sample | This is a vehicle that is provided in the showroom as an example. |
Factory | Identifies that the vehicle may have been used as a product demonstration for an official or executive from the manufacturer. |
Super-types: | xsd:date < Date (by restriction) < SalesDate (by restriction) |
---|---|
Sub-types: | None |
Name | SalesDate |
---|---|
Documentation | Date sales paperwork signed More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Type (by restriction) < SaleSubCategory (by restriction) |
---|---|
Sub-types: | None |
Name | SaleSubCategory |
---|---|
Documentation | Code to extend the category of sale More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < Salutation (by restriction) |
---|---|
Sub-types: | None |
Name | Salutation |
---|---|
Documentation | Title or greeting of business party More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < SecondaryPassword (by restriction) |
---|---|
Sub-types: | None |
Name | SecondaryPassword |
---|---|
Documentation | Secondary password used to validate access to the dealer information More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < SecurityCode (by restriction) |
---|---|
Sub-types: | None |
Name | SecurityCode |
---|---|
Documentation | Vehicle security code for entry or backup security More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < SellingSource (by restriction) |
---|---|
Sub-types: | None |
Name | SellingSource |
---|---|
Documentation | Code to determine souce brand of sale (i.e., OEM division) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < SerialNumber (by restriction) |
---|---|
Sub-types: |
|
Name | SerialNumber |
---|---|
Documentation | Serial Number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < ShortMfg (by restriction) |
---|---|
Sub-types: | None |
Name | ShortMfg |
---|---|
Documentation | Short Manfacturer or RSP Codes More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < SortName (by restriction) |
---|---|
Sub-types: | None |
Name | SortName |
---|---|
Documentation | Index name used as a sort for report purposes More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < SpecialPrograms (by restriction) |
---|---|
Sub-types: | None |
Name | SpecialPrograms |
---|---|
Documentation | Code identifying the type of special program (First Time Buyer, College Graduate, etc. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < StateOrProvince (by restriction) |
---|---|
Sub-types: |
|
Name | StateOrProvince |
---|---|
Documentation | Is the State or Province of a given Address. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < StatusCode (by restriction) |
---|---|
Sub-types: | None |
Name | StatusCode |
---|---|
Documentation | A code identifying the reason for the status message. More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Success | The operation completed successfully. This does not necessarily mean that the BOD was processed. Instead it means that the client's role is done and that it won't receive any error messages later. Type of Response Code: Success. |
Unspecified | An unspecified error occurred. The StatusText field contains the complete text. |
Not In Inventory | Inventory is not currently available and back ordering was not requested. |
Discontinued | The part has discontinued. |
Invalid Part | Invalid part number. |
Not Yet Available | The part is scheduled for a future release date and is not available at this time. |
Not Authorized | The part is not authorized for your product line. |
Under Development | The part is under development and not ready for sale. |
Assembly Only | The part is a component part and is only available as an assembly. |
Component Only | The part is an assembly part and is only available as a component. |
Internal Use Only | The part is reserved for manufacturing and supplier internal use; it is not a service replacement part. |
Recalled | The part has been recalled. |
Cannot Sell | The part is not available for sale for an unspecified reason. |
Export Only | The part is not available for sale in the United States; it is for export vehicles only. |
Credit Limit Exceeded | Credit limit exceeded. |
Credit Card Denied | Credit card transaction denied by creditor. |
Account On Hold | The dealer's account has been put on hold. |
Invalid Unit Of Measure | The unit of measurement was invalid for this part number. |
Invalid Promotion Code | The promotion code is invalid. |
Invalid Shipping Method | The shipping method is invalid, for example, shipping by ground to Puerto Rico. |
Duplicate Line Number | The line number is the same as another line within this transaction. |
No Drop Shipment | Drop shipments are not allowed. |
No Will Call | Will-call pickups are not allowed. |
Minimum Quantity Not Met | There is a minimum quantity purchase requirement for this part and the quantity has not been met. The minimum quantity is: NN |
Other | Other |
N/A | Not Applicable |
Super-types: | xsd:string < Text (by restriction) < StatusText (by restriction) |
---|---|
Sub-types: | None |
Name | StatusText |
---|---|
Documentation | Descriptive status text. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < StatusType (by restriction) |
---|---|
Sub-types: | None |
Name | StatusType |
---|---|
Documentation | Defines the type of status that occurred. EX: S-Success, E-Error, I-Info, A-Abort More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Success | The operation completed successfully. This does not necessarily mean that the BOD was processed. Instead it means that the client's role is done and that it won't receive any error messages later. Type of Response Code: Success. |
Error | The operation resulted in error and did not succeed. |
Warning | The operation completed a warning. |
Informational | The provided StatusText is informational. |
Other | Other |
N/A | Not Applicable |
Super-types: | xsd:string < Code (by restriction) < SubventionCode (by restriction) |
---|---|
Sub-types: | None |
Name | SubventionCode |
---|---|
Documentation | Identifies a subvention program More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < Suffix (by restriction) |
---|---|
Sub-types: | None |
Name | Suffix |
---|---|
Documentation | Business Party name suffix designation if individual Ex: Sr, Jr, III, etc. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < ReferenceNumber (by restriction) < SystemVersion (by restriction) |
---|---|
Sub-types: | None |
Name | SystemVersion |
---|---|
Documentation | The sender's software version number . More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < TaxabilityInd (by restriction) |
---|---|
Sub-types: | None |
Name | TaxabilityInd |
---|---|
Documentation | Determines whether an item or amount is taxable. More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < TaxType (by restriction) |
---|---|
Sub-types: | None |
Name | TaxType |
---|---|
Documentation | Tax Type More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Total | |
Amount | |
Labor | |
Parts | |
Claim | |
Dealer | Dealer |
Deductible | |
Prorated | |
Other | Other |
Luxury | |
Vehicle Inventory | |
Taxes Not In Cash Price | |
Document Stamp | |
Sales | |
Tire | |
Personal Property | |
Registration | |
Monthly/Use | |
Weight | |
Adjustment | |
DownPayment | |
CapCostReduction | |
Lieu | |
CurrentYear | |
N/A | Not Applicable |
LocalOption | Tennessee Tax - combination of city and county. |
SingleArticle | Tennessee Tax - State Tax |
Gas | Gas tax levied to applicable vehicles or by state/province law. (Referred to in US as "Gas Guzzler" tax). |
Total Monthly/Use | The total amount of monthly use tax for a payment on a contract. |
Service Contract | Tax charged on service contracts (where applicable). |
Adjusted Sales | Adjusted sales tax due to tax modifications when capitalized (i.e. NY) |
Total Sales/Use | The total amount of sales/use tax for a single payment contract. |
Air Conditioning Excise | Provincal tax providing for the installation or removal of freon. (Canada) |
Purchase and Use | A type of tax that is assessed upon "tax free" tangible personal property purchased by a resident of the assessing state for use, storage or consumption of goods in that state (not for resale), regardless of where the purchase took place. The tax is a one time retail tax due at registration or titling of a vehicle. |
County Tax | A county tax charged based on the location of the dealer and the customer. An example, The Cook County Tax. |
General Excise | This is a general excise tax that a state or region could impose. |
Gross Receipt | A gross receipts tax, sometimes referred to as a gross excise tax, is a tax on the total gross revenues of a company, regardless of their source. |
Tax on Trade-In | Tax due on a trade-in vehicle. |
Tax on Upfront Fees | Total tax due on fees paid upfront. |
Tax on Acquisition Fee | Tax due on amount of acquisition fee. |
Environmental Tax | Environmental Levy / Tax. |
Motor Vehicle Tax | Tax paid at of registration based on the vehicle's age and MSRP. |
Wheel Tax | A tax levied by cities and villages to be credited to a road fund of the city or village |
Super-types: | xsd:string < TaxTypeId (by restriction) |
---|---|
Sub-types: | None |
Name | TaxTypeId |
---|---|
Documentation | CS - City, CP - County, ST - State, OT - Other, EX - Excise, VAT - Value Added Tax, PST - Provincial Sales Tax , RT - Rental, GST - Goods and Services Tax, HST - Harmonized Tax, ART - Air Tax, QST - Quebec Sales Tax, IMP - Import Tax More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
CS | City |
CP | County |
ST | State |
OT | "OT" = Other |
EX | Excise |
VAT | Value Added |
PST | Provincial Sales Tax |
RT | Rental |
GST | Goods and Services Tax |
HST | Harmonized Tax |
ART | Air Tax |
QST | Quebec Sales Tax |
IMP | Import Tax |
Super-types: | xsd:string < Name (by restriction) < TeamName (by restriction) |
---|---|
Sub-types: | None |
Name | TeamName |
---|---|
Documentation | Name of team More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < TechnicianName (by restriction) |
---|---|
Sub-types: | None |
Name | TechnicianName |
---|---|
Documentation | Name of technician More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Type (by restriction) < TechnicianSkillArea (by restriction) |
---|---|
Sub-types: | None |
Name | TechnicianSkillArea |
---|---|
Documentation | Type of training required to perform the labor operation More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < TechnicianSkillLevel (by restriction) |
---|---|
Sub-types: | None |
Name | TechnicianSkillLevel |
---|---|
Documentation | Level of training required to perform the labor operation More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < TelematicsServiceInd (by restriction) |
---|---|
Sub-types: | None |
Name | TelematicsServiceInd |
---|---|
Documentation | Indication whether Telematics Service Subscription is turned on More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < TermLength (by restriction) |
---|---|
Sub-types: | None |
Name | TermLength |
---|---|
Documentation | Term Length More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Months | Months |
Weeks | Weeks |
Years | Years |
Super-types: | xsd:string < Text (by restriction) |
---|---|
Sub-types: |
|
Name | Text |
---|---|
Documentation | Indicates generic text type More information at: http://www.starstandard.org. |
Super-types: | xsd:string < LocationDescription (by restriction) < TireLocation (by restriction) |
---|---|
Sub-types: | None |
Name | TireLocation |
---|---|
Documentation | Location of tire on vehicle (i.e., Front Passenger, Front Driver, Rear Passenger, etc) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < SerialNumber (by restriction) < TireSerialNumber (by restriction) |
---|---|
Sub-types: | None |
Name | TireSerialNumber |
---|---|
Documentation | Tire Serial Number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < TradeInOffLeaseCode (by restriction) |
---|---|
Sub-types: | None |
Name | TradeInOffLeaseCode |
---|---|
Documentation | Indicates if a vehicle is a trade-in or is coming off lease. Ex: T or O More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < TransmissionCode (by restriction) |
---|---|
Sub-types: | None |
Name | TransmissionCode |
---|---|
Documentation | Transmission Serial Number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < TransmissionType (by restriction) |
---|---|
Sub-types: | None |
Name | TransmissionType |
---|---|
Documentation | Vehicle Transmission type - 3 = 3 speed, 4 = 4 speed, 5 = 5 speed, 6 = 6 speed, A - Automatic More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
3 | 3 Speed |
4 | 4 Speed |
5 | 5 Speed |
6 | 6 Speed |
A | "A" = Automatic |
Automatic 3 | Automatic 3 speed transmission type |
Automatic 4 | Automatic 4 speed transmission type |
Automatic 5 | Automatic 5 speed transmission type |
Automatic 6 | Automatic 6 speed transmission type |
Automatic 7 | Automatic 7 speed transmission type |
7 | 7 Speed |
CVT Automatic 3 | Continuously Variable T ransmission Automatic 3 speed transmission type (natural gas and hybrid). |
CVT Automatic 4 | Continuously Variable T ransmission Automatic 4 speed transmission type (natural gas and hybrid). |
CVT Automatic 5 | Continuously Variable T ransmission Automatic 5 speed transmission type (natural gas and hybrid). |
CVT Automatic 6 | Continuously Variable T ransmission Automatic 6 speed transmission type (natural gas and hybrid). |
CVT Automatic 7 | Continuously Variable T ransmission Automatic 7 speed transmission type (natural gas and hybrid). |
M | M = Manual |
Super-types: | xsd:string < Code (by restriction) < TrimCode (by restriction) |
---|---|
Sub-types: | None |
Name | TrimCode |
---|---|
Documentation | Manufacturer assigned trim code More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Type (by restriction) |
---|---|
Sub-types: |
|
Name | Type |
---|---|
Documentation | Type More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < UrbanizationCode (by restriction) |
---|---|
Sub-types: | None |
Name | UrbanizationCode |
---|---|
Documentation | Geographic definition of a metropolitan or suburban area More information at: http://www.starstandard.org. |
Super-types: | xsd:anyURI < URI (by restriction) |
---|---|
Sub-types: | None |
Name | URI |
---|---|
Documentation | URI More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < VehicleArrivalDate (by restriction) |
---|---|
Sub-types: | None |
Name | VehicleArrivalDate |
---|---|
Documentation | The Date the original retail vehicle is delivered to a dealer More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < VehicleDemoInd (by restriction) |
---|---|
Sub-types: | None |
Name | VehicleDemoInd |
---|---|
Documentation | Indicates whether vehicle was ever a demo More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Note (by restriction) < VehicleNote (by restriction) |
---|---|
Sub-types: | None |
Name | VehicleNote |
---|---|
Documentation | Any vehicle related notes More information at: http://www.starstandard.org. |
Super-types: | xsd:string < ReferenceNumber (by restriction) < VehicleStock (by restriction) |
---|---|
Sub-types: | None |
Name | VehicleStock |
---|---|
Documentation | Dealer assigned vehicle stock number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < VIN (by restriction) |
---|---|
Sub-types: | None |
Name | VIN |
---|---|
Documentation | Federally defined 17 position vehicle identification number More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < WarrantyExpirationDate (by restriction) |
---|---|
Sub-types: | None |
Name | WarrantyExpirationDate |
---|---|
Documentation | Last Date of vehicle warranty coverage for warranty currently in force at time of repair More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < WarrantyNotes (by restriction) |
---|---|
Sub-types: | None |
Name | WarrantyNotes |
---|---|
Documentation | Any Warranty related Notes More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < WarrantyRemaining (by restriction) |
---|---|
Sub-types: | None |
Name | WarrantyRemaining |
---|---|
Documentation | Defines how much warranty is left, either in time or miles More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < WarrantyStartDate (by restriction) |
---|---|
Sub-types: | None |
Name | WarrantyStartDate |
---|---|
Documentation | Start Date of vehicle warranty More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < WarrantyStatus (by restriction) |
---|---|
Sub-types: | None |
Name | WarrantyStatus |
---|---|
Documentation | Whether warranty is still applicable More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < WarrantyTransferInd (by restriction) |
---|---|
Sub-types: | None |
Name | WarrantyTransferInd |
---|---|
Documentation | Indicates if warranty is transferable More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:gYear < Year (by restriction) |
---|---|
Sub-types: |
|
Name | Year |
---|---|
Documentation | Year More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < ZoneCode (by restriction) |
---|---|
Sub-types: | None |
Name | ZoneCode |
---|---|
Documentation | Manufacturer Assigned Zone Code More information at: http://www.starstandard.org. |
Identification Record |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Creator Name Code |
DCS software creator code |
100242 |
Application Area - Sender/CreatorNameCode |
|
2 |
Creator Software Code |
DCS software code name |
100244 |
Application Area - Sender/Component |
|
3 |
Interface Version |
Software release version |
100220 |
Application Area - Sender/SystemVersion |
|
4 |
Transaction Create Date |
Date the transaction was created |
100430 |
Application Area - CreationDateTime |
|
5 |
Transaction Create Time |
Time the transaction was created |
100440 |
Application Area - CreationDateTime |
|
6 |
Dealer Number |
Dealer code number |
100210 |
Application Area - Sender or Destination/DealerNumber |
|
7 |
Store Number |
Dealer code store number (DMS assigned) |
100240 |
Application Area - Sender or Destination/StoreNumber |
|
8 |
Area Number |
Dealer code area number (DMS vendor assigned) |
100200 |
Application Area - Sender or Destination/AreaNumber |
|
9 |
Destination Name Code |
Code for destination of file - Short Manufacturer or Short DSP code |
106190 |
Application Area - Destination/DestinationNameCode |
|
10 |
Destination Software |
For which software destination file is intended (May not be known) |
106200 |
Application Area - Destination/DestinationSoftware |
|
11 |
Transaction Type Code |
Transaction type code indicates action to be taken for all records in this transaction set (Will not be in the BODs. Will be handled by OAGI verb) |
106210 |
Not Needed in BOD - Transaction type is specified by OAGI XML verb |
|
12 |
Dealer Country |
Dealer country location |
108430 |
Application Area - Sender/DealerContry |
|
13 |
Reference ID |
Enables the sending application to indicate the instance identifier of the event or task that caused the transaction to be created. This is used to correlate a response transaction to an origination transaction |
112260 |
Application Area - Sender/ReferenceId |
|
14 |
SenderPartyId |
The Party Id field uniquely identifies the Sender 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. |
112261 |
Application Area - Sender/PartyId |
|
15 |
SenderLocationId |
The Location Id field uniquely identifies the location of the Sender 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. |
11262 |
Application Area - Sender/LocationId |
|
16 |
SenderServiceId |
The Service Id field identifies the particular service to which a message is being sent from, e.g., an inventory service. |
11263 |
Application Area - Sender/ServiceId |
|
17 |
DestinationPartyId |
The 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. |
11264 |
Application Area - Destination/PartyId |
|
18 |
DestinationLocationId |
The 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. |
11265 |
Application Area - Destination/LocationId |
|
19 |
DestinationServiceId |
The Service Id field identifies the particular service to which a message is being sent to, e.g., an inventory service. |
11266 |
Application Area - Destination/ServiceId |
|
Vehicle |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Sales Deal Number |
Dealer or DMS assigned deal number |
103600 |
Header/DealNumber |
|
2 |
Sales Stock Number |
Dealer assigned vehicle stock number of the sale |
103620 |
Vehicle/VehicleStock |
|
3 |
Vehicle Identification Number |
Federally defined 17 position vehicle identification number |
103680 |
Vehicle/VIN |
|
5 |
PDI Date |
Date Pre-Delivery Inspection completed at dealership |
103570 |
Vehicle/PDI Date |
|
6 |
Sales Date |
Date sales paperwork signed |
103590 |
Header/SalesDate |
|
7 |
Sales Delivery Date |
Date vehicle physically delivered to buyer |
103610 |
Vehicle/DeliveryDate |
|
8 |
Warranty Start Service Date |
Demo in service date and/or Warranty start date |
103640 |
Vehicle - Warranty/WarrantyStartDate |
|
9 |
Dealer Transfer Date |
Date transferred to retailing dealer |
103670 |
Header/DealerTransferDate |
|
10 |
Sales Delivery Mileage |
Odometer reading at sales delivery date |
103550 |
Vehicle/DeliveryMileage |
|
11 |
Mileage Type |
Mileage measurement type |
103560 |
Vehicle/DeliveryMileage (attribute) |
|
14 |
License Plate |
State issued license plate number |
103540 |
Vehicle/LicenseNumber |
|
15 |
Registration State |
State or province of vehicle registration |
103580 |
Vehicle/RegistrationState |
|
16 |
Security Code |
Vehicle security code for entry or backup security |
103630 |
Vehicle/SecurityCode |
|
17 |
Vehicle Demo Flag |
Indicates whether vehicle was ever a demo |
105440 |
Vehicle/VehicleDemoInd |
|
18 |
Vehicle Acquisition Method |
Indicates the way the vehicle was acquired by retailer |
106750 |
Header/AcquisitionMethod |
|
19 |
Vehicle Ignition Key Number |
Ignition key number |
106030 |
Vehicle/IgnitionKeyNumber |
|
Sale |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Sale Class |
Class of Sale |
103130 |
Vehicle/SaleClass |
|
2 |
Certified Preowned Flag |
Identifies as a certified pre-owned vehicle |
102156 |
Vehicle/CertifiedPreownedInd |
|
3 |
Sale Type |
Type of sale code - EX: Retail, Fleet, Lease, Demo, Transfer, Certified used, Used, Select, Export, etc. |
103140 |
Header/SaleCategory |
|
4 |
Transferring Dealer |
Manufacturer assigned code of transferring dealer |
103150 |
TransferringDealer/PartyId |
|
5 |
Transferring Dealer City |
City of transferring dealer |
103160 |
TransferringDealer/Address/City |
|
6 |
First Salesperson Emp ID Code |
First Salesperson's employee identification code |
102730 |
SalesPerson /PartyId |
|
7 |
First Salesperson Name |
First Salesperson's name |
102740 |
SalesPerson /Name |
|
8 |
First Salesperson SSN |
First salesperson's social security number |
102750 |
SalesPerson /AlternatePartyIds |
|
9 |
Second Salesperson Emp ID Code |
Second salesperson's employee identification code |
102732 |
SalesPerson /PartyId |
|
10 |
Second Salesperson Name |
Second salesperson's name |
102742 |
SalesPerson / Name |
|
11 |
Second Salesperson SSN |
Second Salesperson's social security number |
102752 |
SalesPerson /AlternatePartyIds |
|
12 |
Third Salesperson Emp ID Code |
Third salesperson's employee identification code |
102734 |
SalesPerson /PartyId |
|
13 |
Third Salesperson Name |
Third salesperson's name |
102744 |
SalesPerson / Name |
|
14 |
Third Salesperson SSN |
Third salesperson's social security number |
102754 |
SalesPerson /AlternatePartyIds |
|
15 |
Sales Manager Emp ID Code |
Sales manager employee identification code |
102700 |
SalesManager /PartyId |
|
16 |
Sales Manager Name |
Sales manager name |
102710 |
SalesManager /Name |
|
17 |
Sales Manager SSN |
Sales manager social security number |
102720 |
SalesManager /AlternatePartyIds |
|
18 |
PDI Technician Emp ID Code |
PDI technician employee identification code |
102640 |
Vehicle - PDITechnician/PartyId |
|
19 |
PDI Technician Name |
PDI technician name |
102650 |
Vehicle - PDITechnician/TechnicianName |
|
20 |
PDI Technician SSN |
PDI technician social security number |
102660 |
Vehicle - PDITechnician/AlternatePartyIds |
|
21 |
Closer FI Manager Name |
Closer / F&I Manager name |
103120 |
FIManager/Name |
|
22 |
Closer FI Manager Emp ID Code |
Closer FI Manager employee identification code |
107730 |
FIManager/PartyId |
|
23 |
Closer FI Manager SSN |
Closer FI Manager social security number |
107740 |
FIManager/AlternatePartyIds |
|
24 |
First Salesperson Address 1 |
First salesperson address information |
107410 |
SalesPerson - Address/Address |
|
25 |
First Salesperson Address 2 |
First salesperson supplemental address information |
107420 |
SalesPerson - Address/Address |
|
26 |
First Salesperson City |
First salesperson city of residence |
107430 |
SalesPerson - Address/City |
|
27 |
First Salesperson State |
First Salesperson state or province of residence |
107440 |
SalesPerson - Address/State |
|
28 |
First Salesperson Zip Code |
First Salesperson zip or postal code |
107450 |
SalesPerson - Address/PostalCode |
|
29 |
Fleet Account |
Manufacturer defined fleet account number |
102116 |
Vehicle/FleetAccount |
|
30 |
Sale Sub Type |
Code to extend the type of sale |
110730 |
Header/SaleSubCategory |
|
31 |
Location ID |
Code identifying the physical location of a dealer. |
110910 |
Header/LocationId |
|
TradeIn |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Trade In Year |
Model year of trade in vehicle - Usually available in the VIN number (use NCIC code) |
103530 |
TradeIn/ModelYear |
|
2 |
Trade In Make |
Vehicle make code of trade in vehicle -Usually available in the VIN number (use NCIC code) |
103480 |
TradeIn/Make |
|
3 |
Trade In Model |
Manufacturer-assigned model code of trade in vehicle - Sales version of vehicle is usually available in the VIN number (use NCI |
103510 |
TradeIn/Model |
|
4 |
Trade In VIN |
VIN of trade in vehicle |
103520 |
TradeIn/VIN |
|
5 |
Trade In Color |
Exterior color description of trade in vehicle |
103470 |
TradeIn/ExteriorColor |
|
6 |
Trade In Mileage |
Odometer reading of trade in vehicle when received by dealer |
103490 |
TradeIn/TradeInMileage |
|
7 |
Trade In Mileage Type |
Mileage measurement type |
103500 |
TradeIn/TradeInMileage (attribute) |
|
8 |
Manufacturer Name |
Manufacture of the trade-in. |
108260 |
TradeIn/Manufacturer |
|
9 |
Trade In Off Lease Code |
Indicates if a vehicle is a trade-in or is coming off lease. |
110880 |
TradeIn/ TradeInOffLeaseCode |
|
Buyer |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Buyer Type |
Type of buyer |
102190 |
Not Required - Will be on either IndividualBuyer or OrganizationalBuyer |
|
2 |
Buyer Gender |
Gender of buyer |
102080 |
IndividualBuyer - Demographics/Gender |
|
3 |
Buyer Salutation |
Title greeting of buyer (if an individual) - Not used for Company buyer. Ex - Mr., Ms., etc. |
102140 |
IndividualBuyer - PersonName/Salutation |
|
4 |
Buyer Last Name |
Last name of buyer, if an individual - Not used if Company is buyer |
102120 |
IndividualBuyer - PersonName/LastName |
|
5 |
Buyer First Name |
First name of buyer, if an individual - Not used if Company is buyer |
102070 |
IndividualBuyer - PersonName/FirstName |
|
6 |
Buyer Middle Initial or Name |
Middle Initial or Name of buyer, if an individual - Not used if Company is buyer |
102100 |
IndividualBuyer - PersonName/MiddleInitial |
|
7 |
Buyer Suffix |
Buyer name suffix designation (if an individual) - Not used if Company is buyer Ex. Sr, Jr, III, etc. |
102180 |
IndividualBuyer - PersonName/Suffix |
|
8 |
Buyer Address1 |
Buyer address information |
101990 |
IndividualBuyer - IndivualAddress/AddressLine |
|
9 |
Buyer Address2 |
Buyer supplemental address information |
102000 |
IndividualBuyer - IndivualAddress/AddressLine |
|
10 |
Buyer City |
Buyer Company city or Individual city of residence |
102020 |
IndividualBuyer - IndivualAddress/City |
|
11 |
Buyer State |
Buyer state or province |
102170 |
IndividualBuyer - IndivualAddress/StateOrProvince |
|
12 |
Buyer Zip Code |
Buyer zip or postal code |
102210 |
IndividualBuyer - IndivualAddress/PostalCode |
|
13 |
Buyer Country |
Buyer Company country location or Individual country of residence |
102030 |
IndividualBuyer - IndivualAddress/Country |
|
14 |
Buyer Language |
Buyer's native language |
102110 |
IndividualBuyer - Demographics/Language |
|
15 |
Buyer Evening Phone |
Buyer evening phone, if an individual |
102090 |
IndividualBuyer - Contact/Telephone(Evening Phone) |
|
16 |
Buyer Day Phone |
Buyer Company telephone number or Individual buyer day telephone number |
102200 |
IndividualBuyer - Contact/Telephone(Day Phone) |
|
17 |
Buyer Fax Telephone Number |
Buyer fax telephone number |
102060 |
IndividualBuyer - Contact/Fax(Home) |
|
18 |
Buyer Email Address |
Buyer Email address |
102050 |
IndividualBuyer - Contact/Email(Home) |
|
19 |
Buyer SSN |
Buyer social security number, if an individual |
102160 |
IndividualBuyer - AlternatePartyId/LegalId |
|
20 |
Buyer Birthdate |
Buyer Birth date, if an individual |
102010 |
IndividualBuyer - Demographics/BirthDate |
|
21 |
Buyer Driver Name |
Name of person driving buyer's vehicle |
102155 |
SecondaryDriver /DriverAction |
|
22 |
Primary Driver Flag |
Identifies customer as primary driver |
102150 |
IndividualBuyer /PrimaryDriverInd |
|
23 |
Day Phone Extension |
Company telephone number extension or Individual's day telephone number extension |
107480 |
IndividualBuyer - Contact/Telephone(Day Phone) - Attribute "exten" |
|
24 |
Customer Cell Phone |
Customer cell phone number |
107490 |
IndividualBuyer - Contact/Telephone(Cell Phone) |
|
25 |
Customer Mail Flag |
Flag to note customers whom have requested no marketing mail |
107500 |
IndividualBuyer /MarketingMailInd |
|
26 |
Company Name |
Company name, if owner of the vehicle. If an individual owns vehicle, this data element would not be used for repair order or |
103720 |
OrganizationalBuyer /CompanyName |
|
27 |
Customer Pager Number |
Vehicle Owner's contact pager number |
106950 |
IndividualBuyer - Contact/Telephone(Pager) |
|
28 |
Customer Preferred Contact Method |
Customer's preferred method of contact |
106970 |
IndividualBuyer - Contact/PreferredContactMethod |
|
29 |
Customer ID |
Manufacturer specific customer identifier - Assigned by the manufacturer for each customer |
106930 |
IndividualBuyer /PartyId |
|
30 |
Preferred Language |
Customer's preferred language |
110720 |
IndividualBuyer - Demographics/ PreferredLanguage |
|
31 |
Customer First Time Buyer Flag |
Indicates buyer's first purchased with the manufacture. |
102122 |
IndividualBuyer - Demographics/ FirstTimeBuyerInd |
|
32 |
DMS Customer ID |
The system assigned number associated with a customer entity |
112150 |
IndividualBuyer/DMSCustomerId |
|
Privacy |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Privacy Indicator |
Indicator to note that Business Party has requested to share or to not share information with third parties. |
110970 |
IndividualBuyer - Privacy/PrivacyInd |
|
2 |
Privacy Type |
Code identifying a Party's authorized privacy rights. (i.e., Financial, Demographics, etc.) |
110980 |
IndividualBuyer - Privacy/PrivacyType |
|
Co-Buyer |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Co Buyer Type |
Type of co-buyer (i.e., Business or Individual) |
102420 |
Not Required - Will be on either IndividualBuyer or OrganizationalBuyer |
|
2 |
Co Buyer Gender |
Gender of co-buyer |
102310 |
IndividualCo-Buyer - Demographics/Gender |
|
3 |
Co Buyer Salutation |
Title greeting of co-buyer (if an individual) - Not used if Company is co-buyer. Ex - Mr., Ms., etc. |
102370 |
IndividualCo-Buyer - PersonName/Salutation |
|
4 |
Co Buyer Last Name |
Last name of co-buyer, if an individual - Not used if Company is co-buyer |
102350 |
IndividualCo-Buyer - PersonName/LastName |
|
5 |
Co Buyer First Name |
First name of co-buyer, if an individual - Not used if Company is co-buyer |
102300 |
IndividualCo-Buyer - PersonName/FirstName |
|
6 |
Co Buyer Middle Initial or Name |
Middle Initial or Name of co-buyer, if an individual - Not used if Company is co-buyer |
102330 |
IndividualCo-Buyer - PersonName/MiddleInitial |
|
7 |
Co Buyer Suffix |
Co-buyer name suffix designation (if an individual) - Not used if Company is co-buyer. Ex. Sr, Jr, III, etc. |
102410 |
IndividualCo-Buyer - PersonName/Suffix |
|
8 |
Co Buyer Address1 |
Co-buyer address information |
102220 |
IndividualCo-Buyer - IndivualAddress/AddressLine |
|
9 |
Co Buyer Address2 |
Co-buyer supplemental address information |
102230 |
IndividualCo-Buyer - IndivualAddress/AddressLine |
|
10 |
Co Buyer City |
Co-buyer Company city or Individual city of residence |
102250 |
IndividualCo-Buyer - IndivualAddress/City |
|
11 |
Co Buyer State |
Co-buyer state or province |
102400 |
IndividualCo-Buyer - IndivualAddress/StateOrProvince |
|
12 |
Co Buyer Zip Code |
Co-buyer zip or postal code |
102440 |
IndividualCo-Buyer - IndivualAddress/PostalCode |
|
13 |
Co Buyer Country |
Co-buyer Company country location or Individual country of residence |
102260 |
IndividualCo-Buyer - IndivualAddress/Country |
|
14 |
Co Buyer Evening Phone |
Co-buyer evening phone, if an individual |
102320 |
IndividualCo-Buyer - Contact/Telephone(Evening Phone) |
|
15 |
Co Buyer Day Phone |
Co-buyer Company telephone number or Individual co-buyer day telephone number |
102430 |
IndividualCo-Buyer - Contact/Telephone(Day Phone) |
|
16 |
Co Buyer Fax Phone |
Co-buyer Fax telephone number |
102290 |
IndividualCo-Buyer - Contact/Fax(Home) |
|
17 |
Co Buyer Email Address |
Co-buyer Email address |
102280 |
IndividualCo-Buyer - Contact/Email(Home) |
|
18 |
Co Buyer SSN |
Co Buyer social security number, if an individual |
102390 |
IndividualCo-Buyer - AlternatePartyId/LegalId |
|
19 |
Co Buyer Birthdate |
Birthdate of co-buyer, if an individual |
102240 |
IndividualCo-Buyer - Demographics/BirthDate |
|
20 |
Co Buyer Primary Driver Flag |
Identifies co-buyer as primary driver |
102380 |
IndividualCo-Buyer /PrimaryDriverInd |
|
21 |
Day Phone Extension |
Company telephone number extension or Individual's day telephone number extension |
107480 |
IndividualCo-Buyer - Contact/Telephone(Day Phone) - attribute "exten" |
|
22 |
Customer Cell Phone |
Customer cell phone number |
107490 |
IndividualCo-Buyer - Contact/Telephone(Cell Phone) |
|
23 |
Customer Mail Flag |
Flag to note customers whom have requested no marketing mail |
107500 |
IndividualCo-Buyer /MarketingMailInd |
|
24 |
Co Buyer Language |
Co buyer's native language |
102340 |
IndividualCo-Buyer - Demographics/Language |
|
25 |
Driver Name |
Name of person driving vehicle |
107550 |
SecondaryDriver /DriverAction |
|
26 |
Company Name |
Company name, if owner of the vehicle. If an individual owns vehicle, this data element would not be used for repair order or |
103720 |
OrganizationalCo-Buyer /CompanyName |
|
27 |
Customer Pager Number |
Vehicle Owner's contact pager number |
106950 |
IndividualCo-Buyer - Contact/Telephone(Pager) |
|
28 |
Customer Preferred Contact Method |
Customer's preferred method of contact |
106970 |
IndividualCo-Buyer - Contact/PreferredContactMethod |
|
29 |
Customer ID |
Manufacturer specific customer identifier - Assigned by the manufacturer for each customer |
106930 |
IndividualCo-Buyer /PartyId |
|
30 |
Preferred Language |
Customer's preferred language |
110720 |
IndividualCo-Buyer - Demographics / PreferredLanguage |
|
31 |
DMS Customer ID |
The system assigned number associated with a customer entity |
112150 |
IndividualCo-Buyer/DMSCustomerId |
|
Primary Driver |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Primary Driver Type |
Type of primary driver |
103090 |
Not Required - Will be on either IndividualBuyer or OrganizationalBuyer |
|
2 |
Primary Driver Gender |
Gender of primary driver |
102990 |
PrimaryDriver - Demographics/Gender |
|
3 |
Primary Driver Salutation |
Title greeting of primary driver (if an individual) - Not used if Company is primary driver. Ex - Mr., Ms., etc. |
103050 |
PrimaryDriver - PersonName/Salutation |
|
4 |
Primary Driver Last Name |
Last name of primary driver, if an individual - Not used if Company is primary driver |
103030 |
PrimaryDriver - PersonName/LastName |
|
5 |
Primary Driver First Name |
First name of primary driver, if an individual - Not used if Company is primary driver |
102980 |
PrimaryDriver - PersonName/FirstName |
|
6 |
Primary Driver Middle Initial or Name |
Middle Initial or Name of primary driver, if an individual - Not used if Company is primary driver |
103010 |
PrimaryDriver - PersonName/MiddleInitial |
|
7 |
Primary Driver Suffix |
Primary driver name suffix designation (if an individual) - Not used if Company is primary driver. Ex. Sr., Jr., III, etc. |
103080 |
PrimaryDriver - PersonName/Suffix |
|
8 |
Primary Driver Address1 |
Primary driver address information |
102910 |
PrimaryDriver - IndivualAddress/AddressLine |
|
9 |
Primary Driver Address2 |
Primary driver supplemental address information |
102920 |
PrimaryDriver - IndivualAddress/AddressLine |
|
10 |
Primary Driver City |
Primary Driver Company city or Individual city of residence |
102930 |
PrimaryDriver - IndivualAddress/City |
|
11 |
Primary Driver State |
Primary driver State or province |
103070 |
PrimaryDriver - IndivualAddress/StateOrProvince |
|
12 |
Primary Driver Zip Code |
Primary driver zip or postal code |
103110 |
PrimaryDriver - IndivualAddress/PostalCode |
|
13 |
Primary Driver Country |
Primary Driver Company country location or Individual country of residence |
102940 |
PrimaryDriver - IndivualAddress/Country |
|
14 |
Primary Driver Evening Phone |
Primary driver evening phone, if an individual |
103000 |
PrimaryDriver - Contact/Telephone(Evening Phone) |
|
15 |
Primary Driver Day Phone |
Primary Driver Company telephone number or Individual primary driver day telephone number |
103100 |
PrimaryDriver - Contact/Telephone(Day Phone) |
|
16 |
Primary Driver Fax Phone |
Primary Driver Fax telephone number |
102970 |
PrimaryDriver - Contact/Fax(Home) |
|
17 |
Primary Driver Email Address |
Primary driver Email address |
102960 |
PrimaryDriver - Contact/Email(Home) |
|
18 |
Primary Driver SSN |
Primary driver social security number, if an individual |
103060 |
PrimaryDriver - AlternatePartyId/LegalId |
|
19 |
Customer Birthdate |
Birthdate of customer |
107530 |
PrimaryDriver - Demographics/BirthDate |
|
20 |
Primary Driver Flag |
Identifies customer as primary driver |
102150 |
PrimaryDriver /PrimaryDriverInd |
|
11 |
Primary Driver State |
Primary driver State or province |
103070 |
PrimaryDriver - IndivualAddress/StateOrProvince |
|
21 |
Day Phone Extension |
Company telephone number extension or Individual's day telephone number extension |
107480 |
PrimaryDriver - Contact/Telephone(Day Phone) - attribute "exten" |
|
22 |
Customer Cell Phone |
Customer cell phone number |
107490 |
PrimaryDriver - Contact/Telephone(Cell Phone) |
|
23 |
Customer Mail Flag |
Flag to note customers whom have requested no marketing mail |
107500 |
PrimaryDriver /MarketingMailInd |
|
24 |
Primary Driver Language |
Primary driver's native language |
103020 |
PrimaryDriver - Demographics/Language |
|
25 |
Driver Name |
Name of person driving vehicle |
107550 |
SecondaryDriver /DriverAction |
|
26 |
Company Name |
Company name, if owner of the vehicle. If an individual owns vehicle, this data element would not be used for repair order or |
103720 |
Organizational/CompanyName |
|
27 |
Customer Pager Number |
Vehicle Owner's contact pager number |
106950 |
PrimaryDriver - Contact/Telephone(Pager) |
|
28 |
Customer Preferred Contact Method |
Customer's preferred method of contact |
106970 |
PrimaryDriver - Contact/PreferredContactMethod |
|
29 |
Customer ID |
Manufacturer specific customer identifier - Assigned by the manufacturer for each customer |
106930 |
PrimaryDriver /PartyId |
|
30 |
Preferred Language |
Customer's preferred language |
110720 |
PrimaryDriver - Demographics/ PreferredLanguage |
|
31 |
DMS Customer ID |
The system assigned number associated with a customer entity |
112150 |
PrimaryDriver/DMSCustomerId |
|
Secondary Driver |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Secondary Driver Type |
Type of secondary driver |
103350 |
Not Required - Will be on either IndividualBuyer or OrganizationalBuyer |
|
2 |
Secondary Driver Gender |
Gender of secondary driver |
103250 |
SecondaryDriver - Demographics/Gender |
|
3 |
Secondary Driver Salutation |
Title greeting of secondary driver (if an individual) - Not used if Company is secondary driver. Ex - Mr., Ms., etc. |
103310 |
SecondaryDriver - PersonName/Salutation |
|
4 |
Secondary Driver Last Name |
Last name of secondary driver, if an individual - Not used if Company is secondary driver |
103290 |
SecondaryDriver - PersonName/LastName |
|
5 |
Secondary Driver First Name |
First name of secondary driver, if an individual - Not used if Company is secondary driver |
103240 |
SecondaryDriver - PersonName/FirstName |
|
6 |
Secondary Driver Middle Initial or Name |
Middle Initial or Name of secondary driver, if an individual - Not used if Company is secondary driver |
103270 |
SecondaryDriver - PersonName/MiddleInitial |
|
7 |
Secondary Driver Suffix |
Secondary driver name suffix designation (if an individual) - Not used if Company is secondary driver. Ex. Sr., Jr., III, etc. |
103340 |
SecondaryDriver - PersonName/Suffix |
|
8 |
Secondary Driver Address1 |
Secondary driver address information |
103170 |
SecondaryDriver - IndivualAddress/AddressLine |
|
9 |
Secondary Driver Address2 |
Secondary driver supplemental address information |
103180 |
SecondaryDriver - IndivualAddress/AddressLine |
|
10 |
Secondary Driver City |
Secondary Driver Company city or Individual city of residence |
103190 |
SecondaryDriver - IndivualAddress/City |
|
11 |
Secondary Driver State |
Secondary driver State or province |
103330 |
SecondaryDriver - IndivualAddress/StateOrProvince |
|
12 |
Secondary Driver Zip Code |
Secondary driver zip or postal code |
103370 |
PrimaryDriver - IndivualAddress/PostalCode |
|
13 |
Secondary Driver Country |
Secondary Driver Company country location or Individual country of residence |
103200 |
PrimaryDriver - IndivualAddress/Country |
|
14 |
Secondary Driver Evening Phone |
Secondary driver evening telephone, if an individual |
103260 |
SecondaryDriver - Contact/Telephone(Evening Phone) |
|
15 |
Secondary Driver Day Phone |
Secondary Driver Company telephone number or Individual secondary driver day telephone number |
103360 |
SecondaryDriver - Contact/Telephone(Day Phone) |
|
16 |
Secondary Driver Fax Phone |
Secondary Driver Fax telephone number |
103230 |
SecondaryDriver - Contact/Fax(Home) |
|
17 |
Secondary Driver Email Address |
Secondary driver Email address |
103220 |
SecondaryDriver - Contact/Email(Home) |
|
18 |
Secondary Driver SSN |
Secondary driver social security number, if an individual |
103320 |
SecondaryDriver - AlternatePartyId/LegalId |
|
19 |
Customer Birthdate |
Birthdate of customer |
107530 |
SecondaryDriver - Demographics/BirthDate |
|
20 |
Primary Driver Flag |
Identifies customer as primary driver |
102150 |
SecondaryDriver /PrimaryDriverInd |
|
21 |
Day Phone Extension |
Company telephone number extension or Individual's day telephone number extension |
107480 |
SecondaryDriver - Contact/Telephone(Day Phone) - attribute "exten" |
|
22 |
Customer Cell Phone |
Customer cell phone number |
107490 |
SecondaryDriver - Contact/Telephone(Cell Phone) |
|
23 |
Customer Mail Flag |
Flag to note customers whom have requested no marketing mail |
107500 |
SecondaryDriver /MarketingMailInd |
|
24 |
Secondary Driver Language |
Secondary driver's native language |
103280 |
SecondaryDriver - Demographics/Language |
|
25 |
Driver Name |
Name of person driving vehicle |
107550 |
SecondaryDriver /DriverAction |
|
26 |
Company Name |
Company name, if owner of the vehicle. If an individual owns vehicle, this data element would not be used for repair order or |
103720 |
Organizational/CompanyName |
|
27 |
Customer Pager Number |
Vehicle Owner's contact pager number |
106950 |
SecondaryDriver - Contact/Telephone(Pager) |
|
28 |
Customer Preferred Contact Method |
Customer's preferred method of contact |
106970 |
SecondaryDriver - Contact/PreferredContactMethod |
|
29 |
Customer ID |
Manufacturer specific customer identifier - Assigned by the manufacturer for each customer |
106930 |
SecondaryDriver /PartyId |
|
30 |
Preferred Language |
Customer's preferred language |
110720 |
SecondaryDriver - Demographics/ PreferredLanguage |
|
31 |
DMS Customer ID |
The system assigned number associated with a customer entity |
112150 |
SecondaryDriver/DMSCustomerId |
|
Finance |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Finance Type |
Type of financing - Examples may be F-Finance, L-Lease, C-Cash, etc. |
102780 |
Financing/FinanceType |
|
2 |
Contract Term |
Number of months of contract term |
102760 |
Financing/Term |
|
3 |
Maturity Date |
Month and year of contract maturity |
102800 |
Financing/MaturityDate |
|
4 |
Interest Rate or Money Factor |
Finance interest rate or lease money factor |
102790 |
Financing/AnnualPercentageRate |
|
5 |
Monthly Payment Amount |
Monthly payment amount |
102810 |
Financing/PaymentAmount |
|
6 |
Purchase Price Or Gross Cap Cost |
Purchase price or gross cap cost specified in deal |
102820 |
Financing/PurchasePrice |
|
7 |
Down Payment or Cap Cost Reduction |
Down payment amount or amount of cap cost reduction |
102770 |
Financing/DownPayment |
|
8 |
Promotional Rate Flag |
Promotional lease rate was used |
107560 |
Financing/PromotionalRateInd |
|
Bank/Leasing |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Bank Leasing Name |
Bank or leasing company |
101910 |
Financing/FinanceCompanyName |
|
2 |
Bank Leasing Address1 |
Bank or leasing company address information |
101790 |
Financing - Address/Address |
|
3 |
Bank Leasing Address2 |
Bank or leasing company supplemental address information |
101800 |
Financing - Address/Address |
|
4 |
Bank Leasing City |
Bank or leasing company city address |
101810 |
Financing - Address/City |
|
5 |
Bank Leasing State |
Bank or leasing company state or province |
101940 |
Financing - Address/StateOrProvince |
|
6 |
Bank Leasing Zip Code |
Bank or leasing company zip or postal code |
101980 |
Financing - Address/PostalCode |
|
7 |
Fleet Account |
Used when owner has a fleet account. |
102116 |
Financing/LessorFleetAccount |
|
8 |
Bank Phone |
Bank or Lease Company phone number |
110960 |
Financing - Contact/Telephone |
|
9 |
Preferred Language |
Customer's preferred language |
110720 |
Financing - Contact/PreferredLanguage |
|
Incentive |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Incentive Reimburse Program ID |
Manufacturer incentive reimbursement program identification |
102900 |
Vehicle-MarketingInitiatives/InitiativeId |
|
2 |
Incentive Reimburse Certificate Number |
Incentive Reimbursement certificate number |
102880 |
Vehicle-MarketingInitiatives/ReimbursementId |
|
3 |
Incentive Reimburse Comment |
Incentive Reimbursement dealer comments. |
102890 |
Vehicle-MarketingInitiatives/ReimbursementComment |
|
4 |
Incentive Reimburse Amount |
Incentive Reimbursement Amount |
102870 |
Vehicle-MarketingInitiatives/ReimbursementAmount |
|
5 |
Incentive Reimburse Descriptor |
Indicates who is paid the incentive - It can be either a code (D - Dealer or C - Customer) or the recipient name of reimbursem |
102850 |
Vehicle-MarketingInitiatives/ReimbursementPayee |
|
6 |
Incentive Fleet Number |
Manufacturer Fleet number |
102840 |
Vehicle-MarketingInitiatives/FleetAccount |
|
7 |
Incentive Rebate Amount |
The actual amount paid for the incentive rebate |
102860 |
Vehicle-MarketingInitiatives/ReimbursementAmount |
|
8 |
Incentive Coupon ID |
Incentive coupon identification number |
102830 |
Vehicle-MarketingInitiatives/ReimbursementId |
|
9 |
Incentive Date |
The date the incentive was processed. |
110790 |
Vehicle-MarketingInitiatives/InitiativeDate |
|
10 |
Demo Quantity |
Number of times vehicle was driven as a demo. |
110800 |
Vehicle-MarketingInitiatives/DemoCount |
|
ServiceContract |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Plan Code |
Service contract plan code |
103380 |
ServiceContract/PlanCode |
|
2 |
Service Contract Company Name |
Service contract company name |
103390 |
ServiceContract/ContractCompanyName |
|
3 |
Service Contract Type |
Service contract type and/or area of coverage |
103430 |
ServiceContract/ContractType |
|
4 |
Service Contract Term |
Service contract terms number of months |
103422 |
ServiceContract/Term |
|
5 |
Service Contract Term Mileage |
Mileage allowed under terms of service contract |
103420 |
ServiceContract/ContractTermMileage |
|
6 |
Service Contract Selling Price |
Service contract-selling price |
103410 |
ServiceContract/TotalContractAmount |
|
7 |
Service Contract Salesperson Emp ID Code |
Service contract salesperson employee identification code |
103440 |
ServiceContract - ServiceContractSalesPerson /PartyId |
|
8 |
Service Contract Salesperson Name |
Service contract salesperson name |
103450 |
ServiceContract - ServiceContractSalesPerson / Name |
|
9 |
Service Contract Salesperson SSN |
Service contract salesperson social security number |
103460 |
ServiceContract - ServiceContractSalesPerson /AlternatePartyId |
|
10 |
Service Contract Loaner Vehicle Flag |
Service contract loaner vehicle flag |
103400 |
ServiceContract/LoanerVehicleInd |
|
12 |
Mileage Type |
Mileage measurement type |
103560 |
ServiceContract/ContractTermMileage (Attribute) |
|
13 |
Deductible Amount |
Amount customer pays on service visit. |
110810 |
ServiceContract/ContractDeductible |
|
14 |
No Charge Flag |
Indicates customer was not charged for the service contract. |
110820 |
ServiceContract/NoChargeInd |
|
15 |
Original Vehicle In Service Date |
The date a used vehicle went in service. |
110870 |
ServiceContract/ OriginalInServiceDate |
|
16 |
Plan Mileage |
Odometer reading at the time of the sale of the plan. |
110830 |
ServiceContract/ContractStartMileage |
|
17 |
Plan Lien Flag |
Indicates the vehicle has a lien or the service contract was financed. |
110840 |
ServiceContract/ContractLienInd |
|
18 |
Plan Lien Name |
The name of the lien holder or service contract finacier. |
110850 |
ServiceContract - LienholderParty /Name |
|
19 |
Plan Purchase Date |
The date extended warranty was purchased. |
110860 |
ServiceContract/ContractStartDate |
|
GenuineAccessories |
|||||
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Dealer Installed |
Dealer installed accessories, before delivery of vehicle - Could be used for N/A or used vehicle, if applicable |
101740 |
Vehicle - Option/DealerInstalled |
|
2 |
Radio Serial Number |
Radio serial number |
101660 |
Vehicle - Option/OptionSerialNumber |
|
3 |
Radio Part Type |
Specifies whether the Radio parts are indicated by manufacturer part code or Part Number |
101760 |
Vehicle - Option/PartType |
|
4 |
Radio Part Number |
Radio part number |
101750 |
Vehicle - Option/ItemId |
|
5 |
CD Player Serial Number |
CD player serial number |
101650 |
Vehicle - Option/OptionSerialNumber |
|
6 |
CD Player Part Type |
Specifies whether the CD Player parts are indicated by manufacturer part code or Part Number |
101730 |
Vehicle - Option/PartType |
|
7 |
CD Player Part Number |
CD player part number |
101720 |
Vehicle - Option/ItemId |
|
8 |
CD Changer Serial Number |
CD changer serial number |
101640 |
Vehicle - Option/OptionSerialNumber |
|
9 |
CD Changer Part Type |
Specifies whether the CD changer parts are indicated by manufacturer part code or Part Number |
101710 |
Vehicle - Option/PartType |
|
10 |
CD Changer Part Number |
CD changer part number |
101700 |
Vehicle - Option/ItemId |
|
11 |
Security System Serial Number |
Security system serial number |
101670 |
Vehicle - Option/OptionSerialNumber |
|
12 |
Security System Part Type |
Specifies whether the security system parts are indicated by manufacturer part code or Part Number |
101780 |
Vehicle - Option/PartType |
|
13 |
Security System Part Number |
Security system part number |
101770 |
Vehicle - Option/ItemId |
|
14 |
Air Conditioner Kit Number |
Air conditioner kit number |
101690 |
Vehicle - Option/OptionSerialNumber |
|
15 |
Air Conditioner EVAP Number |
Air conditioner EVAP number |
101680 |
Vehicle - Option/ItemId |
|
|
|
|
|
|
|
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Generated by StarSchemaGuidelineGenerator based on xs3p. Last modified: