doc/yard/Invoicexpress/Client/Charts.html
<!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 http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: Invoicexpress::Client::Charts
— Documentation by YARD 0.8.5
</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">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../';
framesUrl = "../../frames.html#!" + escape(window.location.href);
</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>
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (C)</a> »
<span class='title'><span class='object_link'><a href="../../Invoicexpress.html" title="Invoicexpress (module)">Invoicexpress</a></span></span> » <span class='title'><span class='object_link'><a href="../Client.html" title="Invoicexpress::Client (class)">Client</a></span></span>
»
<span class="title">Charts</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 class="full_list_link" id="class_list_link"
href="../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Invoicexpress::Client::Charts
</h1>
<dl class="box">
<dt class="r1">Included in:</dt>
<dd class="r1"><span class='object_link'><a href="../Client.html" title="Invoicexpress::Client (class)">Invoicexpress::Client</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/invoicexpress/client/charts.rb</dd>
</dl>
<div class="clear"></div>
<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="#invoicing_chart-instance_method" title="#invoicing_chart (instance method)">- (Array<Invoicexpress::Models::Chart>) <strong>invoicing_chart</strong>(options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the invoicing chart data.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#quarterly_results-instance_method" title="#quarterly_results (instance method)">- (Array<Invoicexpress::Models::TopClient>) <strong>quarterly_results</strong>(year = Date.today.year, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>This method allows you to obtain the quarterly results.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#top_clients-instance_method" title="#top_clients (instance method)">- (Array<Invoicexpress::Models::TopClient>) <strong>top_clients</strong>(options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns your 5 top clients for which you have invoiced more.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#top_debtors-instance_method" title="#top_debtors (instance method)">- (Array<Invoicexpress::Models::TopClient>) <strong>top_debtors</strong>(options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns your 5 top debtors.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#treasury_chart-instance_method" title="#treasury_chart (instance method)">- (Array<Invoicexpress::Models::Chart>) <strong>treasury_chart</strong>(options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the treasury chart data.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="invoicing_chart-instance_method">
- (<tt>Array<<span class='object_link'><a href="../Models/Chart.html" title="Invoicexpress::Models::Chart (class)">Invoicexpress::Models::Chart</a></span>></tt>) <strong>invoicing_chart</strong>(options = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns the invoicing chart data.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Models/Chart.html" title="Invoicexpress::Models::Chart (class)">Invoicexpress::Models::Chart</a></span>></tt>)</span>
—
<div class='inline'><p>An array with all the charting results</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::Unauthorized When the client is unauthorized</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/charts.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_invoicing_chart'>invoicing_chart</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:klass</span> <span class='op'>=></span> <span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>Chart</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>api/charts/invoicing.xml</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="quarterly_results-instance_method">
- (<tt>Array<<span class='object_link'><a href="../Models/TopClient.html" title="Invoicexpress::Models::TopClient (class)">Invoicexpress::Models::TopClient</a></span>></tt>) <strong>quarterly_results</strong>(year = Date.today.year, options = {})
</h3><div class="docstring">
<div class="discussion">
<p>This method allows you to obtain the quarterly results.
Each quarter has:
The amount invoiced before taxes
Taxes amount
Year to date (YTD) which consists on the difference between the invoiced on the current quarter less the invoiced on the same quarter one year ago</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>year</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>Date.today.year</tt>)</em>
—
<div class='inline'><p>By default year is the current year. It should obey the format YYYY (ex.: 2010)</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Models/TopClient.html" title="Invoicexpress::Models::TopClient (class)">Invoicexpress::Models::TopClient</a></span>></tt>)</span>
—
<div class='inline'><p>An array with all the charting results</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::Unauthorized When the client is unauthorized</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52
53
54</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/charts.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_quarterly_results'>quarterly_results</span><span class='lparen'>(</span><span class='id identifier rubyid_year'>year</span><span class='op'>=</span><span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_today'>today</span><span class='period'>.</span><span class='id identifier rubyid_year'>year</span> <span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='comment'>#params = { :klass => Invoicexpress::Models::QuaterlyResult }
</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:klass</span> <span class='op'>=></span> <span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>QuarterlyResult</span><span class='comma'>,</span> <span class='symbol'>:year</span> <span class='op'>=></span> <span class='id identifier rubyid_year'>year</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>api/charts/quarterly-results.xml</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="top_clients-instance_method">
- (<tt>Array<<span class='object_link'><a href="../Models/TopClient.html" title="Invoicexpress::Models::TopClient (class)">Invoicexpress::Models::TopClient</a></span>></tt>) <strong>top_clients</strong>(options = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns your 5 top clients for which you have invoiced more.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Models/TopClient.html" title="Invoicexpress::Models::TopClient (class)">Invoicexpress::Models::TopClient</a></span>></tt>)</span>
—
<div class='inline'><p>An array with all the charting results</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::Unauthorized When the client is unauthorized</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/charts.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_top_clients'>top_clients</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:klass</span> <span class='op'>=></span> <span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>TopClient</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>api/charts/top-clients.xml</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="top_debtors-instance_method">
- (<tt>Array<<span class='object_link'><a href="../Models/TopClient.html" title="Invoicexpress::Models::TopClient (class)">Invoicexpress::Models::TopClient</a></span>></tt>) <strong>top_debtors</strong>(options = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns your 5 top debtors. Values are calculated based on the due amount.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Models/TopClient.html" title="Invoicexpress::Models::TopClient (class)">Invoicexpress::Models::TopClient</a></span>></tt>)</span>
—
<div class='inline'><p>An array with all the charting results</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::Unauthorized When the client is unauthorized</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
36
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/charts.rb', line 36</span>
<span class='kw'>def</span> <span class='id identifier rubyid_top_debtors'>top_debtors</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:klass</span> <span class='op'>=></span> <span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>TopDebtor</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>api/charts/top-debtors.xml</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="treasury_chart-instance_method">
- (<tt>Array<<span class='object_link'><a href="../Models/Chart.html" title="Invoicexpress::Models::Chart (class)">Invoicexpress::Models::Chart</a></span>></tt>) <strong>treasury_chart</strong>(options = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns the treasury chart data.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="../Models/Chart.html" title="Invoicexpress::Models::Chart (class)">Invoicexpress::Models::Chart</a></span>></tt>)</span>
—
<div class='inline'><p>An array with all the charting results</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'></span>
<div class='inline'><p>Invoicexpress::Unauthorized When the client is unauthorized</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
18
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/invoicexpress/client/charts.rb', line 18</span>
<span class='kw'>def</span> <span class='id identifier rubyid_treasury_chart'>treasury_chart</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:klass</span> <span class='op'>=></span> <span class='const'>Invoicexpress</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>Chart</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>api/charts/treasury.xml</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Jun 20 18:40:53 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.5 (ruby-1.9.3).
</div>
</body>
</html>