Accounts and transactions
Generated from --help output of fob-actual 0.1.0. Every command also accepts the global options --profile <name>, --help and --version.
accounts#
accounts list#
fob-actual accounts list
List accounts with balances
Options:
--limit Maximum rows to show [number]
--json Output raw JSON [boolean]
--fields Columns to show, comma-separated [string]
--format Output format [string] [choices: "table", "csv", "json"]
--output Write output to a file instead of stdout [string]
--all Include closed accounts [boolean]
accounts show#
fob-actual accounts show <id>
Show one account by id or name
Positionals:
id Account id or name [string] [required]
Options:
--json Output raw JSON [boolean]
accounts balance#
fob-actual accounts balance <id>
Show an account's balance
Positionals:
id Account id or name [string] [required]
Options:
--json Output raw JSON [boolean]
--as-of Balance as of a date (YYYY-MM-DD) [string]
accounts create#
fob-actual accounts create
Create an account
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--name Account name [string] [required]
--offbudget Create as an off-budget account [boolean]
--balance Starting balance, e.g. 1000.00 [string]
accounts edit#
fob-actual accounts edit <id>
Update an account (only passed flags change)
Positionals:
id Account id or name [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--name Account name [string]
--offbudget Move on/off budget [boolean]
accounts close#
fob-actual accounts close <id>
Close an account, optionally moving its balance
Positionals:
id Account id or name [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--transfer-account Move the remaining balance to this account [string]
--transfer-category Category for the transfer [string]
accounts reopen#
fob-actual accounts reopen <id>
Reopen a closed account
Positionals:
id Account id or name [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
accounts delete#
fob-actual accounts delete <id>
Delete an account and its transactions (requires --yes)
Positionals:
id Account id or name [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
-y, --yes Confirm deletion [boolean]
transactions#
transactions list#
fob-actual transactions list
List transactions in an account (defaults to the last 30 days)
Options:
--limit Maximum rows to show [number]
--json Output raw JSON [boolean]
--fields Columns to show, comma-separated [string]
--format Output format [string] [choices: "table", "csv", "json"]
--output Write output to a file instead of stdout [string]
--account Account id or name [string] [required]
--from Start date, YYYY-MM-DD [string]
--to End date, YYYY-MM-DD [string]
transactions add#
fob-actual transactions add
Add transactions to an account
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--account Account id or name [string] [required]
--date Transaction date, YYYY-MM-DD [string]
--amount Amount, e.g. -42.50 (negative is an outflow) [string]
--payee Payee name [string]
--category Category id [string]
--notes Notes [string]
--cleared Mark as cleared [boolean]
--file JSON file of transactions to add instead of flags [string]
--run-transfers Create transfers for matching entries [boolean]
--learn-categories Let Actual learn payee categories [boolean]
transactions import#
fob-actual transactions import
Import transactions with Actual's dedupe + rules
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--account Account id or name [string] [required]
--file JSON file of transactions [string] [required]
transactions edit#
fob-actual transactions edit <id>
Update a transaction (only passed flags change)
Positionals:
id Transaction id [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--date Transaction date, YYYY-MM-DD [string]
--amount Amount, e.g. -42.50 [string]
--payee Payee name [string]
--category Category id [string]
--notes Notes [string]
--cleared Mark as cleared [boolean]
transactions delete#
fob-actual transactions delete <id>
Delete a transaction (requires --yes)
Positionals:
id Transaction id [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
-y, --yes Confirm deletion [boolean]