Path Parameters
HTTP Header
api-key REQUIRED string - Your Accelerate API Key | URL Substitution
subdomain REQUIRED
relationship ID REQUIRED
opportunity ID REQUIRED
quote ID OPTIONAL |
Quote Requests
GET POST PUT
GET POST - Retrieve all quotes from an opportunity or add a quote to an opportunity.
https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/opportunities/{id}/quotes/
Example Payload
POST
{
"quote_status": "New",
"dealer_funding_flag": "Y",
"asset_type": "CAR",
"cap_id": 74468,
"product_type": "Business Contract Hire",
"frequency": "Monthly",
"term": 48,
"extension_flag": "N",
"annual_mileage": 8000,
"monthly_payment_finance": 471.16,
"monthly_payment_maintenance": 0,
"create_cashflows_flag": "N"
}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 of a successful response. { |
GET PUT - Retrieve or update an existing quote from an opportunity.
https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/opportunities/{id}/quotes/{id}/
Example Payload
PUT
{
"quote_status": "Submitted",
"dealer_funding_flag": "N",
"frequency": "Monthly",
"term": 36,
"extension_flag": "N",
"annual_mileage": 8000,
"monthly_payment_finance": 395,
"monthly_payment_maintenance": 25,
"create_cashflows_flag": "N"
}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 of a successful response. { |
Quote Attributes
When updating/adding a new quote via the API, there are a number of fields needed.
Mandatory Fields
Expand to view the mandatory fields
Expand to view the mandatory fields
quote_status - string
Must be one of your custom Quote/Proposal statuses. If you leave this blank it will default to your Quote/Proposal status with the lowest ordinal.
dealer_funding_flag - string
Y or N
frequency - string
Must be one of Monthly, Quarterly, Bi-annual, Annual
term - number
Must be between 1 and 72
extension_flag - string
Y or N
monthly_payment_finance - number
Amount paid monthly
other_service_description - string
This field is only mandatory if monthly_payment_other_service > 0
create_cashflows_flag - string
Y or N - Only on POST . Indicates if the default cashflows should be created when the quote is inserted.
Non Mandatory Fields
Expand to see all non mandatory fields that can be used
Expand to see all non mandatory fields that can be used
quote_id - number
Must not be supplied when using POST or PUT .
driver_id - number
Must be a driver ID related to the relationship supplied.
funder - string
Must be one of the funders in Accelerate. Contact support for a current list.
funder_quote_number - string
funder_doc_fee - number
quantity - number
asset_type - string
Must be one of CAR, LCV.
cap_id - number
Must be a valid CAP ID for the given asset_type. You cannot change this value using a PUT .
Note: asset_type and cap_id must be provided for new vehicle quotes.
cap_code - string
Must be 20 characters long. Either cap_code OR asset_type AND cap_id must be supplied. You cannot change this value using a PUT .
dealer_otr_override - number
Override the OTR for dealer invoicing purposes.
cca_status - number
Must be one of Regulated, Non-regulated; High net worth, Non-regulated; Business use.
finance_product_id - number
Must be the numeric ID of a finance product you have configured in Accelerate.
Note: at least one of finance_product_id and product_type must be passed.
product_type - string
Must be one of Cash, Conditional Purchase, Contract Hire, Contract Purchase, Finance Lease, Hire Purchase, Lease Purchase, Personal Contract Hire, Personal Contract Purchase.
Note: if you have multiple finance products configured with the same finance type, if you do not also pass in finance_product_id, the system will assign the first-created finance product of a matching type.
At least one of finance_product_id and product_type must be passed
vat_display_type - string
GET only
frequency - string
Must be one of Monthly, Quarterly, Bi-annual, Annual.
initial_payment_multiple - number
Must be between 1 and 12. Must not be specified if deposit_amount is specified
deposit_amount - number
Must not be specified if initial_payment_multiple is specified.
term - number
Must be between 1 and 72.
extension_flag - string
Y or N
rfl_included - string
Must be one of None, First Year or Full Term
annual_mileage - number
Must be a whole number > 0
monthly_payment_finance - number
monthly_payment_maintenance - number
monthly_payment_tyres - number
monthly_payment_glass - number
monthly_payment_relief_vehicle - number
monthly_payment_recovery -number
monthly_payment_other_service - number
other_service_description - string
excess_mileage - number
Pence per mile
excess_mileage_2 - number
excess_mileage_m -number
excess_mileage_m_2 - number
final_payment - number
pause_type - number
Must be one of Spread, Terminal
target_delivery_date - string
Must be fewer than 50 characters.
Note that this does not have to be a date, could be e.g. 'By the end of February'.
create_cashflows_flag - string
Y or N - Only on POST . Indicates if the default cashflows should be created when the quote is inserted.
proposal_url - string
QV Apply URL unique to this relationship and quote. Only populated if the client is set up with QV Apply.
acceptance_date - date
salsac_gross_deduction - number
salsac_net_impact - number