PartnerHub

<back to all web services

DealChange

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/DealChange HTTP/1.1 
Host: partnerhub.pbsdealers.com 
Content-Type: application/json
Content-Length: length

{"DealInfo":{"Id":"string/00000000-0000-0000-0000-000000000000","DealId":"00000000000000000000000000000000","SerialNumber":"String","DealKey":"String","DealType":"String","UserRoles":[{"EmployeeRef":"00000000000000000000000000000000","Name":"String","Primary":false,"Role":"String"}],"CreationDate":"0001-01-01T00:00:00.0000000Z","ContractDate":"0001-01-01T00:00:00.0000000Z","PaymentDate":"0001-01-01T00:00:00.0000000Z","DeliveryDate":"0001-01-01T00:00:00.0000000Z","SystemDeliveryDate":"0001-01-01T00:00:00.0000000Z","DeliveryStepsCompleted":["String"],"Conditions":"String","Status":"String","SaleType":"String","TaxCode":"String","Notes":"String","AmortizationTerm":0,"PaymentTerm":0,"PaymentsPerYear":0,"Price":0,"BuyerRef":"00000000000000000000000000000000","CoBuyerRefs":["00000000000000000000000000000000"],"LastUpdate":"0001-01-01T00:00:00.0000000Z","Fees":[{"Name":"String","Amount":0,"Capitalized":false}],"Accessories":[{"Code":"String","Description":"String","Price":0,"Cost":0,"Residual":0}],"Warranties":[{"Type":"String","CompanyName":"String","CoveragePlan":"String","Description":"String","Price":0,"Cost":0,"Term":0,"Deductible":0,"PolicyNumber":"String","Mileage":0,"Date":"String","Expiry":"String"}],"Protections":[{"Name":"String","Price":0,"Cost":0}],"Insurance":[{"Code":"String","Description":"String","Coverage":"String","NumberOfPayments":0,"Premium":0,"Cost":0,"PolicyNumber":"String","RetroDays":"String"}],"Trades":[{"VehicleRef":"00000000000000000000000000000000","VIN":"String","Allowance":0,"Lien":0,"Capitalized":0,"Upfront":0,"ActualCashValue":0,"Odometer":0,"LienHolder":{"Name":"String","Phone":"String","Address":"String","City":"String","Province":"String","Postal":"String"}}],"Rebates":[{"Code":"String","Description":"String","Amount":0,"CertificateNumber":"String"}],"Allowances":[{"Code":"String","Description":"String","Amount":0,"CertificateNumber":"String"}],"Adjustments":[{"Description":"String","Amount":0}],"Vehicles":[{"VehicleRef":"00000000000000000000000000000000","StockNumber":"String","VIN":"String","IsNewVehicle":false,"SaleOdometer":0,"Cost":0}],"VehicleInsurance":{"Agent":"String","Address":"String","City":"String","Province":"String","PostalCode":"String","Phone":"String","Fax":"String","InsuranceCompany":"String","SaleNumber":"String","PolicyNumber":"String","PolicyEffective":"String","PolicyExpiry":"String","Collision":0,"Comprehensive":0,"Liability":0},"CashInfo":{"MSRP":0,"Taxes":[{"Name":"String","Rate":0,"Amount":0}],"Deposit":0,"DueOnDelivery":0},"FinanceInfo":{"MSRP":0,"Deposit":0,"CashOnDelivery":0,"Bank":"String","BankInfo":{"Code":"String","Name":"String","Address":"String","Phone":"String","Fax":"String","City":"String","State":"String","ZipCode":"String","BankNumber":"String"},"Rate":0,"PaymentsPerYear":0,"PaymentTerm":0,"AmortizationTerm":0,"Balloon":0,"BalanceToFinance":0,"FinanceCharges":0,"TotalBalanceDue":0,"PaymentBase":0,"PaymentTaxes":[{"Name":"String","Rate":0,"Amount":0}],"Payment":0,"Term":0,"APR":0},"LeaseInfo":{"MSRP":0,"CapTaxes":[{"Name":"String","Rate":0,"Amount":0}],"CapSettings":[{"Name":"String","Rate":0,"LeaseCapitalized":false,"TradeCapitalized":false,"RebateCapitalized":false,"CodCapitalized":false}],"CapCost":0,"CashOnDelivery":0,"CapReduction":0,"NetLease":0,"ResidualPercent":0,"ResidualAmount":0,"InceptionMilesAllowed":0,"InceptionMileageRate":0,"InceptionMileageIncluded":false,"MileageCategory":"String","MileageAllowed":0,"MileageExpected":0,"MileageRate":0,"ExcessMileageRate":0,"MileageCharges":0,"ResidualNet":0,"ResidualAdjustment":0,"Depreciation":0,"Bank":"String","BankInfo":{"Code":"String","Name":"String","Address":"String","Phone":"String","Fax":"String","City":"String","State":"String","ZipCode":"String","BankNumber":"String"},"LeaseCalculationModel":"String","Rate":0,"PaymentsPerYear":0,"PaymentTerm":0,"AmortizationTerm":0,"PaymentBase":0,"PaymentTaxes":[{"Name":"String","Rate":0,"Amount":0}],"Payment":0,"UpfrontTaxes":[{"Name":"String","Rate":0,"Amount":0}],"SecurityDeposit":0,"DriveOffLease":0,"PayableOnDelivery":0,"Term":0,"APR":0},"Gross":{"Reserve":{"Amount":0,"BaseRate":0,"MidRate":0,"Factor":0},"VehicleGross":0,"AccessoryGross":0,"FinanceGross":0,"DealGross":0,"Incentives":0},"ProspectRef":"00000000000000000000000000000000","DealTags":[{"KeyName":"String","KeyValue":"String"}],"CashOnDelivery":0,"APR":0},"IsAsynchronous":false,"UserRequest":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"WasSuccessful":false,"Message":"String","ReferenceId":"String"}