improve speed in customer search, #13364
[freeside.git] / httemplate / search / report_tax.cgi
index 9f0ad99..93e5b51 100755 (executable)
               )
           )
 %>
+<TD ALIGN="right">
+Download full results<BR>
+as <A HREF="<% $p.'search/report_tax-xls.cgi?'.$cgi->query_string%>">Excel spreadsheet</A>
+</TD>
 
 <% include('/elements/table-grid.html') %>
 
   <TR>
-    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2></TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=3></TH>
     <TH CLASS="grid" BGCOLOR="#cccccc" COLSPAN=9>Sales</TH>
-    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2></TH>
-    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2>Rate</TH>
-    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2></TH>
-    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2>Tax owed</TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=3></TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=3>Rate</TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=3></TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=3>Tax owed</TH>
 % unless ( $cgi->param('show_taxclasses') ) { 
-      <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2>Tax invoiced</TH>
+      <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=3>Tax invoiced</TH>
+      <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=3></TH>
+      <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=3>Tax credited</TH>
+      <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=3></TH>
+      <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=3>Tax collected</TH>
 % } 
   </TR>
 
   <TR>
-    <TH CLASS="grid" BGCOLOR="#cccccc">Total</TH>
-    <TH CLASS="grid" BGCOLOR="#cccccc"></TH>
-    <TH CLASS="grid" BGCOLOR="#cccccc">Non-taxable<BR><FONT SIZE=-1>(tax-exempt customer)</FONT></TH>
-    <TH CLASS="grid" BGCOLOR="#cccccc"></TH>
-    <TH CLASS="grid" BGCOLOR="#cccccc">Non-taxable<BR><FONT SIZE=-1>(tax-exempt package)</FONT></TH>
-    <TH CLASS="grid" BGCOLOR="#cccccc"></TH>
-    <TH CLASS="grid" BGCOLOR="#cccccc">Non-taxable<BR><FONT SIZE=-1>(monthly exemption)</FONT></TH>
-    <TH CLASS="grid" BGCOLOR="#cccccc"></TH>
-    <TH CLASS="grid" BGCOLOR="#cccccc">Taxable</TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2>Total</TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2></TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=1>Non-taxable</TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2></TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=1>Non-taxable</TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2></TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=1>Non-taxable</TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2></TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2>Taxable</TH>
+  </TR>
+
+  <TR>
+    <TH CLASS="grid" BGCOLOR="#cccccc"><FONT SIZE=-1>(tax-exempt customer)</FONT></TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc"><FONT SIZE=-1>(tax-exempt package)</FONT></TH>
+    <TH CLASS="grid" BGCOLOR="#cccccc"><FONT SIZE=-1>(monthly exemption)</FONT></TH>
   </TR>
 
 % my $bgcolor1 = '#eeeeee';
 % foreach my $region ( @regions ) {
 %
 %   my $link = '';
-%   if ( $region->{'label'} ne 'Total' ) {
-%     if ( $region->{'label'} eq $out ) {
-%       $link = ';out=1';
-%     } else {
-%       $link = ';'. $region->{'url_param'};
-%     }
+%   if ( $region->{'label'} eq $out ) {
+%     $link = ';out=1';
+%   } else {
+%     $link = ';'. $region->{'url_param'}
+%       if $region->{'url_param'};
 %   }
 %
 %   if ( $bgcolor eq $bgcolor1 ) {
       </TD>
 
 % unless ( $cgi->param('show_taxclasses') ) { 
+%       my $invlink = $region->{'url_param_inv'}
+%                       ? ';'. $region->{'url_param_inv'}
+%                       : $link;
+
         <<%$tdh%> ALIGN="right">
-          <A HREF="<% $baselink. $link %>;istax=1"
+          <A HREF="<% $baselink. $invlink %>;istax=1"
           ><% &$money_sprintf( $region->{'tax'} ) %></A>
         </TD>
+        <<%$tdh%>><FONT SIZE="+1"><B> - </B></FONT></TD>
+        <<%$tdh%> ALIGN="right">
+          <A HREF="<% $creditlink. $invlink %>;istax=1"
+          ><% &$money_sprintf( $region->{'credit'} ) %></A>
+        </TD>
+        <<%$tdh%>><FONT SIZE="+1"><B> = </B></FONT></TD>
+        <<%$tdh%> ALIGN="right">
+          <% &$money_sprintf( $region->{'tax'} - $region->{'credit'} ) %>
+        </TD>
 % } 
 
     </TR>
     <TR>
       <TH CLASS="grid" BGCOLOR="#cccccc"></TH>
       <TH CLASS="grid" BGCOLOR="#cccccc">Tax invoiced</TH>
+      <TH CLASS="grid" BGCOLOR="#cccccc"></TH>
+      <TH CLASS="grid" BGCOLOR="#cccccc">Tax credited</TH>
+      <TH CLASS="grid" BGCOLOR="#cccccc"></TH>
+      <TH CLASS="grid" BGCOLOR="#cccccc">Tax collected</TH>
     </TR>
 
 %   #some false laziness w/above
 %   foreach my $region ( @base_regions ) {
 %
 %     my $link = '';
-%     #if ( $region->{'label'} ne 'Total' ) {
-%       if ( $region->{'label'} eq $out ) {
-%         $link = ';out=1';
-%       } else {
-%         $link = ';'. $region->{'url_param'};
-%       }
-%     #}
+%     if ( $region->{'label'} eq $out ) {
+%       $link = ';out=1';
+%     } else {
+%       $link = ';'. $region->{'url_param'}
+%         if $region->{'url_param'};
+%     }
 %
 %     if ( $bgcolor eq $bgcolor1 ) {
 %       $bgcolor = $bgcolor2;
 %       $bgcolor = $bgcolor1;
 %     }
 %     my $td = qq(TD CLASS="grid" BGCOLOR="$bgcolor");
+%     my $tdh = qq(TD CLASS="grid" BGCOLOR="$bgcolor");
+%
+%     #?
+%     my $invlink = $region->{'url_param_inv'}
+%                     ? ';'. $region->{'url_param_inv'}
+%                     : $link;
 
       <TR>
         <<%$td%>><% $region->{'label'} %></TD>
           <A HREF="<% $baselink. $link %>;istax=1"
           ><% &$money_sprintf( $region->{'tax'} ) %></A>
         </TD>
+        <<%$td%>><FONT SIZE="+1"><B> - </B></FONT></TD>
+        <<%$tdh%> ALIGN="right">
+          <A HREF="<% $creditlink. $invlink %>;istax=1"
+          ><% &$money_sprintf( $region->{'credit'} ) %></A>
+        </TD>
+        <<%$td%>><FONT SIZE="+1"><B> = </B></FONT></TD>
+        <<%$tdh%> ALIGN="right">
+          <% &$money_sprintf( $region->{'tax'} - $region->{'credit'} ) %>
+        </TD>
       </TR>
 
 % } 
      <A HREF="<% $baselink %>;istax=1"
      ><% &$money_sprintf( $tot_tax ) %></A>
    </TD>
+        <<%$td%>><FONT SIZE="+1"><B> - </B></FONT></TD>
+   <<%$td%> ALIGN="right">
+     <A HREF="<% $creditlink %>;istax=1"
+     ><% &$money_sprintf( $tot_credit ) %></A>
+   </TD>
+        <<%$td%>><FONT SIZE="+1"><B> = </B></FONT></TD>
+   <<%$td%> ALIGN="right">
+     <% &$money_sprintf( $tot_tax - $tot_credit ) %>
+   </TD>
   </TR>
 
   </TABLE>
@@ -222,7 +275,10 @@ sub gotcust {
   my $table = shift;
   my $prefix = @_ ? shift : '';
   "
-        ( $table.${prefix}county  = cust_main_county.county
+        ( $table.${prefix}city  = cust_main_county.city
+          OR cust_main_county.city = ''
+          OR cust_main_county.city IS NULL )
+    AND ( $table.${prefix}county  = cust_main_county.county
           OR cust_main_county.county = ''
           OR cust_main_county.county IS NULL )
     AND ( $table.${prefix}state   = cust_main_county.state
@@ -275,16 +331,6 @@ if ( $conf->exists('tax-pkg_address') ) {
     "WHERE 0 < ( SELECT COUNT(*) FROM cust_main WHERE $gotcust LIMIT 1 )";
 }
 
-#tax-report_groups filtering
-my($group_op, $group_value) = ( '', '' );
-if ( $cgi->param('report_group') =~ /^(=|!=) (.*)$/ ) {
-  ( $group_op, $group_value ) = ( $1, $2 );
-}
-my $skipping_out = $group_op ? 1 : 0; #in case there are other reasons
-
-my( $total, $tot_taxable, $tot_owed ) = ( 0, 0, 0 );
-my( $exempt_cust, $exempt_pkg, $exempt_monthly ) = ( 0, 0, 0 );
-
 my $out = 'Out of taxable region(s)';
 my %regions = ();
 
@@ -297,10 +343,14 @@ foreach my $r ( qsearch({ 'table'     => 'cust_main_county',
 
   my $label = getlabel($r);
   $regions{$label}->{'label'} = $label;
+
+  $regions{$label}->{$_} = $r->$_() for (qw( county state country )); #taxname?
+
+  my @url_param = qw( county state country taxname );
+  push @url_param, 'city' if $cgi->param('show_cities') && $r->city();
+
   $regions{$label}->{'url_param'} =
-    join(';', map "$_=".uri_escape($r->$_()),
-                  qw( county state country taxname )
-        );
+    join(';', map "$_=".uri_escape($r->$_()), @url_param );
 
   my @param = @base_param;
   my $mywhere = $where;
@@ -312,6 +362,8 @@ foreach my $r ( qsearch({ 'table'     => 'cust_main_county',
     $regions{$label}->{'url_param'} .= ';taxclass='. uri_escape($r->taxclass);
     #no, always#  if $cgi->param('show_taxclasses');
 
+    $regions{$label}->{'taxclass'} = $r->taxclass;
+
   } else {
 
     $regions{$label}->{'url_param'} .= ';taxclassNULL=1'
@@ -335,9 +387,8 @@ foreach my $r ( qsearch({ 'table'     => 'cust_main_county',
    "SELECT SUM(cust_bill_pkg.setup+cust_bill_pkg.recur) $fromwhere AND $nottax";
   my $t = scalar_sql($r, \@param, $t_sql);
   $regions{$label}->{'total'} += $t;
-  $total += $t unless $label eq $out && $skipping_out;
 
-  #if ( $label eq $out ) {# && $t ) {
+  #if ( $label eq $out ) # && $t ) {
   #  warn "adding $t for ".
   #       join('/', map $r->$_, qw( taxclass county state country ) ). "\n";
   #  #warn $t_sql if $r->state eq 'FL';
@@ -359,13 +410,28 @@ foreach my $r ( qsearch({ 'table'     => 'cust_main_county',
 #    );
 #  }
 
+  #false laziness -ish w/report_tax.cgi
+  my $cust_exempt;
+  if ( $r->taxname ) {
+    my $q_taxname = dbh->quote($r->taxname);
+    $cust_exempt =
+      "( tax = 'Y'
+         OR EXISTS ( SELECT 1 FROM cust_main_exemption
+                       WHERE cust_main_exemption.custnum = cust_main.custnum
+                         AND cust_main_exemption.taxname = $q_taxname
+                   )
+       )
+      ";
+  } else {
+    $cust_exempt = " tax = 'Y' ";
+  }
+
   my $x_cust = scalar_sql($r, \@param,
     "SELECT SUM(cust_bill_pkg.setup+cust_bill_pkg.recur)
-     $fromwhere AND $nottax AND tax = 'Y' "
+     $fromwhere AND $nottax AND $cust_exempt "
   );
 
   $regions{$label}->{'exempt_cust'} += $x_cust;
-  $exempt_cust += $x_cust unless $label eq $out && $skipping_out;
   
   ## calculate package-exemption for this region
 
@@ -393,7 +459,6 @@ foreach my $r ( qsearch({ 'table'     => 'cust_main_county',
     "
   );
   $regions{$label}->{'exempt_pkg'} += $x_pkg;
-  $exempt_pkg += $x_pkg unless $label eq $out && $skipping_out;
 
   ## calculate monthly exemption (texas tax) for this region
 
@@ -407,22 +472,12 @@ foreach my $r ( qsearch({ 'table'     => 'cust_main_county',
        $join_cust_pkg
      $mywhere"
   );
-#  if ( $x_monthly ) {
-#    #warn $r->taxnum(). ": $x_monthly\n";
-#    $taxable -= $x_monthly;
-#  }
-
   $regions{$label}->{'exempt_monthly'} += $x_monthly;
-  $exempt_monthly += $x_monthly unless $label eq $out && $skipping_out;
 
   my $taxable = $t - $x_cust - $x_pkg - $x_monthly;
-
   $regions{$label}->{'taxable'} += $taxable;
-  $tot_taxable += $taxable unless $label eq $out && $skipping_out;
 
-  my $owed = $taxable * ($r->tax/100);
-  $regions{$label}->{'owed'} += $owed;
-  $tot_owed += $owed unless $label eq $out && $skipping_out;
+  $regions{$label}->{'owed'} += $taxable * ($r->tax/100);
 
   if ( defined($regions{$label}->{'rate'})
        && $regions{$label}->{'rate'} != $r->tax.'%' ) {
@@ -433,7 +488,7 @@ foreach my $r ( qsearch({ 'table'     => 'cust_main_county',
 
 }
 
-my $distinct = "country, state, county,
+my $distinct = "country, state, county, city, 
                 CASE WHEN taxname IS NULL THEN '' ELSE taxname END AS taxname";
 my $taxclass_distinct = 
   #a little bit unsure of this part... test?
@@ -463,9 +518,18 @@ if ( $conf->exists('tax-pkg_address') ) {
   $taxwhere =~ s/cust_pkg\.locationnum/cust_bill_pkg_tax_location.locationnum/g;
 
 }
+my $creditfromwhere = $taxfromwhere. 
+   " JOIN cust_credit_bill_pkg USING (billpkgnum";
+$creditfromwhere .= " ,billpkgtaxlocationnum"
+   if $conf->exists('tax-pkg_address');
+$creditfromwhere .= ")";
+
 $taxfromwhere .= " $taxwhere "; #AND payby != 'COMP' ";
+$creditfromwhere .= " $taxwhere AND billpkgtaxratelocationnum IS NULL"; #AND payby != 'COMP' ";
+
 my @taxparam = @base_param;
 
+
 #should i be a cust_main_county method or something
 #need to pass in $taxfromwhere & @taxparam???
 my $_taxamount_sub = sub {
@@ -483,13 +547,51 @@ my $_taxamount_sub = sub {
   scalar_sql($r, \@taxparam, $sql );
 };
 
+my $_creditamount_sub = sub {
+  my $r = shift;
+
+  #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 $sql = "SELECT SUM(cust_credit_bill_pkg.amount) ".
+            " $creditfromwhere AND cust_bill_pkg.pkgnum = 0 $named_tax";
+
+  scalar_sql($r, \@taxparam, $sql );
+};
+
+#tax-report_groups filtering
+my($group_op, $group_value) = ( '', '' );
+if ( $cgi->param('report_group') =~ /^(=|!=) (.*)$/ ) {
+  ( $group_op, $group_value ) = ( $1, $2 );
+}
+my $group_test = sub {
+  my $label = shift;
+  return 1 unless $group_op; #in case we get called inadvertantly
+  if ( $label eq $out ) { #don't display "out of taxable region" in this case
+    0;
+  } elsif ( $group_op eq '=' ) {
+    $label =~ /^$group_value/;
+  } elsif ( $group_op eq '!=' ) {
+    $label !~ /^$group_value/;
+  } else {
+    die "guru meditation #00de: group_op $group_op\n";
+  }
+};
+
 my $tot_tax = 0;
+my $tot_credit = 0;
 #foreach my $label ( keys %regions ) {
 foreach my $r ( qsearch(\%qsearch) ) {
 
   #warn join('-', map { $r->$_() } qw( country state county taxname ) )."\n";
 
   my $label = getlabel($r);
+  if ( $group_op ) {
+    next unless &{$group_test}($label);
+  }
 
   #my $fromwhere = $join_pkg. $where. " AND payby != 'COMP' ";
   #my @param = @base_param; 
@@ -499,6 +601,13 @@ foreach my $r ( qsearch(\%qsearch) ) {
   $regions{$label}->{'tax'} += $x;
   $tot_tax += $x unless $cgi->param('show_taxclasses');
 
+  ## calculate credit for this region
+
+  $x = &{$_creditamount_sub}($r);
+
+  $regions{$label}->{'credit'} += $x;
+  $tot_credit += $x unless $cgi->param('show_taxclasses');
+
 }
 
 my %base_regions = ();
@@ -519,26 +628,68 @@ if ( $cgi->param('show_taxclasses') ) {
 
     $base_regions{$base_label}->{'tax'} += $x;
     $tot_tax += $x;
+
+    ## calculate credit for this region
+
+    $x = &{$_creditamount_sub}($r);
+
+    $base_regions{$base_label}->{'credit'} += $x;
+    $tot_credit += $x;
+
   }
 
 }
 
-
 my @regions = keys %regions;
 
 #tax-report_groups filtering
+@regions = grep &{$group_test}($_), @regions
+  if $group_op;
+
+#calculate totals
+my( $total, $tot_taxable, $tot_owed ) = ( 0, 0, 0 );
+my( $exempt_cust, $exempt_pkg, $exempt_monthly, $tot_credit ) = ( 0, 0, 0, 0 );
+my %taxclasses = ();
+my %county = ();
+my %state = ();
+my %country = ();
+foreach (@regions) {
+  $total          += $regions{$_}->{'total'};
+  $tot_taxable    += $regions{$_}->{'taxable'};
+  $tot_owed       += $regions{$_}->{'owed'};
+  $exempt_cust    += $regions{$_}->{'exempt_cust'};
+  $exempt_pkg     += $regions{$_}->{'exempt_pkg'};
+  $exempt_monthly += $regions{$_}->{'exempt_monthly'};
+  $tot_credit     += $regions{$_}->{'credit'};
+  $taxclasses{$regions{$_}->{'taxclass'}} = 1
+    if $regions{$_}->{'taxclass'};
+  $county{$regions{$_}->{'county'}} = 1;
+  $state{$regions{$_}->{'state'}} = 1;
+  $country{$regions{$_}->{'country'}} = 1;
+}
+
+my $total_url_param = '';
+my $total_url_param_invoiced = '';
 if ( $group_op ) {
-  @regions = grep {
-    if ( $_ eq $out ) { #don't display "out of taxable region" in this case
-      0;
-    } elsif ( $group_op eq '=' ) {
-      $_ =~ /^$group_value \(/;
-    } elsif ( $group_op eq '!=' ) {
-      $_ !~ /^$group_value \(/;
-    } else {
-      die "guru meditation #00de: group_op $group_op\n";
-    }
-  } @regions;
+
+  my @country = keys %country;
+  warn "WARNING: multiple countries on this grouped report; total links broken"
+    if scalar(@country) > 1;
+  my $country = $country[0];
+
+  my @state = keys %state;
+  warn "WARNING: multiple countries on this grouped report; total links broken"
+    if scalar(@state) > 1;
+  my $state = $state[0];
+
+  $total_url_param_invoiced =
+  $total_url_param =
+    'report_group='.uri_escape("$group_op $group_value").';'.
+    join(';', map 'taxclass='.uri_escape($_), keys %taxclasses );
+  $total_url_param .= ';'.
+    "country=$country;state=".uri_escape($state).';'.
+    join(';', map 'county='.uri_escape($_), keys %county ) ;
+
 }
 
 #ordering
@@ -552,9 +703,11 @@ my @base_regions =
   sort { ( ($a eq $out) cmp ($b eq $out) ) || ($b cmp $a) }
   keys %base_regions;
 
+#add total line
 push @regions, {
   'label'          => 'Total',
-  'url_param'      => '',
+  'url_param'      => $total_url_param,
+  'url_param_inv'  => $total_url_param_invoiced,
   'total'          => $total,
   'exempt_cust'    => $exempt_cust,
   'exempt_pkg'     => $exempt_pkg,
@@ -563,6 +716,7 @@ push @regions, {
   'rate'           => '',
   'owed'           => $tot_owed,
   'tax'            => $tot_tax,
+  'credit'         => $tot_credit,
 };
 
 #-- 
@@ -579,8 +733,9 @@ sub getlabel {
   my $label;
   if (
     $r->tax == 0 
-    && ! scalar( qsearch('cust_main_county', { 'state'   => $r->state,
+    && ! scalar( qsearch('cust_main_county', { 'city'    => $r->city,
                                                'county'  => $r->county,
+                                               'state'   => $r->state,
                                                'country' => $r->country,
                                                'tax' => { op=>'>', value=>0 },
                                              }
@@ -599,6 +754,7 @@ sub getlabel {
     $label = $r->country;
     $label = $r->state.", $label" if $r->state;
     $label = $r->county." county, $label" if $r->county;
+    $label = $r->city. ", $label" if $r->city && $cgi->param('show_cities');
     $label = "$label (". $r->taxclass. ")"
       if $r->taxclass
       && $cgi->param('show_taxclasses')
@@ -635,5 +791,6 @@ $dateagentlink .= ';agentnum='. $cgi->param('agentnum')
   if length($agentname);
 my $baselink   = $p. "search/cust_bill_pkg.cgi?$dateagentlink";
 my $exemptlink = $p. "search/cust_tax_exempt_pkg.cgi?$dateagentlink";
+my $creditlink = $p. "search/cust_credit_bill_pkg.html?$dateagentlink";
 
 </%init>