ContractService Web Service

ContractService

Click here for a complete list of operations.

UpdateContract

The UpdateContract validates & updates a contract, if contract can be updated with 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/UpdateContract"

<?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>
    <UpdateContract xmlns="http://tempuri.org/ContractService/">
      <updateContract>
        <ContractOptions>
          <ContractOptionUpdate>
            <Id>int</Id>
            <Description>string</Description>
            <Action>string</Action>
          </ContractOptionUpdate>
          <ContractOptionUpdate>
            <Id>int</Id>
            <Description>string</Description>
            <Action>string</Action>
          </ContractOptionUpdate>
        </ContractOptions>
        <ContractNumber>string</ContractNumber>
        <DealerNumber>string</DealerNumber>
        <ReRate>boolean</ReRate>
        <SaleDate>dateTime</SaleDate>
        <SaleDateRemove>string</SaleDateRemove>
        <ProgramName>string</ProgramName>
        <ProgramNameRemove>string</ProgramNameRemove>
        <PlanCode>string</PlanCode>
        <PlanCodeRemove>string</PlanCodeRemove>
        <PlanType>string</PlanType>
        <PlanTypeRemove>string</PlanTypeRemove>
        <SaleOdometer>int</SaleOdometer>
        <SaleOdometerRemove>string</SaleOdometerRemove>
        <VehiclePurchasePrice>decimal</VehiclePurchasePrice>
        <VehiclePurchasePriceRemove>string</VehiclePurchasePriceRemove>
        <VehiclePurchaseDate>dateTime</VehiclePurchaseDate>
        <VehiclePurchaseDateRemove>string</VehiclePurchaseDateRemove>
        <InServiceDate>dateTime</InServiceDate>
        <InServiceDateRemove>string</InServiceDateRemove>
        <FinanceType>string</FinanceType>
        <FinanceTypeRemove>string</FinanceTypeRemove>
        <FinancedAmount>decimal</FinancedAmount>
        <FinancedAmountRemove>string</FinancedAmountRemove>
        <FinanceAPR>decimal</FinanceAPR>
        <FinanceAPRRemove>string</FinanceAPRRemove>
        <FinanceTerm>int</FinanceTerm>
        <FinanceTermRemove>string</FinanceTermRemove>
        <MSRP>decimal</MSRP>
        <MSRPRemove>string</MSRPRemove>
        <MonthlyPayment>decimal</MonthlyPayment>
        <MonthlyPaymentRemove>string</MonthlyPaymentRemove>
        <FirstPaymentDate>dateTime</FirstPaymentDate>
        <FirstPaymentDateRemove>string</FirstPaymentDateRemove>
        <BalloonAmount>decimal</BalloonAmount>
        <BalloonAmountRemove>string</BalloonAmountRemove>
        <ResidualValue>decimal</ResidualValue>
        <ResidualValueRemove>string</ResidualValueRemove>
        <BaseACV>decimal</BaseACV>
        <BaseACVRemove>string</BaseACVRemove>
        <NADAValue>decimal</NADAValue>
        <NADAValueRemove>string</NADAValueRemove>
        <InsuranceDeductible>decimal</InsuranceDeductible>
        <InsuranceDeductibleRemove>string</InsuranceDeductibleRemove>
        <RetailCost>decimal</RetailCost>
        <RetailCostRemove>string</RetailCostRemove>
        <PaymentOption>string</PaymentOption>
        <PaymentOptionRemove>string</PaymentOptionRemove>
        <StockNumber>string</StockNumber>
        <DealNumber>string</DealNumber>
        <RegenerateContractDocument>boolean</RegenerateContractDocument>
        <AdditionalContractInfo>
          <FieldValueRemove>string</FieldValueRemove>
        </AdditionalContractInfo>
        <TermMile>
          <Action>string</Action>
        </TermMile>
        <Deductible>
          <Action>string</Action>
        </Deductible>
        <Vehicle>
          <Action>string</Action>
        </Vehicle>
        <Customer>
          <Title>string</Title>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <MiddleInitial>string</MiddleInitial>
          <Email>string</Email>
          <AlternateContact>string</AlternateContact>
          <Address>
            <Address1Remove>string</Address1Remove>
            <Address2Remove>string</Address2Remove>
            <CityRemove>string</CityRemove>
            <StateRemove>string</StateRemove>
            <ZipCodeRemove>string</ZipCodeRemove>
            <HomePhoneRemove>string</HomePhoneRemove>
            <HomePhoneExtRemove>string</HomePhoneExtRemove>
            <WorkPhoneRemove>string</WorkPhoneRemove>
            <WorkPhoneExtRemove>string</WorkPhoneExtRemove>
          </Address>
          <TitleRemove>string</TitleRemove>
          <FirstNameRemove>string</FirstNameRemove>
          <LastNameRemove>string</LastNameRemove>
          <MiddleInitialRemove>string</MiddleInitialRemove>
          <EmailRemove>string</EmailRemove>
          <AlternateContactRemove>string</AlternateContactRemove>
          <IsTaxExempt>boolean</IsTaxExempt>
        </Customer>
        <SalesPerson>
          <Action>string</Action>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
        </SalesPerson>
        <LienHolder>
          <Action>string</Action>
        </LienHolder>
        <RecipientId>string</RecipientId>
        <RecipientIdRemove>string</RecipientIdRemove>
      </updateContract>
    </UpdateContract>
  </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>
    <UpdateContractResponse xmlns="http://tempuri.org/ContractService/">
      <UpdateContractResult>
        <Request>
          <ContractOptions>
            <ContractOptionUpdate xsi:nil="true" />
            <ContractOptionUpdate xsi:nil="true" />
          </ContractOptions>
          <ContractNumber>string</ContractNumber>
          <DealerNumber>string</DealerNumber>
          <ReRate>boolean</ReRate>
          <SaleDate>dateTime</SaleDate>
          <SaleDateRemove>string</SaleDateRemove>
          <ProgramName>string</ProgramName>
          <ProgramNameRemove>string</ProgramNameRemove>
          <PlanCode>string</PlanCode>
          <PlanCodeRemove>string</PlanCodeRemove>
          <PlanType>string</PlanType>
          <PlanTypeRemove>string</PlanTypeRemove>
          <SaleOdometer>int</SaleOdometer>
          <SaleOdometerRemove>string</SaleOdometerRemove>
          <VehiclePurchasePrice>decimal</VehiclePurchasePrice>
          <VehiclePurchasePriceRemove>string</VehiclePurchasePriceRemove>
          <VehiclePurchaseDate>dateTime</VehiclePurchaseDate>
          <VehiclePurchaseDateRemove>string</VehiclePurchaseDateRemove>
          <InServiceDate>dateTime</InServiceDate>
          <InServiceDateRemove>string</InServiceDateRemove>
          <FinanceType>string</FinanceType>
          <FinanceTypeRemove>string</FinanceTypeRemove>
          <FinancedAmount>decimal</FinancedAmount>
          <FinancedAmountRemove>string</FinancedAmountRemove>
          <FinanceAPR>decimal</FinanceAPR>
          <FinanceAPRRemove>string</FinanceAPRRemove>
          <FinanceTerm>int</FinanceTerm>
          <FinanceTermRemove>string</FinanceTermRemove>
          <MSRP>decimal</MSRP>
          <MSRPRemove>string</MSRPRemove>
          <MonthlyPayment>decimal</MonthlyPayment>
          <MonthlyPaymentRemove>string</MonthlyPaymentRemove>
          <FirstPaymentDate>dateTime</FirstPaymentDate>
          <FirstPaymentDateRemove>string</FirstPaymentDateRemove>
          <BalloonAmount>decimal</BalloonAmount>
          <BalloonAmountRemove>string</BalloonAmountRemove>
          <ResidualValue>decimal</ResidualValue>
          <ResidualValueRemove>string</ResidualValueRemove>
          <BaseACV>decimal</BaseACV>
          <BaseACVRemove>string</BaseACVRemove>
          <NADAValue>decimal</NADAValue>
          <NADAValueRemove>string</NADAValueRemove>
          <InsuranceDeductible>decimal</InsuranceDeductible>
          <InsuranceDeductibleRemove>string</InsuranceDeductibleRemove>
          <RetailCost>decimal</RetailCost>
          <RetailCostRemove>string</RetailCostRemove>
          <PaymentOption>string</PaymentOption>
          <PaymentOptionRemove>string</PaymentOptionRemove>
          <StockNumber>string</StockNumber>
          <DealNumber>string</DealNumber>
          <RegenerateContractDocument>boolean</RegenerateContractDocument>
          <AdditionalContractInfo>
            <FieldValueRemove>string</FieldValueRemove>
          </AdditionalContractInfo>
          <TermMile>
            <Action>string</Action>
          </TermMile>
          <Deductible>
            <Action>string</Action>
          </Deductible>
          <Vehicle>
            <Action>string</Action>
          </Vehicle>
          <Customer>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <MiddleInitial>string</MiddleInitial>
            <Email>string</Email>
            <AlternateContact>string</AlternateContact>
            <Address xsi:nil="true" />
            <TitleRemove>string</TitleRemove>
            <FirstNameRemove>string</FirstNameRemove>
            <LastNameRemove>string</LastNameRemove>
            <MiddleInitialRemove>string</MiddleInitialRemove>
            <EmailRemove>string</EmailRemove>
            <AlternateContactRemove>string</AlternateContactRemove>
            <IsTaxExempt>boolean</IsTaxExempt>
          </Customer>
          <SalesPerson>
            <Action>string</Action>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
          </SalesPerson>
          <LienHolder>
            <Action>string</Action>
          </LienHolder>
          <RecipientId>string</RecipientId>
          <RecipientIdRemove>string</RecipientIdRemove>
        </Request>
        <ContractDocument>string</ContractDocument>
      </UpdateContractResult>
    </UpdateContractResponse>
  </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>
    <UpdateContract xmlns="http://tempuri.org/ContractService/">
      <updateContract>
        <ContractOptions>
          <ContractOptionUpdate>
            <Id>int</Id>
            <Description>string</Description>
            <Action>string</Action>
          </ContractOptionUpdate>
          <ContractOptionUpdate>
            <Id>int</Id>
            <Description>string</Description>
            <Action>string</Action>
          </ContractOptionUpdate>
        </ContractOptions>
        <ContractNumber>string</ContractNumber>
        <DealerNumber>string</DealerNumber>
        <ReRate>boolean</ReRate>
        <SaleDate>dateTime</SaleDate>
        <SaleDateRemove>string</SaleDateRemove>
        <ProgramName>string</ProgramName>
        <ProgramNameRemove>string</ProgramNameRemove>
        <PlanCode>string</PlanCode>
        <PlanCodeRemove>string</PlanCodeRemove>
        <PlanType>string</PlanType>
        <PlanTypeRemove>string</PlanTypeRemove>
        <SaleOdometer>int</SaleOdometer>
        <SaleOdometerRemove>string</SaleOdometerRemove>
        <VehiclePurchasePrice>decimal</VehiclePurchasePrice>
        <VehiclePurchasePriceRemove>string</VehiclePurchasePriceRemove>
        <VehiclePurchaseDate>dateTime</VehiclePurchaseDate>
        <VehiclePurchaseDateRemove>string</VehiclePurchaseDateRemove>
        <InServiceDate>dateTime</InServiceDate>
        <InServiceDateRemove>string</InServiceDateRemove>
        <FinanceType>string</FinanceType>
        <FinanceTypeRemove>string</FinanceTypeRemove>
        <FinancedAmount>decimal</FinancedAmount>
        <FinancedAmountRemove>string</FinancedAmountRemove>
        <FinanceAPR>decimal</FinanceAPR>
        <FinanceAPRRemove>string</FinanceAPRRemove>
        <FinanceTerm>int</FinanceTerm>
        <FinanceTermRemove>string</FinanceTermRemove>
        <MSRP>decimal</MSRP>
        <MSRPRemove>string</MSRPRemove>
        <MonthlyPayment>decimal</MonthlyPayment>
        <MonthlyPaymentRemove>string</MonthlyPaymentRemove>
        <FirstPaymentDate>dateTime</FirstPaymentDate>
        <FirstPaymentDateRemove>string</FirstPaymentDateRemove>
        <BalloonAmount>decimal</BalloonAmount>
        <BalloonAmountRemove>string</BalloonAmountRemove>
        <ResidualValue>decimal</ResidualValue>
        <ResidualValueRemove>string</ResidualValueRemove>
        <BaseACV>decimal</BaseACV>
        <BaseACVRemove>string</BaseACVRemove>
        <NADAValue>decimal</NADAValue>
        <NADAValueRemove>string</NADAValueRemove>
        <InsuranceDeductible>decimal</InsuranceDeductible>
        <InsuranceDeductibleRemove>string</InsuranceDeductibleRemove>
        <RetailCost>decimal</RetailCost>
        <RetailCostRemove>string</RetailCostRemove>
        <PaymentOption>string</PaymentOption>
        <PaymentOptionRemove>string</PaymentOptionRemove>
        <StockNumber>string</StockNumber>
        <DealNumber>string</DealNumber>
        <RegenerateContractDocument>boolean</RegenerateContractDocument>
        <AdditionalContractInfo>
          <FieldValueRemove>string</FieldValueRemove>
        </AdditionalContractInfo>
        <TermMile>
          <Action>string</Action>
        </TermMile>
        <Deductible>
          <Action>string</Action>
        </Deductible>
        <Vehicle>
          <Action>string</Action>
        </Vehicle>
        <Customer>
          <Title>string</Title>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <MiddleInitial>string</MiddleInitial>
          <Email>string</Email>
          <AlternateContact>string</AlternateContact>
          <Address>
            <Address1Remove>string</Address1Remove>
            <Address2Remove>string</Address2Remove>
            <CityRemove>string</CityRemove>
            <StateRemove>string</StateRemove>
            <ZipCodeRemove>string</ZipCodeRemove>
            <HomePhoneRemove>string</HomePhoneRemove>
            <HomePhoneExtRemove>string</HomePhoneExtRemove>
            <WorkPhoneRemove>string</WorkPhoneRemove>
            <WorkPhoneExtRemove>string</WorkPhoneExtRemove>
          </Address>
          <TitleRemove>string</TitleRemove>
          <FirstNameRemove>string</FirstNameRemove>
          <LastNameRemove>string</LastNameRemove>
          <MiddleInitialRemove>string</MiddleInitialRemove>
          <EmailRemove>string</EmailRemove>
          <AlternateContactRemove>string</AlternateContactRemove>
          <IsTaxExempt>boolean</IsTaxExempt>
        </Customer>
        <SalesPerson>
          <Action>string</Action>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
        </SalesPerson>
        <LienHolder>
          <Action>string</Action>
        </LienHolder>
        <RecipientId>string</RecipientId>
        <RecipientIdRemove>string</RecipientIdRemove>
      </updateContract>
    </UpdateContract>
  </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>
    <UpdateContractResponse xmlns="http://tempuri.org/ContractService/">
      <UpdateContractResult>
        <Request>
          <ContractOptions>
            <ContractOptionUpdate xsi:nil="true" />
            <ContractOptionUpdate xsi:nil="true" />
          </ContractOptions>
          <ContractNumber>string</ContractNumber>
          <DealerNumber>string</DealerNumber>
          <ReRate>boolean</ReRate>
          <SaleDate>dateTime</SaleDate>
          <SaleDateRemove>string</SaleDateRemove>
          <ProgramName>string</ProgramName>
          <ProgramNameRemove>string</ProgramNameRemove>
          <PlanCode>string</PlanCode>
          <PlanCodeRemove>string</PlanCodeRemove>
          <PlanType>string</PlanType>
          <PlanTypeRemove>string</PlanTypeRemove>
          <SaleOdometer>int</SaleOdometer>
          <SaleOdometerRemove>string</SaleOdometerRemove>
          <VehiclePurchasePrice>decimal</VehiclePurchasePrice>
          <VehiclePurchasePriceRemove>string</VehiclePurchasePriceRemove>
          <VehiclePurchaseDate>dateTime</VehiclePurchaseDate>
          <VehiclePurchaseDateRemove>string</VehiclePurchaseDateRemove>
          <InServiceDate>dateTime</InServiceDate>
          <InServiceDateRemove>string</InServiceDateRemove>
          <FinanceType>string</FinanceType>
          <FinanceTypeRemove>string</FinanceTypeRemove>
          <FinancedAmount>decimal</FinancedAmount>
          <FinancedAmountRemove>string</FinancedAmountRemove>
          <FinanceAPR>decimal</FinanceAPR>
          <FinanceAPRRemove>string</FinanceAPRRemove>
          <FinanceTerm>int</FinanceTerm>
          <FinanceTermRemove>string</FinanceTermRemove>
          <MSRP>decimal</MSRP>
          <MSRPRemove>string</MSRPRemove>
          <MonthlyPayment>decimal</MonthlyPayment>
          <MonthlyPaymentRemove>string</MonthlyPaymentRemove>
          <FirstPaymentDate>dateTime</FirstPaymentDate>
          <FirstPaymentDateRemove>string</FirstPaymentDateRemove>
          <BalloonAmount>decimal</BalloonAmount>
          <BalloonAmountRemove>string</BalloonAmountRemove>
          <ResidualValue>decimal</ResidualValue>
          <ResidualValueRemove>string</ResidualValueRemove>
          <BaseACV>decimal</BaseACV>
          <BaseACVRemove>string</BaseACVRemove>
          <NADAValue>decimal</NADAValue>
          <NADAValueRemove>string</NADAValueRemove>
          <InsuranceDeductible>decimal</InsuranceDeductible>
          <InsuranceDeductibleRemove>string</InsuranceDeductibleRemove>
          <RetailCost>decimal</RetailCost>
          <RetailCostRemove>string</RetailCostRemove>
          <PaymentOption>string</PaymentOption>
          <PaymentOptionRemove>string</PaymentOptionRemove>
          <StockNumber>string</StockNumber>
          <DealNumber>string</DealNumber>
          <RegenerateContractDocument>boolean</RegenerateContractDocument>
          <AdditionalContractInfo>
            <FieldValueRemove>string</FieldValueRemove>
          </AdditionalContractInfo>
          <TermMile>
            <Action>string</Action>
          </TermMile>
          <Deductible>
            <Action>string</Action>
          </Deductible>
          <Vehicle>
            <Action>string</Action>
          </Vehicle>
          <Customer>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <MiddleInitial>string</MiddleInitial>
            <Email>string</Email>
            <AlternateContact>string</AlternateContact>
            <Address xsi:nil="true" />
            <TitleRemove>string</TitleRemove>
            <FirstNameRemove>string</FirstNameRemove>
            <LastNameRemove>string</LastNameRemove>
            <MiddleInitialRemove>string</MiddleInitialRemove>
            <EmailRemove>string</EmailRemove>
            <AlternateContactRemove>string</AlternateContactRemove>
            <IsTaxExempt>boolean</IsTaxExempt>
          </Customer>
          <SalesPerson>
            <Action>string</Action>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
          </SalesPerson>
          <LienHolder>
            <Action>string</Action>
          </LienHolder>
          <RecipientId>string</RecipientId>
          <RecipientIdRemove>string</RecipientIdRemove>
        </Request>
        <ContractDocument>string</ContractDocument>
      </UpdateContractResult>
    </UpdateContractResponse>
  </soap12:Body>
</soap12:Envelope>