SCS Validate Generate Contract API

Overview

The SCS Auto Platform provides a web service that allows external systems (Integration Partners) to validate without executing contract generate transactions electronically. Validating a transaction will verify all the business rules necessary to execute the transaction, without actually executing it and to specify what, if any, business rules are not met in the error/warning response. This will enable sending TPAs to know exactly what to fix such that these transactions can be resubmitted to be successfully processed.

This document addresses the method ‘ValidateGenerateContract’ which allows validation of the contract generate transactions without their execution.

SCS ValidateGenerateContract Specifications

Data Format

The following table represents the data formats used in the XML coding (Use to reference the “Format” column in the following XML schema tables)

Data type	Description	Example
X(10)	Characters of max length of 10	ABCDEABCDE
Date	yyyy-mm-dd	2000-12-21
DateTime	yyyy-mm-ddThh:mm:ss	2000-12-21T12:24:40
N(5)	Number,max length of 5	12345
N(8,2)	Number with two decimals, max length of 8.	123456.78
Boolean	Boolean true or false	true

Validations

1. All validations will be performed without executing the transaction.

2. The ValidateGenerateContract response when ‘Successful’ will include the request that can be used to subsequently execute the transaction.

3. Validations will be performed in the following order:

   1. Credential validation - The request needs to include valid TPA and userid/password information. If the request does not pass this stage of validation, then no data elements in the request will be validated against SCS Contract submission business logic.
   2. Seller validation - The seller needs to exist and be configured to utilize the web service. If the seller in the request does not meet both of these criteria, then no data elements in the request will be validated against SCS Contract submission business logic.
   3. Sale Authority validation - If the seller exists and is activated for the eContracting service, the plan will be determined using the Contract Sale Date, Plan Code and Vehicle Type. Rate Book is optional but will be validated if provided.
   4. ProgramName is optional but will be validated when provided and will be used to assist in returning a single plan from within the seller's sale authority for the specified sale date.
      • If the optional tags RateBook and ProgramName are not provided in the request and a single plan cannot be identified from what is within the seller’s sale authority for the specified sale date, then no further SCS contract submission business rules will be validated. The error message returned will be: 'A unique plan could not be identified since multiple plan codes for the same rate book and/or program are eligible for sale. Provide the Program and/or Ratebook to assist in the return of a single plan.'
      • The RateBook and ProgramName will be returned in a successful response within the request object.
   5. Rating validation - Once the sale authority has been validated, the contract will be rated. Rating validation will include any vin-based and mandatory surcharges configured for the plan. At this point, any options passed in will also be verified for eligibility and rating. Options will be matched based on the preference manager text configured for web services.
      • If the submitted Net Remit value, including options and surcharges, differs from the calculated Net Remit, for this condition only, the contract will successfully pass this validation with a warning message.
        • The ValidateGenerateContract response object will return a ResponseCode = 2, indicating that it passed successfully with a warning and it will include the Request object for the validated contract.
        • The Request object will contain the SCS calculated contract Net Remit value, and individual option/surcharge NetCost values if present in the request.
      • If the plan has regulated retail rate rules, the Retail as submitted must fall within the configured parameters or the request will fail validation with the appropriate error messages.
   6. Contract Information validation - Contract information that has no impact on rating will be validated last. This group contains data elements like required customer information, contract number, lienholder information, AdditionalContractInfo (if product defined). At this time, the existence of contracts with the same plan code, contract number and sale date will be checked to prevent duplicate contracts from being submitted.
   7. When the ValidateGenerateContract response is ‘Successful’, SCS will include in the response object a request for the contract that was validated. This request can be used to submit the contract in to SCS. The fields not provided in the ValidateGenerateContract request which are necessary for the contract to be submitted will be included in this request. This missing but necessary data includes SCS IDs such as Quote Id, Term Id, Deductible Id, and FinalCopy.
   8. Actions that require Underwriting Supervisor permission will not be performed by any of the webservice methods.

Validate Generate Contract

Request Schema

ValidateGenerateContractRequest

