VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/ERP Financeiro

Fluxo de caixa

Resume o fluxo de caixa de um período e devolve a série diária para gráficos.

Resumo do fluxo de caixa

Resume o período em três visões: o realizado (o que foi quitado no período), o previsto (o que vence no período e ainda está aberto) e o panorama geral em aberto e vencido, sem recorte de data.

GET/api/v1/vendor/erp/financeiro/cashflowSeller

Resumo do fluxo de caixa de um período

Parâmetros de consulta

fromstring
Início YYYY-MM-DD. Padrão: 30 dias atrás.
tostring
Fim YYYY-MM-DD. Padrão: hoje.

Exemplo de requisição: Resumo do fluxo de caixa

bash
curl "$BASE_URL/api/v1/vendor/erp/financeiro/cashflow?from=2026-10-01&to=2026-10-31" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Resumo do fluxo de caixa

200Resumo
json
{
  "from": "2026-09-11",
  "to": "2026-10-11",
  "inflow_realized_cents": 120000,
  "outflow_realized_cents": 52400,
  "net_realized_cents": 67600,
  "inflow_expected_cents": 200000,
  "outflow_expected_cents": 110000,
  "net_expected_cents": 90000,
  "open_receivables_cents": 300000,
  "open_payables_cents": 110000,
  "overdue_receivables_cents": 20000,
  "overdue_payables_cents": 11000
}

Campos da resposta

fromstring
Início efetivo.
tostring
Fim efetivo.
inflow_realized_centsinteger
Contas a receber quitadas por inteiro no período.
outflow_realized_centsinteger
Contas a pagar quitadas por inteiro no período.
net_realized_centsinteger
Entradas menos saídas realizadas.
inflow_expected_centsinteger
A receber com vencimento no período, ainda em aberto.
outflow_expected_centsinteger
A pagar com vencimento no período, ainda em aberto.
net_expected_centsinteger
Previsto de entradas menos saídas.
open_receivables_centsinteger
Total a receber em aberto, em qualquer data.
open_payables_centsinteger
Total a pagar em aberto, em qualquer data.
overdue_receivables_centsinteger
Parte do a receber já vencida.
overdue_payables_centsinteger
Parte do a pagar já vencida.

Erros: Resumo do fluxo de caixa

StatusQuandoCorpo
400from em outro formato.{"error":"vendorerp: from must be YYYY-MM-DD"}
400to em outro formato.{"error":"vendorerp: to must be YYYY-MM-DD"}
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}
O resumo e a série usam regras diferentes para baixa parcial

O resumo só considera como realizado o título quitado por inteiro na data (valor cheio do título); baixas parciais ficam de fora, e o previsto usa o valor cheio. A série diária soma cada baixa pelo valor baixado e usa o saldo devedor no previsto. Os dois totais podem não bater.

Série diária

Uma linha por dia do período, com o realizado (pela data da baixa), o previsto (pelo vencimento) e o saldo acumulado do realizado. Serve para desenhar um gráfico. O período vai de 1 a 181 pontos (máximo de 180 dias entre from e to).

GET/api/v1/vendor/erp/financeiro/cashflow/seriesSeller

Fluxo de caixa dia a dia

Parâmetros de consulta

fromstring
Início YYYY-MM-DD. Padrão: 30 dias atrás.
tostring
Fim YYYY-MM-DD. Padrão: hoje.

Exemplo de requisição: Série diária

bash
curl "$BASE_URL/api/v1/vendor/erp/financeiro/cashflow/series?from=2026-10-01&to=2026-10-03" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Série diária

200Série
json
{
  "points": [
    {
      "date": "2026-10-01",
      "inflow_realized_cents": 0,
      "outflow_realized_cents": 0,
      "net_realized_cents": 0,
      "running_balance_cents": 0,
      "inflow_expected_cents": 20000,
      "outflow_expected_cents": 0
    }
  ],
  "total": 1
}

Campos da resposta

pointsarray

Um ponto por dia.

datestring
Dia YYYY-MM-DD.
inflow_realized_centsinteger
Recebido no dia (baixas).
outflow_realized_centsinteger
Pago no dia (baixas).
net_realized_centsinteger
Entradas menos saídas do dia.
running_balance_centsinteger
Soma acumulada do líquido realizado desde from.
inflow_expected_centsinteger
Saldo a receber com vencimento no dia.
outflow_expected_centsinteger
Saldo a pagar com vencimento no dia.
totalinteger
Número de pontos.

Erros: Série diária

StatusQuandoCorpo
400from em outro formato.{"error":"vendorerp: from must be YYYY-MM-DD"}
400to anterior a from.{"error":"vendorerp: to must be >= from"}
400Intervalo maior que 180 dias.{"error":"vendorerp: período máximo de 180 dias"}
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}

Veja também

  • Contas a pagar
  • Contas a receber
Anterior
Contas bancárias
Próxima
ERP de cobrança e conciliação
Nesta página
  • Resumo do fluxo de caixa
  • Exemplo de requisição: Resumo do fluxo de caixa
  • Resposta: Resumo do fluxo de caixa
  • Erros: Resumo do fluxo de caixa
  • Série diária
  • Exemplo de requisição: Série diária
  • Resposta: Série diária
  • Erros: Série diária
  • Veja também