range of the report. Line items will be limited to those for which this
portion is > 0. This disables filtering on invoice date.
-- usage: Separate usage (cust_bill_pkg_detail records) from
- recurring charges. If set to "usage", will show usage instead of
- recurring charges. If set to "recurring", will deduct usage and only
- show the flat rate charge. If not passed, the "recurring charge" column
- will include usage charges also.
+- charges: 'S'etup, 'R'ecur, 'U'sage, or any string combination of those.
Filtering parameters:
- begin, end: Date range. Applies to invoice date, not necessarily package
my $money_char = $conf->config('money_char') || '$';
my @select = ( 'cust_bill_pkg.*', 'cust_bill._date' );
-my @total = ( 'COUNT(*)', 'SUM(cust_bill_pkg.setup + cust_bill_pkg.recur)');
-my @total_desc = ( $money_char.'%.2f total' ); # sprintf strings
+my @total = ( 'COUNT(*)' );
+my @total_desc = ();
my @peritem = ( 'setup', 'recur' );
-my @peritem_desc = ( 'Setup charge', 'Recurring charge' );
+my @peritem_desc = ( 'Setup charges', 'Recurring charges' );
my @currency_desc = ();
my @currency_sub = ();
}
# used in several places
-my $itemdesc = 'COALESCE(part_fee.itemdesc, part_pkg.pkg, cust_bill_pkg.itemdesc)';
+my $itemdesc = 'COALESCE(cust_bill_pkg.itemdesc, part_fee.itemdesc, part_pkg.pkg, cust_bill_pkg.itemdesc)';
# valid in both the tax and non-tax cases
my $join_cust =
$part_pkg = 'override';
}
push @select, "$part_pkg.pkgpart", "$part_pkg.pkg";
+push @select, "($itemdesc) AS itemdesc"; # available in all report modes
+
push @select, "COALESCE($part_pkg.taxclass, part_fee.taxclass) AS taxclass"
if $conf->exists('enable_taxclasses');
# the non-tax case
if ( $cgi->param('nottax') ) {
- push @select, "($itemdesc) AS itemdesc";
-
push @where,
'(cust_bill_pkg.pkgnum > 0 OR cust_bill_pkg.feepart IS NOT NULL)';
# If we're showing 'out' (items that aren't region/class taxable),
# then we need the set of all items minus the union of those.
+ # Always exclude cust_tax_exempt_pkg records with non-NULL creditbillpkgnum.
+
if ( $cgi->param('out') ) {
# separate from the rest, in that we're not going to join cust_main_county
# in the outer query
} else {
# everything that returns things joined to a tax definition
- my $exempt_sub;
+ if ( @exempt_where or @tax_where or $cgi->param('taxable') ) {
- # process exemption restrictions, including @tax_where
- my $exempt_sub = 'SELECT SUM(amount) as exempt_amount, billpkgnum
- FROM cust_tax_exempt_pkg JOIN cust_main_county USING (taxnum)';
+ push @exempt_where, "cust_tax_exempt_pkg.creditbillpkgnum IS NULL";
- $exempt_sub .= ' WHERE '.join(' AND ', @tax_where, @exempt_where)
- if (@tax_where or @exempt_where);
+ # process exemption restrictions, including @tax_where
+ my $exempt_sub = 'SELECT SUM(amount) as exempt_amount, billpkgnum
+ FROM cust_tax_exempt_pkg JOIN cust_main_county USING (taxnum)';
- $exempt_sub .= ' GROUP BY billpkgnum';
+ $exempt_sub .= ' WHERE '.join(' AND ', @tax_where, @exempt_where);
- $join_pkg .= " LEFT JOIN ($exempt_sub) AS item_exempt
- ON (cust_bill_pkg.billpkgnum = item_exempt.billpkgnum)";
+ $exempt_sub .= ' GROUP BY billpkgnum';
+
+ $join_pkg .= " LEFT JOIN ($exempt_sub) AS item_exempt
+ ON (cust_bill_pkg.billpkgnum = item_exempt.billpkgnum)";
+
+ }
my $credit_sub = 'SELECT SUM(amount) AS credit_amount, billpkgnum
FROM cust_credit_bill_pkg GROUP BY billpkgnum';
unshift @tax_where,
'cust_main_county.tax > 0';
- my $tax_sub = "SELECT taxable_billpkgnum AS billpkgnum
+ my $tax_sub = "SELECT taxable_billpkgnum
FROM cust_bill_pkg_tax_location
JOIN cust_main_county USING (taxnum)
WHERE ". join(' AND ', @tax_where).
" GROUP BY taxable_billpkgnum";
$join_pkg .= " LEFT JOIN ($tax_sub) AS item_tax
- ON (cust_bill_pkg.billpkgnum = item_tax.billpkgnum)"
+ ON (cust_bill_pkg.billpkgnum = item_tax.taxable_billpkgnum)"
}
# now do something with that
- if ( @exempt_where ) {
+ if ( $cgi->param('taxable') ) {
+ # taxable query: needs sale amount - exempt amount
+ my $taxable = 'cust_bill_pkg.setup + cust_bill_pkg.recur '.
+ '- COALESCE(item_exempt.exempt_amount, 0)';
+
+ push @where, "item_tax.taxable_billpkgnum IS NOT NULL";
+ push @select, "($taxable) AS taxable_amount";
+ push @peritem, 'taxable_amount';
+ push @peritem_desc, 'Taxable';
+ push @total, "SUM($taxable)";
+ push @total_desc, "$money_char%.2f taxable";
+
+ } elsif ( $cgi->param('exempt_cust') or $cgi->param('exempt_pkg') ) {
push @where, 'item_exempt.billpkgnum IS NOT NULL';
push @select, 'item_exempt.exempt_amount';
push @total, 'SUM(exempt_amount)';
push @total_desc, "$money_char%.2f tax-exempt";
- } elsif ( @tax_where or $cgi->param('taxable') ) {
+ } elsif ( @tax_where ) {
+ # union of taxable + all exempt_ cases
+ push @where,
+ '(item_tax.taxable_billpkgnum IS NOT NULL OR item_exempt.billpkgnum IS NOT NULL)';
- my $taxable = 'cust_bill_pkg.setup + cust_bill_pkg.recur '.
- '- COALESCE(item_exempt.exempt_amount, 0) '.
- '- COALESCE(item_credit.credit_amount, 0)';
+ }
- push @where, "(item_tax.billpkgnum IS NOT NULL OR item_exempt.billpkgnum IS NOT NULL)";
- push @select, "($taxable) AS taxable_amount";
- push @peritem, 'taxable_amount';
- push @peritem_desc, 'Taxable';
+ } # handle all joins to cust_main_county
- if ( $cgi->param('taxable') ) {
- push @where, "($taxable) > 0";
- } else {
- push @total, 'SUM('.
- 'cust_bill_pkg.setup + cust_bill_pkg.recur '.
- '- COALESCE(item_credit.credit_amount, 0) )';
- push @total_desc, "$money_char%.2f net sales";
- }
+ # setup/recur/usage separation
+ my %charges = map { $_ => 1 } split('', $cgi->param('charges') || 'SRU');
- push @total, "SUM($taxable)";
- push @total_desc, "$money_char%.2f taxable";
- }
+ if ( $charges{S} and $charges{R} and $charges{U} ) {
+ # in this case, show discounts
- } # handle all joins to cust_main_county
+ $join_pkg .= ' JOIN (
+ SELECT billpkgnum, COALESCE(SUM(amount), 0) AS discounted
+ FROM cust_bill_pkg_discount RIGHT JOIN cust_bill_pkg USING (billpkgnum)
+ GROUP BY billpkgnum
+ ) AS _discount ON (cust_bill_pkg.billpkgnum = _discount.billpkgnum)
+ ';
+ push @select, '_discount.discounted';
+
+ push @peritem, 'discounted';
+ push @peritem_desc, 'Discount';
+ push @total, 'SUM(cust_bill_pkg.setup + cust_bill_pkg.recur + discounted)',
+ 'SUM(discounted)',
+ 'SUM(cust_bill_pkg.setup + cust_bill_pkg.recur)';
+ push @total_desc, "$money_char%.2f gross sales",
+ "− $money_char%.2f discounted",
+ "= $money_char%.2f invoiced";
+
+ } elsif ( $charges{R} and $charges{U} ) {
- # recur/usage separation
- if ( $cgi->param('usage') eq 'recurring' ) {
+ # hide rows with no recurring fee, and show the sum of recurring fees only
+ push @where, 'cust_bill_pkg.recur > 0';
+ push @total, "SUM(cust_bill_pkg.recur)";
+ push @total_desc, "$money_char%.2f recurring";
- my $recur_no_usage = FS::cust_bill_pkg->charged_sql('', '', no_usage => 1);
+ } elsif ( $charges{R} and !$charges{U} ) {
+
+ my $recur_no_usage = FS::cust_bill_pkg->charged_sql('', '',
+ setuprecur => 'recur', no_usage => 1);
push @select, "($recur_no_usage) AS recur_no_usage";
$peritem[1] = 'recur_no_usage';
- $total[1] = "SUM(cust_bill_pkg.setup + $recur_no_usage)";
- $total_desc[0] .= ' (excluding usage)';
+ $peritem_desc[1] = 'Recurring charges (excluding usage)';
+ push @total, "SUM($recur_no_usage)";
+ push @total_desc, "$money_char%.2f recurring";
+ if ( !$charges{S} ) {
+ push @where, "($recur_no_usage) > 0";
+ }
- } elsif ( $cgi->param('usage') eq 'usage' ) {
+ } elsif ( !$charges{R} and $charges{U} ) {
my $usage = FS::cust_bill_pkg->usage_sql();
push @select, "($usage) AS _usage";
# there's already a method named 'usage'
$peritem[1] = '_usage';
$peritem_desc[1] = 'Usage charge';
- $total[1] = "SUM($usage)";
- $total_desc[0] .= ' usage charges';
- }
+ push @total, "SUM($usage)";
+ push @total_desc, "$money_char%.2f usage charges";
+ if ( !$charges{S} ) {
+ push @where, "($usage) > 0";
+ }
+
+ } elsif ( $charges{S} ) {
+
+ push @where, "cust_bill_pkg.setup > 0";
+ push @total, "SUM(cust_bill_pkg.setup)";
+ push @total_desc, "$money_char%.2f setup";
+
+ } # else huh? you have to have SOME charges
} elsif ( $cgi->param('istax') ) {
}
}
- $total[1] = 'SUM(
+ push @total, 'SUM(
COALESCE(cust_bill_pkg_tax_rate_location.amount,
cust_bill_pkg.setup + cust_bill_pkg.recur)
)';
+ push @total_desc, "$money_char%.2f total";
} else { # the internal-tax case
';
# don't double-count the components of consolidated taxes
- $total[0] = 'COUNT(DISTINCT cust_bill_pkg.billpkgnum)';
- $total[1] = 'SUM(cust_bill_pkg_tax_location.amount)';
+ @total = ( 'COUNT(DISTINCT cust_bill_pkg.billpkgnum)',
+ 'SUM(cust_bill_pkg_tax_location.amount)' );
+ @total_desc = "$money_char%.2f total";
# package classnum
if ( grep { $_ eq 'classnum' } $cgi->param ) {
} #end of "normal case"
+ # classnum (of underlying package)
+ # not specified: all classes
+ # 0: empty class
+ # N: classnum
+ if ( grep { $_ eq 'classnum' } $cgi->param ) {
+ my @classnums = grep /^\d+$/, $cgi->param('classnum');
+ push @where, "COALESCE(part_fee.classnum, $part_pkg.classnum, 0) IN ( ".
+ join(',', @classnums ).
+ ' )'
+ if @classnums;
+ }
+
} # nottax / istax
projects / freeside.git / blobdiff