Tag	Format	Req/ Opt/ Cond	Attributes	Valid values	Description
TpaCode	X(4)	R			Third Party Administrator Code
UserId	X(30)	R			User ID issued to the requesting system
Password	X(255)	R			Password issued to the requesting system
ContractNumber	X(20)	C			Contract Number, if not provided SCS will generate one
DealerNumber	X(18)	R			Dealer Number
ContractFormNumber	X(60)	R			This is the PDFFormNo from the eContracting response
RegisterNumber	X(10)	O			Register Number
InserviceDate	Date	C			Inservice Date. Required if the vehicle type is NEW and product type is not GAP.
SaleDate	Date	R			Sale Date
VehiclePurchaseDate	Date	C			Required for some Non-GAP product types including EWT.
SaleOdometer	N(7)	O			Sale Odometer
ManuWarrTerm	N(3)	O
ManuWarrMiles	N(7)	O
AdditionalBaseWarran tyTerm	N(3)	O			Additional Base Warranty Term (Months)
AdditionalBaseWarran tyMiles	N(7)	O			Additional Base Warranty Miles
AdditionalPowertrainW arrantyTerm	N(3)	O			Additional Powertrain Warranty Term (Months)
AdditionalPowertrain WarrantyMiles	N(7)	O			Additional Powertrain Warranty Miles
VehiclePurchasePrice	N(8,2)	C			Required for some GAP plans.
QuoteID	N(15)	O	nillable		Quote ID
PlanCode	X(2)	R			Plan Code
RateBook	N(15)	C	nillable		Rate Book
GenerateContractDoc ument	Boolean	O		true, false	true = PDF will be generated and returned in Contract response
FinalCopy	Boolean	O		true, false
NetCost	N(8,2)	R			The amount due to the provider for the contract (aka Remit Amount). This value should be the sum of net rate for the selected plan plus the net cost for each of the selected options and surcharges.
RetailCost	N(8,2)	R			The price charged to the customer for the contract. Any value sent will be validated against the plan’s Retail Rules
BaseMarkup	N(8,2)	O			Base markup. If base markup is specified, then RetailCost must equal NetCost + BaseMarkup + FIMarkup
FIMarkup	N(8,2)	O			F&I Markup. If F&I markup is specified, then RetailCost must equal NetCost + BaseMarkup + FIMarkup
FinanceType	X(4)	C		BALL LEAS LOAN CASH	Required for some GAP product contracts. Values are BALL (balloon), LEAS (lease), LOAN (loan) and CASH.
FinancedAmount	N(8,2)	C			Required for GAP product contracts
FinanceApr	N(2,2)	C			Required for GAP product contracts
FinanceTerm	N(3)	C			Required for GAP product contracts
Msrp	N(8,2)	C			Required for some GAP contracts
MonthlyPayment	N(8,2)	C			Required for some GAP contracts
FirstPaymentDate	Date	C			Required for some GAP contracts
BalloonAmount	N(8,2)	O			Balloon Amount GAP contract supplemental Loan/Lease information.
ResidualValue	N(8,2)	O			Residual Value GAP contract supplemental Loan/Lease information.
BaseACV	N(8,2)	O			Base ACV is the retail price of the car minus all the options (e.g. roof rack, floor mats, etc.)
NADAValue	N(8,2)	O			GAP contract supplemental Loan/Lease information.
InsuranceDeductible	N(5,2)	O			GAP contract supplemental Loan/Lease information.
SalesPersonFname	X(30)	O			Salesperson First Name The First Name of the F&I Mgr/Seller employee who sold the contract.
SalesPersonLname	X(30)	O			Salesperson Last Name The Last Name of the F&I Mgr/Seller employee who sold the contract.
StockNumber	X(30)	O			Stock Number **10/2015 - Added in Release 8.14.2
TermMile		R	TermMile		Term Mile object
Deductible		C	Deductible		Deductible object
Vehicle		R	Vehicle		Vehicle Information object
Customer		R	Customer		Customer object
LienHolder		O	LienHolder		Lienholder object
ContractOptions		O	ContractOption s		Contract Options object
AdditionalContractInfo		C	AdditionalContr actInfo		Additional Contract Info object Contains member ID Label and value. Required for some products.
ContractPDF		O			Base-64 encoded string that is a digital representation of the filled-out contract in PDF format.
DigitallySigned	Boolean	O		true, false	Whether the contract is digitally signed or not
IsTaxExempt	Boolean	R		true false (default )	Indicates if the customer is tax exempt.
ProgramName	X(100)	O			ProgramName is optional but will be validated when provided and will be used to assist in returning a single plan from within the seller's sale authority for the Description specified sale date. ProgramName will be matched to the Preference Manager text configured for web services. The match will be made first with the Preference Manager Display Text and if none is found the match is made with the Preference Manager Program Name.
Stock Number	X(30)	O
DealNumber	X(15)	O			DMS deal number
RecipientId	X(20)	O

TermMile Object

Tag	Format	Req/ Opt/ Cond	Attributes	Valid values	Description
Term	N(3)	R			Term in months
Mileage	N(6)	C			Mileage Required for non-GAP product

Deductible Object

Tag	Format	Req/ Opt/ Cond	Attributes	Valid Values	Description
DeductAmt	N(5,2)	C		Max value is 1000	Deductible amount
DeductType	X(10)	C		Disp, Reducing, Standard, Percent, Component	Deductible type SCS-6518 Required for non-GAP product Match is based on the deduct type code configured in deduct type table.
ReducedAmount	N(5,2)	C			Reduced Amount. Required if DeductType = “Reducing”

Vehicle Object

Tag	Format	Req/ Opt/ Cond	Attributes	Valid Values	Description
VinNumber	X(17)	R			VIN is always required.
VehicleType	X(1)	R		N U	Vehicle Type New or Used. Value will be used to determine plan and rates. Required for non-GAP products.
Year	N(4)	O
Make	X(25)	O
Model	X(25)	O
Cyl	X(2)	O
Drv	X(2)	O
Fuel	X(2)	O
AspirationCode	X(2)	O
SegmentationCode	X(2)	O
TonRating	X(4)	O
GVWR	X(2)	O
AssetType	X(25)	O
Trim	X(100)	O
EngineSize	N(7)	O
EngineSizeUnit	X(3)	O		CC CID
CompleteVehicle	Boolea n	O		True False
Ownership	X(1)	C		‘N’ – New ‘P’ – Pre-Owned	Ownership of the vehicle

Customer Object

Tag	Format	Req/ Opt/ Cond	Attributes	Valid values	Description
Title	X(20)	O
FirstName	X(30)	O
LastName	X(60)	R
MiddleInitial	X(30)	O
Email	X(100)	O			**10/2015 – Increased from 30 to 100 characters in Release 8.14.2
Address		R	Address		Address object
AlternateContact	X(60)	O			Co-Buyer name

