sales tax report: detail link and better accuracy for "out of taxable" calculation...
[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'  => \@total_desc,
7                  'header'      => [
8                    @pkgnum_header,
9                    emt('Pkg Def'),
10                    emt('Description'),
11                    @post_desc_header,
12                    @peritem_desc,
13                    emt('Invoice'),
14                    emt('Date'),
15                    emt('Paid'),
16                    emt('Credited'),
17                    FS::UI::Web::cust_header(),
18                  ],
19                  'fields'      => [
20                    @pkgnum,
21                    sub { $_[0]->pkgnum > 0
22                            ? $_[0]->get('pkgpart')
23                            : ''
24                        },
25                    'itemdesc', # is part_pkg.pkg if applicable
26                    @post_desc,
27                    #strikethrough or "N/A ($amount)" or something these when
28                    # they're not applicable to pkg_tax search
29                    @peritem_sub,
30                    'invnum',
31                    sub { time2str('%b %d %Y', shift->_date ) },
32                    sub { sprintf($money_char.'%.2f', shift->get('pay_amount')) },
33                    sub { sprintf($money_char.'%.2f', shift->get('credit_amount')) },
34                    \&FS::UI::Web::cust_fields,
35                  ],
36                  'sort_fields' => [
37                    @pkgnum_null,
38                    '',
39                    '',
40                    @post_desc_null,
41                    @peritem,
42                    'invnum',
43                    '_date',
44                    '', #'pay_amount',
45                    '', #'credit_amount',
46                    FS::UI::Web::cust_sort_fields(),
47                  ],
48                  'links'       => [
49                    @pkgnum_null,
50                    '',
51                    '',
52                    @post_desc_null,
53                    @peritem_null,
54                    $ilink,
55                    $ilink,
56                    $pay_link,
57                    $credit_link,
58                    ( map { $_ ne 'Cust. Status' ? $clink : '' }
59                          FS::UI::Web::cust_header()
60                    ),
61                  ],
62                  #'align' => 'rlrrrc'.FS::UI::Web::cust_aligns(),
63                  'align' => $pkgnum_align.
64                             'rl'.
65                             $post_desc_align.
66                             $peritem_align.
67                             'rcrr'.
68                             FS::UI::Web::cust_aligns(),
69                  'color' => [ 
70                               @pkgnum_null,
71                               '',
72                               '',
73                               @post_desc_null,
74                               @peritem_null,
75                               '',
76                               '',
77                               '',
78                               '',
79                               FS::UI::Web::cust_colors(),
80                             ],
81                  'style' => [ 
82                               @pkgnum_null,
83                               '',
84                               '',
85                               @post_desc_null,
86                               @peritem_null,
87                               '',
88                               '',
89                               '',
90                               '',
91                               FS::UI::Web::cust_styles(),
92                             ],
93 &>
94 <%doc>
95
96 Output control parameters:
97 - distribute: Boolean.  If true, recurring fees will be "prorated" for the 
98   portion of the package date range (sdate-edate) that falls within the date
99   range of the report.  Line items will be limited to those for which this 
100   portion is > 0.  This disables filtering on invoice date.
101
102 - usage: Separate usage (cust_bill_pkg_detail records) from
103   recurring charges.  If set to "usage", will show usage instead of 
104   recurring charges.  If set to "recurring", will deduct usage and only
105   show the flat rate charge.  If not passed, the "recurring charge" column
106   will include usage charges also.
107
108 Filtering parameters:
109 - begin, end: Date range.  Applies to invoice date, not necessarily package
110   date range.  But see "distribute".
111
112 - status: Customer status (active, suspended, etc.).  This will filter on 
113   _current_ customer status, not status at the time the invoice was generated.
114
115 - agentnum: Filter on customer agent.
116
117 - refnum: Filter on customer reference source.
118
119 - cust_classnum: Filter on customer class.
120
121 - classnum: Filter on package class.
122
123 - report_optionnum: Filter on package report class.  Can be a single report
124   class number or a comma-separated list (where 0 is "no report class"), or the
125   word "multiple".
126
127 - use_override: Apply "classnum" and "taxclass" filtering based on the 
128   override (bundle) pkgpart, rather than always using the true pkgpart.
129
130 - nottax: Limit to items that are not taxes (pkgnum > 0 or feepart > 0).
131
132 - istax: Limit to items that are taxes (pkgnum == 0 and feepart = null).
133
134 - taxnum: Limit to items whose tax definition matches this taxnum.
135   With "nottax" that means items that are subject to that tax;
136   with "istax" it's the tax charges themselves.  Can be specified 
137   more than once to include multiple taxes.
138
139 - country, state, county, city: Limit to items whose tax location 
140   matches these fields.  If "nottax" it's the tax location of the package;
141   if "istax" the location of the tax.
142
143 - taxname, taxnameNULL: With "nottax", limit to items whose tax location
144   matches a tax with this name.  With "istax", limit to items that have
145   this tax name.  taxnameNULL is equivalent to "taxname = '' OR taxname 
146   = 'Tax'".
147
148 - out: With "nottax", limit to items that don't match any tax definition.
149   With "istax", find tax items that are unlinked to their tax definitions.
150   Current Freeside (> July 2012) always creates tax links, but unlinked
151   items may result from an incomplete upgrade of legacy data.
152
153 - locationtaxid: With "nottax", limit to packages matching this 
154   tax_rate_location ID; with "tax", limit to taxes generated from that 
155   location.
156
157 - taxclass: Filter on package taxclass.
158
159 - taxclassNULL: With "nottax", limit to items that would be subject to the
160   tax with taxclass = NULL.  This doesn't necessarily mean part_pkg.taxclass
161   is NULL; it also includes taxclasses that don't have a tax in this region.
162
163 - itemdesc: Limit to line items with this description.  Note that non-tax
164   packages usually have a description of NULL.  (Deprecated.)
165
166 - report_group: Can contain '=' or '!=' followed by a string to limit to 
167   line items where itemdesc starts with, or doesn't start with, the string.
168
169 - cust_tax: Limit to customers who are tax-exempt.  If "taxname" is also
170   specified, limit to customers who are also specifically exempt from that 
171   tax.
172
173 - pkg_tax: Limit to packages that are tax-exempt, and only include the 
174   exempt portion (setup, recurring, or both) when calculating totals.
175
176 - taxable: Limit to packages that are subject to tax, i.e. where a
177   cust_bill_pkg_tax_location record exists.
178
179 - credit: Limit to line items that received a credit application.  The
180   amount of the credit will also be shown.
181
182 </%doc>
183 <%init>
184
185 my $curuser = $FS::CurrentUser::CurrentUser;
186
187 die "access denied" unless $curuser->access_right('Financial reports');
188
189 my $conf = new FS::Conf;
190 my $money_char = $conf->config('money_char') || '$';
191
192 my @select = ( 'cust_bill_pkg.*', 'cust_bill._date' );
193 my @total = ( 'COUNT(*)', 'SUM(cust_bill_pkg.setup + cust_bill_pkg.recur)');
194 my @total_desc = ( $money_char.'%.2f total' ); # sprintf strings
195
196 my @peritem = ( 'setup', 'recur' );
197 my @peritem_desc = ( 'Setup charge', 'Recurring charge' );
198
199 my @pkgnum_header = ();
200 my @pkgnum = ();
201 my @pkgnum_null;
202 my $pkgnum_align = '';
203 if ( $curuser->option('show_pkgnum') ) {
204   push @select, 'cust_bill_pkg.pkgnum';
205   push @pkgnum_header, 'Pkg Num';
206   push @pkgnum, sub { $_[0]->pkgnum > 0 ? $_[0]->pkgnum : '' };
207   push @pkgnum_null, '';
208   $pkgnum_align .= 'r';
209 }
210
211 my @post_desc_header = ();
212 my @post_desc = ();
213 my @post_desc_null = ();
214 my $post_desc_align = '';
215 if ( $conf->exists('enable_taxclasses') ) {
216   push @post_desc_header, 'Tax class';
217   push @post_desc, 'taxclass';
218   push @post_desc_null, '';
219   $post_desc_align .= 'l';
220 }
221
222 # used in several places
223 my $itemdesc = 'COALESCE(part_fee.itemdesc, part_pkg.pkg, cust_bill_pkg.itemdesc)';
224
225 # valid in both the tax and non-tax cases
226 my $join_cust = 
227   " LEFT JOIN cust_bill ON (cust_bill_pkg.invnum = cust_bill.invnum)".
228   # use cust_pkg.locationnum if it exists
229   FS::UI::Web::join_cust_main('cust_bill', 'cust_pkg');
230
231 #agent virtualization
232 my $agentnums_sql =
233   $FS::CurrentUser::CurrentUser->agentnums_sql( 'table' => 'cust_main' );
234
235 my @where = ( $agentnums_sql );
236
237 # date range
238 my($beginning, $ending) = FS::UI::Web::parse_beginning_ending($cgi);
239
240 if ( $cgi->param('distribute') == 1 ) {
241   push @where, "sdate <= $ending",
242                "edate >  $beginning",
243   ;
244 } else {
245   push @where, "cust_bill._date >= $beginning",
246                "cust_bill._date <= $ending";
247 }
248
249 # status
250 if ( $cgi->param('status') =~ /^([a-z]+)$/ ) {
251   push @where, FS::cust_main->cust_status_sql . " = '$1'";
252 }
253
254 # agentnum
255 if ( $cgi->param('agentnum') =~ /^(\d+)$/ ) {
256   push @where, "cust_main.agentnum = $1";
257 }
258
259 # salesnum--see below
260 # refnum
261 if ( $cgi->param('refnum') =~ /^(\d+)$/ ) {
262   push @where, "cust_main.refnum = $1";
263 }
264
265 # cust_classnum (false laziness w/ elements/cust_main_dayranges.html, elements/cust_pay_or_refund.html, prepaid_income.html, cust_bill_pay.html, cust_bill_pkg_referral.html, unearned_detail.html, cust_credit.html, cust_credit_refund.html, cust_main::Search::search_sql)
266 if ( grep { $_ eq 'cust_classnum' } $cgi->param ) {
267   my @classnums = grep /^\d*$/, $cgi->param('cust_classnum');
268   push @where, 'COALESCE( cust_main.classnum, 0) IN ( '.
269                    join(',', map { $_ || '0' } @classnums ).
270                ' )'
271     if @classnums;
272 }
273
274
275 # custnum
276 if ( $cgi->param('custnum') =~ /^(\d+)$/ ) {
277   push @where, "cust_main.custnum = $1";
278 }
279
280 # we want the package and its definition if available
281 my $join_pkg = 
282 ' LEFT JOIN cust_pkg      USING (pkgnum) 
283   LEFT JOIN part_pkg      USING (pkgpart)
284   LEFT JOIN part_fee      USING (feepart)';
285
286 my $part_pkg = 'part_pkg';
287 # "Separate sub-packages from parents"
288 my $use_override = $cgi->param('use_override') ? 1 : 0;
289 if ( $use_override ) {
290   # still need the real part_pkg for tax applicability, 
291   # so alias this one
292   $join_pkg .= " LEFT JOIN part_pkg AS override ON (
293   COALESCE(cust_bill_pkg.pkgpart_override, cust_pkg.pkgpart, 0) = override.pkgpart
294   )";
295   $part_pkg = 'override';
296 }
297 push @select, "$part_pkg.pkgpart", "$part_pkg.pkg";
298 push @select, "COALESCE($part_pkg.taxclass, part_fee.taxclass) AS taxclass"
299   if $conf->exists('enable_taxclasses');
300
301 # the non-tax case
302 if ( $cgi->param('nottax') ) {
303
304   push @select, "($itemdesc) AS itemdesc";
305
306   push @where,
307     '(cust_bill_pkg.pkgnum > 0 OR cust_bill_pkg.feepart IS NOT NULL)';
308
309   my @tax_where; # will go into a subquery
310   my @exempt_where; # will also go into a subquery
311
312   # classnum (of override pkgpart if applicable)
313   # not specified: all classes
314   # 0: empty class
315   # N: classnum
316   if ( grep { $_ eq 'classnum' } $cgi->param ) {
317     my @classnums = grep /^\d+$/, $cgi->param('classnum');
318     push @where, "COALESCE(part_fee.classnum, $part_pkg.classnum, 0) IN ( ".
319                      join(',', @classnums ).
320                  ' )'
321       if @classnums;
322   }
323
324   if ( grep { $_ eq 'report_optionnum' } $cgi->param ) {
325     my $num = join(',', grep /^[\d,]+$/, $cgi->param('report_optionnum'));
326     my $not_num = join(',', grep /^[\d,]+$/, $cgi->param('not_report_optionnum'));
327     my $all = $cgi->param('all_report_options') ? 1 : 0;
328     push @where, # code reuse FTW
329       FS::Report::Table->with_report_option(
330         report_optionnum      => $num,
331         not_report_optionnum  => $not_num,
332         use_override          => $use_override,
333         all_report_options    => $all,
334       );
335   }
336
337   # taxclass
338   if ( $cgi->param('taxclassNULL') ) {
339     # a little different from 'taxclass' in that it applies to the
340     # effective taxclass, not the real one
341     push @tax_where, 'cust_main_county.taxclass IS NULL'
342   } elsif ( $cgi->param('taxclass') ) {
343     push @tax_where, "COALESCE(part_fee.taxclass, $part_pkg.taxclass) IN (" .
344                  join(', ', map {dbh->quote($_)} $cgi->param('taxclass') ).
345                  ')';
346   }
347
348   if ( $cgi->param('exempt_cust') eq 'Y' ) {
349     # tax-exempt customers
350     push @exempt_where, "(exempt_cust = 'Y' OR exempt_cust_taxname = 'Y')";
351
352   } elsif ( $cgi->param('exempt_pkg') eq 'Y' ) { # non-taxable package
353     # non-taxable package charges
354     push @exempt_where, "(exempt_setup = 'Y' OR exempt_recur = 'Y')";
355   }
356   # we don't handle exempt_monthly here
357   
358   if ( $cgi->param('taxname') ) { # specific taxname
359       push @tax_where, 'COALESCE(cust_main_county.taxname, \'Tax\') = '.
360                         dbh->quote($cgi->param('taxname'));
361   }
362
363   # country:state:county:city:district (may be repeated)
364   # You can also pass a big list of taxnums but that leads to huge URLs.
365   # Note that this means "packages whose tax is in this region", not 
366   # "packages in this region".  It's meant for links from the tax report.
367   if ( $cgi->param('region') ) {
368     my @orwhere;
369     foreach ( $cgi->param('region') ) {
370       my %loc;
371       @loc{qw(country state county city district)} = 
372         split(':', $cgi->param('region'));
373       my $string = join(' AND ',
374             map { 
375               if ( $loc{$_} ) {
376                 "$_ = ".dbh->quote($loc{$_});
377               } else {
378                 "$_ IS NULL";
379               }
380             } keys(%loc)
381       );
382       push @orwhere, "($string)";
383     }
384     push @tax_where, '(' . join(' OR ', @orwhere) . ')' if @orwhere;
385   }
386
387   # specific taxnums
388   if ( $cgi->param('taxnum') =~ /^([0-9,]+)$/ ) {
389     push @tax_where, "cust_main_county.taxnum IN ($1)";
390   }
391
392   # If we're showing exempt items, we need to find those with 
393   # cust_tax_exempt_pkg records matching the selected taxes.
394   # If we're showing taxable items, we need to find those with 
395   # cust_bill_pkg_tax_location records.  We also need to find the 
396   # exemption records so that we can show the taxable amount.
397   # If we're showing all items, we need the union of those.
398   # If we're showing 'out' (items that aren't region/class taxable),
399   # then we need the set of all items minus the union of those.
400
401   if ( $cgi->param('out') ) {
402     # separate from the rest, in that we're not going to join cust_main_county
403     # in the outer query
404
405     my @exclude = ( 'cust_tax_exempt_pkg.billpkgnum',
406                     'cust_bill_pkg_tax_location.taxable_billpkgnum'
407                   );
408     foreach my $col (@exclude) {
409       my ($table) = split(/\./, $col);
410       my $this_where = 'WHERE ' .  join(' AND ',
411         "$col = cust_bill_pkg.billpkgnum",
412         @tax_where
413       );
414
415       push @where,
416       "NOT EXISTS(SELECT 1 FROM $table
417         JOIN cust_main_county USING (taxnum)
418         $this_where
419       )";
420     }
421   
422   } else {
423     # everything that returns things joined to a tax definition
424
425     my $exempt_sub;
426     if ( @exempt_where or @tax_where or $cgi->param('taxable') ) {
427
428       # process exemption restrictions, including @tax_where
429       my $exempt_sub = 'SELECT SUM(amount) as exempt_amount, billpkgnum 
430       FROM cust_tax_exempt_pkg JOIN cust_main_county USING (taxnum)';
431
432       $exempt_sub .= ' WHERE '.join(' AND ', @tax_where, @exempt_where)
433         if (@tax_where or @exempt_where);
434
435       $exempt_sub .= ' GROUP BY billpkgnum';
436
437       $join_pkg .= " LEFT JOIN ($exempt_sub) AS item_exempt
438       USING (billpkgnum)";
439     }
440    
441     if ( @tax_where or $cgi->param('taxable') ) {
442       # process tax restrictions
443       unshift @tax_where,
444         'cust_main_county.tax > 0';
445
446       my $tax_sub = "SELECT invnum, cust_bill_pkg_tax_location.pkgnum
447       FROM cust_bill_pkg_tax_location
448       JOIN cust_bill_pkg AS tax_item USING (billpkgnum)
449       JOIN cust_main_county USING (taxnum)
450       WHERE ". join(' AND ', @tax_where).
451       " GROUP BY invnum, cust_bill_pkg_tax_location.pkgnum";
452
453       $join_pkg .= " LEFT JOIN ($tax_sub) AS item_tax
454       ON (item_tax.invnum = cust_bill_pkg.invnum AND
455           item_tax.pkgnum = cust_bill_pkg.pkgnum)";
456     }
457
458     # now do something with that
459     if ( @exempt_where ) {
460
461       push @where,    'item_exempt.billpkgnum IS NOT NULL';
462       push @select,   'item_exempt.exempt_amount';
463       push @peritem,  'exempt_amount';
464       push @peritem_desc, 'Exempt';
465       push @total,    'SUM(exempt_amount)';
466       push @total_desc, "$money_char%.2f tax-exempt";
467
468     } elsif ( $cgi->param('taxable') ) {
469
470       my $taxable = 'cust_bill_pkg.setup + cust_bill_pkg.recur '.
471                     '- COALESCE(item_exempt.exempt_amount, 0)';
472
473       push @where,    'item_tax.invnum IS NOT NULL';
474       push @select,   "($taxable) AS taxable_amount";
475       push @peritem,  'taxable_amount';
476       push @peritem_desc, 'Taxable';
477       push @total,    "SUM($taxable)";
478       push @total_desc, "$money_char%.2f taxable";
479
480     } elsif ( @tax_where ) {
481       # union of taxable + all exempt_ cases
482       push @where,
483         '(item_tax.invnum IS NOT NULL OR item_exempt.billpkgnum IS NOT NULL)';
484
485     }
486
487   } # handle all joins to cust_main_county
488
489   # recur/usage separation
490   if ( $cgi->param('usage') eq 'recurring' ) {
491
492     my $recur_no_usage = FS::cust_bill_pkg->charged_sql('', '', no_usage => 1);
493     push @select, "($recur_no_usage) AS recur_no_usage";
494     $peritem[1] = 'recur_no_usage';
495     $total[1] = "SUM(cust_bill_pkg.setup + $recur_no_usage)";
496     $total_desc[0] .= ' (excluding usage)';
497
498   } elsif ( $cgi->param('usage') eq 'usage' ) {
499
500     my $usage = FS::cust_bill_pkg->usage_sql();
501     push @select, "($usage) AS _usage";
502     # there's already a method named 'usage'
503     $peritem[1] = '_usage';
504     $peritem_desc[1] = 'Usage charge';
505     $total[1] = "SUM($usage)";
506     $total_desc[0] .= ' usage charges';
507   }
508
509 } elsif ( $cgi->param('istax') ) {
510
511   @peritem = ( 'setup' ); # taxes only have setup
512   @peritem_desc = ( 'Tax charge' );
513
514   push @where, 'cust_bill_pkg.pkgnum = 0';
515
516   # tax location when using tax_rate_location
517   if ( $cgi->param('vendortax') ) {
518
519     $join_pkg .= ' LEFT JOIN cust_bill_pkg_tax_rate_location USING ( billpkgnum ) '.
520                  ' LEFT JOIN tax_rate_location USING ( taxratelocationnum )';
521     foreach (qw( state county city locationtaxid)) {
522       if ( scalar($cgi->param($_)) ) {
523         my $place = dbh->quote( $cgi->param($_) );
524         push @where, "tax_rate_location.$_ = $place";
525       }
526     }
527
528     $total[1] = 'SUM(
529       COALESCE(cust_bill_pkg_tax_rate_location.amount, 
530                cust_bill_pkg.setup + cust_bill_pkg.recur)
531     )';
532
533   } else { # the internal-tax case
534
535     $join_pkg .= '
536       LEFT JOIN cust_bill_pkg_tax_location USING (billpkgnum)
537       JOIN cust_main_county           USING (taxnum)
538     ';
539
540     # don't double-count the components of consolidated taxes
541     $total[0] = 'COUNT(DISTINCT cust_bill_pkg.billpkgnum)';
542     $total[1] = 'SUM(cust_bill_pkg_tax_location.amount)';
543
544     # taxclass
545     if ( $cgi->param('taxclassNULL') ) {
546       push @where, 'cust_main_county.taxclass IS NULL';
547     }
548
549     # taxname
550     if ( $cgi->param('taxnameNULL') ) {
551       push @where, 'cust_main_county.taxname IS NULL OR '.
552                    'cust_main_county.taxname = \'Tax\'';
553     } elsif ( $cgi->param('taxname') ) {
554       push @where, 'cust_main_county.taxname = '.
555                     dbh->quote($cgi->param('taxname'));
556     }
557
558     # specific taxnums
559     if ( $cgi->param('taxnum') =~ /^([0-9,]+)$/ ) {
560       push @where, "cust_main_county.taxnum IN ($1)";
561     }
562   } # the normal case
563
564   # report group (itemdesc)
565   if ( $cgi->param('report_group') =~ /^(=|!=) (.*)$/ ) {
566     my ( $group_op, $group_value ) = ( $1, $2 );
567     if ( $group_op eq '=' ) {
568       #push @where, 'itemdesc LIKE '. dbh->quote($group_value.'%');
569       push @where, 'itemdesc = '. dbh->quote($group_value);
570     } elsif ( $group_op eq '!=' ) {
571       push @where, '( itemdesc != '. dbh->quote($group_value) .' OR itemdesc IS NULL )';
572     } else {
573       die "guru meditation #00de: group_op $group_op\n";
574     }
575   }
576
577   # itemdesc, for breakdown from the vendor tax report
578   if ( $cgi->param('itemdesc') ) {
579     if ( $cgi->param('itemdesc') eq 'Tax' ) {
580       push @where, "($itemdesc = 'Tax' OR $itemdesc is null)";
581     } else {
582       push @where, "$itemdesc = ". dbh->quote($cgi->param('itemdesc'));
583     }
584   }
585
586 } # nottax / istax
587
588
589 #total payments
590 my $pay_sub = "SELECT SUM(cust_bill_pay_pkg.amount)
591                  FROM cust_bill_pay_pkg
592                    WHERE cust_bill_pkg.billpkgnum = cust_bill_pay_pkg.billpkgnum
593               ";
594 push @select, "($pay_sub) AS pay_amount";
595
596
597 # credit
598 if ( $cgi->param('credit') ) {
599
600   my $credit_where;
601
602   my($cr_begin, $cr_end) = FS::UI::Web::parse_beginning_ending($cgi, 'credit');
603   $credit_where = "WHERE cust_credit_bill._date >= $cr_begin " .
604                   "AND cust_credit_bill._date <= $cr_end";
605
606   my $credit_sub;
607
608   if ( $cgi->param('istax') ) {
609     # then we need to group/join by billpkgtaxlocationnum, to get only the 
610     # relevant part of partial taxes
611     my $credit_sub = "SELECT SUM(cust_credit_bill_pkg.amount) AS credit_amount,
612       reason.reason as reason_text, access_user.username AS username_text,
613       billpkgtaxlocationnum, billpkgnum
614     FROM cust_credit_bill_pkg
615       JOIN cust_credit_bill USING (creditbillnum)
616       JOIN cust_credit USING (crednum)
617       LEFT JOIN reason USING (reasonnum)
618       LEFT JOIN access_user USING (usernum)
619     $credit_where
620     GROUP BY billpkgnum, billpkgtaxlocationnum, reason.reason, 
621       access_user.username";
622
623     if ( $cgi->param('out') ) {
624
625       # find credits that are applied to the line items, but not to 
626       # a cust_bill_pkg_tax_location link
627       $join_pkg .= " LEFT JOIN ($credit_sub) AS item_credit
628         USING (billpkgnum)";
629       push @where, 'item_credit.billpkgtaxlocationnum IS NULL';
630
631     } else {
632
633       # find credits that are applied to the CBPTL links that are 
634       # considered "interesting" by the report criteria
635       $join_pkg .= " LEFT JOIN ($credit_sub) AS item_credit
636         USING (billpkgtaxlocationnum)";
637
638     }
639
640   } else {
641     # then only group by billpkgnum
642     my $credit_sub = "SELECT SUM(cust_credit_bill_pkg.amount) AS credit_amount,
643       reason.reason as reason_text, access_user.username AS username_text,
644       billpkgnum
645     FROM cust_credit_bill_pkg
646       JOIN cust_credit_bill USING (creditbillnum)
647       JOIN cust_credit USING (crednum)
648       LEFT JOIN reason USING (reasonnum)
649       LEFT JOIN access_user USING (usernum)
650     $credit_where
651     GROUP BY billpkgnum, reason.reason, access_user.username";
652     $join_pkg .= " LEFT JOIN ($credit_sub) AS item_credit USING (billpkgnum)";
653   }
654
655   push @where,    'item_credit.billpkgnum IS NOT NULL';
656   push @select,   'item_credit.credit_amount',
657                   'item_credit.username_text',
658                   'item_credit.reason_text';
659   push @peritem,  'credit_amount', 'username_text', 'reason_text';
660   push @peritem_desc, 'Credited', 'By', 'Reason';
661   push @total,    'SUM(credit_amount)';
662   push @total_desc, "$money_char%.2f credited";
663
664 } else {
665
666   #still want a credit total column
667
668   my $credit_sub = "
669     SELECT SUM(cust_credit_bill_pkg.amount)
670       FROM cust_credit_bill_pkg
671         WHERE cust_bill_pkg.billpkgnum = cust_credit_bill_pkg.billpkgnum
672   ";
673   push @select, "($credit_sub) AS credit_amount";
674
675 }
676
677 push @select, 'cust_main.custnum', FS::UI::Web::cust_sql_fields();
678
679 #salesnum
680 if ( $cgi->param('salesnum') =~ /^(\d+)$/ ) {
681
682   my $salesnum = $1;
683   my $sales = FS::sales->by_key($salesnum)
684     or die "salesnum $salesnum not found";
685
686   my $subsearch = $sales->cust_bill_pkg_search('', '',
687     'cust_main_sales' => ($cgi->param('cust_main_sales') ? 1 : 0),
688     'paid'            => ($cgi->param('paid') ? 1 : 0),
689     'classnum'        => scalar($cgi->param('classnum'))
690   );
691   $join_pkg .= " JOIN sales_pkg_class ON ( COALESCE(sales_pkg_class.classnum, 0) = COALESCE( part_fee.classnum, part_pkg.classnum, 0) )";
692
693   my $extra_sql = $subsearch->{extra_sql};
694   $extra_sql =~ s/^WHERE//;
695   push @where, $extra_sql;
696
697   $cgi->param('classnum', 0) unless $cgi->param('classnum');
698 }
699
700
701 my $where = join(' AND ', @where);
702 $where &&= "WHERE $where";
703
704 my $query = {
705   'table'     => 'cust_bill_pkg',
706   'addl_from' => "$join_pkg $join_cust",
707   'hashref'   => {},
708   'select'    => join(",\n", @select ),
709   'extra_sql' => $where,
710   'order_by'  => 'ORDER BY cust_bill._date, cust_bill_pkg.billpkgnum',
711 };
712
713 my $count_query =
714   'SELECT ' . join(',', @total) .
715   " FROM cust_bill_pkg $join_pkg $join_cust
716   $where";
717
718 @peritem_desc = map {emt($_)} @peritem_desc;
719 my @peritem_sub = map {
720   my $field = $_;
721   if ($field =~ /_text$/) { # kludge for credit reason/username fields
722     sub {$_[0]->get($field)};
723   } else {
724     sub { sprintf($money_char.'%.2f', $_[0]->get($field)) }
725   }
726 } @peritem;
727 my @peritem_null = map { '' } @peritem; # placeholders
728 my $peritem_align = 'r' x scalar(@peritem);
729
730 my $ilink = [ "${p}view/cust_bill.cgi?", 'invnum' ];
731 my $clink = [ "${p}view/cust_main.cgi?", 'custnum' ];
732
733 my $pay_link    = ''; #[, 'billpkgnum', ];
734 my $credit_link = [ "${p}search/cust_credit_bill_pkg.html?billpkgnum=", 'billpkgnum', ];
735
736 warn "\n\nQUERY:\n".Dumper($query)."\n\nCOUNT_QUERY:\n$count_query\n\n"
737   if $cgi->param('debug');
738
739 </%init>