<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Hledger.Data.Journal</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Hledger-Data-Journal.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Hledger-Data-Journal.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">hledger-lib-0.14: Reusable types and utilities for the hledger accounting tool and financial apps in general.</p></div><div id="content"><div id="module-header"><p class="caption">Hledger.Data.Journal</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A <code><a href="Hledger-Data-Types.html#t:Journal">Journal</a></code> is a set of <code><a href="Hledger-Data-Types.html#t:Transaction">Transaction</a></code>s and related data, usually parsed
from a hledger/ledger journal file or timelog. This is the primary hledger
data object.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:nulljournal">nulljournal</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:nullctx">nullctx</a> :: <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a></li><li class="src short"><a href="#v:journalFilePath">journalFilePath</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a></li><li class="src short"><a href="#v:journalFilePaths">journalFilePaths</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a>]</li><li class="src short"><a href="#v:mainfile">mainfile</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a>, <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</li><li class="src short"><a href="#v:addTransaction">addTransaction</a> :: <a href="Hledger-Data-Types.html#t:Transaction">Transaction</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:addModifierTransaction">addModifierTransaction</a> :: <a href="Hledger-Data-Types.html#t:ModifierTransaction">ModifierTransaction</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:addPeriodicTransaction">addPeriodicTransaction</a> :: <a href="Hledger-Data-Types.html#t:PeriodicTransaction">PeriodicTransaction</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:addHistoricalPrice">addHistoricalPrice</a> :: <a href="Hledger-Data-Types.html#t:HistoricalPrice">HistoricalPrice</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:addTimeLogEntry">addTimeLogEntry</a> :: <a href="Hledger-Data-Types.html#t:TimeLogEntry">TimeLogEntry</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:journalPostings">journalPostings</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>]</li><li class="src short"><a href="#v:journalAccountNamesUsed">journalAccountNamesUsed</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]</li><li class="src short"><a href="#v:journalAccountNames">journalAccountNames</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]</li><li class="src short"><a href="#v:journalAccountNameTree">journalAccountNameTree</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a></li><li class="src short"><a href="#v:filterJournalTransactions">filterJournalTransactions</a> :: <a href="Hledger-Data-Types.html#t:FilterSpec">FilterSpec</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:filterJournalPostings">filterJournalPostings</a> :: <a href="Hledger-Data-Types.html#t:FilterSpec">FilterSpec</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:filterJournalTransactionsByDescription">filterJournalTransactionsByDescription</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:filterJournalTransactionsByDate">filterJournalTransactionsByDate</a> :: <a href="Hledger-Data-Types.html#t:DateSpan">DateSpan</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:filterJournalTransactionsByClearedStatus">filterJournalTransactionsByClearedStatus</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:filterJournalPostingsByClearedStatus">filterJournalPostingsByClearedStatus</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:filterJournalPostingsByRealness">filterJournalPostingsByRealness</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:filterJournalPostingsByEmpty">filterJournalPostingsByEmpty</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:filterJournalTransactionsByDepth">filterJournalTransactionsByDepth</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:filterJournalPostingsByDepth">filterJournalPostingsByDepth</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:filterJournalTransactionsByAccount">filterJournalTransactionsByAccount</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:filterJournalPostingsByAccount">filterJournalPostingsByAccount</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:journalSelectingDate">journalSelectingDate</a> :: <a href="Hledger-Data-Types.html#t:WhichDate">WhichDate</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:journalFinalise">journalFinalise</a> :: <a href="/usr/share/doc/ghc/html/libraries/old-time-1.0.0.6/System-Time.html#t:ClockTime">ClockTime</a> -> <a href="/usr/share/doc/ghc/html/libraries/time-1.2.0.3/Data-Time-LocalTime.html#t:LocalTime">LocalTime</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:journalBalanceTransactions">journalBalanceTransactions</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:journalCanonicaliseAmounts">journalCanonicaliseAmounts</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:journalApplyHistoricalPrices">journalApplyHistoricalPrices</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:journalHistoricalPriceFor">journalHistoricalPriceFor</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="/usr/share/doc/ghc/html/libraries/time-1.2.0.3/Data-Time-Calendar.html#t:Day">Day</a> -> <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a></li><li class="src short"><a href="#v:journalCloseTimeLogEntries">journalCloseTimeLogEntries</a> :: <a href="/usr/share/doc/ghc/html/libraries/time-1.2.0.3/Data-Time-LocalTime.html#t:LocalTime">LocalTime</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:journalConvertAmountsToCost">journalConvertAmountsToCost</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:journalCanonicalCommodities">journalCanonicalCommodities</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a></li><li class="src short"><a href="#v:journalAmountCommodities">journalAmountCommodities</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="Hledger-Data-Types.html#t:Commodity">Commodity</a>]</li><li class="src short"><a href="#v:journalAmountAndPriceCommodities">journalAmountAndPriceCommodities</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="Hledger-Data-Types.html#t:Commodity">Commodity</a>]</li><li class="src short"><a href="#v:amountCommodities">amountCommodities</a> :: <a href="Hledger-Data-Types.html#t:Amount">Amount</a> -> [<a href="Hledger-Data-Types.html#t:Commodity">Commodity</a>]</li><li class="src short"><a href="#v:journalAmounts">journalAmounts</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a>]</li><li class="src short"><a href="#v:journalDateSpan">journalDateSpan</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:DateSpan">DateSpan</a></li><li class="src short"><a href="#v:matchpats">matchpats</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:journalAccountInfo">journalAccountInfo</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> (<a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>, <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> <a href="Hledger-Data-Types.html#t:Account">Account</a>)</li><li class="src short"><a href="#v:groupPostings">groupPostings</a> :: [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>] -> (<a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>, <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>], <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a>, <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a>)</li><li class="src short"><a href="#v:calculateBalances">calculateBalances</a> :: <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> (<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>]) -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> (<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>, (<a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a>, <a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a>))</li><li class="src short"><a href="#v:postingsByAccount">postingsByAccount</a> :: [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>] -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>]</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:nulljournal" class="def">nulljournal</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#nulljournal" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:nullctx" class="def">nullctx</a> :: <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a><a href="src/Hledger-Data-Journal.html#nullctx" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:journalFilePath" class="def">journalFilePath</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a><a href="src/Hledger-Data-Journal.html#journalFilePath" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:journalFilePaths" class="def">journalFilePaths</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a>]<a href="src/Hledger-Data-Journal.html#journalFilePaths" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:mainfile" class="def">mainfile</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a>, <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)<a href="src/Hledger-Data-Journal.html#mainfile" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:addTransaction" class="def">addTransaction</a> :: <a href="Hledger-Data-Types.html#t:Transaction">Transaction</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#addTransaction" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:addModifierTransaction" class="def">addModifierTransaction</a> :: <a href="Hledger-Data-Types.html#t:ModifierTransaction">ModifierTransaction</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#addModifierTransaction" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:addPeriodicTransaction" class="def">addPeriodicTransaction</a> :: <a href="Hledger-Data-Types.html#t:PeriodicTransaction">PeriodicTransaction</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#addPeriodicTransaction" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:addHistoricalPrice" class="def">addHistoricalPrice</a> :: <a href="Hledger-Data-Types.html#t:HistoricalPrice">HistoricalPrice</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#addHistoricalPrice" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:addTimeLogEntry" class="def">addTimeLogEntry</a> :: <a href="Hledger-Data-Types.html#t:TimeLogEntry">TimeLogEntry</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#addTimeLogEntry" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:journalPostings" class="def">journalPostings</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>]<a href="src/Hledger-Data-Journal.html#journalPostings" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:journalAccountNamesUsed" class="def">journalAccountNamesUsed</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]<a href="src/Hledger-Data-Journal.html#journalAccountNamesUsed" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:journalAccountNames" class="def">journalAccountNames</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]<a href="src/Hledger-Data-Journal.html#journalAccountNames" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:journalAccountNameTree" class="def">journalAccountNameTree</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a><a href="src/Hledger-Data-Journal.html#journalAccountNameTree" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:filterJournalTransactions" class="def">filterJournalTransactions</a> :: <a href="Hledger-Data-Types.html#t:FilterSpec">FilterSpec</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#filterJournalTransactions" class="link">Source</a></p><div class="doc"><p>Keep only transactions we are interested in, as described by
the filter specification. May also massage the data a little.
</p></div></div><div class="top"><p class="src"><a name="v:filterJournalPostings" class="def">filterJournalPostings</a> :: <a href="Hledger-Data-Types.html#t:FilterSpec">FilterSpec</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#filterJournalPostings" class="link">Source</a></p><div class="doc"><p>Keep only postings we are interested in, as described by
the filter specification. May also massage the data a little.
This can leave unbalanced transactions.
</p></div></div><div class="top"><p class="src"><a name="v:filterJournalTransactionsByDescription" class="def">filterJournalTransactionsByDescription</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#filterJournalTransactionsByDescription" class="link">Source</a></p><div class="doc"><p>Keep only transactions whose description matches the description patterns.
</p></div></div><div class="top"><p class="src"><a name="v:filterJournalTransactionsByDate" class="def">filterJournalTransactionsByDate</a> :: <a href="Hledger-Data-Types.html#t:DateSpan">DateSpan</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#filterJournalTransactionsByDate" class="link">Source</a></p><div class="doc"><p>Keep only transactions which fall between begin and end dates.
We include transactions on the begin date and exclude transactions on the end
date, like ledger. An empty date string means no restriction.
</p></div></div><div class="top"><p class="src"><a name="v:filterJournalTransactionsByClearedStatus" class="def">filterJournalTransactionsByClearedStatus</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#filterJournalTransactionsByClearedStatus" class="link">Source</a></p><div class="doc"><p>Keep only transactions which have the requested cleared/uncleared
status, if there is one.
</p></div></div><div class="top"><p class="src"><a name="v:filterJournalPostingsByClearedStatus" class="def">filterJournalPostingsByClearedStatus</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#filterJournalPostingsByClearedStatus" class="link">Source</a></p><div class="doc"><p>Keep only postings which have the requested cleared/uncleared status,
if there is one.
</p></div></div><div class="top"><p class="src"><a name="v:filterJournalPostingsByRealness" class="def">filterJournalPostingsByRealness</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#filterJournalPostingsByRealness" class="link">Source</a></p><div class="doc"><p>Strip out any virtual postings, if the flag is true, otherwise do
no filtering.
</p></div></div><div class="top"><p class="src"><a name="v:filterJournalPostingsByEmpty" class="def">filterJournalPostingsByEmpty</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#filterJournalPostingsByEmpty" class="link">Source</a></p><div class="doc"><p>Strip out any postings with zero amount, unless the flag is true.
</p></div></div><div class="top"><p class="src"><a name="v:filterJournalTransactionsByDepth" class="def">filterJournalTransactionsByDepth</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#filterJournalTransactionsByDepth" class="link">Source</a></p><div class="doc"><p>Keep only transactions which affect accounts deeper than the specified depth.
</p></div></div><div class="top"><p class="src"><a name="v:filterJournalPostingsByDepth" class="def">filterJournalPostingsByDepth</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#filterJournalPostingsByDepth" class="link">Source</a></p><div class="doc"><p>Strip out any postings to accounts deeper than the specified depth
(and any transactions which have no postings as a result).
</p></div></div><div class="top"><p class="src"><a name="v:filterJournalTransactionsByAccount" class="def">filterJournalTransactionsByAccount</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#filterJournalTransactionsByAccount" class="link">Source</a></p><div class="doc"><p>Keep only transactions which affect accounts matched by the account patterns.
More precisely: each positive account pattern excludes transactions
which do not contain a posting to a matched account, and each negative
account pattern excludes transactions containing a posting to a matched
account.
</p></div></div><div class="top"><p class="src"><a name="v:filterJournalPostingsByAccount" class="def">filterJournalPostingsByAccount</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#filterJournalPostingsByAccount" class="link">Source</a></p><div class="doc"><p>Keep only postings which affect accounts matched by the account patterns.
This can leave transactions unbalanced.
</p></div></div><div class="top"><p class="src"><a name="v:journalSelectingDate" class="def">journalSelectingDate</a> :: <a href="Hledger-Data-Types.html#t:WhichDate">WhichDate</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#journalSelectingDate" class="link">Source</a></p><div class="doc"><p>Convert this journal's transactions' primary date to either the
actual or effective date.
</p></div></div><div class="top"><p class="src"><a name="v:journalFinalise" class="def">journalFinalise</a> :: <a href="/usr/share/doc/ghc/html/libraries/old-time-1.0.0.6/System-Time.html#t:ClockTime">ClockTime</a> -> <a href="/usr/share/doc/ghc/html/libraries/time-1.2.0.3/Data-Time-LocalTime.html#t:LocalTime">LocalTime</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#journalFinalise" class="link">Source</a></p><div class="doc"><p>Do post-parse processing on a journal, to make it ready for use.
</p></div></div><div class="top"><p class="src"><a name="v:journalBalanceTransactions" class="def">journalBalanceTransactions</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#journalBalanceTransactions" class="link">Source</a></p><div class="doc"><p>Fill in any missing amounts and check that all journal transactions
balance, or return an error message. This is done after parsing all
amounts and working out the canonical commodities, since balancing
depends on display precision. Reports only the first error encountered.
</p></div></div><div class="top"><p class="src"><a name="v:journalCanonicaliseAmounts" class="def">journalCanonicaliseAmounts</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#journalCanonicaliseAmounts" class="link">Source</a></p><div class="doc"><p>Convert all the journal's amounts to their canonical display
settings. Ie, all amounts in a given commodity will use (a) the
display settings of the first, and (b) the greatest precision, of the
amounts in that commodity. Prices are canonicalised as well, so consider
calling journalApplyHistoricalPrices before this.
</p></div></div><div class="top"><p class="src"><a name="v:journalApplyHistoricalPrices" class="def">journalApplyHistoricalPrices</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#journalApplyHistoricalPrices" class="link">Source</a></p><div class="doc"><p>Apply this journal's historical price records to unpriced amounts where possible.
</p></div></div><div class="top"><p class="src"><a name="v:journalHistoricalPriceFor" class="def">journalHistoricalPriceFor</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="/usr/share/doc/ghc/html/libraries/time-1.2.0.3/Data-Time-Calendar.html#t:Day">Day</a> -> <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a><a href="src/Hledger-Data-Journal.html#journalHistoricalPriceFor" class="link">Source</a></p><div class="doc"><p>Get the price for a commodity on the specified day from the price database, if known.
Does only one lookup step, ie will not look up the price of a price.
</p></div></div><div class="top"><p class="src"><a name="v:journalCloseTimeLogEntries" class="def">journalCloseTimeLogEntries</a> :: <a href="/usr/share/doc/ghc/html/libraries/time-1.2.0.3/Data-Time-LocalTime.html#t:LocalTime">LocalTime</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#journalCloseTimeLogEntries" class="link">Source</a></p><div class="doc"><p>Close any open timelog sessions in this journal using the provided current time.
</p></div></div><div class="top"><p class="src"><a name="v:journalConvertAmountsToCost" class="def">journalConvertAmountsToCost</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Data-Journal.html#journalConvertAmountsToCost" class="link">Source</a></p><div class="doc"><p>Convert all this journal's amounts to cost by applying their prices, if any.
</p></div></div><div class="top"><p class="src"><a name="v:journalCanonicalCommodities" class="def">journalCanonicalCommodities</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a><a href="src/Hledger-Data-Journal.html#journalCanonicalCommodities" class="link">Source</a></p><div class="doc"><p>Get this journal's unique, display-preference-canonicalised commodities, by symbol.
</p></div></div><div class="top"><p class="src"><a name="v:journalAmountCommodities" class="def">journalAmountCommodities</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="Hledger-Data-Types.html#t:Commodity">Commodity</a>]<a href="src/Hledger-Data-Journal.html#journalAmountCommodities" class="link">Source</a></p><div class="doc"><p>Get all this journal's amounts' commodities, in the order parsed.
</p></div></div><div class="top"><p class="src"><a name="v:journalAmountAndPriceCommodities" class="def">journalAmountAndPriceCommodities</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="Hledger-Data-Types.html#t:Commodity">Commodity</a>]<a href="src/Hledger-Data-Journal.html#journalAmountAndPriceCommodities" class="link">Source</a></p><div class="doc"><p>Get all this journal's amount and price commodities, in the order parsed.
</p></div></div><div class="top"><p class="src"><a name="v:amountCommodities" class="def">amountCommodities</a> :: <a href="Hledger-Data-Types.html#t:Amount">Amount</a> -> [<a href="Hledger-Data-Types.html#t:Commodity">Commodity</a>]<a href="src/Hledger-Data-Journal.html#amountCommodities" class="link">Source</a></p><div class="doc"><p>Get this amount's commodity and any commodities referenced in its price.
</p></div></div><div class="top"><p class="src"><a name="v:journalAmounts" class="def">journalAmounts</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> [<a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a>]<a href="src/Hledger-Data-Journal.html#journalAmounts" class="link">Source</a></p><div class="doc"><p>Get all this journal's amounts, in the order parsed.
</p></div></div><div class="top"><p class="src"><a name="v:journalDateSpan" class="def">journalDateSpan</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> <a href="Hledger-Data-Types.html#t:DateSpan">DateSpan</a><a href="src/Hledger-Data-Journal.html#journalDateSpan" class="link">Source</a></p><div class="doc"><p>The (fully specified) date span containing this journal's transactions,
or DateSpan Nothing Nothing if there are none.
</p></div></div><div class="top"><p class="src"><a name="v:matchpats" class="def">matchpats</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Hledger-Data-Journal.html#matchpats" class="link">Source</a></p><div class="doc"><p>Check if a set of hledger account/description filter patterns matches the
given account name or entry description. Patterns are case-insensitive
regular expressions. Prefixed with not:, they become anti-patterns.
</p></div></div><div class="top"><p class="src"><a name="v:journalAccountInfo" class="def">journalAccountInfo</a> :: <a href="Hledger-Data-Types.html#t:Journal">Journal</a> -> (<a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>, <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> <a href="Hledger-Data-Types.html#t:Account">Account</a>)<a href="src/Hledger-Data-Journal.html#journalAccountInfo" class="link">Source</a></p><div class="doc"><p>Calculate the account tree and all account balances from a journal's
postings, returning the results for efficient lookup.
</p></div></div><div class="top"><p class="src"><a name="v:groupPostings" class="def">groupPostings</a> :: [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>] -> (<a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>, <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>], <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a>, <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a>)<a href="src/Hledger-Data-Journal.html#groupPostings" class="link">Source</a></p><div class="doc"><p>Given a list of postings, return an account name tree and three query
functions that fetch postings, subaccount-excluding-balance and
subaccount-including-balance by account name.
</p></div></div><div class="top"><p class="src"><a name="v:calculateBalances" class="def">calculateBalances</a> :: <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> (<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>]) -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> (<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>, (<a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a>, <a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a>))<a href="src/Hledger-Data-Journal.html#calculateBalances" class="link">Source</a></p><div class="doc"><p>Add subaccount-excluding and subaccount-including balances to a tree
of account names somewhat efficiently, given a function that looks up
transactions by account name.
</p></div></div><div class="top"><p class="src"><a name="v:postingsByAccount" class="def">postingsByAccount</a> :: [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>] -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>]<a href="src/Hledger-Data-Journal.html#postingsByAccount" class="link">Source</a></p><div class="doc"><p>Convert a list of postings to a map from account name to that
account's postings.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
