Centjes

Balance report

Documentation about the centjes balance command, for viewing the balance of given accounts.

currency USD 0.01

account assets:cash
account equity:opening-balances
account expenses:coffee

2025-01-28
  | Opening balances
  * assets:cash             +10 USD
  * equity:opening-balances -10 USD

2025-01-29
  | Coffee
  * assets:cash     -5 USD
  * expenses:coffee +5 USD


assets                    5.00 USD
assets:cash               5.00 USD
equity                  -10.00 USD
equity:opening-balances -10.00 USD
expenses                  5.00 USD
expenses:coffee           5.00 USD
Total

Reference

Options

centjes balance [--convert CURRENCY] [--show-empty] [--virtual] [--year YEAR | --this-year | --last-year] [FILTER [FILTER]]

  --convert    Currency to convert to                                            
  --show-empty Show empty balances instead of hiding them default: DoNotShowEmpty
  --virtual    Show virtual postings too                  default: False         
  --year       Balance at the end of the given year                              
  --this-year  Balance at the end of the current year                            
  --last-year  Balance at the end of last year                                   
  FILTER       filter                                                            
  FILTER       filter

Environment variables

  CENTJES_YEAR YEAR   Balance at the end of the given year

Configuration values

  Currency to convert to
  balance.convert:
    # or null
    <string>
  Show empty balances instead of hiding them
  default: DoNotShowEmpty
  balance.show-empty:
    # or null
    <boolean>
  Show virtual postings too
  default: False
  balance.virtual:
    # or null
    <boolean>
  Balance at the end of the given year
  balance.year:
    # or null
    <integer>

Combined settings

Usage: centjes balance [--convert CURRENCY] [--show-empty] [--virtual] [--year YEAR | --this-year | --last-year] [FILTER [FILTER]]

balance report

Available settings:
  Show this help text
  switch: -h|--help

  Currency to convert to
  option: --convert CURRENCY
  config:
    balance.convert: # or null
      <string>

  Show empty balances instead of hiding them
  switch: --show-empty
  config:
    balance.show-empty: # or null
      <boolean>
  default: DoNotShowEmpty

  Show virtual postings too
  switch: --virtual
  config:
    balance.virtual: # or null
      <boolean>
  default: False

  Balance at the end of the given year
  option: --year YEAR
  env: CENTJES_YEAR YEAR
  config:
    balance.year: # or null
      <integer>

  Balance at the end of the current year
  switch: --this-year

  Balance at the end of last year
  switch: --last-year

  filter
  argument: FILTER

  filter
  argument: FILTER