Expenditure Object v2

Path Parameters

HTTP Header

api-key status:REQUIRED
string - Your Accelerate API Key

URL Substitution

subdomain status:Required
string - Your Accelerate subdomain

relationship ID status:REQUIRED
integer - ID of your chosen relationship

Expenditure Requests status:GEt status:Post

status:Get status: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 status:POSt

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

Response

status:200
Returned if the request is successful.

{
    "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/"
    }
}

status:400
Returned if the request sent is invalid.

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

Expenditure Attributes

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

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 status:Post it. )

Non Mandatory Fields

comments - string

QV Systems Knowledge Base