Skip to main content

Asset Object v2

A technical guide to retrieving, adding, and updating addresses associated with relationships in Accelerate using 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

asset ID OPTIONAL
integer - ID of your chosen asset

Asset Requests

GET POST DELETE

GET POST - Return all assets or insert a new asset

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/assets/

Example Payload

POST

{
    "asset_class":"Hard Assets - Plant",
    "asset_category":"Cranes"
    "asset_type":"Small Cranes (<15m)",
    "build_date":"2019-01-15",
    "description":"Liebherr mini 450x",
    "serial_number_1":"6473749/B"
}

Response

400
​

Returned if the request sent is invalid.

(Only for POST)

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": [
        {
            "asset_id": 355833,
            "external_reference": "20275213",
            "customer_reference": null,
            "status": null,
            "vat_rate_type": null,
            "vat_qualifying_flag": "Y",
            "net_cost": 28120.83,
            "options_cost": null,
            "services_cost": null,
            "vat": null,
            "otr_grant": null,
            "total_cost": null,
            "p11d_value": 34445,
            "recon_cost": null,
            "transport_cost": null,
            "chassis_number": null,
            "engine_number": null,
            "vin": null,
            "registration_number": null,
            "new_used": "NEW",
            "build_date": null,
            "first_registration_date": null,
            "purchase_date": "2022-07-18",
            "available_from": null,
            "default_offer_price": null,
            "serial_number_1": null,
            "last_known_mileage": 0,
            "last_known_mileage_date": "2022-07-18",
            "last_service_date": null,
            "last_service_mileage": null,
            "owners": 1,
            "mot_expiry_date": "2025-07-21",
            "rfl_expiry_date": "2023-07-21",
            "warranty_expiry_date": null,
            "asset_class": null,
            "asset_category": null,
            "asset_type": null,
            "manufucturer": "JEEP",
            "range": "RENEGADE",
            "model": "RENEGADE HATCHBACK",
            "derivative": "1.3 Turbo 4xe PHEV 190 Limited 5dr Auto",
            "description": "JEEP RENEGADE HATCHBACK 1.3 Turbo 4xe PHEV 190 Limited 5dr Auto",
            "paint_option_code": null,
            "interior_option_code": null,
            "primary_trim_option_code": null,
            "exterior_colour": null,
            "interior_colour": null,
            "primary_trim": null,
            "model_year_reference": "2021",
            "cap_asset_type": "CAR",
            "cap_id": "94033",
            "relationship_id": 2300184,
            "contract_id": 519415,
            "proposal_id": null,
            "vehicle_order_id": 153706,
            "scrapped_flag": "N",
            "exported_flag": "N",
            "imported_flag": "N",
            ...
        }
    ]
}

GET - Return an individual asset

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

Response

200
Returned if the request is successful.

Expand to see example of a successful response

{
    "asset_id": 355858,
    "external_reference": null,
    "customer_reference": null,
    "status": null,
    "vat_rate_type": null,
    "vat_qualifying_flag": "N",
    "net_cost": null,
    "options_cost": null,
    "services_cost": null,
    "vat": null,
    "otr_grant": null,
    "total_cost": null,
    "p11d_value": null,
    "recon_cost": null,
    "transport_cost": null,
    "chassis_number": null,
    "engine_number": null,
    "vin": null,
    "registration_number": null,
    "new_used": "NEW",
    "build_date": null,
    "first_registration_date": "2014-04-19",
    "purchase_date": null,
    "available_from": null,
    "default_offer_price": null,
    "serial_number_1": null,
    "owners": null,
    "mot_expiry_date": null,
    "rfl_expiry_date": null,
    "warranty_expiry_date": null,
    "asset_class": null,
    "asset_category": null,
    "asset_type": null,
    "manufucturer": "VOLKSWAGEN",
    "range": "UP",
    "model": "UP HATCHBACK SPECIAL EDS",
    "derivative": "1.0 Rock Up 3dr",
    "description": "VOLKSWAGEN UP HATCHBACK SPECIAL EDS 1.0 Rock Up 3dr",
    "exterior_colour": "WHI",
    "interior_colour": null,
    "primary_trim": null,
    "model_year_reference": "2014",
    "cap_asset_type": "CAR",
    "cap_id": "60855",
    "relationship_id": 2300191,
    "contract_id": null,
    "proposal_id": null,
    "vehicle_order_id": null,
    "supplier_id": null,
    "px_flag": "N",
    "scrapped_flag": "N",
    "exported_flag": "N",
    "imported_flag": "N",
    "comments": null,
}

404
​

Returned if the request is not found or the user does not have permission to view it.

DELETE - Delete an individual asset

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

Response

204
​

Returned if the deletion is successful.

404
​

Returned if the request is not found or the user does not have permission to view it.

Asset Attributes

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

Vehicle Usage Attributes

Mandatory Fields

Expand to see the list of mandatory fields

cap_asset_type - string
CAR or LCV

cap_id - number
CAR HPI ID

Non Mandatory Fields

Expand to see the list of non-mandatory fields.

relationship_id - number
If you want to link this asset to a relationship, provide the relationship ID in this attribute.

contract_id - number
If you want to link this asset to a contract, provide the contract ID in this attribute. Cannot be supplied unless relationship_id is specified.

proposal_id - number
If you want to link this asset to a quote/proposal, provide the contract ID in this attribute. Cannot be supplied unless relationship_id is specified.

vehicle_order_id - number
If you want to link this asset to a vehicle order, provide the contract ID in this attribute. Cannot be supplied unless relationship_id is specified.

model_year - string

asset_status - string

external_reference - string

customer_reference - string

net_cost - number

options_cost - number

services_cost - number

vat - number

otr_grant - number

total_cost - number

p11d_value - number

recon_cost - number

transport_cost - number

chassis_number - string

engine_number - string

vin - string

registration_number - string

new_used - string

build_date - date

first_registration_date - date

purchase_date - date

available_from - date

default_offer_price - number

last_known_mileage - number

last_known_mileage_date - date

last_service_date - date

last_service_mileage - number

owners - number

mot_expiry_date - date

rfl_expiry_date - date

warranty_expiry_date - date

px_flag - string

paint_option_code - number

interior_option_code - number

primary_trim_option_code - number

scrapped_flag - string
Y or N.

exported_flag - string
Y or N.

imported_flag - string
Y or N.

comments - string

Equipment Usage Attributes

Mandatory Fields

Expand to see the list of mandatory fields

asset_type - string
Must be one of the configured asset types

asset_class - string

asset_category - string

Non Mandatory Fields

Expand to see the list of non-mandatory fields.

relationship_id - number
If you want to link this asset to a relationship, provide the relationship ID in this attribute.

contract_id - number
If you want to link this asset to a contract, provide the contract ID in this attribute.

proposal_id - number
If you want to link this asset to a quote/proposal, provide the contract ID in this attribute.

asset_status - string
Must be one of the configured asset statuses

manufacturer - string

range - string

model - string

derivative - string

asset_category - string

description - string

external_reference - string

customer_reference - string

net_cost - number

options_cost - number

services_cost - number

vat - number

total_cost - number

recon_cost - number

transport_cost - number

new_used - string

build_date - date

purchase_date - date

available_from_date - date

default-offer_price - number

serial_number_1 - string

serial_number_2 - string

serial_number_3 - string

last_service_date - date

owners - number

warranty_expiry_date - date

px_flag - string

comments - string

Related Articles
Quote Object v2
Address Object v2
Contact Address Object v2
Contract Object v2
Cashflow Object v2
Did this answer your question?