Address Object

Tag	Format	Req/ Opt/ Cond	Attributes	Valid values	Description
Address1	X(30)	R
Address2	X(30)	O
City	X(20)	R
State	X(2)	R
ZipCode	X(10)	R
HomePhone	X(10)	O
HomePhoneExt	X(4)	O
WorkPhone	X(10)	O
WorkPhoneExt	X(4)	O

LienHolder Object

Tag	Format	Req/ Opt/ Cond	Attributes	Valid values	Description
Name	X(60)	O			Lienholder name
Address1	X(30)	O			Lienholder address1
Address2	X(30)	O			Lienholder address2
State	X(2)	O			Lienholder state
Phone	X(10)	O			Lienholder phone
City	X(30)	O			Lienholder city
ZipCode	X(10)	O			Lienholder zip code
Number	X(18)	O			Lienholder number

ContractOptions Object

Tag	Format	Req/ Opt/ Cond	Attributes	Valid values	Description
ContractOptionValidate ValidateGenerateContract					Grouping tag used to allow specifying more than one contract option in a single request. ContractOptionValidate is the grouping tag for ValidateGenerateContract request.
Id	N(15)	C	nillable		The unique identifier of the Option ID in SCS. Required for the GenerateContract request when the contract includes options or surcharges. Option Description will be ignored if this value is provided Value from eContracting response that identifies the Id to be used to produce the contract.
Description	X(60)	C			Option Description within the Option group for the plan/term/deductible combination that must be added. Option will be matched based on the preference manager text configured for web services.
IsSurcharge	Boolean	C		true false	Value from rating engine response (IsSurcharge). Required if contract includes options or surcharges.
NetCost	N(8,2)	C			Value from rating engine response (NetRate). Required if contract includes options or surcharges.

AdditionalContractInfo Object

Tag	Format	Req/ Opt/ Cond	Attributes	Valid values	Description
FieldLabel	X(50)	C			FieldLabel value from eContracting response to be used to produce the contract.
FieldValue	X(50)	C			‘Member ID’ Value

Sample SOAP Request

<soap:Envelope> 
    <soap:Body>
        <ValidateGenerateContract>
            <validateContract>
                <UserId>?</UserId>
                <Password>?</Password>
                <TpaCode>?</TpaCode>
                <AdditionalContractInfo>
                    <FieldOrder>int</FieldOrder>
                    <FieldLabel>string</FieldLabel>
                    <FieldValue>string</FieldValue>
                    <FieldType>string</FieldType>
                    <Length>int</Length>
                    <Required>boolean</Required>
                    <Unique>boolean</Unique>
                </AdditionalContractInfo>
                <ContractOptions>
                    <ContractOptionValidate>
                        <Id>int</Id>
                        <Description>string</Description>
                        <IsSurcharge>boolean</IsSurcharge>
                        <NetCost>decimal</NetCost>
                    </ContractOptionValidate>
                    <ContractOptionValidate>
                        <Id>int</Id>
                        <Description>string</Description>
                        <IsSurcharge>boolean</IsSurcharge>
                        <NetCost>decimal</NetCost>
                    </ContractOptionValidate>
                </ContractOptions>
                <Customer>
                    <Title>string</Title>
                    <FirstName>string</FirstName>
                    <LastName>string</LastName>
                    <MiddleInitial>string</MiddleInitial>
                    <Email>string</Email>
                    <Address>
                        <Address1>string</Address1>
                        <Address2>string</Address2>
                        <City>string</City>
                        <State>string</State>
                        <ZipCode>string</ZipCode>
                        <HomePhone>string</HomePhone>
                        <HomePhoneExt>string</HomePhoneExt>
                        <WorkPhone>string</WorkPhone>
                        <WorkPhoneExt>string</WorkPhoneExt>
                    </Address>
                    <AlternateContact>string</AlternateContact>
                </Customer>
                <Deductible>
                    <DeductTypeDescriptions>
                        <GlobalInformation xsi:nil="true" />
                        <GlobalInformation xsi:nil="true" />
                    </DeductTypeDescriptions>
                    <DeductAmt>decimal</DeductAmt>
                    <DeductType>string</DeductType>
                    <ReducedAmount>decimal</ReducedAmount>
                </Deductible>
                <LienHolder>
                    <State>string</State>
                    <Phone>string</Phone>
                    <City>string</City>
                    <ZipCode>string</ZipCode>
                    <Name>string</Name>
                    <Address1>string</Address1>
                    <Address2>string</Address2>
                    <Number>string</Number>
                </LienHolder>
                <TermMile>
                    <Term>int</Term>
                    <Mileage>int</Mileage>
                </TermMile>
                <Vehicle>
                    <Cyl>string</Cyl>
                    <Fuel>string</Fuel>
                    <Model>string</Model>
                    <Drv>string</Drv>
                    <VinNumber>string</VinNumber>
                    <Make>string</Make>
                    <Year>int</Year>
                    <VehicleType>string</VehicleType>
                    <AspirationCode>string</AspirationCode>
                    <SegmentationCode>string</SegmentationCode>
                    <TonRating>string</TonRating>
                    <GVWR>string</GVWR>
                    <Trim>string</Trim>
                    <AssetType>string</AssetType>
                    <EngineSize>decimal</EngineSize>
                    <EngineSizeUnit>string</EngineSizeUnit>
                    <Ownership>string</Ownership>
                    <BodyStyle>string</BodyStyle>
                    <CompleteVehicle>string</CompleteVehicle>
                </Vehicle>
                <ContractNumber>string</ContractNumber>
                <ContractFormNumber>string</ContractFormNumber>
                <RegisterNumber>string</RegisterNumber>
                <DealerNumber>string</DealerNumber>
                <InserviceDate>dateTime</InserviceDate>
                <SaleDate>dateTime</SaleDate>
                <VehiclePurchaseDate>dateTime</VehiclePurchaseDate>
                <SaleOdometer>int</SaleOdometer>
                <ManufWarrTerm>int</ManufWarrTerm>
                <ManufWarrMiles>int</ManufWarrMiles>
                <AdditionalBaseWarrantyTerm>int</AdditionalBaseWarrantyTerm>
                <AdditionalBaseWarrantyMiles>int</AdditionalBaseWarrantyMiles>
                <AdditionalPowertrainWarrantyTerm>int</AdditionalPowertrainWarrantyTerm>
                <AdditionalPowertrainWarrantyMiles>int</AdditionalPowertrainWarrantyMiles>
                <VehiclePurchasePrice>decimal</VehiclePurchasePrice>
                <PlanCode>string</PlanCode>
                <RateBook>int</RateBook>
                <FinalCopy>boolean</FinalCopy>
                <RetailCost>decimal</RetailCost>
                <NetCost>decimal</NetCost>
                <FinanceType>string</FinanceType>
                <FinancedAmount>decimal</FinancedAmount>
                <FinanceApr>decimal</FinanceApr>
                <FinanceTerm>int</FinanceTerm>
                <Msrp>decimal</Msrp>
                <MonthlyPayment>decimal</MonthlyPayment>
                <FirstPaymentDate>dateTime</FirstPaymentDate>
                <BalloonAmount>decimal</BalloonAmount>
                <ResidualValue>decimal</ResidualValue>
                <BaseACV>decimal</BaseACV>
                <NADAValue>decimal</NADAValue>
                <InsuranceDeductible>decimal</InsuranceDeductible>
                <SalesPersonFname>string</SalesPersonFname>
                <SalesPersonLname>string</SalesPersonLname>
                <ContractPDF>string</ContractPDF>
                <DigitallySigned>boolean</DigitallySigned>
                <QuoteId>int</QuoteId>
                <GenerateContractDocument>boolean</GenerateContractDocument>
                <IsTaxExempt>boolean</IsTaxExempt>
                <BaseMarkup>decimal</BaseMarkup>
                <FIMarkup>decimal</FIMarkup>
                <ProgramName>string</ProgramName>
                <StockNumber>string</StockNumber>
                <DealNumber>string</DealNumber>
                <RecipientId>string</RecipientId>
            </validateContract>
        </ValidateGenerateContract>
    </soap:Body>
