> ## 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 status de emissão e entrega de notas fiscais

> Retorna até 200 registros fiscais recentes para a organização atual. Filtrar por CRN da fatura para inspecionar documentos para uma fatura de faturamento mais antiga. Não emite pagamentos históricos automaticamente.

<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/fiscal-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/fiscal-invoices:
    get:
      tags:
        - Billing
      summary: Listar status de emissão e entrega de notas fiscais
      description: >-
        Retorna até 200 registros fiscais recentes para a organização atual.
        Filtrar por CRN da fatura para inspecionar documentos para uma fatura de
        faturamento mais antiga. Não emite pagamentos históricos
        automaticamente.
      operationId: listFiscalInvoices
      parameters:
        - name: invoice
          in: query
          description: Fatura de faturamento canônico CRN.
          schema:
            type: string
            example: crn:billing:::invoice/0195d322-8765-7000-8000-000000000001
      responses:
        '200':
          description: Registros fiscais para esta organização.
          content:
            application/json:
              schema:
                type: object
                required:
                  - fiscal_documents
                properties:
                  fiscal_documents:
                    type: array
                    items:
                      $ref: '#/components/schemas/FiscalInvoice'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    FiscalInvoice:
      type: object
      description: >-
        Um NFS-e por pagamento confirmado do provedor, incluindo pagamentos
        parciais ou recargas de crédito. O consumo de crédito pré-pago nunca
        emite o mesmo dinheiro duas vezes. Os detalhes do destinatário e o valor
        do recibo são congelados antes do envio.
      required:
        - id
        - organization_id
        - payment_id
        - amount
        - status
        - email_status
        - attempts
        - requires_review
        - created_at
      properties:
        id:
          type: string
          format: uuid
        organization_id:
          type: string
          format: uuid
        payment_id:
          type: string
          format: uuid
        invoice_id:
          type: string
          format: uuid
          nullable: true
        amount:
          type: string
          description: Valor real recebido em BRL, não o total da fatura de faturamento.
          example: '12.34'
        status:
          type: string
          enum:
            - queued
            - waiting_details
            - retrying
            - rejected
            - issued
            - review_required
        email_status:
          type: string
          enum:
            - pending
            - queued
          description: >-
            Estado de entrega separado. Em fila significa que é aceito de forma
            duradoura pelo serviço de e-mail interno; não afirma a entrega ao
            destinatário.
        last_error:
          type: string
          description: Códigos de erro operacional ou rejeição municipal higienizados.
        attempts:
          type: integer
        number:
          type: string
        verification_code:
          type: string
        url:
          type: string
          format: uri
          description: Link de visualização/impressão municipal disponível após a emissão.
        issued_at:
          type: string
          format: date-time
        requires_review:
          type: boolean
          description: >-
            Os reembolsos preservam o documento fiscal e exigem revisão do
            operador; o cancelamento nunca é inferido automaticamente.
        created_at:
          type: string
          format: date-time
    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
  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
  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.