Totais dos Lançamentos

Retorna entradas, saídas e saldo do conjunto de lançamentos que atende aos filtros — o mesmo conjunto de Listar Lançamentos, sem paginação.

Endpoint

Método e URL:

GET /api/v1/companies/:companyId/accounting/bank-accounts/entries/meta

Parâmetros da URL:

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

Parâmetros de query:

• accountId (uuid, opcional, repetível): Restringe a contas específicas
• from, to (data YYYY-MM-DD ou data-hora ISO 8601, opcionais): Período sobre date, ambos inclusivos — veja Período
• filters (JSON, opcional): Condições sobre os campos filtráveis dos lançamentos
• joinOperator (opcional): and (padrão) ou or
• search (texto, opcional): Mesma busca da listagem

Use exatamente os mesmos accountId, from, to, filters, joinOperator e search da listagem para obter os totais correspondentes.

Exemplo

curl -G "https://api-business.openi.com.br/api/v1/companies/{companyId}/accounting/bank-accounts/entries/meta" \
  -H "Authorization: Bearer oak_368ba506f7b2_9f2c..." \
  --data-urlencode 'accountId=6f1c2b3a-8d4e-4a5b-9c0d-1e2f3a4b5c6d' \
  --data-urlencode 'from=2026-08-01' \
  --data-urlencode 'to=2026-08-31'

Resposta

{
  "status": "success",
  "data": {
    "inflow": "25400.50",
    "outflow": "18220.30",
    "balance": "7280.20"
  }
}

• inflow: soma dos lançamentos CREDIT
• outflow: soma dos lançamentos DEBIT, em valor absoluto
• balance: saldo contábil inicial das contas informadas em accountId somado ao resultado dos lançamentos filtrados. Sem accountId, é apenas o resultado dos lançamentos
• Valores como strings decimais com duas casas