Debian Codegraph @

Hledger/Cli/Commands/Balancesheetequity.txt

raw
1 balancesheetequity
2
3 (bse)
4
5 This command displays a balance sheet, showing historical ending
6 balances of asset, liability and equity accounts. Amounts are shown with
7 normal positive sign, as in conventional financial statements.
8
9 Flags:
10 --sum calculation mode: show sum of posting amounts
11 (default)
12 --valuechange calculation mode: show total change of value of
13 period-end historical balances (caused by deposits,
14 withdrawals, market price fluctuations)
15 --gain calculation mode: show unrealised capital
16 gain/loss (historical balance value minus cost
17 basis)
18 --count calculation mode: show the count of postings
19 --change accumulation mode: accumulate amounts from column
20 start to column end (in multicolumn reports)
21 --cumulative accumulation mode: accumulate amounts from report
22 start (specified by e.g. -b/--begin) to column end
23 -H --historical accumulation mode: accumulate amounts from
24 journal start to column end (includes postings
25 before report start date) (default)
26 -l --flat list/tree mode: show accounts as a flat list
27 (default). Amounts exclude subaccount amounts,
28 except where the account is depth-clipped.
29 -t --tree list/tree mode: show accounts as a tree. Amounts
30 include subaccount amounts.
31 --drop=N in list mode, omit N leading account name parts
32 --declared include non-parent declared accounts (best used
33 with -E)
34 -A --average show a row average column (in multicolumn
35 reports)
36 -T --row-total show a row total column (in multicolumn reports)
37 --summary-only display only row summaries (e.g. row total,
38 average) (in multicolumn reports)
39 -N --no-total omit the final total row
40 --no-elide in tree mode, don't squash boring parent accounts
41 --format=FORMATSTR use this custom line format (in simple reports)
42 -S --sort-amount sort by amount instead of account code/name
43 -% --percent express values in percentage of each column's
44 total
45 --layout=ARG how to show multi-commodity amounts:
46 'wide[,WIDTH]': all commodities on one line
47 'tall' : each commodity on a new line
48 'bare' : bare numbers, symbols in a column
49 --base-url=URLPREFIX in html output, generate hyperlinks to
50 hledger-web, with this prefix. (Usually the base
51 url shown by hledger-web; can also be relative.)
52 -O --output-format=FMT select the output format. Supported formats:
53 txt, html, csv, tsv, json.
54 -o --output-file=FILE write output to FILE. A file extension matching
55 one of the above formats selects that format.
56
57 This report shows accounts declared with the Asset, Cash, Liability or
58 Equity type (see account types). Or if no such accounts are declared, it
59 shows top-level accounts named asset, liability or equity (case
60 insensitive, plurals allowed) and their subaccounts.
61
62 Example:
63
64 $ hledger balancesheetequity
65 Balance Sheet With Equity 2008-12-31
66
67 || 2008-12-31
68 ====================++============
69 Assets ||
70 --------------------++------------
71 assets:bank:saving || $1
72 assets:cash || $-2
73 --------------------++------------
74 || $-1
75 ====================++============
76 Liabilities ||
77 --------------------++------------
78 liabilities:debts || $-1
79 --------------------++------------
80 || $-1
81 ====================++============
82 Equity ||
83 --------------------++------------
84 --------------------++------------
85 || 0
86 ====================++============
87 Net: || 0
88
89 This command is a higher-level variant of the balance command, and
90 supports many of that command's features, such as multi-period reports.
91 It is similar to hledger balance -H assets liabilities equity, but with
92 smarter account detection, and liabilities/equity displayed with their
93 sign flipped.
94
95 This report is the easiest way to see if the accounting equation (A+L+E
96 = 0) is satisfied (after you have done a close --retain to merge
97 revenues and expenses with equity, and perhaps added --infer-equity to
98 balance your commodity conversions).
99
100 This command also supports the output destination and output format
101 options The output formats supported are txt, csv, tsv, html, and json.