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 );
11 use FS::cust_bill_pkg_detail;
12 use FS::cust_bill_pkg_display;
13 use FS::cust_bill_pkg_discount;
14 use FS::cust_bill_pkg_fee;
15 use FS::cust_bill_pay_pkg;
16 use FS::cust_credit_bill_pkg;
17 use FS::cust_tax_exempt_pkg;
18 use FS::cust_bill_pkg_tax_location;
19 use FS::cust_bill_pkg_tax_rate_location;
20 use FS::cust_tax_adjustment;
21 use FS::cust_bill_pkg_void;
22 use FS::cust_bill_pkg_detail_void;
23 use FS::cust_bill_pkg_display_void;
24 use FS::cust_bill_pkg_discount_void;
25 use FS::cust_bill_pkg_tax_location_void;
26 use FS::cust_bill_pkg_tax_rate_location_void;
27 use FS::cust_tax_exempt_pkg_void;
28 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";
243 my $other; # the as yet uninserted cust_bill_pkg
244 $other = $link->billpkgnum ? $link->get('taxable_cust_bill_pkg')
245 : $link->get('tax_cust_bill_pkg');
246 my $link_array = $other->get( $tax_link_table ) || [];
247 push @$link_array, $link;
248 $other->set( $tax_link_table => $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;
327 =item void [ REASON ]
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 : '';
338 unless (ref($reason) || !$reason) {
339 $reason = FS::reason->new_or_existing(
341 'type' => 'Invoice void',
346 local $SIG{HUP} = 'IGNORE';
347 local $SIG{INT} = 'IGNORE';
348 local $SIG{QUIT} = 'IGNORE';
349 local $SIG{TERM} = 'IGNORE';
350 local $SIG{TSTP} = 'IGNORE';
351 local $SIG{PIPE} = 'IGNORE';
353 my $oldAutoCommit = $FS::UID::AutoCommit;
354 local $FS::UID::AutoCommit = 0;
357 my $cust_bill_pkg_void = new FS::cust_bill_pkg_void ( {
358 map { $_ => $self->get($_) } $self->fields
360 $cust_bill_pkg_void->reasonnum($reason->reasonnum) if $reason;
361 my $error = $cust_bill_pkg_void->insert;
363 $dbh->rollback if $oldAutoCommit;
367 foreach my $table (qw(
369 cust_bill_pkg_display
370 cust_bill_pkg_discount
371 cust_bill_pkg_tax_location
372 cust_bill_pkg_tax_rate_location
377 foreach my $linked ( qsearch($table, { billpkgnum=>$self->billpkgnum }) ) {
379 my $vclass = 'FS::'.$table.'_void';
380 my $void = $vclass->new( {
381 map { $_ => $linked->get($_) } $linked->fields
383 my $error = $void->insert || $linked->delete;
385 $dbh->rollback if $oldAutoCommit;
393 $error = $self->delete;
395 $dbh->rollback if $oldAutoCommit;
399 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
414 local $SIG{HUP} = 'IGNORE';
415 local $SIG{INT} = 'IGNORE';
416 local $SIG{QUIT} = 'IGNORE';
417 local $SIG{TERM} = 'IGNORE';
418 local $SIG{TSTP} = 'IGNORE';
419 local $SIG{PIPE} = 'IGNORE';
421 my $oldAutoCommit = $FS::UID::AutoCommit;
422 local $FS::UID::AutoCommit = 0;
425 foreach my $table (qw(
427 cust_bill_pkg_display
428 cust_bill_pkg_discount
429 cust_bill_pkg_tax_location
430 cust_bill_pkg_tax_rate_location
437 foreach my $linked ( qsearch($table, { billpkgnum=>$self->billpkgnum }) ) {
438 my $error = $linked->delete;
440 $dbh->rollback if $oldAutoCommit;
447 foreach my $cust_tax_adjustment (
448 qsearch('cust_tax_adjustment', { billpkgnum=>$self->billpkgnum })
450 $cust_tax_adjustment->billpkgnum(''); #NULL
451 my $error = $cust_tax_adjustment->replace;
453 $dbh->rollback if $oldAutoCommit;
458 my $error = $self->SUPER::delete(@_);
460 $dbh->rollback if $oldAutoCommit;
464 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
470 #alas, bin/follow-tax-rename
472 #=item replace OLD_RECORD
474 #Currently unimplemented. This would be even more of an accounting nightmare
475 #than deleteing the items. Just don't do it.
480 # return "Can't modify cust_bill_pkg records!";
485 Checks all fields to make sure this is a valid line item. If there is an
486 error, returns the error, otherwise returns false. Called by the insert
495 $self->ut_numbern('billpkgnum')
496 || $self->ut_snumber('pkgnum')
497 || $self->ut_number('invnum')
498 || $self->ut_money('setup')
499 || $self->ut_moneyn('unitsetup')
500 || $self->ut_currencyn('setup_billed_currency')
501 || $self->ut_moneyn('setup_billed_amount')
502 || $self->ut_money('recur')
503 || $self->ut_moneyn('unitrecur')
504 || $self->ut_currencyn('recur_billed_currency')
505 || $self->ut_moneyn('recur_billed_amount')
506 || $self->ut_numbern('sdate')
507 || $self->ut_numbern('edate')
508 || $self->ut_textn('itemdesc')
509 || $self->ut_textn('itemcomment')
510 || $self->ut_enum('hidden', [ '', 'Y' ])
512 return $error if $error;
514 $self->regularize_details;
516 #if ( $self->pkgnum != 0 ) { #allow unchecked pkgnum 0 for tax! (add to part_pkg?)
517 if ( $self->pkgnum > 0 ) { #allow -1 for non-pkg line items and 0 for tax (add to part_pkg?)
518 return "Unknown pkgnum ". $self->pkgnum
519 unless qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
522 return "Unknown invnum"
523 unless qsearchs( 'cust_bill' ,{ 'invnum' => $self->invnum } );
528 =item regularize_details
530 Converts the contents of the 'details' pseudo-field to
531 L<FS::cust_bill_pkg_detail> objects, if they aren't already.
535 sub regularize_details {
537 if ( $self->get('details') ) {
538 foreach my $detail ( @{$self->get('details')} ) {
539 if ( ref($detail) ne 'FS::cust_bill_pkg_detail' ) {
540 # then turn it into one
542 if ( ! ref($detail) ) {
543 $hash{'detail'} = $detail;
545 elsif ( ref($detail) eq 'HASH' ) {
548 elsif ( ref($detail) eq 'ARRAY' ) {
549 carp "passing invoice details as arrays is deprecated";
550 #carp "this way sucks, use a hash"; #but more useful/friendly
551 $hash{'format'} = $detail->[0];
552 $hash{'detail'} = $detail->[1];
553 $hash{'amount'} = $detail->[2];
554 $hash{'classnum'} = $detail->[3];
555 $hash{'phonenum'} = $detail->[4];
556 $hash{'accountcode'} = $detail->[5];
557 $hash{'startdate'} = $detail->[6];
558 $hash{'duration'} = $detail->[7];
559 $hash{'regionname'} = $detail->[8];
562 die "unknown detail type ". ref($detail);
564 $detail = new FS::cust_bill_pkg_detail \%hash;
566 $detail->billpkgnum($self->billpkgnum) if $self->billpkgnum;
572 =item set_exemptions TAXOBJECT, OPTIONS
574 Sets up tax exemptions. TAXOBJECT is the L<FS::cust_main_county> or
575 L<FS::tax_rate> record for the tax.
577 This will deal with the following cases:
581 =item Fully exempt customers (cust_main.tax flag) or customer classes
584 =item Customers exempt from specific named taxes (cust_main_exemption
587 =item Taxes that don't apply to setup or recurring fees
588 (cust_main_county.setuptax and recurtax, tax_rate.setuptax and recurtax).
590 =item Packages that are marked as tax-exempt (part_pkg.setuptax,
593 =item Fees that aren't marked as taxable (part_fee.taxable).
597 It does NOT deal with monthly tax exemptions, which need more context
598 than this humble little method cares to deal with.
600 OPTIONS should include "custnum" => the customer number if this tax line
601 hasn't been inserted (which it probably hasn't).
603 Returns a list of exemption objects, which will also be attached to the
604 line item as the 'cust_tax_exempt_pkg' pseudo-field. Inserting the line
605 item will insert these records as well.
614 my $part_pkg = $self->part_pkg;
615 my $part_fee = $self->part_fee;
618 my $custnum = $opt{custnum};
619 $custnum ||= $self->cust_bill->custnum if $self->cust_bill;
621 $cust_main = FS::cust_main->by_key( $custnum )
622 or die "set_exemptions can't identify customer (pass custnum option)\n";
625 my $taxable_charged = $self->setup + $self->recur;
626 return unless $taxable_charged > 0;
628 ### Fully exempt customer ###
630 my $conf = FS::Conf->new;
631 if ( $conf->exists('cust_class-tax_exempt') ) {
632 my $cust_class = $cust_main->cust_class;
633 $exempt_cust = $cust_class->tax if $cust_class;
635 $exempt_cust = $cust_main->tax;
638 ### Exemption from named tax ###
639 my $exempt_cust_taxname;
640 if ( !$exempt_cust and $tax->taxname ) {
641 $exempt_cust_taxname = $cust_main->tax_exemption($tax->taxname);
644 if ( $exempt_cust ) {
646 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
647 amount => $taxable_charged,
650 $taxable_charged = 0;
652 } elsif ( $exempt_cust_taxname ) {
654 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
655 amount => $taxable_charged,
656 exempt_cust_taxname => 'Y',
658 $taxable_charged = 0;
662 my $exempt_setup = ( ($part_fee and not $part_fee->taxable)
663 or ($part_pkg and $part_pkg->setuptax)
668 and $taxable_charged > 0 ) {
670 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
671 amount => $self->setup,
674 $taxable_charged -= $self->setup;
678 my $exempt_recur = ( ($part_fee and not $part_fee->taxable)
679 or ($part_pkg and $part_pkg->recurtax)
684 and $taxable_charged > 0 ) {
686 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
687 amount => $self->recur,
690 $taxable_charged -= $self->recur;
694 foreach (@new_exemptions) {
695 $_->set('taxnum', $tax->taxnum);
696 $_->set('taxtype', ref($tax));
699 push @{ $self->cust_tax_exempt_pkg }, @new_exemptions;
700 return @new_exemptions;
706 Returns the invoice (see L<FS::cust_bill>) for this invoice line item.
710 Returns the customer (L<FS::cust_main> object) for this line item.
715 # required for cust_main_Mixin equivalence
716 # and use cust_bill instead of cust_pkg because this might not have a
719 my $cust_bill = $self->cust_bill or return '';
720 $cust_bill->cust_main;
723 =item previous_cust_bill_pkg
725 Returns the previous cust_bill_pkg for this package, if any.
729 sub previous_cust_bill_pkg {
731 return unless $self->sdate;
733 'table' => 'cust_bill_pkg',
734 'hashref' => { 'pkgnum' => $self->pkgnum,
735 'sdate' => { op=>'<', value=>$self->sdate },
737 'order_by' => 'ORDER BY sdate DESC LIMIT 1',
743 Returns the amount owed (still outstanding) on this line item's setup fee,
744 which is the amount of the line item minus all payment applications (see
745 L<FS::cust_bill_pay_pkg> and credit applications (see
746 L<FS::cust_credit_bill_pkg>).
752 $self->owed('setup', @_);
757 Returns the amount owed (still outstanding) on this line item's recurring fee,
758 which is the amount of the line item minus all payment applications (see
759 L<FS::cust_bill_pay_pkg> and credit applications (see
760 L<FS::cust_credit_bill_pkg>).
766 $self->owed('recur', @_);
769 # modeled after cust_bill::owed...
771 my( $self, $field ) = @_;
772 my $balance = $self->$field();
773 $balance -= $_->amount foreach ( $self->cust_bill_pay_pkg($field) );
774 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) );
775 $balance = sprintf( '%.2f', $balance );
776 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
782 my( $self, $field ) = @_;
783 my $balance = $self->$field();
784 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) );
785 $balance = sprintf( '%.2f', $balance );
786 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
790 sub cust_bill_pay_pkg {
791 my( $self, $field ) = @_;
792 qsearch( 'cust_bill_pay_pkg', { 'billpkgnum' => $self->billpkgnum,
793 'setuprecur' => $field,
798 sub cust_credit_bill_pkg {
799 my( $self, $field ) = @_;
800 qsearch( 'cust_credit_bill_pkg', { 'billpkgnum' => $self->billpkgnum,
801 'setuprecur' => $field,
808 Returns the number of billing units (for tax purposes) represented by this,
815 $self->pkgnum ? $self->part_pkg->calc_units($self->cust_pkg) : 0; # 1?
820 If this item has any discounts, returns a hashref in the format used
821 by L<FS::Template_Mixin/_items_cust_bill_pkg> to describe the discount(s)
822 on an invoice. This will contain the keys 'description', 'amount',
823 'ext_description' (an arrayref of text lines describing the discounts),
824 and '_is_discount' (a flag).
826 The value for 'amount' will be negative, and will be scaled for the package
835 my $d; # this will be returned.
837 my @pkg_discounts = $self->pkg_discount;
838 if (@pkg_discounts) {
839 # special case: if there are old "discount details" on this line item,
840 # don't show discount line items
841 if ( FS::cust_bill_pkg_detail->count("detail LIKE 'Includes discount%' AND billpkgnum = ?", $self->billpkgnum || 0) > 0 ) {
848 description => $self->mt('Discount'),
851 ext_description => \@ext,
852 pkgpart => $self->pkgpart,
853 feepart => $self->feepart,
854 # maybe should show quantity/unit discount?
856 foreach my $pkg_discount (@pkg_discounts) {
857 push @ext, $pkg_discount->description;
858 my $setuprecur = $pkg_discount->cust_pkg_discount->setuprecur;
859 $d->{$setuprecur.'_amount'} -= $pkg_discount->amount;
863 # show introductory rate as a pseudo-discount
864 if (!$d) { # this will conflict with showing real discounts
865 my $part_pkg = $self->part_pkg;
866 if ( $part_pkg and $part_pkg->option('show_as_discount') ) {
867 my $cust_pkg = $self->cust_pkg;
868 my $intro_end = $part_pkg->intro_end($cust_pkg);
869 my $_date = $self->cust_bill->_date;
870 if ( $intro_end > $_date ) {
871 $d = $part_pkg->item_discount($cust_pkg);
877 $d->{setup_amount} *= $self->quantity || 1; # ??
878 $d->{recur_amount} *= $self->quantity || 1; # ??
884 =item set_display OPTION => VALUE ...
886 A helper method for I<insert>, populates the pseudo-field B<display> with
887 appropriate FS::cust_bill_pkg_display objects.
889 Options are passed as a list of name/value pairs. Options are:
891 part_pkg: FS::part_pkg object from this line item's package.
893 real_pkgpart: if this line item comes from a bundled package, the pkgpart
894 of the owning package. Otherwise the same as the part_pkg's pkgpart above.
899 my( $self, %opt ) = @_;
900 my $part_pkg = $opt{'part_pkg'};
901 my $cust_pkg = new FS::cust_pkg { pkgpart => $opt{real_pkgpart} };
903 my $conf = new FS::Conf;
905 # whether to break this down into setup/recur/usage
906 my $separate = $conf->exists('separate_usage');
908 my $usage_mandate = $part_pkg->option('usage_mandate', 'Hush!')
909 || $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
911 # or use the category from $opt{'part_pkg'} if its not bundled?
912 my $categoryname = $cust_pkg->part_pkg->categoryname;
914 # if we don't have to separate setup/recur/usage, or put this in a
915 # package-specific section, or display a usage summary, then don't
916 # even create one of these. The item will just display in the unnamed
917 # section as a single line plus details.
918 return $self->set('display', [])
919 unless $separate || $categoryname || $usage_mandate;
923 my %hash = ( 'section' => $categoryname );
925 # whether to put usage details in a separate section, and if so, which one
926 my $usage_section = $part_pkg->option('usage_section', 'Hush!')
927 || $cust_pkg->part_pkg->option('usage_section', 'Hush!');
929 # whether to show a usage summary line (total usage charges, no details)
930 my $summary = $part_pkg->option('summarize_usage', 'Hush!')
931 || $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
934 # create lines for setup and (non-usage) recur, in the main section
935 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
936 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
938 # display everything in a single line
939 push @display, new FS::cust_bill_pkg_display
942 # and if usage_mandate is enabled, hide details
943 # (this only works on multisection invoices...)
944 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
948 if ($separate && $usage_section && $summary) {
949 # create a line for the usage summary in the main section
950 push @display, new FS::cust_bill_pkg_display { type => 'U',
956 if ($usage_mandate || ($usage_section && $summary) ) {
957 $hash{post_total} = 'Y';
960 if ($separate || $usage_mandate) {
961 # show call details for this line item in the usage section.
962 # if usage_mandate is on, this will display below the section subtotal.
963 # this also happens if usage is in a separate section and there's a
964 # summary in the main section, though I'm not sure why.
965 $hash{section} = $usage_section if $usage_section;
966 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
969 $self->set('display', \@display);
975 Returns a hash: keys are "setup", "recur" or usage classnum, values are
976 FS::cust_bill_pkg objects, each with no more than a single class (setup or
983 # XXX this goes away with cust_bill_pkg refactor
984 # or at least I wish it would, but it turns out to be harder than
987 #my $cust_bill_pkg = new FS::cust_bill_pkg { $self->hash }; # wha huh?
988 my %cust_bill_pkg = ();
991 foreach my $classnum ($self->usage_classes) {
992 my $amount = $self->usage($classnum);
993 next if $amount == 0; # though if so we shouldn't be here
994 my $usage_item = FS::cust_bill_pkg->new({
998 'taxclass' => $classnum,
1001 $cust_bill_pkg{$classnum} = $usage_item;
1002 $usage_total += $amount;
1005 foreach (qw(setup recur)) {
1006 next if ($self->get($_) == 0);
1007 my $item = FS::cust_bill_pkg->new({
1014 $item->set($_, $self->get($_));
1015 $cust_bill_pkg{$_} = $item;
1019 $cust_bill_pkg{recur}->set('recur',
1020 sprintf('%.2f', $cust_bill_pkg{recur}->get('recur') - $usage_total)
1027 =item usage CLASSNUM
1029 Returns the amount of the charge associated with usage class CLASSNUM if
1030 CLASSNUM is defined. Otherwise returns the total charge associated with
1036 my( $self, $classnum ) = @_;
1037 $self->regularize_details;
1039 if ( $self->get('details') ) {
1042 map { $_->amount || 0 }
1043 grep { !defined($classnum) or $classnum eq $_->classnum }
1044 @{ $self->get('details') }
1049 my $sql = 'SELECT SUM(COALESCE(amount,0)) FROM cust_bill_pkg_detail '.
1050 ' WHERE billpkgnum = '. $self->billpkgnum;
1051 if (defined $classnum) {
1052 if ($classnum =~ /^(\d+)$/) {
1053 $sql .= " AND classnum = $1";
1054 } elsif ($classnum eq '') {
1055 $sql .= " AND classnum IS NULL";
1059 my $sth = dbh->prepare($sql) or die dbh->errstr;
1060 $sth->execute or die $sth->errstr;
1062 return $sth->fetchrow_arrayref->[0] || 0;
1070 Returns a list of usage classnums associated with this invoice line's
1077 $self->regularize_details;
1079 if ( $self->get('details') ) {
1081 my %seen = ( map { $_->classnum => 1 } @{ $self->get('details') } );
1086 map { $_->classnum }
1087 qsearch({ table => 'cust_bill_pkg_detail',
1088 hashref => { billpkgnum => $self->billpkgnum },
1089 select => 'DISTINCT classnum',
1096 sub cust_tax_exempt_pkg {
1099 my $array = $self->{Hash}->{cust_tax_exempt_pkg} ||= [];
1102 =item cust_bill_pkg_tax_Xlocation
1104 Returns the list of associated cust_bill_pkg_tax_location and/or
1105 cust_bill_pkg_tax_rate_location objects
1109 sub cust_bill_pkg_tax_Xlocation {
1112 my %hash = ( 'billpkgnum' => $self->billpkgnum );
1115 qsearch ( 'cust_bill_pkg_tax_location', { %hash } ),
1116 qsearch ( 'cust_bill_pkg_tax_rate_location', { %hash } )
1121 =item recur_show_zero
1123 Whether to show a zero recurring amount. This is true if the package or its
1124 definition has the recur_show_zero flag, and the recurring fee is actually
1125 zero for this period.
1129 sub recur_show_zero {
1130 my( $self, $what ) = @_;
1132 return 0 unless $self->get('recur') == 0 && $self->pkgnum;
1134 $self->cust_pkg->_X_show_zero('recur');
1137 =item setup_show_zero
1139 Whether to show a zero setup charge. This requires the package or its
1140 definition to have the setup_show_zero flag, but it also returns false if
1141 the package's setup date is before this line item's start date.
1145 sub setup_show_zero {
1147 return 0 unless $self->get('setup') == 0 && $self->pkgnum;
1148 my $cust_pkg = $self->cust_pkg;
1149 return 0 if ( $self->sdate || 0 ) > ( $cust_pkg->setup || 0 );
1150 return $cust_pkg->_X_show_zero('setup');
1153 =item credited [ BEFORE, AFTER, OPTIONS ]
1155 Returns the sum of credits applied to this item. Arguments are the same as
1156 owed_sql/paid_sql/credited_sql.
1162 $self->scalar_sql('SELECT '. $self->credited_sql(@_).' FROM cust_bill_pkg WHERE billpkgnum = ?', $self->billpkgnum);
1165 =item tax_locationnum
1167 Returns the L<FS::cust_location> number that this line item is in for tax
1168 purposes. For package sales, it's the package tax location; for fees,
1169 it's the customer's default service location.
1173 sub tax_locationnum {
1175 if ( $self->pkgnum ) { # normal sales
1176 return $self->cust_pkg->tax_locationnum;
1177 } elsif ( $self->feepart ) { # fees
1178 my $custnum = $self->fee_origin->custnum;
1180 return FS::cust_main->by_key($custnum)->ship_locationnum;
1189 if ( $self->pkgnum ) { # normal sales
1190 return $self->cust_pkg->tax_location;
1191 } elsif ( $self->feepart ) { # fees
1192 my $custnum = $self->fee_origin->custnum;
1194 return FS::cust_main->by_key($custnum)->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->config('tax_data_vendor'); #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 local($FS::Record::qsearch_qualify_columns) = 0;
1405 my $h_cust_main = qsearchs('h_cust_main',
1406 { custnum => $custnum },
1407 FS::h_cust_main->sql_h_searchs($date)
1409 if (!$h_cust_main ) {
1410 warn "no historical address for cust#".$h_cust_bill->custnum."; skipped\n";
1412 # fallback to current $cust_main? sounds dangerous.
1415 # This is a historical customer record, so it has a historical address.
1416 # If there's no cust_location matching this custnum and address (there
1417 # probably isn't), create one.
1418 my %tax_loc; # keys are pkgnums, values are cust_location objects
1419 my $default_tax_loc;
1420 if ( $h_cust_main->bill_locationnum ) {
1421 # the location has already been upgraded
1423 $default_tax_loc = $h_cust_main->ship_location;
1425 $default_tax_loc = $h_cust_main->bill_location;
1428 $pre = 'ship_' if $use_ship and length($h_cust_main->get('ship_last'));
1429 my %hash = map { $_ => $h_cust_main->get($pre.$_) }
1430 FS::cust_main->location_fields;
1431 # not really needed for this, and often result in duplicate locations
1432 delete @hash{qw(censustract censusyear latitude longitude coord_auto)};
1434 $hash{custnum} = $h_cust_main->custnum;
1435 $default_tax_loc = FS::cust_location->new(\%hash);
1436 my $error = $default_tax_loc->find_or_insert || $default_tax_loc->disable_if_unused;
1438 warn "couldn't create historical location record for cust#".
1439 $h_cust_main->custnum.": $error\n";
1444 $exempt_cust = 1 if $h_cust_main->tax;
1446 # classify line items
1448 my %nontax_items; # taxclass => array of cust_bill_pkg
1449 foreach my $item ($h_cust_bill->cust_bill_pkg) {
1450 my $pkgnum = $item->pkgnum;
1452 if ( $pkgnum == 0 ) {
1454 push @tax_items, $item;
1457 # (pkgparts really shouldn't change, right?)
1458 local($FS::Record::qsearch_qualify_columns) = 0;
1459 my $h_cust_pkg = qsearchs('h_cust_pkg', { pkgnum => $pkgnum },
1460 FS::h_cust_pkg->sql_h_searchs($date)
1462 if ( !$h_cust_pkg ) {
1463 warn "no historical package #".$item->pkgpart."; skipped\n";
1466 my $pkgpart = $h_cust_pkg->pkgpart;
1468 if ( $use_pkgloc and $h_cust_pkg->locationnum ) {
1469 # then this package already had a locationnum assigned, and that's
1470 # the one to use for tax calculation
1471 $tax_loc{$pkgnum} = FS::cust_location->by_key($h_cust_pkg->locationnum);
1473 # use the customer's bill or ship loc, which was inserted earlier
1474 $tax_loc{$pkgnum} = $default_tax_loc;
1477 if (!exists $pkgpart_taxclass{$pkgpart}) {
1478 local($FS::Record::qsearch_qualify_columns) = 0;
1479 my $h_part_pkg = qsearchs('h_part_pkg', { pkgpart => $pkgpart },
1480 FS::h_part_pkg->sql_h_searchs($date)
1482 if ( !$h_part_pkg ) {
1483 warn "no historical package def #$pkgpart; skipped\n";
1486 $pkgpart_taxclass{$pkgpart} = $h_part_pkg->taxclass || '';
1487 $pkgpart_exempt_setup{$pkgpart} = 1 if $h_part_pkg->setuptax;
1488 $pkgpart_exempt_recur{$pkgpart} = 1 if $h_part_pkg->recurtax;
1491 # mark any exemptions that apply
1492 if ( $pkgpart_exempt_setup{$pkgpart} ) {
1493 $item->set('exempt_setup' => 1);
1496 if ( $pkgpart_exempt_recur{$pkgpart} ) {
1497 $item->set('exempt_recur' => 1);
1500 my $taxclass = $pkgpart_taxclass{ $pkgpart };
1502 $nontax_items{$taxclass} ||= [];
1503 push @{ $nontax_items{$taxclass} }, $item;
1507 printf("%d tax items: \$%.2f\n", scalar(@tax_items), map {$_->setup} @tax_items)
1510 # Get any per-customer taxname exemptions that were in effect.
1511 my %exempt_cust_taxname;
1512 foreach (keys %all_tax_names) {
1513 local($FS::Record::qsearch_qualify_columns) = 0;
1514 my $h_exemption = qsearchs('h_cust_main_exemption', {
1515 'custnum' => $custnum,
1518 FS::h_cust_main_exemption->sql_h_searchs($date, $date)
1521 $exempt_cust_taxname{ $_ } = 1;
1525 # Use a variation on the procedure in
1526 # FS::cust_main::Billing::_handle_taxes to identify taxes that apply
1528 my @loc_keys = qw( district city county state country );
1529 my %taxdef_by_name; # by name, and then by taxclass
1530 my %est_tax; # by name, and then by taxclass
1531 my %taxable_items; # by taxnum, and then an array
1533 foreach my $taxclass (keys %nontax_items) {
1534 foreach my $orig_item (@{ $nontax_items{$taxclass} }) {
1535 my $my_tax_loc = $tax_loc{ $orig_item->pkgnum };
1536 my %myhash = map { $_ => $my_tax_loc->get($pre.$_) } @loc_keys;
1537 my @elim = qw( district city county state );
1538 my @taxdefs; # because there may be several with different taxnames
1540 $myhash{taxclass} = $taxclass;
1541 @taxdefs = qsearch('cust_main_county', \%myhash);
1543 $myhash{taxclass} = '';
1544 @taxdefs = qsearch('cust_main_county', \%myhash);
1546 $myhash{ shift @elim } = '';
1547 } while scalar(@elim) and !@taxdefs;
1549 foreach my $taxdef (@taxdefs) {
1550 next if $taxdef->tax == 0;
1551 $taxdef_by_name{$taxdef->taxname}{$taxdef->taxclass} = $taxdef;
1553 $taxable_items{$taxdef->taxnum} ||= [];
1554 # clone the item so that taxdef-dependent changes don't
1555 # change it for other taxdefs
1556 my $item = FS::cust_bill_pkg->new({ $orig_item->hash });
1558 # these flags are already set if the part_pkg declares itself exempt
1559 $item->set('exempt_setup' => 1) if $taxdef->setuptax;
1560 $item->set('exempt_recur' => 1) if $taxdef->recurtax;
1563 my $taxable = $item->setup + $item->recur;
1565 # h_cust_credit_bill_pkg?
1566 # NO. Because if these exemptions HAD been created at the time of
1567 # billing, and then a credit applied later, the exemption would
1568 # have been adjusted by the amount of the credit. So we adjust
1569 # the taxable amount before creating the exemption.
1570 # But don't deduct the credit from taxable, because the tax was
1571 # calculated before the credit was applied.
1572 foreach my $f (qw(setup recur)) {
1573 my $credited = FS::Record->scalar_sql(
1574 "SELECT SUM(amount) FROM cust_credit_bill_pkg ".
1575 "WHERE billpkgnum = ? AND setuprecur = ?",
1579 $item->set($f, $item->get($f) - $credited) if $credited;
1581 my $existing_exempt = FS::Record->scalar_sql(
1582 "SELECT SUM(amount) FROM cust_tax_exempt_pkg WHERE ".
1583 "billpkgnum = ? AND taxnum = ?",
1584 $item->billpkgnum, $taxdef->taxnum
1586 $taxable -= $existing_exempt;
1588 if ( $taxable and $exempt_cust ) {
1589 push @new_exempt, { exempt_cust => 'Y', amount => $taxable };
1592 if ( $taxable and $exempt_cust_taxname{$taxdef->taxname} ){
1593 push @new_exempt, { exempt_cust_taxname => 'Y', amount => $taxable };
1596 if ( $taxable and $item->exempt_setup ) {
1597 push @new_exempt, { exempt_setup => 'Y', amount => $item->setup };
1598 $taxable -= $item->setup;
1600 if ( $taxable and $item->exempt_recur ) {
1601 push @new_exempt, { exempt_recur => 'Y', amount => $item->recur };
1602 $taxable -= $item->recur;
1605 $item->set('taxable' => $taxable);
1606 push @{ $taxable_items{$taxdef->taxnum} }, $item
1609 # estimate the amount of tax (this is necessary because different
1610 # taxdefs with the same taxname may have different tax rates)
1611 # and sum that for each taxname/taxclass combination
1613 $est_tax{$taxdef->taxname} ||= {};
1614 $est_tax{$taxdef->taxname}{$taxdef->taxclass} ||= 0;
1615 $est_tax{$taxdef->taxname}{$taxdef->taxclass} +=
1616 $taxable * $taxdef->tax;
1618 foreach (@new_exempt) {
1619 next if $_->{amount} == 0;
1620 my $cust_tax_exempt_pkg = FS::cust_tax_exempt_pkg->new({
1622 billpkgnum => $item->billpkgnum,
1623 taxnum => $taxdef->taxnum,
1625 my $error = $cust_tax_exempt_pkg->insert;
1627 my $pkgnum = $item->pkgnum;
1628 warn "error creating tax exemption for inv$invnum pkg$pkgnum:".
1632 } #foreach @new_exempt
1635 } #foreach $taxclass
1637 # Now go through the billed taxes and match them up with the line items.
1638 TAX_ITEM: foreach my $tax_item ( @tax_items )
1640 my $taxname = $tax_item->itemdesc;
1641 $taxname = '' if $taxname eq 'Tax';
1643 if ( !exists( $taxdef_by_name{$taxname} ) ) {
1644 # then we didn't find any applicable taxes with this name
1645 warn "no definition found for tax item '$taxname', custnum $custnum\n";
1646 # possibly all of these should be "next TAX_ITEM", but whole invoices
1647 # are transaction protected and we can go back and retry them.
1650 # classname => cust_main_county
1651 my %taxdef_by_class = %{ $taxdef_by_name{$taxname} };
1653 # Divide the tax item among taxclasses, if necessary
1654 # classname => estimated tax amount
1655 my $this_est_tax = $est_tax{$taxname};
1656 if (!defined $this_est_tax) {
1657 warn "no taxable sales found for inv#$invnum, tax item '$taxname'.\n";
1660 my $est_total = sum(values %$this_est_tax);
1661 if ( $est_total == 0 ) {
1663 warn "estimated tax on invoice #$invnum is zero.\n";
1667 my $real_tax = $tax_item->setup;
1668 printf ("Distributing \$%.2f tax:\n", $real_tax);
1669 my $cents_remaining = $real_tax * 100; # for rounding error
1670 my @tax_links; # partial CBPTL hashrefs
1671 foreach my $taxclass (keys %taxdef_by_class) {
1672 my $taxdef = $taxdef_by_class{$taxclass};
1673 # these items already have "taxable" set to their charge amount
1674 # after applying any credits or exemptions
1675 my @items = @{ $taxable_items{$taxdef->taxnum} };
1676 my $subtotal = sum(map {$_->get('taxable')} @items);
1677 printf("\t$taxclass: %.2f\n", $this_est_tax->{$taxclass}/$est_total);
1679 foreach my $nontax (@items) {
1680 my $my_tax_loc = $tax_loc{ $nontax->pkgnum };
1681 my $part = int($real_tax
1683 * ($this_est_tax->{$taxclass}/$est_total)
1685 * ($nontax->get('taxable'))/$subtotal
1689 $cents_remaining -= $part;
1691 taxnum => $taxdef->taxnum,
1692 pkgnum => $nontax->pkgnum,
1693 locationnum => $my_tax_loc->locationnum,
1694 billpkgnum => $nontax->billpkgnum,
1698 } #foreach $taxclass
1699 # Distribute any leftover tax round-robin style, one cent at a time.
1701 my $nlinks = scalar(@tax_links);
1703 # ensure that it really is an integer
1704 $cents_remaining = sprintf('%.0f', $cents_remaining);
1705 while ($cents_remaining > 0) {
1706 $tax_links[$i % $nlinks]->{cents} += 1;
1711 warn "Can't create tax links--no taxable items found.\n";
1715 # Gather credit/payment applications so that we can link them
1718 qsearch( 'cust_credit_bill_pkg',
1719 { billpkgnum => $tax_item->billpkgnum, billpkgtaxlocationnum => '' }
1721 qsearch( 'cust_bill_pay_pkg',
1722 { billpkgnum => $tax_item->billpkgnum, billpkgtaxlocationnum => '' }
1726 # grab the first one
1727 my $this_unlinked = shift @unlinked;
1728 my $unlinked_cents = int($this_unlinked->amount * 100) if $this_unlinked;
1730 # Create tax links (yay!)
1731 printf("Creating %d tax links.\n",scalar(@tax_links));
1732 foreach (@tax_links) {
1733 my $link = FS::cust_bill_pkg_tax_location->new({
1734 billpkgnum => $tax_item->billpkgnum,
1735 taxtype => 'FS::cust_main_county',
1736 locationnum => $_->{locationnum},
1737 taxnum => $_->{taxnum},
1738 pkgnum => $_->{pkgnum},
1739 amount => sprintf('%.2f', $_->{cents} / 100),
1740 taxable_billpkgnum => $_->{billpkgnum},
1742 my $error = $link->insert;
1744 warn "Can't create tax link for inv#$invnum: $error\n";
1748 my $link_cents = $_->{cents};
1749 # update/create subitem links
1751 # If $this_unlinked is undef, then we've allocated all of the
1752 # credit/payment applications to the tax item. If $link_cents is 0,
1753 # then we've applied credits/payments to all of this package fraction,
1754 # so go on to the next.
1755 while ($this_unlinked and $link_cents) {
1756 # apply as much as possible of $link_amount to this credit/payment
1758 my $apply_cents = min($link_cents, $unlinked_cents);
1759 $link_cents -= $apply_cents;
1760 $unlinked_cents -= $apply_cents;
1761 # $link_cents or $unlinked_cents or both are now zero
1762 $this_unlinked->set('amount' => sprintf('%.2f',$apply_cents/100));
1763 $this_unlinked->set('billpkgtaxlocationnum' => $link->billpkgtaxlocationnum);
1764 my $pkey = $this_unlinked->primary_key; #creditbillpkgnum or billpaypkgnum
1765 if ( $this_unlinked->$pkey ) {
1766 # then it's an existing link--replace it
1767 $error = $this_unlinked->replace;
1769 $this_unlinked->insert;
1771 # what do we do with errors at this stage?
1773 warn "Error creating tax application link: $error\n";
1774 next INVOICE; # for lack of a better idea
1777 if ( $unlinked_cents == 0 ) {
1778 # then we've allocated all of this payment/credit application,
1779 # so grab the next one
1780 $this_unlinked = shift @unlinked;
1781 $unlinked_cents = int($this_unlinked->amount * 100) if $this_unlinked;
1782 } elsif ( $link_cents == 0 ) {
1783 # then we've covered all of this package tax fraction, so split
1784 # off a new application from this one
1785 $this_unlinked = $this_unlinked->new({
1786 $this_unlinked->hash,
1789 # $unlinked_cents is still what it is
1792 } #while $this_unlinked and $link_cents
1793 } #foreach (@tax_links)
1794 } #foreach $tax_item
1796 $dbh->commit if $commit_each_invoice and $oldAutoCommit;
1802 $dbh->rollback if $oldAutoCommit;
1803 die "Upgrade halted.\n" unless $commit_each_invoice;
1807 $dbh->commit if $oldAutoCommit and !$commit_each_invoice;
1812 # Create a queue job to run upgrade_tax_location from January 1, 2012 to
1816 use Date::Parse 'str2time';
1819 my $upgrade = 'tax_location_2012';
1820 return if FS::upgrade_journal->is_done($upgrade);
1821 my $job = FS::queue->new({
1822 'job' => 'FS::cust_bill_pkg::upgrade_tax_location'
1824 # call it kind of like a class method, not that it matters much
1825 $job->insert($class, 's' => str2time('2012-01-01'));
1826 # if there's a customer location upgrade queued also, wait for it to
1828 my $location_job = qsearchs('queue', {
1829 job => 'FS::cust_main::Location::process_upgrade_location'
1831 if ( $location_job ) {
1832 $job->depend_insert($location_job->jobnum);
1834 # Then mark the upgrade as done, so that we don't queue the job twice
1835 # and somehow run two of them concurrently.
1836 FS::upgrade_journal->set_done($upgrade);
1837 # This upgrade now does the job of assigning taxable_billpkgnums to
1838 # cust_bill_pkg_tax_location, so set that task done also.
1839 FS::upgrade_journal->set_done('tax_location_taxable_billpkgnum');
1846 setup and recur shouldn't be separate fields. There should be one "amount"
1847 field and a flag to tell you if it is a setup/one-time fee or a recurring fee.
1849 A line item with both should really be two separate records (preserving
1850 sdate and edate for setup fees for recurring packages - that information may
1851 be valuable later). Invoice generation (cust_main::bill), invoice printing
1852 (cust_bill), tax reports (report_tax.cgi) and line item reports
1853 (cust_bill_pkg.cgi) would need to be updated.
1855 owed_setup and owed_recur could then be repaced by just owed, and
1856 cust_bill::open_cust_bill_pkg and
1857 cust_bill_ApplicationCommon::apply_to_lineitems could be simplified.
1859 The upgrade procedure is pretty sketchy.
1863 L<FS::Record>, L<FS::cust_bill>, L<FS::cust_pkg>, L<FS::cust_main>, schema.html
1864 from the base documentation.