1 package FS::cust_bill_pkg;
2 use base qw( FS::TemplateItem_Mixin FS::cust_main_Mixin FS::Record );
5 use vars qw( @ISA $DEBUG $me );
7 use List::Util qw( sum min );
9 use FS::Record qw( qsearch qsearchs dbh );
12 use FS::cust_bill_pkg_detail;
13 use FS::cust_bill_pkg_display;
14 use FS::cust_bill_pkg_discount;
15 use FS::cust_bill_pkg_fee;
16 use FS::cust_bill_pay_pkg;
17 use FS::cust_credit_bill_pkg;
18 use FS::cust_tax_exempt_pkg;
19 use FS::cust_bill_pkg_tax_location;
20 use FS::cust_bill_pkg_tax_rate_location;
21 use FS::cust_tax_adjustment;
22 use FS::cust_bill_pkg_void;
23 use FS::cust_bill_pkg_detail_void;
24 use FS::cust_bill_pkg_display_void;
25 use FS::cust_bill_pkg_discount_void;
26 use FS::cust_bill_pkg_tax_location_void;
27 use FS::cust_bill_pkg_tax_rate_location_void;
28 use FS::cust_tax_exempt_pkg_void;
29 use FS::cust_bill_pkg_fee_void;
35 $me = '[FS::cust_bill_pkg]';
39 FS::cust_bill_pkg - Object methods for cust_bill_pkg records
43 use FS::cust_bill_pkg;
45 $record = new FS::cust_bill_pkg \%hash;
46 $record = new FS::cust_bill_pkg { 'column' => 'value' };
48 $error = $record->insert;
50 $error = $record->check;
54 An FS::cust_bill_pkg object represents an invoice line item.
55 FS::cust_bill_pkg inherits from FS::Record. The following fields are
66 invoice (see L<FS::cust_bill>)
70 package (see L<FS::cust_pkg>) or 0 for the special virtual sales tax package, or -1 for the virtual line item (itemdesc is used for the line)
72 =item pkgpart_override
74 optional package definition (see L<FS::part_pkg>) override
86 starting date of recurring fee
90 ending date of recurring fee
94 Line item description (overrides normal package description)
98 If not set, defaults to 1
102 If not set, defaults to setup
106 If not set, defaults to recur
110 If set to Y, indicates data should not appear as separate line item on invoice
114 sdate and edate are specified as UNIX timestamps; see L<perlfunc/"time">. Also
115 see L<Time::Local> and L<Date::Parse> for conversion functions.
123 Creates a new line item. To add the line item to the database, see
124 L<"insert">. Line items are normally created by calling the bill method of a
125 customer object (see L<FS::cust_main>).
129 sub table { 'cust_bill_pkg'; }
131 sub detail_table { 'cust_bill_pkg_detail'; }
132 sub display_table { 'cust_bill_pkg_display'; }
133 sub discount_table { 'cust_bill_pkg_discount'; }
134 #sub tax_location_table { 'cust_bill_pkg_tax_location'; }
135 #sub tax_rate_location_table { 'cust_bill_pkg_tax_rate_location'; }
136 #sub tax_exempt_pkg_table { 'cust_tax_exempt_pkg'; }
140 Adds this line item to the database. If there is an error, returns the error,
141 otherwise returns false.
148 local $SIG{HUP} = 'IGNORE';
149 local $SIG{INT} = 'IGNORE';
150 local $SIG{QUIT} = 'IGNORE';
151 local $SIG{TERM} = 'IGNORE';
152 local $SIG{TSTP} = 'IGNORE';
153 local $SIG{PIPE} = 'IGNORE';
155 my $oldAutoCommit = $FS::UID::AutoCommit;
156 local $FS::UID::AutoCommit = 0;
159 my $error = $self->SUPER::insert;
161 $dbh->rollback if $oldAutoCommit;
165 if ( $self->get('details') ) {
166 foreach my $detail ( @{$self->get('details')} ) {
167 $detail->billpkgnum($self->billpkgnum);
168 $error = $detail->insert;
170 $dbh->rollback if $oldAutoCommit;
171 return "error inserting cust_bill_pkg_detail: $error";
176 if ( $self->get('display') ) {
177 foreach my $cust_bill_pkg_display ( @{ $self->get('display') } ) {
178 $cust_bill_pkg_display->billpkgnum($self->billpkgnum);
179 $error = $cust_bill_pkg_display->insert;
181 $dbh->rollback if $oldAutoCommit;
182 return "error inserting cust_bill_pkg_display: $error";
187 if ( $self->get('discounts') ) {
188 foreach my $cust_bill_pkg_discount ( @{$self->get('discounts')} ) {
189 $cust_bill_pkg_discount->billpkgnum($self->billpkgnum);
190 $error = $cust_bill_pkg_discount->insert;
192 $dbh->rollback if $oldAutoCommit;
193 return "error inserting cust_bill_pkg_discount: $error";
198 foreach my $cust_tax_exempt_pkg ( @{$self->cust_tax_exempt_pkg} ) {
199 $cust_tax_exempt_pkg->billpkgnum($self->billpkgnum);
200 $error = $cust_tax_exempt_pkg->insert;
202 $dbh->rollback if $oldAutoCommit;
203 return "error inserting cust_tax_exempt_pkg: $error";
207 foreach my $tax_link_table (qw(cust_bill_pkg_tax_location
208 cust_bill_pkg_tax_rate_location))
210 my $tax_location = $self->get($tax_link_table) || [];
211 foreach my $link ( @$tax_location ) {
212 my $pkey = $link->primary_key;
213 next if $link->get($pkey); # don't try to double-insert
214 # This cust_bill_pkg can be linked on either side (i.e. it can be the
215 # tax or the taxed item). If the other side is already inserted,
216 # then set billpkgnum to ours, and insert the link. Otherwise,
217 # set billpkgnum to ours and pass the link off to the cust_bill_pkg
218 # on the other side, to be inserted later.
220 my $tax_cust_bill_pkg = $link->get('tax_cust_bill_pkg');
221 if ( $tax_cust_bill_pkg && $tax_cust_bill_pkg->billpkgnum ) {
222 $link->set('billpkgnum', $tax_cust_bill_pkg->billpkgnum);
223 # break circular links when doing this
224 $link->set('tax_cust_bill_pkg', '');
226 my $taxable_cust_bill_pkg = $link->get('taxable_cust_bill_pkg');
227 if ( $taxable_cust_bill_pkg && $taxable_cust_bill_pkg->billpkgnum ) {
228 $link->set('taxable_billpkgnum', $taxable_cust_bill_pkg->billpkgnum);
229 # XXX pkgnum is zero for tax on tax; it might be better to use
230 # the underlying package?
231 $link->set('pkgnum', $taxable_cust_bill_pkg->pkgnum);
232 $link->set('locationnum', $taxable_cust_bill_pkg->tax_locationnum);
233 $link->set('taxable_cust_bill_pkg', '');
236 if ( $link->billpkgnum and $link->taxable_billpkgnum ) {
237 $error = $link->insert;
239 $dbh->rollback if $oldAutoCommit;
240 return "error inserting cust_bill_pkg_tax_location: $error";
244 $other = $link->billpkgnum ? $link->get('taxable_cust_bill_pkg')
245 : $link->get('tax_cust_bill_pkg');
246 my $link_array = $other->get('cust_bill_pkg_tax_location') || [];
247 push @$link_array, $link;
248 $other->set('cust_bill_pkg_tax_location' => $link_array);
253 # someday you will be as awesome as cust_bill_pkg_tax_location...
254 # and today is that day
255 #my $tax_rate_location = $self->get('cust_bill_pkg_tax_rate_location');
256 #if ( $tax_rate_location ) {
257 # foreach my $cust_bill_pkg_tax_rate_location ( @$tax_rate_location ) {
258 # $cust_bill_pkg_tax_rate_location->billpkgnum($self->billpkgnum);
259 # $error = $cust_bill_pkg_tax_rate_location->insert;
261 # $dbh->rollback if $oldAutoCommit;
262 # return "error inserting cust_bill_pkg_tax_rate_location: $error";
267 my $fee_links = $self->get('cust_bill_pkg_fee');
269 foreach my $link ( @$fee_links ) {
270 # very similar to cust_bill_pkg_tax_location, for obvious reasons
271 next if $link->billpkgfeenum; # don't try to double-insert
273 my $target = $link->get('cust_bill_pkg'); # the line item of the fee
274 my $base = $link->get('base_cust_bill_pkg'); # line item it was based on
276 if ( $target and $target->billpkgnum ) {
277 $link->set('billpkgnum', $target->billpkgnum);
278 # base_invnum => null indicates that the fee is based on its own
280 $link->set('base_invnum', $target->invnum) unless $link->base_invnum;
281 $link->set('cust_bill_pkg', '');
284 if ( $base and $base->billpkgnum ) {
285 $link->set('base_billpkgnum', $base->billpkgnum);
286 $link->set('base_cust_bill_pkg', '');
288 # it's based on a line item that's not yet inserted
289 my $link_array = $base->get('cust_bill_pkg_fee') || [];
290 push @$link_array, $link;
291 $base->set('cust_bill_pkg_fee' => $link_array);
292 next; # don't insert the link yet
295 $error = $link->insert;
297 $dbh->rollback if $oldAutoCommit;
298 return "error inserting cust_bill_pkg_fee: $error";
303 if ( my $fee_origin = $self->get('fee_origin') ) {
304 $fee_origin->set('billpkgnum' => $self->billpkgnum);
305 $error = $fee_origin->replace;
307 $dbh->rollback if $oldAutoCommit;
308 return "error updating fee origin record: $error";
312 my $cust_tax_adjustment = $self->get('cust_tax_adjustment');
313 if ( $cust_tax_adjustment ) {
314 $cust_tax_adjustment->billpkgnum($self->billpkgnum);
315 $error = $cust_tax_adjustment->replace;
317 $dbh->rollback if $oldAutoCommit;
318 return "error replacing cust_tax_adjustment: $error";
322 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
329 Voids this line item: deletes the line item and adds a record of the voided
330 line item to the FS::cust_bill_pkg_void table (and related tables).
336 my $reason = scalar(@_) ? shift : '';
337 my $reprocess_cdrs = scalar(@_) ? shift : '';
339 local $SIG{HUP} = 'IGNORE';
340 local $SIG{INT} = 'IGNORE';
341 local $SIG{QUIT} = 'IGNORE';
342 local $SIG{TERM} = 'IGNORE';
343 local $SIG{TSTP} = 'IGNORE';
344 local $SIG{PIPE} = 'IGNORE';
346 my $oldAutoCommit = $FS::UID::AutoCommit;
347 local $FS::UID::AutoCommit = 0;
350 my $cust_bill_pkg_void = new FS::cust_bill_pkg_void ( {
351 map { $_ => $self->get($_) } $self->fields
353 $cust_bill_pkg_void->reason($reason);
354 my $error = $cust_bill_pkg_void->insert;
356 $dbh->rollback if $oldAutoCommit;
360 foreach my $table (qw(
362 cust_bill_pkg_display
363 cust_bill_pkg_discount
364 cust_bill_pkg_tax_location
365 cust_bill_pkg_tax_rate_location
369 my %delete_args = ();
370 $delete_args{'reprocess_cdrs'} = $reprocess_cdrs
371 if $table eq 'cust_bill_pkg_detail';
373 foreach my $linked ( qsearch($table, { billpkgnum=>$self->billpkgnum }) ) {
375 my $vclass = 'FS::'.$table.'_void';
376 my $void = $vclass->new( {
377 map { $_ => $linked->get($_) } $linked->fields
379 my $error = $void->insert || $linked->delete(%delete_args);
381 $dbh->rollback if $oldAutoCommit;
389 $error = $self->delete;
391 $dbh->rollback if $oldAutoCommit;
395 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
410 local $SIG{HUP} = 'IGNORE';
411 local $SIG{INT} = 'IGNORE';
412 local $SIG{QUIT} = 'IGNORE';
413 local $SIG{TERM} = 'IGNORE';
414 local $SIG{TSTP} = 'IGNORE';
415 local $SIG{PIPE} = 'IGNORE';
417 my $oldAutoCommit = $FS::UID::AutoCommit;
418 local $FS::UID::AutoCommit = 0;
421 foreach my $table (qw(
423 cust_bill_pkg_display
424 cust_bill_pkg_discount
425 cust_bill_pkg_tax_location
426 cust_bill_pkg_tax_rate_location
433 foreach my $linked ( qsearch($table, { billpkgnum=>$self->billpkgnum }) ) {
434 my $error = $linked->delete;
436 $dbh->rollback if $oldAutoCommit;
443 foreach my $cust_tax_adjustment (
444 qsearch('cust_tax_adjustment', { billpkgnum=>$self->billpkgnum })
446 $cust_tax_adjustment->billpkgnum(''); #NULL
447 my $error = $cust_tax_adjustment->replace;
449 $dbh->rollback if $oldAutoCommit;
454 my $error = $self->SUPER::delete(@_);
456 $dbh->rollback if $oldAutoCommit;
460 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
466 #alas, bin/follow-tax-rename
468 #=item replace OLD_RECORD
470 #Currently unimplemented. This would be even more of an accounting nightmare
471 #than deleteing the items. Just don't do it.
476 # return "Can't modify cust_bill_pkg records!";
481 Checks all fields to make sure this is a valid line item. If there is an
482 error, returns the error, otherwise returns false. Called by the insert
491 $self->ut_numbern('billpkgnum')
492 || $self->ut_snumber('pkgnum')
493 || $self->ut_number('invnum')
494 || $self->ut_money('setup')
495 || $self->ut_money('recur')
496 || $self->ut_numbern('sdate')
497 || $self->ut_numbern('edate')
498 || $self->ut_textn('itemdesc')
499 || $self->ut_textn('itemcomment')
500 || $self->ut_enum('hidden', [ '', 'Y' ])
502 return $error if $error;
504 $self->regularize_details;
506 #if ( $self->pkgnum != 0 ) { #allow unchecked pkgnum 0 for tax! (add to part_pkg?)
507 if ( $self->pkgnum > 0 ) { #allow -1 for non-pkg line items and 0 for tax (add to part_pkg?)
508 return "Unknown pkgnum ". $self->pkgnum
509 unless qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
512 return "Unknown invnum"
513 unless qsearchs( 'cust_bill' ,{ 'invnum' => $self->invnum } );
518 =item regularize_details
520 Converts the contents of the 'details' pseudo-field to
521 L<FS::cust_bill_pkg_detail> objects, if they aren't already.
525 sub regularize_details {
527 if ( $self->get('details') ) {
528 foreach my $detail ( @{$self->get('details')} ) {
529 if ( ref($detail) ne 'FS::cust_bill_pkg_detail' ) {
530 # then turn it into one
532 if ( ! ref($detail) ) {
533 $hash{'detail'} = $detail;
535 elsif ( ref($detail) eq 'HASH' ) {
538 elsif ( ref($detail) eq 'ARRAY' ) {
539 carp "passing invoice details as arrays is deprecated";
540 #carp "this way sucks, use a hash"; #but more useful/friendly
541 $hash{'format'} = $detail->[0];
542 $hash{'detail'} = $detail->[1];
543 $hash{'amount'} = $detail->[2];
544 $hash{'classnum'} = $detail->[3];
545 $hash{'phonenum'} = $detail->[4];
546 $hash{'accountcode'} = $detail->[5];
547 $hash{'startdate'} = $detail->[6];
548 $hash{'duration'} = $detail->[7];
549 $hash{'regionname'} = $detail->[8];
552 die "unknown detail type ". ref($detail);
554 $detail = new FS::cust_bill_pkg_detail \%hash;
556 $detail->billpkgnum($self->billpkgnum) if $self->billpkgnum;
562 =item set_exemptions TAXOBJECT, OPTIONS
564 Sets up tax exemptions. TAXOBJECT is the L<FS::cust_main_county> or
565 L<FS::tax_rate> record for the tax.
567 This will deal with the following cases:
571 =item Fully exempt customers (cust_main.tax flag) or customer classes
574 =item Customers exempt from specific named taxes (cust_main_exemption
577 =item Taxes that don't apply to setup or recurring fees
578 (cust_main_county.setuptax and recurtax, tax_rate.setuptax and recurtax).
580 =item Packages that are marked as tax-exempt (part_pkg.setuptax,
583 =item Fees that aren't marked as taxable (part_fee.taxable).
587 It does NOT deal with monthly tax exemptions, which need more context
588 than this humble little method cares to deal with.
590 OPTIONS should include "custnum" => the customer number if this tax line
591 hasn't been inserted (which it probably hasn't).
593 Returns a list of exemption objects, which will also be attached to the
594 line item as the 'cust_tax_exempt_pkg' pseudo-field. Inserting the line
595 item will insert these records as well.
604 my $part_pkg = $self->part_pkg;
605 my $part_fee = $self->part_fee;
608 my $custnum = $opt{custnum};
609 $custnum ||= $self->cust_bill->custnum if $self->cust_bill;
611 $cust_main = FS::cust_main->by_key( $custnum )
612 or die "set_exemptions can't identify customer (pass custnum option)\n";
615 my $taxable_charged = $self->setup + $self->recur;
616 return unless $taxable_charged > 0;
618 ### Fully exempt customer ###
620 my $conf = FS::Conf->new;
621 if ( $conf->exists('cust_class-tax_exempt') ) {
622 my $cust_class = $cust_main->cust_class;
623 $exempt_cust = $cust_class->tax if $cust_class;
625 $exempt_cust = $cust_main->tax;
628 ### Exemption from named tax ###
629 my $exempt_cust_taxname;
630 if ( !$exempt_cust and $tax->taxname ) {
631 $exempt_cust_taxname = $cust_main->tax_exemption($tax->taxname);
634 if ( $exempt_cust ) {
636 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
637 amount => $taxable_charged,
640 $taxable_charged = 0;
642 } elsif ( $exempt_cust_taxname ) {
644 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
645 amount => $taxable_charged,
646 exempt_cust_taxname => 'Y',
648 $taxable_charged = 0;
652 my $exempt_setup = ( ($part_fee and not $part_fee->taxable)
653 or ($part_pkg and $part_pkg->setuptax)
658 and $taxable_charged > 0 ) {
660 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
661 amount => $self->setup,
664 $taxable_charged -= $self->setup;
668 my $exempt_recur = ( ($part_fee and not $part_fee->taxable)
669 or ($part_pkg and $part_pkg->recurtax)
674 and $taxable_charged > 0 ) {
676 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
677 amount => $self->recur,
680 $taxable_charged -= $self->recur;
684 foreach (@new_exemptions) {
685 $_->set('taxnum', $tax->taxnum);
686 $_->set('taxtype', ref($tax));
689 push @{ $self->cust_tax_exempt_pkg }, @new_exemptions;
690 return @new_exemptions;
696 Returns the invoice (see L<FS::cust_bill>) for this invoice line item.
702 qsearchs( 'cust_bill', { 'invnum' => $self->invnum } );
707 Returns the customer (L<FS::cust_main> object) for this line item.
712 # required for cust_main_Mixin equivalence
713 # and use cust_bill instead of cust_pkg because this might not have a
716 my $cust_bill = $self->cust_bill or return '';
717 $cust_bill->cust_main;
720 =item previous_cust_bill_pkg
722 Returns the previous cust_bill_pkg for this package, if any.
726 sub previous_cust_bill_pkg {
728 return unless $self->sdate;
730 'table' => 'cust_bill_pkg',
731 'hashref' => { 'pkgnum' => $self->pkgnum,
732 'sdate' => { op=>'<', value=>$self->sdate },
734 'order_by' => 'ORDER BY sdate DESC LIMIT 1',
740 Returns the amount owed (still outstanding) on this line item's setup fee,
741 which is the amount of the line item minus all payment applications (see
742 L<FS::cust_bill_pay_pkg> and credit applications (see
743 L<FS::cust_credit_bill_pkg>).
749 $self->owed('setup', @_);
754 Returns the amount owed (still outstanding) on this line item's recurring fee,
755 which is the amount of the line item minus all payment applications (see
756 L<FS::cust_bill_pay_pkg> and credit applications (see
757 L<FS::cust_credit_bill_pkg>).
763 $self->owed('recur', @_);
766 # modeled after cust_bill::owed...
768 my( $self, $field ) = @_;
769 my $balance = $self->$field();
770 $balance -= $_->amount foreach ( $self->cust_bill_pay_pkg($field) );
771 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) );
772 $balance = sprintf( '%.2f', $balance );
773 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
779 my( $self, $field ) = @_;
780 my $balance = $self->$field();
781 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) );
782 $balance = sprintf( '%.2f', $balance );
783 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
787 sub cust_bill_pay_pkg {
788 my( $self, $field ) = @_;
789 qsearch( 'cust_bill_pay_pkg', { 'billpkgnum' => $self->billpkgnum,
790 'setuprecur' => $field,
795 sub cust_credit_bill_pkg {
796 my( $self, $field ) = @_;
797 qsearch( 'cust_credit_bill_pkg', { 'billpkgnum' => $self->billpkgnum,
798 'setuprecur' => $field,
805 Returns the number of billing units (for tax purposes) represented by this,
812 $self->pkgnum ? $self->part_pkg->calc_units($self->cust_pkg) : 0; # 1?
817 If this item has any discounts, returns a hashref in the format used
818 by L<FS::Template_Mixin/_items_cust_bill_pkg> to describe the discount(s)
819 on an invoice. This will contain the keys 'description', 'amount',
820 'ext_description' (an arrayref of text lines describing the discounts),
821 and '_is_discount' (a flag).
823 The value for 'amount' will be negative, and will be scaled for the package
831 my $d; # this will be returned.
833 my @pkg_discounts = $self->pkg_discount;
834 if (@pkg_discounts) {
835 # special case: if there are old "discount details" on this line item,
836 # don't show discount line items
837 if ( FS::cust_bill_pkg_detail->count("detail LIKE 'Includes discount%' AND billpkgnum = ?", $self->billpkgnum || 0) > 0 ) {
844 description => $self->mt('Discount'),
846 ext_description => \@ext,
847 pkgpart => $self->pkgpart,
848 feepart => $self->feepart,
849 # maybe should show quantity/unit discount?
851 foreach my $pkg_discount (@pkg_discounts) {
852 push @ext, $pkg_discount->description;
853 $d->{'amount'} -= $pkg_discount->amount;
857 # show introductory rate as a pseudo-discount
858 if (!$d) { # this will conflict with showing real discounts
859 my $part_pkg = $self->part_pkg;
860 if ( $part_pkg and $part_pkg->option('show_as_discount',1) ) {
861 my $cust_pkg = $self->cust_pkg;
862 my $intro_end = $part_pkg->intro_end($cust_pkg);
863 my $_date = $self->cust_bill->_date;
864 if ( $intro_end > $_date ) {
865 $d = $part_pkg->item_discount($cust_pkg);
871 $d->{amount} *= $self->quantity || 1;
877 =item set_display OPTION => VALUE ...
879 A helper method for I<insert>, populates the pseudo-field B<display> with
880 appropriate FS::cust_bill_pkg_display objects.
882 Options are passed as a list of name/value pairs. Options are:
884 part_pkg: FS::part_pkg object from this line item's package.
886 real_pkgpart: if this line item comes from a bundled package, the pkgpart
887 of the owning package. Otherwise the same as the part_pkg's pkgpart above.
892 my( $self, %opt ) = @_;
893 my $part_pkg = $opt{'part_pkg'};
894 my $cust_pkg = new FS::cust_pkg { pkgpart => $opt{real_pkgpart} };
896 my $conf = new FS::Conf;
898 # whether to break this down into setup/recur/usage
899 my $separate = $conf->exists('separate_usage');
901 my $usage_mandate = $part_pkg->option('usage_mandate', 'Hush!')
902 || $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
904 # or use the category from $opt{'part_pkg'} if its not bundled?
905 my $categoryname = $cust_pkg->part_pkg->categoryname;
907 # if we don't have to separate setup/recur/usage, or put this in a
908 # package-specific section, or display a usage summary, then don't
909 # even create one of these. The item will just display in the unnamed
910 # section as a single line plus details.
911 return $self->set('display', [])
912 unless $separate || $categoryname || $usage_mandate;
916 my %hash = ( 'section' => $categoryname );
918 # whether to put usage details in a separate section, and if so, which one
919 my $usage_section = $part_pkg->option('usage_section', 'Hush!')
920 || $cust_pkg->part_pkg->option('usage_section', 'Hush!');
922 # whether to show a usage summary line (total usage charges, no details)
923 my $summary = $part_pkg->option('summarize_usage', 'Hush!')
924 || $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
927 # create lines for setup and (non-usage) recur, in the main section
928 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
929 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
931 # display everything in a single line
932 push @display, new FS::cust_bill_pkg_display
935 # and if usage_mandate is enabled, hide details
936 # (this only works on multisection invoices...)
937 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
941 if ($separate && $usage_section && $summary) {
942 # create a line for the usage summary in the main section
943 push @display, new FS::cust_bill_pkg_display { type => 'U',
949 if ($usage_mandate || ($usage_section && $summary) ) {
950 $hash{post_total} = 'Y';
953 if ($separate || $usage_mandate) {
954 # show call details for this line item in the usage section.
955 # if usage_mandate is on, this will display below the section subtotal.
956 # this also happens if usage is in a separate section and there's a
957 # summary in the main section, though I'm not sure why.
958 $hash{section} = $usage_section if $usage_section;
959 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
962 $self->set('display', \@display);
968 Returns a hash: keys are "setup", "recur" or usage classnum, values are
969 FS::cust_bill_pkg objects, each with no more than a single class (setup or
976 # XXX this goes away with cust_bill_pkg refactor
977 # or at least I wish it would, but it turns out to be harder than
980 #my $cust_bill_pkg = new FS::cust_bill_pkg { $self->hash }; # wha huh?
981 my %cust_bill_pkg = ();
984 foreach my $classnum ($self->usage_classes) {
985 next if $classnum eq ''; # null-class usage is included in 'recur'
986 my $amount = $self->usage($classnum);
987 next if $amount == 0; # though if so we shouldn't be here
988 my $usage_item = FS::cust_bill_pkg->new({
992 'taxclass' => $classnum,
995 $cust_bill_pkg{$classnum} = $usage_item;
996 $usage_total += $amount;
999 foreach (qw(setup recur)) {
1000 next if ($self->get($_) == 0);
1001 my $item = FS::cust_bill_pkg->new({
1008 $item->set($_, $self->get($_));
1009 $cust_bill_pkg{$_} = $item;
1013 $cust_bill_pkg{recur}->set('recur',
1014 sprintf('%.2f', $cust_bill_pkg{recur}->get('recur') - $usage_total)
1021 =item usage CLASSNUM
1023 Returns the amount of the charge associated with usage class CLASSNUM if
1024 CLASSNUM is defined. Otherwise returns the total charge associated with
1030 my( $self, $classnum ) = @_;
1031 $self->regularize_details;
1033 if ( $self->get('details') ) {
1036 map { $_->amount || 0 }
1037 grep { !defined($classnum) or $classnum eq $_->classnum }
1038 @{ $self->get('details') }
1043 my $sql = 'SELECT SUM(COALESCE(amount,0)) FROM cust_bill_pkg_detail '.
1044 ' WHERE billpkgnum = '. $self->billpkgnum;
1045 if (defined $classnum) {
1046 if ($classnum =~ /^(\d+)$/) {
1047 $sql .= " AND classnum = $1";
1048 } elsif (defined($classnum) and $classnum eq '') {
1049 $sql .= " AND classnum IS NULL";
1053 my $sth = dbh->prepare($sql) or die dbh->errstr;
1054 $sth->execute or die $sth->errstr;
1056 return $sth->fetchrow_arrayref->[0] || 0;
1064 Returns a list of usage classnums associated with this invoice line's
1071 $self->regularize_details;
1073 if ( $self->get('details') ) {
1075 my %seen = ( map { $_->classnum => 1 } @{ $self->get('details') } );
1080 map { $_->classnum }
1081 qsearch({ table => 'cust_bill_pkg_detail',
1082 hashref => { billpkgnum => $self->billpkgnum },
1083 select => 'DISTINCT classnum',
1090 sub cust_tax_exempt_pkg {
1093 my $array = $self->{Hash}->{cust_tax_exempt_pkg} ||= [];
1096 =item cust_bill_pkg_fee
1098 Returns the list of associated cust_bill_pkg_fee objects, if this is
1103 sub cust_bill_pkg_fee {
1105 qsearch('cust_bill_pkg_fee', { billpkgnum => $self->billpkgnum });
1108 =item cust_bill_pkg_tax_Xlocation
1110 Returns the list of associated cust_bill_pkg_tax_location and/or
1111 cust_bill_pkg_tax_rate_location objects
1115 sub cust_bill_pkg_tax_Xlocation {
1118 my %hash = ( 'billpkgnum' => $self->billpkgnum );
1121 qsearch ( 'cust_bill_pkg_tax_location', { %hash } ),
1122 qsearch ( 'cust_bill_pkg_tax_rate_location', { %hash } )
1127 =item recur_show_zero
1129 Whether to show a zero recurring amount. This is true if the package or its
1130 definition has the recur_show_zero flag, and the recurring fee is actually
1131 zero for this period.
1135 sub recur_show_zero {
1136 my( $self, $what ) = @_;
1138 return 0 unless $self->get('recur') == 0 && $self->pkgnum;
1140 $self->cust_pkg->_X_show_zero('recur');
1143 =item setup_show_zero
1145 Whether to show a zero setup charge. This requires the package or its
1146 definition to have the setup_show_zero flag, but it also returns false if
1147 the package's setup date is before this line item's start date.
1151 sub setup_show_zero {
1153 return 0 unless $self->get('setup') == 0 && $self->pkgnum;
1154 my $cust_pkg = $self->cust_pkg;
1155 return 0 if ( $self->sdate || 0 ) > ( $cust_pkg->setup || 0 );
1156 return $cust_pkg->_X_show_zero('setup');
1159 =item credited [ BEFORE, AFTER, OPTIONS ]
1161 Returns the sum of credits applied to this item. Arguments are the same as
1162 owed_sql/paid_sql/credited_sql.
1168 $self->scalar_sql('SELECT '. $self->credited_sql(@_).' FROM cust_bill_pkg WHERE billpkgnum = ?', $self->billpkgnum);
1171 =item tax_locationnum
1173 Returns the L<FS::cust_location> number that this line item is in for tax
1174 purposes. For package sales, it's the package tax location; for fees,
1175 it's the customer's default service location.
1179 sub tax_locationnum {
1181 if ( $self->pkgnum ) { # normal sales
1182 return $self->cust_pkg->tax_locationnum;
1183 } elsif ( $self->feepart and $self->invnum ) { # fees
1184 return $self->cust_bill->cust_main->ship_locationnum;
1192 if ( $self->pkgnum ) { # normal sales
1193 return $self->cust_pkg->tax_location;
1194 } elsif ( $self->feepart and $self->invnum ) { # fees
1195 return $self->cust_bill->cust_main->ship_location;
1203 =head1 CLASS METHODS
1209 Returns an SQL expression for the total usage charges in details on
1215 '(SELECT COALESCE(SUM(cust_bill_pkg_detail.amount),0)
1216 FROM cust_bill_pkg_detail
1217 WHERE cust_bill_pkg_detail.billpkgnum = cust_bill_pkg.billpkgnum)';
1219 sub usage_sql { $usage_sql }
1221 # this makes owed_sql, etc. much more concise
1223 my ($class, $start, $end, %opt) = @_;
1224 my $setuprecur = $opt{setuprecur} || '';
1226 $setuprecur =~ /^s/ ? 'cust_bill_pkg.setup' :
1227 $setuprecur =~ /^r/ ? 'cust_bill_pkg.recur' :
1228 'cust_bill_pkg.setup + cust_bill_pkg.recur';
1230 if ($opt{no_usage} and $charged =~ /recur/) {
1231 $charged = "$charged - $usage_sql"
1238 =item owed_sql [ BEFORE, AFTER, OPTIONS ]
1240 Returns an SQL expression for the amount owed. BEFORE and AFTER specify
1241 a date window. OPTIONS may include 'no_usage' (excludes usage charges)
1242 and 'setuprecur' (set to "setup" or "recur" to limit to one or the other).
1248 '(' . $class->charged_sql(@_) .
1249 ' - ' . $class->paid_sql(@_) .
1250 ' - ' . $class->credited_sql(@_) . ')'
1253 =item paid_sql [ BEFORE, AFTER, OPTIONS ]
1255 Returns an SQL expression for the sum of payments applied to this item.
1260 my ($class, $start, $end, %opt) = @_;
1261 my $s = $start ? "AND cust_pay._date <= $start" : '';
1262 my $e = $end ? "AND cust_pay._date > $end" : '';
1263 my $setuprecur = $opt{setuprecur} || '';
1264 $setuprecur = 'setup' if $setuprecur =~ /^s/;
1265 $setuprecur = 'recur' if $setuprecur =~ /^r/;
1266 $setuprecur &&= "AND setuprecur = '$setuprecur'";
1268 my $paid = "( SELECT COALESCE(SUM(cust_bill_pay_pkg.amount),0)
1269 FROM cust_bill_pay_pkg JOIN cust_bill_pay USING (billpaynum)
1270 JOIN cust_pay USING (paynum)
1271 WHERE cust_bill_pay_pkg.billpkgnum = cust_bill_pkg.billpkgnum
1272 $s $e $setuprecur )";
1274 if ( $opt{no_usage} ) {
1275 # cap the amount paid at the sum of non-usage charges,
1276 # minus the amount credited against non-usage charges
1278 $class->charged_sql($start, $end, %opt) . ' - ' .
1279 $class->credited_sql($start, $end, %opt).')';
1288 my ($class, $start, $end, %opt) = @_;
1289 my $s = $start ? "AND cust_credit._date <= $start" : '';
1290 my $e = $end ? "AND cust_credit._date > $end" : '';
1291 my $setuprecur = $opt{setuprecur} || '';
1292 $setuprecur = 'setup' if $setuprecur =~ /^s/;
1293 $setuprecur = 'recur' if $setuprecur =~ /^r/;
1294 $setuprecur &&= "AND setuprecur = '$setuprecur'";
1296 my $credited = "( SELECT COALESCE(SUM(cust_credit_bill_pkg.amount),0)
1297 FROM cust_credit_bill_pkg JOIN cust_credit_bill USING (creditbillnum)
1298 JOIN cust_credit USING (crednum)
1299 WHERE cust_credit_bill_pkg.billpkgnum = cust_bill_pkg.billpkgnum
1300 $s $e $setuprecur )";
1302 if ( $opt{no_usage} ) {
1303 # cap the amount credited at the sum of non-usage charges
1304 "LEAST($credited, ". $class->charged_sql($start, $end, %opt).')';
1312 sub upgrade_tax_location {
1313 # For taxes that were calculated/invoiced before cust_location refactoring
1314 # (May-June 2012), there are no cust_bill_pkg_tax_location records unless
1315 # they were calculated on a package-location basis. Create them here,
1316 # along with any necessary cust_location records and any tax exemption
1319 my ($class, %opt) = @_;
1320 # %opt may include 's' and 'e': start and end date ranges
1321 # and 'X': abort on any error, instead of just rolling back changes to
1324 my $oldAutoCommit = $FS::UID::AutoCommit;
1325 local $FS::UID::AutoCommit = 0;
1328 use FS::h_cust_main;
1329 use FS::h_cust_bill;
1331 use FS::h_cust_main_exemption;
1334 local $FS::cust_location::import = 1;
1336 my $conf = FS::Conf->new; # h_conf?
1337 return if $conf->exists('enable_taxproducts'); #don't touch this case
1338 my $use_ship = $conf->exists('tax-ship_address');
1339 my $use_pkgloc = $conf->exists('tax-pkg_address');
1341 my $date_where = '';
1343 $date_where .= " AND cust_bill._date >= $opt{s}";
1346 $date_where .= " AND cust_bill._date < $opt{e}";
1349 my $commit_each_invoice = 1 unless $opt{X};
1351 # if an invoice has either of these kinds of objects, then it doesn't
1352 # need to be upgraded...probably
1353 my $sub_has_tax_link = 'SELECT 1 FROM cust_bill_pkg_tax_location'.
1354 ' JOIN cust_bill_pkg USING (billpkgnum)'.
1355 ' WHERE cust_bill_pkg.invnum = cust_bill.invnum';
1356 my $sub_has_exempt = 'SELECT 1 FROM cust_tax_exempt_pkg'.
1357 ' JOIN cust_bill_pkg USING (billpkgnum)'.
1358 ' WHERE cust_bill_pkg.invnum = cust_bill.invnum'.
1359 ' AND exempt_monthly IS NULL';
1361 my %all_tax_names = (
1364 map { $_->taxname => 1 }
1365 qsearch('h_cust_main_county', { taxname => { op => '!=', value => '' }})
1368 my $search = FS::Cursor->new({
1369 table => 'cust_bill',
1371 extra_sql => "WHERE NOT EXISTS($sub_has_tax_link) ".
1372 "AND NOT EXISTS($sub_has_exempt) ".
1376 #print "Processing ".scalar(@invnums)." invoices...\n";
1380 while (my $cust_bill = $search->fetch) {
1381 my $invnum = $cust_bill->invnum;
1383 print STDERR "Invoice #$invnum\n";
1385 my %pkgpart_taxclass; # pkgpart => taxclass
1386 my %pkgpart_exempt_setup;
1387 my %pkgpart_exempt_recur;
1388 my $h_cust_bill = qsearchs('h_cust_bill',
1389 { invnum => $invnum,
1390 history_action => 'insert' });
1391 if (!$h_cust_bill) {
1392 warn "no insert record for invoice $invnum; skipped\n";
1393 #$date = $cust_bill->_date as a fallback?
1394 # We're trying to avoid using non-real dates (-d/-y invoice dates)
1395 # when looking up history records in other tables.
1398 my $custnum = $h_cust_bill->custnum;
1400 # Determine the address corresponding to this tax region.
1401 # It's either the bill or ship address of the customer as of the
1402 # invoice date-of-insertion. (Not necessarily the invoice date.)
1403 my $date = $h_cust_bill->history_date;
1404 my $h_cust_main = qsearchs('h_cust_main',
1405 { custnum => $custnum },
1406 FS::h_cust_main->sql_h_searchs($date)
1408 if (!$h_cust_main ) {
1409 warn "no historical address for cust#".$h_cust_bill->custnum."; skipped\n";
1411 # fallback to current $cust_main? sounds dangerous.
1414 # This is a historical customer record, so it has a historical address.
1415 # If there's no cust_location matching this custnum and address (there
1416 # probably isn't), create one.
1417 my %tax_loc; # keys are pkgnums, values are cust_location objects
1418 my $default_tax_loc;
1419 if ( $h_cust_main->bill_locationnum ) {
1420 # the location has already been upgraded
1422 $default_tax_loc = $h_cust_main->ship_location;
1424 $default_tax_loc = $h_cust_main->bill_location;
1427 $pre = 'ship_' if $use_ship and length($h_cust_main->get('ship_last'));
1428 my %hash = map { $_ => $h_cust_main->get($pre.$_) }
1429 FS::cust_main->location_fields;
1430 # not really needed for this, and often result in duplicate locations
1431 delete @hash{qw(censustract censusyear latitude longitude coord_auto)};
1433 $hash{custnum} = $h_cust_main->custnum;
1434 $default_tax_loc = FS::cust_location->new(\%hash);
1435 my $error = $default_tax_loc->find_or_insert || $default_tax_loc->disable_if_unused;
1437 warn "couldn't create historical location record for cust#".
1438 $h_cust_main->custnum.": $error\n";
1443 $exempt_cust = 1 if $h_cust_main->tax;
1445 # classify line items
1447 my %nontax_items; # taxclass => array of cust_bill_pkg
1448 foreach my $item ($h_cust_bill->cust_bill_pkg) {
1449 my $pkgnum = $item->pkgnum;
1451 if ( $pkgnum == 0 ) {
1453 push @tax_items, $item;
1456 # (pkgparts really shouldn't change, right?)
1457 my $h_cust_pkg = qsearchs('h_cust_pkg', { pkgnum => $pkgnum },
1458 FS::h_cust_pkg->sql_h_searchs($date)
1460 if ( !$h_cust_pkg ) {
1461 warn "no historical package #".$item->pkgpart."; skipped\n";
1464 my $pkgpart = $h_cust_pkg->pkgpart;
1466 if ( $use_pkgloc and $h_cust_pkg->locationnum ) {
1467 # then this package already had a locationnum assigned, and that's
1468 # the one to use for tax calculation
1469 $tax_loc{$pkgnum} = FS::cust_location->by_key($h_cust_pkg->locationnum);
1471 # use the customer's bill or ship loc, which was inserted earlier
1472 $tax_loc{$pkgnum} = $default_tax_loc;
1475 if (!exists $pkgpart_taxclass{$pkgpart}) {
1476 my $h_part_pkg = qsearchs('h_part_pkg', { pkgpart => $pkgpart },
1477 FS::h_part_pkg->sql_h_searchs($date)
1479 if ( !$h_part_pkg ) {
1480 warn "no historical package def #$pkgpart; skipped\n";
1483 $pkgpart_taxclass{$pkgpart} = $h_part_pkg->taxclass || '';
1484 $pkgpart_exempt_setup{$pkgpart} = 1 if $h_part_pkg->setuptax;
1485 $pkgpart_exempt_recur{$pkgpart} = 1 if $h_part_pkg->recurtax;
1488 # mark any exemptions that apply
1489 if ( $pkgpart_exempt_setup{$pkgpart} ) {
1490 $item->set('exempt_setup' => 1);
1493 if ( $pkgpart_exempt_recur{$pkgpart} ) {
1494 $item->set('exempt_recur' => 1);
1497 my $taxclass = $pkgpart_taxclass{ $pkgpart };
1499 $nontax_items{$taxclass} ||= [];
1500 push @{ $nontax_items{$taxclass} }, $item;
1504 printf("%d tax items: \$%.2f\n", scalar(@tax_items), map {$_->setup} @tax_items)
1507 # Get any per-customer taxname exemptions that were in effect.
1508 my %exempt_cust_taxname;
1509 foreach (keys %all_tax_names) {
1510 my $h_exemption = qsearchs('h_cust_main_exemption', {
1511 'custnum' => $custnum,
1514 FS::h_cust_main_exemption->sql_h_searchs($date, $date)
1517 $exempt_cust_taxname{ $_ } = 1;
1521 # Use a variation on the procedure in
1522 # FS::cust_main::Billing::_handle_taxes to identify taxes that apply
1524 my @loc_keys = qw( district city county state country );
1525 my %taxdef_by_name; # by name, and then by taxclass
1526 my %est_tax; # by name, and then by taxclass
1527 my %taxable_items; # by taxnum, and then an array
1529 foreach my $taxclass (keys %nontax_items) {
1530 foreach my $orig_item (@{ $nontax_items{$taxclass} }) {
1531 my $my_tax_loc = $tax_loc{ $orig_item->pkgnum };
1532 my %myhash = map { $_ => $my_tax_loc->get($pre.$_) } @loc_keys;
1533 my @elim = qw( district city county state );
1534 my @taxdefs; # because there may be several with different taxnames
1536 $myhash{taxclass} = $taxclass;
1537 @taxdefs = qsearch('cust_main_county', \%myhash);
1539 $myhash{taxclass} = '';
1540 @taxdefs = qsearch('cust_main_county', \%myhash);
1542 $myhash{ shift @elim } = '';
1543 } while scalar(@elim) and !@taxdefs;
1545 foreach my $taxdef (@taxdefs) {
1546 next if $taxdef->tax == 0;
1547 $taxdef_by_name{$taxdef->taxname}{$taxdef->taxclass} = $taxdef;
1549 $taxable_items{$taxdef->taxnum} ||= [];
1550 # clone the item so that taxdef-dependent changes don't
1551 # change it for other taxdefs
1552 my $item = FS::cust_bill_pkg->new({ $orig_item->hash });
1554 # these flags are already set if the part_pkg declares itself exempt
1555 $item->set('exempt_setup' => 1) if $taxdef->setuptax;
1556 $item->set('exempt_recur' => 1) if $taxdef->recurtax;
1559 my $taxable = $item->setup + $item->recur;
1561 # h_cust_credit_bill_pkg?
1562 # NO. Because if these exemptions HAD been created at the time of
1563 # billing, and then a credit applied later, the exemption would
1564 # have been adjusted by the amount of the credit. So we adjust
1565 # the taxable amount before creating the exemption.
1566 # But don't deduct the credit from taxable, because the tax was
1567 # calculated before the credit was applied.
1568 foreach my $f (qw(setup recur)) {
1569 my $credited = FS::Record->scalar_sql(
1570 "SELECT SUM(amount) FROM cust_credit_bill_pkg ".
1571 "WHERE billpkgnum = ? AND setuprecur = ?",
1575 $item->set($f, $item->get($f) - $credited) if $credited;
1577 my $existing_exempt = FS::Record->scalar_sql(
1578 "SELECT SUM(amount) FROM cust_tax_exempt_pkg WHERE ".
1579 "billpkgnum = ? AND taxnum = ?",
1580 $item->billpkgnum, $taxdef->taxnum
1582 $taxable -= $existing_exempt;
1584 if ( $taxable and $exempt_cust ) {
1585 push @new_exempt, { exempt_cust => 'Y', amount => $taxable };
1588 if ( $taxable and $exempt_cust_taxname{$taxdef->taxname} ){
1589 push @new_exempt, { exempt_cust_taxname => 'Y', amount => $taxable };
1592 if ( $taxable and $item->exempt_setup ) {
1593 push @new_exempt, { exempt_setup => 'Y', amount => $item->setup };
1594 $taxable -= $item->setup;
1596 if ( $taxable and $item->exempt_recur ) {
1597 push @new_exempt, { exempt_recur => 'Y', amount => $item->recur };
1598 $taxable -= $item->recur;
1601 $item->set('taxable' => $taxable);
1602 push @{ $taxable_items{$taxdef->taxnum} }, $item
1605 # estimate the amount of tax (this is necessary because different
1606 # taxdefs with the same taxname may have different tax rates)
1607 # and sum that for each taxname/taxclass combination
1609 $est_tax{$taxdef->taxname} ||= {};
1610 $est_tax{$taxdef->taxname}{$taxdef->taxclass} ||= 0;
1611 $est_tax{$taxdef->taxname}{$taxdef->taxclass} +=
1612 $taxable * $taxdef->tax;
1614 foreach (@new_exempt) {
1615 next if $_->{amount} == 0;
1616 my $cust_tax_exempt_pkg = FS::cust_tax_exempt_pkg->new({
1618 billpkgnum => $item->billpkgnum,
1619 taxnum => $taxdef->taxnum,
1621 my $error = $cust_tax_exempt_pkg->insert;
1623 my $pkgnum = $item->pkgnum;
1624 warn "error creating tax exemption for inv$invnum pkg$pkgnum:".
1628 } #foreach @new_exempt
1631 } #foreach $taxclass
1633 # Now go through the billed taxes and match them up with the line items.
1634 TAX_ITEM: foreach my $tax_item ( @tax_items )
1636 my $taxname = $tax_item->itemdesc;
1637 $taxname = '' if $taxname eq 'Tax';
1639 if ( !exists( $taxdef_by_name{$taxname} ) ) {
1640 # then we didn't find any applicable taxes with this name
1641 warn "no definition found for tax item '$taxname', custnum $custnum\n";
1642 # possibly all of these should be "next TAX_ITEM", but whole invoices
1643 # are transaction protected and we can go back and retry them.
1646 # classname => cust_main_county
1647 my %taxdef_by_class = %{ $taxdef_by_name{$taxname} };
1649 # Divide the tax item among taxclasses, if necessary
1650 # classname => estimated tax amount
1651 my $this_est_tax = $est_tax{$taxname};
1652 if (!defined $this_est_tax) {
1653 warn "no taxable sales found for inv#$invnum, tax item '$taxname'.\n";
1656 my $est_total = sum(values %$this_est_tax);
1657 if ( $est_total == 0 ) {
1659 warn "estimated tax on invoice #$invnum is zero.\n";
1663 my $real_tax = $tax_item->setup;
1664 printf ("Distributing \$%.2f tax:\n", $real_tax);
1665 my $cents_remaining = $real_tax * 100; # for rounding error
1666 my @tax_links; # partial CBPTL hashrefs
1667 foreach my $taxclass (keys %taxdef_by_class) {
1668 my $taxdef = $taxdef_by_class{$taxclass};
1669 # these items already have "taxable" set to their charge amount
1670 # after applying any credits or exemptions
1671 my @items = @{ $taxable_items{$taxdef->taxnum} };
1672 my $subtotal = sum(map {$_->get('taxable')} @items);
1673 printf("\t$taxclass: %.2f\n", $this_est_tax->{$taxclass}/$est_total);
1675 foreach my $nontax (@items) {
1676 my $my_tax_loc = $tax_loc{ $nontax->pkgnum };
1677 my $part = int($real_tax
1679 * ($this_est_tax->{$taxclass}/$est_total)
1681 * ($nontax->get('taxable'))/$subtotal
1685 $cents_remaining -= $part;
1687 taxnum => $taxdef->taxnum,
1688 pkgnum => $nontax->pkgnum,
1689 locationnum => $my_tax_loc->locationnum,
1690 billpkgnum => $nontax->billpkgnum,
1694 } #foreach $taxclass
1695 # Distribute any leftover tax round-robin style, one cent at a time.
1697 my $nlinks = scalar(@tax_links);
1699 # ensure that it really is an integer
1700 $cents_remaining = sprintf('%.0f', $cents_remaining);
1701 while ($cents_remaining > 0) {
1702 $tax_links[$i % $nlinks]->{cents} += 1;
1707 warn "Can't create tax links--no taxable items found.\n";
1711 # Gather credit/payment applications so that we can link them
1714 qsearch( 'cust_credit_bill_pkg',
1715 { billpkgnum => $tax_item->billpkgnum, billpkgtaxlocationnum => '' }
1717 qsearch( 'cust_bill_pay_pkg',
1718 { billpkgnum => $tax_item->billpkgnum, billpkgtaxlocationnum => '' }
1722 # grab the first one
1723 my $this_unlinked = shift @unlinked;
1724 my $unlinked_cents = int($this_unlinked->amount * 100) if $this_unlinked;
1726 # Create tax links (yay!)
1727 printf("Creating %d tax links.\n",scalar(@tax_links));
1728 foreach (@tax_links) {
1729 my $link = FS::cust_bill_pkg_tax_location->new({
1730 billpkgnum => $tax_item->billpkgnum,
1731 taxtype => 'FS::cust_main_county',
1732 locationnum => $_->{locationnum},
1733 taxnum => $_->{taxnum},
1734 pkgnum => $_->{pkgnum},
1735 amount => sprintf('%.2f', $_->{cents} / 100),
1736 taxable_billpkgnum => $_->{billpkgnum},
1738 my $error = $link->insert;
1740 warn "Can't create tax link for inv#$invnum: $error\n";
1744 my $link_cents = $_->{cents};
1745 # update/create subitem links
1747 # If $this_unlinked is undef, then we've allocated all of the
1748 # credit/payment applications to the tax item. If $link_cents is 0,
1749 # then we've applied credits/payments to all of this package fraction,
1750 # so go on to the next.
1751 while ($this_unlinked and $link_cents) {
1752 # apply as much as possible of $link_amount to this credit/payment
1754 my $apply_cents = min($link_cents, $unlinked_cents);
1755 $link_cents -= $apply_cents;
1756 $unlinked_cents -= $apply_cents;
1757 # $link_cents or $unlinked_cents or both are now zero
1758 $this_unlinked->set('amount' => sprintf('%.2f',$apply_cents/100));
1759 $this_unlinked->set('billpkgtaxlocationnum' => $link->billpkgtaxlocationnum);
1760 my $pkey = $this_unlinked->primary_key; #creditbillpkgnum or billpaypkgnum
1761 if ( $this_unlinked->$pkey ) {
1762 # then it's an existing link--replace it
1763 $error = $this_unlinked->replace;
1765 $this_unlinked->insert;
1767 # what do we do with errors at this stage?
1769 warn "Error creating tax application link: $error\n";
1770 next INVOICE; # for lack of a better idea
1773 if ( $unlinked_cents == 0 ) {
1774 # then we've allocated all of this payment/credit application,
1775 # so grab the next one
1776 $this_unlinked = shift @unlinked;
1777 $unlinked_cents = int($this_unlinked->amount * 100) if $this_unlinked;
1778 } elsif ( $link_cents == 0 ) {
1779 # then we've covered all of this package tax fraction, so split
1780 # off a new application from this one
1781 $this_unlinked = $this_unlinked->new({
1782 $this_unlinked->hash,
1785 # $unlinked_cents is still what it is
1788 } #while $this_unlinked and $link_cents
1789 } #foreach (@tax_links)
1790 } #foreach $tax_item
1792 $dbh->commit if $commit_each_invoice and $oldAutoCommit;
1798 $dbh->rollback if $oldAutoCommit;
1799 die "Upgrade halted.\n" unless $commit_each_invoice;
1803 $dbh->commit if $oldAutoCommit and !$commit_each_invoice;
1808 # Return an array of hashrefs for each cust_bill_pkg_tax_location
1809 # applied to this bill for this cust_bill_pkg.pkgnum.
1812 # In some situations, this list will contain more tax records than the
1813 # ones directly related to $self->billpkgnum. The returned list contains
1814 # all records, for this bill, charged against this billpkgnum's pkgnum.
1816 # One must keep this in mind when using data returned by this method.
1818 # An unaddressed deficiency in the cust_bill_pkg_tax_location model makes
1819 # this necessary: When a linked-hidden package generates a tax/fee as a row
1820 # in cust_bill_pkg_tax_location, there is not enough information to surmise
1821 # with specificity which billpkgnum row represents the direct parent of the
1822 # the linked-hidden package's tax row. The closest we can get to this
1823 # backwards reassociation is to use the pkgnum. Therefore, when multiple
1824 # billpkgnum's appear with the same pkgnum, this method is going to return
1825 # the tax records for ALL of those billpkgnum's, not just $self->billpkgnum.
1827 # This could be addressed with an update to the model, and to the billing
1828 # routine that generates rows into cust_bill_pkg_tax_location. Perhaps a
1829 # column, link_billpkgnum or parent_billpkgnum, recording the link. I'm not
1830 # doing that now, because there would be no possible repair of data stored
1831 # historically prior to such a fix. I need _pkg_tax_list() to not be
1832 # broken for already-generated bills.
1834 # Any code you write relying on _pkg_tax_list() MUST be aware of, and
1835 # account for, the possible return of duplicated tax records returned
1836 # when method is called on multiple cust_bill_pkg_tax_location rows.
1837 # Duplicates can be identified by billpkgtaxlocationnum column.
1840 return unless $self->pkgnum;
1843 billpkgtaxlocationnum => $_->billpkgtaxlocationnum,
1844 billpkgnum => $_->billpkgnum,
1845 taxnum => $_->taxnum,
1846 amount => $_->amount,
1847 taxname => $_->taxname,
1850 table => 'cust_bill_pkg_tax_location',
1852 LEFT JOIN cust_bill_pkg
1853 ON cust_bill_pkg.billpkgnum
1854 = cust_bill_pkg_tax_location.taxable_billpkgnum
1856 select => join( ', ', (qw|
1857 cust_bill_pkg.billpkgnum
1858 cust_bill_pkg_tax_location.billpkgtaxlocationnum
1859 cust_bill_pkg_tax_location.taxnum
1860 cust_bill_pkg_tax_location.amount
1864 ' cust_bill_pkg.invnum = ' . dbh->quote( $self->invnum ) .
1866 ' cust_bill_pkg_tax_location.pkgnum = ' . dbh->quote( $self->pkgnum ),
1872 # Create a queue job to run upgrade_tax_location from January 1, 2012 to
1876 use Date::Parse 'str2time';
1879 my $upgrade = 'tax_location_2012';
1880 return if FS::upgrade_journal->is_done($upgrade);
1881 my $job = FS::queue->new({
1882 'job' => 'FS::cust_bill_pkg::upgrade_tax_location'
1884 # call it kind of like a class method, not that it matters much
1885 $job->insert($class, 's' => str2time('2012-01-01'));
1886 # if there's a customer location upgrade queued also, wait for it to
1888 my $location_job = qsearchs('queue', {
1889 job => 'FS::cust_main::Location::process_upgrade_location'
1891 if ( $location_job ) {
1892 $job->depend_insert($location_job->jobnum);
1894 # Then mark the upgrade as done, so that we don't queue the job twice
1895 # and somehow run two of them concurrently.
1896 FS::upgrade_journal->set_done($upgrade);
1897 # This upgrade now does the job of assigning taxable_billpkgnums to
1898 # cust_bill_pkg_tax_location, so set that task done also.
1899 FS::upgrade_journal->set_done('tax_location_taxable_billpkgnum');
1906 setup and recur shouldn't be separate fields. There should be one "amount"
1907 field and a flag to tell you if it is a setup/one-time fee or a recurring fee.
1909 A line item with both should really be two separate records (preserving
1910 sdate and edate for setup fees for recurring packages - that information may
1911 be valuable later). Invoice generation (cust_main::bill), invoice printing
1912 (cust_bill), tax reports (report_tax.cgi) and line item reports
1913 (cust_bill_pkg.cgi) would need to be updated.
1915 owed_setup and owed_recur could then be repaced by just owed, and
1916 cust_bill::open_cust_bill_pkg and
1917 cust_bill_ApplicationCommon::apply_to_lineitems could be simplified.
1919 The upgrade procedure is pretty sketchy.
1923 L<FS::Record>, L<FS::cust_bill>, L<FS::cust_pkg>, L<FS::cust_main>, schema.html
1924 from the base documentation.