> ## Documentation Index > Fetch the complete documentation index at: https://docs.besimplo.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar todas as faturas > Retorna uma lista paginada de faturas. ## OpenAPI ````yaml /api-reference/openapi.yml get /api/v1/invoices openapi: 3.1.0 info: title: API - Simplo version: 1.0.0 description: API para cobrança e assinaturas para contas Simplo contact: name: Simplo url: https://besimplo.com email: team@besimplo.com servers: - url: https://besimplo.com description: Produção security: - apiKeyAuth: [] tags: - name: Clientes description: Clientes são as pessoas que pagarão pelos produtos da sua conta - name: Produtos description: Produtos representam os bens ou serviços que você vende - name: Preços description: Preços definem quanto cobrar e a frequência de cobrança de um Produto - name: Assinaturas description: Assinaturas conectam clientes aos seus planos para cobrança recorrente - name: Checkout description: >- Sessões de checkout permitem que clientes completem pagamentos e assinaturas através de uma interface web - name: Faturas description: Faturas representam cobranças geradas para clientes - name: Reembolsos description: Reembolsos permitem devolver pagamentos já realizados aos clientes - name: Webhooks description: > Eventos enviados via HTTP POST para a URL configurada na sua conta. Responda com status 2xx rapidamente. Processe o evento de forma assincrona. Use o campo `event.id` para garantir idempotencia. paths: /api/v1/invoices: get: tags: - Faturas summary: Listar todas as faturas description: Retorna uma lista paginada de faturas. operationId: listInvoices parameters: - name: customer in: query schema: type: string pattern: ^cus_[0-9a-z]{26}$ example: cus_01h455vb4pex5vsknk084sn02p description: Filtrar pelo ID do cliente (TypeID com prefixo `cus_`). - name: subscription in: query schema: type: string pattern: ^sub_[0-9a-z]{26}$ example: sub_01h455vb4pex5vsknk084sn02s description: Filtrar pelo ID da assinatura (TypeID com prefixo `sub_`). - name: status in: query schema: type: string enum: - draft - open - paid - uncollectible - void description: Filtrar por status - name: limit in: query schema: type: integer minimum: 1 maximum: 100 default: 20 description: Resultados por página - name: page in: query schema: type: string description: Cursor para próxima página responses: '200': description: Lista de faturas content: application/json: schema: type: object unevaluatedProperties: false required: - object - url - has_more - data properties: object: type: string description: >- String representando o tipo do objeto. Sempre "list" para listas. enum: - list example: list url: type: string format: uri-reference description: URL do recurso solicitado. example: /api/v1/invoices has_more: type: boolean description: Indica se há mais resultados disponíveis para paginação. example: false data: type: array description: Lista de faturas. items: type: object unevaluatedProperties: false required: - id - object - amount_due - created - currency - customer - live_mode - status - total properties: id: type: string pattern: ^in_[0-9a-z]{26}$ readOnly: true description: >- ID único da fatura, no formato TypeID com prefixo `in_`. example: in_01h455vb4pex5vsknk084sn02q object: type: string description: Tipo do objeto. Sempre 'invoice'. enum: - invoice example: invoice amount_due: type: integer description: Valor a pagar em centavos. R$ 99,90 = 9990. example: 9990 amount_paid: type: integer description: Valor já pago em centavos. R$ 99,90 = 9990. example: 0 amount_remaining: type: integer description: Valor restante a pagar em centavos. R$ 99,90 = 9990. example: 9990 created: type: integer format: int64 readOnly: true description: Timestamp Unix da criação da fatura. example: 1704672000 currency: type: string description: Moeda do valor. Sempre 'brl' (Real brasileiro). enum: - brl example: brl customer: type: string pattern: ^cus_[0-9a-z]{26}$ description: >- ID do cliente associado à fatura, no formato TypeID com prefixo `cus_`. example: cus_01h455vb4pex5vsknk084sn02p customer_email: type: - string - 'null' nullable: true description: E-mail do cliente. example: joao.silva@exemplo.com customer_name: type: - string - 'null' nullable: true description: Nome do cliente. example: João Silva live_mode: type: boolean description: >- Indica ambiente de produção (true) ou sandbox (false). Dados de sandbox são limpos periodicamente. example: true paid: type: boolean description: Indica se a fatura foi paga. example: false status: type: string description: | Status atual da fatura. - draft: Rascunho, ainda não finalizada. - open: Aberta, aguardando pagamento. - paid: Paga. - uncollectible: Marcada como incobrável. - void: Cancelada. enum: - draft - open - paid - uncollectible - void example: open status_transitions: type: object description: | Timestamps de quando a fatura mudou de status. Campos são null se a transição ainda não ocorreu. properties: paid_at: type: - integer - 'null' nullable: true format: int64 description: Timestamp Unix de quando a fatura foi paga. example: 1704758400 subscription: type: - string - 'null' nullable: true pattern: ^sub_[0-9a-z]{26}$ description: >- ID da assinatura associada (se aplicável), no formato TypeID com prefixo `sub_`. example: sub_01h455vb4pex5vsknk084sn02s total: type: integer description: Valor total da fatura em centavos. R$ 99,90 = 9990. example: 9990 '404': description: Não encontrado content: application/problem+json: schema: type: object required: - type - status - title - detail - code properties: type: type: string description: URI que identifica o tipo de problema format: uri enum: - https://problems-registry.smartbear.com/not-found status: type: integer description: O código de status HTTP format: int32 enum: - 404 title: type: string description: O nome do status HTTP enum: - Not Found detail: type: string description: Mensagem descritiva do erro code: type: string description: Código de erro interno da API enum: - NOT_FOUND - RESOURCE_MISSING examples: not_found: summary: Recurso não encontrado value: type: https://problems-registry.smartbear.com/not-found status: 404 title: Not Found detail: The requested resource was not found code: NOT_FOUND customer_not_found: summary: Cliente não encontrado value: type: https://problems-registry.smartbear.com/not-found status: 404 title: Not Found detail: 'No such customer: ''019abc12-3456-7890-abcd-ef1234567890''' code: RESOURCE_MISSING security: - apiKeyAuth: [] components: securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: > A chave de API usada para autenticar a requisição e identificar a sua conta. **Exemplo:** `Authorization: ApiKey my-secure-key` ````