Skip to content

Commit

Permalink
doc: new zerosum link features
Browse files Browse the repository at this point in the history
  • Loading branch information
redstreet committed Apr 19, 2024
1 parent e1426a4 commit e73097c
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions beancount_reds_plugins/zerosum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,19 @@ the source accounts, making the config below equivalent to the config above:
}"
```

## Features

Optionally, the plugin can add transaction level or posting level links, tying together
related transactions or postings. Transaction level links use Beancount's linking
feature. Beancount does not support posting level links, and thus, these use metadata.
Both use randomly generated link ids.

To use these, see the following options documented at the top of `zerosum.py`:
- 'match_metadata'
- 'match_metadata_name'
- 'link_transactions'
- 'link_prefix'

## Example
See the included zerosum-example.beancount as the minimum beancount file for this example.

Expand Down

0 comments on commit e73097c

Please sign in to comment.