Returns expanded occurrence rows for dated plan expenses in a window (default today → +3 months, max 36 months). Optional boxId and expense-name query. Amounts are converted to the budget baseCurrency.
GET
/v1/list_scheduleQuery
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| budgetId | string | Yes | — | Budget to project. |
| boxId | string | No | — | Limit to one expense box. |
| fromDate | string | No | today (UTC) | Inclusive start yyyy-MM-dd. |
| toDate | string | No | fromDate + 3mo | Inclusive end yyyy-MM-dd (window ≤ 36 months). |
| query | string | No | — | Case-insensitive expense name substring. |
| limit | number | No | 50 | Max occurrences (1–100). |
Response shape: { items, hasMore }.
Response data
| Field | Type | Description |
|---|---|---|
| items | array | Occurrence rows. |
| hasMore | boolean | True when more occurrences exist beyond limit. |
Item fields
| Field | Type | Description |
|---|---|---|
| date | string | Occurrence day yyyy-MM-dd. |
| expenseId | string | Plan expense id. |
| boxId | string | Expense box id. |
| boxName | string | Expense box name. |
| name | string | Expense name. |
| amount | number | Amount in budget base currency. |
| currency | string | Budget base currency. |
| originalAmount | number | Present when expense currency differs from base. |
| originalCurrency | string | Present when expense currency differs from base. |