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

doc: journal: document payee directive

Browse Source
This commit is contained in:
Simon Michael 2020-12-31 12:55:24 -08:00
parent 3898a66dda
commit fdeaa3cd8b
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
hledger/hledger.m4.md
View File

@ -2188,6 +2188,7 @@ Note part of this table is hidden when viewed in a web browser - scroll it sidew
| [`commodity`] | | `format` | declare a commodity and its number notation & display style | number notation: following entries in that commodity in all files <!-- or until end of current file ? -->; <br>display style: amounts of that commodity in reports | [`commodity`] | | `format` | declare a commodity and its number notation & display style | number notation: following entries in that commodity in all files <!-- or until end of current file ? -->; <br>display style: amounts of that commodity in reports
| [`D`] | | | declare a commodity to be used for commodityless amounts, and its number notation & display style | default commodity: following commodityless entries until end of current file; <br>number notation: following entries in that commodity until end of current file; <br>display style: amounts of that commodity in reports | [`D`] | | | declare a commodity to be used for commodityless amounts, and its number notation & display style | default commodity: following commodityless entries until end of current file; <br>number notation: following entries in that commodity until end of current file; <br>display style: amounts of that commodity in reports
| [`include`] | | | include entries/directives from another file | what the included directives affect | [`include`] | | | include entries/directives from another file | what the included directives affect
| [`payee`] | | | declare a payee name | following entries until end of current file
| [`P`] | | | declare a market price for a commodity | amounts of that commodity in reports, when -V is used | [`P`] | | | declare a market price for a commodity | amounts of that commodity in reports, when -V is used
| [`Y`] | | | declare a year for yearless dates | following entries until end of current file | [`Y`] | | | declare a year for yearless dates | following entries until end of current file
| [`=`] | | | declare an auto posting rule, adding postings to other transactions | all entries in parent/current/child files (but not sibling files, see [#1212](https://github.com/simonmichael/hledger/issues/1212)) | [`=`] | | | declare an auto posting rule, adding postings to other transactions | all entries in parent/current/child files (but not sibling files, see [#1212](https://github.com/simonmichael/hledger/issues/1212))
@ -2300,6 +2301,16 @@ Y2010 ; change default year to 2010
assets assets
``` ```
## Declaring payees
The `payee` directive can be used to declare a limited set of payees which may appear in transaction descriptions.
The ["payees" check](#check) will report an error if any transaction refers to a payee that has not been declared.
Eg:
```journal
payee Whole Foods
```
## Declaring commodities ## Declaring commodities
The `commodity` directive has several functions: The `commodity` directive has several functions: