Path Parameters
HTTP Header
api-key REQUIRED string - Your Accelerate API Key
cutoff-months OPTIONAL integer (positive) - Reduces the dada set to only include ranges with at least one derivative current in the last X months | URL Substitution
subdomain REQUIRED
asset type - REQUIRED string - CAR or LCV. Must be uppercase
Page - REQUIRED integer - Starting from 1 increment the page number until an empty response is received |
Deals Requests
GET - Returns deal data sourced from active ratebooks loaded to Accelerate.
https://{{subdomain}}.quotevineapp.com/qvine/quotevine/web/v1/alldeals/{asset-type}/{page}/
Response
400 Returned if the request sent is invalid. | 404 Returned if the request is not found or the user does not have permission to view it. |
200
Expand to see example 26539333 44432 CH0124020000N CH 1 24 20000N 686.06 686.06 686.06NN Hitachi Capital Vehicle Solutions New Hitachi TestYN 4.97 |
Deals Attributes
When retrieving deals via the API, there are a number of fields needed.
Returned Fields
Expand to view the returned fields.
Expand to view the returned fields.
id - integer
Accelerate ratebook entry ID.
vehicle_id - integer
CAP derivative ID.
ref - string
See profile reference.
product_type_id - string
The product type abbreviation E.g. CH, PCH.
initial_rentals - integer
The number of initial rentals.
term - integer
The term in months.
annual_mileage - integer
The annual mileage allowance.
maintenance_flag - string
Whether or not maintenance is included. Either Y or N.
finance_rental - numeric
The monthly rental not including any maintenance payment.
monthly_rental - numeric
The monthly rental including any maintenance payment.
maintenance_payment - numeric
The monthly maintenance payment if applicable.
initial_payment - numeric
The amount of the initial payment e.g. initial_rentals x monthly_rental
featured_flag - string
Whether or not flagged as featured in Accelerate. Either Y or N.
in_stock_flag - string
Whether or not flagged as in stock in Accelerate. Either Y or N.
doc_fee - string
Documentation fee.
lender_name - string
The name of the lender supplying the deal.
ratebook_name - string
The filename of the ratebook containing this deal, when uploaded to Accelerate.
best_deal_flag - string
Whether or not this deal is the cheapest deal of this profile for this derivative.
model_best_deal_flag - string
Whether or not this deal is the cheapest deal of this profile for this model.
Profile reference
Info: A profile reference encapsulates key profile data in a single string. It is useful for incorporating into URLs.
A profile reference uses the following format:
product_type_id + initial_payments (0 left padded to 2 chars) + term (0 left padded to 2 chars) + annual_mileage (0 left padded to 6 chars) + maintenance_flag
Therefore a deal with the reference: PCH0936008000N, Would have the following profile:
Product Type: PCH (Personal Contract Hire) + Initial Rentals: 9 + Term: 36 months + Annual Mileage: 8,000 + Maintenance: No