</soap:Envelope>

ValidateGenerateContract Response Schema Details

1. The ValidateGenerateContract request schema will be similar to the existing GenerateContract schema with exceptions noted in columns: Validate and Generate.

2. The tag FinalCopy will not be included in the ValidateGenerateContract schema but on successful validation this tag will be included with a value ‘true’ in the GenerateContractRequest.

3. The TermId tag and the DeductId tag will not be included in the ValidateGenerateContract schema but on successful validation these tags and their values will be required and included in the corresponding TermMile Object and Deductible Object of the GenerateContractRequest

   • TermId N(15) Required
   • DeductId N(15) Required

ValidateGenerateContractResponse Object

Tag	Content Items	Format	Description
ValidateGenerateContr actResponse
	ValidateGenerateContract Result
	Response Code		2 = Successful, passed with a warning. 1 = Successful. 0 = Failed. Error returned. See Message Object for Type
	ContractDocument		Contract Document
	ContractNumber	N(12)
	EffectiveDate	Date
	EffectiveOdometer	N(7)
	ExpirationDate	Date
	ExpirationOdometer	N(7)
	Tax (node)		**10/2015 – Added in Release 8.14.1 Tax object included in response only if taxes are configured.
	NetTaxAmt1	N(8,2)
	NetTaxAmt2	N(8,2)
	RetailTaxAmt1	N(8,2)
	RetailTaxAmt2	N(8,2)
	TotalRetailTaxAmt	N(8,2)
	Tax1TaxLabel	X(50)
	Tax2TaxLabel	X(50)
	Messages	Message Object	Collection of Messages.
	eContracting	GenerateContractRequest Object	The response schema for ValidateGenerateContract when successful will include the request that can be used to subsequently execute the transaction. The request will include required tags FinalCopy=true, the TermId and DeductId tags and their values.

Message Object

Tag	Format	Req/ Opt/ Cond	Valid values	Description
Type	Integer	R	1. – Error 2. – Info 3. – Warning 4. - Success	Message Type
Code	String X(30)	R		Returns the associated code with each message text.
Text	String X(2000)	R		Message Text

Sample SOAP Response

