PartnerHub

<back to all web services

DealGet

To override the Content-type in your clients HTTP Accept Header, append the .soap12 suffix or ?format=soap12

HTTP + SOAP12

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap12 HTTP/1.1 
Host: partnerhub.pbsdealers.com 
Content-Type: text/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>

<DealGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PBS.PartnerHub.ServiceModel">
  <BuyerRef>00000000-0000-0000-0000-000000000000</BuyerRef>
  <ContractSince>0001-01-01T00:00:00</ContractSince>
  <ContractUntil>0001-01-01T00:00:00</ContractUntil>
  <DealId>00000000-0000-0000-0000-000000000000</DealId>
  <DealKey>String</DealKey>
  <DealType>String</DealType>
  <DeliverySince>0001-01-01T00:00:00</DeliverySince>
  <DeliveryUntil>0001-01-01T00:00:00</DeliveryUntil>
  <ModifiedSince>0001-01-01T00:00:00</ModifiedSince>
  <ModifiedUntil>0001-01-01T00:00:00</ModifiedUntil>
  <SaleType>String</SaleType>
  <SerialNumber>String</SerialNumber>
  <Status>String</Status>
  <SystemDeliverySince>0001-01-01T00:00:00</SystemDeliverySince>
  <SystemDeliveryUntil>0001-01-01T00:00:00</SystemDeliveryUntil>
</DealGet>

    </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
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>

<DealGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PBS.PartnerHub.ServiceModel">
  <Deals>
    <Deal>
      <APR>0</APR>
      <Accessories>
        <DealAccessory>
          <Code>String</Code>
          <Cost>0</Cost>
          <Description>String</Description>
          <Price>0</Price>
        </DealAccessory>
      </Accessories>
      <Adjustments>
        <DealVehicleAdjustment>
          <Amount>0</Amount>
          <Description>String</Description>
        </DealVehicleAdjustment>
      </Adjustments>
      <Allowances>
        <DealAllowance>
          <Amount>0</Amount>
          <CertificateNumber>String</CertificateNumber>
          <Code>String</Code>
          <Description>String</Description>
        </DealAllowance>
      </Allowances>
      <AmortizationTerm>0</AmortizationTerm>
      <BuyerRef>00000000-0000-0000-0000-000000000000</BuyerRef>
      <CashInfo>
        <Deposit>0</Deposit>
        <DueOnDelivery>0</DueOnDelivery>
        <MSRP>0</MSRP>
        <Taxes>
          <DealTax>
            <Amount>0</Amount>
            <Name>String</Name>
            <Rate>0</Rate>
          </DealTax>
        </Taxes>
      </CashInfo>
      <CashOnDelivery>0</CashOnDelivery>
      <CoBuyerRefs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
      </CoBuyerRefs>
      <Conditions>String</Conditions>
      <ContractDate>0001-01-01T00:00:00</ContractDate>
      <CreationDate>0001-01-01T00:00:00</CreationDate>
      <DealId>00000000-0000-0000-0000-000000000000</DealId>
      <DealKey>String</DealKey>
      <DealTags>
        <DealTagInfo>
          <KeyName>String</KeyName>
          <KeyValue>String</KeyValue>
        </DealTagInfo>
      </DealTags>
      <DealType>String</DealType>
      <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
      <DeliveryStepsCompleted xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </DeliveryStepsCompleted>
      <Fees>
        <DealFee>
          <Amount>0</Amount>
          <Capitalized>false</Capitalized>
          <Name>String</Name>
        </DealFee>
      </Fees>
      <FinanceInfo>
        <APR>0</APR>
        <AmortizationTerm>0</AmortizationTerm>
        <BalanceToFinance>0</BalanceToFinance>
        <Balloon>0</Balloon>
        <Bank>String</Bank>
        <BankInfo>
          <Address>String</Address>
          <BankNumber>String</BankNumber>
          <City>String</City>
          <Code>String</Code>
          <Fax>String</Fax>
          <Name>String</Name>
          <Phone>String</Phone>
          <State>String</State>
          <ZipCode>String</ZipCode>
        </BankInfo>
        <CashOnDelivery>0</CashOnDelivery>
        <Deposit>0</Deposit>
        <FinanceCharges>0</FinanceCharges>
        <MSRP>0</MSRP>
        <Payment>0</Payment>
        <PaymentBase>0</PaymentBase>
        <PaymentTaxes>
          <DealTax>
            <Amount>0</Amount>
            <Name>String</Name>
            <Rate>0</Rate>
          </DealTax>
        </PaymentTaxes>
        <PaymentTerm>0</PaymentTerm>
        <PaymentsPerYear>0</PaymentsPerYear>
        <Rate>0</Rate>
        <Term>0</Term>
        <TotalBalanceDue>0</TotalBalanceDue>
      </FinanceInfo>
      <Gross>
        <AccessoryGross>0</AccessoryGross>
        <DealGross>0</DealGross>
        <FinanceGross>0</FinanceGross>
        <Incentives>0</Incentives>
        <Reserve>
          <Amount>0</Amount>
          <BaseRate>0</BaseRate>
          <Factor>0</Factor>
          <MidRate>0</MidRate>
        </Reserve>
        <VehicleGross>0</VehicleGross>
      </Gross>
      <Insurance>
        <DealInsurance>
          <Code>String</Code>
          <Cost>0</Cost>
          <Coverage>String</Coverage>
          <Description>String</Description>
          <NumberOfPayments>0</NumberOfPayments>
          <PolicyNumber>String</PolicyNumber>
          <Premium>0</Premium>
          <RetroDays>String</RetroDays>
        </DealInsurance>
      </Insurance>
      <LastUpdate>0001-01-01T00:00:00</LastUpdate>
      <LeaseInfo>
        <APR>0</APR>
        <AmortizationTerm>0</AmortizationTerm>
        <Bank>String</Bank>
        <BankInfo>
          <Address>String</Address>
          <BankNumber>String</BankNumber>
          <City>String</City>
          <Code>String</Code>
          <Fax>String</Fax>
          <Name>String</Name>
          <Phone>String</Phone>
          <State>String</State>
          <ZipCode>String</ZipCode>
        </BankInfo>
        <CapCost>0</CapCost>
        <CapReduction>0</CapReduction>
        <CapSettings>
          <DealLeaseCapTaxSetting>
            <CodCapitalized>false</CodCapitalized>
            <LeaseCapitalized>false</LeaseCapitalized>
            <Name>String</Name>
            <Rate>0</Rate>
            <RebateCapitalized>false</RebateCapitalized>
            <TradeCapitalized>false</TradeCapitalized>
          </DealLeaseCapTaxSetting>
        </CapSettings>
        <CapTaxes>
          <DealTax>
            <Amount>0</Amount>
            <Name>String</Name>
            <Rate>0</Rate>
          </DealTax>
        </CapTaxes>
        <CashOnDelivery>0</CashOnDelivery>
        <Depreciation>0</Depreciation>
        <DriveOffLease>0</DriveOffLease>
        <InceptionMileageIncluded>false</InceptionMileageIncluded>
        <InceptionMileageRate>0</InceptionMileageRate>
        <InceptionMilesAllowed>0</InceptionMilesAllowed>
        <LeaseCalculationModel>String</LeaseCalculationModel>
        <MSRP>0</MSRP>
        <MileageAllowed>0</MileageAllowed>
        <MileageCategory>String</MileageCategory>
        <MileageCharges>0</MileageCharges>
        <MileageExpected>0</MileageExpected>
        <MileageRate>0</MileageRate>
        <NetLease>0</NetLease>
        <PayableOnDelivery>0</PayableOnDelivery>
        <Payment>0</Payment>
        <PaymentBase>0</PaymentBase>
        <PaymentTaxes>
          <DealTax>
            <Amount>0</Amount>
            <Name>String</Name>
            <Rate>0</Rate>
          </DealTax>
        </PaymentTaxes>
        <PaymentTerm>0</PaymentTerm>
        <PaymentsPerYear>0</PaymentsPerYear>
        <Rate>0</Rate>
        <ResidualAdjustment>0</ResidualAdjustment>
        <ResidualAmount>0</ResidualAmount>
        <ResidualNet>0</ResidualNet>
        <ResidualPercent>0</ResidualPercent>
        <SecurityDeposit>0</SecurityDeposit>
        <Term>0</Term>
        <UpfrontTaxes>
          <DealTax>
            <Amount>0</Amount>
            <Name>String</Name>
            <Rate>0</Rate>
          </DealTax>
        </UpfrontTaxes>
      </LeaseInfo>
      <Notes>String</Notes>
      <PaymentDate>0001-01-01T00:00:00</PaymentDate>
      <PaymentTerm>0</PaymentTerm>
      <PaymentsPerYear>0</PaymentsPerYear>
      <Price>0</Price>
      <ProspectRef>00000000-0000-0000-0000-000000000000</ProspectRef>
      <Protections>
        <DealProtection>
          <Cost>0</Cost>
          <Name>String</Name>
          <Price>0</Price>
        </DealProtection>
      </Protections>
      <Rebates>
        <DealRebate>
          <Amount>0</Amount>
          <CertificateNumber>String</CertificateNumber>
          <Code>String</Code>
          <Description>String</Description>
        </DealRebate>
      </Rebates>
      <SaleType>String</SaleType>
      <SerialNumber>String</SerialNumber>
      <Status>String</Status>
      <SystemDeliveryDate>0001-01-01T00:00:00</SystemDeliveryDate>
      <TaxCode>String</TaxCode>
      <Trades>
        <DealTrade>
          <ActualCashValue>0</ActualCashValue>
          <Allowance>0</Allowance>
          <Capitalized>0</Capitalized>
          <Lien>0</Lien>
          <LienHolder>
            <Address>String</Address>
            <City>String</City>
            <Name>String</Name>
            <Phone>String</Phone>
            <Postal>String</Postal>
            <Province>String</Province>
          </LienHolder>
          <Odometer>0</Odometer>
          <Upfront>0</Upfront>
          <VIN>String</VIN>
          <VehicleRef>00000000-0000-0000-0000-000000000000</VehicleRef>
        </DealTrade>
      </Trades>
      <UserRoles>
        <DealUserRole>
          <EmployeeRef>00000000-0000-0000-0000-000000000000</EmployeeRef>
          <Name>String</Name>
          <Primary>false</Primary>
          <Role>String</Role>
        </DealUserRole>
      </UserRoles>
      <VehicleInsurance>
        <Address>String</Address>
        <Agent>String</Agent>
        <City>String</City>
        <Collision>0</Collision>
        <Comprehensive>0</Comprehensive>
        <Fax>String</Fax>
        <InsuranceCompany>String</InsuranceCompany>
        <Liability>0</Liability>
        <Phone>String</Phone>
        <PolicyEffective>String</PolicyEffective>
        <PolicyExpiry>String</PolicyExpiry>
        <PolicyNumber>String</PolicyNumber>
        <PostalCode>String</PostalCode>
        <Province>String</Province>
        <SaleNumber>String</SaleNumber>
      </VehicleInsurance>
      <Vehicles>
        <DealVehicle>
          <Cost>0</Cost>
          <IsNewVehicle>false</IsNewVehicle>
          <SaleOdometer>0</SaleOdometer>
          <StockNumber>String</StockNumber>
          <VIN>String</VIN>
          <VehicleRef>00000000-0000-0000-0000-000000000000</VehicleRef>
        </DealVehicle>
      </Vehicles>
      <Warranties>
        <DealWarranty>
          <CompanyName>String</CompanyName>
          <Cost>0</Cost>
          <CoveragePlan>String</CoveragePlan>
          <Date>String</Date>
          <Deductible>0</Deductible>
          <Description>String</Description>
          <Expiry>String</Expiry>
          <Mileage>0</Mileage>
          <PolicyNumber>String</PolicyNumber>
          <Price>0</Price>
          <Term>0</Term>
          <Type>String</Type>
        </DealWarranty>
      </Warranties>
    </Deal>
  </Deals>
</DealGetResponse>

    </soap12:Body>
</soap12:Envelope>