slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;areg: doc: clarify

Browse Source
This commit is contained in:
Simon Michael 2021-07-30 09:09:59 -10:00
parent 2f819725e5
commit aa60c46597
1 changed files with 14 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
hledger/Hledger/Cli/Commands/Aregister.md
View File

@ -9,14 +9,14 @@ _FLAGS
its subaccounts, with each line item representing a whole transaction - its subaccounts, with each line item representing a whole transaction -
as in bank statements, hledger-ui, hledger-web and other accounting apps. as in bank statements, hledger-ui, hledger-web and other accounting apps.
Note this is unlike the [`register`](#register) command, This is unlike the [`register`](#register) command,
which shows individual postings which shows individual postings, and not necessarily from a single account.
and does not always show a single account or a historical balance.
A reminder, "historical" balances include any balance from transactions Also, `aregister` always shows the historical running balance, which
before the report start date, so (if opening balances are recorded correctly) includes any balance from transactions before the report start date.
`aregister` will show the real-world balances of an account, as you would see So `aregister` should always show the accurate real-world account balance
in a bank statement. on each day. (Assuming opening balances are recorded correctly, and
allowing for date disagreements.)
As a quick rule of thumb, As a quick rule of thumb,
use `aregister` for reconciling real-world asset/liability accounts use `aregister` for reconciling real-world asset/liability accounts
@ -32,6 +32,13 @@ select the alphabetically first matched account.
Any additional arguments form a query which will filter the Any additional arguments form a query which will filter the
transactions shown. transactions shown.
An example: this shows the transactions and historical running balance
during july in the first account whose name contains "checking":
```shell
$ hledger areg checking date:jul
```
Each `aregister` line item shows: Each `aregister` line item shows:
- the transaction's date (or the relevant posting's date if different, see below) - the transaction's date (or the relevant posting's date if different, see below)
@ -62,16 +69,3 @@ To filter strictly by transaction date instead, add the `--txn-dates`
flag. If you use this flag and some of your postings have custom flag. If you use this flag and some of your postings have custom
dates, it's probably best to assume the running balance is wrong. dates, it's probably best to assume the running balance is wrong.
Examples:
Show all transactions and historical running balance in the first
account whose name contains "checking":
```shell
$ hledger areg checking
```
Show transactions and historical running balance in all asset accounts
during july:
```shell
$ hledger areg assets date:jul
```