| 1 |
cashflow |
| 2 |
|
| 3 |
(cf) |
| 4 |
|
| 5 |
This command displays a (simple) cashflow statement, showing the inflows |
| 6 |
and outflows affecting "cash" (ie, liquid, easily convertible) assets. |
| 7 |
Amounts are shown with normal positive sign, as in conventional |
| 8 |
financial statements. |
| 9 |
|
| 10 |
Flags: |
| 11 |
--sum calculation mode: show sum of posting amounts |
| 12 |
(default) |
| 13 |
--valuechange calculation mode: show total change of value of |
| 14 |
period-end historical balances (caused by deposits, |
| 15 |
withdrawals, market price fluctuations) |
| 16 |
--gain calculation mode: show unrealised capital |
| 17 |
gain/loss (historical balance value minus cost |
| 18 |
basis) |
| 19 |
--count calculation mode: show the count of postings |
| 20 |
--change accumulation mode: accumulate amounts from column |
| 21 |
start to column end (in multicolumn reports) |
| 22 |
(default) |
| 23 |
--cumulative accumulation mode: accumulate amounts from report |
| 24 |
start (specified by e.g. -b/--begin) to column end |
| 25 |
-H --historical accumulation mode: accumulate amounts from |
| 26 |
journal start to column end (includes postings |
| 27 |
before report start date) |
| 28 |
-l --flat list/tree mode: show accounts as a flat list |
| 29 |
(default). Amounts exclude subaccount amounts, |
| 30 |
except where the account is depth-clipped. |
| 31 |
-t --tree list/tree mode: show accounts as a tree. Amounts |
| 32 |
include subaccount amounts. |
| 33 |
--drop=N in list mode, omit N leading account name parts |
| 34 |
--declared include non-parent declared accounts (best used |
| 35 |
with -E) |
| 36 |
-A --average show a row average column (in multicolumn |
| 37 |
reports) |
| 38 |
-T --row-total show a row total column (in multicolumn reports) |
| 39 |
--summary-only display only row summaries (e.g. row total, |
| 40 |
average) (in multicolumn reports) |
| 41 |
-N --no-total omit the final total row |
| 42 |
--no-elide in tree mode, don't squash boring parent accounts |
| 43 |
--format=FORMATSTR use this custom line format (in simple reports) |
| 44 |
-S --sort-amount sort by amount instead of account code/name |
| 45 |
-% --percent express values in percentage of each column's |
| 46 |
total |
| 47 |
--layout=ARG how to show multi-commodity amounts: |
| 48 |
'wide[,WIDTH]': all commodities on one line |
| 49 |
'tall' : each commodity on a new line |
| 50 |
'bare' : bare numbers, symbols in a column |
| 51 |
--base-url=URLPREFIX in html output, generate hyperlinks to |
| 52 |
hledger-web, with this prefix. (Usually the base |
| 53 |
url shown by hledger-web; can also be relative.) |
| 54 |
-O --output-format=FMT select the output format. Supported formats: |
| 55 |
txt, html, csv, tsv, json. |
| 56 |
-o --output-file=FILE write output to FILE. A file extension matching |
| 57 |
one of the above formats selects that format. |
| 58 |
|
| 59 |
This report shows accounts declared with the Cash type (see account |
| 60 |
types). Or if no such accounts are declared, it shows accounts |
| 61 |
|
| 62 |
- under a top-level account named asset (case insensitive, plural |
| 63 |
allowed) |
| 64 |
- whose name contains some variation of cash, bank, checking or saving. |
| 65 |
|
| 66 |
More precisely: all accounts matching this case insensitive regular |
| 67 |
expression: |
| 68 |
|
| 69 |
^assets?(:.+)?:(cash|bank|che(ck|que?)(ing)?|savings?|currentcash)(:|$) |
| 70 |
|
| 71 |
and their subaccounts. |
| 72 |
|
| 73 |
An example cashflow report: |
| 74 |
|
| 75 |
$ hledger cashflow |
| 76 |
Cashflow Statement 2008 |
| 77 |
|
| 78 |
|| 2008 |
| 79 |
====================++====== |
| 80 |
Cash flows || |
| 81 |
--------------------++------ |
| 82 |
assets:bank:saving || $1 |
| 83 |
assets:cash || $-2 |
| 84 |
--------------------++------ |
| 85 |
|| $-1 |
| 86 |
|
| 87 |
This command is a higher-level variant of the balance command, and |
| 88 |
supports many of that command's features, such as multi-period reports. |
| 89 |
It is similar to |
| 90 |
hledger balance assets not:fixed not:investment not:receivable, but with |
| 91 |
smarter account detection. |
| 92 |
|
| 93 |
This command also supports the output destination and output format |
| 94 |
options The output formats supported are txt, csv, tsv (Added in 1.32), |
| 95 |
html, and json. |