(and fix the total too) fix overreporting of tax invoiced when using & reporting...
[freeside.git] / httemplate / search / report_tax.cgi
1 <% include("/elements/header.html", "$agentname Sales Tax Report - ".
2               ( $beginning
3                   ? time2str('%h %o %Y ', $beginning )
4                   : ''
5               ).
6               'through '.
7               ( $ending == 4294967295
8                   ? 'now'
9                   : time2str('%h %o %Y', $ending )
10               )
11           )
12 %>
13
14 <% include('/elements/table-grid.html') %>
15
16   <TR>
17     <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2></TH>
18     <TH CLASS="grid" BGCOLOR="#cccccc" COLSPAN=9>Sales</TH>
19     <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2></TH>
20     <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2>Rate</TH>
21     <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2></TH>
22     <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2>Tax owed</TH>
23 % unless ( $cgi->param('show_taxclasses') ) { 
24
25       <TH CLASS="grid" BGCOLOR="#cccccc" ROWSPAN=2>Tax invoiced</TH>
26 % } 
27
28   </TR>
29   <TR>
30     <TH CLASS="grid" BGCOLOR="#cccccc">Total</TH>
31     <TH CLASS="grid" BGCOLOR="#cccccc"></TH>
32     <TH CLASS="grid" BGCOLOR="#cccccc">Non-taxable<BR><FONT SIZE=-1>(tax-exempt customer)</FONT></TH>
33     <TH CLASS="grid" BGCOLOR="#cccccc"></TH>
34     <TH CLASS="grid" BGCOLOR="#cccccc">Non-taxable<BR><FONT SIZE=-1>(tax-exempt package)</FONT></TH>
35     <TH CLASS="grid" BGCOLOR="#cccccc"></TH>
36     <TH CLASS="grid" BGCOLOR="#cccccc">Non-taxable<BR><FONT SIZE=-1>(monthly exemption)</FONT></TH>
37     <TH CLASS="grid" BGCOLOR="#cccccc"></TH>
38     <TH CLASS="grid" BGCOLOR="#cccccc">Taxable</TH>
39   </TR>
40 % my $bgcolor1 = '#eeeeee';
41 %   my $bgcolor2 = '#ffffff';
42 %   my $bgcolor;
43 %
44 % foreach my $region ( @regions ) {
45 %
46 %       if ( $bgcolor eq $bgcolor1 ) {
47 %         $bgcolor = $bgcolor2;
48 %       } else {
49 %         $bgcolor = $bgcolor1;
50 %       }
51 %
52 %       my $link = '';
53 %       if ( $region->{'label'} ne 'Total' ) {
54 %         if ( $region->{'label'} eq $out ) {
55 %           $link = ';out=1';
56 %         } else {
57 %           $link = ';'. $region->{'url_param'};
58 %         }
59 %       }
60 %
61 %
62 %
63 %
64 %  
65
66
67     <TR>
68       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>"><% $region->{'label'} %></TD>
69       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>" ALIGN="right">
70         <A HREF="<% $baselink. $link %>;nottax=1"><% $money_char %><% sprintf('%.2f', $region->{'total'} ) %></A>
71       </TD>
72       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>"><FONT SIZE="+1"><B> - </B></FONT></TD>
73       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>" ALIGN="right">
74         <A HREF="<% $baselink. $link %>;nottax=1;cust_tax=Y"><% $money_char %><% sprintf('%.2f', $region->{'exempt_cust'} ) %></A>
75       </TD>
76       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>"><FONT SIZE="+1"><B> - </B></FONT></TD>
77       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>" ALIGN="right">
78         <A HREF="<% $baselink. $link %>;nottax=1;pkg_tax=Y"><% $money_char %><% sprintf('%.2f', $region->{'exempt_pkg'} ) %></A>
79       </TD>
80       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>"><FONT SIZE="+1"><B> - </B></FONT></TD>
81       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>" ALIGN="right">
82         <A HREF="<% $exemptlink. $link %>"><% $money_char %><% sprintf('%.2f', $region->{'exempt_monthly'} ) %></A>
83         </TD>
84       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>"><FONT SIZE="+1"><B> = </B></FONT></TD>
85       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>" ALIGN="right">
86         <% $money_char %><% sprintf('%.2f', $region->{'taxable'} ) %></A>
87       </TD>
88       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>"><% $region->{'label'} eq 'Total' ? '' : '<FONT FACE="sans-serif" SIZE="+1"><B> X </B></FONT>' %></TD>
89       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>" ALIGN="right"><% $region->{'rate'} %></TD>
90       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>"><% $region->{'label'} eq 'Total' ? '' : '<FONT FACE="sans-serif" SIZE="+1"><B> = </B></FONT>' %></TD>
91       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>" ALIGN="right">
92         <% $money_char %><% sprintf('%.2f', $region->{'owed'} ) %>
93       </TD>
94 % unless ( $cgi->param('show_taxclasses') ) { 
95
96         <TD CLASS="grid" BGCOLOR="<% $bgcolor %>" ALIGN="right">
97           <A HREF="<% $baselink. $link %>;istax=1"><% $money_char %><% sprintf('%.2f', $region->{'tax'} ) %></A>
98         </TD>
99 % } 
100
101     </TR>
102 % } 
103
104
105 </TABLE>
106 % if ( $cgi->param('show_taxclasses') ) { 
107
108
109   <BR>
110   <% include('/elements/table-grid.html') %>
111   <TR>
112     <TH CLASS="grid" BGCOLOR="#cccccc"></TH>
113     <TH CLASS="grid" BGCOLOR="#cccccc">Tax invoiced</TH>
114   </TR>
115 % #some false laziness w/above
116 %     $bgcolor1 = '#eeeeee';
117 %     $bgcolor2 = '#ffffff';
118 %     foreach my $region ( @base_regions ) {
119 %
120 %       if ( $bgcolor eq $bgcolor1 ) {
121 %         $bgcolor = $bgcolor2;
122 %       } else {
123 %         $bgcolor = $bgcolor1;
124 %       }
125 %
126 %       my $link = '';
127 %       #if ( $region->{'label'} ne 'Total' ) {
128 %         if ( $region->{'label'} eq $out ) {
129 %           $link = ';out=1';
130 %         } else {
131 %           $link = ';'. $region->{'url_param'};
132 %         }
133 %       #}
134 %  
135
136
137     <TR>
138       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>"><% $region->{'label'} %></TD>
139       <TD CLASS="grid" BGCOLOR="<% $bgcolor %>" ALIGN="right">
140         <A HREF="<% $baselink. $link %>;istax=1"><% $money_char %><% sprintf('%.2f', $region->{'tax'} ) %></A>
141       </TD>
142     </TR>
143 % } 
144 %
145 %     if ( $bgcolor eq $bgcolor1 ) {
146 %       $bgcolor = $bgcolor2;
147 %     } else {
148 %       $bgcolor = $bgcolor1;
149 %     }
150 %  
151
152
153   <TR>
154    <TD CLASS="grid" BGCOLOR="<% $bgcolor %>">Total</TD>
155     <TD CLASS="grid" BGCOLOR="<% $bgcolor %>" ALIGN="right">
156       <A HREF="<% $baselink %>;istax=1"><% $money_char %><% sprintf('%.2f', $tax ) %></A>
157     </TD>
158   </TR>
159
160   </TABLE>
161 % } 
162
163
164 </BODY>
165 </HTML>
166 <%init>
167
168 die "access denied"
169   unless $FS::CurrentUser::CurrentUser->access_right('Financial reports');
170
171 my $conf = new FS::Conf;
172 my $money_char = $conf->config('money_char') || '$';
173
174 my $user = getotaker;
175
176 my($beginning, $ending) = FS::UI::Web::parse_beginning_ending($cgi);
177
178 my $join_cust = "
179     JOIN cust_bill USING ( invnum ) 
180     LEFT JOIN cust_main USING ( custnum )
181 ";
182 my $from_join_cust = "
183     FROM cust_bill_pkg
184     $join_cust
185 "; 
186 my $join_pkg = "
187     LEFT JOIN cust_pkg USING ( pkgnum )
188     LEFT JOIN part_pkg USING ( pkgpart )
189 ";
190
191 my $where = "WHERE _date >= $beginning AND _date <= $ending ";
192 my @base_param = qw( county county state state country );
193 if ( $conf->exists('tax-ship_address') ) {
194
195   $where .= "
196       AND (    (     ( ship_last IS NULL     OR  ship_last  = '' )
197                  AND ( county       = ? OR ? = '' )
198                  AND ( state        = ? OR ? = '' )
199                  AND   country      = ?
200                )
201             OR (       ship_last IS NOT NULL AND ship_last != ''
202                  AND ( ship_county  = ? OR ? = '' )
203                  AND ( ship_state   = ? OR ? = '' )
204                  AND   ship_country = ?
205                )
206           )
207   ";
208   #    AND payby != 'COMP'
209
210   push @base_param, @base_param;
211
212 } else {
213
214   $where .= "
215       AND ( county  = ? OR ? = '' )
216       AND ( state   = ? OR ? = '' )
217       AND   country = ?
218   ";
219   #    AND payby != 'COMP'
220
221 }
222
223 my $agentname = '';
224 if ( $cgi->param('agentnum') =~ /^(\d+)$/ ) {
225   my $agent = qsearchs('agent', { 'agentnum' => $1 } );
226   die "agent not found" unless $agent;
227   $agentname = $agent->agent;
228   $where .= ' AND cust_main.agentnum = '. $agent->agentnum;
229 }
230
231 my $gotcust = "
232   WHERE 0 < ( SELECT COUNT(*) FROM cust_main
233 ";
234 if ( $conf->exists('tax-ship_address') ) {
235
236   $gotcust .= "
237                 WHERE
238
239                 (    cust_main_county.country = cust_main.country
240                   OR cust_main_county.country = cust_main.ship_country
241                 )
242
243                 AND
244
245                 ( 
246
247                   (     ( ship_last IS NULL     OR  ship_last = '' )
248                     AND (    cust_main_county.country = cust_main.country )
249                     AND (    cust_main_county.state = cust_main.state
250                           OR cust_main_county.state = ''
251                           OR cust_main_county.state IS NULL )
252                     AND (    cust_main_county.county = cust_main.county
253                           OR cust_main_county.county = ''
254                           OR cust_main_county.county IS NULL )
255                   )
256   
257                   OR
258   
259                   (       ship_last IS NOT NULL AND ship_last != ''
260                     AND (    cust_main_county.country = cust_main.ship_country )
261                     AND (    cust_main_county.state = cust_main.ship_state
262                           OR cust_main_county.state = ''
263                           OR cust_main_county.state IS NULL )
264                     AND (    cust_main_county.county = cust_main.ship_county
265                           OR cust_main_county.county = ''
266                           OR cust_main_county.county IS NULL )
267                   )
268
269                 )
270
271                 LIMIT 1
272             )
273   ";
274
275 } else {
276
277   $gotcust .= "
278                 WHERE ( cust_main.county  = cust_main_county.county
279                         OR cust_main_county.county = ''
280                         OR cust_main_county.county IS NULL )
281                   AND ( cust_main.state   = cust_main_county.state
282                         OR cust_main_county.state = ''
283                         OR cust_main_county.state IS NULL )
284                   AND ( cust_main.country = cust_main_county.country )
285                 LIMIT 1
286             )
287   ";
288
289 }
290
291 my($total, $tot_taxable, $owed, $tax) = ( 0, 0, 0, 0 );
292 my( $exempt_cust, $exempt_pkg, $exempt_monthly ) = ( 0, 0, 0 );
293 my $out = 'Out of taxable region(s)';
294 my %regions = ();
295 foreach my $r ( qsearch({ 'table'     => 'cust_main_county',
296                           'extra_sql' => $gotcust,
297                        })
298               )
299 {
300   #warn $r->county. ' '. $r->state. ' '. $r->country. "\n";
301
302   my $label = getlabel($r);
303   $regions{$label}->{'label'} = $label;
304   $regions{$label}->{'url_param'} = join(';', map "$_=".$r->$_(), qw( county state country ) );
305
306   my @param = @base_param;
307   my $mywhere = $where;
308
309   if ( $r->taxclass ) {
310
311     $mywhere .= " AND taxclass = ? ";
312     push @param, 'taxclass';
313     $regions{$label}->{'url_param'} .= ';taxclass='. $r->taxclass
314       if $cgi->param('show_taxclasses');
315
316   } else {
317
318     $regions{$label}->{'url_param'} .= ';taxclassNULL=1'
319       if $cgi->param('show_taxclasses');
320
321     my $same_sql = $r->sql_taxclass_sameregion;
322     $mywhere .= " AND $same_sql" if $same_sql;
323
324   }
325
326   my $fromwhere = $from_join_cust. $join_pkg. $mywhere. " AND payby != 'COMP' ";
327
328 #  my $label = getlabel($r);
329 #  $regions{$label}->{'label'} = $label;
330
331   my $nottax = 'pkgnum != 0';
332
333   ## calculate total for this region
334
335   my $t = scalar_sql($r, \@param,
336     "SELECT SUM(cust_bill_pkg.setup+cust_bill_pkg.recur) $fromwhere AND $nottax"
337   );
338   $total += $t;
339   $regions{$label}->{'total'} += $t;
340
341   ## calculate customer-exemption for this region
342
343 ##  my $taxable = $t;
344
345 #  my($taxable, $x_cust) = (0, 0);
346 #  foreach my $e ( grep { $r->get($_.'tax') !~ /^Y/i }
347 #                       qw( cust_bill_pkg.setup cust_bill_pkg.recur ) ) {
348 #    $taxable += scalar_sql($r, \@param, 
349 #      "SELECT SUM($e) $fromwhere AND $nottax AND ( tax != 'Y' OR tax IS NULL )"
350 #    );
351 #
352 #    $x_cust += scalar_sql($r, \@param, 
353 #      "SELECT SUM($e) $fromwhere AND $nottax AND tax = 'Y'"
354 #    );
355 #  }
356
357   my $x_cust = scalar_sql($r, \@param,
358     "SELECT SUM(cust_bill_pkg.setup+cust_bill_pkg.recur)
359      $fromwhere AND $nottax AND tax = 'Y' "
360   );
361
362   $exempt_cust += $x_cust;
363   $regions{$label}->{'exempt_cust'} += $x_cust;
364   
365   ## calculate package-exemption for this region
366
367   my $x_pkg = scalar_sql($r, \@param,
368     "SELECT SUM(
369                  ( CASE WHEN part_pkg.setuptax = 'Y'
370                         THEN cust_bill_pkg.setup
371                         ELSE 0
372                    END
373                  )
374                  +
375                  ( CASE WHEN part_pkg.recurtax = 'Y'
376                         THEN cust_bill_pkg.recur
377                         ELSE 0
378                    END
379                  )
380                )
381        $fromwhere
382        AND $nottax
383        AND (
384                 ( part_pkg.setuptax = 'Y' AND cust_bill_pkg.setup > 0 )
385              OR ( part_pkg.recurtax = 'Y' AND cust_bill_pkg.recur > 0 )
386            )
387        AND ( tax != 'Y' OR tax IS NULL )
388     "
389   );
390   $exempt_pkg += $x_pkg;
391   $regions{$label}->{'exempt_pkg'} += $x_pkg;
392
393   ## calculate monthly exemption (texas tax) for this region
394
395   # count up all the cust_tax_exempt_pkg records associated with
396   # the actual line items.
397
398   my $x_monthly = scalar_sql($r, \@param,
399     "SELECT SUM(amount)
400        FROM cust_tax_exempt_pkg
401        JOIN cust_bill_pkg USING ( billpkgnum )
402        $join_cust $join_pkg
403      $mywhere"
404   );
405 #  if ( $x_monthly ) {
406 #    #warn $r->taxnum(). ": $x_monthly\n";
407 #    $taxable -= $x_monthly;
408 #  }
409
410   $exempt_monthly += $x_monthly;
411   $regions{$label}->{'exempt_monthly'} += $x_monthly;
412
413   my $taxable = $t - $x_cust - $x_pkg - $x_monthly;
414
415   $tot_taxable += $taxable;
416   $regions{$label}->{'taxable'} += $taxable;
417
418   $owed += $taxable * ($r->tax/100);
419   $regions{$label}->{'owed'} += $taxable * ($r->tax/100);
420
421   if ( defined($regions{$label}->{'rate'})
422        && $regions{$label}->{'rate'} != $r->tax.'%' ) {
423     $regions{$label}->{'rate'} = 'variable';
424   } else {
425     $regions{$label}->{'rate'} = $r->tax.'%';
426   }
427
428 }
429
430 my $distinct = "country, state, county,
431                 CASE WHEN taxname IS NULL THEN '' ELSE taxname END AS taxname";
432 my $taxclass_distinct = 
433   #a little bit unsure of this part... test?
434   #ah, it looks like it winds up being irrelevant as ->{'tax'} 
435   # from $regions is not displayed when show_taxclasses is on
436   ( $cgi->param('show_taxclasses')
437       ? " CASE WHEN taxclass IS NULL THEN '' ELSE taxclass END "
438       : " '' "
439   )." AS taxclass";
440
441 my %qsearch = (
442   'select'    => "DISTINCT $distinct, $taxclass_distinct",
443   'table'     => 'cust_main_county',
444   'hashref'   => {},
445   'extra_sql' => $gotcust,
446 );
447
448 my $taxwhere = "$from_join_cust $where AND payby != 'COMP' ";
449 my @taxparam = @base_param;
450
451 #should i be a cust_main_county method or something
452 #need to pass in $taxwhere & @taxparam???
453 my $_taxamount_sub = sub {
454   my $r = shift;
455
456   #match itemdesc if necessary!
457   my $named_tax =
458     $r->taxname
459       ? 'AND itemdesc = '. dbh->quote($r->taxname)
460       : "AND ( itemdesc IS NULL OR itemdesc = '' OR itemdesc = 'Tax' )";
461
462   my $sql = "SELECT SUM(cust_bill_pkg.setup+cust_bill_pkg.recur) ".
463             " $taxwhere AND pkgnum = 0 $named_tax";
464
465   scalar_sql($r, \@taxparam, $sql );
466 };
467
468 #foreach my $label ( keys %regions ) {
469 foreach my $r ( qsearch(\%qsearch) ) {
470
471   #warn join('-', map { $r->$_() } qw( country state county taxname ) )."\n";
472
473   my $label = getlabel($r);
474
475   #my $fromwhere = $join_pkg. $where. " AND payby != 'COMP' ";
476   #my @param = @base_param; 
477
478   my $x = &{$_taxamount_sub}($r);
479
480   $tax += $x unless $cgi->param('show_taxclasses');
481   $regions{$label}->{'tax'} += $x;
482
483 }
484
485 my %base_regions = ();
486 if ( $cgi->param('show_taxclasses') ) {
487
488   $qsearch{'select'} = "DISTINCT $distinct";
489   foreach my $r ( qsearch(\%qsearch) ) {
490
491     my $x = &{$_taxamount_sub}($r);
492
493     my $base_label = getlabel($r, 'no_taxclass'=>1 );
494     $base_regions{$base_label}->{'label'} = $base_label;
495     $base_regions{$base_label}->{'url_param'} =
496       join(';', map "$_=".$r->$_(), qw( county state country ) );
497     $base_regions{$base_label}->{'tax'} += $x;
498     $tax += $x;
499   }
500
501 }
502
503
504 #ordering
505 my @regions =
506   map $regions{$_},
507   sort { ( ($a eq $out) cmp ($b eq $out) ) || ($b cmp $a) }
508   keys %regions;
509
510 my @base_regions =
511   map $base_regions{$_},
512   sort { ( ($a eq $out) cmp ($b eq $out) ) || ($b cmp $a) }
513   keys %base_regions;
514
515 push @regions, {
516   'label'          => 'Total',
517   'url_param'      => '',
518   'total'          => $total,
519   'exempt_cust'    => $exempt_cust,
520   'exempt_pkg'     => $exempt_pkg,
521   'exempt_monthly' => $exempt_monthly,
522   'taxable'        => $tot_taxable,
523   'rate'           => '',
524   'owed'           => $owed,
525   'tax'            => $tax,
526 };
527
528 #-- 
529
530 sub getlabel {
531   my $r = shift;
532   my %opt = @_;
533
534   my $label;
535   if (
536     $r->tax == 0 
537     && ! scalar( qsearch('cust_main_county', { 'state'   => $r->state,
538                                                'county'  => $r->county,
539                                                'country' => $r->country,
540                                                'tax' => { op=>'>', value=>0 },
541                                              }
542                         )
543                )
544
545   ) {
546     #kludge to avoid "will not stay shared" warning
547     my $out = 'Out of taxable region(s)';
548     $label = $out;
549   } elsif ( $r->taxname ) {
550     $label = $r->taxname;
551 #    $regions{$label}->{'taxname'} = $label;
552 #    push @{$regions{$label}->{$_}}, $r->$_() foreach qw( county state country );
553   } else {
554     $label = $r->country;
555     $label = $r->state.", $label" if $r->state;
556     $label = $r->county." county, $label" if $r->county;
557     $label = "$label (". $r->taxclass. ")"
558       if $r->taxclass
559       && $cgi->param('show_taxclasses')
560       && ! $opt{'no_taxclass'};
561     #$label = $r->taxname. " ($label)" if $r->taxname;
562   }
563   return $label;
564 }
565
566 #false laziness w/FS::Report::Table::Monthly (sub should probably be moved up
567 #to FS::Report or FS::Record or who the fuck knows where)
568 sub scalar_sql {
569   my( $r, $param, $sql ) = @_;
570   #warn "$sql\n";
571   my $sth = dbh->prepare($sql) or die dbh->errstr;
572   $sth->execute( map $r->$_(), @$param )
573     or die "Unexpected error executing statement $sql: ". $sth->errstr;
574   $sth->fetchrow_arrayref->[0] || 0;
575 }
576
577 my $dateagentlink = "begin=$beginning;end=$ending";
578 $dateagentlink .= ';agentnum='. $cgi->param('agentnum')
579   if length($agentname);
580 my $baselink   = $p. "search/cust_bill_pkg.cgi?$dateagentlink";
581 my $exemptlink = $p. "search/cust_tax_exempt_pkg.cgi?$dateagentlink";
582
583 </%init>