> ## 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.

# Visão contábil dos payouts liquidados no período (exportação)

> Visão contábil dos payouts concluídos num período (por data de pagamento): uma linha por payout com afiliado, valor, comprovante e situação da NF vinculada. Base para a exportação contábil (CSV) no painel.



## OpenAPI

````yaml /openapi.json get /payouts/accounting-report
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:
  /payouts/accounting-report:
    get:
      tags:
        - Payouts
      summary: Visão contábil dos payouts liquidados no período (exportação)
      description: >-
        Visão contábil dos payouts concluídos num período (por data de
        pagamento): uma linha por payout com afiliado, valor, comprovante e
        situação da NF vinculada. Base para a exportação contábil (CSV) no
        painel.
      operationId: getPayoutAccountingReport
      parameters:
        - schema:
            example: '2026-06-01T00:00:00.000Z'
          in: query
          name: from
          required: true
          description: Início do período por data de pagamento (inclusive, ISO-8601).
        - schema:
            example: '2026-07-01T00:00:00.000Z'
          in: query
          name: to
          required: true
          description: Fim do período por data de pagamento (exclusive, ISO-8601).
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  from:
                    description: Início do período (ISO-8601).
                    type: string
                    format: date-time
                  to:
                    description: Fim do período (ISO-8601).
                    type: string
                    format: date-time
                  entries:
                    type: array
                    items:
                      type: object
                      properties:
                        payoutId:
                          type: string
                          description: Payout liquidado.
                        affiliateId:
                          type: string
                          description: Afiliado beneficiário.
                        affiliateName:
                          type: string
                          description: Nome do afiliado.
                        method:
                          type: string
                          enum:
                            - pix
                          description: Método de pagamento do payout.
                          example: pix
                        amountCents:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: 'Valor pago em centavos (ex.: 1990 = R$19,90).'
                        currency:
                          type: string
                          description: Moeda (ISO 4217).
                        paidAt:
                          anyOf:
                            - type: string
                              format: date-time
                            - type: 'null'
                          description: Data do pagamento (ISO-8601).
                        providerTransactionId:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: ID da transação no provedor.
                        invoiceId:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: NF vinculada ao payout, quando exigida.
                        invoiceStatus:
                          anyOf:
                            - type: string
                              enum:
                                - pending
                                - processing
                                - validated
                                - rejected
                                - canceled
                              description: >-
                                Status da nota fiscal. `pending`: aguardando
                                envio do arquivo da NF. `processing`: arquivo
                                recebido, extração/validação automática em
                                andamento. `validated`: NF aprovada (libera o
                                pagamento). `rejected`: NF recusada na validação
                                (reabre a pendência do pagamento e permite
                                reenvio). `canceled`: NF cancelada.
                              example: validated
                            - type: 'null'
                          description: Status da NF vinculada, quando houver.
                        nfNumber:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Número da NF declarada, quando houver.
                      required:
                        - payoutId
                        - affiliateId
                        - affiliateName
                        - method
                        - amountCents
                        - currency
                        - paidAt
                        - providerTransactionId
                        - invoiceId
                        - invoiceStatus
                        - nfNumber
                      additionalProperties: false
                    description: Uma linha por payout concluído no período.
                  totals:
                    type: object
                    properties:
                      count:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: Quantidade de payouts no período.
                      totalCents:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: Soma dos valores pagos em centavos.
                    required:
                      - count
                      - totalCents
                    additionalProperties: false
                    description: Totais consolidados do período.
                required:
                  - from
                  - to
                  - entries
                  - totals
                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`.

````