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

# Exportar vendas em CSV

> Gera a planilha das vendas da empresa autenticada que casam com os filtros e devolve o CSV na própria resposta, pronto para conciliação contábil fora da plataforma. O período é limitado a 100 dias (sem filtro de data, os últimos 100) e a exportação a 50000 linhas; acima disso a resposta é 413 e os filtros precisam ser refinados.



## OpenAPI

````yaml /openapi.yaml post /v1/transactions/export
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/transactions/export:
    post:
      tags:
        - Vendas
      summary: Exportar vendas em CSV
      description: >-
        Gera a planilha das vendas da empresa autenticada que casam com os
        filtros e devolve o CSV na própria resposta, pronto para conciliação
        contábil fora da plataforma. O período é limitado a 100 dias (sem filtro
        de data, os últimos 100) e a exportação a 50000 linhas; acima disso a
        resposta é 413 e os filtros precisam ser refinados.
      operationId: exportTransactions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - pending
                    - infraction
                    - paid
                    - refused
                    - canceled
                    - refund
                    - chargeback
                    - contest
                    - preCharge
                    - error
                    - waiting
                    - expired
                  description: Filtra por situação da venda.
                paymentMethod:
                  type: string
                  enum:
                    - pix
                    - credit_card
                    - boleto
                    - multiple_cards
                  description: Filtra por meio de pagamento.
                productId:
                  type: string
                  minLength: 1
                  description: Filtra pelas vendas de um produto.
                customerName:
                  type: string
                  minLength: 1
                  description: Filtra pelo nome do comprador.
                customerEmail:
                  type: string
                  minLength: 1
                  description: >-
                    Filtra pelo e-mail do comprador: casa tanto o e-mail do
                    cadastro do cliente quanto qualquer e-mail usado por ele
                    numa compra. Aceita trecho do endereço e ignora maiúsculas.
                customerDocument:
                  type: string
                  minLength: 1
                  description: >-
                    Filtra pelo CPF ou CNPJ do comprador, só dígitos e exato —
                    39053344705, não 390.533.447-05.
                startDate:
                  type: string
                  format: date-time
                  description: Início do período de criação da venda (ISO 8601).
                endDate:
                  type: string
                  format: date-time
                  description: Fim do período de criação da venda (ISO 8601).
                saleType:
                  type: string
                  enum:
                    - producer
                    - affiliate
                    - coproduction
                  description: >-
                    Filtra pelo papel da empresa: produtor, afiliado ou
                    coprodutor.
                purchaseType:
                  type: string
                  enum:
                    - single
                    - subscription
                    - installment
                  description: Compra única, assinatura ou parcelamento.
                utmSource:
                  type: string
                  minLength: 1
                  description: Filtra pela origem de tráfego gravada no checkout.
                utmMedium:
                  type: string
                  minLength: 1
                  description: Filtra pelo meio de tráfego gravado no checkout.
                utmCampaign:
                  type: string
                  minLength: 1
                  description: Filtra pela campanha gravada no checkout.
                utmContent:
                  type: string
                  minLength: 1
                  description: Filtra pelo conteúdo do anúncio gravado no checkout.
                utmTerm:
                  type: string
                  minLength: 1
                  description: Filtra pelo termo de busca gravado no checkout.
              additionalProperties: false
            example:
              status: paid
              startDate: '2026-08-01T00:00:00.000Z'
              endDate: '2026-08-31T23:59:59.000Z'
      responses:
        '200':
          description: Planilha gerada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: object
                    properties:
                      filename:
                        type: string
                        description: Nome sugerido para salvar o arquivo.
                      contentType:
                        type: string
                        description: Tipo do conteúdo devolvido em `content`.
                      rowsExported:
                        type: integer
                        description: Quantidade de vendas na planilha.
                      filtersDescription:
                        type: string
                        description: Os filtros efetivamente aplicados, em texto legível.
                      content:
                        type: string
                        description: >-
                          Conteúdo do CSV em UTF-8, com BOM e quebras de linha
                          CRLF.
                    required:
                      - filename
                      - contentType
                      - rowsExported
                      - filtersDescription
                      - content
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Planilha gerada.
              example:
                success: true
                data:
                  filename: vendas-2026-09-12.csv
                  contentType: text/csv; charset=utf-8
                  rowsExported: 1
                  filtersDescription: >-
                    Período: 2026-08-01T00:00:00.000Z até
                    2026-08-31T23:59:59.000Z · Status: paid
                  content: "\uFEFFID,Data da criação,Data do pagamento,Produto,Nome,E-mail,Telefone,CPF/CNPJ,Método,Status,Data da solicitação de reembolso,Data da execução do reembolso,Motivo de recusa,Total líquido,Total bruto\r\ncmtx9p2k40001hlg1u3ajbj6o,14/08/2026 11:02,14/08/2026 11:03,Curso de Tráfego Pago,Mariana Ribeiro Alves,mariana.alves@exemplo.com.br,+5521998877665,39053344705,PIX,Pago,,,,\"R$ 462,70\",\"R$ 499,00\""
        '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
        '413':
          description: A exportação passou do teto de linhas; refine os filtros.
          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 exportação passou do teto de linhas; refine os filtros.
              example:
                success: false
                message: Payload maior que o limite aceito.
        '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

````