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