Pular para o conteúdo principal

Lista o fluxo de caixa

GET 
/accounts/cash-flow

Retorna o fluxo de caixa da empresa em dois modos, controlados pelo parâmetro Type:

  • Resumo (default, sem Type): consolidado mês a mês (ou dia a dia, com GroupBy=day) do previsto TotalValue e do realizado ValuePaid, agrupado por plano de contas. Cada item inclui a árvore completa do plano de contas em CategoryTree. Considera o ano inteiro definido em Year (ou o ano corrente quando omitido) e ignora contas com status Não lançado.
  • Detalhe (Type=Detail): lista os títulos individuais (AccountsPayableReceivable) que compõem uma célula do resumo. Use IDTypeAccountPayableReceivable para restringir ao plano de contas selecionado e Date (primeiro dia do mês YYYY-MM-DD) combinado com DateType para restringir ao mês — DateType=DateDue filtra pelo vencimento (coluna Previsto); qualquer outro valor (a UI envia DatePayment) filtra pela data de pagamento lançado (coluna Realizado).

Valores são assinados pelo tipo de lançamento: contas a pagar (IDTypeAccount=1) entram negativas; contas a receber (IDTypeAccount=0) entram positivas.

Request​

Responses​

Fluxo de caixa retornado. O formato depende de Type: array de itens consolidados (modo Resumo) ou array de títulos individuais (modo Detalhe). Quando não há registros no Resumo, retorna [].