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

Expenditure Requests

GET POST

GET POST - Retrieve expenditures from a relationship or add a new expenditure to a relationship.

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

Example Payload

POST

{
    "expenditure_type": "Clothing",
    "expenditure_frequency": "Monthly",
    "amount": "20"
}

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": [
        {
            "expenditure_id": 22689,
            "expenditure_type": "Clothing",
            "expenditure_frequency": "Monthly",
            "amount": 20,
            "comments": null
        }
    ],
    "first": {
        "$ref": "https://demo.quotevineapp.com/qvine/quotevine/api/v2/relationships/2300191/expenditures/"
    }
}

Expenditure Attributes

When adding a new expenditure via the API, there are a number of fields needed.

Mandatory Fields

Expand to see the list of mandatory fields

expenditure_type - string
Must be one of: Car Tax/MOT/Maintenance/Insurance (Inc. New Car), Credit Card(s), County Court Judgments, Child Care (Nursery/Clubs etc.), Clothing, Child Support/Maintenance (CSA or Private), Council Tax, Endowment/Repayment Vehicle, Household Food and Toiletries, Mortgage/Rent, Building/Contents Insurance, Life Assurance, Other, Pension Contribution, Secured Personal Loan(s), Service Charge/Maintenance (Flat), Home Telephone/Mobile/Broadband, Cigarettes/Tobacco, Travel (Fuel/Train/Bus/School), TV Licence/Satellite/Cable TV, Unsecured Personal Loan(s), Utilities (Electric, Gas, Water, Oil)

expenditure_frequency - string
Must be one of: Annual, Fortnightly, Four-weekly, Monthly, Weekly

amount - number
Must be > 0 (if someone spends nothing on a given item, do not POST it. )

Non-mandatory Fields

Expand to see the list of non-mandatory fields.

comments - string

Address Object v2

Cookie Object v2

Driver Object v2

Marketing Permissions Object v2

Relationship Note Object v2

Expenditure Object v2