Invoice Object v2

Path Parameters

HTTP Header

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

URL Substitution

subdomain status:Required
string - Your Accelerate subdomain

date status:REQUIRED
date - invoices to be retrieved since and including the supplied date

Invoice Requests status:GEt

status:Get status:Post - Retrieve all invoices since and including the supplied date

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/invoices/since/{date}/

Response

status:200
Returned if the request is successful.

{
    "items": [
        {
            "invoice_id": 100489,
            "invoice_type": "Purchase",
            "credit_invoice_id": null,
            "external_reference": "1",
            "contract_id": null,
            "asset_id": null,
            "payer_display_name": "QV Systems",
            "payer_property": "Unit A, The Merton Centre",
            "payer_street": "45 St Peter's Street",
            "payer_locality": null,
            "payer_town_city": "Bedford",
            "payer_postcode": "MK40 2FL",
            "tax_date": "2022-07-22",
            "due_date": "2022-08-05",
            "sent_date": null,
            "sent_by": null,
            "paid_date": null,
            "paid_by": null,
            "void_date": null,
            "void_by": null,
            "paid_amount": 0,
            "payable_sort_code": null,
            "payable_account_number": null,
            "creation_date": "2022-07-22 13:09:57",
            "created_by": "example@qv.systems",
            "last_update_date": "2022-07-22 13:10:42",
            "last_updated_by": "example@qv.systems",
            "invoice_lines": []
        },
        {
            "invoice_id": 100490,
            "invoice_type": "Sales",
            "credit_invoice_id": null,
            "external_reference": "2",
            "contract_id": null,
            "asset_id": null,
            "payer_display_name": "QV Systems",
            "payer_property": "Unit A, The Merton Centre",
            "payer_street": "45 St Peter's Street",
            "payer_locality": null,
            "payer_town_city": "Bedford",
            "payer_postcode": "MK40 2FL",
            "tax_date": "2022-07-22",
            "due_date": "2022-08-05",
            "sent_date": null,
            "sent_by": null,
            "paid_date": null,
            "paid_by": null,
            "void_date": null,
            "void_by": null,
            "paid_amount": 0,
            "payable_sort_code": null,
            "payable_account_number": null,
            "creation_date": "2022-07-22 13:16:47",
            "created_by": "example@qv.systems",
            "last_update_date": "2022-08-04 15:03:35",
            "last_updated_by": "example@qv.systems",
            "invoice_lines": []
        }
    ]
}

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.

Invoice Attributes

When retrieving Invoices via the API, there are a number of fields returned.

Mandatory Fields

net_amount - number
The net amount of the invoice

quote_id - number
The quote ID that has generated the invoice

type - string
The type of transaction

invoice_date - date
The date the invoice was raised in Accelerate

invoiced_by - string
The email address of the user who raised the invoice in Accelerate

Non Mandatory Fields

description - string

reference - string

paid_date - date
If invoice is marked as paid in Accelerate, the associated date

paid_by - string
The email address of the user who marked the invoice as paid in Accelerate

payment_reference - string

vat_rate - number

ipt_rate - number

QV Systems Knowledge Base