Register report

Documentation about the centjes register command, for printing a register overview

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

Timestamp  Description      Account                 Amount     Running    
2025-01-28 Opening balances assets:cash              10.00 USD  10.00  USD
                            equity:opening-balances -10.00 USD            
2025-01-29 Coffee           assets:cash              -5.00 USD  -5.00  USD
                            expenses:coffee           5.00 USD            

Reference

Options

centjes register [--convert CURRENCY] [--individually | --daily | --weekly | --monthly | --quarterly | --yearly | [--block BLOCK_SIZE]] [--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] [--begin|-b DATE] [--end|-e DATE] [FILTER [FILTER]]

  --convert      Currency to convert to                                                                
  --individually All transactions in one block                                                         
  --daily        Group transactions by day                                                             
  --weekly       Group transactions by week                                                            
  --monthly      Group transactions by month                                                           
  --quarterly    Group transactions by quarter                                                         
  --yearly       Group transactions by year                                                            
  --block        Group transactions                                        default: BlockSizeIndividual
  --virtual      Show virtual postings too                                 default: False              
  --year         Filter to the given year                                                              
  --this-year    Filter to the current year                                                            
  --last-year    Filter to last year (beginning to end of last year)                                   
  --past-year    Filter to the past year (past 365 days)                                               
  --this-quarter Filter to the current quarter                                                         
  --last-quarter Filter to last quarter (beginning to end of last quarter)                             
  --past-quarter Filter to the past quarter (past 90 days)                                             
  --this-month   Filter to the current month                                                           
  --last-month   Filter to last month (beginning to end of last month)                                 
  --past-month   Filter to the past month (past 30 days)                                               
  --this-week    Filter to the current week                                                            
  --last-week    Filter to last week (beginning to end of last week)                                   
  --past-week    Filter to the past week (past 7 days)                                                 
  --begin|-b     Begin date (inclusive), in YYYY-MM-DD format                                          
  --end|-e       End date (inclusive), in YYYY-MM-DD format                                            
  FILTER         filter                                                                                
  FILTER         filter                                                                                

Environment variables

  CENTJES_YEAR YEAR   Filter to the given year

Configuration values

  Currency to convert to
  register.convert:
    # or null
    <string>
  Group transactions
  default: BlockSizeIndividual
  register.block:
    # or null
    <string>
  Show virtual postings too
  default: False
  register.virtual:
    # or null
    <boolean>
  Filter to the given year
  register.year:
    # or null
    <integer>
  Begin date (inclusive), in YYYY-MM-DD format
  register.begin:
    # or null
    # Day
    <string>
  End date (inclusive), in YYYY-MM-DD format
  register.end:
    # or null
    # Day
    <string>
  filter
  register.filter:
    # or null
    def: Filter
    # any of
    [ <string>
    , - ref: Filter
    ]

Combined settings

Usage: centjes register [--convert CURRENCY] [--individually | --daily | --weekly | --monthly | --quarterly | --yearly | [--block BLOCK_SIZE]] [--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] [--begin|-b DATE] [--end|-e DATE] [FILTER [FILTER]]

register report

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

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

  All transactions in one block
  switch: --individually

  Group transactions by day
  switch: --daily

  Group transactions by week
  switch: --weekly

  Group transactions by month
  switch: --monthly

  Group transactions by quarter
  switch: --quarterly

  Group transactions by year
  switch: --yearly

  Group transactions
  option: --block BLOCK_SIZE
  config:
    register.block: # or null
      <string>
  default: BlockSizeIndividual

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

  Filter to the given year
  option: --year YEAR
  env: CENTJES_YEAR YEAR
  config:
    register.year: # or null
      <integer>

  Filter to the current year
  switch: --this-year

  Filter to last year (beginning to end of last year)
  switch: --last-year

  Filter to the past year (past 365 days)
  switch: --past-year

  Filter to the current quarter
  switch: --this-quarter

  Filter to last quarter (beginning to end of last quarter)
  switch: --last-quarter

  Filter to the past quarter (past 90 days)
  switch: --past-quarter

  Filter to the current month
  switch: --this-month

  Filter to last month (beginning to end of last month)
  switch: --last-month

  Filter to the past month (past 30 days)
  switch: --past-month

  Filter to the current week
  switch: --this-week

  Filter to last week (beginning to end of last week)
  switch: --last-week

  Filter to the past week (past 7 days)
  switch: --past-week

  Begin date (inclusive), in YYYY-MM-DD format
  option: --begin|-b DATE
  config:
    register.begin: # or null
      # Day
      <string>

  End date (inclusive), in YYYY-MM-DD format
  option: --end|-e DATE
  config:
    register.end: # or null
      # Day
      <string>

  filter
  argument: FILTER

  filter
  argument: FILTER

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