allow punctuation in tax name on tax report, #33255
[freeside.git] / httemplate / search / report_tax.cgi
old mode 100755 (executable)
new mode 100644 (file)
index 8062479..491cd42
-<%
-#!/usr/bin/perl -Tw
-#
-# $Id: report_tax.cgi,v 1.1 2002-02-22 23:18:34 jeff Exp $
-#
-# Usage: post form to:
-#        http://server.name/path/svc_domain.cgi
-#
-# ivan@voicenet.com 96-mar-5
-#
-# need to look at table in results to make it more readable
-#
-# ivan@voicenet.com
-#
-# rewrite ivan@sisd.com 98-mar-15
-#
-# Changes to allow page to work at a relative position in server
-#       bmccane@maxbaud.net     98-apr-3
-#
-# $Log: report_tax.cgi,v $
-# Revision 1.1  2002-02-22 23:18:34  jeff
-# add some reporting features
-#
-# Revision 1.1  2002/02/05 15:22:00  jeff
-# preserving state prior to 1.4.0pre7 upgrade
-#
-# Revision 1.2  2000/09/20 19:25:19  jeff
-# local modifications
-#
-# Revision 1.1.1.1  2000/09/18 06:26:58  jeff
-# Import of Freeside 1.2.3
-#
-# Revision 1.10  1999/07/20 06:03:36  ivan
-# s/CGI::Request/CGI/; (how'd i miss that before?)
-#
-# Revision 1.9  1999/04/09 04:22:34  ivan
-# also table()
-#
-# Revision 1.8  1999/04/09 03:52:55  ivan
-# explicit & for table/itable/ntable
-#
-# Revision 1.7  1999/02/28 00:03:56  ivan
-# removed misleading comments
-#
-# Revision 1.6  1999/02/09 09:22:58  ivan
-# visual and bugfixes
-#
-# Revision 1.5  1999/01/19 05:14:16  ivan
-# for mod_perl: no more top-level my() variables; use vars instead
-# also the last s/create/new/;
-#
-# Revision 1.4  1999/01/18 09:41:40  ivan
-# all $cgi->header calls now include ( '-expires' => 'now' ) for mod_perl
-# (good idea anyway)
-#
-# Revision 1.3  1998/12/17 09:41:11  ivan
-# s/CGI::(Base|Request)/CGI.pm/;
-#
-
-use strict;
-use vars qw( $conf $cgi $beginning $ending );
-use CGI;
-use CGI::Carp qw(fatalsToBrowser);
-use FS::UID qw(cgisuidsetup);
-use FS::CGI qw(popurl idiot header table);
-use FS::Record qw(qsearch qsearchs);
-use FS::Conf;
-
-$cgi = new CGI;
-&cgisuidsetup($cgi);
-
-$conf = new FS::Conf;
-
-$cgi->param('beginning') =~ /^([ 0-9\-\/]{0,10})$/;
-$beginning = $1;
-
-$cgi->param('ending') =~ /^([ 0-9\-\/]{0,10})$/;
-$ending = $1;
-
-  print $cgi->header( '-expires' => '-2m' ),
-        header('Tax Report Results');
-
-  open (REPORT, "/usr/bin/freeside-tax-report -v -s $beginning -d $ending freeside |");
-
-  print '<PRE>';
-  while(<REPORT>) {
-    print $_;
-  }
-  print '</PRE>';
-
-  print '</BODY></HTML>';
-
-%>
+<& /elements/header.html, $report->title &>
+<TD ALIGN="right">
+Download full results<BR>
+as <A HREF="<% $p.'search/report_tax-xls.cgi?'.$cgi->query_string%>">Excel spreadsheet</A>
+</TD>
 
