Documentation

clovis account balances

List posted, pending, and current balances by account and asset

npm

What it does

List posted, pending, and current balances by account and asset

UsageUsage: clovis account balances [options]

Options

--type <type>Account type

--asset <id>Asset id or symbol

--entity <id>Scope to an account group

--parent <id>Alias for --entity

--account <id>Restrict to an account or account subtree; may be repeated (default: [])

--as-of <date>Balance date, YYYY-MM-DD

--rollupRoll balances up through same-type account children

--native-onlyOnly include each account's native/default asset

--presentation <mode>Display mode: ledger, bank, or banking (default: "ledger")

--show-zeroInclude zero-balance rows

-h, --helpdisplay help for command

Examples

clovis account balances --type asset

clovis account balances --type liability --asset CAD

clovis --format json account balances --type asset --show-zero

Notes

Balances are reported in their native asset; Clovis does not silently convert currencies.

Current balance is posted plus pending.

Raw help output

This is the exact help text captured from the published package.

Usage: clovis account balances [options]

List posted, pending, and current balances by account and asset

Options:
  --type <type>          Account type
  --asset <id>           Asset id or symbol
  --entity <id>          Scope to an account group
  --parent <id>          Alias for --entity
  --account <id>         Restrict to an account or account subtree; may be
                         repeated (default: [])
  --as-of <date>         Balance date, YYYY-MM-DD
  --rollup               Roll balances up through same-type account children
  --native-only          Only include each account's native/default asset
  --presentation <mode>  Display mode: ledger, bank, or banking (default:
                         "ledger")
  --show-zero            Include zero-balance rows
  -h, --help             display help for command

Examples:
  clovis account balances --type asset
  clovis account balances --type liability --asset CAD
  clovis --format json account balances --type asset --show-zero

Notes:
  Balances are reported in their native asset; Clovis does not silently convert currencies.
  Current balance is posted plus pending.