Projeção de fluxo de caixa
cashflow_forecastProjeção mês a mês (até 12 meses) de entradas, saídas e saldo projetado, incluindo receita/despesa recorrente, categorias, centros de custo e meses no vermelho. Quando pending=true (default) e não há simulação, serve a leitura já materializada (cache); caso contrário recalcula ao vivo no motor Python. Suporta simular liquidação de um ativo (liquidationParams) ou amortização extra de uma dívida (simulationParams) e ver o impacto no saldo projetado — não grava nada, é só simulação. Diferença dos outros: é o único que traz saldo/caixa completo por mês; para só gastos por categoria use spending_projection, para só patrimônio líquido use networth_projection, para o mês corrente (sem projeção futura) use current_month_spending, e para série histórica real (passado) use analytics_history.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| months | No | Quantidade de meses a projetar, 1-12 (default 12) | |
| userId | No | Id do cliente a consultar (uso de planejador financeiro); omitido usa o próprio usuário autenticado | |
| topCategories | No | Quantas categorias de topo trazer por mês em topExpenses, 1-20 (default 5) | |
| includePending | No | Se true (default), considera transações pendentes na projeção; false usa só o histórico realizado e força recálculo ao vivo (não usa cache) | |
| simulationParams | No | JSON stringificado simulando amortização extra de uma dívida: {"debtId": "<id>", "amount": number, "frequency"?: "MONTHLY"|..., "installments"?: number}. Só tem efeito se debtId e amount forem válidos. | |
| liquidationParams | No | JSON stringificado simulando a liquidação de um ativo: {"assetId": "<id do Equity>", "amount": number, "liquidationLevel"?: "LL1"|..., "months"?: number}. Só tem efeito se assetId e amount forem válidos. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| months | No | ||
| cacheHit | No | ||
| chartData | No | ||
| generatedAt | No | ||
| balanceTrend | No | ||
| categoryKeys | No | ||
| costCenterKeys | No | ||
| negativeMonths | No | ||
| startingBalance | No | ||
| variableSummary | No | ||
| currentMonthForecast | No | ||
| finalProjectedBalance | No |