> ## Documentation Index > Fetch the complete documentation index at: https://userepass.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Lista as notas fiscais (obrigações de NF) > Lista as notas fiscais (obrigações de NF) da organização, com paginação por cursor. Permite filtrar por afiliado, payout e status. ## OpenAPI ````yaml /openapi.json get /invoices openapi: 3.1.0 info: title: Repass API description: >- API pública do Repass — plataforma de gestão de afiliados: programas, links, tracking, atribuição, conversões, comissões, payouts, fiscal (BR), reprocessamento, event store e webhooks. version: 0.1.0 servers: - url: https://api.userepass.com description: Produção security: - bearerAuth: [] - apiKeyAuth: [] tags: - name: Profile description: Perfil do usuário autenticado. - name: Guide description: >- Guia de onboarding do painel: estado de tours, telas visitadas e preferências por usuário e organização. - name: Portal description: >- Portal do afiliado: sessão por identidade de afiliado (sem org), convites e claim. - name: Programs description: 'Programas de afiliados: configuração, atribuição, hold e tiers.' - name: Commission Rules description: Regras de comissão versionadas (imutáveis) por programa. - name: Affiliates description: 'Ciclo de vida do afiliado: cadastro, aprovação, tier, saldo.' - name: Terms description: Termos do programa, versionados. - name: Materials description: >- Materiais (criativos) do programa: upload pelo gestor e download pelos afiliados. - name: Links description: Links rastreáveis e domínios de redirecionamento. - name: Coupons description: Cupons de afiliado e sync com gateway. - name: Pagamentos por PIX description: Habilitação de pagamentos por PIX (onboarding e documentos). - name: Tracking description: Endpoints públicos de redirect e registro de cliques. - name: Clicks description: Consulta de cliques e estatísticas de link. - name: Conversions description: 'Conversões: ingestão S2S, atribuição, matching, fraude e auditoria.' - name: Commissions description: Comissões calculadas, holds, aprovação, void e clawback. - name: Payouts description: Ciclos de pagamento, prévia, execução e comprovantes. - name: Invoices description: Notas fiscais (PJ), envio e validação (BR). - name: Fraud description: Fila de revisão e decisões de fraude. - name: Reprocess description: Reprocessamento com dry-run obrigatório e relatório de impacto. - name: Events description: Histórico de eventos para auditoria e consulta. - name: Notifications description: >- Notificações ao operador (falhas de sincronização, payouts e afins) — registro in-app espelhado por e-mail aos owners/admins. - name: Webhooks description: Endpoints de webhook, entregas, retries e dead-letter. - name: Ingest description: Ingestão de eventos de cobrança (S2S e gateways). - name: Settings description: Configurações por organização (políticas e integrações). - name: Billing description: 'Plano e cobrança: contadores de uso da organização para o painel.' - name: Dashboard description: >- Métricas agregadas da operação (receita, top afiliados, conversões, comissões, novos afiliados) para a home e os relatórios do gestor. - name: Health description: Liveness do serviço. paths: /invoices: get: tags: - Fiscal summary: Lista as notas fiscais (obrigações de NF) description: >- Lista as notas fiscais (obrigações de NF) da organização, com paginação por cursor. Permite filtrar por afiliado, payout e status. operationId: listInvoices parameters: - schema: default: 25 type: integer minimum: 1 maximum: 100 in: query name: limit required: false - schema: type: string pattern: ^inv_[0-9A-HJKMNP-TV-Z]{26}$ in: query name: starting_after required: false - schema: type: string pattern: ^inv_[0-9A-HJKMNP-TV-Z]{26}$ in: query name: ending_before required: false - schema: type: string example: aff_01J9Z3K8N2QF4T7B9XP0WMD5RC in: query name: affiliate_id required: false description: Filtra notas fiscais por afiliado. - schema: type: string example: pay_01J9Z3K8N2QF4T7B9XP0WMD5RC in: query name: payout_id required: false description: Filtra notas fiscais por pagamento (payout). - schema: type: string enum: - pending - processing - validated - rejected - canceled example: validated in: query name: status required: false description: >- Filtra por status da NF (`pending`, `processing`, `validated`, `rejected` ou `canceled`). - schema: example: '2026-06-01T00:00:00.000Z' in: query name: created_after required: false description: >- Filtra notas fiscais criadas a partir desta data (inclusive, ISO-8601). Use com `created_before` para recortar por competência (mês). - schema: example: '2026-07-01T00:00:00.000Z' in: query name: created_before required: false description: Filtra notas fiscais criadas antes desta data (exclusive, ISO-8601). responses: '200': description: Default Response content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string description: >- Identificador único da nota fiscal (prefixo `inv_` + ULID). example: inv_01J9Z3K8N2QF4T7B9XP0WMD5RC organizationId: type: string description: Organização (tenant) dona da nota fiscal. example: org_01J9Z3K8N2QF4T7B9XP0WMD5RC affiliateId: type: string description: Afiliado a quem a nota fiscal se refere. example: aff_01J9Z3K8N2QF4T7B9XP0WMD5RC payoutId: type: string description: >- Pagamento (payout) ao qual a nota fiscal está vinculada. example: pay_01J9Z3K8N2QF4T7B9XP0WMD5RC status: type: string enum: - pending - processing - validated - rejected - canceled description: Status atual da nota fiscal. example: validated nfNumber: anyOf: - type: string - type: 'null' description: >- Número da nota fiscal extraído do arquivo. `null` até a extração concluir. example: '12345' nfSeries: anyOf: - type: string - type: 'null' description: >- Série da nota fiscal extraída do arquivo. `null` quando ausente. example: '1' issuerCnpj: anyOf: - type: string - type: 'null' description: >- CNPJ do emissor extraído do arquivo (normalizado a 14 dígitos). `null` até a extração concluir. example: '11222333000181' nfAmountCents: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Valor da NF extraído do arquivo, em centavos (ex.: 1990 = R$19,90). `null` até a extração concluir. example: 25000 recipientName: anyOf: - type: string - type: 'null' description: >- Nome do tomador/destinatário extraído da NF. `null` até a extração concluir. example: Repass Tecnologia LTDA nfAccessKey: anyOf: - type: string - type: 'null' description: >- Chave de acesso da NF (44 dígitos na NF-e; formato próprio na NFS-e Nacional). `null` quando ausente do documento. example: '35260611222333000181550010000001231123456782' nfIssuedAt: anyOf: - type: string format: date-time - type: 'null' description: >- Data de emissão extraída da NF (ISO-8601). `null` quando ausente. example: '2026-06-20T00:00:00.000Z' extractionMethod: anyOf: - type: string enum: - xml_nfe - xml_nfse - ai_pdf - ai_xml description: >- Como os dados da NF foram extraídos do arquivo. `xml_nfe`: parser determinístico de NF-e (modelo 55). `xml_nfse`: parser determinístico de NFS-e Nacional. `ai_pdf`: extração por IA a partir do PDF. `ai_xml`: extração por IA a partir de um XML fora dos layouts conhecidos. example: xml_nfse - type: 'null' description: >- Como os dados foram extraídos do arquivo. `null` até a extração concluir. extractionError: anyOf: - type: string - type: 'null' description: >- Código da falha fatal de extração (ex.: `unreadable_file`). `null` quando a extração leu o arquivo. example: unreadable_file fileKey: anyOf: - type: string - type: 'null' description: >- Referência interna do arquivo da NF armazenado. `null` enquanto não enviado. example: invoices/inv_01J9Z3K8N2QF4T7B9XP0WMD5RC.pdf fileContentType: anyOf: - type: string - type: 'null' description: >- Tipo MIME do arquivo da NF (PDF ou XML). `null` enquanto não enviado. example: application/pdf fileSizeBytes: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Tamanho do arquivo da NF em bytes. `null` enquanto não enviado. example: 204800 validationErrors: anyOf: - type: array items: type: string - type: 'null' description: >- Códigos/mensagens de erro encontrados na validação automática da NF. `null` quando não houve validação ou ela passou. example: - amount_mismatch rejectionReason: anyOf: - type: string - type: 'null' description: >- Motivo da rejeição manual da NF. `null` quando não rejeitada. example: Valor da NF diverge do payout submittedAt: anyOf: - type: string format: date-time - type: 'null' description: >- Momento do envio da NF (ISO-8601). `null` enquanto não enviada. example: '2026-06-13T12:00:00.000Z' validatedAt: anyOf: - type: string format: date-time - type: 'null' description: >- Momento da validação da NF (ISO-8601). `null` quando não validada. example: '2026-06-13T12:00:00.000Z' rejectedAt: anyOf: - type: string format: date-time - type: 'null' description: >- Momento da rejeição da NF (ISO-8601). `null` quando não rejeitada. example: '2026-06-13T12:00:00.000Z' canceledAt: anyOf: - type: string format: date-time - type: 'null' description: >- Momento do cancelamento da NF (ISO-8601). `null` quando não cancelada. example: '2026-06-13T12:00:00.000Z' createdAt: description: Data de criação do registro da NF (ISO-8601). example: '2026-06-13T12:00:00.000Z' type: string format: date-time updatedAt: description: >- Data da última atualização do registro da NF (ISO-8601). example: '2026-06-13T12:00:00.000Z' type: string format: date-time required: - id - organizationId - affiliateId - payoutId - status - nfNumber - nfSeries - issuerCnpj - nfAmountCents - recipientName - nfAccessKey - nfIssuedAt - extractionMethod - extractionError - fileKey - fileContentType - fileSizeBytes - validationErrors - rejectionReason - submittedAt - validatedAt - rejectedAt - canceledAt - createdAt - updatedAt additionalProperties: false hasMore: type: boolean nextCursor: anyOf: - type: string - type: 'null' description: Cursor da próxima página (use em starting_after). previousCursor: anyOf: - type: string - type: 'null' description: Cursor da página anterior (use em ending_before). required: - data - hasMore - nextCursor - previousCursor additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- Chave de API (prefixo `rstr_`) enviada como `Authorization: Bearer rstr_...`. apiKeyAuth: type: apiKey in: header name: x-api-key description: Chave de API (prefixo `rstr_`) enviada no header `x-api-key`. ````