<!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.Posting</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-Posting.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Hledger-Data-Posting.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.Posting</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A <code><a href="Hledger-Data-Types.html#t:Posting">Posting</a></code> represents a <code><a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a></code> being added to or subtracted from a
single <code><a href="Hledger-Data-Types.html#t:Account">Account</a></code>. Each <code><a href="Hledger-Data-Types.html#t:Transaction">Transaction</a></code> contains two or more postings which
should add up to 0. Postings also reference their parent transaction, so
we can get a date or description for a posting (from the transaction).
Strictly speaking, "entry" is probably a better name for these.
</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:showPosting">showPosting</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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:showPostingForRegister">showPostingForRegister</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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:isReal">isReal</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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:isVirtual">isVirtual</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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:isBalancedVirtual">isBalancedVirtual</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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:hasAmount">hasAmount</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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:accountNamesFromPostings">accountNamesFromPostings</a> :: [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>] -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]</li><li class="src short"><a href="#v:sumPostings">sumPostings</a> :: [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>] -> <a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a></li><li class="src short"><a href="#v:postingDate">postingDate</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</a> -> <a href="/usr/share/doc/ghc/html/libraries/time-1.2.0.3/Data-Time-Calendar.html#t:Day">Day</a></li><li class="src short"><a href="#v:postingCleared">postingCleared</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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:isPostingInDateSpan">isPostingInDateSpan</a> :: <a href="Hledger-Data-Types.html#t:DateSpan">DateSpan</a> -> <a href="Hledger-Data-Types.html#t:Posting">Posting</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:isEmptyPosting">isEmptyPosting</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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:postingsDateSpan">postingsDateSpan</a> :: [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>] -> <a href="Hledger-Data-Types.html#t:DateSpan">DateSpan</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:showPosting" class="def">showPosting</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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-Posting.html#showPosting" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:showPostingForRegister" class="def">showPostingForRegister</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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-Posting.html#showPostingForRegister" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:isReal" class="def">isReal</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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-Posting.html#isReal" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:isVirtual" class="def">isVirtual</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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-Posting.html#isVirtual" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:isBalancedVirtual" class="def">isBalancedVirtual</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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-Posting.html#isBalancedVirtual" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:hasAmount" class="def">hasAmount</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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-Posting.html#hasAmount" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:accountNamesFromPostings" class="def">accountNamesFromPostings</a> :: [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>] -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]<a href="src/Hledger-Data-Posting.html#accountNamesFromPostings" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:sumPostings" class="def">sumPostings</a> :: [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>] -> <a href="Hledger-Data-Types.html#t:MixedAmount">MixedAmount</a><a href="src/Hledger-Data-Posting.html#sumPostings" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:postingDate" class="def">postingDate</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</a> -> <a href="/usr/share/doc/ghc/html/libraries/time-1.2.0.3/Data-Time-Calendar.html#t:Day">Day</a><a href="src/Hledger-Data-Posting.html#postingDate" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:postingCleared" class="def">postingCleared</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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-Posting.html#postingCleared" class="link">Source</a></p><div class="doc"><p>Is this posting cleared? If this posting was individually marked
as cleared, returns True. Otherwise, return the parent
transaction's cleared status or, if there is no parent
transaction, return False.
</p></div></div><div class="top"><p class="src"><a name="v:isPostingInDateSpan" class="def">isPostingInDateSpan</a> :: <a href="Hledger-Data-Types.html#t:DateSpan">DateSpan</a> -> <a href="Hledger-Data-Types.html#t:Posting">Posting</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-Posting.html#isPostingInDateSpan" class="link">Source</a></p><div class="doc"><p>Does this posting fall within the given date span ?
</p></div></div><div class="top"><p class="src"><a name="v:isEmptyPosting" class="def">isEmptyPosting</a> :: <a href="Hledger-Data-Types.html#t:Posting">Posting</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-Posting.html#isEmptyPosting" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:postingsDateSpan" class="def">postingsDateSpan</a> :: [<a href="Hledger-Data-Types.html#t:Posting">Posting</a>] -> <a href="Hledger-Data-Types.html#t:DateSpan">DateSpan</a><a href="src/Hledger-Data-Posting.html#postingsDateSpan" class="link">Source</a></p><div class="doc"><p>Get the minimal date span which contains all the postings, or
DateSpan Nothing Nothing if there are none.
</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>
