Skip to main content

Cashflow Object v2

A technical guide to retrieving, adding, and updating cashflows associated with quotes 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

relationship ID REQUIRED
integer - ID of your chosen relationship

opportunity ID REQUIRED
integer - ID of your chosen opportunity

quote ID REQUIRED
integer - ID of your chosen quote

cashflow ID OPTIONAL
integer - ID of your chosen cashflow

Cashflow Requests

GET POST

GET POST - Return all cashflows associated with a quote or insert a new cashflow into a quote.

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/opportunities/{id}/quotes/{id}/cashflows/

Example Payload

POST

{
    "cashflow_type": "Holding Deposit",
    "net_amount": "500",
    "admin_view_only_flag": "N",
    "account_owner_view_only": "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": [
        {
            "cashflow_id": 401892,
            "vehicle_order_id": null,
            "third_party_relationship_id": null,
            "cashflow_type": "Holding Deposit",
            "description": null,
            "invoice_id": null,
            "nominal_code": null,
            "admin_view_only_flag": "N",
            "account_owner_view_only_flag": "N",
            "default_flag": "N",
            "vat_rate_type": null,
            "ipt_type": null,
            "quantity": null,
            "net_amount": 500,
            "tax_amount": 0,
            "invoiced_date": null,
            "invoiced_by": null,
            "invoice_reference": null,
            "paid_date": null,
            "paid_amount": 0,
            "paid_by": null,
            "payment_reference": null,
            "refunded_amount": 0,
            "creation_date": "2022-08-04 13:08:20",
            "last_update_date": "2022-08-04 13:08:20",
        }
    ]
}

PUT - Update an existing cashflow within a quote

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/opportunities/{id}/quotes/{id}/cashflows/{id}/

Example Payload

PUT

{

"cashflow_type": "Holding Deposit",

"net_amount": "653",

"admin_view_only_flag": "N",

"account_owner_view_only": "Y"

}

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.

A successful PUT request will not return a response object.

{}

Cashflow Attributes

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

Mandatory Fields

Expand to see the list of mandatory fields

cashflow_type - string
Must be one of the available Cashflow Types below;

Inflow types

Carbon Offset Commission

Dealer Bonus

Dealer Cashback

Dealer Commission

Dealer GAP Commission

Dealer PPI Commission

Documentation/Procurement Fee

Funder Bonus

Funder Commission

GAP Commission

GAP Insurance Sale

Holding Deposit

Key Insurance SaleMaintenance Commission

Manufacturer Bonus

Manufacturer Commission

Misfuel Insurance Sales

Other Inflow

Smart Protect Plus Sale

Smart Protect Sal

Vehicle Sale

Vehicle Sourcing Charge

Outflow types

Customer Cashback

GAP Insurance Purchase

Holding Deposit Refund

Introducer Commission

Key Insurance Purchase

Misfuel Insurance Purchase

Other OutflowRebateSmart Protect Plus Purchase

Smart Protect Purchase

Vehicle Purchase

description - string

Must be specified for Cashflow Types 'Other Inflow' and 'Other Outflow'.

net_amount - number

admin_view_only_flag - string
Y or N. If Y only users with the Administrator flag will be able to see the cashflow.

account_owner_view_only_flag - string
Y or N. If Y only users with the Owner flag will be able to see the cashflow.

paid_amount - number
Mandatory is paid_date is populated. If the cashflow is paid, the amount that was paid.

Non Mandatory Fields

Expand to see the list of non-mandatory fields.

cashflow-id - number
Must not be supplied when using POST or PUT

vat_rate_type - string
Must be Standard, Reduced, Zero Rated or Outside VAT Scope.

ipt_rate - string
Must be blank, Standard or Higher. If this is non-blank, vat_rate_type must be Outside VAT Scope.

tax_amount - number
Read only: will be calculated from the net_amount together with the value in either vat_rate_type or ipt_rate.

invoiced_date - date
If the cashflow is invoiced, the date it was invoiced.

invoiced_by - string
Read only.

paid_date - date
If the cashflow is paid, the date it was paid.

paid_by - string
Read only.

invoice_reference - string
Maximum 30 characters.

payment_reference - date
Maximum 30 characters.

nominal_account - date
Read only.

Related Articles
Quote Object v2
Contact Object v2
Contract Object v2
Quote Options Object v2
Asset Object v2
Did this answer your question?