Implementation Guideline
Get Service Processing Advisory
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Implementation Guideline
Get Service Processing Advisory
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
This document is a guideline on how to use the Get Service Processing Advisory Business Object Document (BOD). Get Service Processing Advisory has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Get Service Processing Advisory process for individual consumers who service their automobiles through their OEM’s authorized Dealers. The focus is on Dealer and OEM interactions, not third party organizations. NOTE: Although this is the traditional use of the Get Service Processing Advisory, this BOD could be used to send Get Service Processing Advisory information between any two business parties.
The Get Service Processing Advisory Implementation Guidelines provide detailed information regarding the structure and meaning of the Get Service Processing Advisory BOD and corresponds directly to the Get Service Processing Advisory schema. In addition to structure and meaning, the Implementation Guidelines identify various business rules for specific fields/components that due to their nature, i.e. field interdependence, are not possible to express using schema. Please note that although these business rules are not included in the schema, they MUST be followed to be STAR Compliant. Therefore, the Get Service Processing Advisory Implementation Guidelines must be used in concert with the Get Service Processing Advisory schema during development and should NOT be considered a supplement or substitution to the schema. For more information regarding STAR XML Data Compliance, please review the STAR Data Compliance Guidelines document located on the STAR Web site.
For a copy of the corresponding Get Service Processing Advisory schema, please download the appropriate STAR schema repository from the XML portion of the STAR website (www.starstandard.org). Prior to downloading the schema, users are encouraged to download the STAR XML Reference/Implementation document also located on the XML portion of the STAR website. This document provides an overview of the STAR BOD development methodology, how to download and read STAR schema, and various frequently asked questions related to the implementation of STAR BODs.
STAR has followed the Open Application Group’s Business Object Document methodology to develop the Get Service Processing Advisory BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Get Service Processing Advisory BOD is unique to the Retail Automotive industry and is not an extension of any existing OAGIS BODs.
For more information on the Open Applications Group's BODs and related documentation please refer to the Open Applications Group’s Web site at www.openapplications.org.
STAR uses the same Noun in the schema for all the Noun/Verb combinations of the Get Service Processing Advisory 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 Service Processing Advisory Binary Collaboration starts with the sending of Service Processing Advisory information from the OEM to the Dealer. This process occurs on demand as needed. Note: This scenario is an example of how the Service Processing Advisory BOD can be used. Implemenations may vary.
The relationship diagram identifies all of the various components or building blocks of information used in the Get Service Processing Advisory BOD. This diagram visually depicts the relationships of the components using symbolic indentation and their occurrence in the BOD. Note: That this is an approximation of the Components, and may not reflect the exact implementation. Also, some fields are displayed in the diagram. This diagram should only be used as a starting point and not an absolute reference.
| Target Namespace | http://www.starstandards.org/STAR |
|---|---|
| Element and Attribute Namespaces |
|
| Documentation | This schema is made available under an Eclipse Public Licenses 1.0. This license may be found in the STAR/License directory as well as the STAR BOD Guidelines. More information at: http://www.starstandard.org/. |
| Prefix | Namespace |
|---|---|
| Default namespace | http://www.starstandards.org/STAR |
| xml | http://www.w3.org/XML/1998/namespace |
| xsd | http://www.w3.org/2001/XMLSchema |
| Name | ApplicationArea |
|---|---|
| Type | ApplicationArea |
| Nillable | no |
| Abstract | no |
| Documentation | Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of. More information at: http://www.openapplications.org/oagis. Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of. More information at: http://www.openapplications.org/oagis. |
|
| Name | Get |
|---|---|
| Type | Get |
| Nillable | no |
| Abstract | no |
| Documentation | The Get verb is to communicate to a business software component a request for an existing piece of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across most of the nouns it may be paired with.The Get is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The Get verb is not used to request several documents at once. The GetList verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned. More information at: http://www.openapplications.org/oagis. |
| Name | GetServiceProcessingAdvisory |
|---|---|
| Type | GetServiceProcessingAdvisory |
| Nillable | no |
| Abstract | no |
| Name | Header |
|---|---|
| Type | ServiceProcessingAdvisoryHeader |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | ServiceProcessingAdvisory |
|---|---|
| Type | ServiceProcessingAdvisory |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
|
| Name | Verb |
|---|---|
| Type | Verb |
| Nillable | no |
| Abstract | yes |
| Super-types: | xsd:decimal < Amount (by extension) < AdjustedAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | AdjustedAmount |
|---|---|
| Abstract | no |
| Documentation | Amount of adjustment More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | AdjustmentReason |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| AdjustedReason | Free form text of reason(s) Claim was adjusted | Optional | |
| AdjustedAmount | Difference between the submitted amount and the paid amount | Optional | |
| Tax | Amount of tax on Adjusted Amount | Optional |
| Super-types: | xsd:decimal < Amount (by extension) |
|---|---|
| Sub-types: | None |
| Name | Amount |
|---|---|
| Abstract | no |
| Documentation | Based on OAGI Amount. Simple content with the currency as an attrbute More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| currency | Required |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ApplicationArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Sender | Identifies characteristics and control identifiers that relate to the application that created the Business Object Document. The sender area can indicate the logical location of the application and/or database server, the application, and the task that was processing to create the BOD. | Required | |
| CreationDateTime | is the date time stamp that the given instance of the Business Object Document was created. This date must not be modified during the life of the Business Object Document. | Required |
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:decimal < Amount (by extension) < ApprovedAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | ApprovedAmount |
|---|---|
| Abstract | no |
| Documentation | Amount pre-approved More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | BusinessObjectDocument |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| revision | This should contain the STAR repository version in the following recommended format. 4.2.1_M20080416. Where the first part indicates the version of the STAR repository and anything after the _ indicates the Milestone build that is being used. If referring to an official published version then only the STAR Repository version is required. | Optional | |
| release | Indicates the OAGIS release that this BOD belongs. | Optional | |
| environment | Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s). | Optional | |
| lang | Indicates the language that the contents of the BOD is in unless otherwise stated. | Optional | |
| bodVersion | Deprecated as of STAR 4.2.2. It is recommended to use the revision attribute to identify the repository and the noun. May be removed in a new major version of the STAR repository. | Optional |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| ApplicationArea | Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of. | Required |
| Super-types: | xsd:integer < Count (by extension) < ClaimCount (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ClaimCount |
|---|---|
| Abstract | no |
| Documentation | Identifies the total number of Claims More information at: http://www.starstandard.org. |
| 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: | xsd:integer < Count (by extension) |
|---|---|
| Sub-types: | None |
| Name | Count |
|---|---|
| Abstract | no |
| Documentation | Simple quantity type with no attributes More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < DealerContributionAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | DealerContributionAmount |
|---|---|
| Abstract | no |
| Documentation | The dealer's contribution and or copay amount factored out of the total amount More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < DeductibleAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | DeductibleAmount |
|---|---|
| Abstract | no |
| Documentation | The Customer Deductible and/or Co/pay amount Amount. Eg:$50.00 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: | None |
|---|---|
| Sub-types: | None |
| Name | DispositionReason |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DispositionStatus | Disposition of request Ex: Rejected, Partial Payment, etc.) | Optional | |
| DispositionReasonCode | Substantiating reason for arriving at disposition | Optional | |
| DispositionReasonCodeDesc | Description of disposition Reason code | Optional |
| Super-types: | xsd:string < Description (by extension) < DispositionReasonCodeDesc (by extension) |
|---|---|
| Sub-types: | None |
| Name | DispositionReasonCodeDesc |
|---|---|
| Abstract | no |
| Documentation | Description of disposition Reason code More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < DocumentId (by extension) |
|---|---|
| Sub-types: | None |
| Name | DocumentId |
|---|---|
| Abstract | no |
| Documentation | Is the identifier for the document. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ExpressionCriteria |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| expressionLanguage | Optional |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| SelectExpression | Allows the 1-n number of selection expressions for the information to be returned. | Required |
| Super-types: | Verb < ConfirmableVerb (by extension) < RequestVerb (by extension) < Get (by extension) |
|---|---|
| Sub-types: | None |
| Name | Get |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| show | Required |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| ReturnCriteria | ReturnCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies. | Required |
| Super-types: | BusinessObjectDocument < GetServiceProcessingAdvisory (by extension) |
|---|---|
| Sub-types: | None |
| Name | GetServiceProcessingAdvisory |
|---|---|
| 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 | GetServiceProcessingAdvisoryDataArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Get | The Get verb is to communicate to a business software component a request for an existing piece of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across most of the nouns it may be paired with.The Get is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The Get verb is not used to request several documents at once. The GetList verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned. | Required | |
| ServiceProcessingAdvisory | Required |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | HeaderBase |
|---|---|
| Abstract | no |
| Documentation | Used on all STAR BODs More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DocumentDateTime | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. | Optional | |
| SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | |
| SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional |
| Super-types: | xsd:string < Id (by extension) |
|---|---|
| Sub-types: | None |
| Name | Id |
|---|---|
| Abstract | no |
| Documentation | Party Identification number More information at: http://www.starstandard.org. |
| Super-types: | xsd:integer < Count (by extension) < JobCount (by restriction) |
|---|---|
| Sub-types: | None |
| Name | JobCount |
|---|---|
| Abstract | no |
| Documentation | Identifies the total number of jobs More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | JobReconciliation |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| JobNumber | DMS assigned job or line identification number | Optional | |
| OperationId | Dealer or DMS assigned operation code identifier | Optional | |
| AdjustedInd | Indicates that the final payment Amount was adjusted from the original submission amount during processing | Optional | |
| ApprovedAmount | Total Payment amount approved | Optional | |
| LaborAmount | Labor portion of total approved amount | Optional | |
| PartsAmount | Parts portion of total approved amount | Optional | |
| OtherAmount | Everything that is not included in total approved amount such as sublets, GOG, transportation, towing, etc. | Optional | |
| Tax | Amount of job tax for total, labor, parts, prorated and other. | Optional | |
| ProratedAmount | Total payment amount after application of Customer pay Deductible and/or Co/pay amounts | Optional | |
| AdjustmentReason | Reason that adjustment was made on request | Optional | |
| DispositionReason | Reason that disposition was changed on request | Optional | |
| WarrantyClaim | Warranty Claim information associated with Job | Optional | |
| ClaimType | Identifier of the type of claim the job is associated with. | Optional | |
| PaidAmount | Total paid amount without deductions and/or co-pay amounts. | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < LaborAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | LaborAmount |
|---|---|
| Abstract | no |
| Documentation | Labor Amount More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < LocationId (by extension) |
|---|---|
| Sub-types: | None |
| Name | LocationId |
|---|---|
| Abstract | no |
| Documentation | Code identifying a physical location More information at: http://www.starstandard.org. |
| Super-types: | 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:string < Id (by extension) < OperationId (by extension) |
|---|---|
| Sub-types: | None |
| Name | OperationId |
|---|---|
| Abstract | no |
| Documentation | Dealer or DMS assigned operation code identifier More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < OtherAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | OtherAmount |
|---|---|
| Abstract | no |
| Documentation | Other Amount More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < PaidAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | PaidAmount |
|---|---|
| Abstract | no |
| Documentation | Total paid amount without deductions and/or co-pay amounts. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < PartsAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | PartsAmount |
|---|---|
| Abstract | no |
| Documentation | Parts Amount More information at: http://www.starstandard.org. |
| 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:string < Id (by extension) < PaymentCycleId (by extension) |
|---|---|
| Sub-types: | None |
| Name | PaymentCycleId |
|---|---|
| Abstract | no |
| Documentation | Identifies a Payment Cycle More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Payments |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| ClaimInvoiceNumber | Invoice number that Claim was paid from | Optional | |
| ProcessDate | Effective date of process | Optional | |
| ToBePaidAmount | Amount paid on Warranty Claim, not necessarily the amount claimed | Optional | |
| AdjustedInd | Indicates that the final payment Amount was adjusted from the original submission amount during processing | Optional | |
| RepairOrder | Repair Order information associated with a Payment/Disposition. | Optional | |
| PaymentNotes | Notes from OEM to dealer regarding this payment | Optional | |
| DispositionNotes | Notes from OEM to dealer regarding disposition of this request | Optional |
| Super-types: | xsd:decimal < Percent (by extension) |
|---|---|
| Sub-types: | None |
| Name | Percent |
|---|---|
| Abstract | no |
| Documentation | Percent More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < ProratedAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | ProratedAmount |
|---|---|
| Abstract | no |
| Documentation | Prorated Amount More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | RepairOrderReconciliation |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DocumentId | Repair Order Number - Identification number of repair order assigned by dealer or DMS | Optional | |
| VIN | Federally defined 17 position vehicle identification number | Optional | |
| RepairOrderOpenedDate | System date when Repair Order was opened | Optional | |
| RepairOrderCompletedDate | The date the last line was closed on the repair order | Optional | |
| Job | Job information associated with a Repair Order | Optional | |
| WarrantyClaim | Warranty Claim information associated with a Repair Order | Optional |
| Super-types: | Verb < ConfirmableVerb (by extension) < RequestVerb (by extension) |
|---|---|
| Sub-types: |
|
| Name | RequestVerb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| ReturnCriteria | ReturnCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies. | Required |
| Super-types: | xsd:string < 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 |
DealerNumber is Required if originating from the
DMS.
|
| 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 | ServiceProcessingAdvisory |
|---|---|
| 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 8/7/2002; OAGI approved 8/16/2002; effective date 1/01/2003 More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Header | Required |
| Super-types: | HeaderBase < ServiceProcessingAdvisoryHeader (by extension) |
|---|---|
| Sub-types: | None |
| Name | ServiceProcessingAdvisoryHeader |
|---|---|
| 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 unique identifer of the settlement instrument EX: Check Number | Optional | (INACTIVE) |
| SettlementType | Method that was used for settlement transfer of funds | Optional | (INACTIVE) |
| SettlementDate | Date that funds are transferred between the OEM and the Dealer | Optional | (INACTIVE) YYYY-MM-DD |
| PaymentCycleEndDate | Ending date of Payment Cycle | Optional | YYYY-MM-DD |
| PaymentCycleId | Identifies a Payment Cycle | Optional | |
| ClaimCount | Identifies the total number of Claims within the Payment Cycle. | Optional | (INACTIVE) |
| JobCount | Identifies the total number of jobs within the Payment Cycle. | Optional | (INACTIVE) |
| TotalAmount | Identifies the total amount of the Payment Cycle. | Optional | (INACTIVE) |
| Payments | Contains Information for request that was submitted. This component may contain additional sub-components with detail on request for payment. | Optional | (INACTIVE) |
| Disposition | Contains Information for request that was submitted. This component may contain additional sub-components with detail on reason for change in disposition of request for payment. | Optional | (INACTIVE) |
| 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: | None |
|---|---|
| Sub-types: | None |
| Name | Tax |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| TaxType | Identifies the type tax. | Required | |
| TaxDescription | Free form text description of tax amount. | Optional | |
| TaxAmount | Actual amount of tax paid. | Optional | |
| UnitSalesTaxAmount | Unit amount of sales tax. | Optional | |
| TaxRate | Tax Percentage Rate | Optional | |
| TotalTaxableAmount | Total taxble price | Optional | |
| NonTaxableAmount | Total non-taxble price | Optional | |
| TaxTypeId | Tax type identification | Optional | |
| TaxabilityInd | Determines whether the dealer wants to claim tax on the cost. | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < TaxAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | TaxAmount |
|---|---|
| Abstract | no |
| Documentation | Actual amount of tax paid. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < TaxDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | TaxDescription |
|---|---|
| Abstract | no |
| Documentation | Free form text description of tax amount. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Percent (by extension) < TaxRate (by extension) |
|---|---|
| Sub-types: | None |
| Name | TaxRate |
|---|---|
| Abstract | no |
| Documentation | Tax Percentage rate. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < ToBePaidAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | ToBePaidAmount |
|---|---|
| Abstract | no |
| Documentation | Amount to be paid More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < TotalAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | TotalAmount |
|---|---|
| Abstract | no |
| Documentation | Total price (cost + markup) More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < TotalTaxableAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | TotalTaxableAmount |
|---|---|
| Abstract | no |
| Documentation | Total taxable price. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < UnitSalesTaxAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | UnitSalesTaxAmount |
|---|---|
| Abstract | no |
| Documentation | Unit amount of sales tax. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | Verb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | WarrantyClaimBase |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| ClaimNumber | Identifier of claim entered by dealer | Optional | |
| ClaimType | Identifier of the type of claim | Optional | |
| OEMClaimNumber | Assigned by OEM at time of claim processing | Optional | |
| ExternalReferenceNumber | Secondary identifying scheme that is meaningful to claimant | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | WarrantyClaimDeductible |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DeductibleType | The type of customer deductible. Eg: Service Contract | Optional | |
| DeductibleAmount | The Customer Deductible and/or Co/pay amount factored out of the total Claim Amount. Eg:$50.00 | Optional | |
| Tax | Amount of tax on Warranty Claim for Claim and Dealer | Optional | |
| DeductibleWaiverInd | Indicates that the dealer waivered the deductible or changed the deductible from an amount greater than zero to zero. | Optional |
| Super-types: | WarrantyClaimBase < WarrantyClaimReconciliation (by extension) |
|---|---|
| Sub-types: | None |
| Name | WarrantyClaimReconciliation |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| ClaimNumber | Identifier of claim entered by dealer | Optional | |
| ClaimType | Identifier of the type of claim | Optional | |
| OEMClaimNumber | Assigned by OEM at time of claim processing | Optional | |
| ExternalReferenceNumber | Secondary identifying scheme that is meaningful to claimant | Optional | |
| WarrantyClaimDeductible | Deductible information associated with Warranty Claim | Optional | |
| AdjustedInd | Indicates that the final payment Amount was adjusted from the original submission amount during processing | Optional | |
| ToBePaidAmount | Amount paid on claim, not necessarily the amount claimed | Optional | |
| AdjustmentReason | Reason that adjustment was made on request | Optional | |
| DispositionReason | Reason that disposition was changed on request | Optional | |
| Job | Job information associated with a Warranty Claim. | Optional | |
| ClaimGasInd | Determines whether the cost of gas is included in the request for reimbursement | Optional | |
| WarrantyNotes | Notes from OEM to dealer regarding this claim | Optional | |
| DealerContributionAmount | The dealer’s contribution and or copay amount factored out of the total claim amount | Optional | |
| Tax | Amount of tax on Warranty Claim for Claim and Dealer | Optional |
| Super-types: | xsd:string < Indicator (by restriction) < AdjustedInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AdjustedInd |
|---|---|
| Documentation | Indicates that the Amount was adjusted More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Code (by restriction) < AdjustedReason (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AdjustedReason |
|---|---|
| Documentation | Free form text of reason(s) for adjustment More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < ClaimGasInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ClaimGasInd |
|---|---|
| Documentation | Determines whether the cost of gas is included in the request for reimbursement More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < ClaimInvoiceNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ClaimInvoiceNumber |
|---|---|
| Documentation | Claim Invoice number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < ClaimNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ClaimNumber |
|---|---|
| Documentation | Identifier of claim entered by dealer More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Type (by restriction) < ClaimType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ClaimType |
|---|---|
| Documentation | Identifier of the type of claim 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:NMTOKEN < ConfirmType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ConfirmType |
|---|
| Code Value | Description |
|---|---|
| Always | |
| OnChange | |
| Never |
| 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 < 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 < Type (by restriction) < DeductibleType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DeductibleType |
|---|---|
| Documentation | The type of customer deductible. Eg: Service Contract More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < DeductibleWaiverInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DeductibleWaiverInd |
|---|---|
| Documentation | Indicates that the dealer waivered the deductible or changed the deductible from an amount greater than zero to zero. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Note (by restriction) < DispositionNotes (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DispositionNotes |
|---|---|
| Documentation | Notes regarding disposition of request More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < DispositionReasonCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DispositionReasonCode |
|---|---|
| Documentation | Substantiating reason for arriving at disposition More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Type (by restriction) < DispositionStatus (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DispositionStatus |
|---|---|
| Documentation | Disposition of request Ex: Rejected, Partial Payment, etc.) 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 < Expression (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Expression |
|---|
| Super-types: | xsd:string < ExpressionLanguage (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ExpressionLanguage |
|---|
| Super-types: | xsd:string < ReferenceNumber (by restriction) < ExternalReferenceNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ExternalReferenceNumber |
|---|---|
| Documentation | Secondary identifying scheme that is meaningful to claimant More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Indicator |
|---|---|
| Documentation | 0 = No, 1 = Yes More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < JobNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | JobNumber |
|---|---|
| Documentation | DMS assigned job or line identification number 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 < Note (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Note |
|---|---|
| Documentation | A free form note. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < OEMClaimNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OEMClaimNumber |
|---|---|
| Documentation | Assigned by OEM at time of claim processing More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < PaymentCycleEndDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PaymentCycleEndDate |
|---|---|
| Documentation | Ending date of Payment Cycle More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < PaymentNotes (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PaymentNotes |
|---|---|
| Documentation | Notes regarding payment More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < ProcessDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ProcessDate |
|---|---|
| Documentation | Effective date of process 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:date < Date (by restriction) < RepairOrderCompletedDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RepairOrderCompletedDate |
|---|---|
| Documentation | The date the last line was closed on the repair order More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < RepairOrderOpenedDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RepairOrderOpenedDate |
|---|---|
| Documentation | System date when Repair Order was opened 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:date < Date (by restriction) < SettlementDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SettlementDate |
|---|---|
| Documentation | Date that funds are transferred More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < SettlementType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SettlementType |
|---|---|
| Documentation | Method that was used for settlement transfer of funds More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| EFT | Electronic funds transfer. |
| Check | Indicates that a check will be used as the method of payment. |
| Parts Credit | Parts Credit |
| Other | Other |
| 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 < ReferenceNumber (by restriction) < SystemVersion (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SystemVersion |
|---|---|
| Documentation | The sender's software version number . More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < TaxabilityInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TaxabilityInd |
|---|---|
| Documentation | Determines whether an item or amount is taxable. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < TaxType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TaxType |
|---|---|
| Documentation | Tax Type More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Total | |
| Amount | |
| Labor | |
| Parts | |
| Claim | |
| Dealer | Dealer |
| Deductible | |
| Prorated | |
| Other | Other |
| Luxury | |
| Vehicle Inventory | |
| Taxes Not In Cash Price | |
| Document Stamp | |
| Sales | |
| Tire | |
| Personal Property | |
| Registration | |
| Monthly/Use | |
| Weight | |
| Adjustment | |
| DownPayment | |
| CapCostReduction | |
| Lieu | |
| CurrentYear | |
| N/A | Not Applicable |
| LocalOption | Tennessee Tax - combination of city and county. |
| SingleArticle | Tennessee Tax - State Tax |
| Gas | Gas tax levied to applicable vehicles or by state/province law. (Referred to in US as "Gas Guzzler" tax). |
| Total Monthly/Use | The total amount of monthly use tax for a payment on a contract. |
| Service Contract | Tax charged on service contracts (where applicable). |
| Adjusted Sales | Adjusted sales tax due to tax modifications when capitalized (i.e. NY) |
| Total Sales/Use | The total amount of sales/use tax for a single payment contract. |
| Air Conditioning Excise | Provincal tax providing for the installation or removal of freon. (Canada) |
| Purchase and Use | A type of tax that is assessed upon "tax free" tangible personal property purchased by a resident of the assessing state for use, storage or consumption of goods in that state (not for resale), regardless of where the purchase took place. The tax is a one time retail tax due at registration or titling of a vehicle. |
| County Tax | A county tax charged based on the location of the dealer and the customer. An example, The Cook County Tax. |
| General Excise | This is a general excise tax that a state or region could impose. |
| Gross Receipt | A gross receipts tax, sometimes referred to as a gross excise tax, is a tax on the total gross revenues of a company, regardless of their source. |
| Tax on Trade-In | Tax due on a trade-in vehicle. |
| Tax on Upfront Fees | Total tax due on fees paid upfront. |
| Tax on Acquisition Fee | Tax due on amount of acquisition fee. |
| Environmental Tax | Environmental Levy / Tax. |
| Motor Vehicle Tax | Tax paid at of registration based on the vehicle's age and MSRP. |
| Wheel Tax | A tax levied by cities and villages to be credited to a road fund of the city or village |
| Super-types: | xsd:string < TaxTypeId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TaxTypeId |
|---|---|
| Documentation | CS - City, CP - County, ST - State, OT - Other, EX - Excise, VAT - Value Added Tax, PST - Provincial Sales Tax , RT - Rental, GST - Goods and Services Tax, HST - Harmonized Tax, ART - Air Tax, QST - Quebec Sales Tax, IMP - Import Tax More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| CS | City |
| CP | County |
| ST | State |
| OT | "OT" = Other |
| EX | Excise |
| VAT | Value Added |
| PST | Provincial Sales Tax |
| RT | Rental |
| GST | Goods and Services Tax |
| HST | Harmonized Tax |
| ART | Air Tax |
| QST | Quebec Sales Tax |
| IMP | Import Tax |
| Super-types: | xsd:string < Text (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Text |
|---|---|
| Documentation | Indicates generic text type 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:anyURI < URI (by restriction) |
|---|---|
| Sub-types: | None |
| Name | URI |
|---|---|
| Documentation | URI More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < VIN (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VIN |
|---|---|
| Documentation | Federally defined 17 position vehicle identification number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < WarrantyNotes (by restriction) |
|---|---|
| Sub-types: | None |
| Name | WarrantyNotes |
|---|---|
| Documentation | Any Warranty related Notes More information at: http://www.starstandard.org. |
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Creator Name Code |
DCS software creator code |
100242 |
Application Area – Sender/CreatorNameCode |
|
2 |
Creator Software Code |
DCS software code name |
100244 |
Application Area – Sender/Component |
|
3 |
Interface Version |
Software release version |
100220 |
Application Area – Sender/SystemVersion |
|
4 |
Transaction Create Date |
Date the transaction was created |
100430 |
Application Area - CreationDateTime |
|
5 |
Transaction Create Time |
Time the transaction was created |
100440 |
Application Area - CreationDateTime |
|
6 |
Dealer Number |
Dealer code number |
100210 |
Application Area - Sender or Destination/DealerNumber |
|
7 |
Store Number |
Dealer code store number (DMS assigned) |
100240 |
Application Area - Sender or Destination/StoreNumber |
|
8 |
Area Number |
Dealer code area number (DMS vendor assigned) |
100200 |
Application Area - Sender or Destination/AreaNumber |
|
9 |
Destination Name Code |
Code for destination of file - Short Manufacturer or Short DSP code |
106190 |
Application Area – Destination/DestinationNameCode |
|
10 |
Destination Software |
For which software destination file is intended (May not be known) |
106200 |
Application Area – Destination/DestinationSoftware |
|
11 |
Transaction Type Code |
Transaction type code indicates action to be taken for all records in this transaction set (Will not be in the BODs. Will be handled by OAGI verb) |
106210 |
Not Needed in BOD - Transaction type is specified by OAGI XML verb |
|
12 |
Dealer Country |
Dealer country location |
108430 |
Application Area – Sender/DealerContry |
|
13 |
Reference ID |
Enables the sending application to indicate the instance identifier of the event or task that caused the transaction to be created. This is used to correlate a response transaction to an origination transaction |
112260 |
Application Area – Sender/ReferenceId |
|
14 |
SenderPartyId |
The Party Id field uniquely identifies the Sender of the message. This element can be used for parties within the Automotive Community as well as external parties. Party Id is not intended as a replacement for the Dealer Number. Suggested formats for OEMs or other large institutions include: DUNs Number, ShortMfgCode + DUNs, or ShortMfgCode. The suggested format for Dealers is: ShortMfgCode+Dealer Number. |
112261 |
Application Area – Sender/PartyId |
|
15 |
SenderLocationId |
The Location Id field uniquely identifies the location of the Sender of a message. This Id may be aligned with a physical address or data centers. This field provides an additional level of granularity beyond the usage of the Party Id for additional routing and deliver of data. |
11262 |
Application Area – Sender/LocationId |
|
16 |
SenderServiceId |
The Service Id field identifies the particular service to which a message is being sent from, e.g., an inventory service. |
11263 |
Application Area – Sender/ServiceId |
|
17 |
DestinationPartyId |
The Party Id field uniquely identifies the Receiver of the message. This element can be used for parties within the Automotive Community as well as external parties. Party Id is not intended as a replacement for the Dealer Number. Suggested formats for OEMs or other large institutions include: DUNs Number, ShortMfgCode + DUNs, or ShortMfgCode. The suggested format for Dealers is: ShortMfgCode+Dealer Number. |
11264 |
Application Area – Destination/PartyId |
|
18 |
DestinationLocationId |
The Location Id field uniquely identifies the location of the Receiver of a message. This Id may be aligned with a physical address or data centers. This field provides an additional level of granularity beyond the usage of the Party Id for additional routing and deliver of data. |
11265 |
Application Area – Destination/LocationId |
|
19 |
DestinationServiceId |
The Service Id field identifies the particular service to which a message is being sent to, e.g., an inventory service. |
11266 |
Application Area – Destination/ServiceId |
|
Header |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Claim Check Number |
Check number of claim payment |
110030 |
Header/DocumentId |
|
2 |
Claim Check Date |
Date that claim check was printed |
110040 |
Header/SettlementDate |
|
3 |
Payment Cycle Date |
Century, year, month and week of the month in which the payment was processed. (i.e., YYYYMMC) |
110190 |
Header/PaymentCycleEndDate |
|
4 |
Dealer Number, Secondary |
Identifies secondary dealer code if different than primary "Dealer Number" |
110200 |
Header/SecondaryDealerNumber |
|
5 |
Payment Cycle Number |
Identifies a Payment Cycle within a month. A given month can have 1 to many payment cycles. |
110670 |
Header/PaymentCycleId |
|
6 |
Emp ID Code |
Dealers' employee ID |
100250 |
Sender/AuthorizationId |
|
Payments |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Claim Invoice Number |
Invoice number that claim was paid from |
110050 |
Payments/ClaimInvoiceNumber |
|
2 |
Repair Order Number |
Identification number of repair order assigned by dealer or DMS |
105150 |
Payments - RepairOrder/DocumentId |
|
3 |
Claim Type |
Identifier of the type of claim - Claim type is usually 1 - 4 characters |
105030 |
Payments - WarrantyClaim/ClaimType |
|
4 |
Claim Number |
Identifier of claim |
105020 |
Payments - WarrantyClaim/ClaimNumber |
|
5 |
Repair Order VIN |
Manufacturer Vehicle identification number associated with repair order |
105525 |
Payments - RepairOrder/VIN |
|
6 |
Claim Process Date |
Date claim payment was processed |
110060 |
Payments/ProcessDate |
|
7 |
Claim Paid Amount |
Amount paid on claim, not necessarily the amount claimed |
110070 |
Payments/ToBePaidAmount |
|
8 |
Claim Gas Flag |
Determines whether the cost of gas is included in the request for reimbursement |
110080 |
Payments - WarrantyClaim/ClaimGasInd |
|
9 |
Claim Deductible Amount |
The Customer Deductible and/or Co/pay amount factored out of the total Claim Paid Amount |
110210 |
Payments - WarrantyClaim - WarrantyClaimDeductible/DeductibleAmount |
|
10 |
Claim Adjusted Flag |
Indicates that the final Claim Payment Amount was adjusted from the original claim submission amount during processing |
110220 |
Payments/AdjustedInd |
|
11 |
Claim Process Type |
Identifies the type of claim process. |
110680 |
N/A - process type defined by OAGI BOD verb |
|
Condition |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Claim Condition Number |
Relative sequence that Condition is within the overall Claim. Each condition is a separate type of repair or service within the |
110230 |
Job/JobNumber |
|
2 |
Claim Type |
Identifier of the type of claim - Claim type is usually 1 - 4 characters |
105030 |
Job/ClaimType |
|
3 |
Claim Condition Adjusted Flag |
Indicates that the final payment amount for the condition was adjusted from the original submission amount |
110240 |
Job/AdjustedInd |
|
4 |
Claim Condition Payment Total |
Total Payment amount approved for Condition |
110250 |
Job/ApprovedAmount |
|
5 |
Claim Condition Labor Total |
Labor portion of total approved amount for the Condition |
110260 |
Job/LaborAmount |
|
6 |
Claim Condition Parts Total |
Parts portion of total approved amount for the Condition |
110270 |
Job/PartsAmount |
|
7 |
Claim Condition Special Service Amount |
Special Services portion of total approved amount for the Condition |
110280 |
Job/OtherAmount |
|
8 |
Claim Condition Prorated Total |
Total condition payment amount after application of Customer pay Deductible and/or Co/pay amounts |
110290 |
Job/ProratedAmount |
|
9 |
Claim Condition Local Tax Amount |
Local Tax amount (if any) applied to approved amounts for the condition |
110300 |
Job - Tax/"Total" - use TaxTypeId for tax definition |
|
10 |
Claim Condition Federal Tax Amount |
Federal Tax amount (if any) applied to approved amounts for the condition |
110310 |
Job - Tax/"Total" - use TaxTypeId for tax definition |
|
Trailer |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Number of Records |
Number of detail records contained in this file |
110500 |
Not Applicable - Not used in XML BOD |
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Generated by StarSchemaGuidelineGenerator based on xs3p. Last modified: