---
title: "List Invoice summaries"
method: GET
path: "/invoices/list-summary"
tags: ["Invoices"]
---

# List Invoice summaries

`GET /invoices/list-summary`

List invoices with only the fields the summary table renders

## Query parameters

- `before` string
- `after` string
- `limit` integer
- `sortOrder` 'ASC' | 'DESC'
- `sortBy` string
- `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
- `excludeInvoiceStatus` string
- `excludeInvoicePaymentStatus` string
- `excludeCustomerId` string
- `excludeBillingScheduleId` string
- `excludeInvoiceCurrency` string
- `excludeInvoiceNumber` string
- `excludeNetTotal` number
- `excludeSearch` string

## Headers

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

## Response `200`

OK

- InvoiceListSummaryResponse
  - `items` InvoiceListSummaryResponseItem[], required — Invoice summaries
    - `id` string, required — Invoice ID
    - `invoiceNumber` string — Invoice number
    - `status` 'IN_PROGRESS' | 'DRAFT' | 'FINAL' | 'SENT' | 'VOIDED', required
    - `paymentStatus` 'UNPAID' | 'PARTIALLY_PAID' | 'PAID' | 'UNCOLLECTIBLE', required
    - `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
    - `grossTotal` string, required — Gross total (the Amount column)
    - `customerId` string, required — The ID of the Customer this invoice is linked to
    - `customerLegalCompanyName` string, required — Customer's legal company name (the Customer column)
    - `billingScheduleId` string — The ID of the billing schedule this invoice was generated from, if any
    - `billingPeriod` InclusiveDateRange — Service Period
      - `start` string, required — Start date, included in the whole range
      - `endInclusive` string, required — End date, included in the whole range
    - `dueDate` string — Due date
    - `dueDateSource` 'MANUAL' | 'CALCULATED', required
    - `accountingDate` string, required — Accounting date (the Date column)
    - `links` LinkInfo[], required — Linked external integration entities (the Links column)
      - `externalId` string, required — The ID of the related entity in external system
      - `externalService` 'Amazon_Redshift' | 'GoCardless' | 'Google_BigQuery' | 'Google_Sheets' | 'HubSpot' | 'NetSuite' | 'QuickBooks_Online' | 'Salesforce' | 'Slack' | 'Snowflake' | 'Stripe' | 'Xero' | 'Avalara' | 'Anrok' | 'Attio' | 'Numeral' | 'Rillet' | 'Sphere', required
      - `syncTime` string, required — The time that this was synced from the connected integration
      - `externalUrl` string — External URL
  - `pagination` PaginationMeta, required — Results pagination
    - `after` string — Cursor for the page after this (if it exists)
    - `before` string — Cursor for the page before this (if it exists)
    - `totalResultSize` integer — Total number of entries across all pages

## 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)