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

                    Balance     Total     
assets                            5.00 USD
└─ cash               5.00  USD   5.00 USD
equity                          -10.00 USD
└─ opening-balances -10.00  USD -10.00 USD
expenses                          5.00 USD
└─ coffee             5.00  USD   5.00 USD
Total                                     

Reference

Options

centjes balance [--convert CURRENCY] [--show-empty] [--virtual] [--year YEAR | --this-year | --last-year | --past-year | --this-quarter | --last-quarter | --past-quarter | --this-month | --last-month | --past-month | --this-week | --last-week | --past-week] [--end|-e DATE] [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                                       
  --past-year    Balance at the end of the past year (today)                           
  --this-quarter Balance at the end of the current quarter                             
  --last-quarter Balance at the end of last quarter                                    
  --past-quarter Balance at the end of the past quarter (today)                        
  --this-month   Balance at the end of the current month                               
  --last-month   Balance at the end of last month                                      
  --past-month   Balance at the end of the past month (today)                          
  --this-week    Balance at the end of the current week                                
  --last-week    Balance at the end of last week                                       
  --past-week    Balance at the end of the past week (today)                           
  --end|-e       End date (inclusive), in YYYY-MM-DD format                            
  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>
  filter
  balance.filter:
    # or null
    def: Filter
    # any of
    [ <string>
    , - ref: Filter
    ]

Combined settings

Usage: centjes balance [--convert CURRENCY] [--show-empty] [--virtual] [--year YEAR | --this-year | --last-year | --past-year | --this-quarter | --last-quarter | --past-quarter | --this-month | --last-month | --past-month | --this-week | --last-week | --past-week] [--end|-e DATE] [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

  Balance at the end of the past year (today)
  switch: --past-year

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

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

  Balance at the end of the past quarter (today)
  switch: --past-quarter

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

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

  Balance at the end of the past month (today)
  switch: --past-month

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

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

  Balance at the end of the past week (today)
  switch: --past-week

  End date (inclusive), in YYYY-MM-DD format
  option: --end|-e DATE

  filter
  argument: FILTER

  filter
  argument: FILTER

  filter
  config:
    balance.filter: # or null
      def: Filter
      # any of
      [ <string>
      , - ref: Filter
      ]