1 <& elements/search.html,
2 'title' => emt('Line items'),
3 'name' => emt('line items'),
5 'count_query' => $count_query,
6 'count_addl' => \@total_desc,
18 FS::UI::Web::cust_header(),
22 sub { $_[0]->pkgnum > 0
23 # possibly use override.pkg but i think this correct
24 ? $_[0]->get('pkgpart')
27 sub { $_[0]->pkgnum > 0
28 # possibly use override.pkg but i think this correct
30 : $_[0]->get('itemdesc')
33 #strikethrough or "N/A ($amount)" or something these when
34 # they're not applicable to pkg_tax search
38 sub { time2str('%b %d %Y', shift->_date ) },
39 sub { sprintf($money_char.'%.2f', shift->get('pay_amount')) },
40 sub { sprintf($money_char.'%.2f', shift->get('credit_amount')) },
41 \&FS::UI::Web::cust_fields,
66 ( map { $_ ne 'Cust. Status' ? $clink : '' }
67 FS::UI::Web::cust_header()
70 #'align' => 'rlrrrc'.FS::UI::Web::cust_aligns(),
71 'align' => $pkgnum_align.
77 FS::UI::Web::cust_aligns(),
89 FS::UI::Web::cust_colors(),
102 FS::UI::Web::cust_styles(),
107 Output control parameters:
108 - distribute: Boolean. If true, recurring fees will be "prorated" for the
109 portion of the package date range (sdate-edate) that falls within the date
110 range of the report. Line items will be limited to those for which this
111 portion is > 0. This disables filtering on invoice date.
113 - usage: Separate usage (cust_bill_pkg_detail records) from
114 recurring charges. If set to "usage", will show usage instead of
115 recurring charges. If set to "recurring", will deduct usage and only
116 show the flat rate charge. If not passed, the "recurring charge" column
117 will include usage charges also.
119 Filtering parameters:
120 - begin, end: Date range. Applies to invoice date, not necessarily package
121 date range. But see "distribute".
123 - status: Customer status (active, suspended, etc.). This will filter on
124 _current_ customer status, not status at the time the invoice was generated.
126 - agentnum: Filter on customer agent.
128 - refnum: Filter on customer reference source.
130 - cust_classnum: Filter on customer class.
132 - classnum: Filter on package class.
134 - report_optionnum: Filter on package report class. Can be a single report
135 class number, a comma-separated list, the word "multiple", or an empty
136 string (for "no report class").
138 - use_override: Apply "classnum" and "taxclass" filtering based on the
139 override (bundle) pkgpart, rather than always using the true pkgpart.
141 - nottax: Limit to items that are not taxes (pkgnum > 0).
143 - istax: Limit to items that are taxes (pkgnum == 0).
145 - taxnum: Limit to items whose tax definition matches this taxnum.
146 With "nottax" that means items that are subject to that tax;
147 with "istax" it's the tax charges themselves. Can be specified
148 more than once to include multiple taxes.
150 - country, state, county, city: Limit to items whose tax location
151 matches these fields. If "nottax" it's the tax location of the package;
152 if "istax" the location of the tax.
154 - taxname, taxnameNULL: With "nottax", limit to items whose tax location
155 matches a tax with this name. With "istax", limit to items that have
156 this tax name. taxnameNULL is equivalent to "taxname = '' OR taxname
159 - out: With "nottax", limit to items that don't match any tax definition.
160 With "istax", find tax items that are unlinked to their tax definitions.
161 Current Freeside (> July 2012) always creates tax links, but unlinked
162 items may result from an incomplete upgrade of legacy data.
164 - locationtaxid: With "nottax", limit to packages matching this
165 tax_rate_location ID; with "tax", limit to taxes generated from that
168 - taxclass: Filter on package taxclass.
170 - taxclassNULL: With "nottax", limit to items that would be subject to the
171 tax with taxclass = NULL. This doesn't necessarily mean part_pkg.taxclass
172 is NULL; it also includes taxclasses that don't have a tax in this region.
174 - itemdesc: Limit to line items with this description. Note that non-tax
175 packages usually have a description of NULL. (Deprecated.)
177 - report_group: Can contain '=' or '!=' followed by a string to limit to
178 line items where itemdesc starts with, or doesn't start with, the string.
180 - cust_tax: Limit to customers who are tax-exempt. If "taxname" is also
181 specified, limit to customers who are also specifically exempt from that
184 - pkg_tax: Limit to packages that are tax-exempt, and only include the
185 exempt portion (setup, recurring, or both) when calculating totals.
187 - taxable: Limit to packages that are subject to tax, i.e. where a
188 cust_bill_pkg_tax_location record exists.
190 - credit: Limit to line items that received a credit application. The
191 amount of the credit will also be shown.
196 my $curuser = $FS::CurrentUser::CurrentUser;
198 die "access denied" unless $curuser->access_right('Financial reports');
200 my $conf = new FS::Conf;
201 my $money_char = $conf->config('money_char') || '$';
203 my @select = ( 'cust_bill_pkg.*', 'cust_bill._date' );
204 my @total = ( 'COUNT(*)', 'SUM(cust_bill_pkg.setup + cust_bill_pkg.recur)');
205 my @total_desc = ( $money_char.'%.2f total' ); # sprintf strings
207 my @peritem = ( 'setup', 'recur' );
208 my @peritem_desc = ( 'Setup charge', 'Recurring charge' );
210 my @currency_desc = ();
211 my @currency_sub = ();
213 if ( $conf->config('currencies') ) {
214 @currency_desc = ( 'Setup billed', 'Recurring billed' );
218 sub { my $currency = $_[0]->get($what.'_billed_currency') or return '';
219 $currency. ' '. currency_symbol($currency, SYM_HTML).
220 $_[0]->get($what.'_billed_amount');
224 @currency = ( 'setup_billed_amount', 'recur_billed_amount' ); #for sorting
227 my @pkgnum_header = ();
230 my $pkgnum_align = '';
231 if ( $curuser->option('show_pkgnum') ) {
232 push @select, 'cust_bill_pkg.pkgnum';
233 push @pkgnum_header, 'Pkg Num';
234 push @pkgnum, sub { $_[0]->pkgnum > 0 ? $_[0]->pkgnum : '' };
235 push @pkgnum_null, '';
236 $pkgnum_align .= 'r';
239 my @post_desc_header = ();
241 my @post_desc_null = ();
242 my $post_desc_align = '';
243 if ( $conf->exists('enable_taxclasses') ) {
244 push @post_desc_header, 'Tax class';
245 push @post_desc, 'taxclass';
246 push @post_desc_null, '';
247 $post_desc_align .= 'l';
248 push @select, 'part_pkg.taxclass'; # or should this use override?
251 # valid in both the tax and non-tax cases
253 " LEFT JOIN cust_bill ON (cust_bill_pkg.invnum = cust_bill.invnum)".
254 # use cust_pkg.locationnum if it exists
255 FS::UI::Web::join_cust_main('cust_bill', 'cust_pkg');
257 #agent virtualization
259 $FS::CurrentUser::CurrentUser->agentnums_sql( 'table' => 'cust_main' );
261 my @where = ( $agentnums_sql );
264 my($beginning, $ending) = FS::UI::Web::parse_beginning_ending($cgi);
266 if ( $cgi->param('distribute') == 1 ) {
267 push @where, "sdate <= $ending",
268 "edate > $beginning",
272 push @where, "cust_bill._date >= $beginning",
273 "cust_bill._date <= $ending";
277 if ( $cgi->param('status') =~ /^([a-z]+)$/ ) {
278 push @where, FS::cust_main->cust_status_sql . " = '$1'";
282 if ( $cgi->param('agentnum') =~ /^(\d+)$/ ) {
283 push @where, "cust_main.agentnum = $1";
287 if ( $cgi->param('salesnum') =~ /^(\d+)$/ ) {
291 my $cmp_salesnum = $cgi->param('cust_main_sales')
292 ? ' COALESCE( cust_pkg.salesnum, cust_main.salesnum )'
293 : ' cust_pkg.salesnum ';
295 push @where, "$cmp_salesnum = $salesnum";
297 $cgi->param('classnum', 0) unless $cgi->param('classnum');
301 if ( $cgi->param('refnum') =~ /^(\d+)$/ ) {
302 push @where, "cust_main.refnum = $1";
305 # 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)
306 if ( grep { $_ eq 'cust_classnum' } $cgi->param ) {
307 my @classnums = grep /^\d*$/, $cgi->param('cust_classnum');
308 push @where, 'COALESCE( cust_main.classnum, 0) IN ( '.
309 join(',', map { $_ || '0' } @classnums ).
316 if ( $cgi->param('custnum') =~ /^(\d+)$/ ) {
317 push @where, "cust_main.custnum = $1";
320 # we want the package and its definition if available
322 ' LEFT JOIN cust_pkg USING (pkgnum)
323 LEFT JOIN part_pkg USING (pkgpart)';
325 my $part_pkg = 'part_pkg';
326 if ( $cgi->param('use_override') ) { #"Separate sub-packages from parents"
327 # still need the real part_pkg for tax applicability,
329 $join_pkg .= " LEFT JOIN part_pkg AS override ON (
330 COALESCE(cust_bill_pkg.pkgpart_override, cust_pkg.pkgpart, 0) = override.pkgpart
332 $part_pkg = 'override';
334 push @select, 'part_pkg.pkgpart', 'part_pkg.pkg'; # or should this use override?
337 if ( $cgi->param('nottax') ) {
339 push @where, 'cust_bill_pkg.pkgnum > 0';
341 my @tax_where; # will go into a subquery
342 my @exempt_where; # will also go into a subquery
344 # classnum (of override pkgpart if applicable)
345 # not specified: all classes
348 if ( $cgi->param('classnum') =~ /^(\d+)$/ ) {
349 push @where, "COALESCE($part_pkg.classnum, 0) = $1";
352 if ( $cgi->param('report_optionnum') =~ /^(\w+)$/ ) {
356 FS::Report::Table->with_report_option( $1, $cgi->param('use_override') )
361 if ( $cgi->param('taxclassNULL') ) {
362 # a little different from 'taxclass' in that it applies to the
363 # effective taxclass, not the real one
364 push @tax_where, 'cust_main_county.taxclass IS NULL'
365 } elsif ( $cgi->param('taxclass') ) {
366 push @tax_where, "$part_pkg.taxclass IN (" .
367 join(', ', map {dbh->quote($_)} $cgi->param('taxclass') ).
371 if ( $cgi->param('exempt_cust') eq 'Y' ) {
372 # tax-exempt customers
373 push @exempt_where, "(exempt_cust = 'Y' OR exempt_cust_taxname = 'Y')";
375 } elsif ( $cgi->param('exempt_pkg') eq 'Y' ) { # non-taxable package
376 # non-taxable package charges
377 push @exempt_where, "(exempt_setup = 'Y' OR exempt_recur = 'Y')";
379 # we don't handle exempt_monthly here
381 if ( $cgi->param('taxname') ) { # specific taxname
382 push @tax_where, 'cust_main_county.taxname = '.
383 dbh->quote($cgi->param('taxname'));
384 } elsif ( $cgi->param('taxnameNULL') ) {
385 push @tax_where, 'cust_main_county.taxname IS NULL OR '.
386 'cust_main_county.taxname = \'Tax\'';
389 # country:state:county:city:district (may be repeated)
390 # You can also pass a big list of taxnums but that leads to huge URLs.
391 # Note that this means "packages whose tax is in this region", not
392 # "packages in this region". It's meant for links from the tax report.
393 if ( $cgi->param('region') ) {
395 foreach ( $cgi->param('region') ) {
397 @loc{qw(country state county city district)} =
398 split(':', $cgi->param('region'));
399 my $string = join(' AND ',
402 "$_ = ".dbh->quote($loc{$_});
408 push @orwhere, "($string)";
410 push @tax_where, '(' . join(' OR ', @orwhere) . ')' if @orwhere;
414 if ( $cgi->param('taxnum') ) {
415 my $taxnum_in = join(',',
416 grep /^\d+$/, $cgi->param('taxnum')
418 push @tax_where, "cust_main_county.taxnum IN ($taxnum_in)"
422 # If we're showing exempt items, we need to find those with
423 # cust_tax_exempt_pkg records matching the selected taxes.
424 # If we're showing taxable items, we need to find those with
425 # cust_bill_pkg_tax_location records. We also need to find the
426 # exemption records so that we can show the taxable amount.
427 # If we're showing all items, we need the union of those.
428 # If we're showing 'out' (items that aren't region/class taxable),
429 # then we need the set of all items minus the union of those.
433 if ( @exempt_where or @tax_where
434 or $cgi->param('taxable') or $cgi->param('out') )
436 # process exemption restrictions, including @tax_where
437 my $exempt_sub = 'SELECT SUM(amount) as exempt_amount, billpkgnum
438 FROM cust_tax_exempt_pkg JOIN cust_main_county USING (taxnum)';
440 $exempt_sub .= ' WHERE '.join(' AND ', @tax_where, @exempt_where)
441 if (@tax_where or @exempt_where);
443 $exempt_sub .= ' GROUP BY billpkgnum';
445 $join_pkg .= " LEFT JOIN ($exempt_sub) AS item_exempt
449 if ( @tax_where or $cgi->param('taxable') or $cgi->param('out') ) {
450 # process tax restrictions
452 'cust_main_county.tax > 0';
454 my $tax_sub = "SELECT invnum, cust_bill_pkg_tax_location.pkgnum
455 FROM cust_bill_pkg_tax_location
456 JOIN cust_bill_pkg AS tax_item USING (billpkgnum)
457 JOIN cust_main_county USING (taxnum)
458 WHERE ". join(' AND ', @tax_where).
459 " GROUP BY invnum, cust_bill_pkg_tax_location.pkgnum";
461 $join_pkg .= " LEFT JOIN ($tax_sub) AS item_tax
462 ON (item_tax.invnum = cust_bill_pkg.invnum AND
463 item_tax.pkgnum = cust_bill_pkg.pkgnum)";
466 # now do something with that
467 if ( @exempt_where ) {
469 push @where, 'item_exempt.billpkgnum IS NOT NULL';
470 push @select, 'item_exempt.exempt_amount';
471 push @peritem, 'exempt_amount';
472 push @peritem_desc, 'Exempt';
473 push @total, 'SUM(exempt_amount)';
474 push @total_desc, "$money_char%.2f tax-exempt";
476 } elsif ( $cgi->param('taxable') ) {
478 my $taxable = 'cust_bill_pkg.setup + cust_bill_pkg.recur '.
479 '- COALESCE(item_exempt.exempt_amount, 0)';
481 push @where, 'item_tax.invnum IS NOT NULL';
482 push @select, "($taxable) AS taxable_amount";
483 push @peritem, 'taxable_amount';
484 push @peritem_desc, 'Taxable';
485 push @total, "SUM($taxable)";
486 push @total_desc, "$money_char%.2f taxable";
488 } elsif ( $cgi->param('out') ) {
490 push @where, 'item_tax.invnum IS NULL',
491 'item_exempt.billpkgnum IS NULL';
493 } elsif ( @tax_where ) {
495 # union of taxable + all exempt_ cases
497 '(item_tax.invnum IS NOT NULL OR item_exempt.billpkgnum IS NOT NULL)';
501 # recur/usage separation
502 if ( $cgi->param('usage') eq 'recurring' ) {
504 my $recur_no_usage = FS::cust_bill_pkg->charged_sql('', '', no_usage => 1);
505 push @select, "($recur_no_usage) AS recur_no_usage";
506 $peritem[1] = 'recur_no_usage';
507 $total[1] = "SUM(cust_bill_pkg.setup + $recur_no_usage)";
508 $total_desc[0] .= ' (excluding usage)';
510 } elsif ( $cgi->param('usage') eq 'usage' ) {
512 my $usage = FS::cust_bill_pkg->usage_sql();
513 push @select, "($usage) AS _usage";
514 # there's already a method named 'usage'
515 $peritem[1] = '_usage';
516 $peritem_desc[1] = 'Usage charge';
517 $total[1] = "SUM($usage)";
518 $total_desc[0] .= ' usage charges';
521 } elsif ( $cgi->param('istax') ) {
523 @peritem = ( 'setup' ); # taxes only have setup
524 @peritem_desc = ( 'Tax charge' );
526 push @where, 'cust_bill_pkg.pkgnum = 0';
528 # tax location when using tax_rate_location
529 if ( scalar( grep( /locationtaxid/, $cgi->param ) ) ) {
531 $join_pkg .= ' LEFT JOIN cust_bill_pkg_tax_rate_location USING ( billpkgnum ) '.
532 ' LEFT JOIN tax_rate_location USING ( taxratelocationnum )';
533 push @where, FS::tax_rate_location->location_sql(
534 map { $_ => (scalar($cgi->param($_)) || '') }
535 qw( district city county state locationtaxid )
539 COALESCE(cust_bill_pkg_tax_rate_location.amount,
540 cust_bill_pkg.setup + cust_bill_pkg.recur)
543 } elsif ( $cgi->param('out') ) {
546 LEFT JOIN cust_bill_pkg_tax_location USING (billpkgnum)
548 push @where, 'cust_bill_pkg_tax_location.billpkgnum IS NULL';
550 # each billpkgnum should appear only once
551 $total[0] = 'COUNT(*)';
552 $total[1] = 'SUM(cust_bill_pkg.setup)';
554 } else { # not locationtaxid or 'out'--the normal case
557 LEFT JOIN cust_bill_pkg_tax_location USING (billpkgnum)
558 JOIN cust_main_county USING (taxnum)
561 # don't double-count the components of consolidated taxes
562 $total[0] = 'COUNT(DISTINCT cust_bill_pkg.billpkgnum)';
563 $total[1] = 'SUM(cust_bill_pkg_tax_location.amount)';
567 if ( $cgi->param('taxclassNULL') ) {
568 push @where, 'cust_main_county.taxclass IS NULL';
572 if ( $cgi->param('taxnameNULL') ) {
573 push @where, 'cust_main_county.taxname IS NULL OR '.
574 'cust_main_county.taxname = \'Tax\'';
575 } elsif ( $cgi->param('taxname') ) {
576 push @where, 'cust_main_county.taxname = '.
577 dbh->quote($cgi->param('taxname'));
581 if ( $cgi->param('taxnum') ) {
582 my $taxnum_in = join(',',
583 grep /^\d+$/, $cgi->param('taxnum')
585 push @where, "cust_main_county.taxnum IN ($taxnum_in)"
589 # report group (itemdesc)
590 if ( $cgi->param('report_group') =~ /^(=|!=) (.*)$/ ) {
591 my ( $group_op, $group_value ) = ( $1, $2 );
592 if ( $group_op eq '=' ) {
593 #push @where, 'itemdesc LIKE '. dbh->quote($group_value.'%');
594 push @where, 'itemdesc = '. dbh->quote($group_value);
595 } elsif ( $group_op eq '!=' ) {
596 push @where, '( itemdesc != '. dbh->quote($group_value) .' OR itemdesc IS NULL )';
598 die "guru meditation #00de: group_op $group_op\n";
602 # itemdesc, for some reason
603 if ( $cgi->param('itemdesc') ) {
604 if ( $cgi->param('itemdesc') eq 'Tax' ) {
605 push @where, "(itemdesc='Tax' OR itemdesc is null)";
607 push @where, 'itemdesc='. dbh->quote($cgi->param('itemdesc'));
615 my $pay_sub = "SELECT SUM(cust_bill_pay_pkg.amount)
616 FROM cust_bill_pay_pkg
617 WHERE cust_bill_pkg.billpkgnum = cust_bill_pay_pkg.billpkgnum
619 push @select, "($pay_sub) AS pay_amount";
623 if ( $cgi->param('credit') ) {
627 if ( $cgi->param('istax') ) {
628 # then we need to group/join by billpkgtaxlocationnum, to get only the
629 # relevant part of partial taxes
630 my $credit_sub = "SELECT SUM(cust_credit_bill_pkg.amount) AS credit_amount,
631 reason.reason as reason_text, access_user.username AS username_text,
632 billpkgtaxlocationnum, billpkgnum
633 FROM cust_credit_bill_pkg
634 JOIN cust_credit_bill USING (creditbillnum)
635 JOIN cust_credit USING (crednum)
636 LEFT JOIN reason USING (reasonnum)
637 LEFT JOIN access_user USING (usernum)
638 GROUP BY billpkgnum, billpkgtaxlocationnum, reason.reason,
639 access_user.username";
641 if ( $cgi->param('out') ) {
643 # find credits that are applied to the line items, but not to
644 # a cust_bill_pkg_tax_location link
645 $join_pkg .= " LEFT JOIN ($credit_sub) AS item_credit
647 push @where, 'item_credit.billpkgtaxlocationnum IS NULL';
651 # find credits that are applied to the CBPTL links that are
652 # considered "interesting" by the report criteria
653 $join_pkg .= " LEFT JOIN ($credit_sub) AS item_credit
654 USING (billpkgtaxlocationnum)";
659 # then only group by billpkgnum
660 my $credit_sub = "SELECT SUM(cust_credit_bill_pkg.amount) AS credit_amount,
661 reason.reason as reason_text, access_user.username AS username_text,
663 FROM cust_credit_bill_pkg
664 JOIN cust_credit_bill USING (creditbillnum)
665 JOIN cust_credit USING (crednum)
666 LEFT JOIN reason USING (reasonnum)
667 LEFT JOIN access_user USING (usernum)
668 GROUP BY billpkgnum, reason.reason, access_user.username";
669 $join_pkg .= " LEFT JOIN ($credit_sub) AS item_credit USING (billpkgnum)";
672 push @where, 'item_credit.billpkgnum IS NOT NULL';
673 push @select, 'item_credit.credit_amount',
674 'item_credit.username_text',
675 'item_credit.reason_text';
676 push @peritem, 'credit_amount', 'username_text', 'reason_text';
677 push @peritem_desc, 'Credited', 'By', 'Reason';
678 push @total, 'SUM(credit_amount)';
679 push @total_desc, "$money_char%.2f credited";
683 #still want a credit total column
686 SELECT SUM(cust_credit_bill_pkg.amount)
687 FROM cust_credit_bill_pkg
688 WHERE cust_bill_pkg.billpkgnum = cust_credit_bill_pkg.billpkgnum
690 push @select, "($credit_sub) AS credit_amount";
694 push @select, 'cust_main.custnum', FS::UI::Web::cust_sql_fields();
696 my $where = join(' AND ', @where);
697 $where &&= "WHERE $where";
700 'table' => 'cust_bill_pkg',
701 'addl_from' => "$join_pkg $join_cust",
703 'select' => join(",\n", @select ),
704 'extra_sql' => $where,
705 'order_by' => 'ORDER BY cust_bill._date, cust_bill_pkg.billpkgnum',
709 'SELECT ' . join(',', @total) .
710 " FROM cust_bill_pkg $join_pkg $join_cust
713 @peritem_desc = map {emt($_)} @peritem_desc;
714 my @peritem_sub = map {
716 if ($field =~ /_text$/) { # kludge for credit reason/username fields
717 sub {$_[0]->get($field)};
719 sub { sprintf($money_char.'%.2f', $_[0]->get($field)) }
722 my @peritem_null = map { '' } @peritem; # placeholders
723 my $peritem_align = 'r' x scalar(@peritem);
725 @currency_desc = map {emt($_)} @currency_desc;
726 my @currency_null = map { '' } @currency; # placeholders
727 my $currency_align = 'r' x scalar(@currency);
729 my $ilink = [ "${p}view/cust_bill.cgi?", 'invnum' ];
730 my $clink = [ "${p}view/cust_main.cgi?", 'custnum' ];
732 my $pay_link = ''; #[, 'billpkgnum', ];
733 my $credit_link = [ "${p}search/cust_credit_bill_pkg.html?billpkgnum=", 'billpkgnum', ];
735 warn "\n\nQUERY:\n".Dumper($query)."\n\nCOUNT_QUERY:\n$count_query\n\n"
736 if $cgi->param('debug');