+<STYLE type="text/css">
+TD.sectionhead {
+  background-color: #777777;
+  color: #ffffff;
+  font-weight: bold;
+  text-align: left;
+}
+.grid TH { background-color: #cccccc; padding: 0px 3px 2px }
+.row0 TD { background-color: #eeeeee; padding: 0px 3px 2px; text-align: right}
+.row1 TD { background-color: #ffffff; padding: 0px 3px 2px; text-align: right}
+TD.rowhead { font-weight: bold; text-align: left; padding: 0px 3px }
+.bigmath { font-size: large; font-weight: bold; font: sans-serif; text-align: center }
+.total { font-style: italic }
+</STYLE>
+<& /elements/table-grid.html &>
+  <THEAD>
+  <TR>
+    <TH ROWSPAN=3></TH>
+    <TH COLSPAN=5>Sales</TH>
+    <TH ROWSPAN=3></TH>
+    <TH ROWSPAN=3>Rate</TH>
+    <TH ROWSPAN=3></TH>
+    <TH ROWSPAN=3>Estimated tax</TH>
+    <TH ROWSPAN=3>Tax invoiced</TH>
+    <TH ROWSPAN=3></TH>
+    <TH ROWSPAN=3>Tax credited</TH>
+    <TH ROWSPAN=3></TH>
+    <TH ROWSPAN=3>Net tax due</TH>
+  </TR>
+
+  <TR>
+    <TH ROWSPAN=2>Total</TH>
+    <TH ROWSPAN=1>Non-taxable</TH>
+    <TH ROWSPAN=1>Non-taxable</TH>
+    <TH ROWSPAN=1>Non-taxable</TH>
+    <TH ROWSPAN=2>Taxable</TH>
+  </TR>
+
+  <TR STYLE="font-size:small">
+    <TH>(tax-exempt customer)</TH>
+    <TH>(tax-exempt package)</TH>
+    <TH>(monthly exemption)</TH>
+  </TR>
+  </THEAD>
+
+% my $rownum = 0;
+% my $prev_row = { pkgclass => 'DUMMY PKGCLASS' };
+
+  <TBODY>
+% foreach my $row (@rows) {
+%   # before anything else: if this row's pkgclass is not the same as the 
+%   # previous row's, then:
+%   if ( $row->{pkgclass} ne $prev_row->{pkgclass} ) {
+%     if ( $rownum > 0 ) { # start a new section
+%       $rownum = 0;
+  </TBODY><TBODY>
+%     }
+%     if ( $params{breakdown}->{pkgclass} ) { # and caption the new section
+  <TR>
+    <TD COLSPAN=19 CLASS="sectionhead">
+      <% $pkgclass_name{$row->{pkgclass}} %>
+    </TD>
+  </TR>
+%     }
+%   } # if $row->{pkgclass} ne ...
+
+%   # construct base links that limit to the tax rates described by this row
+%   my $rowlink = ';taxnum=' . $row->{taxnums};
+%   # and also the package class, if we're limiting package class
+%   if ( $params{breakdown}->{pkgclass} ) {
+%     $rowlink .= ';classnum=' . ($row->{pkgclass} || 0);
+%   }
+%
+%   if ( $row->{total} ) {
+  </TBODY><TBODY CLASS="total">
+%   }
+  <TR CLASS="row<% $rownum % 2 %>">
+%   # Row label
+    <TD CLASS="rowhead"><% $row->{label} |h %></TD>
+    <TD>
+%   # Total sales
+      <A HREF="<% $saleslink . $rowlink %>">
+        <% $money_sprintf->( $row->{sales} ) %>
+      </A>
+    </TD>
+%   # Exemptions: customer
+    <TD>
+      <A HREF="<% $saleslink . $rowlink . ';exempt_cust=Y' %>">
+        <% $money_sprintf->( $row->{exempt_cust} ) %>
+      </A>
+    </TD>
+%   # package
+    <TD>
+      <A HREF="<% $saleslink . $rowlink . ';exempt_pkg=Y' %>">
+        <% $money_sprintf->( $row->{exempt_pkg} ) %>
+      </A>
+    </TD>
+%   # monthly (note this uses $exemptlink; it's a completely separate report)
+    <TD>
+      <A HREF="<% $exemptlink . $rowlink %>">
+        <% $money_sprintf->( $row->{exempt_monthly} ) %>
+      </A>
+    </TD>
+%   # taxable sales
+    <TD>
+      <A HREF="<% $saleslink . $rowlink . ";taxable=1" %>">
+        <% $money_sprintf->( $row->{taxable} ) %>
+      </A>
+    </TD>
+    <TD CLASS="bigmath"> &times; </TD>
+    <TD><% $row->{rate} %></TD>
+%   # estimated tax
+    <TD CLASS="bigmath"> = </TD>
+    <TD>
+%   if ( $row->{estimated} ) {
+      <% $money_sprintf->( $row->{estimated} ) %>
+%   }
+    </TD>
+%   # invoiced tax
+    <TD>
+      <A HREF="<% $taxlink . $rowlink %>">
+        <% $money_sprintf->( $row->{tax} ) %>
+      </A>
+    </TD>
+%   # credited tax
+    <TD CLASS="bigmath"> &minus; </TD>
+    <TD>
+      <A HREF="<% $creditlink . $rowlink %>">
+        <% $money_sprintf->( $row->{credit} ) %>
+      </A>
+    </TD>
+%   # net tax due
+    <TD CLASS="bigmath"> = </TD>
+    <TD><% $money_sprintf->( $row->{tax} - $row->{credit} ) %></TD>
+  </TR>
+%   $rownum++;
+%   $prev_row = $row;
+% } # foreach my $row
+% # at the end of everything
+  </TBODY>
+% if ( $report->{outside} > 0 ) {
+  <TBODY CLASS="total" STYLE="background-color: #cccccc; line-height: 3">
+    <TR>
+      <TD CLASS="rowhead">
+        <% emt('Out of taxable region') %>
+      </TD>
+      <TD STYLE="text-align: right">
+        <A HREF="<% $saleslink %>;out=1;taxname=<% encode_entities($params{'taxname'}) %>">
+          <% $money_sprintf->( $report->{outside } ) %>
+        </A>
+      </TD>
+      <TD COLSPAN=0></TD>
+    </TR>
+  </TBODY>
+% }
+</TABLE>
+
+<& /elements/footer.html &>
+<%init>
+
+die "access denied"
+  unless $FS::CurrentUser::CurrentUser->access_right('Financial reports');
+
+my $DEBUG = $cgi->param('debug') || 0;
+
+my $conf = new FS::Conf;
+
+my($beginning, $ending) = FS::UI::Web::parse_beginning_ending($cgi);
+
+my %params = (
+  beginning => $beginning,
+  ending    => $ending,
+);
+$params{country} = $cgi->param('country');
+$params{debug}   = $DEBUG;
+$params{breakdown} = { map { $_ => 1 } $cgi->param('breakdown') };
+
+my $agentname;
+if ( $cgi->param('agentnum') =~ /^(\d+)$/ ) {
+  my $agent = FS::agent->by_key($1) or die "unknown agentnum $1";
+  $params{agentnum} = $1;
+  $agentname = $agent->agentname;
+}
+
+# allow anything in here; FS::Report::Tax will treat it as unsafe
+if ( length($cgi->param('taxname')) ) {
+  $params{taxname} = $cgi->param('taxname');
+} else {
+  die "taxname required";
+}
+
+if ( $cgi->param('credit_date') eq 'cust_credit_bill' ) {
+  $params{credit_date} = 'cust_credit_bill';
+} else {
+  $params{credit_date} = 'cust_bill';
+}
+
+warn "PARAMS:\n".Dumper(\%params)."\n\n" if $DEBUG;
+
+my $report = FS::Report::Tax->report_internal(%params);
+my @rows = $report->table; # array of hashrefs
+
+my $money_char = $conf->config('money_char') || '$';
+my $money_sprintf = sub {
+  $money_char. sprintf('%.2f', shift);
+};
+
+my $dateagentlink = "begin=$beginning;end=$ending";
+if ( $params{agentnum} ) {
+  $dateagentlink .= ';agentnum=' . $params{agentnum};
+}
+my $saleslink  = $p. "search/cust_bill_pkg.cgi?$dateagentlink;nottax=1";
+my $taxlink    = $p. "search/cust_bill_pkg.cgi?$dateagentlink;istax=1";
+my $exemptlink = $p. "search/cust_tax_exempt_pkg.cgi?$dateagentlink";
+my $creditlink = $p. "search/cust_bill_pkg.cgi?$dateagentlink;credit=1;istax=1";
+
+if ( $params{'credit_date'} eq 'cust_credit_bill' ) {
+  $creditlink =~ s/begin/credit_begin/;
+  $creditlink =~ s/end/credit_end/;
+}
+
+my %pkgclass_name = map { $_->classnum, $_->classname } qsearch('pkg_class');
+$pkgclass_name{''} = 'Unclassified';
+
+</%init>