| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Hledger.Reports.MultiBalanceReports
Description
Multi-column balance reports, used by the balance command.
- newtype MultiBalanceReport = MultiBalanceReport ([DateSpan], [MultiBalanceReportRow], MultiBalanceTotalsRow)
- type MultiBalanceReportRow = (RenderableAccountName, [MixedAmount], MixedAmount, MixedAmount)
- multiBalanceReport :: ReportOpts -> Query -> Journal -> MultiBalanceReport
Documentation
newtype MultiBalanceReport Source
A multi balance report is a balance report with one or more columns. It has:
- a list of each column's date span
- a list of rows, each containing a renderable account name and the amounts to show in each column
- a list of each column's final total
The meaning of the amounts depends on the type of multi balance
report, of which there are three: periodic, cumulative and historical
(see BalanceType and Hledger.Cli.Balance).
Constructors
| MultiBalanceReport ([DateSpan], [MultiBalanceReportRow], MultiBalanceTotalsRow) |
Instances
type MultiBalanceReportRow = (RenderableAccountName, [MixedAmount], MixedAmount, MixedAmount) Source
A row in a multi balance report has
- An account name, with rendering hints
- A list of amounts to be shown in each of the report's columns.
- The total of the row amounts.
- The average of the row amounts.
multiBalanceReport :: ReportOpts -> Query -> Journal -> MultiBalanceReport Source
Generate a multicolumn balance report for the matched accounts, showing the change of balance, accumulated balance, or historical balance in each of the specified periods.