SF.net SVN: ledger-smb:[4993] trunk

[..hidden..]

Revision: 4993
          http://ledger-smb.svn.sourceforge.net/ledger-smb/?rev=4993&view=rev
Author:   einhverfr
Date:     2012-07-15 14:48:15 +0000 (Sun, 15 Jul 2012)
Log Message:
-----------
Most of the logic there for new trial balance report

Modified Paths:
--------------
    trunk/Changelog

Added Paths:
-----------
    trunk/LedgerSMB/DBObject/Report/Trial_Balance.pm

Modified: trunk/Changelog
===================================================================
--- trunk/Changelog	2012-07-15 13:37:35 UTC (rev 4992)
+++ trunk/Changelog	2012-07-15 14:48:15 UTC (rev 4993)
@@ -28,12 +28,20 @@
 New RESTful Web Services Framework
 * Supports XML and JSON as input formats
 * Supports XML and JSON as output formats
+* Supports read/write for Contacts:
+   * Customers
+   * Vendors
+   * Employees
+   * Leads
+   * More
 
 New Reporting Framework
 * Easy bridge between SQL and display (Chris T)
 * All reports exportable to CSV (Chris T)
 * All reports exportable to PDF (Chris T)
 * Unified UI for reports (Chris T)
+* Enhanced trial balance allows for partial trial balance (Chris T)
+* Enhanced trial balance allows for saved criteria (Chris T)
 
 Customer/Vendor Handling 
 * Added sales tax id and license number fields for companies (Chris T)

Added: trunk/LedgerSMB/DBObject/Report/Trial_Balance.pm
===================================================================
--- trunk/LedgerSMB/DBObject/Report/Trial_Balance.pm	                        (rev 0)
+++ trunk/LedgerSMB/DBObject/Report/Trial_Balance.pm	2012-07-15 14:48:15 UTC (rev 4993)
@@ -0,0 +1,212 @@
+=head1 NAME
+
+LedgerSMB::DBObject::Report::Trial_Balance - Trial Balance report for LedgerSMB
+
+=head1 SYNOPSYS
+
+Unlike other reports, trial balance reports can be saved:
+
+ my $report = LedgerSMB::DBObject::Report::Trial_Balance->new(%$request);
+ $report->save;
+
+We can then run it:
+
+ $report->run_report;
+ $report->render($request);
+
+We can also retrieve a previous report from the database and run it:
+
+ my $report = LedgerSMB::DBObject::Report::Trial_Balance->get($id);
+ $report->run_report;
+ $report->render($request);
+
+=cut
+
+package LedgerSMB::DBObject::Report::Trial_Balance;
+use Moose;
+use LedgerSMB::App_State;
+extends 'LedgerSMB::DBObject::Report';
+
+my $locale = $LedgerSMB::App_State::Locale;
+
+=head1 DESCRIPTION
+
+The trial balance is a report used to test the books and whether they balance 
+in paper accounting systems.  In digital systems it tends to also be repurposed
+also as a general, quick look at accounting activity.  For this reason it is
+probably the second most important report in the system, behind only the GL
+reports.
+
+Unlike other reports, trial balance reports can be saved:
+
+=head1 	CRITERIA PRPERTIES
+
+Criteria sets can also be saved/loaded.
+
+=over
+
+=item id
+
+This is the id of the trial balance, only used to save over an existing 
+criteria set.
+
+=cut
+
+has id => (is => 'rw', isa => 'Maybe[Int]');
+
+=item date_from
+
+Standard start date for trial balance.
+
+=item date_to
+
+Standard end date for report.
+
+=cut
+
+has date_from => (is => 'rw', coerce => 1, isa => 'LedgerSMB::Moose::Date');
+has date_to => (is => 'rw', coerce => 1, isa => 'LedgerSMB::Moose::Date');
+
+=item desc
+
+Only used for saved criteria sets, is a human-readable description.
+
+=cut
+
+has desc => (is => 'rw', isa => 'Maybe[Str]');
+
+=item yearend
+
+This value holds information related to yearend handling.  It can be either
+'all', 'none', or 'last' each of which describes which yearends to ignore.
+
+=cut
+
+has yearend => (is => 'rw', isa => 'Str');
+
+
+=item heading
+
+If set, only select accounts under this heading
+
+=cut
+
+has heading => (is => 'rw', isa => 'Maybe[Int]')l
+
+=item accounts
+
+If set, only include these accounts
+
+=cut
+
+has accounts => (is => 'rw', isa => 'Maybe[ArrayRef[Int]]');
+
+=head1  REPORT CONSTANT FUNCTIONS
+
+See the documentation for LedgerSMB::DBObject::Report for details on these
+methods.
+
+=over
+
+=item name
+
+=cut
+
+sub name {
+    return $locale->text('Trial Balance');
+};
+
+=item columns
+
+=cut
+
+sub columns {
+    return [
+      {col_id => 'account_number',
+         type => 'href',
+    href_base => 'report.pl?action=',
+         name => $locale->text('Account Number') },
+
+      {col_id => 'account_desc',
+         type => 'href',
+    href_base => 'report.pl?action=',
+         name => $locale->text('Account Description') },
+
+      {col_id => 'gifi_accno',
+         type => 'href',
+    href_base => 'report.pl?action=',
+         name => $locale->text('GIFI') } ,
+
+      {col_id => 'starting_balance',
+         type => 'text',
+         name => $locale->text('Starting Balance') } ,
+
+      {col_id => 'debits',
+         type => 'text',
+         name => $locale->text('Debits') } ,
+
+      {col_id => 'credits',
+         type => 'text',
+         name => $locale->text('Credits') } ,
+
+      {col_id => 'ending_balance',
+         type => 'text',
+         name => $locale->text('Ending Balance') } ,
+
+    ];
+}
+
+=item report_heading
+
+=cut
+
+sub report_heading {
+    return;
+}
+
+=back
+
+=head1  METHODS
+
+=over
+
+=item get
+
+Retrieves the trial balance for review and possibly running it.
+
+=cut
+
+sub get {
+    my ($self) = @_;
+    my $ref = __PACKAGE__->call_procedure(procname => 'trial_balance__get', 
+                                              args => [$id]);
+    return __PACKAGE__->new(%$ref);
+}
+
+=item save
+
+Saves the trial balance to be run again with the same parameters another time
+
+=cut
+
+sub save {
+    my ($self) = @_;
+    my ($ref) = $self->exec_method({funcname => 'trial_balance__save'});
+    $self->id(shift (values @$ref));
+}
+
+=item run_report
+
+Runs the trial balance report.
+
+=back
+
+=head1 COPYRIGHT
+
+COPYRIGHT (C) 2012 The LedgerSMB Core Team.  This file may be re-used under the
+terms of the LedgerSMB General Public License version 2 or at your option any
+later version.  Please see enclosed LICENSE file for details.
+
+=cut
+
+1;

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.