Debian Codegraph @

Hledger/Cli/Commands/Balancesheet.txt

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