PushDeals

Pushes deal structure and cobuyers. Adds additional data to the record created by PushProspects.

Request Information

Parameters

Collection of DealPushRequest
NameDescriptionTypeAdditional information
StoreId

API identifier of the store for this deal.

integer

Required

DealKey

The API DealKey of an existing Prospect/Deal to update. To get the DealKey, either: (1) create a new Prospect with PushProspects and use the PushedRecordKey from the push response as DealKey; or (2) call PullDeals and use the DealKey from the pull response to update an existing Deal.

string

Required

InventoryKey

API identifier of the stock vehicle. Use either InventoryKey or StockNumber to assign a vehicle.

string

StockNumber

Dealer stock number of the stock vehicle. Use either InventoryKey or StockNumber to assign a vehicle.

string

CustomerDriverLicense

DriversLicense

TradeIns

Trade-in numbers for this deal: allowance, ACV, and payoff. To push trade vehicle data, use PushAppraisals.

Collection of TradeInPushRequest

ExternalDealId

Optional integrator identifier for this record. The ExternalProspectId is echoed in the push response, but isn't stored. When pushing multiple records in one request, it can be useful for matching push responses to push requests.

string

SalesNumber

Employee number of the sales person.

string

SalesNumber2

Employee number of the second sales person.

string

SalesManagerNumber

Employee number of the sales manager.

string

Cobuyer

Cobuyer's personal information.

CobuyerInfo

DealType

Deal type: lease, finance, cash, etc.

DealType

Msrp

Manufacturer's suggested retail price. If null or zero, the MSRP is calculated from the SellingPrice: MSRP = SellingPrice - HardAdds. If both MSRP and SellingPrice are populated, the deal's discount is calculated as: Discount = (MSRP + HardAdds - SellingPrice) * -1.

MonetaryValue

SellingPrice

Selling price. Includes hard adds (sum of DealPushRequest.HardAdds[].Price). Does not include soft adds, incentives, rebates, insurance products, or other products. If both MSRP and SellingPrice are populated, the deal's discount is calculated as: Discount = (MSRP + HardAdds - SellingPrice) * -1.

MonetaryValue

TaxableSalesAmount

MonetaryValue

CashDownPayment

MonetaryValue

Lease

Deal structure and tax/fee data for lease deals.

LeaseInfo

Finance

Deal structure and tax/fee data for retail deals.

BuyInfo

ContractDate

date

TermMonths

Finance/lease term in months.

integer

Rate

Interest rate percent, formatted like "16.9". For finance, flex-buy, and balloon deals.

decimal number

BuyRate

Buy rate percent, formatted like "16.9". For finance, flex-buy, and balloon deals.

decimal number

DaysToFirstPayment

Days from contract date to first payment date. For finance, flex-buy, and balloon deals. If zero, the value is taken from the store's setup for new Deal records and unchanged for existing Deal records.

integer

ResidualPercentage

Residual percentage, formatted like "59.5".

decimal number

ResidualAmount

MonetaryValue

BaseResidualAmount

MonetaryValue

LenderCode

Dealer-defined code for the lender.

string

SoftAdds

Non-residualized accessories.

Collection of SoftAdd

HardAdds

Residualized accessories.

Collection of HardAdd

Rebates

Collection of Rebate

ServiceContracts

Collection of SaleServiceContract

Incentives

Collection of Incentive

MileageResidualAdjustPercent

decimal number

EstimatedPayment

MonetaryValue

Mrm

Maximum Residualized MSRP.

MonetaryValue

InsuranceProducts

Collection of InsuranceProduct

WaiveFeesAndTaxes

Is the dealer waiving fees and taxes for this Deal?

boolean

FinanceCharge

MonetaryValue

FinanceManagerNumbers

Employee numbers of the finance managers.

Collection of string

Max length: 2

PrepaidFinanceChargeAmount

MonetaryValue

ProtectionPackages

Collection of ProtectionPackage

ReturnDealFlag

boolean

VehicleId

integer

ProductDetails

ServiceProduct

FinanceReserve

MonetaryValue

Sample Request

Response Information

Resource Description

Collection of StorePushResponse
NameDescriptionTypeAdditional information
StoreId

integer

PushedDeal

Deal

PushedRecordKey

string

PushResult

PushResult

Message

string

ExternalRecordId

string

Sample Response