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 ? $_[0]->get('pkgpart')
26 sub { $_[0]->pkgnum > 0
28 : $_[0]->get('itemdesc')
31 #strikethrough or "N/A ($amount)" or something these when
32 # they're not applicable to pkg_tax search
36 sub { time2str('%b %d %Y', shift->_date ) },
37 sub { sprintf($money_char.'%.2f', shift->get('pay_amount')) },
38 sub { sprintf($money_char.'%.2f', shift->get('credit_amount')) },
39 \&FS::UI::Web::cust_fields,
52 FS::UI::Web::cust_sort_fields(),
65 ( map { $_ ne 'Cust. Status' ? $clink : '' }
66 FS::UI::Web::cust_header()
69 #'align' => 'rlrrrc'.FS::UI::Web::cust_aligns(),
70 'align' => $pkgnum_align.
76 FS::UI::Web::cust_aligns(),
88 FS::UI::Web::cust_colors(),
101 FS::UI::Web::cust_styles(),
106 Output control parameters:
107 - distribute: Boolean. If true, recurring fees will be "prorated" for the
108 portion of the package date range (sdate-edate) that falls within the date
109 range of the report. Line items will be limited to those for which this
110 portion is > 0. This disables filtering on invoice date.
112 - usage: Separate usage (cust_bill_pkg_detail records) from
113 recurring charges. If set to "usage", will show usage instead of
114 recurring charges. If set to "recurring", will deduct usage and only
115 show the flat rate charge. If not passed, the "recurring charge" column
116 will include usage charges also.
118 Filtering parameters:
119 - begin, end: Date range. Applies to invoice date, not necessarily package
120 date range. But see "distribute".
122 - status: Customer status (active, suspended, etc.). This will filter on
123 _current_ customer status, not status at the time the invoice was generated.
125 - agentnum: Filter on customer agent.
127 - refnum: Filter on customer reference source.
129 - cust_classnum: Filter on customer class.
131 - classnum: Filter on package class.
133 - report_optionnum: Filter on package report class. Can be a single report
134 class number or a comma-separated list (where 0 is "no report class"), or the
137 - use_override: Apply "classnum" and "taxclass" filtering based on the
138 override (bundle) pkgpart, rather than always using the true pkgpart.
140 - nottax: Limit to items that are not taxes (pkgnum > 0 or feepart > 0).
142 - istax: Limit to items that are taxes (pkgnum == 0 and feepart = null).
144 - taxnum: Limit to items whose tax definition matches this taxnum.
145 With "nottax" that means items that are subject to that tax;
146 with "istax" it's the tax charges themselves. Can be a comma-separated
147 list to include multiple taxes.
149 - country, state, county, city: Limit to items whose tax location
150 matches these fields. If "nottax" it's the tax location of the package;
151 if "istax" the location of the tax.
153 - taxname, taxnameNULL: With "nottax", limit to items whose tax location
154 matches a tax with this name. With "istax", limit to items that have
155 this tax name. taxnameNULL is equivalent to "taxname = '' OR taxname
158 - out: With "nottax", limit to items that don't match any tax definition.
159 With "istax", find tax items that are unlinked to their tax definitions.
160 Current Freeside (> July 2012) always creates tax links, but unlinked
161 items may result from an incomplete upgrade of legacy data.
163 - locationtaxid: With "nottax", limit to packages matching this
164 tax_rate_location ID; with "tax", limit to taxes generated from that
167 - taxclass: Filter on package taxclass.
169 - taxclassNULL: With "nottax", limit to items that would be subject to the
170 tax with taxclass = NULL. This doesn't necessarily mean part_pkg.taxclass
171 is NULL; it also includes taxclasses that don't have a tax in this region.
173 - itemdesc: Limit to line items with this description. Note that non-tax
174 packages usually have a description of NULL. (Deprecated.)
176 - report_group: Can contain '=' or '!=' followed by a string to limit to
177 line items where itemdesc starts with, or doesn't start with, the string.
179 - cust_tax: Limit to customers who are tax-exempt. If "taxname" is also
180 specified, limit to customers who are also specifically exempt from that
183 - pkg_tax: Limit to packages that are tax-exempt, and only include the
184 exempt portion (setup, recurring, or both) when calculating totals.
186 - taxable: Limit to packages that are subject to tax, i.e. where a
187 cust_bill_pkg_tax_location record exists.
189 - credit: Limit to line items that received a credit application. The
190 amount of the credit will also be shown.
195 my $curuser = $FS::CurrentUser::CurrentUser;
197 die "access denied" unless $curuser->access_right('Financial reports');
199 my $conf = new FS::Conf;
200 my $money_char = $conf->config('money_char') || '$';
202 my @select = ( 'cust_bill_pkg.*', 'cust_bill._date' );
203 my @total = ( 'COUNT(*)', 'SUM(cust_bill_pkg.setup + cust_bill_pkg.recur)');
204 my @total_desc = ( $money_char.'%.2f total' ); # sprintf strings
206 my @peritem = ( 'setup', 'recur' );
207 my @peritem_desc = ( 'Setup charge', 'Recurring charge' );
209 my @currency_desc = ();
210 my @currency_sub = ();
212 if ( $conf->config('currencies') ) {
213 @currency_desc = ( 'Setup billed', 'Recurring billed' );
217 sub { my $currency = $_[0]->get($what.'_billed_currency') or return '';
218 $currency. ' '. currency_symbol($currency, SYM_HTML).
219 $_[0]->get($what.'_billed_amount');
223 @currency = ( 'setup_billed_amount', 'recur_billed_amount' ); #for sorting
226 my @pkgnum_header = ();
229 my $pkgnum_align = '';
230 if ( $curuser->option('show_pkgnum') ) {
231 push @select, 'cust_bill_pkg.pkgnum';
232 push @pkgnum_header, 'Pkg Num';
233 push @pkgnum, sub { $_[0]->pkgnum > 0 ? $_[0]->pkgnum : '' };
234 push @pkgnum_null, '';
235 $pkgnum_align .= 'r';
238 my @post_desc_header = ();
240 my @post_desc_null = ();
241 my $post_desc_align = '';
242 if ( $conf->exists('enable_taxclasses') ) {
243 push @post_desc_header, 'Tax class';
244 push @post_desc, 'taxclass';
245 push @post_desc_null, '';
246 $post_desc_align .= 'l';
249 # valid in both the tax and non-tax cases
251 " LEFT JOIN cust_bill ON (cust_bill_pkg.invnum = cust_bill.invnum)".
252 # use cust_pkg.locationnum if it exists
253 FS::UI::Web::join_cust_main('cust_bill', 'cust_pkg');
255 #agent virtualization
257 $FS::CurrentUser::CurrentUser->agentnums_sql( 'table' => 'cust_main' );
259 my @where = ( $agentnums_sql );
262 my($beginning, $ending) = FS::UI::Web::parse_beginning_ending($cgi);
264 if ( $cgi->param('distribute') == 1 ) {
265 push @where, "sdate <= $ending",
266 "edate > $beginning",
270 push @where, "cust_bill._date >= $beginning",
271 "cust_bill._date <= $ending";
275 if ( $cgi->param('status') =~ /^([a-z]+)$/ ) {
276 push @where, FS::cust_main->cust_status_sql . " = '$1'";
280 if ( $cgi->param('agentnum') =~ /^(\d+)$/ ) {
281 push @where, "cust_main.agentnum = $1";
284 # salesnum--see below
286 if ( $cgi->param('refnum') =~ /^(\d+)$/ ) {
287 push @where, "cust_main.refnum = $1";
290 # 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)
291 if ( grep { $_ eq 'cust_classnum' } $cgi->param ) {
292 my @classnums = grep /^\d*$/, $cgi->param('cust_classnum');
293 push @where, 'COALESCE( cust_main.classnum, 0) IN ( '.
294 join(',', map { $_ || '0' } @classnums ).
301 if ( $cgi->param('custnum') =~ /^(\d+)$/ ) {
302 push @where, "cust_main.custnum = $1";
305 # we want the package and its definition if available
307 ' LEFT JOIN cust_pkg USING (pkgnum)
308 LEFT JOIN part_pkg USING (pkgpart)
309 LEFT JOIN part_fee USING (feepart)';
311 my $part_pkg = 'part_pkg';
312 # "Separate sub-packages from parents"
313 my $use_override = $cgi->param('use_override') ? 1 : 0;
314 if ( $use_override ) {
315 # still need the real part_pkg for tax applicability,
317 $join_pkg .= " LEFT JOIN part_pkg AS override ON (
318 COALESCE(cust_bill_pkg.pkgpart_override, cust_pkg.pkgpart, 0) = override.pkgpart
320 $part_pkg = 'override';
322 push @select, "$part_pkg.pkgpart", "$part_pkg.pkg";
323 push @select, "COALESCE($part_pkg.taxclass, part_fee.taxclass) AS taxclass"
324 if $conf->exists('enable_taxclasses');
327 if ( $cgi->param('nottax') ) {
329 push @select, "part_fee.itemdesc";
332 '(cust_bill_pkg.pkgnum > 0 OR cust_bill_pkg.feepart IS NOT NULL)';
334 my @tax_where; # will go into a subquery
335 my @exempt_where; # will also go into a subquery
337 # classnum (of override pkgpart if applicable)
338 # not specified: all classes
341 if ( grep { $_ eq 'classnum' } $cgi->param ) {
342 my @classnums = grep /^\d*$/, $cgi->param('classnum');
343 push @where, "COALESCE(part_fee.classnum, $part_pkg.classnum, 0) IN ( ".
344 join(',', @classnums ).
349 if ( grep { $_ eq 'report_optionnum' } $cgi->param ) {
350 my $num = join(',', grep /^[\d,]+$/, $cgi->param('report_optionnum'));
351 my $not_num = join(',', grep /^[\d,]+$/, $cgi->param('not_report_optionnum'));
352 my $all = $cgi->param('all_report_options') ? 1 : 0;
353 push @where, # code reuse FTW
354 FS::Report::Table->with_report_option(
355 report_optionnum => $num,
356 not_report_optionnum => $not_num,
357 use_override => $use_override,
358 all_report_options => $all,
363 if ( $cgi->param('taxclassNULL') ) {
364 # a little different from 'taxclass' in that it applies to the
365 # effective taxclass, not the real one
366 push @tax_where, 'cust_main_county.taxclass IS NULL'
367 } elsif ( $cgi->param('taxclass') ) {
368 push @tax_where, "COALESCE(part_fee.taxclass, $part_pkg.taxclass) IN (" .
369 join(', ', map {dbh->quote($_)} $cgi->param('taxclass') ).
373 if ( $cgi->param('exempt_cust') eq 'Y' ) {
374 # tax-exempt customers
375 push @exempt_where, "(exempt_cust = 'Y' OR exempt_cust_taxname = 'Y')";
377 } elsif ( $cgi->param('exempt_pkg') eq 'Y' ) { # non-taxable package
378 # non-taxable package charges
379 push @exempt_where, "(exempt_setup = 'Y' OR exempt_recur = 'Y')";
381 # we don't handle exempt_monthly here
383 if ( $cgi->param('taxname') ) { # specific taxname
384 push @tax_where, "COALESCE(cust_main_county.taxname, 'Tax') = ".
385 dbh->quote($cgi->param('taxname'));
388 # country:state:county:city:district (may be repeated)
389 # You can also pass a big list of taxnums but that leads to huge URLs.
390 # Note that this means "packages whose tax is in this region", not
391 # "packages in this region". It's meant for links from the tax report.
392 if ( $cgi->param('region') ) {
394 foreach ( $cgi->param('region') ) {
396 @loc{qw(country state county city district)} =
397 split(':', $cgi->param('region'));
398 my $string = join(' AND ',
401 "$_ = ".dbh->quote($loc{$_});
407 push @orwhere, "($string)";
409 push @tax_where, '(' . join(' OR ', @orwhere) . ')' if @orwhere;
413 if ( $cgi->param('taxnum') =~ /^([\d,]+)$/) {
414 push @tax_where, "cust_main_county.taxnum IN ($1)";
417 # If we're showing exempt items, we need to find those with
418 # cust_tax_exempt_pkg records matching the selected taxes.
419 # If we're showing taxable items, we need to find those with
420 # cust_bill_pkg_tax_location records. We also need to find the
421 # exemption records so that we can show the taxable amount.
422 # If we're showing all items, we need the union of those.
423 # If we're showing 'out' (items that aren't region/class taxable),
424 # then we need the set of all items minus the union of those.
428 if ( @exempt_where or @tax_where
429 or $cgi->param('taxable') or $cgi->param('out') )
431 # process exemption restrictions, including @tax_where
432 my $exempt_sub = 'SELECT SUM(amount) as exempt_amount, billpkgnum
433 FROM cust_tax_exempt_pkg JOIN cust_main_county USING (taxnum)';
435 $exempt_sub .= ' WHERE '.join(' AND ', @tax_where, @exempt_where)
436 if (@tax_where or @exempt_where);
438 $exempt_sub .= ' GROUP BY billpkgnum';
440 $join_pkg .= " LEFT JOIN ($exempt_sub) AS item_exempt
443 # process tax restrictions
445 'cust_bill_pkg_tax_location.taxable_billpkgnum = cust_bill_pkg.billpkgnum',
446 'cust_main_county.tax > 0';
449 my $tax_sub = "SELECT 1
450 FROM cust_bill_pkg_tax_location
451 JOIN cust_bill_pkg AS tax_item USING (billpkgnum)
452 JOIN cust_main_county USING (taxnum)
453 WHERE ". join(' AND ', @tax_where);
455 # now do something with that
456 if ( @exempt_where ) {
458 push @where, 'item_exempt.billpkgnum IS NOT NULL';
459 push @select, 'item_exempt.exempt_amount';
460 push @peritem, 'exempt_amount';
461 push @peritem_desc, 'Exempt';
462 push @total, 'SUM(exempt_amount)';
463 push @total_desc, "$money_char%.2f tax-exempt";
465 } elsif ( $cgi->param('taxable') ) {
467 my $taxable = 'cust_bill_pkg.setup + cust_bill_pkg.recur '.
468 '- COALESCE(item_exempt.exempt_amount, 0)';
470 push @select, "($taxable) AS taxable_amount";
471 push @where, "EXISTS($tax_sub)";
472 push @peritem, 'taxable_amount';
473 push @peritem_desc, 'Taxable';
474 push @total, "SUM($taxable)";
475 push @total_desc, "$money_char%.2f taxable";
477 } elsif ( @tax_where ) {
479 # union of taxable + all exempt_ cases
480 push @where, "(EXISTS($tax_sub) OR item_exempt.billpkgnum IS NOT NULL)";
484 # recur/usage separation
485 if ( $cgi->param('usage') eq 'recurring' ) {
487 my $recur_no_usage = FS::cust_bill_pkg->charged_sql('', '', no_usage => 1);
488 push @select, "($recur_no_usage) AS recur_no_usage";
489 $peritem[1] = 'recur_no_usage';
490 $total[1] = "SUM(cust_bill_pkg.setup + $recur_no_usage)";
491 $total_desc[0] .= ' (excluding usage)';
493 } elsif ( $cgi->param('usage') eq 'usage' ) {
495 my $usage = FS::cust_bill_pkg->usage_sql();
496 push @select, "($usage) AS _usage";
497 # there's already a method named 'usage'
498 $peritem[1] = '_usage';
499 $peritem_desc[1] = 'Usage charge';
500 $total[1] = "SUM($usage)";
501 $total_desc[0] .= ' usage charges';
504 } elsif ( $cgi->param('istax') ) {
506 @peritem = ( 'setup' ); # taxes only have setup
507 @peritem_desc = ( 'Tax charge' );
509 push @where, 'cust_bill_pkg.pkgnum = 0';
511 # tax location when using tax_rate_location
512 if ( scalar( grep( /locationtaxid/, $cgi->param ) ) ) {
514 $join_pkg .= ' LEFT JOIN cust_bill_pkg_tax_rate_location USING ( billpkgnum ) '.
515 ' LEFT JOIN tax_rate_location USING ( taxratelocationnum )';
516 push @where, FS::tax_rate_location->location_sql(
517 map { $_ => (scalar($cgi->param($_)) || '') }
518 qw( district city county state locationtaxid )
522 COALESCE(cust_bill_pkg_tax_rate_location.amount,
523 cust_bill_pkg.setup + cust_bill_pkg.recur)
526 } elsif ( $cgi->param('out') ) {
529 LEFT JOIN cust_bill_pkg_tax_location USING (billpkgnum)
531 push @where, 'cust_bill_pkg_tax_location.billpkgnum IS NULL';
533 # each billpkgnum should appear only once
534 $total[0] = 'COUNT(*)';
535 $total[1] = 'SUM(cust_bill_pkg.setup)';
537 } else { # not locationtaxid or 'out'--the normal case
540 LEFT JOIN cust_bill_pkg_tax_location USING (billpkgnum)
541 JOIN cust_main_county USING (taxnum)
544 # don't double-count the components of consolidated taxes
545 $total[0] = 'COUNT(DISTINCT cust_bill_pkg.billpkgnum)';
546 $total[1] = 'SUM(cust_bill_pkg_tax_location.amount)';
549 if ( grep { $_ eq 'classnum' } $cgi->param ) {
550 my @classnums = grep /^\d*$/, $cgi->param('classnum');
552 JOIN cust_pkg AS taxed_pkg
553 ON (cust_bill_pkg_tax_location.pkgnum = taxed_pkg.pkgnum)
554 JOIN part_pkg AS taxed_part_pkg
555 ON (taxed_pkg.pkgpart = taxed_part_pkg.pkgpart)
557 push @where, "COALESCE(taxed_part_pkg.classnum, 0) IN ( ".
558 join(',', @classnums ).
565 if ( $cgi->param('taxclassNULL') ) {
566 push @where, 'cust_main_county.taxclass IS NULL';
570 if ( $cgi->param('taxnameNULL') ) {
571 push @where, 'cust_main_county.taxname IS NULL OR '.
572 'cust_main_county.taxname = \'Tax\'';
573 } elsif ( $cgi->param('taxname') ) {
574 push @where, 'cust_main_county.taxname = '.
575 dbh->quote($cgi->param('taxname'));
579 if ( $cgi->param('taxnum') =~ /^([\d,]+)$/) {
580 push @where, "cust_main_county.taxnum IN ($1)";
583 # itemdesc, for some reason
584 if ( $cgi->param('itemdesc') ) {
585 if ( $cgi->param('itemdesc') eq 'Tax' ) {
586 push @where, "(itemdesc='Tax' OR itemdesc is null)";
588 push @where, 'itemdesc='. dbh->quote($cgi->param('itemdesc'));
596 my $pay_sub = "SELECT SUM(cust_bill_pay_pkg.amount)
597 FROM cust_bill_pay_pkg
598 WHERE cust_bill_pkg.billpkgnum = cust_bill_pay_pkg.billpkgnum
600 push @select, "($pay_sub) AS pay_amount";
604 if ( $cgi->param('credit') ) {
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 GROUP BY billpkgnum, billpkgtaxlocationnum, reason.reason,
620 access_user.username";
622 if ( $cgi->param('out') ) {
624 # find credits that are applied to the line items, but not to
625 # a cust_bill_pkg_tax_location link
626 $join_pkg .= " LEFT JOIN ($credit_sub) AS item_credit
628 push @where, 'item_credit.billpkgtaxlocationnum IS NULL';
632 # find credits that are applied to the CBPTL links that are
633 # considered "interesting" by the report criteria
634 $join_pkg .= " LEFT JOIN ($credit_sub) AS item_credit
635 USING (billpkgtaxlocationnum)";
640 # then only group by billpkgnum
641 my $credit_sub = "SELECT SUM(cust_credit_bill_pkg.amount) AS credit_amount,
642 reason.reason as reason_text, access_user.username AS username_text,
644 FROM cust_credit_bill_pkg
645 JOIN cust_credit_bill USING (creditbillnum)
646 JOIN cust_credit USING (crednum)
647 LEFT JOIN reason USING (reasonnum)
648 LEFT JOIN access_user USING (usernum)
649 GROUP BY billpkgnum, reason.reason, access_user.username";
650 $join_pkg .= " LEFT JOIN ($credit_sub) AS item_credit USING (billpkgnum)";
653 push @where, 'item_credit.billpkgnum IS NOT NULL';
654 push @select, 'item_credit.credit_amount',
655 'item_credit.username_text',
656 'item_credit.reason_text';
657 push @peritem, 'credit_amount', 'username_text', 'reason_text';
658 push @peritem_desc, 'Credited', 'By', 'Reason';
659 push @total, 'SUM(credit_amount)';
660 push @total_desc, "$money_char%.2f credited";
664 #still want a credit total column
667 SELECT SUM(cust_credit_bill_pkg.amount)
668 FROM cust_credit_bill_pkg
669 WHERE cust_bill_pkg.billpkgnum = cust_credit_bill_pkg.billpkgnum
671 push @select, "($credit_sub) AS credit_amount";
675 push @select, 'cust_main.custnum', FS::UI::Web::cust_sql_fields();
678 if ( $cgi->param('salesnum') =~ /^(\d+)$/ ) {
681 my $sales = FS::sales->by_key($salesnum)
682 or die "salesnum $salesnum not found";
684 my $subsearch = $sales->cust_bill_pkg_search('', '',
685 'cust_main_sales' => ($cgi->param('cust_main_sales') ? 1 : 0),
686 'paid' => ($cgi->param('paid') ? 1 : 0),
687 'classnum' => scalar($cgi->param('classnum'))
689 $join_pkg .= " JOIN sales_pkg_class ON ( COALESCE(sales_pkg_class.classnum, 0) = COALESCE( part_fee.classnum, part_pkg.classnum, 0) )";
691 my $extra_sql = $subsearch->{extra_sql};
692 $extra_sql =~ s/^WHERE//;
693 push @where, $extra_sql;
695 $cgi->param('classnum', 0) unless $cgi->param('classnum');
699 my $where = join(' AND ', @where);
700 $where &&= "WHERE $where";
703 'table' => 'cust_bill_pkg',
704 'addl_from' => "$join_pkg $join_cust",
706 'select' => join(",\n", @select ),
707 'extra_sql' => $where,
708 'order_by' => 'ORDER BY cust_bill._date, cust_bill_pkg.billpkgnum',
712 'SELECT ' . join(',', @total) .
713 " FROM cust_bill_pkg $join_pkg $join_cust
716 @peritem_desc = map {emt($_)} @peritem_desc;
717 my @peritem_sub = map {
719 if ($field =~ /_text$/) { # kludge for credit reason/username fields
720 sub {$_[0]->get($field)};
722 sub { sprintf($money_char.'%.2f', $_[0]->get($field)) }
725 my @peritem_null = map { '' } @peritem; # placeholders
726 my $peritem_align = 'r' x scalar(@peritem);
728 @currency_desc = map {emt($_)} @currency_desc;
729 my @currency_null = map { '' } @currency; # placeholders
730 my $currency_align = 'r' x scalar(@currency);
732 my $ilink = [ "${p}view/cust_bill.cgi?", 'invnum' ];
733 my $clink = [ "${p}view/cust_main.cgi?", 'custnum' ];
735 my $pay_link = ''; #[, 'billpkgnum', ];
736 my $credit_link = [ "${p}search/cust_credit_bill_pkg.html?billpkgnum=", 'billpkgnum', ];
738 warn "\n\nQUERY:\n".Dumper($query)."\n\nCOUNT_QUERY:\n$count_query\n\n"
739 if $cgi->param('debug');