PartnerHub

<back to all web services

DealChange

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

HTTP + CSV

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

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

DealInfo,IsAsynchronous,UserRequest,UserRef
"{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-01,ContractDate:0001-01-01,PaymentDate:0001-01-01,DeliveryDate:0001-01-01,SystemDeliveryDate:0001-01-01,SoldDate:0001-01-01,DeliveryStepsCompleted:[String],Conditions:String,Status:String,SaleType:String,TaxCode:String,Notes:String,AmortizationTerm:0,PaymentTerm:0,PaymentTermMonths:0,PaymentsPerYear:0,Price:0,BuyerRef:00000000000000000000000000000000,CoBuyerRefs:[00000000000000000000000000000000],LastUpdate:0001-01-01,Fees:[{Name:String,Amount:0,Capitalized:False,Cost:0,GrossType:String,OEMType:String}],Accessories:[{Code:String,Description:String,Price:0,Cost:0,Residual:0,MaxResidual:0,Capitalized:False,GrossType:0}],Warranties:[{Code:String,Type:String,OEMType:String,OEMProductType:String,CompanyName:String,CoveragePlan:String,Description:String,Price:0,Cost:0,Term:0,Deductible:0,PolicyNumber:String,Mileage:0,Date:0001-01-01,Expiry:0001-01-01,Residual:0}],Protections:[{Name:String,Price:0,Cost:0,Capitalized:False,Provider:String,TermMonths:0,Residual:0,OEMType:String,OEMProductType:String}],Insurance:[{Code:String,Description:String,Coverage:String,NumberOfPayments:0,Premium:0,Cost:0,PolicyNumber:String,RetroDays:String,Provider: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},OwnershipType:String,HasMaxTradeCredit:False}],Rebates:[{Code:String,Description:String,Amount:0,CertificateNumber:String,UpFrontAmount:0,CapitalizedAmount:0}],Allowances:[{Code:String,Description:String,Amount:0,CapitalizedAmount:0,UpfrontAmount:0,CertificateNumber:String}],BackEndAllowances:[{Code:String,Description:String,Amount:0,CapitalizedAmount:0,UpfrontAmount:0,CertificateNumber:String}],Adjustments:[{Description:String,Amount:0,Upfront:0,Capitalized:0,AdjustmentType:Price}],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,EffectiveRate:0,PaymentsPerYear:0,PaymentTerm:0,PaymentTermMonths: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,EffectiveRate:0,PaymentsPerYear:0,PaymentTerm:0,PaymentTermMonths: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}],LeadRef:String,LeadSource:String,LeadType:String,ProspectType:String,StatusInfo:[{StatusRef:0,StatusName:String,StatusSystemType:String,UserRef:00000000000000000000000000000000,UserName:String,IsSelected:False,EffectiveDate:0001-01-01}],SystemStatus:String,DealInterestType:String,DealCommissions:0,DealActivityInfo:[{Id:00000000000000000000000000000000,ActivityRef:00000000000000000000000000000000,ActivityName:String,ActivityCategory:Phone,ResultRef:00000000000000000000000000000000,ResultName:String,GreeterRef:00000000000000000000000000000000,GreeterName:String,SalesRepRef:00000000000000000000000000000000,SalesRepName:String,ManagerRef:00000000000000000000000000000000,ManagerName:String,SalesSteps:[{SalesStepRef:0,SalesStepName:String,SalesStepOrder:0}],CreatedDate:0001-01-01,EngagementDate:0001-01-01,ActionedDate:0001-01-01,Notes:String,IsDeleted:False}],CashOnDelivery:0,APR:0}",False,String,00000000000000000000000000000000

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

WasSuccessful,Message,ReferenceId,ReferenceNumber
False,String,String,String