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

# Listar faturas

<Info>
  Requer a ação IAM **`billing:ListInvoices`**. Consulte [permissões de faturamento](/billing/permissions) para obter a lista completa, o que cada uma cobre e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/billing.yaml get /v1/invoices
openapi: 3.0.3
info:
  title: Basaltic Billing API
  version: 1.0.0
  description: >
    Preços, uso medido, faturas, pagamentos e créditos para a organização. O
    catálogo de preços (`/v1/prices`) é público; outras operações exigem
    concessão de políticas da organização para ações de faturamento.


    Inclui perfis de faturamento editáveis e status de fatura fiscal /
    downloads. A liquidação de uma fatura e a gestão dos métodos de pagamento
    ocorrem no console.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://billing.basaltic.sh
    description: Endpoint global da API
security:
  - BearerAuth: []
paths:
  /v1/invoices:
    get:
      tags:
        - Billing
      summary: Listar faturas
      operationId: listInvoices
      parameters:
        - name: crn
          in: query
          description: >-
            Exato CRN de fatura de organização. Identidades estrangeiras ou não
            correspondentes retornam uma página vazia.
          schema:
            type: string
          example: crn:billing:::invoice/550e8400-e29b-41d4-a716-446655440000
        - $ref: '#/components/parameters/Marker'
        - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: Uma página de faturas (sem itens de linha).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  parameters:
    Marker:
      name: marker
      in: query
      description: >-
        Cursor de paginação opaco. Echo back o valor `meta.marker` da página
        anterior para buscar a próxima; não construa ou analise-o. A forma
        interna do token varia de acordo com o endpoint (um ID de recurso, um
        carimbo de data/hora, etc.) e não é garantida a estabilidade entre
        versões.
      required: false
      schema:
        type: string
      example: 550e8400-e29b-41d4-a716-446655440000
    Limit:
      name: limit
      in: query
      description: >-
        Número máximo de itens a devolver. Um valor acima do máximo é fixado ao
        invés de rejeitado, então uma página mais curta do que a que você pediu
        é normal — page until `meta.has_more` é false, não até que uma página
        pareça curta.
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      example: 20
  schemas:
    InvoiceListResponse:
      type: object
      required:
        - invoices
        - meta
      properties:
        invoices:
          type: array
          items:
            $ref: '#/components/schemas/Invoice'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    Invoice:
      type: object
      required:
        - id
        - crn
        - invoice_number
        - period_start
        - period_end
        - subtotal
        - credits_applied
        - total
        - currency
        - status
        - refunded_amount
        - disputed_amount
        - created_at
      properties:
        crn:
          type: string
          description: Identidade de fatura global com escopo de organização.
          example: crn:billing:::invoice/550e8400-e29b-41d4-a716-446655440000
        id:
          type: string
          format: uuid
        invoice_number:
          type: string
          example: INV-2026-000042
        period_start:
          type: string
          format: date
          description: Primeiro dia do mês faturado UTC.
          example: '2026-06-01'
        period_end:
          type: string
          format: date
          description: Fim exclusivo (primeiro dia do mês seguinte).
          example: '2026-07-01'
        subtotal:
          type: string
          example: '128.40'
        credits_applied:
          type: string
          example: '20.00'
        total:
          type: string
          example: '108.40'
        currency:
          type: string
          example: BRL
        refunded_amount:
          type: string
          description: >-
            Reembolsos confirmados menos reversões de reembolsos com falha, em
            BRL.
          example: '25.00'
        disputed_amount:
          type: string
          description: >-
            Capital da disputa retirado menos fundos repostos; exclui taxas de
            provedor.
          example: '0.00'
        status:
          type: string
          enum:
            - open
            - paid
            - past_due
            - uncollectible
            - void
        issued_at:
          type: string
          format: date-time
          nullable: true
        due_at:
          type: string
          format: date-time
          nullable: true
        paid_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        pdf_url:
          type: string
          description: >
            Caminho do extrato PDF, renderizado sob demanda por GET
            /v1/invoices/{invoice_id}/pdf sob a mesma autorização que este
            documento.
          example: /v1/invoices/019fbbe8-7201-7aad-9475-e6ea0631a4a3/pdf
        items:
          type: array
          description: Itens de linha; presentes apenas no ponto de extremidade de detalhe.
          items:
            $ref: '#/components/schemas/InvoiceItem'
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Número total de itens
          example: 150
        limit:
          type: integer
          description: Número de itens por página
          example: 20
        marker:
          type: string
          description: >-
            Cursor opaco para a próxima página. Passe-o de volta como o
            parâmetro de consulta `marker`; trate-o como um token, não um valor
            para analisar.
          example: 550e8400-e29b-41d4-a716-446655440000
        has_more:
          type: boolean
          description: Se há mais itens
          example: true
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
    InvoiceItem:
      type: object
      required:
        - kind
        - description
        - quantity
        - unit_price
        - amount
      properties:
        kind:
          type: string
          enum:
            - usage
            - credit
        sku:
          type: string
          nullable: true
          example: compute.instance.m1.small
        description:
          type: string
          example: m1.small
        quantity:
          type: string
          example: '720'
        unit:
          type: string
          nullable: true
          example: hour
        unit_price:
          type: string
          example: '0.065'
        amount:
          type: string
          description: Total arredondado da linha; negativo para linhas de crédito.
          example: '46.80'
  responses:
    BadRequest:
      description: Parâmetros de solicitação inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.