Invoices API

List invoices

Get a list of all outstanding and paid invoices

Scope: Invoices

GET /invoices

Attribute	Type	Required	Description
filter[status]	string	no	Filter the results by status. Available options: outstanding, paid & all
sort	string or array of strings	no	Sort the invoices by the given field or fields.
search	string	no	Search by invoice_number, description, invoice_date, expire_date, payment_date, total

Example of response

[
    {
        "invoice_number": "I220001",
        "description": "Invoice description",
        "invoice_date": "2022-01-01T23:00:00.000000Z",
        "expire_date": "2022-01-01T23:00:00.000000Z",
        "invoice_address": {
            "name": "",
            "name_extension": "",
            "address": "",
            "address_2": "",
            "address_3": "",
            "postcode": "",
            "state": "",
            "city": "",
            "country": ""
        },
        "payment_term": {
            "term": "60",
            "description": "Payment within 60 days"
        },
        "payment_date": "2022-01-01T23:00:00.000000Z",
        "currency": "EUR",
        "vat_percentage": 21,
        "subtotal": 10000,
        "vat": 2100,
        "total": 12100
    }
]

Get single invoice

Get a specific invoice by its invoice number.

Scope: Invoices

GET /invoice/:invoice_number

Example of response

{
    "invoice_number": "I220001",
    "description": "Invoice description",
    "invoice_date": "2022-01-01T23:00:00.000000Z",
    "expire_date": "2022-01-01T23:00:00.000000Z",
    "invoice_address": {
        "name": "",
        "name_extension": "",
        "address": "",
        "address_2": "",
        "address_3": "",
        "postcode": "",
        "state": "",
        "city": "",
        "country": ""
    },
    "payment_term": {
        "term": "60",
        "description": "Payment within 60 days"
    },
    "payment_date": "2022-01-01T23:00:00.000000Z",
    "currency": "EUR",
    "vat_percentage": 21,
    "subtotal": 10000,
    "vat": 2100,
    "total": 12100,
    "lines": [
        {
            "line_number": 7,
            "amount": 10000,
            "quote_number": "BVF22-0001",
            "sales_order_number": "BVR22-0001",
            "sales_order_line": "010 / 005",
            "customer_quote_number": "",
            "customer_order_number": "",
            "part_number": "M1234A",
            "customer_part_number": "",
            "description": "Invoice line description",
            "qty": 1000,
            "unit_price": 10
        }
    ]
}