ContractService Web Service

ContractService

Click here for a complete list of operations.

GenerateContract

The GenerateContract returns contract PDF for given contract parameters.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /scs.webservice/contractservice.asmx HTTP/1.1
Host: staging.fiadmin.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/ContractService/GenerateContract"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GenerateContract xmlns="http://tempuri.org/ContractService/">
      <contract>
        <ContractOptions>
          <ContractOption>
            <Id>int</Id>
            <Description>string</Description>
            <IsSurcharge>boolean</IsSurcharge>
            <NetCost>decimal</NetCost>
          </ContractOption>
          <ContractOption>
            <Id>int</Id>
            <Description>string</Description>
            <IsSurcharge>boolean</IsSurcharge>
            <NetCost>decimal</NetCost>
          </ContractOption>
        </ContractOptions>
        <Deductible>
          <DeductTypeDescriptions>
            <GlobalInformation xsi:nil="true" />
            <GlobalInformation xsi:nil="true" />
          </DeductTypeDescriptions>
          <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>
            <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>
        <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>
    </GenerateContract>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GenerateContractResponse xmlns="http://tempuri.org/ContractService/">
      <GenerateContractResult>
        <ContractDocument>string</ContractDocument>
        <ContractNumber>string</ContractNumber>
        <EffectiveDate>dateTime</EffectiveDate>
        <EffectiveOdometer>int</EffectiveOdometer>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationOdometer>int</ExpirationOdometer>
        <Tax>
          <NetTaxAmt1>decimal</NetTaxAmt1>
          <NetTaxAmt2>decimal</NetTaxAmt2>
          <RetailTaxAmt1>decimal</RetailTaxAmt1>
          <RetailTaxAmt2>decimal</RetailTaxAmt2>
          <TotalRetailTaxAmt>decimal</TotalRetailTaxAmt>
          <Tax1TaxLabel>string</Tax1TaxLabel>
          <Tax2TaxLabel>string</Tax2TaxLabel>
        </Tax>
      </GenerateContractResult>
    </GenerateContractResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /scs.webservice/contractservice.asmx HTTP/1.1
Host: staging.fiadmin.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GenerateContract xmlns="http://tempuri.org/ContractService/">
      <contract>
        <ContractOptions>
          <ContractOption>
            <Id>int</Id>
            <Description>string</Description>
            <IsSurcharge>boolean</IsSurcharge>
            <NetCost>decimal</NetCost>
          </ContractOption>
          <ContractOption>
            <Id>int</Id>
            <Description>string</Description>
            <IsSurcharge>boolean</IsSurcharge>
            <NetCost>decimal</NetCost>
          </ContractOption>
        </ContractOptions>
        <Deductible>
          <DeductTypeDescriptions>
            <GlobalInformation xsi:nil="true" />
            <GlobalInformation xsi:nil="true" />
          </DeductTypeDescriptions>
          <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>
            <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>
        <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>
    </GenerateContract>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GenerateContractResponse xmlns="http://tempuri.org/ContractService/">
      <GenerateContractResult>
        <ContractDocument>string</ContractDocument>
        <ContractNumber>string</ContractNumber>
        <EffectiveDate>dateTime</EffectiveDate>
        <EffectiveOdometer>int</EffectiveOdometer>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationOdometer>int</ExpirationOdometer>
        <Tax>
          <NetTaxAmt1>decimal</NetTaxAmt1>
          <NetTaxAmt2>decimal</NetTaxAmt2>
          <RetailTaxAmt1>decimal</RetailTaxAmt1>
          <RetailTaxAmt2>decimal</RetailTaxAmt2>
          <TotalRetailTaxAmt>decimal</TotalRetailTaxAmt>
          <Tax1TaxLabel>string</Tax1TaxLabel>
          <Tax2TaxLabel>string</Tax2TaxLabel>
        </Tax>
      </GenerateContractResult>
    </GenerateContractResponse>
  </soap12:Body>
</soap12:Envelope>