Sign in
Invoices

Get an invoice summary

Returns aggregate invoice totals (count and gross total) grouped by currency for the invoices matching the supplied filters. Totals cover the whole matching set, so accurate figures can be retrieved in a single request without paginating.

get/invoices/summary

Query parameters

invoiceStatusstring

Filter by invoice status. Options: IN_PROGRESS, DRAFT, FINAL, SENT, VOIDED

invoicePaymentStatusstring

Filter by payment status. Options: UNPAID, PARTIALLY_PAID, PAID, UNCOLLECTIBLE

customerIdstring

Filter by customer id.

billingScheduleIdstring

Filter by billing schedule id.

dueBeforestring

Filter by due date before. Format: yyyy-MM-dd

dueAfterstring

Filter by due date after. Format: yyyy-MM-dd

sentBeforestring

Filter by sent date before. Format: yyyy-MM-dd

sentAfterstring

Filter by sent date after. Format: yyyy-MM-dd

invoiceBeforestring

Filter by invoice date before. Format: yyyy-MM-dd

invoiceAfterstring

Filter by invoice date after. Format: yyyy-MM-dd

excludeZeroQuantityboolean

Exclude invoices with zero quantity.

invoiceCurrencystring

Get invoices for a specific currency (provide a comma-separated list)

searchstring

Search invoices by invoice number (partial, case-insensitive match)

invoiceNumberstring

Filter by invoice number

netTotalnumber

Filter by net total amount

excludeInvoiceStatusstring

Exclude invoices with these statuses. Options: IN_PROGRESS, DRAFT, FINAL, SENT, VOIDED

excludeInvoicePaymentStatusstring

Exclude invoices with these payment statuses. Options: UNPAID, PARTIALLY_PAID, PAID, UNCOLLECTIBLE

excludeCustomerIdstring

Exclude invoices for these customer ids.

excludeBillingScheduleIdstring

Exclude invoices for these billing schedule ids.

excludeInvoiceCurrencystring

Exclude invoices for these currencies (provide a comma-separated list)

excludeInvoiceNumberstring

Exclude invoices with these invoice numbers

excludeNetTotalnumber

Exclude invoices with this exact net total amount

excludeSearchstring

Exclude invoices whose invoice number contains this (partial, case-insensitive match)

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Response

OK

Example response

{
  "totalsByCurrency": [
    {
      "currency": "GBP",
      "invoiceCount": 12,
      "grossTotal": 15400
    },
    {
      "currency": "USD",
      "invoiceCount": 3,
      "grossTotal": 980.5
    }
  ]
}

Changes