<soap:Envelope>
    <soap:Body>
        <ValidateGenerateContractResponse>
            <ValidateGenerateContractResult>
                <contract>
                    <ContractOptions>
                        <ContractOption xsi:nil="true" />
                        <ContractOption xsi:nil="true" />
                    </ContractOptions>
                    <Deductible>
                        <DeductTypeDescriptions xsi:nil="true" />
                        <DeductId>int</DeductId>
                        <DeductAmt>decimal</DeductAmt>
                        <DeductType>string</DeductType>
                        <ReducedAmount>decimal</ReducedAmount>
                    </Deductible>
                    <TermMile>
                        <TermId>int</TermId>
                        <Term>int</Term>
                        <Mileage>int</Mileage>
                    </TermMile>
                    <LienHolder>
                        <State>string</State>
                        <Phone>string</Phone>
                        <City>string</City>
                        <ZipCode>string</ZipCode>
                        <Name>string</Name>
                        <Address1>string</Address1>
                        <Address2>string</Address2>
                        <Number>string</Number>
                    </LienHolder>
                    <Vehicle>
                        <Cyl>string</Cyl>
                        <Fuel>string</Fuel>
                        <Model>string</Model>
                        <Drv>string</Drv>
                        <VinNumber>string</VinNumber>
                        <Make>string</Make>
                        <Year>int</Year>
                        <VehicleType>string</VehicleType>
                        <AspirationCode>string</AspirationCode>
                        <SegmentationCode>string</SegmentationCode>
                        <TonRating>string</TonRating>
                        <GVWR>string</GVWR>
                        <Trim>string</Trim>
                        <AssetType>string</AssetType>
                        <EngineSize>decimal</EngineSize>
                        <EngineSizeUnit>string</EngineSizeUnit>
                        <Ownership>string</Ownership>
                        <BodyStyle>string</BodyStyle>
                        <CompleteVehicle>string</CompleteVehicle>
                    </Vehicle>
                    <Customer>
                        <Title>string</Title>
                        <FirstName>string</FirstName>
                        <LastName>string</LastName>
                        <MiddleInitial>string</MiddleInitial>
                        <Email>string</Email>
                        <Address xsi:nil="true" />
                        <AlternateContact>string</AlternateContact>
                    </Customer>
                    <AdditionalContractInfo>
                        <FieldLabel>string</FieldLabel>
                        <FieldValue>string</FieldValue>
                    </AdditionalContractInfo>
                    <TaxInfoRequest>
                        <NetTaxAmt1>decimal</NetTaxAmt1>
                        <NetTaxAmt2>decimal</NetTaxAmt2>
                        <RetailTaxAmt1>decimal</RetailTaxAmt1>
                        <RetailTaxAmt2>decimal</RetailTaxAmt2>
                    </TaxInfoRequest>
                    <ContractNumber>string</ContractNumber>
                    <ContractFormNumber>string</ContractFormNumber>
                    <RegisterNumber>string</RegisterNumber>
                    <DealerNumber>string</DealerNumber>
                    <InserviceDate>dateTime</InserviceDate>
                    <SaleDate>dateTime</SaleDate>
                    <VehiclePurchaseDate>dateTime</VehiclePurchaseDate>
                    <SaleOdometer>int</SaleOdometer>
                    <ManufWarrTerm>int</ManufWarrTerm>
                    <ManufWarrMiles>int</ManufWarrMiles>
                    <PowertrainWarrTerm>int</PowertrainWarrTerm>
                    <PowertrainWarrMiles>int</PowertrainWarrMiles>
                    <AdditionalBaseWarrantyTerm>int</AdditionalBaseWarrantyTerm>
                    <AdditionalBaseWarrantyMiles>int</AdditionalBaseWarrantyMiles>
                                <AdditionalPowertrainWarrantyTerm>int</AdditionalPowertrainWarrantyTerm>
                <AdditionalPowertrainWarrantyMiles>int</AdditionalPowertrainWarrantyMiles>
                    <TotalBaseWarrantyTerm>int</TotalBaseWarrantyTerm>
                    <TotalBaseWarrantyMiles>int</TotalBaseWarrantyMiles>
                    <TotalPowertrainWarrantyTerm>int</TotalPowertrainWarrantyTerm>
                    <TotalPowertrainWarrantyMiles>int</TotalPowertrainWarrantyMiles>
                    <VehiclePurchasePrice>decimal</VehiclePurchasePrice>
                    <PlanCode>string</PlanCode>
                    <RateBook>int</RateBook>
                    <FinalCopy>boolean</FinalCopy>
                    <RetailCost>decimal</RetailCost>
                    <NetCost>decimal</NetCost>
                    <FinanceType>string</FinanceType>
                    <FinancedAmount>decimal</FinancedAmount>
                    <FinanceApr>decimal</FinanceApr>
                    <FinanceTerm>int</FinanceTerm>
                    <Msrp>decimal</Msrp>
                    <MonthlyPayment>decimal</MonthlyPayment>
                    <FirstPaymentDate>dateTime</FirstPaymentDate>
                    <BalloonAmount>decimal</BalloonAmount>
                    <ResidualValue>decimal</ResidualValue>
                    <BaseACV>decimal</BaseACV>
                    <NADAValue>decimal</NADAValue>
                    <InsuranceDeductible>decimal</InsuranceDeductible>
                    <SalesPersonFname>string</SalesPersonFname>
                    <SalesPersonLname>string</SalesPersonLname>
                    <ContractPDF>string</ContractPDF>
                    <DigitallySigned>boolean</DigitallySigned>
                    <QuoteId>int</QuoteId>
                    <GenerateContractDocument>boolean</GenerateContractDocument>
                    <IsTaxExempt>boolean</IsTaxExempt>
                    <BaseMarkup>decimal</BaseMarkup>
                    <FIMarkup>decimal</FIMarkup>
                    <ProgramName>string</ProgramName>
                    <StockNumber>string</StockNumber>
                    <DealNumber>string</DealNumber>
                    <RecipientId>string</RecipientId>
                </contract>
                <ContractDocument>string</ContractDocument>
                <EffectiveDate>dateTime</EffectiveDate>
                <EffectiveOdometer>int</EffectiveOdometer>
                <ExpirationDate>dateTime</ExpirationDate>
                <ExpirationOdometer>int</ExpirationOdometer>
            </ValidateGenerateContractResult>
        </ValidateGenerateContractResponse>
    </soap:Body>
