> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sequencehq.com/llms.txt
> Use this file to discover all available pages before exploring further.

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



## OpenAPI

````yaml invoices.latest.product.live GET /invoices/summary
openapi: 3.0.0
info:
  title: ''
  description: ''
  version: 0.0.1
servers:
  - url: https://dev.seqhq.io
    description: E2E
  - url: https://dev.seqhq.io
    description: DEV
  - url: https://sandbox.sequencehq.com
    description: SANDBOX
  - url: https://eu.sequencehq.com
    description: PRODUCTION
security: []
tags:
  - name: Invoices
  - name: Credit Note Line Items
  - name: Invoice Line Items
  - name: Invoice Settings
  - name: Credit Notes
paths:
  /invoices/summary:
    servers: []
    parameters: []
    get:
      tags:
        - Invoices
      summary: Get an invoice summary
      description: >-
        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.
      operationId: getInvoicesSummary
      parameters:
        - name: Authorization
          in: header
          description: >-
            Your [API credentials](/reference/authentication). Eg. `Basic
            {credentials}`.
          required: true
          schema:
            type: string
        - name: invoiceStatus
          in: query
          description: >-
            Filter by invoice status. Options: IN_PROGRESS, DRAFT, FINAL, SENT,
            VOIDED
          required: false
          schema:
            type: string
        - name: invoicePaymentStatus
          in: query
          description: >-
            Filter by payment status. Options: UNPAID, PARTIALLY_PAID, PAID,
            UNCOLLECTIBLE
          required: false
          schema:
            type: string
        - name: customerId
          in: query
          description: Filter by customer id.
          required: false
          schema:
            type: string
        - name: billingScheduleId
          in: query
          description: Filter by billing schedule id.
          required: false
          schema:
            type: string
        - name: dueBefore
          in: query
          description: 'Filter by due date before. Format: yyyy-MM-dd'
          required: false
          schema:
            type: string
        - name: dueAfter
          in: query
          description: 'Filter by due date after. Format: yyyy-MM-dd'
          required: false
          schema:
            type: string
        - name: sentBefore
          in: query
          description: 'Filter by sent date before. Format: yyyy-MM-dd'
          required: false
          schema:
            type: string
        - name: sentAfter
          in: query
          description: 'Filter by sent date after. Format: yyyy-MM-dd'
          required: false
          schema:
            type: string
        - name: invoiceBefore
          in: query
          description: 'Filter by invoice date before. Format: yyyy-MM-dd'
          required: false
          schema:
            type: string
        - name: invoiceAfter
          in: query
          description: 'Filter by invoice date after. Format: yyyy-MM-dd'
          required: false
          schema:
            type: string
        - name: excludeZeroQuantity
          in: query
          description: Exclude invoices with zero quantity.
          required: false
          schema:
            type: boolean
        - name: invoiceCurrency
          in: query
          description: >-
            Get invoices for a specific currency (provide a comma-separated
            list)
          required: false
          schema:
            type: string
        - name: search
          in: query
          description: Search invoices by invoice number (partial, case-insensitive match)
          required: false
          schema:
            type: string
        - name: invoiceNumber
          in: query
          description: Filter by invoice number
          required: false
          schema:
            type: string
        - name: netTotal
          in: query
          description: Filter by net total amount
          required: false
          schema:
            type: number
        - name: sequence-version
          in: header
          description: Use this header to select an API version
          required: false
          schema:
            type: string
            enum:
              - '2024-07-30'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceSummaryResponse'
                example:
                  totalsByCurrency:
                    - currency: GBP
                      invoiceCount: 12
                      grossTotal: 15400
                    - currency: USD
                      invoiceCount: 3
                      grossTotal: 980.5
              examples:
                InvoiceSummaryResponse:
                  summary: ''
                  value:
                    totalsByCurrency:
                      - currency: GBP
                        invoiceCount: 12
                        grossTotal: 15400
                      - currency: USD
                        invoiceCount: 3
                        grossTotal: 980.5
        '400':
          description: Bad Request
          content: {}
        '401':
          description: Unauthorized
          content: {}
        '500':
          description: Internal Server Error
          content: {}
components:
  schemas:
    InvoiceSummaryResponse:
      required:
        - totalsByCurrency
      type: object
      example:
        totalsByCurrency:
          - currency: GBP
            invoiceCount: 12
            grossTotal: 15400
          - currency: USD
            invoiceCount: 3
            grossTotal: 980.5
      properties:
        totalsByCurrency:
          type: array
          description: >-
            Aggregate totals for the invoices matching the supplied filters,
            grouped by currency.
          example:
            - currency: GBP
              invoiceCount: 12
              grossTotal: 15400
            - currency: USD
              invoiceCount: 3
              grossTotal: 980.5
          items:
            $ref: '#/components/schemas/InvoiceSummaryResponseCurrencyTotals'
    InvoiceSummaryResponseCurrencyTotals:
      required:
        - currency
        - grossTotal
        - invoiceCount
      type: object
      example:
        currency: GBP
        invoiceCount: 12
        grossTotal: 15400
      properties:
        currency:
          $ref: '#/components/schemas/Currency'
          description: The currency these totals are denominated in.
        invoiceCount:
          type: integer
          description: The number of invoices matching the filters in this currency.
          format: int64
          example: 12
        grossTotal:
          type: number
          description: >-
            The sum of the gross totals of the matching invoices in this
            currency.
          example: 15400
    Currency:
      type: string
      example: GBP
      enum:
        - 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

````