Openi DeveloperDeveloper
Contas bancárias

Transações por Dia

Lista as transações com resumos diários (saldo de abertura, saldo de fechamento, entradas e saídas por dia). Aceita os mesmos filtros, ordenação e busca de Listar Transações.

Endpoint

Método e URL:

GET /api/v1/companies/:companyId/bank-accounts/transactions/by-day

Parâmetros da URL:

  • companyId (uuid, obrigatório): Identificador da empresa

Parâmetros de query:

  • accountId (uuid, opcional, repetível): Restringe a uma ou mais contas
  • from, to (data YYYY-MM-DD ou data-hora ISO 8601, opcionais): Período sobre transactionAt, ambos inclusivos — veja Período
  • filters (JSON, opcional): Condições sobre os campos filtráveis das transações
  • joinOperator (opcional): and (padrão) ou or
  • sort (JSON, opcional): Ordenação por transactionAt. Padrão: mais recente primeiro
  • search (texto, opcional): Busca em descrição, nome e documento da contraparte, valor e tipo
  • page (number, opcional): Página, a partir de 1 (padrão: 1)
  • perPage (number, opcional): Itens por página, de 1 a 500 (padrão: 10)

Exemplo

Extrato de agosto de 2026, dia a dia:

curl -G "https://api-business.openi.com.br/api/v1/companies/{companyId}/bank-accounts/transactions/by-day" \
  -H "Authorization: Bearer oak_368ba506f7b2_9f2c..." \
  --data-urlencode 'from=2026-08-01' \
  --data-urlencode 'to=2026-08-31' \
  --data-urlencode 'sort=[{"id":"transactionAt","desc":false}]' \
  --data-urlencode 'perPage=500'

Resposta

{
  "status": "success",
  "data": {
    "dailySummaries": [
      {
        "date": "2026-08-07",
        "openingBalance": 15230.45,
        "closingBalance": 16730.45,
        "inflow": "1500.00",
        "outflow": "0"
      }
    ],
    "transactions": [
      {
        "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
        "accountId": "6f1c2b3a-8d4e-4a5b-9c0d-1e2f3a4b5c6d",
        "description": "PIX RECEBIDO PADARIA SILVA LTDA",
        "status": "POSTED",
        "type": "CREDIT",
        "amount": "1500.00",
        "currency": "BRL",
        "paymentMethod": "PIX",
        "operationType": "PIX",
        "transactionAt": "2026-08-07T14:33:00.000Z",
        "balanceAfter": "16730.45"
      }
    ],
    "pagination": { "page": 1, "limit": 10, "totalPages": 12 }
  }
}

As transações têm o mesmo formato de Listar Transações (campos abreviados acima). dailySummaries cobre os dias presentes na página atual, do mais recente para o mais antigo.

  • openingBalance e closingBalance são números; inflow, outflow, amount e balanceAfter são strings decimais
  • Os resumos diários refletem todas as transações do dia nas contas consultadas, não apenas as que passaram pelos filtros — use-os como saldo do extrato, não como soma do resultado filtrado
  • Com filters ou search, o balanceAfter deste endpoint desconsidera as transações filtradas fora da página e pode divergir do saldo real. Para o saldo após cada transação num resultado filtrado, use Listar Transações

On this page