</soap:Envelope>

Error Messages

Message Type	Error code	Message Text
		Includes error messages from
Error	rfvTPACode	TPA Code is required.
Error	VD0003	TPA is invalid.
Error	ERRSESSION	Unable to create session.
Error	WSLICEN001	License not available.
Error	VD0009	Authentication Failed.
Error	WSSECUR001	You do not have necessary permission to execute this web method.
Error	ERRINREQ	Error in request.
Error	NOQUOTEFND	Invalid Quote ID.
Error	QUOTEEXP	Quote ID {0} has expired as of {1}.
Error	IMP_CNTR_0023	Seller not enabled for contracting.
Error	DLRNOTEXIST	Dealer does not exist.
Error	IMP_CNTR_0074	Either seller does not have sale authority for the plan, or that the plan is ineligible due to plan configuration (date and state intervals).
Error	PHONEINVALID	Invalid Phone number.
Error	rfvCustLastName	Customer Last Name is required.
Error	rfvCustAddress	Customer Address is required.
Error	rfvCustCity	Customer City is required.
Error	rfvCustState	Customer State is required.
Error	rfvCustZipCode	Customer Zip Code is required.
Error	INVCUSTSTA	Invalid Customer state code.
Error	CNTR_SRVC_0003	Watermark file name is not provided.
Error	IMP_CNTR_0058	Invalid form directory path.
Error	CNTR_SRVC_0001	Error finding forms directory.
Error	DEALER_NOT_ACTIVE_SALEDATE	The seller account is not active for this sale date.
Error	NO_SALE_AUTHORITY	Seller does not have Sale Authority for this product as of {0}
Error	PROGRAM_INVALID	Program is Invalid
Error	VEHTYPREQD	Vehicle Type is required.
Error	VEHTYPINVD	Invalid Vehicle Type.
Error	IMP_CNTR_0030	Plan information is invalid.
Error	IMP_CNTR_0079	A unique plan could not be identified since multiple plan codes for the same rate book and/or program are eligible for sale. Provide the Program and/or Rate book to assist in the return of a single plan
Error	rfvInServiceDate	In Service Date is required.
Error	INVALID_DEAL_TYPE	Deal Type is invalid. This error applies to GAP contracts
Error	INVALID_FINANCE_AMT	Finance Amount is invalid. This error applies to GAP contracts
Error	INVALID_FINANCE_APR	Finance APR is invalid. This error applies to GAP contracts when eligibility is based on APR
Error	INVALID_FINANCE_TERM	Finance Term is invalid. This error applies to GAP contracts
Error	INVALID_MSRP	MSRP is invalid. This error applies to GAP contracts when eligibility is based on MSRP
Error	INVALID_MONTHLYPAY	Monthly payment is invalid.
Error	INVALID_FIRST_PAYMENT_DATE	First Payment Date must be greater than or equal to Sale Date.
Error	INVALID_BALLOON_AMT	Balloon amount is invalid.
Error	INVALID_RESIDUAL_AMT	Residual amount is invalid.
Error	INVALID_BASE_ACV	Base ACV is invalid.
Error	INVALID_NADA_VALUE	NADA Value is invalid.
Error	INVALID_INS_DEDUCT	Insurance deductible is invalid.
Error	IMP_CNTR_0015	Duplicate contract number.
Error	IMP_CNTR_0051	Contract already exists having the same “Sale Date, Plan Code, VIN”
Warning	IMP_CNTR_0052	Contract already exists having the same “Plan Code, VIN”
Warning	IMP_CNTR_0053	VIN is already in use by another contract.
Error	IMP_CNTR_0047	Sale odometer cannot be over {0} if Sale date and In Service Date are the same.
Error	INVALID_SALE_ODOM	Invalid Sale Odometer.
Error	IMP_CNTR_0031	Insurance Carrier information is invalid.
Error	IMP_CNTR_0032	Lien holder information is invalid.
Error	IMP_CNTR_0063	Invalid Lienholder state code.
Error	IMP_CNTR_0064	Invalid Lienholder zipcode.
Error	IMP_CNTR_0065	Invalid Lienholder phone number.
Error	IMP_CNTR_0033	Term and Mileage information is invalid.
Error	DEDUCT_INVALID	The deductible is invalid.
Error	VIN_NOT_ENTER	VIN is not entered.
Error	VEHICLEINFOMISG	Vehicle information is missing or not valid.
Warning	IMP_CNTR_0068	VIN could not be decoded.
Error	IMP_CNTR_0046	This vehicle is not eligible based on the sale odometer, model year and/or manufacturer warranty information supplied.
Error	RetailMarkupCompute	The contract is not eligible because the Retail Cost must equal Net Cost plus Base Markup and F&I Markup.
Error	IMP_CNTR_0020	Error Creating the Register.
Error	IMP_CNTR_0017	Invalid Register Number. The register is used by another seller.
Error	SALEODOM_EXCEED_MILE	The sale odometer exceeds the odometer eligibility mileage.
Error	EXPDATE_LT_SALEDATE_ECONTR	The contract cannot be created because the expiration date {1} is earlier than the sale date {2}.
Error	IMP_CNTR_0040	Incorrect Contract Form Number. Form# {0} must be used.
Error	IMP_CNTR_0056	Invalid watermark file path.
Error	IMP_CNTR_0055	Contract form not found.
Error	IMP_CNTR_0057	Form File handling error.
Error	IMP_CNTR_0058	Invalid form directory path.
Error	IMP_CNTR_0036	The submitted option (Id: Description: ) does not match the surcharge tag value.
Error	IMP_CNTR_0001	Submitted Option Cost ({0}) is different from Rate Option Cost ({1}) for Option {2}.
Error	IMP_CNTR_0038	Option {0} is a surcharge and is not selected.
Error	IMP_CNTR_0039	Option {0} is invalid.
Error	IMP_CNTR_0024	Submitted Total Contract Cost ({0:c}) is different from Rated Total Contract Cost({1:c}).
Error	rfvFinanceAmount	Financed Amount is required.
Error	IMP_CNTR_0076	{0} Retail must be {1:c} based on plan eligibility rules.
Error	IMP_CNTR_0048	Retail Price must be between {0:c} and {1:c} based on plan eligibility rules.
Error	IMP_CNTR_0077	Retail must be less than or equal to {0:c} based on eligibility rules.
Error	IMP_CNTR_0078	Retail must be greater than or equal to {0:c} based on eligibility rules.
Error	RETAIL_RATE_DISCOUNTED	Retail Price must be less than or equal to {0:c}.
Error	IMP_CNTR_0049	Retail Price must be {0:c} based on plan eligibility rules.
Error	SALEDATE_EXCEED_MIN	Sale Date cannot be less than {0}.
Error	SALEDATE_EXCEED	Sale Date exceeds future Sale Date limit.
Error	rfvSaleDate	Sale Date is required.
Error	VPDTGTTODAY2	Vehicle Purchase Date cannot be greater than today's date.
Error	EFFDATE_GT_EXPDATE	Effective Date cannot be greater than or equal to Expiration Date.
Error	EFFODOM_GT_EXPODOM	Effective Odometer is greater than the Expiration Odometer based on plan eligibility rules. Contract cannot be saved.
Error	SALEODOM_LT_EXPODOM	Sale Odometer must be less than Expiration Odometer.
Error	EMAILVALID	Email not in correct format.
Error	revZipCode	Invalid Zip/Postal Code.
Error	FIMgrReqOnContract	Please select F&I Manager, it is required to issue a commission payment.
Error	rfvTemplate	{0} is required. This error is returned if the Additional Contract field value is required.
Error	AdditionalInfoLength	Invalid {0}. {0} must be {1} characters. This error is returned if the Additional Contract field value does not meet the length requirement.
Error	AdditionalInfoUnique	Value entered for {0} is not unique. Please enter a different value. This error is returned if the Additional Contract field value is not unique.
Error	STOCK_NUMBER_TOO_LONG	Stock Number must be 30 characters or less.
Error	ERATING_TRIMREQ	There are more rates available which require specification of a Trim value. The VIN’s available Trims are [Trim1], [Trim2], … and [Trim5]. Please resubmit the rating request with the Trim specified.
Error		Trim is required.
Error	INVALIDTRIM	Trim is invalid for VIN. The VIN’s available Trims are [Trim1], [Trim2], … and [Trim5].
Error		Asset Type is required.
Error	INVDADDLBASEWARR	Additional Base Warranty is invalid, both Term and Mileage must be provided.
Error	ADDLBASETERMMILEREQD	Additional Base Warranty term and mileage specified are not valid for use as an Additional Base Warranty.
Error	INVDADDLPWRWARR	Additional Powertrain Warranty is invalid, both Term and Mileage must be provided.
Error	ADDLPWRTERMMILEREQD	Additional Powertrain Warranty term and mileage specified are not valid for use as an Additional Powertrain Warranty.
Error	INVALID_Ownership	Ownership Condition is invalid
Error	INCORRECT_Ownership	Ownership is invalid for the Sale Date and VIN/Sale Odometer combination.
Error	INVALID_NADA	NADA is invalid. (This error applies to GAP contracts when eligibility is based on NADA)
Error	INVALID_RECIPIENT_ID	Recipient Id is Invalid
Error	revInServiceDate	Mfg. Warranty Start Date is not within a year of the vehicle model year (e.g. for a 2013 vehicle, the manufacturer warranty start date must be between 1/1/2012 and 12/31/2014)
Error	CNNFOUND	Contract Number not set
Error	CISNOTSET	Insured State not set
Error	CEDNOTSET	Contract Entry date not set

