Implementation Guideline
Get Vehicle Inventory
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Implementation Guideline
Get Vehicle Inventory
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 Get Vehicle Inventory Business Object Document (BOD). Get Vehicle Inventory has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Get Vehicle Inventory 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 Get Vehicle Inventory, this BOD could be used to send Get Vehicle Inventory information between any two business parties.
The Get Vehicle Inventory Implementation Guidelines provide detailed information regarding the structure and meaning of the Get Vehicle Inventory BOD and corresponds directly to the Get Vehicle Inventory 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 Get Vehicle Inventory Implementation Guidelines must be used in concert with the Get Vehicle Inventory 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 Get Vehicle Inventory 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 Get Vehicle Inventory BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Get Vehicle Inventory 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 Get Vehicle Inventory 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 Get Vehicle Inventory Binary Collaboration starts with the sending of Vehicle Inventory information from the OEM to the Dealer. This process occurs on demand as needed. Note: This scenario is an example of how the Vehicle Inventory BOD can be used. Implemenations may vary. Note only the PartyId to be retrieved needs to be filled in the SoldToParty component.
The relationship diagram identifies all of the various components or building blocks of information used in the Get Vehicle Inventory 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 | Get |
|---|---|
| Type | Get |
| Nillable | no |
| Abstract | no |
| Documentation | The Get verb is to communicate to a business software component a request for an existing piece of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across most of the nouns it may be paired with.The Get is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The Get verb is not used to request several documents at once. The GetList verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned. More information at: http://www.openapplications.org/oagis. |
| Name | GetVehicleInventory |
|---|---|
| Type | GetVehicleInventory |
| Nillable | no |
| Abstract | no |
| Name | Header |
|---|---|
| Type | VehicleInventoryHeader |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | Invoice |
|---|---|
| Type | Invoice |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | VehicleInventory |
|---|---|
| Type | VehicleInventory |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
|
| Name | Verb |
|---|---|
| Type | Verb |
| Nillable | no |
| Abstract | yes |
| 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: | 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 | |
| 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 |
| 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 | |
| BrandedTitleDate | Branding Date | Optional | |
| 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: | xsd:string < Id (by extension) < CarrierId (by extension) |
|---|---|
| Sub-types: | None |
| Name | CarrierId |
|---|---|
| Abstract | no |
| Documentation | Carrier Code More information at: http://www.starstandard.org. |
| Super-types: | xsd:integer < Count (by extension) < CheckCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CheckCode |
|---|---|
| Abstract | no |
| Documentation | Checksum Ex: value for Model number and serial number combination More information at: http://www.starstandard.org. |
| 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 |
| 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: | 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: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 | |
| 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: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: | 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 | |
| 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 | |
| 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 | |
| ExteriorColor | Vehicle Exterior Color(s) | Optional | |
| TransmissionType | Vehicle Transmission type | Optional | |
| 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 | |
| VehicleDemoInd | Indicates whether vehicle was ever a demo | Optional | |
| LicenseNumber | State License plate number of vehicle | Optional | |
| BrandedInfo | Vehicle Branding Information | Optional | |
| RestrictionInd | Indication that vehicle has restrictions on its use | Optional | |
| 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 | |
| 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: | None |
|---|---|
| Sub-types: | None |
| Name | ExpressionCriteria |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| expressionLanguage | Optional |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| SelectExpression | Allows the 1-n number of selection expressions for the information to be returned. | Required |
| 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: | Verb < ConfirmableVerb (by extension) < RequestVerb (by extension) < Get (by extension) |
|---|---|
| Sub-types: | None |
| Name | Get |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| show | Required |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| ReturnCriteria | ReturnCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies. | Required |
| Super-types: | BusinessObjectDocument < GetVehicleInventory (by extension) |
|---|---|
| Sub-types: | None |
| Name | GetVehicleInventory |
|---|---|
| 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 | GetVehicleInventoryDataArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Get | The Get verb is to communicate to a business software component a request for an existing piece of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across most of the nouns it may be paired with.The Get is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The Get verb is not used to request several documents at once. The GetList verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned. | Required | |
| VehicleInventory | Required |
| 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 | |
| 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: | 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: | PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension) < IndividualOwnerPartyExtended (by extension) |
|---|---|
| Sub-types: | None |
| Name | IndividualOwnerPartyExtended |
|---|---|
| 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 | |
| PrimaryDriverInd | Identifies customer as primary driver | Optional | |
| DriverAction | Driver action (Ex: Drop-Off, Pick-Up, etc) | 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 | |
| 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: | Vehicle < VehicleBase (by extension) < ExpandedVehicle (by extension) < InventoryVehicle (by extension) |
|---|---|
| Sub-types: |
|
| Name | InventoryVehicle |
|---|---|
| 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 | |
| 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 | |
| ExteriorColor | Vehicle Exterior Color(s) | Optional | |
| TransmissionType | Vehicle Transmission type | Optional | |
| 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 | |
| VehicleDemoInd | Indicates whether vehicle was ever a demo | Optional | |
| LicenseNumber | State License plate number of vehicle | Optional | |
| BrandedInfo | Vehicle Branding Information | Optional | |
| RestrictionInd | Indication that vehicle has restrictions on its use | Optional | |
| 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 | |
| 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 | |
| VehicleStatus | Vehicle status code - Example status could be Built, Scheduled, Shipped, In-Transit, Sold, etc. | Optional | |
| VehicleShipDate | Date shipped from warehouse or distribution center | Optional | |
| VehicleOrderType | Identifies vehicle Invoice order type | Optional | |
| VehicleAllocatedDate | Date vehicle was allocated and/or a delivery work order was cut | Optional | |
| VehicleLocation | Indicates the physical location of the vehicle | Optional | |
| VehicleAcquisitionDate | Actual date vehicle was acquired by Dealership | Optional | |
| VehiclePricing | Vehicle Pricing | Optional | |
| ModelGroup | Grouping of similar models for order management purposes | Optional | |
| IndividualOwner | Individual who owns the vehicle | Optional | |
| OrganizationalOwner | Organization that owns the vehicle | Optional | |
| Tax | Vehicle Tax | Optional | |
| SoldTo | Business party who purchased the vehicle(s) | Optional | |
| ShipTo | Business party who the vehicle(s) was shipped to | Optional | |
| VehicleOrderNumber | Vehicle Order Number (VON) | Optional |
| Super-types: | Vehicle < VehicleBase (by extension) < ExpandedVehicle (by extension) < InventoryVehicle (by extension) < InventoryVehicleExtended (by extension) |
|---|---|
| Sub-types: | None |
| Name | InventoryVehicleExtended |
|---|---|
| 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 | |
| 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 | |
| ExteriorColor | Vehicle Exterior Color(s) | Optional | |
| TransmissionType | Vehicle Transmission type | Optional | |
| 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 | |
| VehicleDemoInd | Indicates whether vehicle was ever a demo | Optional | |
| LicenseNumber | State License plate number of vehicle | Optional | |
| BrandedInfo | Vehicle Branding Information | Optional | |
| RestrictionInd | Indication that vehicle has restrictions on its use | Optional | |
| 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 | |
| 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 | |
| VehicleStatus | Vehicle status code - Example status could be Built, Scheduled, Shipped, In-Transit, Sold, etc. | Optional | |
| VehicleShipDate | Date shipped from warehouse or distribution center | Optional | |
| VehicleOrderType | Identifies vehicle Invoice order type | Optional | |
| VehicleAllocatedDate | Date vehicle was allocated and/or a delivery work order was cut | Optional | |
| VehicleLocation | Indicates the physical location of the vehicle | Optional | |
| VehicleAcquisitionDate | Actual date vehicle was acquired by Dealership | Optional | |
| VehiclePricing | Vehicle Pricing | Optional | |
| ModelGroup | Grouping of similar models for order management purposes | Optional | |
| IndividualOwner | Individual who owns the vehicle | Optional | |
| OrganizationalOwner | Organization that owns the vehicle | Optional | |
| Tax | Vehicle Tax | Optional | |
| SoldTo | Business party who purchased the vehicle(s) | Optional | |
| ShipTo | Business party who the vehicle(s) was shipped to | Optional | |
| VehicleOrderNumber | Vehicle Order Number (VON) | Optional | |
| ActivityStatus | Activity status of vehicle while being manufactured or in transit | Optional | |
| CheckCode | Checksum value for Model number and Serial number combination | Optional | |
| RegulatoryRequirements | Describes the regulatory requirements associated with the vehicle, such as customs or local government requirements | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Invoice |
|---|---|
| Abstract | no |
| Documentation | . More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| InvoiceNumber | Manufacturer-assigned Invoice Number associated with the vehicle | Optional | |
| InvoiceTotal | Grand total for Vehicle Inventory | Optional | |
| LoadNumber | Shipment carrier-assigned load number | Optional | |
| BorderCrossingInd | Border crossing Indicator | Optional | |
| ETADate | Vehicle estimated time of arrival at Ship To dealer | Optional | |
| CarrierId | Vehicle Shipment Carrier (Name or Code) | Optional | |
| Warehouse | Warehouse or Distribution Center vehicle shipped from | Optional | |
| OrderDate | Date vehicle order originally placed with manufacturer | Optional | |
| Vehicle | Vehicle(s) covered by Inventory | Optional | |
| Tax | Invoice taxes | Optional | |
| DealerAssignedNumber | The number given to an order by a dealer | Optional | |
| StatusDate | The date the current status was recorded | Optional | |
| TargetBuildDate | The date the OEM expects to build the vehicle | Optional | |
| RejectCode | A code representing the reject status of an order | Optional | |
| OptionRestrictionStatements | Information about option restrictions on the vehicle. Ex: Sun Roof on Hold | Optional | |
| HoldCodeInd | Representing the hold status of an order | Optional | |
| RejectResponsibilityCode | A code indicating who has action to take to address a reject | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < InvoiceTotal (by extension) |
|---|---|
| Sub-types: | None |
| Name | InvoiceTotal |
|---|---|
| Abstract | no |
| Documentation | Invoice Total 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: | 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: | PartyBase < ManufacturerParty (by extension) |
|---|---|
| Sub-types: | None |
| Name | ManufacturerParty |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| Name | Name of manufacturer or distributor | Optional | |
| Address | Organizational Party address | Optional |
| 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: | None |
|---|---|
| Sub-types: | None |
| Name | MinimalDemographics |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Gender | Gender of party | Optional | |
| Language | Business party native language | Optional | |
| BirthDate | Birth date of party | Optional |
| Super-types: | xsd:string < Description (by extension) < ModelGroup (by extension) |
|---|---|
| Sub-types: | None |
| Name | ModelGroup |
|---|---|
| Abstract | no |
| Documentation | Grouping of similar models for order management purposes More information at: http://www.starstandard.org. |
| 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 < Description (by extension) < OptionRestrictionStatements (by extension) |
|---|---|
| Sub-types: | None |
| Name | OptionRestrictionStatements |
|---|---|
| Abstract | no |
| Documentation | Information about option restrictions on the vehicle 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) |
|---|---|
| Sub-types: |
|
| Name | OrganizationalOwnerParty |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| AlternatePartyIds | Alternate organizational party Identification | Optional | |
| 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: | None |
| Name | OrganizationalOwnerPartyExtended |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| AlternatePartyIds | Alternate organizational party Identification | Optional | |
| 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 |
| 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 | |
| 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 < Percent (by extension) |
|---|---|
| Sub-types: | None |
| Name | Percent |
|---|---|
| Abstract | no |
| Documentation | Percent More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < RegulatoryId (by extension) |
|---|---|
| Sub-types: | None |
| Name | RegulatoryId |
|---|---|
| Abstract | no |
| Documentation | Identification number assigned to regulatory requirement (Ex: Pedimento number assigned to vehicle in Mexico) More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | RegulatoryRequirements |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| RegulatoryType | Type of regulatory requirement (Ex: customs) | Optional | |
| RegulatoryId | Identification number assigned to regulatory requirement (Ex: Pedimento number assigned to vehicle in Mexico | Optional | |
| RegulatoryDate | Date regulatory requirement identification number is assigned (Ex: Date Pedimento number is assigned to vehicle) | Optional |
| Super-types: | Verb < ConfirmableVerb (by extension) < RequestVerb (by extension) |
|---|---|
| Sub-types: |
|
| Name | RequestVerb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| ReturnCriteria | ReturnCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies. | Required |
| 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: | 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 | |
| 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 | |
| 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: | 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 < OrganizationPartyBase (by extension) < ShipToParty (by extension) |
|---|---|
| Sub-types: | None |
| Name | ShipToParty |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| AlternatePartyIds | Alternate organizational party Identification | Optional | |
| Name | Company name of organizational party | Optional | |
| Address | Organizational Party address | Optional | |
| DBAName | Doing Business As name. | Optional | |
| LocationId | Code identifying the physical location of a dealer. | 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: | PartyBase < OrganizationPartyBase (by extension) < SoldToParty (by extension) |
|---|---|
| Sub-types: | None |
| Name | SoldToParty |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| AlternatePartyIds | Alternate organizational party Identification | Optional | |
| Name | Company name of organizational party | Optional | |
| Address | Organizational Party address | Optional | |
| DBAName | Doing Business As name. | 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 | |
| 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: | 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) < 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: | 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 | |
| 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 | |
| ExteriorColor | Vehicle Exterior Color(s) | Optional | |
| TransmissionType | Vehicle Transmission type | Optional | |
| 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 | |
| VehicleDemoInd | Indicates whether vehicle was ever a demo | Optional | |
| LicenseNumber | State License plate number of vehicle | Optional | |
| BrandedInfo | Vehicle Branding Information | Optional | |
| RestrictionInd | Indication that vehicle has restrictions on its use | Optional | |
| RestrictionDescription | Description of vehicle use restrictions | Optional | |
| TelematicsServiceInd | Indication whether Telematics Service Subscription is turned on | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | VehicleInventory |
|---|---|
| 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.0 STAR approved 11/22/2002; OAGI approved 3/15/2003; effective date 01/01/2003 More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Header | Required | ||
| Invoice | Optional |
| Super-types: | HeaderBase < VehicleInventoryHeader (by extension) |
|---|---|
| Sub-types: | None |
| Name | VehicleInventoryHeader |
|---|---|
| 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 | |
| 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 | Manufacturer order reference number for this inventory transacation | Optional | |
| InvoiceDate | Date of Vehicle Inventory | Optional | |
| TransactionType | Type of vehicle Inventory transaction | Optional | |
| SoldTo | Business party who purchased the vehicle(s) | Optional | |
| ShipTo | Business party who the vehicle(s) was shipped to | Optional | |
| Manufacturer | Business party who manufactured the vehicle(s) | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < VehiclePrice (by extension) |
|---|---|
| Sub-types: | None |
| Name | VehiclePrice |
|---|---|
| Abstract | no |
| Documentation | Customer price of vehicle More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | VehiclePricing |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| VehiclePrice | Customer price of vehicle | Required | |
| PriceExplanation | Explanatory Note for Pricing Example: Anniversary Edition | Optional | |
| VehiclePricingType | Designates type of pricing for vehicle transaction | Optional | |
| PricingTypeSource | Source from which pricing type data originated (i.e. Blue Book, NADA, etc.) | 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: | xsd:string < Id (by extension) < Warehouse (by extension) |
|---|---|
| Sub-types: | None |
| Name | Warehouse |
|---|---|
| Abstract | no |
| Documentation | Warehouse Number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Text (by restriction) < ActivityStatus (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ActivityStatus |
|---|---|
| Documentation | Activity status More information at: http://www.starstandard.org. |
| 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 < 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 < 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:string < Indicator (by restriction) < BorderCrossingInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BorderCrossingInd |
|---|---|
| Documentation | BorderCrossing Indicator More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| 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 < 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 < 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 < 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 < ReferenceNumber (by restriction) < DealerAssignedNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DealerAssignedNumber |
|---|---|
| Documentation | The number given to an order by a dealer 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: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: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 < 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) < ETADate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ETADate |
|---|---|
| Documentation | Estimated time of arrival 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: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 < Indicator (by restriction) < HoldCodeInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | HoldCodeInd |
|---|---|
| Documentation | Representing hold status More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| 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: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:date < Date (by restriction) < InvoiceDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | InvoiceDate |
|---|---|
| Documentation | Date of invoice. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < InvoiceNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | InvoiceNumber |
|---|---|
| Documentation | Invoice number 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) < 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 < ReferenceNumber (by restriction) < LoadNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | LoadNumber |
|---|---|
| Documentation | Shipment carrier-assigned load number More information at: http://www.starstandard.org. |
| 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 < 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 < 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 < 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) < 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) < OrderDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OrderDate |
|---|---|
| Documentation | Date order originally placed 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 < 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 < 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 < Note (by restriction) < PriceExplanation (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PriceExplanation |
|---|---|
| Documentation | Explanatory Note for Pricing More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < PricingTypeSource (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PricingTypeSource |
|---|---|
| Documentation | Source from which pricing type data originated (i.e. Blue Book, NADA, etc.). More information at: http://www.starstandard.org. |
| 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 < 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:date < Date (by restriction) < RegulatoryDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RegulatoryDate |
|---|---|
| Documentation | Date regulatory requirement identification number is assigned (Ex: Date Pedimento number is assigned to vehicle) More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Type (by restriction) < RegulatoryType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RegulatoryType |
|---|---|
| Documentation | Type of regulatory requirement (Ex: customs) More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < RejectCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RejectCode |
|---|---|
| Documentation | A code representing a reject reason More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < RejectResponsibilityCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RejectResponsibilityCode |
|---|---|
| Documentation | A code indicating who has action to take to address a reject 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 < 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: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 < 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 < 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:date < Date (by restriction) < StatusDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | StatusDate |
|---|---|
| Documentation | The date the current status was recorded 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:date < Date (by restriction) < TargetBuildDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TargetBuildDate |
|---|---|
| Documentation | The date the OEM expects to build the vehicle 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 < 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 < Text (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Text |
|---|---|
| Documentation | Indicates generic text type More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < TransactionType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TransactionType |
|---|---|
| Documentation | Type of transaction More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Initial | Initial transaction |
| Update | Update transaction |
| Delete | Delete transaction |
| Cancel | Cancel transaction |
| 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) < VehicleAcquisitionDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleAcquisitionDate |
|---|---|
| Documentation | Actual Date vehicle was acquired by Dealership More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < VehicleAllocatedDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleAllocatedDate |
|---|---|
| Documentation | Date vehicle was allocated and/or a delivery work order was cut 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) < VehicleLocation (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleLocation |
|---|---|
| Documentation | Indicates the physical location of the vehicle More information at: http://www.starstandard.org. |
| 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) < VehicleOrderNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleOrderNumber |
|---|---|
| Documentation | Vehicle Order Number (VON) More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Type (by restriction) < VehicleOrderType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleOrderType |
|---|---|
| Documentation | Identifies vehicle order type More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < VehiclePricingType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehiclePricingType |
|---|---|
| Documentation | Designates type of pricing for vehicle More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| MSRP | |
| Hold Back | |
| Destination/Handling | |
| Group Fund Price | |
| Wholesale Price | |
| Wholesale Cost | |
| Actual Cash Value | |
| Employee | |
| Invoice | |
| Sale Price | |
| Final MSRP | |
| Base MSRP | |
| Employee Order Price | |
| Employee Stock Price | |
| Other | Other |
| Selling Price | |
| Cap Cost | |
| Total Option Price | |
| Total Option Cost | |
| Retail | |
| N/A | Not Applicable |
| MSRP Discount | |
| Gross Cap Cost | |
| Net Cap Cost | |
| Taxable Selling Price | |
| Loan | Amount lenders typically loan on the listed vehicle. |
| Trade-In | Amount allowed by dealers on a trade. |
| Adjusted Gross Cap Cost | Adjusted gross cap cost due to tax calculations. |
| Adjusted Net Cap Cost | Adjusted net cap cost due to tax calculations. |
| Total Option MSRP | Total of all itemized products of the Manufactured Suggested Retail Price. |
| Super-types: | xsd:date < Date (by restriction) < VehicleShipDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleShipDate |
|---|---|
| Documentation | Date shipped from warehouse or distribution center More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < VehicleStatus (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleStatus |
|---|---|
| Documentation | Vehicle status code - Example status could be Built, Scheduled, Shipped, In-Transit, Sold, etc. 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:gYear < Year (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Year |
|---|---|
| Documentation | Year 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 |
|
Header |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
VI Order Reference |
Manufacturer order reference number for this invoice (VON) |
105600 |
Header/DocumentId |
|
2 |
VI Date |
Date of vehicle invoice |
105610 |
Header/InvoiceDate |
|
3 |
VI ETA Date |
Vehicle estimated time of arrival at Ship To dealer |
105620 |
Invoice/ETADate |
|
5 |
VI Ship Via |
Vehicle Shipment Carrier (Name or Code) |
105640 |
Invoice/CarrierId |
|
6 |
VI Distribution Center |
Warehouse or Distribution Center vehicle shipped from |
105650 |
Invoice/Warehouse |
|
8 |
VI Order Date |
Date order originally placed with manufacturer |
107570 |
Invoice/OrderDate |
|
9 |
VI Transaction Type |
Type of vehicle invoice/invoice transaction |
107580 |
Header/TransactionType |
|
SoldTo |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
VI Sold To Business Name |
Name of business entity invoiced for vehicle |
105670 |
SoldTo/CompanyName |
|
2 |
VI Sold To DBA Name |
DBA name of business entity invoiced for vehicle |
105680 |
SoldTo/DBAName |
|
3 |
VI Sold To Address |
Address of business entity vehicle was sold to |
105690 |
SoldTo – Address/AddressLine |
|
4 |
VI Sold To City |
City of business entity vehicle was sold to |
105700 |
SoldTo – Address/City |
|
5 |
VI Sold To State |
State or province of business entity vehicle was sold to |
105710 |
SoldTo – Address/StateOrProvince |
|
6 |
VI Sold To Zip Code |
Zip or Postal Code of business entity vehicle was sold to |
105720 |
SoldTo - AddressPostalCode |
|
7 |
VI Sold To Dealer Code |
Dealer code of business entity invoiced for vehicle |
106660 |
SoldTo/PartyId |
|
ShipTo |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
VI Ship To Name |
Name of business entity vehicle was shipped to |
105730 |
ShipTo/CompanyName |
|
2 |
VI Ship To DBA Name |
DBA Name of business entity vehicle was shipped to |
105740 |
ShipTo/DBAName |
|
3 |
VI Ship To Address |
Address of business entity vehicle was shipped to |
105750 |
ShipTo – Address/AddressLine |
|
4 |
VI Ship To City |
City of business entity vehicle was shipped to |
105760 |
ShipTo – Address/City |
|
5 |
VI Ship To State |
State or province of business entity vehicle was shipped to |
105770 |
ShipTo – Address/StateOrProvince |
|
6 |
VI Ship To Zip Code |
Zip or Postal Code of business entity vehicle was shipped to |
105780 |
ShipTo – Address/PostalCode |
|
7 |
VI Ship To Dealer Code |
Dealer code of business entity vehicle was shipped to |
106670 |
ShipTo/PartyId |
|
Manufacturer |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
VI Manufacturer Name |
Name of manufacturer or distributor |
105900 |
Manufacturer/Name |
|
2 |
VI Manufacturer Address |
Address of manufacturer or distributor |
105910 |
Manufacturer – Address/AddressLine |
|
3 |
VI Manufacturer City |
City of manufacturer or distributor |
105920 |
Manufacturer – Address/City |
|
4 |
VI Manufacturer State |
State or province of manufacturer or distributor |
105930 |
Manufacturer – Address/StateOrProvince |
|
5 |
VI Manufacturer Zip Code |
Zip or Postal Code of manufacturer or distributor |
105940 |
Manufacturer – Address/PostalCode |
|
Invoice |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
VI Number |
Manufacturer-assigned Invoice Number associated with the vehicle |
105950 |
Invoice/InvoiceNumber |
|
2 |
VI Total |
Grand total for vehicle invoice |
105960 |
Invoice/InvoiceTotal |
|
3 |
VI Port Of Entry |
Vehicle Port of Entry |
105970 |
Invoice/PortOfEntry |
|
4 |
VI Load Number |
Shipment carrier-assigned load number |
105980 |
Invoice/LoadNumber |
|
5 |
VI Border Crossing Flag |
Border crossing flag |
105990 |
Invoice/BorderCrossingInd |
|
6 |
VI VIN |
Vehicle identification associated with invoice or inventory |
106000 |
Vehicle/VIN |
|
7 |
VI Model Description |
Description of vehicle model |
106010 |
Vehicle/ModelDescription |
|
8 |
VI Accessories Flag |
Flag to indicate manufacturer-installed accessories |
106020 |
Vehicle/Option/ManufacturerInstalledInd |
|
9 |
Vehicle Ignition Key Number |
Ignition key number |
106030 |
Vehicle/IgnitionKeyNumber |
|
10 |
VI Door Key |
Door key number |
106040 |
Vehicle/DoorKeyNumber |
|
11 |
VI Weight |
Vehicle weight |
106050 |
VehicleVehicleWeight |
|
12 |
VI Engine Number |
Serial number of the engine |
106060 |
Vehicle/EngineNumber |
|
13 |
VI Radio Code |
Radio code |
106070 |
Vehicle - Option/OptionSecurityCode |
|
14 |
VI Primary Exterior Color Code |
Vehicle primary exterior color code |
106080 |
Vehicle/ExteriorColorCode |
|
15 |
VI Primary Exterior Color Name |
Vehicle primary exterior color name |
106090 |
Vehicle/ExteriorColor |
|
16 |
VI Interior Color Code |
Vehicle Interior color code |
106100 |
Vehicle/InteriorColorCode |
|
17 |
VI Interior Color Name |
Vehicle interior color name |
106110 |
Vehicle/InteriorColor |
|
18 |
VI MSRP |
Manufacturer's suggested price of retail vehicle |
106120 |
Vehicle - VehiclePricing/MSRP |
|
19 |
VI Hold Back |
Hold back amount |
106130 |
Vehicle - VehiclePricing/Hold Back |
|
20 |
VI Comments |
Manufacturer comments to dealer |
106140 |
Vehicle/VehicleNote |
|
22 |
VI Destination Handling |
Destination/handling charges |
106160 |
Vehicle - VehiclePricing/Destination/Handling |
|
23 |
VI Model Year |
Vehicle designated model year |
106560 |
Vehicle/ModelYear |
|
25 |
VI Primary Group Fund Price |
Group Fund Price #1 |
106590 |
Vehicle - VehiclePricing/Group Fund Price |
|
27 |
VI Secondary Group Fund Price |
Group Fund Price #2 |
106600 |
Vehicle - VehiclePricing/Group Fund Price |
|
28 |
VI Remote Control |
Remote Control (Security code) |
106610 |
Vehicle - Option/OptionSecurityCode |
|
29 |
VI Wholesale Price |
Dealer Invoice (i.e., Actual amount invoiced to dealer) |
106620 |
Vehicle - VehiclePricing/Wholesale Price |
|
30 |
VI Status Code |
Vehicle status code - Example status could be Built, Scheduled, Shipped, In-Transit, Sold, etc. |
106640 |
Vehicle/VehicleStatus |
|
31 |
VI Ship Date |
Date shipped from warehouse or distribution center |
106650 |
Vehicle/VehicleShipDate |
|
32 |
VI Model Code |
Manufacturer-assigned model code - Sales model of vehicle is usually available in the VIN number (use NCIC code) |
107590 |
Vehilce/Model |
|
33 |
VI Secondary Exterior Color Code |
Vehicle secondary exterior color code |
107600 |
Vehicle/ExteriorColorCode |
|
34 |
VI Secondary Exterior Color Name |
Vehicle secondary exterior color name |
107610 |
Vehicle/ExteriorColor |
|
35 |
VI Order Type |
Identifies vehicle Invoice order type |
106890 |
Vehicle/VehicleOrderType |
|
36 |
VI Allocated Date |
Date vehicle was allocated and/or a delivery work order was cut |
107250 |
Vehicle/VehicleAllocatedDate |
|
37 |
VI Stocking Type |
Indicates the physical location of the vehicle |
107280 |
Vehicle/VehicleLocation |
|
38 |
VI Transmission Type |
Vehicle transmission type |
107340 |
Vehicle/TransmissionType |
|
39 |
VI Supplemental Comments |
Supplemental manufacturer comments to dealer |
107460 |
Vehicle/VehicleNote |
|
40 |
Goods and Services Tax |
Federal tax amount. |
110740 |
Invoice – Tax / Type= “Amount” Id = GST |
|
41 |
Provincial Sales Tax |
Provincial or state tax amount. |
110750 |
Invoice – Tax / Type= “Amount” Id = PST |
|
42 |
Harmonized Sales Tax |
Combination of federal and provincial tax amounts. |
110760 |
Invoice – Tax / Type= “Amount” Id = HST |
|
43 |
Quebec Sales Tax |
Tax amount. i.e., Quebec Sales tax |
110770 |
Invoice – Tax / Type= “Amount” Id = QST |
|
44 |
Air Tax |
Tax amount for air conditioning. |
110780 |
Invoice – Tax / Type= “Amount” Id = ART |
|
45 |
Dealer Assigned Number |
The number given to an order by a dealer. |
112160 |
Invoice/DealerAssignedNumber |
|
46 |
Status Date |
The date the current status was recorded. |
112170 |
Invoice/ StatusDate |
|
47 |
Target Build Date |
The date the OEM expects to build the vehicle. |
112180 |
Invoice/TargetBuildDate |
|
48 |
Reject Code |
A code representing the reject status of an order |
112190 |
Invoice/RejectCode |
|
49 |
Option Restriction Statements |
Information about option restrictions on the vehicle. |
112200 |
Invoice/OptionRestrictionStatements |
|
50 |
Hold Code Flag |
Representing the hold status of an order |
112210 |
Invoice/HoldCodeInd |
|
51 |
Reject Responsibility Code |
A code indicating who has action to take to address a reject |
112220 |
Invoice/RejectResponsibilityCode |
|
52 |
Weight Tax |
An Additional tax imposed on larger vehicles based on vehicle weight |
112230 |
Invoice – Tax / Type= “Weight” |
|
LineItem |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
VI Item Description |
Line item description |
106170 |
Vehicle – Option/OptionName |
|
2 |
VI Item Price |
VI MSRP relating to line item description |
106180 |
Vehicle – Option/OptionMSRP |
|
3 |
VI Miscellaneous Codes |
Miscellaneous codes relating to vehicle (i.e., sales codes) |
106630 |
Vehicle – Option/MiscellaneousCodes |
|
4 |
VI Item Cost |
VI line item wholesale cost |
107620 |
Vehicle – Option/OptionCost |
|
5 |
VI Option Package Identifier |
Option package number or identifier used as a method for grouping option package items from manufacturer(s) Ex: OptPkg1,cost, |
106900 |
Vehicle – Option/OptionPackageId |
|
6 |
VI Sales Code |
Further definition of accessories and option packages - Indicates whether ordered option, special package, standard, etc. |
107470 |
Vehicle – Option/OptionSalesCode |
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Generated by StarSchemaGuidelineGenerator based on xs3p. Last modified: