change calculation method for prepaid income report, #13289
[freeside.git] / httemplate / search / cust_bill_pkg.cgi
1 <& elements/search.html,
2                  'title'       => emt('Line items'),
3                  'name'        => emt('line items'),
4                  'query'       => $query,
5                  'count_query' => $count_query,
6                  'count_addl'  => [ $money_char. '%.2f total',
7                                     $unearned ? ( $money_char. '%.2f unearned revenue' ) : (),
8                                   ],
9                  'header'      => [
10                    emt('Description'),
11                    ( $unearned
12                      ? ( emt('Unearned'), 
13                          emt('Owed'), # useful in 'paid' mode?
14                          emt('Payment date') )
15                      : ( emt('Setup charge') )
16                    ),
17                    ( $use_usage eq 'usage'
18                      ? emt('Usage charge')
19                      : emt('Recurring charge')
20                    ),
21                    ( $unearned
22                      ? ( emt('Charge start'), emt('Charge end') )
23                      : ()
24                    ),
25                    emt('Invoice'),
26                    emt('Date'),
27                    FS::UI::Web::cust_header(),
28                  ],
29                  'fields'      => [
30                    sub { $_[0]->pkgnum > 0
31                            ? $_[0]->get('pkg')      # possibly use override.pkg
32                            : $_[0]->get('itemdesc') # but i think this correct
33                        },
34                    #strikethrough or "N/A ($amount)" or something these when
35                    # they're not applicable to pkg_tax search
36                    sub { my $cust_bill_pkg = shift;
37                          if ( $unearned ) {
38
39                            sprintf($money_char.'%.2f', 
40                              $cust_bill_pkg->unearned_revenue)
41
42                          } else {
43                            sprintf($money_char.'%.2f', $cust_bill_pkg->setup );
44                          }
45                        },
46                    ( $unearned
47                      ? ( $owed_sub, $payment_date_sub, )
48                      : ()
49                    ),
50                    sub { my $row = shift;
51                          my $value = 0;
52                          if ( $use_usage eq 'recurring' or $unearned ) {
53                            $value = $row->recur - $row->usage;
54                          } elsif ( $use_usage eq 'usage' ) {
55                            $value = $row->usage;
56                          } else {
57                            $value = $row->recur;
58                          }
59                          sprintf($money_char.'%.2f', $value );
60                        },
61                    ( $unearned
62                      ? ( sub { time2str('%b %d %Y', shift->sdate ) },
63                        # shift edate back a day
64                        # 82799 = 3600*23 - 1
65                        # (to avoid skipping a day during DST)
66                          sub { time2str('%b %d %Y', shift->edate - 82799 ) },
67                        )
68                      : ()
69                    ),
70                    'invnum',
71                    sub { time2str('%b %d %Y', shift->_date ) },
72                    \&FS::UI::Web::cust_fields,
73                  ],
74                  'sort_fields' => [
75                    '',
76                    'setup', #broken in $unearned case i guess
77                    ( $unearned ? ('', '') : () ),
78                    ( $use_usage eq 'recurring' or $unearned
79                         ? 'recur - usage' :
80                      $use_usage eq 'usage' 
81                         ? 'usage'
82                         : 'recur'
83                    ),
84                    ( $unearned ? ('sdate', 'edate') : () ),
85                    'invnum',
86                    '_date',
87                  ],
88                  'links'       => [
89                    #'',
90                    '',
91                    '',
92                    ( $unearned ? ( '', '' ) : () ),
93                    '',
94                    ( $unearned ? ( '', '' ) : () ),
95                    $ilink,
96                    $ilink,
97                    ( map { $_ ne 'Cust. Status' ? $clink : '' }
98                          FS::UI::Web::cust_header()
99                    ),
100                  ],
101                  #'align' => 'rlrrrc'.FS::UI::Web::cust_aligns(),
102                  'align' => 'lr'.
103                             ( $unearned ? 'rc' : '' ).
104                             'r'.
105                             ( $unearned ? 'cc' : '' ).
106                             'rc'.
107                             FS::UI::Web::cust_aligns(),
108                  'color' => [ 
109                               #'',
110                               '',
111                               '',
112                               ( $unearned ? ( '', '' ) : () ),
113                               '',
114                               ( $unearned ? ( '', '' ) : () ),
115                               '',
116                               '',
117                               FS::UI::Web::cust_colors(),
118                             ],
119                  'style' => [ 
120                               #'',
121                               '',
122                               '',
123                               ( $unearned ? ( '', '' ) : () ),
124                               '',
125                               ( $unearned ? ( '', '' ) : () ),
126                               '',
127                               '',
128                               FS::UI::Web::cust_styles(),
129                             ],
130 &>
131 <%init>
132
133 #LOTS of false laziness below w/cust_credit_bill_pkg.cgi
134
135 die "access denied"
136   unless $FS::CurrentUser::CurrentUser->access_right('Financial reports');
137
138 my $conf = new FS::Conf;
139
140 my $unearned = '';
141 my $unearned_mode = '';
142 my $unearned_base = '';
143 my $unearned_sql = '';
144
145 my @select = ( 'cust_bill_pkg.*', 'cust_bill._date' );
146 my ($join_cust, $join_pkg ) = ('', '');
147
148 #here is the agent virtualization
149 my $agentnums_sql =
150   $FS::CurrentUser::CurrentUser->agentnums_sql( 'table' => 'cust_main' );
151
152 my @where = ( $agentnums_sql );
153
154 my($beginning, $ending) = FS::UI::Web::parse_beginning_ending($cgi);
155
156 if ( $cgi->param('status') =~ /^([a-z]+)$/ ) {
157   push @where, FS::cust_main->cust_status_sql . " = '$1'";
158 }
159
160 if ( $cgi->param('distribute') == 1 ) {
161   push @where, "sdate <= $ending",
162                "edate >  $beginning",
163   ;
164 }
165 else {
166   push @where, "cust_bill._date >= $beginning",
167                "cust_bill._date <= $ending";
168 }
169
170 if ( $cgi->param('agentnum') =~ /^(\d+)$/ ) {
171   push @where, "cust_main.agentnum = $1";
172 }
173
174 #classnum
175 # not specified: all classes
176 # 0: empty class
177 # N: classnum
178 my $use_override = $cgi->param('use_override');
179 if ( $cgi->param('classnum') =~ /^(\d+)$/ ) {
180   my $comparison = '';
181   if ( $1 == 0 ) {
182     $comparison = "IS NULL";
183   } else {
184     $comparison = "= $1";
185   }
186
187   if ( $use_override ) {
188     push @where, "(
189       part_pkg.classnum $comparison AND pkgpart_override IS NULL OR
190       override.classnum $comparison AND pkgpart_override IS NOT NULL
191     )";
192   } else {
193     push @where, "part_pkg.classnum $comparison";
194   }
195 }
196
197 if ( $cgi->param('taxclass')
198      && ! $cgi->param('istax')  #no part_pkg.taxclass in this case
199                                 #(should we save a taxclass or a link to taxnum
200                                 # in cust_bill_pkg or something like
201                                 # cust_bill_pkg_tax_location?)
202    )
203 {
204
205   #override taxclass when use_override is specified?  probably
206   #if ( $use_override ) {
207   #
208   #  push @where,
209   #    ' ( '. join(' OR ',
210   #                  map {
211   #                        ' (    part_pkg.taxclass = '. dbh->quote($_).
212   #                        '      AND pkgpart_override IS NULL '.
213   #                        '   OR '.
214   #                        '      override.taxclass = '. dbh->quote($_).
215   #                        '      AND pkgpart_override IS NOT NULL '.
216   #                        ' ) '
217   #                      }
218   #                      $cgi->param('taxclass')
219   #               ).
220   #    ' ) ';
221   #
222   #} else {
223
224     push @where, ' part_pkg.taxclass IN ( '.
225                    join(', ', map dbh->quote($_), $cgi->param('taxclass') ).
226                  ' ) ';
227
228   #}
229
230 }
231
232 my @loc_param = qw( district city county state country );
233
234 if ( $cgi->param('out') ) {
235
236   my ( $loc_sql, @param ) = FS::cust_pkg->location_sql( 'ornull' => 1 );
237   while ( $loc_sql =~ /\?/ ) { #easier to do our own substitution
238     $loc_sql =~ s/\?/'cust_main_county.'.shift(@param)/e;
239   }
240
241   $loc_sql =~ s/cust_pkg\.locationnum/cust_bill_pkg_tax_location.locationnum/g
242     if $cgi->param('istax');
243
244   push @where, "
245     0 = (
246           SELECT COUNT(*) FROM cust_main_county
247            WHERE cust_main_county.tax > 0
248              AND $loc_sql
249         )
250   ";
251
252   #not linked to by anything, but useful for debugging "out of taxable region"
253   if ( grep $cgi->param($_), @loc_param ) {
254
255     my %ph = map { $_ => dbh->quote( scalar($cgi->param($_)) ) } @loc_param;
256
257     my ( $loc_sql, @param ) = FS::cust_pkg->location_sql;
258     while ( $loc_sql =~ /\?/ ) { #easier to do our own substitution
259       $loc_sql =~ s/\?/$ph{shift(@param)}/e;
260     }
261
262     push @where, $loc_sql;
263
264   }
265
266 } elsif ( $cgi->param('country') ) {
267
268   my @counties = $cgi->param('county');
269    
270   if ( scalar(@counties) > 1 ) {
271
272     #hacky, could be more efficient.  care if it is ever used for more than the
273     # tax-report_groups filtering kludge
274
275     my $locs_sql =
276       ' ( '. join(' OR ', map {
277
278           my %ph = ( 'county' => dbh->quote($_),
279                      map { $_ => dbh->quote( $cgi->param($_) ) }
280                        qw( district city state country )
281                    );
282
283           my ( $loc_sql, @param ) = FS::cust_pkg->location_sql;
284           while ( $loc_sql =~ /\?/ ) { #easier to do our own substitution
285             $loc_sql =~ s/\?/$ph{shift(@param)}/e;
286           }
287
288           $loc_sql;
289
290         } @counties
291
292       ). ' ) ';
293
294     push @where, $locs_sql;
295
296   } else {
297
298     my %ph = map { $_ => dbh->quote( scalar($cgi->param($_)) ) } @loc_param;
299
300     my ( $loc_sql, @param ) = FS::cust_pkg->location_sql;
301     while ( $loc_sql =~ /\?/ ) { #easier to do our own substitution
302       $loc_sql =~ s/\?/$ph{shift(@param)}/e;
303     }
304
305     push @where, $loc_sql;
306
307   }
308    
309   if ( $cgi->param('istax') ) {
310     if ( $cgi->param('taxname') ) {
311       push @where, 'itemdesc = '. dbh->quote( $cgi->param('taxname') );
312     #} elsif ( $cgi->param('taxnameNULL') {
313     } else {
314       push @where, "( itemdesc IS NULL OR itemdesc = '' OR itemdesc = 'Tax' )";
315     }
316   } elsif ( $cgi->param('nottax') ) {
317     #what can we usefully do with "taxname" ????  look up a class???
318   } else {
319     #warn "neither nottax nor istax parameters specified";
320   }
321
322   if ( $cgi->param('taxclassNULL')
323        && ! $cgi->param('istax')  #no part_pkg.taxclass in this case
324                                   #(see comment above?)
325      )
326   {
327     my %hash = ( 'country' => scalar($cgi->param('country')) );
328     foreach (qw( state county )) {
329       $hash{$_} = scalar($cgi->param($_)) if $cgi->param($_);
330     }
331     my $cust_main_county = qsearchs('cust_main_county', \%hash);
332     die "unknown base region for empty taxclass" unless $cust_main_county;
333
334     my $same_sql = $cust_main_county->sql_taxclass_sameregion;
335     $same_sql =~ s/taxclass/part_pkg.taxclass/g;
336     push @where, $same_sql if $same_sql;
337
338   }
339
340 } elsif ( scalar( grep( /locationtaxid/, $cgi->param ) ) ) {
341
342   push @where, FS::tax_rate_location->location_sql(
343                  map { $_ => (scalar($cgi->param($_)) || '') }
344                    qw( district city county state locationtaxid )
345                );
346
347 }
348
349 # unearned revenue mode
350 if ( $cgi->param('unearned_now') =~ /^(\d+)$/ ) {
351
352   $unearned = $1;
353   $unearned_mode = $cgi->param('mode');
354
355   push @where, "cust_bill_pkg.sdate < $unearned",
356                "cust_bill_pkg.edate > $unearned",
357                "cust_bill_pkg.recur != 0",
358                "part_pkg.freq != '0'";
359
360   if ( !$cgi->param('include_monthly') ) {
361     push @where,
362                "part_pkg.freq != '1'",
363                "part_pkg.freq NOT LIKE '%h'",
364                "part_pkg.freq NOT LIKE '%d'",
365                "part_pkg.freq NOT LIKE '%w'";
366   }
367
368   my $usage_sql = FS::cust_bill_pkg->usage_sql;
369   push @select, "($usage_sql) AS usage"; # we need this
370   my $owed_sql = FS::cust_bill_pkg->owed_sql($unearned, '', 
371     setuprecur => 'recur', no_usage => 1);
372   push @select, "($owed_sql) AS owed"; # also this
373
374   $unearned_base = "(cust_bill_pkg.recur - $usage_sql)";
375   my $period = "CAST(cust_bill_pkg.edate - cust_bill_pkg.sdate AS REAL)";
376   my $elapsed = "GREATEST( $unearned - cust_bill_pkg.sdate, 0 )";
377   my $remaining = "(1 - $elapsed/$period)";
378
379   $unearned_sql = "CAST(
380   GREATEST( ( $unearned_base * $remaining ) - $owed_sql, 0 )
381     AS DECIMAL(10,2)
382   )";
383   push @select, "$unearned_sql AS unearned_revenue";
384
385   if ( $unearned_mode eq 'billed' ) {
386     # include only rows that have some unearned portion
387     push @where, "$unearned_base > 0";
388   }
389   elsif ( $unearned_mode eq 'paid' ) {
390     # include only those that have some _paid_ unearned portion
391     push @where, "$unearned_sql > 0";
392   }
393
394 }
395
396 if ( $cgi->param('itemdesc') ) {
397   if ( $cgi->param('itemdesc') eq 'Tax' ) {
398     push @where, "(itemdesc='Tax' OR itemdesc is null)";
399   } else {
400     push @where, 'itemdesc='. dbh->quote($cgi->param('itemdesc'));
401   }
402 }
403
404 if ( $cgi->param('report_group') =~ /^(=|!=) (.*)$/ && $cgi->param('istax') ) {
405   my ( $group_op, $group_value ) = ( $1, $2 );
406   if ( $group_op eq '=' ) {
407     #push @where, 'itemdesc LIKE '. dbh->quote($group_value.'%');
408     push @where, 'itemdesc = '. dbh->quote($group_value);
409   } elsif ( $group_op eq '!=' ) {
410     push @where, '( itemdesc != '. dbh->quote($group_value) .' OR itemdesc IS NULL )';
411   } else {
412     die "guru meditation #00de: group_op $group_op\n";
413   }
414   
415 }
416
417 push @where, 'cust_bill_pkg.pkgnum != 0' if $cgi->param('nottax');
418 push @where, 'cust_bill_pkg.pkgnum  = 0' if $cgi->param('istax');
419
420 if ( $cgi->param('cust_tax') ) {
421   #false laziness -ish w/report_tax.cgi
422   my $cust_exempt;
423   if ( $cgi->param('taxname') ) {
424     my $q_taxname = dbh->quote($cgi->param('taxname'));
425     $cust_exempt =
426       "( tax = 'Y'
427          OR EXISTS ( SELECT 1 FROM cust_main_exemption
428                        WHERE cust_main_exemption.custnum = cust_main.custnum
429                          AND cust_main_exemption.taxname = $q_taxname )
430        )
431       ";
432   } else {
433     $cust_exempt = " tax = 'Y' ";
434   }
435
436   push @where, $cust_exempt;
437 }
438
439 my $use_usage = $cgi->param('use_usage');
440
441 my $count_query;
442 if ( $cgi->param('pkg_tax') ) {
443
444   $count_query =
445     "SELECT COUNT(*),
446             SUM(
447                  ( CASE WHEN part_pkg.setuptax = 'Y'
448                         THEN cust_bill_pkg.setup
449                         ELSE 0
450                    END
451                  )
452                  +
453                  ( CASE WHEN part_pkg.recurtax = 'Y'
454                         THEN cust_bill_pkg.recur
455                         ELSE 0
456                    END
457                  )
458                )
459     ";
460
461   push @where, "(    ( part_pkg.setuptax = 'Y' AND cust_bill_pkg.setup > 0 )
462                   OR ( part_pkg.recurtax = 'Y' AND cust_bill_pkg.recur > 0 ) )",
463                "( tax != 'Y' OR tax IS NULL )";
464
465 } elsif ( $cgi->param('taxable') ) {
466
467   my $setup_taxable = "(
468     CASE WHEN part_pkg.setuptax = 'Y'
469          THEN 0
470          ELSE cust_bill_pkg.setup
471     END
472   )";
473
474   my $recur_taxable = "(
475     CASE WHEN part_pkg.recurtax = 'Y'
476          THEN 0
477          ELSE cust_bill_pkg.recur
478     END
479   )";
480
481   my $exempt = "(
482     SELECT COALESCE( SUM(amount), 0 ) FROM cust_tax_exempt_pkg
483       WHERE cust_tax_exempt_pkg.billpkgnum = cust_bill_pkg.billpkgnum
484   )";
485
486   $count_query =
487     "SELECT COUNT(*), SUM( $setup_taxable + $recur_taxable - $exempt )";
488
489   push @where,
490     #not tax-exempt package (setup or recur)
491     "(
492           ( ( part_pkg.setuptax != 'Y' OR part_pkg.setuptax IS NULL )
493             AND cust_bill_pkg.setup > 0 )
494        OR
495           ( ( part_pkg.recurtax != 'Y' OR part_pkg.recurtax IS NULL )
496             AND cust_bill_pkg.recur > 0 )
497     )",
498     #not a tax_exempt customer
499     "( tax != 'Y' OR tax IS NULL )";
500     #not covered in full by a monthly tax exemption (texas tax)
501     "0 < ( $setup_taxable + $recur_taxable - $exempt )",
502
503 } else {
504
505   if ( $use_usage ) {
506     $count_query = "SELECT COUNT(*), ";
507   } else {
508     $count_query = "SELECT COUNT(DISTINCT billpkgnum), ";
509   }
510
511   if ( $unearned ) {
512     $count_query .= "SUM( $unearned_base ), SUM( $unearned_sql )";
513   } elsif ( $use_usage eq 'recurring' ) {
514     $count_query .= "SUM(setup + recur - usage)";
515   } elsif ( $use_usage eq 'usage' ) {
516     $count_query .= "SUM(usage)";
517   } elsif ( scalar( grep( /locationtaxid/, $cgi->param ) ) ) {
518     $count_query .= "SUM( COALESCE(cust_bill_pkg_tax_rate_location.amount, cust_bill_pkg.setup + cust_bill_pkg.recur))";
519   } elsif ( $cgi->param('iscredit') eq 'rate') {
520     $count_query .= "SUM( cust_credit_bill_pkg.amount )";
521   } else {
522     $count_query .= "SUM(cust_bill_pkg.setup + cust_bill_pkg.recur)";
523   }
524
525 }
526
527 $join_cust =  '        JOIN cust_bill USING ( invnum )
528                   LEFT JOIN cust_main USING ( custnum ) ';
529
530 if ( $cgi->param('nottax') ) {
531
532   $join_pkg .=  ' LEFT JOIN cust_pkg USING ( pkgnum )
533                   LEFT JOIN part_pkg USING ( pkgpart )
534                   LEFT JOIN part_pkg AS override
535                     ON pkgpart_override = override.pkgpart ';
536   $join_pkg .= ' LEFT JOIN cust_location USING ( locationnum ) '
537     if $conf->exists('tax-pkg_address');
538
539 } elsif ( $cgi->param('istax') ) {
540
541   #false laziness w/report_tax.cgi $taxfromwhere
542   if ( scalar( grep( /locationtaxid/, $cgi->param ) ) ||
543             $cgi->param('iscredit') eq 'rate') {
544
545     $join_pkg .=
546       ' LEFT JOIN cust_bill_pkg_tax_rate_location USING ( billpkgnum ) '.
547       ' LEFT JOIN tax_rate_location USING ( taxratelocationnum ) ';
548
549   } elsif ( $conf->exists('tax-pkg_address') ) {
550
551     $join_pkg .= ' LEFT JOIN cust_bill_pkg_tax_location USING ( billpkgnum )
552                    LEFT JOIN cust_location              USING ( locationnum ) ';
553
554     #quelle kludge, somewhat false laziness w/report_tax.cgi
555     s/cust_pkg\.locationnum/cust_bill_pkg_tax_location.locationnum/g for @where;
556   }
557
558   if ( $cgi->param('iscredit') ) {
559     $join_pkg .= ' JOIN cust_credit_bill_pkg USING ( billpkgnum';
560     if ( $cgi->param('iscredit') eq 'rate' ) {
561       $join_pkg .= ', billpkgtaxratelocationnum )';
562     } elsif ( $conf->exists('tax-pkg_address') ) {
563       $join_pkg .= ', billpkgtaxlocationnum )';
564       push @where, "billpkgtaxratelocationnum IS NULL";
565     } else {
566       $join_pkg .= ' )';
567       push @where, "billpkgtaxratelocationnum IS NULL";
568     }
569   }
570
571 } else { 
572
573   #die?
574   warn "neiether nottax nor istax parameters specified";
575   #same as before?
576   $join_pkg =  ' LEFT JOIN cust_pkg USING ( pkgnum )
577                  LEFT JOIN part_pkg USING ( pkgpart ) ';
578
579 }
580
581 my $where = ' WHERE '. join(' AND ', @where);
582
583 if ($use_usage) {
584   $count_query .=
585     " FROM (SELECT cust_bill_pkg.setup, cust_bill_pkg.recur, 
586              ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_bill_pkg_detail
587                WHERE cust_bill_pkg.billpkgnum = cust_bill_pkg_detail.billpkgnum
588              ) AS usage FROM cust_bill_pkg  $join_cust $join_pkg $where
589            ) AS countquery";
590 } else {
591   $count_query .= " FROM cust_bill_pkg $join_cust $join_pkg $where";
592 }
593
594 push @select, 'part_pkg.pkg',
595               'part_pkg.freq',
596   unless $cgi->param('istax');
597
598 push @select, 'cust_main.custnum',
599               FS::UI::Web::cust_sql_fields();
600
601 my $query = {
602   'table'     => 'cust_bill_pkg',
603   'addl_from' => "$join_cust $join_pkg",
604   'hashref'   => {},
605   'select'    => join(",\n", @select ),
606   'extra_sql' => $where,
607   'order_by'  => 'ORDER BY cust_bill._date, billpkgnum',
608 };
609
610 my $ilink = [ "${p}view/cust_bill.cgi?", 'invnum' ];
611 my $clink = [ "${p}view/cust_main.cgi?", 'custnum' ];
612
613 my $conf = new FS::Conf;
614 my $money_char = $conf->config('money_char') || '$';
615
616 my $owed_sub = sub {
617   $money_char . shift->get('owed') # owed_recur is not correct here
618 };
619 my $payment_date_sub = sub {
620   #my $cust_bill_pkg = shift;
621   my @cust_pay = sort { $a->_date <=> $b->_date }
622                       map $_->cust_bill_pay->cust_pay,
623                           shift->cust_bill_pay_pkg('recur') #recur :/
624     or return '';
625   time2str('%b %d %Y', $cust_pay[-1]->_date );
626 };
627
628 </%init>