Modulehledger-lib-1.52.4GHC2021

Hledger.Reports.MultiBalanceReport

Multi-column balance reports, used by the balance command.

2 types
10 values

Packagehledger-lib-1.52.4
Exports12
LanguageGHC2021
LicenceGPL-3.0-or-later
SourceMultiBalanceReport.hs

typetype MultiBalanceReport = PeriodicReport DisplayName MixedAmount

A multi balance report is a kind of periodic report, where the amounts correspond to balance changes or ending balances in a given period. It has:

a list of each column's period (date span)
a list of rows, each containing:

the full account name, display name, and display depth
A list of amounts, one for each column.
the total of the row's amounts for a periodic report
the average of the row's amounts

the column totals, and the overall grand total (or zero for cumulative/historical reports) and grand average.

typetype MultiBalanceReportRow = PeriodicReportRow DisplayName MixedAmount

valuemultiBalanceReport :: ReportSpec -> Journal -> MultiBalanceReport

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. If the normalbalance_ option is set, it adjusts the sorting and sign of amounts (see ReportOpts and CompoundBalanceCommand). hledger's most powerful and useful report, used by the balance command (in multiperiod mode) and (via compoundBalanceReport) by the bscfis commands.

valuemultiBalanceReportWith

A helper for multiBalanceReport. This one takes some extra arguments, a PriceOracle to be used for looking up market prices, and a set of AccountNames which should not be elided. Commands which run multiple reports (bs etc.) can generate the price oracle just once for efficiency, passing it to each report by calling this function directly.

valuecompoundBalanceReport

:: ReportSpec
-> Journal
-> [CBCSubreportSpec a]
-> CompoundPeriodicReport a MixedAmount

Generate a compound balance report from a list of CBCSubreportSpec. This shares postings between the subreports.

valuecompoundBalanceReportWith

:: ReportSpec
-> Journal
-> PriceOracle
-> [CBCSubreportSpec a]
-> CompoundPeriodicReport a MixedAmount

A helper for compoundBalanceReport, similar to multiBalanceReportWith.

Helper functions

6 declarations

valuemakeReportQuery :: ReportSpec -> DateSpan -> ReportSpec

Remove any date queries and insert queries from the report span. The user's query expanded to the report span if there is one (otherwise any date queries are left as-is, which handles the hledger-ui+future txns case above).

valuegetPostings :: ReportSpec -> Journal -> PriceOracle -> DateSpan -> [Posting]

Gather postings matching the query within the report period.

valuegenerateMultiBalanceAccount

Generate the Account for the requested multi-balance report from a list of Postings.

valuegeneratePeriodicReport

:: Show c
=> forall a. ReportOpts -> (BalanceData -> MixedAmount) -> a -> Account b -> PeriodicReportRow a c
-> b -> MixedAmount
-> c -> MixedAmount
-> ReportOpts
-> Maybe DayPartition
-> Account b
-> PeriodicReport DisplayName c

Lay out a set of postings grouped by date span into a regular matrix with rows given by AccountName and columns by DateSpan, then generate a MultiBalanceReport from the columns.

valuemakePeriodicReportRow

:: c
-> Map Day c -> (c, c)
-> ReportOpts
-> b -> c
-> a
-> Account b
-> PeriodicReportRow a c

Build a report row.

Calculate the column totals. These are always the sum of column amounts.

valuetests_MultiBalanceReport :: TestTree