add credited sales column to tax report, #37088
[freeside.git] / httemplate / search / report_tax.cgi
old mode 100755 (executable)
new mode 100644 (file)
index 5876657..6d0e95d
-<!-- mason kludge -->
-<%
-
-my $user = getotaker;
-
-$cgi->param('beginning') =~ /^([ 0-9\-\/]{0,10})$/;
-my $pbeginning = $1;
-my $beginning = $1 ? str2time($1) : 0;
-
-$cgi->param('ending') =~ /^([ 0-9\-\/]{0,10})$/;
-my $pending = $1;
-my $ending = ( $1 ? str2time($1) : 4294880896 ) + 86399;
-
-my $from_join_cust = "
-  FROM cust_bill_pkg
-    JOIN cust_bill USING ( invnum ) 
-    JOIN cust_main USING ( custnum )
-";
-my $join_pkg = "
-    JOIN cust_pkg USING ( pkgnum )
-    JOIN part_pkg USING ( pkgpart )
-";
-my $where = "
-  WHERE _date >= $beginning AND _date <= $ending
-    AND ( county  = ? OR ? = '' )
-    AND ( state   = ? OR ? = '' )
-    AND ( country = ? )
-    AND payby != 'COMP'
-";
-my @base_param = qw( county county state state country );
-
-my $gotcust = "
-  WHERE 0 < ( SELECT COUNT(*) FROM cust_main
-              WHERE ( cust_main.county  = cust_main_county.county
-                      OR cust_main_county.county = ''
-                      OR cust_main_county.county IS NULL )
-                AND ( cust_main.state   = cust_main_county.state
-                      OR cust_main_county.state = ''
-                      OR cust_main_county.state IS NULL )
-                AND ( cust_main.country = cust_main_county.country )
-              LIMIT 1
-            )
-";
-
-my $monthly_exempt_warning = 0;
-my($total, $exempt, $taxable, $owed, $tax) = ( 0, 0, 0, 0, 0 );
-my $out = 'Out of taxable region(s)';
-my %regions;
-foreach my $r (qsearch('cust_main_county', {}, '', $gotcust) ) {
-  #warn $r->county. ' '. $r->state. ' '. $r->country. "\n";
-
-  my $label = getlabel($r);
-  $regions{$label}->{'label'} = $label;
-
-  my $fromwhere = $from_join_cust. $join_pkg. $where;
-  my @param = @base_param; 
-
-  if ( $r->taxclass ) {
-    $fromwhere .= " AND ( taxclass = ?  ) ";
-    push @param, 'taxclass';
-  }
-
-  my $nottax = 'pkgnum != 0';
-
-  my $a = scalar_sql($r, \@param,
-    "SELECT SUM(cust_bill_pkg.setup+cust_bill_pkg.recur) $fromwhere AND $nottax"
-  );
-  $total += $a;
-  $regions{$label}->{'total'} += $a;
-
-  foreach my $e ( grep { $r->get($_.'tax') =~ /^Y/i }
-                       qw( cust_bill_pkg.setup cust_bill_pkg.recur ) ) {
-    my $x = scalar_sql($r, \@param,
-      "SELECT SUM($e) $fromwhere AND $nottax"
-    );
-    $exempt += $x;
-    $regions{$label}->{'exempt'} += $x;
-  }
-
-  my($t, $x) = (0, 0);
-  foreach my $e ( grep { $r->get($_.'tax') !~ /^Y/i }
-                       qw( cust_bill_pkg.setup cust_bill_pkg.recur ) ) {
-    $t += scalar_sql($r, \@param, 
-      "SELECT SUM($e) $fromwhere AND $nottax AND ( tax != 'Y' OR tax IS NULL )"
-    );
-
-    $x += scalar_sql($r, \@param, 
-      "SELECT SUM($e) $fromwhere AND $nottax AND tax = 'Y'"
-    );
-  }
-
-  my($sday,$smon,$syear) = (localtime($beginning) )[ 3, 4, 5 ];
-  $monthly_exempt_warning=1 if $sday != 1 && $beginning;
-  $smon++; $syear+=1900;
-
-  my $eending = ( $ending == 4294967295 ) ? time : $ending;
-  my($eday,$emon,$eyear) = (localtime($eending) )[ 3, 4, 5 ];
-  $emon++; $eyear+=1900;
-
-  my $monthly_exemption = scalar_sql($r, [ 'taxnum' ],
-    "SELECT SUM(amount) FROM cust_tax_exempt where taxnum = ? ".
-    "  AND ( year > $syear OR ( year = $syear and month >= $smon ) )".
-    "  AND ( year < $eyear OR ( year = $eyear and month <= $emon ) )"
-  );
-  #warn $r->taxnum(). ": $monthly_exemption\n";
-  if ( $monthly_exemption ) {
-    $t -= $monthly_exemption;
-    $x += $monthly_exemption;
-  }
-
-  $taxable += $t;
-  $regions{$label}->{'taxable'} += $t;
-
-  $exempt += $x;
-  $regions{$label}->{'exempt'} += $x;
-
-  $owed += $t * ($r->tax/100);
-  $regions{$label}->{'owed'} += $t * ($r->tax/100);
-
-  if ( defined($regions{$label}->{'rate'})
-       && $regions{$label}->{'rate'} != $r->tax.'%' ) {
-    $regions{$label}->{'rate'} = 'variable';
-  } else {
-    $regions{$label}->{'rate'} = $r->tax.'%';
-  }
-
+<& /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=6>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>
+    <TH ROWSPAN=3></TH>
+    <TH ROWSPAN=3>Tax collected</TH>
+  </TR>
 
-my $taxwhere = "$from_join_cust $where";
-my @taxparam = @base_param;
-
-#foreach my $label ( keys %regions ) {
-foreach my $r (
-  qsearch( 'cust_main_county',
-           {},
-           'DISTINCT ON (country, state, county, taxname) *',
-           $gotcust
-         )
-) {
-
-  #warn join('-', map { $r->$_() } qw( country state county taxname ) )."\n";
-
-  my $label = getlabel($r);
-
-  my $fromwhere = $join_pkg. $where;
-  my @param = @base_param; 
-
-  #match itemdesc if necessary!
-  my $named_tax =
-    $r->taxname
-      ? 'AND itemdesc = '. dbh->quote($r->taxname)
-      : "AND ( itemdesc IS NULL OR itemdesc = '' OR itemdesc = 'Tax' )";
-  my $x = scalar_sql($r, \@taxparam,
-    "SELECT SUM(cust_bill_pkg.setup+cust_bill_pkg.recur) $taxwhere ".
-    "AND pkgnum = 0 $named_tax",
-  );
-  $tax += $x;
-  $regions{$label}->{'tax'} += $x;
+  <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>Credited</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
+%   # cust_bill_pkg.cgi wants a list of specific taxnums (and package class)
+%   # cust_credit_bill_pkg.html wants a geographic scope (and package class)
+%   my $rowlink = ';taxnum=' . $row->{taxnums};
+%   my $rowregion = '';
+%   foreach my $loc (qw(state county city district)) {
+%     if ( $row->{$loc} ) {
+%       $rowregion .= ";$loc=" . uri_escape($row->{$loc});
+%     }
+%   }
+%   # and also the package class, if we're limiting package class
+%   if ( $params{breakdown}->{pkgclass} ) {
+%     $rowlink .= ';classnum=' . ($row->{pkgclass} || 0);
+%     $rowregion .= ';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>
+%   # credited sales
+    <TD>
+      <A HREF="<% $salescreditlink . $rowregion %>">
+        <% $money_sprintf->( $row->{sales_credited} ) %>
+      </A>
+    </TD>
+    <TD CLASS="bigmath"> &times; </TD>
+    <TD><% $row->{rate} %></TD>
+%   # taxable sales
+    <TD>
+      <A HREF="<% $saleslink . $rowlink . ";taxable=1" %>">
+        <% $money_sprintf->( $row->{taxable} ) %>
+      </A>
+    </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 %>"> currently broken
+        <% $money_sprintf->( $row->{tax_credited} ) %>
+%#      </A>
+    </TD>
+%   # net tax due
+    <TD CLASS="bigmath"> = </TD>
+    <TD><% $money_sprintf->( $row->{tax} - $row->{tax_credited} ) %></TD>
+%   # tax collected
+    <TD>&nbsp;</TD>
+    <TD><% $money_sprintf->( $row->{tax_paid} ) %></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>
 
-#ordering
-my @regions = map $regions{$_},
-              sort { ( ($a eq $out) cmp ($b eq $out) ) || ($b cmp $a) }
-              keys %regions;
-
-push @regions, {
-  'label'     => 'Total',
-  'total'     => $total,
-  'exempt'    => $exempt,
-  'taxable'   => $taxable,
-  'rate'      => '',
-  'owed'      => $owed,
-  'tax'       => $tax,
-};
+<& /elements/footer.html &>
+<%init>
+
+die "access denied"
+  unless $FS::CurrentUser::CurrentUser->access_right('Financial reports');
 
-#-- 
-
-sub getlabel {
-  my $r = shift;
-
-  my $label;
-  if ( $r->tax == 0 ) {
-    #kludge to avoid "will not stay shared" warning
-    my $out = 'Out of taxable region(s)';
-    $label = $out;
-  } elsif ( $r->taxname ) {
-    $label = $r->taxname;
-#    $regions{$label}->{'taxname'} = $label;
-#    push @{$regions{$label}->{$_}}, $r->$_() foreach qw( county state country );
-  } else {
-    $label = $r->country;
-    $label = $r->state.", $label" if $r->state;
-    $label = $r->county." county, $label" if $r->county;
-    #$label = $r->taxname. " ($label)" if $r->taxname;
-  }
-  return $label;
+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;
 }
 
-#false laziness w/FS::Report::Table::Monthly (sub should probably be moved up
-#to FS::Report or FS::Record or who the fuck knows where)
-sub scalar_sql {
-  my( $r, $param, $sql ) = @_;
-  #warn "$sql\n";
-  my $sth = dbh->prepare($sql) or die dbh->errstr;
-  $sth->execute( map $r->$_(), @$param )
-    or die "Unexpected error executing statement $sql: ". $sth->errstr;
-  $sth->fetchrow_arrayref->[0] || 0;
+# 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';
+}
 
-<%= header( "Sales Tax Report - $pbeginning through ".($pending||'now'),
-            menubar( 'Main Menu'=>$p, ) )               %>
-<%= table() %>
-  <TR>
-    <TH ROWSPAN=2></TH>
-    <TH COLSPAN=3>Sales</TH>
-    <TH ROWSPAN=2>Rate</TH>
-    <TH ROWSPAN=2>Tax owed</TH>
-    <TH ROWSPAN=2>Tax invoiced</TH>
-  </TR>
-  <TR>
-    <TH>Total</TH>
-    <TH>Non-taxable</TH>
-    <TH>Taxable</TH>
-  </TR>
-  <% foreach my $region ( @regions ) { %>
-    <TR>
-      <TD><%= $region->{'label'} %></TD>
-      <TD ALIGN="right">$<%= sprintf('%.2f', $region->{'total'} ) %></TD>
-      <TD ALIGN="right">$<%= sprintf('%.2f', $region->{'exempt'} ) %></TD>
-      <TD ALIGN="right">$<%= sprintf('%.2f', $region->{'taxable'} ) %></TD>
-      <TD ALIGN="right"><%= $region->{'rate'} %></TD>
-      <TD ALIGN="right">$<%= sprintf('%.2f', $region->{'owed'} ) %></TD>
-      <TD ALIGN="right">$<%= sprintf('%.2f', $region->{'tax'} ) %></TD>
-    </TR>
-  <% } %>
+warn "PARAMS:\n".Dumper(\%params)."\n\n" if $DEBUG;
 
-</TABLE>
+my $report = FS::Report::Tax->report_internal(%params);
+my @rows = $report->table; # array of hashrefs
 
-<% if ( $monthly_exempt_warning ) { %>
-  <BR>
-  Partial-month tax reports (except for current month) may not be correct due
-  to month-granularity tax exemption (usually "texas tax").  For an accurate
-  report, start on the first of a month and end on the last day of a month (or
-  leave blank for to now).
-<% } %>
+my $money_char = $conf->config('money_char') || '$';
+my $money_sprintf = sub {
+  $money_char. sprintf('%.2f', shift);
+};
 
-</BODY>
-</HTML>
+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 $salescreditlink = $p. "search/cust_credit_bill_pkg.html?$dateagentlink;nottax=1";
+if ( $params{'credit_date'} eq 'cust_credit_bill' ) {
+  $salescreditlink =~ s/begin/credit_begin/;
+  $salescreditlink =~ s/end/credit_end/;
+}
+#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 $creditlink = ''; # disabled until we find a sane way to do this
 
+my %pkgclass_name = map { $_->classnum, $_->classname } qsearch('pkg_class');
+$pkgclass_name{''} = 'Unclassified';
 
+</%init>