ValidateReRate Error Messages

Message Type	Error code	Message Text
Error	CNTOPTSINVLD	Not all contract options are valid.
Error	DEALER_NOT_ACTIVE_SALEDATE	The seller account is not active for this sale date.
Error	DEALER_SALE_AUTHORITY	The seller has no sale authority for this period.
Error	rfvProgram	Program is required.
Error/Warning	PROGRAM_INVALID	Program is invalid. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error	rfvPlan	Plan is required.
Error/Warning	PLAN_INVALID	Plan is invalid. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error	rfvTerm	Term is required.
Error	TERM_INVALID	Term is invalid.
Error	rfvDeduct	Deductible is required.
Error	DEDUCT_INVALID	The deductible is invalid.
Error	INSVDTGTSLDT	In Service Date cannot be greater than sale date.
Error	INSERVICE_GT_DATE	In Service Date cannot be greater than {0}.
Error	INSERVICE_LT_YEAR	In Service Date cannot be less than year {0}.
Error	rfvInServiceDate	In Service Date is required.
Error	VPDTGTSLDT	Vehicle Purchase Date cannot be greater than sale date.
Error	VPDTGTTODAY	Vehicle Purchase Date cannot be greater than {0}.
Error	rfvVehiclePurchaseDate	Vehicle Purchase Date is required.
Error/Warning	OLAPCNTRR	Only pending or active contract can be rated. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error/Warning	VEHICLEINFOMISG	Vehicle Information is missing or not valid. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error	ERATING_TRIMREQ	There are more rates available which require specification of a Trim value. The VIN’s available Trims are [Trim1], [Trim2], … and [Trim5]. Please resubmit the rating request with the Trim specified.
Error		Trim is required.
Error	INVALIDTRIM	Trim is invalid for VIN. The VIN’s available Trims are [Trim1], [Trim2], … and [Trim5].
Error		Asset Type is required.
Error	INVDADDLBASEWARR	Additional Base Warranty is invalid, both Term and Mileage must be provided.
Error	ADDLBASETERMMILEREQD	Additional Base Warranty term and mileage specified are not valid for use as an Additional Base Warranty.
Error	INVDADDLPWRWARR	Additional Powertrain Warranty is invalid, both Term and Mileage must be provided.
Error	ADDLPWRTERMMILEREQD	Additional Powertrain Warranty term and mileage specified are not valid for use as an Additional Powertrain Warranty.
Error	INVALID_Ownership	Ownership Condition is invalid
Error	INCORRECT_Ownership	Ownership is invalid for the Sale Date and VIN/Sale Odometer combination.
Error	INVALID_NADA	NADA is invalid. (This error applies to GAP contracts when eligibility is based on NADA)
Error	INVALID_RECIPIENT_ID	Recipient Id is Invalid
Error	revInServiceDate	Mfg. Warranty Start Date is not within a year of the vehicle model year (e.g. for a 2013 vehicle, the manufacturer warranty start date must be between 1/1/2012 and 12/31/2014)

