---
title: "Get an invoice summary"
method: GET
path: "/invoices/summary"
tags: ["Invoices"]
---

# Get an invoice summary

`GET /invoices/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.

## Query parameters

- `invoiceStatus` string
- `invoicePaymentStatus` string
- `customerId` string
- `billingScheduleId` string
- `dueBefore` string
- `dueAfter` string
- `sentBefore` string
- `sentAfter` string
- `invoiceBefore` string
- `invoiceAfter` string
- `excludeZeroQuantity` boolean
- `invoiceCurrency` string
- `search` string
- `invoiceNumber` string
- `netTotal` number

## Headers

- `Authorization` string, required
- `sequence-version` '2024-07-30'

## Response `200`

OK

- InvoiceSummaryResponse
  - `totalsByCurrency` InvoiceSummaryResponseCurrencyTotals[], required — Aggregate totals for the invoices matching the supplied filters, grouped by currency.
    - `currency` 'AED' | 'ARS' | 'AUD' | 'BRL' | 'BGN' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'ILS' | 'INR' | 'ISK' | 'JPY' | 'KRW' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'USD' | 'UYU' | 'ZAR', required
    - `invoiceCount` integer, required — The number of invoices matching the filters in this currency.
    - `grossTotal` number, required — The sum of the gross totals of the matching invoices in this currency.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/sequencehq/apis/sequence.md) · [All operations](https://skmtc.net/sequencehq/apis/sequence/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sequencehq/sequence/versions/cae64b02699f/schema)