listProjections

listProjections — lists cash-flow projections owned by the caller, with optional filters.

Use with an AI agent

Export this page as Markdown or bundle it with a task for your agent.

Try a task
0 charactersPage docs attached
Preview the prompt that will be copied

Reference

Authentication: bearer token required (see how to get a token)

listProjections — lists cash-flow projections owned by the caller, with optional filters.

Used by budget and balance-forecast views to load all recurring expected
incomes/expenses. Filters are AND-combined: passing both isIncome and
category narrows to projections that match both.

Authentication: Required (Bearer token).

Parameters:
- isIncome (bool, optional): If set, filter to income (true) or expense (false) projections only.
- category (string, optional): If set, filter to projections with this transaction category.

Returns:
- projections ([]object): Projection records with fields:
  - id, userId, name, description, category, isIncome, isActive
  - startMonth, endMonth? (ISO 8601)
  - amount (number), repeatFrequency (NO_REPEAT/MONTHLY/YEARLY/CUSTOM/CRON)
  - customRepeatFrequency? ({frequencyUnit, frequencyAmount})
  - cronExpression? and timezone? when repeatFrequency is CRON
  - overrides ([]object): Time-bound overrides.
  - createdAt, updatedAt (ISO 8601)

Errors:
- unauthenticated: missing or invalid Bearer token.
- internal: store failure.