Skip to main content

Proposal Object v2

This guide details Accelerate Proposal Object v2 API, enabling you to create and manage proposals for relationships programmatically.

Tom White avatar
Written by Tom White
Updated over 6 months ago

Path Parameters

HTTP Header

api-key - REQUIRED
string - Your Accelerate API Key

URL Substitution

subdomain REQUIRED
string - Your Accelerate subdomain

relationship ID REQUIRED
integer - ID of your chosen relationship

Proposal Requests

GET POST - Retrieve proposals from a relationship or add a new proposal to a relationship. 

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/proposals/

Example Payload

POST

{
"legal_form:"Private Individual",
"forename":"Matt", 
"surname':"Sullivan",
"email_address":"[email protected]",
"date_of_birth":"30-10-2001",
"dependents":"0",
"credit_card_count":"2", 
"replace_finance_flag":"N", 
"circumstance_change_flag":"N",
"info_notice_accepted_date":"N"
}

Response

200
Returned if the request is successful.

Expand to see example of a successful response.

{
"items": [
    {
        "legal_form:"Private Individual",
        "forename":"Matt", 
        "surname':"Sullivan",
        "email_address":"[email protected]",
        "date_of_birth":"30-10-2001",
        "dependents":"0",
        "credit_card_count":"2", 
        "replace_finance_flag":"N", 
        "circumstance_change_flag":"N",
        "info_notice_accepted_date":"N",
        ...
     }
  ]
}

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.

Proposal Attributes

When updating/adding a new proposal via the API, there are a number of fields needed.

Personal Proposal Attributes

Mandatory fields

Expand to view the mandatory fields

legal_form - string

Must be private individual

forename - string

surname - string

email_address - string

date_of_birth - string

dependents - number

Must be between 0 and 10

credit_card_account - number

Must be between 0 and 20

replace_finance_flag - string

Y or N

circumstance_change_flag - string

Y or N

info_notice_accepted_flag - string

Y or N

info_notice_accepted_date - date

If info_notice_accepted_flag = Y, this field is mandatory.

Non Mandatory Fields

Expand to view all non- mandatory fields that can be used.

proposal_id - number

Must not be supplied when using post.

title - string

Must be one of Miss, Ms, Doctor, Reverend, Professor, Captain, Major, Sir, Lady, Father, Lieutenant, Lieut Col, Lieut Com, Flight Lt, Lord, Honourable, Judge, Bishop, Brigadier, Canon, Colonel, Commander, Corporal, Count, Countess, Group Capn, Major Genl, Pastor, Rabbi, Prince, Princess, Rev Canon, Rev Doctor, Sergeant, Sister, Mr, Mrs.

middle_name - string

mobile_number - string

marital_status - string

Must be one of In Relationship, Married, Single, Widowed

gross_annual_income - number

net_income - number

Monthly net income

other_income_net - number

partners_income_net - number

exp_mortgage - number

exp_endowment - number

exp_council_tax - number

exp_credit_cards - number

exp_secured_loans - number

exp_unsecured_loans - number

exp_utilities - number

exp_insurances - number

exp_child_care - number

exp_child_support - number

exp_pension - number

exp_food_and_drink - number

exp_telephone_tv_net - number

exp_travel - number

exp_vehicle_agreement - number

exp_other - number

sort_code - string

account_number - string

bank_name - string

bank_account_name - string

bank_address_1 - string

bank_address_2 - string

bank_town - string

bank_postcode - string

bank_year_opened - number

Year as four digit integer

user_agent - string

ip_address - string

Business Proposal Attributes

Mandatory Fields

Expand to view the mandatory fields

legal_form - string

Must be one of LLP, Limited Company, Micro Enterprise, Partnership 4+, Partnership <4, PLC, Registered Charity, Sole Trader

business_name - string

nature_of_business - string

vat_registered_flag - string

Y or N

trading_property - string

trading_town - string

trading_postcode - string

replace_finance_flag - string

Y or N

circumstance_change_flag - string

Y or N

info_notice_accepted_flag - string

Y or N

info_notice_accepted_date - date

if info_notice_accepted_flag = Y this field is mandatory

Non Mandatory fields

Expand to view all non- mandatory fields that can be used.

proposal_id - number

Must not be supplied when using post

company_reg_no - string

established_date - date

vat_reg_no - string

website_url - string

annual_turnover - string

business_telephone_number - string

partner_count - number

employee_count - number

fleet_size_car - number

fleet_size_lcv - number

trading_street - string

trading_locality - string

registered_property - string

registered_street - string

registered_locality - string

registered_town - string

registered_postcode - string

sort_code - string

account_number - string

bank_name - string

bank_account_name - string

bank_address_1 - string

bank_address_2 - string

bank_town - string

bank_postcode - string

bank_year_opened - string

Year as a four digit integer

user_agent - string

ip_address - string

Related Articles
Relationships v2
Relationships Search v2
Driver Object v2
Contact Object v2
Search Proposals v2
Did this answer your question?