Debian Codegraph @

Hledger/Cli/Commands/Incomestatement.txt

raw
1 incomestatement
2
3 (is)
4
5 Show revenue inflows and expense outflows during the report period.
6 Amounts are shown with normal positive sign, as in conventional
7 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 (default)
22 --cumulative accumulation mode: accumulate amounts from report
23 start (specified by e.g. -b/--begin) to column end
24 -H --historical accumulation mode: accumulate amounts from
25 journal start to column end (includes postings
26 before report start date)
27 -l --flat list/tree mode: show accounts as a flat list
28 (default). Amounts exclude subaccount amounts,
29 except where the account is depth-clipped.
30 -t --tree list/tree mode: show accounts as a tree. Amounts
31 include subaccount amounts.
32 --drop=N in list mode, omit N leading account name parts
33 --declared include non-parent declared accounts (best used
34 with -E)
35 -A --average show a row average column (in multicolumn
36 reports)
37 -T --row-total show a row total column (in multicolumn reports)
38 --summary-only display only row summaries (e.g. row total,
39 average) (in multicolumn reports)
40 -N --no-total omit the final total row
41 --no-elide in tree mode, don't squash boring parent accounts
42 --format=FORMATSTR use this custom line format (in simple reports)
43 -S --sort-amount sort by amount instead of account code/name
44 -% --percent express values in percentage of each column's
45 total
46 --layout=ARG how to show multi-commodity amounts:
47 'wide[,WIDTH]': all commodities on one line
48 'tall' : each commodity on a new line
49 'bare' : bare numbers, symbols in a column
50 --base-url=URLPREFIX in html output, generate hyperlinks to
51 hledger-web, with this prefix. (Usually the base
52 url shown by hledger-web; can also be relative.)
53 -O --output-format=FMT select the output format. Supported formats:
54 txt, html, csv, tsv, json.
55 -o --output-file=FILE write output to FILE. A file extension matching
56 one of the above formats selects that format.
57
58 This command displays an income statement, showing revenues and expenses
59 during one or more periods.
60
61 It shows accounts declared with the Revenue or Expense type (see account
62 types). Or if no such accounts are declared, it shows top-level accounts
63 named revenue or income or expense (case insensitive, plurals allowed)
64 and their subaccounts.
65
66 Example:
67
68 $ hledger incomestatement
69 Income Statement 2008
70
71 || 2008
72 ===================++======
73 Revenues ||
74 -------------------++------
75 income:gifts || $1
76 income:salary || $1
77 -------------------++------
78 || $2
79 ===================++======
80 Expenses ||
81 -------------------++------
82 expenses:food || $1
83 expenses:supplies || $1
84 -------------------++------
85 || $2
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 '(revenues|income)' expenses, but with
92 smarter account detection, and revenues/income displayed with their sign
93 flipped.
94
95 This command also supports the output destination and output format
96 options The output formats supported are txt, csv, tsv (Added in 1.32),
97 html, and json.