Skip to main content

Contract Object v2

A technical guide to retrieving, adding, and updating contracts in Accelerate via API v2.

Funmilola Olorode avatar
Written by Funmilola Olorode
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

contract ID OPTIONAL
integer - ID of your chosen contract

Contract Requests

GET PUT POST

GET POST - Return all contracts in a relationship or insert a new relationship into a contract.

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

Example Payload

POST

{
    "relationship": "James Michaels",
    "relationship_id": 2300191,
    "relationship_reference": "2300191",
    "vehicle_order_id": 154706,
    "proposal_id": 20295213,
    "lender":"1pm",
    "dealer_funded_flag": "N",
    "product_type": "Personal Contract Hire",
    "finance_product": "PCH",
    "finance_product_id": 30068,
    "payment_method": null,
    "first_payment_method": null,
    "term": 36,
    "term_unit_id": "MTH",
    "pause_type": "Spread (n+term-1)",
    "frequency": "Monthly",
    "initial_payments": 3,
    "initial_payment": 0,
    "informal_extension_flag": "N",
    "formal_extension_flag": "N",
    "early_termination_flag": "N",
    "maintenance_flag": "N",
    "tyres_flag": "N",
    "glass_flag": "N",
    "relief_vehicle_flag": "N",
    "recovery_flag": "N",
    "other_service_flag": "N",
    "inception_date": "2022-08-05",
    "finance_payment": 600,
    "contract_value": 21600,
    "amount_financed": 19529.47,
    "renewed_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
Returned if the request is successful.

Expand to see example of a successful response.

{
    "items": [
        {
            "contract_id": 521415,
            "portfolio": null,
            "portfolio_id": null,
            "introducer": null,
            "introducer_id": null,
            "relationship": "James Michaels",
            "relationship_id": 2300191,
            "relationship_reference": "2300191",
            "invoice_flag": "N",
            "suppress_auto_contact_flag": "N",
            "brand": "Example Dev",
            "brand_id": 59308,
            "vehicle_order_id": 154706,
            "proposal_id": 20295213,
            "asset_description": "ALFA ROMEO GIULIETTA HATCHBACK 1.4 TB 5dr",
            "loan_purpose": null,
            "contract_number": "20295213/101/C",
            "contract_status": "Test1",
            "lender": null,
            "dealer_funded_flag": "N",
            "funder_reference": null,
            "product_type": "Personal Contract Hire",
            "finance_product": "PCH",
            "finance_product_id": 30068,
            "payment_method": null,
            "first_payment_method": null,
            "term": 36,
            "term_unit_id": "MTH",
            "pause_type": "Spread (n+term-1)",
            "frequency": "Monthly",
            "initial_payments": 3,
            "initial_payment": 0,
            "informal_extension_flag": "N",
            "formal_extension_flag": "N",
            "early_termination_flag": "N",
            "maintenance_flag": "N",
            "tyres_flag": "N",
            "glass_flag": "N",
            "relief_vehicle_flag": "N",
            "recovery_flag": "N",
            "other_service_flag": "N",
            "inception_date": "2022-08-05",
            "finance_payment": 600,
            "contract_value": 21600,
            "amount_financed": 19529.47,
            "residual_value": 0,
            "balloon_payment": null,
            "interest": null,
            "renewed_flag": "N",
            "settlement_method": null,
            ...
        }
    ],
    "first": {
        "$ref": "https://example.quotevineapp.com/qvine/quotevine/api/v2/relationships/2300191/contracts/"
    }
}

GET PUT - Return one specific contract from a relationship or update and existing contract on a relationship

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

Example Payload

PUT

{
    "vehicle_order_id": 154706,
    "proposal_id": 20295213,
    "lender":"1pm",
    "dealer_funded_flag": "N",
    "product_type": "Personal Contract Hire",
    "finance_product": "PCH",
    "finance_product_id": 30068,
    "term": 36,
    "term_unit_id": "MTH",
    "pause_type": "Spread (n+term-1)",
    "frequency": "Annual",
    "informal_extension_flag": "N",
    "formal_extension_flag": "N",
    "early_termination_flag": "N",
    "maintenance_flag": "N",
    "tyres_flag": "N",
    "glass_flag": "N",
    "relief_vehicle_flag": "N",
    "recovery_flag": "N",
    "other_service_flag": "N",
    "finance_payment": 600,
    "renewed_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
Returned if the request is successful.

Expand to see example of a successful response.

{
  "contract_id": 521415,
  "portfolio": null,
  "portfolio_id": null,
  "introducer": null,
  "introducer_id": null,
  "relationship": "James Michaels",
  "relationship_id": 2300191,
  "relationship_reference": "2300191",
  "invoice_flag": "N",
  "suppress_auto_contact_flag": "N",
  "brand": "Example Dev",
  "brand_id": 59308,
  "vehicle_order_id": 154706,
  "proposal_id": 20295213,
  "asset_description": "ALFA ROMEO GIULIETTA HATCHBACK 1.4 TB 5dr",
  "loan_purpose": null,
  "contract_number": "20295213/101/C",
  "contract_status": "Test1",
  "lender": null,
  "dealer_funded_flag": "N",
  "funder_reference": null,
  "product_type": "Personal Contract Hire",
  "finance_product": "PCH",
  "finance_product_id": 30068,
  "payment_method": null,
  "first_payment_method": null,
  "term": 36,
  "term_unit_id": "MTH",
  "pause_type": "Spread (n+term-1)",
  "frequency": "Annual",
  "initial_payments": 3,
  "initial_payment": 0,
  "informal_extension_flag": "N",
  "formal_extension_flag": "N",
  "early_termination_flag": "N",
  "maintenance_flag": "N",
  "tyres_flag": "N",
  "glass_flag": "N",
  "relief_vehicle_flag": "N",
  "recovery_flag": "N",
  "other_service_flag": "N",
  "inception_date": "2022-08-05",
  "finance_payment": 600,
  "contract_value": 21600,
  "amount_financed": 19529.47,
  "residual_value": 0,
  "balloon_payment": null,
  "interest": null,
  "renewed_flag": "N",
  "settlement_method": null,
  ...
}

Contract Attributes

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

Mandatory Fields

Expand to see the list of mandatory fields

amount_financed - number
Amount financed

dealer_funded_flag - string
Y or N

contract_number - string

finance_product_id - integer
The ID of the finance product for the contract.

lender - string
Must be an exact match to the name of one of the funders in Accelerate.

term - number
Must be between 1 and 72

term_unit_id - string
MTH for monthly or DLY for Daily

pause_type - string
Spread (n+term-1) or Terminal (n+term-n)

frequency - string
Must be one of Monthly, Quarterly, Bi-annual, Annual

informal_extension_flag - string
Y or N

formal_extension_flag - string
Y or N

early_termination_flag - string
Y or N

inception_date - date
Date contract starts in YYYY-MM-DD format

finance_payment - number

maintenance_flag - string
Y or N

tyres_flag - string
Y or N

glass_flag - string
Y or N

recovery_flag - string
Y or N

other_service_flag - string
Y or N

relief_vehicle_flag - string
Y or N

Non Mandatory Fields

Expand to see the list of non-mandatory fields.

contract_id - number
PK for this contract. Must not be supplied when using POST or PUT .

portfolio - string
The name of the portfolio to which this contract belongs. Must not be supplied when using POST or PUT .

portfolio_id - integer
The ID of the portfolio to which this contract belongs.

introducer - string
The name of the introducer that introduced this contract. Must not be supplied when using POST or PUT .

introducer_id - integer
The ID of the introducer that introduced this contract.

relationship - string
The name of the relationship that is party to this contract. Must not be supplied when using POST or PUT .

relationship_id - integer
The ID of the relationship that is party to this contract.

relationship_reference - string
The reference of the relationship that is party to this contract. Must not be supplied when using POST or PUT .

relationship_reference_2 - string

The secondary reference of the relationship that is party to this contract. Must not be supplied when using POST or PUT .

invoice_flag - boolean
Whether this contract should be part of the automated invoice run.

invoice_email_address - string
The email address invoices for this contract should be sent to.

suppress_auto_contact_flag - boolean
If Y then automated communications triggered by actions will not be sent for this contract.

brand - string
The name of the brand to which this contract belongs. Must not be supplied when using POST or PUT .

brand_id - string
The ID of the brand to which this contract belongs.

vehicle_order_id - integer
The ID of the vehicle order that spawned this contract. Will be null for asset finance contracts.

proposal_id - integer
The ID of the proposal that spawned this contract.

asset_description - string
Description of the asset(s) related to the contract. Must not be supplied when using POST or PUT .

loan_purpose - string
For loan contracts only.

contract_status - string
Must be an exact match to one of the configured contract statuses.

funder_reference - string

funder_doc_fee - number

funder_otp_fee - number

product_type - string
The base product type of the attached finance product. Must not be supplied when using POST or PUT .

finance_product - string
The name of the finance product for the contract. Must not be supplied when using POST or PUT .

payment_method - string
Payment method for regular payments.

first_payment_method - string
Payment method for the first payment.

initial_payments - number
Must be between 1 and 12. Must not be specified if deposit_amount is specified

initial_payment - number
Must not be specified if initial_payments is specified

maturity_date - date
Date contract ends in YYYY-MM-DD format

extension_end_date - date
Date contract extension ends in YYYY-MM-DD format

termination_date - date
Date contract was early terminated in YYYY-MM-DD format

renewal_date - date
Date contract was renewed YYYY-MM-DD format

renewal_loss_date - date
Date contract renewal was lost to a competitor in YYYY-MM-DD format

annual_mileage - number
Must be a whole number > 0

excess_milage - number
pence per mile

excess_mileage_2 - number

excess_mileage_step - number

residual_value - number

pause_type - string
Must be one of Spread, Terminal

rfl_included_months - number

maintenance_payment - number

excess_mileage_m - number

excess_mileage_m_2 - number

tyres_payment - number

glass_payment - number

relief_vehicle_payment - number

recovery_payment - number

other_service_payment - number

other_service_description - string
If other_service_payment > 0

total_payment - number

payment_day - integer
Day (1-28) for regular payments

contract_value - number
Total value of the contract

goods_cost - number
Total cost of all goods on the contract

deposit - number
Deposit amount

settlement_amount - number

The amount of any settlement to be added to the amount financed.

trade_in_amount - number

The amount contributed by any trade-in.

residual_value - number
The anticipated residual value of the asset(s) at inception

balloon_payment - number
The balloon payment if applicable

interest - number
Total interest payable on the contract

commissions - number
Total commissions payable on the contract

subsidies - number
Total subsidies applied to the contract

fees - number
Total fees payable on the contract

funding_rate - number
The rate the contract is being funded at

customer_rate - number
The rate the customer is paying

rate_type - string
Nominal or Flat

net_rate - number
The customer rate excluding commissions

gross_rate - number
The customer rate including commissions

apr - number

settlement_method - string
If the contract was settled, which method was used.

creation_date - date
The date the record was created. Must not be supplied when using POST or PUT .

last_update_date - date
The date the record was last updated. Must not be supplied when using POST or PUT .


​

Related Articles
Quote Object v2
Driver Object v2
Contact Object v2
Cashflow Object v2
Asset Object v2
Did this answer your question?