SCS Contract Info API

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

Contract Info

This method can be used to get details about the contract such as the customer name, status, and cost of the contract. The information is only available to selling dealers.

Request Schema

Contract Info Object


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
RequestingUser	X(50)	R			The name of the F&I manager, office manager or other user of the system that is requesting the info.
ContractNumber	X(20)	C			Contract Number for contract to be looked up. Contract can be looked up using Contract Number, VIN or Member ID.
VinNumber	X(17)	C			Vehicle Identification Number. Contract can be looked up using Contract Number, VIN or Member ID.
MemberId	X(20)	C			Member ID. Contract can be looked up using Contract Number, VIN or Member ID.

Sample Request

<ContractInfo xmlns[="http://www.natinc.com/SCSAutoService/">](http://www.natinc.com/SCSAutoService/)
    <request>
        <UserId>xxxxxx</UserId>
        <Password>xxxxxxx</Password>
        <TpaCode>DEMO</TpaCode>
        <RequestingUser>JOHN SMITH</RequestingUser>
        <ContractNumber>ABC00007306</ContractNumber>
        <VIN>2D4RN4DE3AR486715</VIN>
    </request>
</ContractInfo>

Response Schema

ContractInfo Object


Tag	Format	Description
RequestResult	Boolean	‘True’ if the contract information was available and returned. ‘False’ if contract is not found or an error message is returned.
ContractNumber	X(20)	Contract Number.
ContractStatus	X(10)	The status of the contract in SCS. Possible values are: ‘Pending’, ‘Pending Remittance’, ‘Active’, ‘Cancelled’, ‘Rejected’, ‘Expired’.
Product Code	X(4)	VSC = Vehicle Service Contract, GAP = GAP, MNT = Maintenance, AP = Appearance Protection, PDR = Paintless Dent Repair
ProductTypeDescription	X(255)
RegisterNumber	X(10)	Register Number. Provided for future functionality.
InserviceDate	Date	Inservice Date. Date the Manufacturer Warranty on the vehicle is effective.
SaleDate	Date	Date the contract was sold.
VehiclePurchaseDate	Date	Vehicle Purchase Date
VehicleOdometer	N(7)	Vehicle odometer reading at the time of sale.
QuoteID	N(15)	Value from eRating response that identifies the Quote that was used to produce the contract.
ProgramDescription	X(60)	Name of the program as configured in SCS.
PlanDescription	X(30)	Plan that was sold on the contract.
Term	N(3)	Term of the contract
Mileage	N(6)	The number of miles that the contract was purchased for.
Deductible	X(255)	Example values are: ‘200 Disappearing’, ‘50 Reducing Deductible’
RetailCost	N(8,2)	The price charged to the customer for the contract.
LienholderName	X(60)	Lienholder Name
EffectiveDate	Date	Date the contract is effective
EffectiveOdometer	N(7)	Odometer when coverage was effective
ExpirationDate	Date	Date the contract is scheduled to expire
ExpirationOdometer	N(7)	Odometer reading when the contract expires
FinanceType	X(1)	Only available for GAP.
FinancedAmount	N(8,2)	Only available for GAP
FinanceAPR	N(2,2)	Only available for GAP
FinanceTerm	N(3)	Only available for GAP
MSRP	N(8,2)	Only available for GAP
MonthlyPayment	N(8,2)	Only available for GAP
FirstPaymentDate	N(8,2)	Only available for GAP
BalloonAmount	N(8,2)	Only available for GAP
ResidualValue	N(8,2)	Only available for GAP
BaseACV	N(8,2)	Only available for certain GAP products. Base Actual Cash Value of the vehicle (i.e. without any vehicle options).
NADAValue	N(8,2)	Only available for GAP
InsuranceDeductible	N(5,2)	Only available for GAP
StockNumber	X(30)
MemberId	X(20)	MemId field value
Ownership	X(1)	New (N) or Pre-Owned (P) vehicle ownership
Vehicle
Customer
ContractOptions

Vehicle Object


Tag	Format	Description
VIN	X(17)
Type	X(1)
Year	N(4)
Make	X(25)
Model	X(25)
Cyl	X(25)
Drv	X(25)
Fuel	X(25)
AspirationCode	X(25)
SegmentationCode	X(100)
TonRating	X(25)
GVWR	X(25)
Trim	X(25)
AssetType	X(25)
BodyStyle	X(25)
EngineSizeUnit	X(25)
EngineSize	X(25)
CompleteVehicle	X(25)

Customer Object


Tag	Format	Description
Title	X(20)
FirstName	X(30)
LastName	X(60)
MiddleInitial	X(30)
Email	X(100)
Address		Address object
AlternateContact	X(60)

Address Object


Tag	Format	Description
Address1	X(30)
Address2	X(30)
City	X(20)
State	X(2)
ZipCode	X(10)
HomePhone	X(10)
HomePhoneExt	X(4)
WorkPhone	X(10)
WorkPhoneExt	X(4)

ContractOptions Object


Tag	Format	Description
Description	X(60)

Message Object


Tag	Format	Req/ Opt/ Cond	Valid values	Description
Code	String	O
Type	Integer	R	1 = Error, 2 = Info, 3 = Warning, 4 = Success	Message Type
Text	String	R		Message Text

Error Messages


Message Type	Message Text
Error	Invalid contract number.
Error	TPA Code is required.
Error	TPA is invalid.
Error	Invalid Seller Number.
Error	Contract Number is required.
Error	Only selling dealers can request contract information.
Error	VIN does not match VIN on the contract.
Error	No contracts found.
Error	More than one active contract(s) exist for this VIN. Please provide the contract number or contact the administrator for further assistance
Error	More than one contract(s) exist for this VIN. Please provide the contract number or contact the administrator for further assistance.
Error	Contract details could not be provided. Please contact the provider for further assistance.

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<ContractInfoResponse xmlns:xsi="<http://www.w3.org/2001/XMLSchema-instance>" xmlns:xsd="<http://www.w3.org/2001/XMLSchema>">
    <ContractInfoResult>
        <ResponseCode>1</ResponseCode>
        <Messages/>
        <Contracts>
            <Contract>
                <Vehicle>
                    <VIN>2D4RN4DE3AR486715</VIN>
                    <Type>N</Type>
                    <Year>2010</Year>
                    <Make>DODGE</Make>
                    <Model>GRAND CARAVAN SE</Model>
                    <Cyl>6 Cyl</Cyl>
                    <Drv>Front Wheel Drive</Drv>
                    <Fuel>Flexible Fuel</Fuel>
                    <AspirationCode>Normal</AspirationCode>
                    <TonRating/>
                    <GVWR>6,001 - 10,000</GVWR>
                    <SegmentationCode>Truck Mid-Size Non-Luxury Van</SegmentationCode>
                </Vehicle>
                <Customer>
                    <Address>
                        <Address1>123 MAIN ST</Address1>
                        <Address2/>
                        <City>OXNARD</City>
                        <State>CA</State>
                        <ZipCode>93036</ZipCode>
                        <HomePhone>3125551212</HomePhone>
                        <HomePhoneExt/>
                        <WorkPhone/>
                        <WorkPhoneExt/>
                    </Address>
                    <AlternateContact/>
                    <Title/>
                    <FirstName>JOHN</FirstName>
                    <LastName>SMITH</LastName>
                    <MiddleInitial/>
                    <Email/>
                </Customer>
                <Seller>
                    <SellerNo>DEMO123</SellerNo>
                    <Name>FIAS TEST DEALER</Name>
                    <Address1>1001 OAK ST</Address1>
                    <Address2 />
                    <City>LOMBARD</City>
                    <State>IL</State>
                    <ZipCode>60056</ZipCode>
                    <Phone>6307432900</Phone>
                    <Fax>6307432001</Fax>
                </Seller>
                <ContractOptions>
                    <ContractOption>
                        <Description>GAP Plus</Description>
                    </ContractOption>
                    <ContractOption>
                        <Description>Commercial Use</Description>
                    </ContractOption>
                </ContractOptions>
                <ContractNumber>CF123456</ContractNumber>
                <ContractStatus>Active</ContractStatus>
                <ProductCode>GAP</ProductCode>
                <ProductTypeDescription>GAP</ProductTypeDescription>
                <RegisterNumber>R000035422</RegisterNumber>
                <InserviceDate xsi:nil="true" />
                <SaleDate>2009-10-03T00:00:00</SaleDate>
                <VehiclePurchaseDate xsi:nil="true" />
                <VehicleOdometer>45384</VehicleOdometer>
                <QuoteID>0</QuoteID>
                <PlanDescription>Loan - 125</PlanDescription>
                <ProgramDescription>GAP Waiver</ProgramDescription>
                <Term>72</Term>
                <Mileage>100000</Mileage>
                <Deductible>0</Deductible>
                <RetailCost>795.0000</RetailCost>
                <LienholderName>ABC FEDERAL CREDIT UNION</LienholderName>
                <EffectiveDate>2009-10-03T00:00:00</EffectiveDate>
                <EffectiveOdometer>0</EffectiveOdometer>
                <ExpirationDate>2015-10-03T00:00:00</ExpirationDate>
                <ExpirationOdometer>100000</ExpirationOdometer>
                <FinanceType>LOAN</FinanceType>
                <FinancedAmount>18189.7600</FinancedAmount>
                <FinanceAPR>0.11990000</FinanceAPR>
                <FinanceTerm>72</FinanceTerm>
                <MSRP xsi:nil="true" />
                <MonthlyPayment xsi:nil="true" />
                <FirstPaymentDate xsi:nil="true" />
                <BalloonAmount xsi:nil="true" />
                <ResidualValue xsi:nil="true" />
                <BaseACV xsi:nil="true" />
                <NADAValue xsi:nil="true" />
                <InsuranceDeductible xsi:nil="true" />
                <StockNumber/>
                <DealNumber/>
            </Contract>
        </Contracts>
    </ContractInfoResult>
</ContractInfoResponse>

08 Contract Info API

SCS Contract Info API#

Data Format#

Contract Info#

Request Schema#

Contract Info Object#

Sample Request#

Response Schema#

ContractInfo Object#

Vehicle Object#

Customer Object#

Address Object#

ContractOptions Object#

Message Object#

Error Messages#

Sample Response#