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

# Listar faturas

> Lista as faturas, ordenadas por data de vencimento, utilize monthYear para pegar faturas referentes a um mês.



## OpenAPI

````yaml api-reference/v3/openapi.json GET /api/v3/invoices
openapi: 3.1.0
info:
  version: v3
  title: Salvy API
  x-logo:
    url: web/logo.png
servers:
  - url: https://api.salvy.com.br
    description: Salvy API URL
security:
  - bearerAuth: []
tags:
  - name: Public API
  - name: Outgoing Webhooks
paths:
  /api/v3/invoices:
    get:
      tags:
        - Public API
      description: >-
        Lista as faturas, ordenadas por data de vencimento, utilize monthYear
        para pegar faturas referentes a um mês.
      operationId: publicListInvoicesV3
      parameters:
        - name: page
          in: query
          required: true
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            default: 1
            description: Número da página, iniciando em 1.
            example: 1
            type: integer
            minimum: 1
            maximum: 9007199254740991
        - name: pageSize
          in: query
          required: true
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            default: 50
            description: Tamanho da página. Máximo de 200.
            example: 50
            type: integer
            minimum: 1
            maximum: 200
        - name: status
          in: query
          required: false
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            description: >-
              Filtra pela situação da fatura. Repita o parâmetro para incluir
              múltiplos valores (`?status=pending&status=late`). `late` é
              derivado: casa faturas abertas cuja data de vencimento já passou.
            example: pending
            type: array
            items:
              type: string
              enum:
                - pending
                - paid
                - failed
                - voided
                - refunded
                - charged-back
                - late
        - name: product
          in: query
          required: false
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            description: >-
              Filtra pelo produto faturado. Repita o parâmetro para incluir
              múltiplos valores.
            example: telecom
            type: array
            items:
              type: string
              enum:
                - telecom
                - asset-management
                - saas-management
        - name: monthYear
          in: query
          required: false
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            description: >-
              Filtra faturas de um mês de referência específico, no formato
              YYYY-MM. Não pode ser combinado com `fromMonthYear`/`toMonthYear`.
            example: 2026-07
            type: string
            pattern: ^\d{4}-\d{2}$
        - name: fromMonthYear
          in: query
          required: false
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            description: >-
              Filtra faturas com mês de referência a partir deste mês
              (inclusivo), no formato YYYY-MM.
            example: 2026-01
            type: string
            pattern: ^\d{4}-\d{2}$
        - name: toMonthYear
          in: query
          required: false
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            description: >-
              Filtra faturas com mês de referência até este mês (inclusivo), no
              formato YYYY-MM.
            example: 2026-07
            type: string
            pattern: ^\d{4}-\d{2}$
        - name: sortBy
          in: query
          required: false
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            description: 'Campo usado para ordenar o resultado. Padrão: `dueDate`.'
            example: dueDate
            type: string
            enum:
              - dueDate
              - referenceMonth
              - amountCents
              - status
              - createdAt
        - name: sortOrder
          in: query
          required: false
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            description: 'Direção da ordenação. Padrão: `desc`.'
            example: desc
            type: string
            enum:
              - asc
              - desc
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          description: Identificador da fatura na plataforma Salvy.
                          example: 123e4567-e89b-12d3-a456-426614174000
                          title: UUID
                          type: string
                          examples:
                            - 123e4567-e89b-12d3-a456-426614174000
                            - 123e4567-e89b-12d3-a456-426614174001
                        companyId:
                          description: >-
                            Identificador da empresa dona da fatura. Útil ao
                            listar faturas de várias empresas com uma chave de
                            organização.
                          example: 123e4567-e89b-12d3-a456-426614174000
                          title: UUID
                          type: string
                          examples:
                            - 123e4567-e89b-12d3-a456-426614174000
                            - 123e4567-e89b-12d3-a456-426614174001
                        status:
                          type: string
                          enum:
                            - pending
                            - paid
                            - failed
                            - voided
                            - refunded
                            - charged-back
                          description: >-
                            Situação da fatura. Faturas em atraso permanecem
                            `pending` ou `failed`; use `isLate` para
                            identificá-las.
                          example: pending
                        isLate:
                          type: boolean
                          description: >-
                            Verdadeiro quando a fatura está aberta (`pending` ou
                            `failed`) e a data de vencimento já passou.
                          example: false
                        amountCents:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Valor total da fatura, em centavos.
                          example: 129900
                        dueDate:
                          type: string
                          format: date
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                          description: Data de vencimento da fatura.
                          example: '2026-08-10'
                        referenceMonth:
                          anyOf:
                            - title: PlainMonth
                              type: string
                              description: A month in ISO 8601 format.
                              examples:
                                - 2023-10
                            - type: 'null'
                          description: >-
                            Mês de referência do consumo faturado, no formato
                            YYYY-MM. Nulo em faturas antigas, anteriores ao
                            registro do mês de referência.
                          example: 2026-07
                        createdAt:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                          description: Data de criação da fatura.
                          example: '2026-08-01T03:00:00.000Z'
                      required:
                        - id
                        - companyId
                        - status
                        - isLate
                        - amountCents
                        - dueDate
                        - referenceMonth
                        - createdAt
                      additionalProperties: false
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        example: 1
                      pageSize:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        example: 50
                      totalCount:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        example: 123
                      totalPages:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        example: 3
                    required:
                      - page
                      - pageSize
                      - totalCount
                      - totalPages
                    additionalProperties: false
                required:
                  - data
                  - pagination
                additionalProperties: false
        '401':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unauthorized
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '403':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - forbidden
                      - insufficient-scope
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - resource-not-found
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '413':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - payload-too-large
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '422':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - input-validation-error
                      - unprocessable-entity
                      - company-not-active
                  message:
                    type: string
                  details:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        message:
                          type: string
                      required:
                        - key
                        - message
                      additionalProperties: false
                required:
                  - code
                  - message
                additionalProperties: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unknown
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
      deprecated: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: key

````