<!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.Ledger</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-Ledger.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Hledger-Data-Ledger.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.Ledger</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A <code><a href="Hledger-Data-Types.html#t:Ledger">Ledger</a></code> is derived from a <code><a href="Hledger-Data-Types.html#t:Journal">Journal</a></code> by applying a filter specification
to select <code><a href="Hledger-Data-Types.html#t:Transaction">Transaction</a></code>s and <code><a href="Hledger-Data-Types.html#t:Posting">Posting</a></code>s of interest. It contains the
filtered journal and knows the resulting chart of accounts, account
balances, and postings in each account.
</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:nullledger">nullledger</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a></li><li class="src short"><a href="#v:journalToLedger">journalToLedger</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:Ledger">Ledger</a></li><li class="src short"><a href="#v:ledgerAccountNames">ledgerAccountNames</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]</li><li class="src short"><a href="#v:ledgerAccount">ledgerAccount</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</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:ledgerAccounts">ledgerAccounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]</li><li class="src short"><a href="#v:ledgerTopAccounts">ledgerTopAccounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]</li><li class="src short"><a href="#v:ledgerAccountsMatching">ledgerAccountsMatching</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:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]</li><li class="src short"><a href="#v:ledgerSubAccounts">ledgerSubAccounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> <a href="Hledger-Data-Types.html#t:Account">Account</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]</li><li class="src short"><a href="#v:ledgerPostings">ledgerPostings</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>]</li><li class="src short"><a href="#v:ledgerAccountTree">ledgerAccountTree</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:Ledger">Ledger</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:Account">Account</a></li><li class="src short"><a href="#v:ledgerAccountTreeAt">ledgerAccountTreeAt</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> <a href="Hledger-Data-Types.html#t:Account">Account</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/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:Account">Account</a>)</li><li class="src short"><a href="#v:ledgerDateSpan">ledgerDateSpan</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> <a href="Hledger-Data-Types.html#t:DateSpan">DateSpan</a></li><li class="src short"><a href="#v:accountnames">accountnames</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]</li><li class="src short"><a href="#v:account">account</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</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:accounts">accounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]</li><li class="src short"><a href="#v:topaccounts">topaccounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]</li><li class="src short"><a href="#v:accountsmatching">accountsmatching</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:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]</li><li class="src short"><a href="#v:subaccounts">subaccounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> <a href="Hledger-Data-Types.html#t:Account">Account</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]</li><li class="src short"><a href="#v:postings">postings</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>]</li><li class="src short"><a href="#v:commodities">commodities</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</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:accounttree">accounttree</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:Ledger">Ledger</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:Account">Account</a></li><li class="src short"><a href="#v:accounttreeat">accounttreeat</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> <a href="Hledger-Data-Types.html#t:Account">Account</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/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:Account">Account</a>)</li><li class="src short"><a href="#v:rawdatespan">rawdatespan</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> <a href="Hledger-Data-Types.html#t:DateSpan">DateSpan</a></li><li class="src short"><a href="#v:ledgeramounts">ledgeramounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a>]</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:nullledger" class="def">nullledger</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a><a href="src/Hledger-Data-Ledger.html#nullledger" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:journalToLedger" class="def">journalToLedger</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:Ledger">Ledger</a><a href="src/Hledger-Data-Ledger.html#journalToLedger" class="link">Source</a></p><div class="doc"><p>Filter a journal's transactions as specified, and then process them
to derive a ledger containing all balances, the chart of accounts,
canonicalised commodities etc.
</p></div></div><div class="top"><p class="src"><a name="v:ledgerAccountNames" class="def">ledgerAccountNames</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]<a href="src/Hledger-Data-Ledger.html#ledgerAccountNames" class="link">Source</a></p><div class="doc"><p>List a ledger's account names.
</p></div></div><div class="top"><p class="src"><a name="v:ledgerAccount" class="def">ledgerAccount</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</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-Ledger.html#ledgerAccount" class="link">Source</a></p><div class="doc"><p>Get the named account from a ledger.
</p></div></div><div class="top"><p class="src"><a name="v:ledgerAccounts" class="def">ledgerAccounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]<a href="src/Hledger-Data-Ledger.html#ledgerAccounts" class="link">Source</a></p><div class="doc"><p>List a ledger's accounts, in tree order
</p></div></div><div class="top"><p class="src"><a name="v:ledgerTopAccounts" class="def">ledgerTopAccounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]<a href="src/Hledger-Data-Ledger.html#ledgerTopAccounts" class="link">Source</a></p><div class="doc"><p>List a ledger's top-level accounts, in tree order
</p></div></div><div class="top"><p class="src"><a name="v:ledgerAccountsMatching" class="def">ledgerAccountsMatching</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:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]<a href="src/Hledger-Data-Ledger.html#ledgerAccountsMatching" class="link">Source</a></p><div class="doc"><p>Accounts in ledger whose name matches the pattern, in tree order.
</p></div></div><div class="top"><p class="src"><a name="v:ledgerSubAccounts" class="def">ledgerSubAccounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> <a href="Hledger-Data-Types.html#t:Account">Account</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]<a href="src/Hledger-Data-Ledger.html#ledgerSubAccounts" class="link">Source</a></p><div class="doc"><p>List a ledger account's immediate subaccounts
</p></div></div><div class="top"><p class="src"><a name="v:ledgerPostings" class="def">ledgerPostings</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>]<a href="src/Hledger-Data-Ledger.html#ledgerPostings" class="link">Source</a></p><div class="doc"><p>List a ledger's postings, in the order parsed.
</p></div></div><div class="top"><p class="src"><a name="v:ledgerAccountTree" class="def">ledgerAccountTree</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:Ledger">Ledger</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:Account">Account</a><a href="src/Hledger-Data-Ledger.html#ledgerAccountTree" class="link">Source</a></p><div class="doc"><p>Get a ledger's tree of accounts to the specified depth.
</p></div></div><div class="top"><p class="src"><a name="v:ledgerAccountTreeAt" class="def">ledgerAccountTreeAt</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> <a href="Hledger-Data-Types.html#t:Account">Account</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/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:Account">Account</a>)<a href="src/Hledger-Data-Ledger.html#ledgerAccountTreeAt" class="link">Source</a></p><div class="doc"><p>Get a ledger's tree of accounts rooted at the specified account.
</p></div></div><div class="top"><p class="src"><a name="v:ledgerDateSpan" class="def">ledgerDateSpan</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> <a href="Hledger-Data-Types.html#t:DateSpan">DateSpan</a><a href="src/Hledger-Data-Ledger.html#ledgerDateSpan" class="link">Source</a></p><div class="doc"><p>The (fully specified) date span containing all the ledger's (filtered) transactions,
or DateSpan Nothing Nothing if there are none.
</p></div></div><div class="top"><p class="src"><a name="v:accountnames" class="def">accountnames</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]<a href="src/Hledger-Data-Ledger.html#accountnames" class="link">Source</a></p><div class="doc"><p>Convenience aliases.
</p></div></div><div class="top"><p class="src"><a name="v:account" class="def">account</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</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-Ledger.html#account" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:accounts" class="def">accounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]<a href="src/Hledger-Data-Ledger.html#accounts" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:topaccounts" class="def">topaccounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]<a href="src/Hledger-Data-Ledger.html#topaccounts" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:accountsmatching" class="def">accountsmatching</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:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]<a href="src/Hledger-Data-Ledger.html#accountsmatching" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:subaccounts" class="def">subaccounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> <a href="Hledger-Data-Types.html#t:Account">Account</a> -> [<a href="Hledger-Data-Types.html#t:Account">Account</a>]<a href="src/Hledger-Data-Ledger.html#subaccounts" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:postings" class="def">postings</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>]<a href="src/Hledger-Data-Ledger.html#postings" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:commodities" class="def">commodities</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</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-Ledger.html#commodities" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:accounttree" class="def">accounttree</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:Ledger">Ledger</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:Account">Account</a><a href="src/Hledger-Data-Ledger.html#accounttree" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:accounttreeat" class="def">accounttreeat</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> <a href="Hledger-Data-Types.html#t:Account">Account</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/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:Account">Account</a>)<a href="src/Hledger-Data-Ledger.html#accounttreeat" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:rawdatespan" class="def">rawdatespan</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> <a href="Hledger-Data-Types.html#t:DateSpan">DateSpan</a><a href="src/Hledger-Data-Ledger.html#rawdatespan" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:ledgeramounts" class="def">ledgeramounts</a> :: <a href="Hledger-Data-Types.html#t:Ledger">Ledger</a> -> [<a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a>]<a href="src/Hledger-Data-Ledger.html#ledgeramounts" class="link">Source</a></p></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>
