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

;doc:close: edits

Browse Source
This commit is contained in:
Simon Michael 2024-01-20 16:07:00 -10:00
parent 6b5b467cce
commit 5d073e16e3
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
hledger/Hledger/Cli/Commands/Close.md
View File

@ -13,7 +13,7 @@ _FLAGS
`close` currently has six modes, selected by a single mode flag: `close` currently has six modes, selected by a single mode flag:
### `close --migrate` ### close --migrate
This is the most common mode. This is the most common mode.
It prints a "closing balances" transaction that zeroes out all asset and liability balances (by default), It prints a "closing balances" transaction that zeroes out all asset and liability balances (by default),
@ -34,24 +34,24 @@ Eg if you want to include equity, you can add `assets liabilities equity` or [`t
(The balancing account is always excluded.) (The balancing account is always excluded.)
Revenues and expenses usually are not migrated to a new file directly; see `--retain` below. Revenues and expenses usually are not migrated to a new file directly; see `--retain` below.
### `close --close` ### close --close
This prints just the closing balances transaction of `--migrate`. This prints just the closing balances transaction of `--migrate`.
It is the default behaviour if you specify no mode flag. It is the default behaviour if you specify no mode flag.
Using the customisation options below, you can move balances from any set of accounts to a different account. Using the customisation options below, you can move balances from any set of accounts to a different account.
### `close --open` ### close --open
This prints just the opening balances transaction of `--migrate`. This prints just the opening balances transaction of `--migrate`.
It is similar to [Ledger's equity command](https://ledger-cli.org/doc/ledger3.html#The-equity-command). It is similar to [Ledger's equity command](https://ledger-cli.org/doc/ledger3.html#The-equity-command).
### `close --assert` ### close --assert
This prints a "closing balances" transaction that just declares [balance assertions](#balance-assertions) This prints a "closing balances" transaction that just declares [balance assertions](#balance-assertions)
for the current balances without changing them. for the current balances without changing them.
It could be useful as documention and to guard against changes. It could be useful as documention and to guard against changes.
### `close --assign` ### close --assign
This prints an "opening balances" transaction that This prints an "opening balances" transaction that
restores the account balances using [balance assignments](#balance-assignments). restores the account balances using [balance assignments](#balance-assignments).
@ -61,7 +61,7 @@ However, omitting the closing balances transaction would unbalance equity.
This is relatively harmless for personal reports, but it disturbs the accounting equation, removing a source of error detection. This is relatively harmless for personal reports, but it disturbs the accounting equation, removing a source of error detection.
So `--migrate` is generally the best way to set to set balances in new files, [for now](https://github.com/simonmichael/hledger/issues/2151). So `--migrate` is generally the best way to set to set balances in new files, [for now](https://github.com/simonmichael/hledger/issues/2151).
### `close --retain` ### close --retain
This is like `--close` with different defaults: This is like `--close` with different defaults:
it prints a "retain earnings" transaction that transfers revenue and expense balances to `equity:retained earnings`. it prints a "retain earnings" transaction that transfers revenue and expense balances to `equity:retained earnings`.
@ -74,7 +74,7 @@ to consolidate revenues and expenses into the main equity balance.
In personal accounting you generally don't need to do this, In personal accounting you generally don't need to do this,
unless you want the `balancesheetequity` report to show a zero total, demonstrating that the accounting equation (A-L=E) is satisfied. unless you want the `balancesheetequity` report to show a zero total, demonstrating that the accounting equation (A-L=E) is satisfied.
### `close` customisation ### close customisation
In all modes, the following things can be overridden: In all modes, the following things can be overridden: