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

;doc: account type updates (#1822)

Browse Source
This commit is contained in:
Simon Michael 2022-02-03 15:36:25 -10:00
parent 31fdcdb8ef
commit 4ec441925a
1 changed files with 20 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
hledger/hledger.m4.md
View File

@ -847,12 +847,12 @@ Match real or virtual postings respectively.
**`status:, status:!, status:*`**\ **`status:, status:!, status:*`**\
Match unmarked, pending, or cleared transactions respectively. Match unmarked, pending, or cleared transactions respectively.
**`type:ACCTTYPES`**\ **`type:TYPECODES`**\
Match by account type (see [Declaring accounts > Account types](#account-types)). Match by account type (see [Declaring accounts > Account types](#account-types)).
`ACCTTYPES` is one or more of the single-letter account type codes `TYPECODES` is one or more of the single-letter account type codes
`ALERXCV`, case insensitive. `ALERXCV`, case insensitive.
Eg: `hledger bal type:AL` shows asset and liability balances. Note `type:A` and `type:E` will also match their respective subtypes `C` (Cash) and `V` (Conversion).
Note: certain kinds of account alias can disrupt this, see Certain kinds of account alias can disrupt account types, see
[Rewriting accounts > Aliases and account types](#aliases-and-account-types). [Rewriting accounts > Aliases and account types](#aliases-and-account-types).
**`tag:REGEX[=REGEX]`**\ **`tag:REGEX[=REGEX]`**\
@ -3088,27 +3088,30 @@ account equity:conversion ; type: V
Here are some tips for working with account types. Here are some tips for working with account types.
- The rules for inferring types from account names are as follows (see also [Regular expressions](#regular-expressions)): - The rules for inferring types from account names are as follows.
Note the Cash regexp changed in hledger 1.24.99.2.
See also [Regular expressions](#regular-expressions).
These are just a convenience that sometimes help new users get going;
if they don't work for you, just ignore them and declare your account types.
<!-- monospace to work around https://github.com/simonmichael/hledger/issues/1573 --> <!-- monospace to work around https://github.com/simonmichael/hledger/issues/1573 -->
``` ```
If account's name matches this case insensitive regular expression: | its type is: If account's name contains this (CI) regular expression: | its type is:
--------------------------------------------------------------------|------------- ---------------------------------------------------------|-------------
^assets?(:|$) | ^assets:(.+:)?(cash|bank)(:|$) | Cash
and does not contain regexp (investment|receivable|:A/R|:fixed) | Cash ^assets?(:|$) | Asset
otherwise | Asset ^(debts?|liabilit(y|ies))(:|$) | Liability
^(debts?|liabilit(y|ies))(:|$) | Liability ^equity:(trad(e|ing)|conversion)s?(:|$) | Conversion
^equity:(trad(e|ing)|conversion)s?(:|$) | Conversion ^equity(:|$) | Equity
^equity(:|$) | Equity ^(income|revenue)s?(:|$) | Revenue
^(income|revenue)s?(:|$) | Revenue ^expenses?(:|$) | Expense
^expenses?(:|$) | Expense
``` ```
<!-- <!--
hledger tries to identify at least one account for each account type (Asset, Liability, Equity, Revenue, Expense, Cash, Conversion..). hledger tries to identify at least one account for each account type (Asset, Liability, Equity, Revenue, Expense, Cash, Conversion..).
In each case, if no account has been declared with that type, it looks for accounts matched by the appropriate regular expression above. In each case, if no account has been declared with that type, it looks for accounts matched by the appropriate regular expression above.
--> -->
- If you declare any account types, it's a good idea to declare an account for all of them (or at least the five main types), - If you declare any account types, it's a good idea to declare an account for all of them,
because a mixture of declared and auto-detected types can disrupt certain reports. because a mixture of declared and name-inferred types can disrupt certain reports.
- Certain uses of [account aliases](#account-aliases) can disrupt account types. - Certain uses of [account aliases](#account-aliases) can disrupt account types.
See [Rewriting accounts > Aliases and account types](#aliases-and-account-types). See [Rewriting accounts > Aliases and account types](#aliases-and-account-types).