Devolve o Needed de runway ao vivo para cada caixa não eliminada (máx. 30). Com status ready: expectedInAccountToday (abertura) e expectedAfterTodaysBills (fecho). Outros estados sem montantes. asOfDate opcional (yyyy-MM-dd, predefinição hoje UTC) é uma reprojeção do plano atual, não o histórico de Reports — use get_report para Needed carimbado.
GET
/v1/list_box_neededConsulta
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
| budgetId | string | Sim | — | Orçamento a avaliar. |
| boxId | string | Não | — | Limitar a uma caixa de despesas. |
| asOfDate | string | Não | today (UTC) | Dia de calendário yyyy-MM-dd da projeção. |
Formato da resposta: { items }. Montantes na moeda da caixa.
Resposta data
| Campo | Tipo | Descrição |
|---|---|---|
| items | array | Linhas de Needed por caixa. |
Campos do item
| Campo | Tipo | Descrição |
|---|---|---|
| boxId | string | Id da caixa de despesas. |
| boxName | string | Nome da caixa de despesas. |
| currency | string | Moeda da caixa. |
| asOfDate | string | Dia da projeção yyyy-MM-dd. |
| status | string | ready, undatedExpenses, missingCreditCycleEndDay ou noPlannedExpenses. |
| expectedInAccountToday | number | Needed de abertura quando status ready. |
| expectedAfterTodaysBills | number | Needed de fecho quando status ready. |
| hasOutflowsToday | boolean | Verdadeiro quando há saídas planeadas em asOfDate. |