<!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" xml:lang="en" lang="en">
<head>
<meta name="Content-Type" content="text/html; charset=utf-8" />
<title>Class: Revenue</title>
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="header">
<div id="menu">
<a href="_index.html">Index (R)</a> »
<span class="title">Revenue</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a id="class_list_link" href="#">Class List</a>
<a id="method_list_link" href="#">Method List</a>
<a id ="file_list_link" href="#">File List</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Revenue
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName"><span class='object_link'><a href="Account.html" title="Account (class)">Account</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next">ActiveRecord::Base</li>
<li class="next"><span class='object_link'><a href="Account.html" title="Account (class)">Account</a></span></li>
<li class="next">Revenue</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">app/models/revenue.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>
The Revenue class is an account type used to represents increases in owners
equity.
</p>
<h3>Normal Balance</h3>
<p>
The normal balance on Revenue accounts is a <b>Credit</b>.
</p>
</div>
</div>
<div class="tags">
<h3>See Also:</h3>
<ul class="see">
<li><a href="http://en.wikipedia.org/wiki/Revenue" target="_parent" title="Revenue">Revenue</a></li>
</ul>
<h3>Author:</h3>
<ul class="author">
<li>
<div class='inline'><p>
Michael Bulat
</p>
</div>
</li>
</ul>
</div>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#balance-class_method" title="balance (class method)">+ (BigDecimal) <strong>balance</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>
This class method is used to return the balance of all Revenue accounts.
</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#balance-instance_method" title="#balance (instance method)">- (BigDecimal) <strong>balance</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>
The balance of the account.
</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#credits_balance-instance_method" title="#credits_balance (instance method)">- (BigDecimal) <strong>credits_balance</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>
The credit balance for the account.
</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#debits_balance-instance_method" title="#debits_balance (instance method)">- (BigDecimal) <strong>debits_balance</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>
The debit balance for the account.
</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Account.html" title="Account (class)">Account</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Account.html#trial_balance-class_method" title="Account.trial_balance (method)">trial_balance</a></span></p>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<p class="signature first" id="balance-class_method">
+ (<tt>BigDecimal</tt>) <strong>balance</strong>
</p><div class="docstring">
<div class="discussion">
<p>
This class method is used to return the balance of all Revenue accounts.
</p>
<p>
Contra accounts are automatically subtracted from the balance.
</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h3>Examples:</h3>
<h4><div class='inline'></div></h4>
<pre class="example code"><span class='rshft op'>>></span> <span class='Revenue constant id'>Revenue</span><span class='dot token'>.</span><span class='balance identifier id'>balance</span>
<span class='assign token'>=</span><span class='gt op'>></span> <span class='comment val'>#<BigDecimal:1030fcc98,'0.82875E5',8(20)></span>
</pre>
</div>
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt>BigDecimal</tt>)</span>
—
<div class='inline'><p>
The decimal value balance
</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
69
70
71
72
73
74
75
76
77
78
79
80</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/revenue.rb', line 69</span>
<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='balance identifier id'>balance</span>
<span class='accounts_balance identifier id'>accounts_balance</span> <span class='assign token'>=</span> <span class='BigDecimal constant id'>BigDecimal</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='string val'>'0'</span><span class='rparen token'>)</span>
<span class='accounts identifier id'>accounts</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='find identifier id'>find</span><span class='lparen token'>(</span><span class='symbol val'>:all</span><span class='rparen token'>)</span>
<span class='accounts identifier id'>accounts</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='revenue identifier id'>revenue</span><span class='bitor op'>|</span>
<span class='unless unless kw'>unless</span> <span class='revenue identifier id'>revenue</span><span class='dot token'>.</span><span class='contra identifier id'>contra</span>
<span class='accounts_balance identifier id'>accounts_balance</span> <span class='opasgn op'>+=</span> <span class='revenue identifier id'>revenue</span><span class='dot token'>.</span><span class='balance identifier id'>balance</span>
<span class='else else kw'>else</span>
<span class='accounts_balance identifier id'>accounts_balance</span> <span class='opasgn op'>-=</span> <span class='revenue identifier id'>revenue</span><span class='dot token'>.</span><span class='balance identifier id'>balance</span>
<span class='end end kw'>end</span>
<span class='end end kw'>end</span>
<span class='accounts_balance identifier id'>accounts_balance</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<p class="signature first" id="balance-instance_method">
- (<tt>BigDecimal</tt>) <strong>balance</strong>
</p><div class="docstring">
<div class="discussion">
<p>
The balance of the account.
</p>
<p>
Revenue accounts have normal credit balances, so the debits are subtracted
from the credits unless this is a contra account, in which credits are
subtracted from debits
</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h3>Examples:</h3>
<h4><div class='inline'></div></h4>
<pre class="example code"><span class='rshft op'>>></span> <span class='asset identifier id'>asset</span><span class='dot token'>.</span><span class='balance identifier id'>balance</span>
<span class='assign token'>=</span><span class='gt op'>></span> <span class='comment val'>#<BigDecimal:103259bb8,'0.2E4',4(12)> </span>
</pre>
</div>
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt>BigDecimal</tt>)</span>
—
<div class='inline'><p>
The decimal value balance
</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
51
52
53
54
55
56
57</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/revenue.rb', line 51</span>
<span class='def def kw'>def</span> <span class='balance identifier id'>balance</span>
<span class='unless unless kw'>unless</span> <span class='contra identifier id'>contra</span>
<span class='credits_balance identifier id'>credits_balance</span> <span class='minus op'>-</span> <span class='debits_balance identifier id'>debits_balance</span>
<span class='else else kw'>else</span>
<span class='debits_balance identifier id'>debits_balance</span> <span class='minus op'>-</span> <span class='credits_balance identifier id'>credits_balance</span>
<span class='end end kw'>end</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="credits_balance-instance_method">
- (<tt>BigDecimal</tt>) <strong>credits_balance</strong>
</p><div class="docstring">
<div class="discussion">
<p>
The credit balance for the account.
</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h3>Examples:</h3>
<h4><div class='inline'></div></h4>
<pre class="example code"><span class='rshft op'>>></span> <span class='revenue identifier id'>revenue</span><span class='dot token'>.</span><span class='credits_balance identifier id'>credits_balance</span>
<span class='assign token'>=</span><span class='gt op'>></span> <span class='comment val'>#<BigDecimal:103259bb8,'0.3E4',4(12)> </span>
</pre>
</div>
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt>BigDecimal</tt>)</span>
—
<div class='inline'><p>
The decimal value credit balance
</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
18
19
20
21
22
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/revenue.rb', line 18</span>
<span class='def def kw'>def</span> <span class='credits_balance identifier id'>credits_balance</span>
<span class='credits_balance identifier id'>credits_balance</span> <span class='assign token'>=</span> <span class='BigDecimal constant id'>BigDecimal</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='string val'>'0'</span><span class='rparen token'>)</span>
<span class='credit_transactions identifier id'>credit_transactions</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='credit_transaction identifier id'>credit_transaction</span><span class='bitor op'>|</span>
<span class='credits_balance identifier id'>credits_balance</span> <span class='assign token'>=</span> <span class='credits_balance identifier id'>credits_balance</span> <span class='plus op'>+</span> <span class='credit_transaction identifier id'>credit_transaction</span><span class='dot token'>.</span><span class='amount identifier id'>amount</span>
<span class='end end kw'>end</span>
<span class='return return kw'>return</span> <span class='credits_balance identifier id'>credits_balance</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="debits_balance-instance_method">
- (<tt>BigDecimal</tt>) <strong>debits_balance</strong>
</p><div class="docstring">
<div class="discussion">
<p>
The debit balance for the account.
</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h3>Examples:</h3>
<h4><div class='inline'></div></h4>
<pre class="example code"><span class='rshft op'>>></span> <span class='revenue identifier id'>revenue</span><span class='dot token'>.</span><span class='debits_balance identifier id'>debits_balance</span>
<span class='assign token'>=</span><span class='gt op'>></span> <span class='comment val'>#<BigDecimal:103259bb8,'0.1E4',4(12)> </span>
</pre>
</div>
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt>BigDecimal</tt>)</span>
—
<div class='inline'><p>
The decimal value credit balance
</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35
36
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/revenue.rb', line 33</span>
<span class='def def kw'>def</span> <span class='debits_balance identifier id'>debits_balance</span>
<span class='debits_balance identifier id'>debits_balance</span> <span class='assign token'>=</span> <span class='BigDecimal constant id'>BigDecimal</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='string val'>'0'</span><span class='rparen token'>)</span>
<span class='debit_transactions identifier id'>debit_transactions</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='debit_transaction identifier id'>debit_transaction</span><span class='bitor op'>|</span>
<span class='debits_balance identifier id'>debits_balance</span> <span class='assign token'>=</span> <span class='debits_balance identifier id'>debits_balance</span> <span class='plus op'>+</span> <span class='debit_transaction identifier id'>debit_transaction</span><span class='dot token'>.</span><span class='amount identifier id'>amount</span>
<span class='end end kw'>end</span>
<span class='return return kw'>return</span> <span class='debits_balance identifier id'>debits_balance</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri Dec 3 14:35:09 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.2 (ruby-1.8.7).
</div>
</body>
</html>