fobs stm entities

fobs stm entities <action> [options]

One action:

ActionDescription
listList entities with period-scoped count, inflow, and outflow

Read-only — entities have no separate model. To change an entity, edit the entity field on the affected transactions with fobs stm transactions edit.

entities list

fobs stm entities list --from 2026-04-01 --to 2026-06-30
fobs stm entities list --from 2026-04-01 --to 2026-06-30 --type expense
fobs stm entities list --from 2026-04-01 --to 2026-06-30 --accounts acc1,acc2
fobs stm entities list --from 2026-04-01 --to 2026-06-30 --totals

fobs stm entities list --from 2026-04-01 --to 2026-06-30 --format csv --output entities.csv
fobs stm entities list --from 2026-04-01 --to 2026-06-30 --format json --output entities.json

Flags

FlagDefaultDescription
--from <YYYY-MM-DD>requiredStart date
--to <YYYY-MM-DD>requiredEnd date
--accounts <ids>allComma-separated account IDs
--type <type>allincome, expense, asset, liability, transfer, or unknown
--fields <list>default columnsComma-separated field names
--totals—Print count + inflow/outflow sums over all matching transactions
--format <fmt> / --output <path>table / stdoutExport to CSV / JSON file
--json—Raw JSON output

Default Columns

ENTITY, TYPE, COUNT, INFLOW, OUTFLOW.

Notes

  • --from/--to are required and validated client-side (missing, malformed, or --from after --to) before any API call, with errors reported using the CLI's own --from/--to flag names.
  • No pagination — the endpoint returns one row per distinct entity+type pair in the range, not a per-transaction list.
  • Matches GET /api/v1/entities exactly; the web UI additionally nests these rows into a type-grouped tree client-side.
  • For the transactions behind an entity, use fobs stm transactions list --entity <name>.

Related