Implementation Guideline
Acknowledge Credit Contract Response
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Implementation Guideline
Acknowledge Credit Contract Response
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 Acknowledge Credit Contract Response Business Object Document (BOD). Acknowledge Credit Contract Response has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Acknowledge Credit Contract Response 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 Acknowledge Credit Contract Response, this BOD could be used to send Acknowledge Credit Contract Response information between any two business parties.
The Acknowledge Credit Contract Response Implementation Guidelines provide detailed information regarding the structure and meaning of the Acknowledge Credit Contract Response BOD and corresponds directly to the Acknowledge Credit Contract Response 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 Acknowledge Credit Contract Response Implementation Guidelines must be used in concert with the Acknowledge Credit Contract Response 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 Acknowledge Credit Contract Response 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 Acknowledge Credit Contract Response BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Acknowledge Credit Contract Response 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 Acknowledge Credit Contract Response 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 Credit Contract Response Binary Collaboration starts with the transmission of credit contract from a dealer to a lender. This submission may be done multiple times. The lender then verifies the contract and responds. This process occurs on demand as is needed. Note: This scenario is an example of how the Credit Contract BOD can be used. Implementations may vary.
The relationship diagram identifies all of the various components or building blocks of information used in the Acknowledge Credit Contract Response 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 | Acknowledge |
|---|---|
| Type | Acknowledge |
| Nillable | no |
| Abstract | no |
| Documentation | The Acknowledge verb is used to acknowledge the application receipt of a Process request. This function conveys the result of the original request. An example of this is Acknowledge PO, where a Process PO has been issued and the corresponding business application acknowledges the receipt of the PO and responds with an acceptance or a counter offer. More information at: http://www.openapplications.org/oagis. |
| Name | AcknowledgeCreditContractResponse |
|---|---|
| Type | AcknowledgeCreditContractResponse |
| Nillable | no |
| Abstract | no |
| 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 | Co-Applicant |
|---|---|
| Type | Co-ApplicantContractRespParty |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | CreditContractResponse |
|---|---|
| Type | CreditContractResponse |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | CreditVehicle |
|---|---|
| Type | CreditContractRespVehicle |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | Dealer |
|---|---|
| Type | DealerExtendedContracts |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | FinanceCompany |
|---|---|
| Type | ExpandedFinanceParty |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | Financing |
|---|---|
| Type | ContractResponseFinancing |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | Header |
|---|---|
| Type | CreditContractResponseHeader |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | IndividualApplicant |
|---|---|
| Type | IndividualApplicantContractRespParty |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | OrganizationalApplicant |
|---|---|
| Type | OrganizationalApplicantContractRespParty |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
|
| Name | Verb |
|---|---|
| Type | Verb |
| Nillable | no |
| Abstract | yes |
| Super-types: | Verb < ConfirmableVerb (by extension) < ResponseVerb (by extension) < Acknowledge (by extension) |
|---|---|
| Sub-types: | None |
| Name | Acknowledge |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| OriginalBODId | Optional |
| Super-types: | BusinessObjectDocument < AcknowledgeCreditContractResponse (by extension) |
|---|---|
| Sub-types: | None |
| Name | AcknowledgeCreditContractResponse |
|---|---|
| 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 | AcknowledgeCreditContractResponseDataArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Acknowledge | The Acknowledge verb is used to acknowledge the application receipt of a Process request. This function conveys the result of the original request. An example of this is Acknowledge PO, where a Process PO has been issued and the corresponding business application acknowledges the receipt of the PO and responds with an acceptance or a counter offer. | Required | |
| CreditContractResponse | Required |
| Super-types: | AddressBase < Address (by extension) |
|---|---|
| Sub-types: |
|
| Name | Address |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| qualifier | Required |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| AddressLine | Indicates the multiple lines of an address. The first line is typically the street name and number. | Required | |
| City | Is the City of the Address. | Required | |
| County | County in which the Address is in. | Optional | |
| StateOrProvince | Is the State or Province of a given Address. | Required | |
| Country | Country in which the Address is in. | Required | |
| PostalCode | Postal Code of the Address. | Required |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | AddressBase |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| AddressLine | Indicates the multiple lines of an address. The first line is typically the street name and number. | Required | |
| City | Is the City of the Address. | Required | |
| County | County in which the Address is in. | Optional | |
| StateOrProvince | Is the State or Province of a given Address. | Required | |
| Country | Country in which the Address is in. | Required | |
| PostalCode | Postal Code of the Address. | Required |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | AlternatePartyId |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Id | Alternate Party Identification | Required |
| Super-types: | xsd:decimal < Amount (by extension) |
|---|---|
| Sub-types: | None |
| Name | Amount |
|---|---|
| Abstract | no |
| Documentation | Based on OAGI Amount. Simple content with the currency as an attrbute More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| currency | Required |
| Super-types: | xsd:decimal < Amount (by extension) < AmountFinanced (by extension) |
|---|---|
| Sub-types: | None |
| Name | AmountFinanced |
|---|---|
| Abstract | no |
| Documentation | The total amount financed. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Percent (by extension) < AnnualPercentageRate (by extension) |
|---|---|
| Sub-types: | None |
| Name | AnnualPercentageRate |
|---|---|
| Abstract | no |
| Documentation | Annual percentage rate. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ApplicationArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Sender | Identifies characteristics and control identifiers that relate to the application that created the Business Object Document. The sender area can indicate the logical location of the application and/or database server, the application, and the task that was processing to create the BOD. | Required | |
| CreationDateTime | is the date time stamp that the given instance of the Business Object Document was created. This date must not be modified during the life of the Business Object Document. | Required |
DateTime fields must be formatted as XML Schema
Datetimes in UTC/GMT format without offsets.
Example: 2003-11-05T13:15:30Z
|
| Signature | If the BOD is to be signed the signature element is included, otherwise it is not. Signature supports any digital signature that maybe used by an implementation of OAGIS. The qualifyingAgency identifies the agency that provided the format for the signature. This element supports any digital signature specification that is available today and in the future. This is accomplished by not actually defining the content but by allowing the implementation to specify the digital signature to be used via an external XML Schema namespace declaration. The Signature element is defined to have any content from any other namespace. This allows the user to carry a digital signature in the xml instance of a BOD. The choice of which digital signature to use is left up to the user and their integration needs. | Optional | |
| BODId | The BODId provides a place to carry a Globally Unique Identifier (GUID) that will make each Business Object Document instance uniquely identifiable. This is a critical success factor to enable software developers to use the Globally Unique Identifier (GUID) to build the following services or capabilities: 1. Legally binding transactions, 2. Transaction logging, 3. Exception handling, 4. Re-sending, 5. Reporting, 6. Confirmations, 7. Security. | Optional | |
| Destination | Information related to the receiver of the BOD | Required |
| Super-types: | xsd:string < ApplicationNumber (by extension) |
|---|---|
| Sub-types: | None |
| Name | ApplicationNumber |
|---|---|
| Abstract | no |
| Documentation | Manufacturer assigned appilcation number. More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| desc | Required |
| Super-types: | xsd:decimal < Amount (by extension) < BalloonHardAddsResidualBuyDown (by extension) |
|---|---|
| Sub-types: | None |
| Name | BalloonHardAddsResidualBuyDown |
|---|---|
| Abstract | no |
| Documentation | Amount paid up-front towards the hard-add residual adjustment. (For example, if the customer wants a CD changer but doesn't want the monthly payments to go up, they may pay for a portion of it up-front.) More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < BalloonMileageResidualBuyDown (by extension) |
|---|---|
| Sub-types: | None |
| Name | BalloonMileageResidualBuyDown |
|---|---|
| Abstract | no |
| Documentation | Amount paid up-front towards expected additional mileage on the vehicle.This amount will off-set the expected reduction of end-of-term residual due to higher mileage on the vehicle. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Percent (by extension) < BalloonPercentageResidualBuyDown (by extension) |
|---|---|
| Sub-types: | None |
| Name | BalloonPercentageResidualBuyDown |
|---|---|
| Abstract | no |
| Documentation | Amount paid up-front towards the end-of-term residual value. (A higher residual means lower monthly payments - some people will put cash or trade equity down to "buy-down" their monthly payments.) More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < BalloonPrepaidMileageResidualBuyDown (by extension) |
|---|---|
| Sub-types: | None |
| Name | BalloonPrepaidMileageResidualBuyDown |
|---|---|
| Abstract | no |
| Documentation | This is the preset amount determined by the lender for upfront miles. This rate is multiplied by the number of up-front miles and this amount is subtracted from the residual value. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Percent (by extension) < BalloonResidualPercentage (by extension) |
|---|---|
| Sub-types: | None |
| Name | BalloonResidualPercentage |
|---|---|
| Abstract | no |
| Documentation | The estimated percent of value at contract end More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Percent (by extension) < BaseBuyPercentageRate (by extension) |
|---|---|
| Sub-types: | None |
| Name | BaseBuyPercentageRate |
|---|---|
| Abstract | no |
| Documentation | Base buy rate before any additions or subtractions. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | BusinessObjectDocument |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| revision | This should contain the STAR repository version in the following recommended format. 4.2.1_M20080416. Where the first part indicates the version of the STAR repository and anything after the _ indicates the Milestone build that is being used. If referring to an official published version then only the STAR Repository version is required. | Optional | |
| release | Indicates the OAGIS release that this BOD belongs. | Optional | |
| environment | Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s). | Optional | |
| lang | Indicates the language that the contents of the BOD is in unless otherwise stated. | Optional | |
| bodVersion | Deprecated as of STAR 4.2.2. It is recommended to use the revision attribute to identify the repository and the noun. May be removed in a new major version of the STAR repository. | Optional |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| ApplicationArea | Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of. | Required |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | BuyPercentageRateAdjGroup |
|---|---|
| Abstract | no |
| Documentation | Communicates any adjustments to the buy rate More information at: http://www.starstandards.org/. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| BuyPercentageRateAdjustment | Communicates any adjustments to the buy rate. | Required |
| Super-types: | xsd:decimal < Percent (by extension) < BuyPercentageRateAdjPercent (by extension) |
|---|---|
| Sub-types: | None |
| Name | BuyPercentageRateAdjPercent |
|---|---|
| Abstract | no |
| Documentation | Percentage adjustment applied to buy rate More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | BuyPercentageRateAdjustment |
|---|---|
| Abstract | no |
| Documentation | Communicates any adjustments to the buy rate. More information at: http://www.starstandards.org/. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| BuyPercentageRateAdjTypeCode | Indicates the type of adjustment, either an addition or subtraction, to be made to the buy rate. | Required | |
| BuyPercentageRateAdjDesc | Description of adjustment to buy rate. | Optional | |
| BuyPercentageRateAdjPercent | Percentage adjustment applied to buy rate. | Optional |
| Super-types: | PartyBase < IndividualApplicantContractRespParty (by extension) < Co-ApplicantContractRespParty (by extension) |
|---|---|
| Sub-types: | None |
| Name | Co-ApplicantContractRespParty |
|---|---|
| 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 | |
| Privacy | Any privacy rights the party has subscribed to or opted out of. | 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:string < Id (by extension) < ContractId (by extension) |
|---|---|
| Sub-types: | None |
| Name | ContractId |
|---|---|
| Abstract | no |
| Documentation | Identification of Contract More information at: http://www.starstandard.org. |
| Super-types: | ContactBase < ContractIndividualApplicantContact (by extension) |
|---|---|
| Sub-types: | None |
| Name | ContractIndividualApplicantContact |
|---|---|
| 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 | |
| PersonName | Optional | ||
| PrimaryDriverInd | Identifies customer as primary driver. | Optional | |
| OtherDescription | The text description of “Other᾿ value from telephone desc attribute. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ContractOrganizationContact |
|---|---|
| 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 |
If the address has a North American country code,
the telephone number must be a minimum of 10
numbers.
|
| EMailAddress | Contact Email address | Optional |
Should conform to the Internet message format as set
forth by RFC 8822.
|
| Fax | Contact Fax number | Optional |
If the address has a North American country code,
the telephone number must be a minimum of 10
numbers.
|
| PreferredContactMethod | Preferred contact method | Optional | |
| ContactTime | Preferred contact time (i.e. Best day/time to reach the contact). | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ContractRespFederalTILDisclosures |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| LeaseRateMoneyFactor | Lease rate charged to customer by the Dealer. | Optional | |
| MaximumLeaseRateMoneyFactor | Maximum rate the dealer can charge the customer for the vehicle being purchased. This is the LeaseBuyMoney Factor plus maximum markup. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ContractResponseFinancing |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DealerReserveType | Identifies the category used to calculate the Dealer Reserve i.e., Flat, Standard Dealer Participation, Guaranteed Dealer Participation. | Optional | |
| DealerReserveAmount | The dollar amount associated with the dealer reserve. | Optional | |
| AmountFinanced | The total amount financed. | Required | |
| NumberOfOverduePayments | The number of payments that are already passed due at the time the deal is funded. | Optional | |
| OverduePaymentAmount | The dollar amount of the past due payments. | Optional | |
| Deduction | Communicates any deductions from the dealer settlement amount (e.g., Tax Stamp Amount). | Optional | |
| Credit | Communicates any miscellaneous additions to the dealer settlement amount (e.g., Owner Loyalty Reimbursement Amount). | Optional | |
| FunderComments | Free form text area for Funder's comments. | Optional | |
| Notifications | Free form text area identifying any policies are legal restrictions. | Optional | |
| ContractTerm | The total duration of the contract in months. | Optional | |
| AnnualPercentageRate | The customer's buy rate. | Optional | |
| PaymentAmount | Monthly Payment Amount. | Optional | |
| BulletinNumber | Identifies the bulletin used to fund the deal. | Optional | |
| BalloonResidualPercentage | The estimated percent of value at contract end. | Optional | |
| ContractMVP | The rating of the customer based on the credit worthiness of the customer. | Optional | |
| NetAnnualPercentageRate | The rate charged to the dealer. | Optional | |
| SubsidyCode | The manufacturer assigned code that determines the incentives that are being offered to the customer (i.e., 0% financing). | Optional | |
| EffectiveDate | The effective date of the incentives or rates. | Optional | YYYY-MM-DD |
| ExpirationDate | Identifies the end date of the incentives and rates. | Optional | YYYY-MM-DD |
| MSRPPackage | Manufacturer suggested retail price / discount amount. Discount package is for a special package on a vehicle. | Optional | |
| BalloonMileageResidualBuyDown | Amount paid up-front towards expected additional mileage on the vehicle.This amount will off-set the expected reduction of end-of-term residual due to higher mileage on the vehicle. | Optional | |
| BalloonPercentageResidualBuyDown | Amount paid up-front towards the end-of-term residual value. (A higher residual means lower monthly payments - some people will put cash or trade equity down to "buy-down" their monthly payments.) | Optional | |
| BalloonHardAddsResidualBuyDown | Amount paid up-front towards the hard-add residual adjustment. (For example, if the customer wants a CD changer but doesn't want the monthly payments to go up, they may pay for a portion of it up-front.) | Optional | |
| BalloonPrepaidMileageResidualBuyDown | This is the preset amount determined by the lender for upfront miles. This rate is multiplied by the number of up-front miles and this amount is subtracted from the residual value. | Optional | |
| RetailAPRBuyDown | The difference in the finance charge amount between the buy rate and the customer rate. For instance if the buy rate is 4.9% and the dealer writes the contract for 2.9% - the difference of 1% finance charge needs to be paid to the lender up-front. | Optional | |
| GrossProceedsAmount | The amount that the finance source is paying the dealer for the deal. EX: If a dealer owes a buy down amount, it may be deducted from their proceeds. | Optional | |
| NetProceedsAmount | The GrossProceedsAmount minus the wholesale payoff amount. | Optional | |
| BookingDate | The date that the finance source begins servicing the deal. | Optional | |
| FinancePlan | Description of standard finance plan applied to deal. | Optional | |
| DeferredGrossAmount | A portion of the dealer’s proceeds that is held for future payment. | Optional | |
| FederalTILDisclosures | Federal Truth In Lending Disclosures | Optional | |
| ProgramsAndRates | The ProgramsAndRates component represents vehicle and finance programs/rates associated with the contract or lease agreement for the vehicle. | Optional | |
| Tax | Tax assoicated with the financing | Optional | |
| BaseBuyPercentageRate | Base buy rate before any additions or subtractions. | Optional | |
| BuyPercentageRateAdjGroup | Communicates any adjustments to the buy rate. | Optional | |
| Fee | Communicates any fee information in regards to financing. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ContractRespProgramsAndRates |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| LeaseBuyMoneyFactor | Lease Rate/Service Factor offered to the dealer by Finance Source. | Optional | |
| SpecialProgramDetail | Finance Special program detail information. | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < CorrectValue (by extension) |
|---|---|
| Sub-types: | None |
| Name | CorrectValue |
|---|---|
| Abstract | no |
| Documentation | Correct value. More information at: http://www.starstandard.org. |
| Super-types: | xsd:integer < Count (by extension) |
|---|---|
| Sub-types: | None |
| Name | Count |
|---|---|
| Abstract | no |
| Documentation | Simple quantity type with no attributes More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Credit |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| CreditDescription | Miscellaneous additions to the dealer settlement amount (e.g., Owner Loyalty Reimbursement). | Optional | |
| CreditAmount | The dollar amount being added to the dealer settlement amount. | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < CreditAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | CreditAmount |
|---|---|
| Abstract | no |
| Documentation | The dollar amount being added to the dealer settlement amount. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | CreditContractResponse |
|---|---|
| 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 01/10/2003; 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 | ||
| FinanceCompany | Required | ||
| Dealer | Required | ||
| IndividualApplicant | Optional | ||
| Co-Applicant | Optional | ||
| OrganizationalApplicant | Optional | ||
| Financing | Required | ||
| CreditVehicle | Optional |
| Super-types: | HeaderBase < CreditContractResponseHeader (by extension) |
|---|---|
| Sub-types: | None |
| Name | CreditContractResponseHeader |
|---|---|
| Abstract | no |
| Documentation | . More information at: http://www.starstandards.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 | |
| DocumentId | The primary DocumentId of the document for the given content. | Optional | |
| DocumentVersionNumber | Identifies the version of the doucment. | Optional | |
| ContractFormNumber | Identifies the type of contract. | Optional | |
| FinanceType | Type of financing. Examples may be F- Finance, L - Lease, C-Cash, 1-Retail, 2-Lease, 3-Balloon, etc. | Required | |
| ApplicationType | Type of application being submitted for financing (e.g., individual, individual + co-applicant, business, business + coapplicant, employee). | Optional | |
| FundingStatus | Identifies the funding status of the deal. | Optional | |
| VIN | Federally defined 17 position vehicle identification number | Optional | |
| ContractId | Finance source assigned contract number. | Optional | |
| ValidationResults | Federally defined 17 position vehicle identification number | Optional | |
| ValidationMessage | Federally defined 17 position vehicle identification number | Optional | |
| ApplicationNumber | Credit application number assigned by document originator. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | CreditContractRespOption |
|---|---|
| Abstract | no |
| Documentation | The Option component represents information about the options and replacements that are associated with a vehicle. Each vehicle can have multiple options. More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| OptionName | Name of vehicle option. | Optional | |
| OptionSalesCode | Further definition of accessories and option packages - Indicates whether ordered option, special package, standard, etc. | 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 |
| Super-types: | Vehicle < CreditContractRespVehicle (by extension) |
|---|---|
| Sub-types: | None |
| Name | CreditContractRespVehicle |
|---|---|
| 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 | |
| TrimCode | Manufacturer assigned trim code | Optional | |
| Pricing | Vehicle Pricing | Optional | |
| Option | The Option component represents information about the options and replacements that are associated with a vehicle. Each vehicle can have multiple options. | Optional | |
| TransmissionType | Vehicle Transmission type | Optional | |
| AirConditionInd | Indicates whether or not the vehicle has air condition | Optional |
| Super-types: | Tax < CreditContractTax (by extension) |
|---|---|
| Sub-types: | None |
| Name | CreditContractTax |
|---|---|
| Abstract | no |
| Documentation | The Fee Component communicates the fees associated with the vehicle being financed. 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 | |
| CapitalizedTaxInd | Indicates whether the tax is capitalized, meaning whether it is included in the monthly payments. If the tax is not capitalized it is to be paid up front. | Optional | |
| TaxPaidTo | The name of the organization or jurisdiction the tax is paid to, e.g., to which state the tax is being paid. | Optional |
| Super-types: | xsd:string < Description (by extension) < CreditDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | CreditDescription |
|---|---|
| Abstract | no |
| Documentation | Miscellaneous additions to the dealer settlement amount (e.g., Owner Loyalty Reimbursement). More information at: http://www.starstandard.org. |
| Super-types: | PartyBase < DealerPartyBase (by extension) < DealerExtendedAddress (by extension) |
|---|---|
| Sub-types: |
|
| Name | DealerExtendedAddress |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| DealerName | Dealer name | Optional | |
| DistrictCode | Manufacturer Assigned District Code | Optional | |
| URI | Dealer URI | Optional | |
| ZoneCode | Manufacturer Assigned Zone Code | Optional | |
| Address | Dealer party address | Optional |
| Super-types: | PartyBase < DealerPartyBase (by extension) < DealerExtendedAddress (by extension) < DealerExtendedContracts (by extension) |
|---|---|
| Sub-types: | None |
| Name | DealerExtendedContracts |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| DealerName | Dealer name | Optional | |
| DistrictCode | Manufacturer Assigned District Code | Optional | |
| URI | Dealer URI | Optional | |
| ZoneCode | Manufacturer Assigned Zone Code | Optional | |
| Address | Dealer party address | Optional | |
| DealerReserveNumber | Dealer party address | Optional | |
| Contact | Organizational Party contact information | Optional | |
| LegalDealershipName | Legal name for dealership | Optional |
| Super-types: | PartyBase < DealerPartyBase (by extension) |
|---|---|
| Sub-types: |
|
| Name | DealerPartyBase |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| DealerName | Dealer name | Optional | |
| DistrictCode | Manufacturer Assigned District Code | Optional | |
| URI | Dealer URI | Optional | |
| ZoneCode | Manufacturer Assigned Zone Code | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < DealerReserveAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | DealerReserveAmount |
|---|---|
| Abstract | no |
| Documentation | The dollar amount associated with the dealer reserve. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Deduction |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DeductionDescription | Description of any deductions from the dealer settlement amount (e.g., Tax Stamp Amount). | Optional | |
| DeductionAmount | The dollar amount being deducted from the dealer settlement amount. | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < DeductionAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | DeductionAmount |
|---|---|
| Abstract | no |
| Documentation | The dollar amount being deducted from the dealer settlement amount. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < DeductionDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | DeductionDescription |
|---|---|
| Abstract | no |
| Documentation | Description of any deductions from the dealer settlement amount (e.g., Tax Stamp Amount). More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < DeferredGrossAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | DeferredGrossAmount |
|---|---|
| Abstract | no |
| Documentation | A portion of the dealer's proceeds that is held for future payment. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) |
|---|---|
| Sub-types: | None |
| Name | Description |
|---|---|
| Abstract | no |
| Documentation | Description More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| language | The ISO language code that the description is written. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Destination |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DestinationNameCode | Code for destination of file (i.e.Short Manufacturer or DSP code) | Optional |
Must use a valid code from the ShortMfg/RSP list on
http://www.starstandards.org
|
| DestinationURI | Physical address of the destination | Optional | |
| DestinationSoftwareCode | Additional information about the destination application | Optional | |
| DestinationSoftware | For which software destination file is intended (may not be known). | Optional | |
| DealerNumber | Target Dealer Code receiving information | Optional | |
| StoreNumber | Dealer code store number (DMS assigned) | Optional | |
| AreaNumber | Dealer code area number (DMS vendor assigned) | Optional | |
| DealerCountry | Target Dealer country location | Optional | |
| PartyId | The Party Id field uniquely identifies the Receiver of the message. This element can be used for parties within the Automotive Community as well as external parties. Party Id is not intended as a replacement for the Dealer Number. Suggested formats for OEMs or other large institutions include: DUNs Number, ShortMfgCode + DUNs, or ShortMfgCode. The suggested format for Dealers is: ShortMfgCode+Dealer Number. | Optional | |
| LocationId | The Location Id field uniquely identifies the location of the Receiver of a message. This Id may be aligned with a physical address or data centers. This field provides an additional level of granularity beyond the usage of the Party Id for additional routing and deliver of data. | Optional | |
| ServiceId | The Service Id field identifies the particular service to which a message is being sent, e.g., an inventory service. | Optional |
| Super-types: | xsd: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:string < Description (by extension) < ErrorCriticality (by extension) |
|---|---|
| Sub-types: | None |
| Name | ErrorCriticality |
|---|---|
| Abstract | no |
| Documentation | Free form text field identifying the severity of funding error. Values may include: Hard, Soft, Warning, etc. More information at: http://www.starstandard.org. |
| Super-types: | PartyBase < OrganizationPartyBase (by extension) < FinanceParty (by extension) < ExpandedFinanceParty (by extension) |
|---|---|
| Sub-types: | None |
| Name | ExpandedFinanceParty |
|---|---|
| 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 | |
| BranchCode | Manufacturer branch code. | Optional | |
| CompanyCode | Manufacturer company code. | Optional | |
| DivisionCode | Manufacturer division code. | Optional | |
| ServiceCenterCode | Manufacturer service center code. | Optional | |
| Contact | Organizational Party contact information | Optional | |
| HoldingCompany | The company that is securing or underwriting the loan. | Optional | |
| URI | Website of Finance Source. This is the consumer-facing URI. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Fee |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| FeeType | Designates the type of fee being applied. | Optional | |
| FeeDescription | Describes the type of fee being applied. | Optional | |
| FeeAmount | Describes the type of fee being applied. | Optional | |
| FeePaidTo | Describes to whom the fee is to be paid. | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < FeeAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | FeeAmount |
|---|---|
| Abstract | no |
| Documentation | The amount of the fee being applied. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < FeeDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | FeeDescription |
|---|---|
| Abstract | no |
| Documentation | Describes the type of fee being applied. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < FeePaidTo (by extension) |
|---|---|
| Sub-types: | None |
| Name | FeePaidTo |
|---|---|
| Abstract | no |
| Documentation | Describes to whom the fee is to be paid. More information at: http://www.starstandard.org. |
| Super-types: | PartyBase < OrganizationPartyBase (by extension) < FinanceParty (by extension) |
|---|---|
| Sub-types: |
|
| Name | FinanceParty |
|---|---|
| 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 | |
| BranchCode | Manufacturer branch code. | Optional | |
| CompanyCode | Manufacturer company code. | Optional | |
| DivisionCode | Manufacturer division code. | Optional | |
| ServiceCenterCode | Manufacturer service center code. | Optional |
| Super-types: | xsd:string < Description (by extension) < FinancePlan (by extension) |
|---|---|
| Sub-types: | None |
| Name | FinancePlan |
|---|---|
| Abstract | no |
| Documentation | Description of standard finance plan applied to deal. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | FundingErrorMessage |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Description | A free form text description of the error message. | Optional | |
| ReasonCode | A code identifying the reason for the error message. | Optional | |
| CorrectValue | The correct value of the field in question. | Optional | |
| ErrorCriticality | Free form text field identifying the severity of funding error. Values may include: Hard, Soft, Warning, etc. | Optional | |
| TimeToCorrectError | Identifies the time the dealer has to correct the error. | Optional | |
| ReferenceName | Text description or XPATH reference to data element in error. | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < GrossProceedsAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | GrossProceedsAmount |
|---|---|
| Abstract | no |
| Documentation | The amount that the finance source is paying the dealer for the deal. EX: If a dealer owes a buy down amount, it may be deducted from their proceeds. More information at: http://www.starstandard.org. |
| 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: | AddressBase < Address (by extension) < IndividualPartyAddress (by extension) < IndividualApplicantAddress (by extension) |
|---|---|
| Sub-types: | None |
| Name | IndividualApplicantAddress |
|---|---|
| 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 | |
| UrbanizationCode | Geographic definition of a metropolitan or suburban area | Optional | |
| PeriodOfResidence | Communicates an applicant's period of residence | Optional | |
| ResidenceType | The type of residence (i.e. Rent, Own, etc) | Optional |
| Super-types: | PartyBase < IndividualApplicantContractRespParty (by extension) |
|---|---|
| Sub-types: |
|
| Name | IndividualApplicantContractRespParty |
|---|---|
| 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 | |
| Privacy | Any privacy rights the party has subscribed to or opted out of. | Optional |
| Super-types: | IndividualPartyPersonName < IndividualApplicantPersonName (by extension) |
|---|---|
| Sub-types: |
|
| Name | IndividualApplicantPersonName |
|---|---|
| Abstract | no |
| 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 | |
| SecondFamilyName | Additional last name. | Optional |
| Super-types: | IndividualPartyPersonName < IndividualApplicantPersonName (by extension) < IndividualApplicantPersonNameExtended (by extension) |
|---|---|
| Sub-types: | None |
| Name | IndividualApplicantPersonNameExtended |
|---|---|
| Abstract | no |
| 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 | |
| SecondFamilyName | Additional last name. | Optional | |
| EmployeeTitle | A formal appellation attached to the name of a person or family by virtue of office, rank, hereditary privilege, noble birth, or attainment or used as a mark of respect. EX: CIO, CEO, President, etc. | Optional |
| Super-types: | AddressBase < Address (by extension) < IndividualPartyAddress (by extension) |
|---|---|
| Sub-types: |
|
| 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: | 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: |
|
| Name | IndividualPartyPersonName |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Salutation | Title or greeting of business party | Optional | |
| GivenName | First Name of business party | Required | |
| MiddleName | Middle Initial of business party | Optional | |
| FamilyName | Last Name of business party | Required | |
| Suffix | Business Party name suffix designation if individual Ex: Sr, Jr, III, etc. | Optional | |
| FormattedName | Full Name of business party. Format for name should be "First Last" with no commas between first and last name | Optional | |
| SortName | Index name used as a sort for report purposes | Optional |
| Super-types: | xsd:string < Id (by extension) < 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: | xsd:decimal < Amount (by extension) < MSRPPackage (by extension) |
|---|---|
| Sub-types: | None |
| Name | MSRPPackage |
|---|---|
| Abstract | no |
| Documentation | Manufacturer suggested retail price / discount amount. Discount package is for a special package on a vehicle. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Percent (by extension) < NetAnnualPercentageRate (by extension) |
|---|---|
| Sub-types: | None |
| Name | NetAnnualPercentageRate |
|---|---|
| Abstract | no |
| Documentation | The rate charged to the dealer More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < NetProceedsAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | NetProceedsAmount |
|---|---|
| Abstract | no |
| Documentation | The GrossProceedsAmount minus the wholesale payoff amount. 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: | xsd:integer < Count (by extension) < NumberOfOverduePayments (by restriction) |
|---|---|
| Sub-types: | None |
| Name | NumberOfOverduePayments |
|---|---|
| Abstract | no |
| Documentation | The number of payments that are already passed due at the time the deal is funded. 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: | AddressBase < OrganizationAddress (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationAddress |
|---|---|
| Abstract | no |
| Documentation | Basic address used for organizations 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 | |
| UrbanizationCode | Geographic definition of a metropolitan or suburban area | Optional |
| Super-types: | PartyBase < OrganizationalApplicantContractRespParty (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationalApplicantContractRespParty |
|---|---|
| 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 | Organization applicant contact information | Optional | |
| MarketingMailInd | Indicates customers whom have requested no marketing mail | Optional | |
| OrganizationType | Identifies the type of business (i.e., Sole Proprietorship, Partnership, LLP, LLC, Not For Profit, etc.). | Optional | |
| Privacy | Organization Privacy options | Optional |
| Super-types: | AddressBase < Address (by extension) < OrganizationalApplicantPartyAddressExtended (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationalApplicantPartyAddressExtended |
|---|---|
| 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 | |
| PeriodOfResidence | Communicates an applicant’s period of residence | Optional | |
| UrbanizationCode | Geographic definition of a metropolitan or suburban area | 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 | 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: | OrganizationContactPersonName < OrganizationContactPersonNameExtended (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationContactPersonNameExtended |
|---|---|
| Abstract | no |
| 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 | |
| EmployeeTitle | A formal appellation attached to the name of a person or family by virtue of office, rank, hereditary privilege, noble birth, or attainment or used as a mark of respect. EX: CIO, CEO, President, etc. | 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: | xsd:string < Description (by extension) < OtherDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | OtherDescription |
|---|---|
| Abstract | no |
| Documentation | The text description of Other value from telephone desc attribute. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < OverduePaymentAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | OverduePaymentAmount |
|---|---|
| Abstract | no |
| Documentation | The dollar amount of the past due payments. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | PartyBase |
|---|---|
| Abstract | no |
| Documentation | Derived from oa:Party More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional |
| Super-types: | xsd:string < Id (by extension) < PartyId (by extension) |
|---|---|
| Sub-types: | None |
| Name | PartyId |
|---|---|
| Abstract | no |
| Documentation | Party Identification Number More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < PaymentAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | PaymentAmount |
|---|---|
| Abstract | no |
| Documentation | Monthly Payment Amount More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Percent (by extension) |
|---|---|
| Sub-types: | None |
| Name | Percent |
|---|---|
| Abstract | no |
| Documentation | Percent More information at: http://www.starstandard.org. |
| Super-types: | xsd:integer < Count (by extension) < PeriodOfResidence (by extension) |
|---|---|
| Sub-types: | None |
| Name | PeriodOfResidence |
|---|---|
| Abstract | no |
| Documentation | Period of time Business Party has lived at residence. More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| period | Required |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Privacy |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PrivacyInd | Indicator to note that Business Party has requested to share or to not share information with third parties | Optional | |
| PrivacyType | Code identifying a Party's authorized privacy rights. (i.e., Financial, Demographics, etc.) | Optional |
| Super-types: | xsd:string < Description (by extension) < ReferenceName (by extension) |
|---|---|
| Sub-types: | None |
| Name | ReferenceName |
|---|---|
| Abstract | no |
| Documentation | The name of the field/tag that references/idenitifies the key data elements the senders request/response bod. More information at: http://www.starstandard.org. |
| Super-types: | Verb < ConfirmableVerb (by extension) < ResponseVerb (by extension) |
|---|---|
| Sub-types: |
|
| Name | ResponseVerb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| OriginalBODId | Optional |
| Super-types: | xsd:decimal < Percent (by extension) < RetailAPRBuyDown (by extension) |
|---|---|
| Sub-types: | None |
| Name | RetailAPRBuyDown |
|---|---|
| Abstract | no |
| Documentation | The difference in the finance charge amount between the buy rate and the customer rate. For instance if the buy rate is 4.9% and the dealer writes the contract for 2.9% - the difference of 1% finance charge needs to be paid to the lender up-front. 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 |
Must use a valid code from the ShortMfg/RSP list on
http://www.starstandards.org
|
| SenderURI | Physical address of the sender | Optional | |
| DealerNumber | Dealer Code of source of information | Optional | |
| StoreNumber | Dealer code store number (DMS assigned) | Optional | |
| AreaNumber | Dealer code area number (DMS vendor assigned) | Optional | |
| DealerCountry | Source Dealer country location | Optional | |
| Language | This code is used to define the language of the data used in this transaction | Optional | |
| DeliverPendingMailInd | Indicates if the user requests to receive pending mail that has been stored and has yet not been delivered yet. By selecting 0, the user will only receive the response for the current transaction the user is performing. | Optional | |
| 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: | None |
|---|---|
| Sub-types: | None |
| Name | Signature |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| qualifyingAgency | Optional |
| Field/Component | Description | Requirement | Business Rules |
|---|
| Super-types: | xsd:string < Description (by extension) < SpecialProgramDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | SpecialProgramDescription |
|---|---|
| Abstract | no |
| Documentation | The description of the special program (First Time Buyer, College Graduate, etc.) being applied to the deal. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | SpecialProgramDetail |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| SpecialProgramDescription | The description of the special program (First Time Buyer, College Graduate, etc.) being applied to the deal. | Optional | |
| SpecialPrograms | Code identifying the special program (First Time Buyer, College Graduate, etc.) being applied to the deal. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| 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:integer < Count (by extension) < Term (by extension) |
|---|---|
| Sub-types: | None |
| Name | Term |
|---|---|
| Abstract | no |
| Documentation | Number of months of contract term More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| length | Required |
| Super-types: | xsd:integer < Count (by extension) < TimeToCorrectError (by extension) |
|---|---|
| Sub-types: | None |
| Name | TimeToCorrectError |
|---|---|
| Abstract | no |
| Documentation | Identifies the time the dealer has to correct the error. More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| period | Required |
| 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: | 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 | 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 Selling Price Cap Cost Other MSRP Discount Gross Cap Cost Net Cap Cost Taxable Selling Price N/A |
| PricingTypeSource | Source from which pricing type data originated (i.e. Blue Book, NADA, etc.) | Optional |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | Verb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|
| Super-types: | xsd:string < AddressLine (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AddressLine |
|---|---|
| Documentation | Indicates the multiple lines of an address. The first line is typically the street name and number. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < AddressQualifier (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AddressQualifier |
|---|---|
| Documentation | Address Qualifier More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| WorkAddress | Work Address |
| SeasonalAddress | Seasonal Address |
| DeliveryAddress | Delivery Address |
| HomeAddress | Home Address |
| PreviousAddress | Previous Address |
| Other | Other |
| Garage | Garage |
| Billing | Billing |
| NonSigningSpouseAddress | Non Signing Spouse Address |
| N/A | Not Applicable |
| Super-types: | xsd:string < Indicator (by restriction) < AirConditionInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AirConditionInd |
|---|---|
| Documentation | Indicates whether or not the vehicle has air conditioning. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < ApplicationNumberDescription (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ApplicationNumberDescription |
|---|---|
| Documentation | Describes the type of application number used. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Finance Source | Application number assigned by the Finance Source |
| Retail System Provider | Application Number assigned by the Retail System Provider |
| Super-types: | xsd:string < Type (by restriction) < ApplicationType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ApplicationType |
|---|---|
| Documentation | Type of application being submitted for financing (e.g., individual, individual + co-applicant, business, business + coapplicant, employee). More information at: http://www.starstandard.org. |
| 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:date < Date (by restriction) < BookingDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BookingDate |
|---|---|
| Documentation | The date that the finance source begins servicing the deal. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < BranchCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BranchCode |
|---|---|
| Documentation | Manufacture branch code. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < BulletinNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BulletinNumber |
|---|---|
| Documentation | Identifies the bulletin used to fund the deal. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Text (by restriction) < BuyPercentageRateAdjDesc (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BuyPercentageRateAdjDesc |
|---|---|
| Documentation | Description of adjustment to buy rate. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < BuyPercentageRateAdjTypeCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BuyPercentageRateAdjTypeCode |
|---|---|
| Documentation | Indicates the type of adjustment, either an addition or subtraction, to be made to the buy rate. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Addition | Indicates an addition to be made to the buy rate. |
| Subtraction | Indicates a subtraction to be made to the buy rate. |
| Super-types: | xsd:string < Indicator (by restriction) < CapitalizedTaxInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CapitalizedTaxInd |
|---|---|
| Documentation | Indicates whether the tax is capitalized, meaning whether it is included in the monthly payments. If the tax is not capitalized it is to be paid up front. 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 < Code (by restriction) < CompanyCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CompanyCode |
|---|---|
| Documentation | Manufacture company code.. 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: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 < ReferenceNumber (by restriction) < ContractFormNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ContractFormNumber |
|---|---|
| Documentation | Identifies the type of contract. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < ContractMVP (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ContractMVP |
|---|---|
| Documentation | The rating of the customer based on the credit worthiness of the customer. 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 < Name (by restriction) < DealerName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DealerName |
|---|---|
| Documentation | Dealer name More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < DealerReserveNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DealerReserveNumber |
|---|---|
| Documentation | Additional dealer number to identify the payment of finance reserve More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Type (by restriction) < DealerReserveType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DealerReserveType |
|---|---|
| Documentation | Identifies the type of Dealer Reserve (i.e., Flat, Standard Dealer Participation, Guaranteed Dealer Participation. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < DistrictCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DistrictCode |
|---|---|
| Documentation | Manufacturer Assigned District Code More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < DivisionCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DivisionCode |
|---|---|
| Documentation | Manufacture division code. More information at: http://www.starstandard.org. |
| Super-types: | xsd:dateTime < DateTime (by restriction) < DocumentDateTime (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DocumentDateTime |
|---|---|
| Documentation | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < DocumentVersionNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DocumentVersionNumber |
|---|---|
| Documentation | Identifies the version of the doucment. More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < EffectiveDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | EffectiveDate |
|---|---|
| Documentation | Effective date More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < EmployeeTitle (by restriction) |
|---|---|
| Sub-types: | None |
| Name | EmployeeTitle |
|---|---|
| Documentation | Employee Title 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 < 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 < FeeType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FeeType |
|---|---|
| Documentation | Designates the type of fee being applied More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| DocumentPreparationFee | |
| SmogCertificateFeePaidToState | |
| DocumentationFee | |
| FloridaDocumentFee | |
| FilingFee | |
| TitleFee | |
| RegistrationFee | |
| LicenseFee | |
| TireFee | |
| MotorVehicleInspectionFee | |
| BatteryFee | |
| WarrantyRightsFee | |
| CanadaFilingFee | |
| OfficialFeesPaidToGovtAgencies | |
| DocumentaryStampFee | |
| GAP | |
| LoanOriginationFee | |
| DeputyServiceFeePaidToDealer | |
| SmogCertificateFeePaidToSeller | |
| SmogImpactFee | |
| ServiceContract | |
| PlateFee | |
| LienNotationFee | |
| WasteTire | |
| ArbitrationFee | |
| NotaryFee | |
| SecurityInterestChargesFilingFee | |
| ElectronicTitleFee | |
| SafetyInspectionFee | |
| ProcessingFee | |
| EmergencyMedicalServiceAdministrationFee | |
| EmissionInspectionFee | |
| AcquisitionFee | |
| Other | Other |
| DispositionFee | |
| TurnInFee | |
| UDriveItPermit | |
| SellPaidSmogFee | |
| TemporaryTagFee | |
| TransferFee | |
| SmogExemptionDonationFee | |
| LienFee | |
| WeightFee | |
| PostageFee | |
| N/A | Not Applicable |
| PurchaseOptionFee | |
| MonthlyLocalFee | |
| SPVFee | |
| OnlineRegistrationFee | |
| FloridaMVWEAFee | |
| ExemptionFee | |
| LemonLawFeePaidToGovernmentAgency | |
| TerminationFee | |
| PublicSafetyFee | |
| VehicleTheftRecoveryFee | |
| RearEndDeterrentSafetyFee | |
| NonFilingInsuranceFee | Non filing insurance fee is property insurance utilized in connection with credit transactions in lieu of the actual recording, filing, or releasing of a security instrument or finance statement. |
| EnvironmentalProtectionFee | Environmental protection fee is a fee imposed on the consumers to protect and clean up the environment. This fee can be applied to clean up of underground storage tank site studies and clean up as well as other environmental protections. |
| FreightFee | Freight charges are the fee for hauling a vehicle to a dealership. |
| DealerProcessingFee | Dealer processing charge. |
| VendorSingleInterestFee | A fee charged by the Creditor to protect the creditor for loss or damage to the vehicle during the initial term of the contract. |
| AutoClubMembershipFee | Fee for membership to auto club such as AAA. |
| DPSHandlingFee | Fee for Louisiana. Department of Public Service Handling fee. |
| ElectronicFilingFee | Electronic Filing Fee for online system filing. |
| ConvenienceFee | Fee for Louisiana. Additional fee charged by the dealer. |
| PPSAFee | Personal Property Security Act - Fee charged to customer for registration of the vehicle contract (VIN) with the Government. |
| AdministrationFee | Fee charged for administration of records. |
| ERTFee | State regulated electronic registration and titling fee. |
| GasFee | State regulated gas fee. |
| TitlePrepFee | Fee charged for preparation of title. |
| SupplementalTitleFee | State regulated supplemental title fee. |
| GeorgiaMotorVehicleWarrantyRightsActFee | Companies that sell or lease new motor vehicles to consumers have certain responsibilities under the law. Pursuant to the Georgia Motor Vehicle Warranty Rights Act [O.C.G.A. Section 10-1-789(a)], a fee of $3.00 shall be collected by every dealer, lessor or distributor from each consumer at the completion of the sale or lease of a new motor vehicle. |
| RoadandBridgeFee | A fee on motor vehicle registrations to fund costs associated with road improvements. - Texas |
| MotorVehicleWarrantyTrustFundFee | The $2 fee is collected by the motor vehicle dealer when a new motor vehicle is sold or leased for one year or more. The fee is reported and paid by the selling dealer to the county tax collector or private tag agency when the dealer applies for title. The fees are transferred monthly by the Florida Department of Revenue to the Department of Legal Affairs for deposit into the Motor Vehicle Warranty Trust Fund. - Florida |
| InspectionStickerFees | A fee charged by the dealer for inspection purposes to protect unsafe vehicles from being operated on the road. The fee is used to inspect the vehicle ensuring it is mechanically sound and safe. - Mississippi |
| EmergencyMedicalServiceFees | Fee charged for EMS services for all drivers. - Washington |
| Smog Abatement Fee | The Smog Abatement Fee is the annual fee that must be paid upon registration renewal in lieu of the bi-annual smog inspection. |
| Greenhouse Gas Reduction | A fee that is placed on the registration or renewal of a vehicle that uses fossil fuels for propulsion. |
| Rental Car Surcharge Fee | Rental Car Surcharge is imposed upon a lease or rented motor vehicle |
| Messenger Fee | Messenger Fee pass through charge by dealers to have an outside company provide a public service of delivering and obtaining documents to and from the Department of Motor Vehicle |
| Encumbrance Fee | The Encumbrance Fee is charged to establish a claim against property. This fee is charged by the Dealer but handle by a third party. |
| Title and Registration Processing Fee | A fee charged to process the title and registration of a vehicle |
| DEQ Certification Fee | Air and qualify certification fee. |
| Motor Vehicle Processing Fee | States like New Jersey that charge the consumer a processing fee for the Motor Vehicle. |
| Department of Motor Vehicle Fee | A fee charged by the department of motor vehicles. |
| New Tag Fee | A fee to obtain a new plate tag. |
| Duplicate of Registration Fee | A fee to obtain a copy of an existing registration if lost, stolen, or destroyed. |
| Vehicle Theft Registration Fee | A fee charged to register theft deterrent products. |
| Total Annual Fees | Total of Annual Fees |
| Total Initial Fees | Total of Initial Fees |
| Document Service Fee | Fee charged to a buyer/lessee for the handling of documents and the performing of services related to the sale /lease and may include dealer profit. |
| Service and Handling Fee | Fee charged to a buyer/lessee for the performing services and handling related to the closing of a sale /lease and may include dealer profit. |
| Delivery and Handling Fee | Fee charged to a buyer/lessee for the handling related to the closing of a sale /lease and may include dealer profit. |
| Recording Fee | Fee charged to a buyer/lessee for the recording of the title (part of the title fee that must be disclosed separately) and is related to the closing of a sale /lease. |
| Air Quality Fee | Air Quality Fee |
| Lender and Member Fee | Lender's and Members's Fee |
| Mobility Fee | Fee paid to Texas Mobility Fund |
| Acquisition Fee Markup | An amount added to the finance company Acquisition Fee that is retained by the dealer. |
| Courtesy Delivery Fee | Fee for delivery of ordered vehicle(s) to multiple destinations. |
| Electronic Temp Tag Processing Fee | Electronic temporary tag processing fee paid to a vendor (not the state). |
| Assignment Fee | Fee paid to the dealer from the finance source for assignment of the contract. This fee is separate from an acquisition fee. |
| Special Monthly Fee | Finance source-specific monthly fee on a lease. This differs from "Monthly Local Fee" which is generally a monthly property tax that the vehicle owner (which is the lender in the case of a lease) passes on to the lessee. "Special Monthly Fee" is a fee that the lender collects and pays into a fund for a special purpose--for example, in New York, the fund is used to pay parking tickets that are by law the responsibility of the vehicle owner (the lender). Not all lenders handle this the same way, but those that do require that these two fees be accounted for differently. |
| Super-types: | xsd:string < Type (by restriction) < FinanceType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FinanceType |
|---|---|
| Documentation | Type of financing Examples may be F- Finance, L - Lease, C-Cash, 1-Retail, 2-Lease, 3-Balloon, etc. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < 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 < Note (by restriction) < FunderComments (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FunderComments |
|---|---|
| Documentation | Free form text area for Funder's comments. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < FundingStatus (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FundingStatus |
|---|---|
| Documentation | Identifies the funding status of the deal. More information at: http://www.starstandard.org. |
| 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 < Name (by restriction) < HoldingCompany (by restriction) |
|---|---|
| Sub-types: | None |
| Name | HoldingCompany |
|---|---|
| Documentation | The company that is securing or underwriting the loan. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < HomeWork (by restriction) |
|---|---|
| Sub-types: | None |
| Name | HomeWork |
|---|---|
| Documentation | Home or Work More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Home | Home |
| Work | Work |
| Other | Other |
| Super-types: | xsd:string < IncomePeriod (by restriction) |
|---|---|
| Sub-types: | None |
| Name | IncomePeriod |
|---|---|
| Documentation | HR = Hour, WK = Week, BiWK = Bi-Weekly, MO = Month, YR = Year, SmMO=SemiMonthly, SmAN=SemiAnnually More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| HR | Hour |
| WK | Week |
| BiWK | Bi-Weekly |
| MO | Monthly |
| YR | Year |
| SmMO | Semi-Monthly |
| SmAN | Semi-Annually. Semi-Annually is twice per year |
| Q | Quarterly |
| 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 < 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: | None |
| Name | Language |
|---|---|
| Documentation | Language conforms to ISO 639-2 rules. Note the format for this field is language-Country (see Country data type for the list of countries with definitions). AA "Afar", AB "Abkhazian", AF "Afrikaans", AM "Amharic", AR "Arabic", AS "Assamese", AY "Aymara", AZ "Azerbaijani", BA "Bashkir", BE "Byelorussian", BG "Bulgarian", BH "Bihari", BI "Bislama", BN "Bengali" "Bangla", BO "Tibetan", BR "Breton", CA "Catalan", CO "Corsican", CS "Czech", CY "Welsh", DA "Danish", DE "German", DZ "Bhutani", EL "Greek", EN "English" "American", ES "Spanish", ET "Estonian", EU "Basque", FA "Persian", FI "Finnish", FJ "Fiji", FO "Faeroese", FR "French", FY "Frisian", GA "Irish", GD "Gaelic" "Scots Gaelic", GL "Galician", GN "Guarani", GU "Gujarati", HA "Hausa", HI "Hindi", HR "Croatian", HU "Hungarian", HY "Armenian", IK "Inupiak", IN "Indonesian", IS "Icelandic", IT "Italian", IW "Hebrew", JA "Japanese", JI "Yiddish", JW "Javanese", KA "Georgian", KK "Kazakh", KL "Greenlandic", KM "Cambodian", KN "Kannada", KO "Korean", KS "Kashmiri", KU "Kurdish", KY "Kirghiz", LA "Latin", LN "Lingala", LO "Laothian", LT "Lithuanian", LV "Latvian" "Lettish", MG "Malagasy". MI "Maori", MK "Macedonian", ML "Malayalam", MN "Mongolian", MO "Moldavian", MR "Marathi", MS "Malay", MT "Maltese", MY "Burmese", NA "Nauru", NE "Nepali", NL "Dutch", NO "Norwegian", OC "Occitan", OM "Oromo" "Afan", OR "Oriya", PA "Punjabi", PL "Polish", PS "Pashto" "Pushto", PT "Portuguese", QU "Quechua", RM "Rhaeto-Romance", RN "Kirundi", RO "Romanian", RU "Russian", RW "Kinyarwanda", SA "Sanskrit", SD "Sindhi", SG "Sangro", SH "Serbo-Croatian", SI "Singhalese", SK "Slovak", SL "Slovenian", SM "Samoan", SN "Shona", SO "Somali", SQ "Albanian", SR "Serbian", SS "Siswati", ST "Sesotho", SU "Sudanese", SV "Swedish", SW "Swahili", TA "Tamil", TE "Tegulu", TG "Tajik", TH "Thai", TI "Tigrinya", TK "Turkmen", TL "Tagalog", TN "Setswana", TO "Tonga", TR "Turkish", TS "Tsonga", TT "Tatar", TW "Twi", UK "Ukrainian", UR "Urdu", UZ "Uzbek", VI "Vietnamese", WO "Wolof", XH "Xhosa", YO "Yoruba", ZH "Chinese", ZU "Zulu" More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| en-US | |
| en-CA | |
| aa-ET | |
| ab-GE | |
| af-ZA | |
| am- ET | |
| ar-SA | |
| as-IN | |
| ay-BO | |
| az-AZ | |
| ba-RU | |
| be-BY | |
| bg-BG | |
| bh-IN | |
| bi-VU | |
| bn-BD | |
| bo-BT | |
| br-FR | |
| ca-ES | |
| co-FR | |
| cs-CZ | |
| cy-GB | |
| da-DE | |
| de-DE | |
| dz-BT | |
| el-GR | |
| es-ES | |
| et-EE | |
| eu-ES | |
| fa-AF | |
| fi-FI | |
| fj-FJ | |
| fo-FO | |
| fr-CA | |
| fr-FR | |
| fy-NL | |
| ga-IE | |
| gd-GB | |
| gl-ES | |
| gn-PY | |
| gu-IN | |
| ha-NG | |
| hi-IN | |
| hr-HR | |
| hu-HU | |
| hy-AM | |
| ik-GL | |
| in-ID | |
| is-IS | |
| it-IT | |
| iw-IL | |
| ja-JP | |
| ji-IL | |
| jw-ID | |
| ka-GE | |
| kk-KZ | |
| kl-GL | |
| km-KH | |
| kn-IN | |
| ko-KP | |
| ko-KR | |
| ks-IN | |
| ku-IQ | |
| ky-CN | |
| la-VA | |
| ln-CD | |
| lo-LA | |
| lt-LT | |
| lv-LV | |
| mg-MG | |
| mi-NZ | |
| mk-MK | |
| ml-IN | |
| mn-MN | |
| mo-MO | |
| mr-IN | |
| ms-MY | |
| mt-MH | |
| my-MM | |
| na-NR | |
| ne-NP | |
| nl-NL | |
| no-NO | |
| oc-FR | |
| om- ET | |
| or-IN | |
| pa-IN | |
| pl-PL | |
| ps-PK | |
| pt-PT | |
| qu-PE | |
| rm-CH | |
| rn-BI | |
| ro-RO | |
| ru-RU | |
| rw-RW | |
| sa-IN | |
| sd-PK | |
| sg-CF | |
| sh-HR | |
| si-LK | |
| sk-SK | |
| sl-SI | |
| sm-WS | |
| sn-ZW | |
| so-SO | |
| sq-AL | |
| sr-CS | |
| ss-ZA | |
| st-ZA | |
| su-SD | |
| sv-SE | |
| sw-TL | |
| ta-IN | |
| te-IN | |
| tg-TJ | |
| th-TH | |
| ti-ET | |
| tk-TM | |
| tl-PH | |
| tn-ZA | |
| to-TO | |
| tr-TR | |
| ts-ZA | |
| tt-RU | |
| tw-GH | |
| uk-UA | |
| ur-PK | |
| uz-UZ | |
| vi-VN | |
| wo-SN | |
| xh-ZA | |
| yo-NG | |
| zh-CN | |
| zu-ZA |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < LeaseBuyMoneyFactor (by restriction) |
|---|---|
| Sub-types: | None |
| Name | LeaseBuyMoneyFactor |
|---|---|
| Documentation | Lease Rate/Service Factor offered to the dealer by Finance Source. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < LeaseRateMoneyFactor (by restriction) |
|---|---|
| Sub-types: | None |
| Name | LeaseRateMoneyFactor |
|---|---|
| Documentation | Money factor multiplier used to determine finance costs for a lease. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < LegalDealershipName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | LegalDealershipName |
|---|---|
| Documentation | Legal name for dealership. 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 < 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 < ReferenceNumber (by restriction) < MaximumLeaseRateMoneyFactor (by restriction) |
|---|---|
| Sub-types: | None |
| Name | MaximumLeaseRateMoneyFactor |
|---|---|
| Documentation | Maximum rate the dealer can charge the customer for the vehicle being purchased. This is the LeaseBuyMoney Factor plus maximum markup. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < MiddleName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | MiddleName |
|---|---|
| Documentation | Middle Initial of business party More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < 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 < 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) < Notifications (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Notifications |
|---|---|
| Documentation | Free form text area identifying any policies are legal restrictions. 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 < 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 < Type (by restriction) < OrganizationType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OrganizationType |
|---|---|
| Documentation | Identifies the type of business (i.e., Sole Proprietorship, Partnership, LLP, LLC, Not For Profit, etc.). More information at: http://www.starstandard.org. |
| 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 < 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 < Indicator (by restriction) < PrivacyInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PrivacyInd |
|---|---|
| Documentation | Indicator to note that Business Party has requested to share or to not share information with third parties. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Type (by restriction) < PrivacyType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PrivacyType |
|---|---|
| Documentation | Code identifying a Party's authorized privacy rights. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < ReasonCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ReasonCode |
|---|---|
| Documentation | Code indicating reason for message. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Text (by restriction) < Reference (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Reference |
|---|---|
| Documentation | Reference notation More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) |
|---|---|
| Sub-types: |
|
| Name | ReferenceNumber |
|---|---|
| Documentation | Reference number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Type (by restriction) < ResidenceType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ResidenceType |
|---|---|
| Documentation | Business Partner's type of residence (i.e., Own, Rent). More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < Salutation (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Salutation |
|---|---|
| Documentation | Title or greeting of business party More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < SecondaryPassword (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SecondaryPassword |
|---|---|
| Documentation | Secondary password used to validate access to the dealer information More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < ServiceCenterCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ServiceCenterCode |
|---|---|
| Documentation | Manufacturer service center code. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < ShortMfg (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ShortMfg |
|---|---|
| Documentation | Short Manfacturer or RSP Codes More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < SortName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SortName |
|---|---|
| Documentation | Index name used as a sort for report purposes More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < SpecialPrograms (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SpecialPrograms |
|---|---|
| Documentation | Code identifying the type of special program (First Time Buyer, College Graduate, etc. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < StateOrProvince (by restriction) |
|---|---|
| Sub-types: |
|
| Name | StateOrProvince |
|---|---|
| Documentation | Is the State or Province of a given Address. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < SubsidyCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SubsidyCode |
|---|---|
| Documentation | The manufacturer assigned code that determines the incentives that are being offered to the customer (i.e., 0% financing). More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < Suffix (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Suffix |
|---|---|
| Documentation | Business Party name suffix designation if individual Ex: Sr, Jr, III, etc. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < SystemVersion (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SystemVersion |
|---|---|
| Documentation | The sender's software version number . More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < TaxabilityInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TaxabilityInd |
|---|---|
| Documentation | Determines whether an item or amount is taxable. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Name (by restriction) < TaxPaidTo (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TaxPaidTo |
|---|---|
| Documentation | The name of the organization or jurisdiction the tax is paid to, e.g., to which state the tax is being paid. More information at: http://www.starstandard.org. |
| 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 < TermLength (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TermLength |
|---|---|
| Documentation | Term Length More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Months | Months |
| Weeks | Weeks |
| Years | Years |
| Super-types: | xsd:string < Text (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Text |
|---|---|
| Documentation | Indicates generic text type More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < 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:string < ValidationResults (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ValidationResults |
|---|---|
| Documentation | Identifies whether a Credit Contract has passed validation rules as defined by the receiving organization. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Passed | Credit contract passed validation |
| Failed | Credit contract failed validation |
| Other | Other |
| N/A | Not Applicable |
| Warning | The operation completed a warning. |
| 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: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. |
| Super-types: | xsd:string < Code (by restriction) < ZoneCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ZoneCode |
|---|---|
| Documentation | Manufacturer Assigned Zone Code More information at: http://www.starstandard.org. |
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Generated by StarSchemaGuidelineGenerator based on xs3p. Last modified: