> ## Documentation Index > Fetch the complete documentation index at: https://docs.ephra.io/llms.txt > Use this file to discover all available pages before exploring further. # Listar lançamentos do extrato > Lista os lançamentos que mexeram no saldo da empresa autenticada — vendas, taxas, reservas, estornos, saques e antecipações — do mais recente para o mais antigo, com filtro opcional de período, tipo e direção. É a consulta para conciliar o extrato com o próprio sistema. ## OpenAPI ````yaml /openapi.yaml get /v1/balance-operations openapi: 3.0.3 info: title: Ephra API description: >- API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks e a API do vendedor sobre catálogo, checkout, vendas, reembolsos, financeiro, crescimento e plataforma. **Limite de requisições.** 1000 requisições por minuto por IP de origem. Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a resposta é `429` com `retry-after`. **Erros.** Toda falha responde o mesmo envelope: `{ "success": false, "message": "..." }`. version: 1.0.0 servers: - url: https://api.ephra.io description: Servidor de produção security: [] tags: - name: Catálogo description: Produtos, ofertas, categorias e cupons — o que a empresa vende. - name: Checkout description: Checkouts, order bumps, upsells e links de pagamento. - name: Vendas description: Vendas, clientes, assinaturas e entregas já realizadas. - name: Reembolsos description: Pedidos de reembolso, contestações e o quiz de retenção. - name: Financeiro description: Saldo, saques, antecipações, taxas e extratos da empresa. - name: Crescimento description: Afiliados, coprodução, indicações, pixels e integrações de marketing. - name: Plataforma description: Conta, membros, chaves de API, webhooks e configurações gerais. paths: /v1/balance-operations: get: tags: - Financeiro summary: Listar lançamentos do extrato description: >- Lista os lançamentos que mexeram no saldo da empresa autenticada — vendas, taxas, reservas, estornos, saques e antecipações — do mais recente para o mais antigo, com filtro opcional de período, tipo e direção. É a consulta para conciliar o extrato com o próprio sistema. operationId: listBalanceOperations parameters: - schema: type: integer minimum: 1 default: 1 in: query name: page required: false description: Página desejada, começando em 1. - schema: type: integer minimum: 1 maximum: 100 default: 10 in: query name: pageSize required: false description: Quantidade de itens por página (máximo 100). - schema: type: string format: date-time in: query name: from required: false description: Início do período (inclusivo), em ISO 8601. - schema: type: string format: date-time in: query name: to required: false description: Fim do período (inclusivo), em ISO 8601. - schema: type: string enum: - fee - sell - transfer - reserve - refund - preCharge - infraction - referralBonus - anticipation - settlement - withdrawal_hold - adjustment in: query name: type required: false description: Filtra por tipo de lançamento. - schema: type: string enum: - credit - debit in: query name: direction required: false description: Filtra por entrada (`credit`) ou saída (`debit`). responses: '200': description: Página de lançamentos do extrato. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: array items: type: object properties: id: type: string description: >- Identificador do lançamento (inteiro sequencial devolvido como texto). sourceId: type: string description: >- Identificador do que originou o lançamento: venda, saque, infração ou antecipação. sourceType: type: string enum: - transaction - transfer - infraction - referralBonus - anticipation - adjustment description: Que tipo de registro originou o lançamento. type: type: string enum: - fee - sell - transfer - reserve - refund - preCharge - infraction - referralBonus - anticipation - settlement - withdrawal_hold - adjustment description: >- Natureza do lançamento: venda, taxa, reserva, estorno, saque... direction: type: string enum: - credit - debit description: '`credit` entra no saldo, `debit` sai.' amount: type: integer description: >- Valor do lançamento em centavos, sempre positivo — o sinal está em `direction`. balance: type: integer description: >- Saldo da empresa logo depois deste lançamento, em centavos. note: type: string nullable: true description: Observação registrada junto ao lançamento. isCashback: type: boolean description: '`true` quando o lançamento veio de cashback.' createdAt: type: string format: date-time description: Momento em que o lançamento entrou no extrato. updatedAt: type: string format: date-time description: Momento da última alteração do lançamento. required: - id - sourceId - sourceType - type - direction - amount - balance - note - isCashback - createdAt - updatedAt additionalProperties: false pagination: type: object properties: page: type: integer description: Página devolvida. pageSize: type: integer description: Itens por página pedidos. total: type: integer description: Total de itens que satisfazem o filtro. totalPages: type: integer description: Total de páginas disponíveis. required: - page - pageSize - total - totalPages additionalProperties: false required: - success - data - pagination additionalProperties: false description: Página de lançamentos do extrato. example: success: true data: - id: '48219' sourceId: clx9f3m2p0004qz0a7h8i9j0k sourceType: transaction type: sell direction: credit amount: 49900 balance: 1284530 note: Venda do Curso de Tráfego Pago isCashback: false createdAt: '2026-09-10T14:22:31.000Z' updatedAt: '2026-09-10T14:22:31.000Z' pagination: page: 1 pageSize: 10 total: 1 totalPages: 1 '401': description: Token ausente, inválido, expirado ou de empresa bloqueada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: Token ausente, inválido, expirado ou de empresa bloqueada. example: success: false message: Token inválido ou expirado '422': description: A requisição não passou na validação de schema. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: A requisição não passou na validação de schema. example: success: false message: 'name: Nome é obrigatório' '429': description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. example: success: false message: Muitas requisições. Tente novamente em breve. headers: retry-after: $ref: '#/components/headers/retry-after' x-ratelimit-limit: $ref: '#/components/headers/x-ratelimit-limit' x-ratelimit-remaining: $ref: '#/components/headers/x-ratelimit-remaining' x-ratelimit-reset: $ref: '#/components/headers/x-ratelimit-reset' '500': description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. example: success: false message: Erro interno do servidor security: - bearerAuth: [] components: headers: retry-after: description: Segundos a esperar antes de repetir a requisição. schema: type: integer x-ratelimit-limit: description: Teto de requisições na janela (1000). Presente em toda resposta. schema: type: integer x-ratelimit-remaining: description: >- Quantas requisições ainda cabem na janela atual. Presente em toda resposta. schema: type: integer x-ratelimit-reset: description: Segundos até o contador da janela zerar. Presente em toda resposta. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````