GetRates Error Messages

Message Type	Error code Message Text
Error/Warning	GETRATES1008	Vehicle’s manufacturer warranty information is not available. Please contact your product provider for further assistance. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error/Warning	GETRATES1005	This vehicle is only eligible for this plan if it is within {0} month(s) of the manufacturer’s base warranty period. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error/Warning	GETRATES1006	This vehicle is only eligible for this plan if it is within {0} miles by odometer of the manufacturer’s base warranty period. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error/Warning	PlanDealType	Plan is only available for {0} deals. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error	rfvVehiclePurchaseDate	Vehicle Purchase Date is required.
Error	GETRATES0001	The contract is not eligible because the Financed Amount is greater than {0:P3} of the Vehicle Sale Price.
Error	GETRATES1001	Vehicle is not classified for this plan.
Error/Warning	GETRATES1007	Manufacturer warranty start date is required. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error	GETRATES0002	The contract is not eligible because the Vehicle Sale Price is greater than the Maximum Vehicle Sale Price.
Error	GETRATES0003	Financed Amount is greater than {0:P3} of the MSRP.
Error	GETRATES0004	MSRP exceeds Maximum MSRP limit of {0}.
Error	GETRATES0017	APR is less than Minimum APR limit of {0:P3}.
Error	GETRATES0005	APR exceeds Maximum APR limit of {0:P3}.
Error	GETRATES0006	Financed Amount is less than Minimum Financed Amount of {0:c}.
Error	GETRATES0014	Financed Amount is greater than Maximum Financed Amount of {0:c}.
Error	rfvFinanceAmount	Financed Amount is required.
Error	GETRATES0008	APR is required.
Error	GETRATES0009	Finance Term is required.
Error	rfvDealType	Deal Type is required.
Error	GETRATES0013	MSRP is required.
Error	GETRATES0018	The term {0} months is not available for this plan.
Error/Warning	GETRATES0020	The Manufacturer Warranty Start Date for this vehicle is too old to provide any effective coverage. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error	SALEODOM_EXCEED_MILE	The sale odometer exceeds the odometer eligibility mileage.
Error/Warning	GETRATES1003	Vehicle is ineligible for one or more terms based on odometer and/or model year rules. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error/Warning	GETRATES1004	Vehicle is ineligible for one or more terms based on odometer eligibility rules. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error/Warning	GETRATES1009	The contract is not eligible based on APR rules. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error	RTLRL035	You do not have permissions to activate or bill a contract with a Retail Rate that differs from the Regulated Retail.
Error	RTLRL036	You do not have permissions to activate or bill a contract with a Retail Rate that differs from allowable Markup.