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 [ , REPROCESS_CDRS ] ]
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 unless (ref($reason) || !$reason) {
340 $reason = FS::reason->new_or_existing(
342 'type' => 'Invoice void',
347 local $SIG{HUP} = 'IGNORE';
348 local $SIG{INT} = 'IGNORE';
349 local $SIG{QUIT} = 'IGNORE';
350 local $SIG{TERM} = 'IGNORE';
351 local $SIG{TSTP} = 'IGNORE';
352 local $SIG{PIPE} = 'IGNORE';
354 my $oldAutoCommit = $FS::UID::AutoCommit;
355 local $FS::UID::AutoCommit = 0;
358 my $cust_bill_pkg_void = new FS::cust_bill_pkg_void ( {
359 map { $_ => $self->get($_) } $self->fields
361 $cust_bill_pkg_void->reasonnum($reason->reasonnum) if $reason;
362 my $error = $cust_bill_pkg_void->insert;
364 $dbh->rollback if $oldAutoCommit;
368 #more efficiently than below, because there could be lots
369 $self->void_cust_bill_pkg_detail($reprocess_cdrs);
371 foreach my $table (qw(
372 cust_bill_pkg_display
373 cust_bill_pkg_discount
374 cust_bill_pkg_tax_location
375 cust_bill_pkg_tax_rate_location
379 foreach my $linked ( qsearch($table, { billpkgnum=>$self->billpkgnum }) ) {
381 my $vclass = 'FS::'.$table.'_void';
382 my $void = $vclass->new( {
383 map { $_ => $linked->get($_) } $linked->fields
385 my $error = $void->insert || $linked->delete;
387 $dbh->rollback if $oldAutoCommit;
395 $error = $self->delete;
397 $dbh->rollback if $oldAutoCommit;
401 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
407 sub void_cust_bill_pkg_detail {
408 my( $self, $reprocess_cdrs ) = @_;
410 my $from_cust_bill_pkg_detail =
411 'FROM cust_bill_pkg_detail WHERE billpkgnum = ?';
412 my $where_detailnum =
413 "WHERE detailnum IN ( SELECT detailnum $from_cust_bill_pkg_detail )";
415 if ( $reprocess_cdrs ) {
416 #well, technically this could have been on other invoices / termination
417 # partners... separate flag?
419 "DELETE FROM cdr_termination
420 WHERE acctid IN ( SELECT acctid FROM cdr $where_detailnum )
426 my $setstatus = $reprocess_cdrs ? ', freesidestatus = NULL' : '';
428 "UPDATE cdr SET detailnum = NULL $setstatus $where_detailnum",
432 $self->scalar_sql("INSERT INTO cust_bill_pkg_detail_void
433 SELECT * $from_cust_bill_pkg_detail",
437 $self->scalar_sql("DELETE $from_cust_bill_pkg_detail", $self->billpkgnum);
450 local $SIG{HUP} = 'IGNORE';
451 local $SIG{INT} = 'IGNORE';
452 local $SIG{QUIT} = 'IGNORE';
453 local $SIG{TERM} = 'IGNORE';
454 local $SIG{TSTP} = 'IGNORE';
455 local $SIG{PIPE} = 'IGNORE';
457 my $oldAutoCommit = $FS::UID::AutoCommit;
458 local $FS::UID::AutoCommit = 0;
461 foreach my $table (qw(
463 cust_bill_pkg_display
464 cust_bill_pkg_discount
465 cust_bill_pkg_tax_location
466 cust_bill_pkg_tax_rate_location
473 foreach my $linked ( qsearch($table, { billpkgnum=>$self->billpkgnum }) ) {
474 my $error = $linked->delete;
476 $dbh->rollback if $oldAutoCommit;
483 foreach my $cust_tax_adjustment (
484 qsearch('cust_tax_adjustment', { billpkgnum=>$self->billpkgnum })
486 $cust_tax_adjustment->billpkgnum(''); #NULL
487 my $error = $cust_tax_adjustment->replace;
489 $dbh->rollback if $oldAutoCommit;
494 my $error = $self->SUPER::delete(@_);
496 $dbh->rollback if $oldAutoCommit;
500 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
506 #alas, bin/follow-tax-rename
508 #=item replace OLD_RECORD
510 #Currently unimplemented. This would be even more of an accounting nightmare
511 #than deleteing the items. Just don't do it.
516 # return "Can't modify cust_bill_pkg records!";
521 Checks all fields to make sure this is a valid line item. If there is an
522 error, returns the error, otherwise returns false. Called by the insert
531 $self->ut_numbern('billpkgnum')
532 || $self->ut_snumber('pkgnum')
533 || $self->ut_number('invnum')
534 || $self->ut_money('setup')
535 || $self->ut_moneyn('unitsetup')
536 || $self->ut_currencyn('setup_billed_currency')
537 || $self->ut_moneyn('setup_billed_amount')
538 || $self->ut_money('recur')
539 || $self->ut_moneyn('unitrecur')
540 || $self->ut_currencyn('recur_billed_currency')
541 || $self->ut_moneyn('recur_billed_amount')
542 || $self->ut_numbern('sdate')
543 || $self->ut_numbern('edate')
544 || $self->ut_textn('itemdesc')
545 || $self->ut_textn('itemcomment')
546 || $self->ut_enum('hidden', [ '', 'Y' ])
548 return $error if $error;
550 $self->regularize_details;
552 #if ( $self->pkgnum != 0 ) { #allow unchecked pkgnum 0 for tax! (add to part_pkg?)
553 if ( $self->pkgnum > 0 ) { #allow -1 for non-pkg line items and 0 for tax (add to part_pkg?)
554 return "Unknown pkgnum ". $self->pkgnum
555 unless qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
558 return "Unknown invnum"
559 unless qsearchs( 'cust_bill' ,{ 'invnum' => $self->invnum } );
564 =item regularize_details
566 Converts the contents of the 'details' pseudo-field to
567 L<FS::cust_bill_pkg_detail> objects, if they aren't already.
571 sub regularize_details {
573 if ( $self->get('details') ) {
574 foreach my $detail ( @{$self->get('details')} ) {
575 if ( ref($detail) ne 'FS::cust_bill_pkg_detail' ) {
576 # then turn it into one
578 if ( ! ref($detail) ) {
579 $hash{'detail'} = $detail;
581 elsif ( ref($detail) eq 'HASH' ) {
584 elsif ( ref($detail) eq 'ARRAY' ) {
585 carp "passing invoice details as arrays is deprecated";
586 #carp "this way sucks, use a hash"; #but more useful/friendly
587 $hash{'format'} = $detail->[0];
588 $hash{'detail'} = $detail->[1];
589 $hash{'amount'} = $detail->[2];
590 $hash{'classnum'} = $detail->[3];
591 $hash{'phonenum'} = $detail->[4];
592 $hash{'accountcode'} = $detail->[5];
593 $hash{'startdate'} = $detail->[6];
594 $hash{'duration'} = $detail->[7];
595 $hash{'regionname'} = $detail->[8];
598 die "unknown detail type ". ref($detail);
600 $detail = new FS::cust_bill_pkg_detail \%hash;
602 $detail->billpkgnum($self->billpkgnum) if $self->billpkgnum;
608 =item set_exemptions TAXOBJECT, OPTIONS
610 Sets up tax exemptions. TAXOBJECT is the L<FS::cust_main_county> or
611 L<FS::tax_rate> record for the tax.
613 This will deal with the following cases:
617 =item Fully exempt customers (cust_main.tax flag) or customer classes
620 =item Customers exempt from specific named taxes (cust_main_exemption
623 =item Taxes that don't apply to setup or recurring fees
624 (cust_main_county.setuptax and recurtax, tax_rate.setuptax and recurtax).
626 =item Packages that are marked as tax-exempt (part_pkg.setuptax,
629 =item Fees that aren't marked as taxable (part_fee.taxable).
633 It does NOT deal with monthly tax exemptions, which need more context
634 than this humble little method cares to deal with.
636 OPTIONS should include "custnum" => the customer number if this tax line
637 hasn't been inserted (which it probably hasn't).
639 Returns a list of exemption objects, which will also be attached to the
640 line item as the 'cust_tax_exempt_pkg' pseudo-field. Inserting the line
641 item will insert these records as well.
650 my $part_pkg = $self->part_pkg;
651 my $part_fee = $self->part_fee;
654 my $custnum = $opt{custnum};
655 $custnum ||= $self->cust_bill->custnum if $self->cust_bill;
657 $cust_main = FS::cust_main->by_key( $custnum )
658 or die "set_exemptions can't identify customer (pass custnum option)\n";
661 my $taxable_charged = $self->setup + $self->recur;
662 return unless $taxable_charged > 0;
664 ### Fully exempt customer ###
666 my $conf = FS::Conf->new;
667 if ( $conf->exists('cust_class-tax_exempt') ) {
668 my $cust_class = $cust_main->cust_class;
669 $exempt_cust = $cust_class->tax if $cust_class;
671 $exempt_cust = $cust_main->tax;
674 ### Exemption from named tax ###
675 my $exempt_cust_taxname;
676 if ( !$exempt_cust and $tax->taxname ) {
677 $exempt_cust_taxname = $cust_main->tax_exemption($tax->taxname);
680 if ( $exempt_cust ) {
682 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
683 amount => $taxable_charged,
686 $taxable_charged = 0;
688 } elsif ( $exempt_cust_taxname ) {
690 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
691 amount => $taxable_charged,
692 exempt_cust_taxname => 'Y',
694 $taxable_charged = 0;
698 my $exempt_setup = ( ($part_fee and not $part_fee->taxable)
699 or ($part_pkg and $part_pkg->setuptax)
704 and $taxable_charged > 0 ) {
706 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
707 amount => $self->setup,
710 $taxable_charged -= $self->setup;
714 my $exempt_recur = ( ($part_fee and not $part_fee->taxable)
715 or ($part_pkg and $part_pkg->recurtax)
720 and $taxable_charged > 0 ) {
722 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
723 amount => $self->recur,
726 $taxable_charged -= $self->recur;
730 foreach (@new_exemptions) {
731 $_->set('taxnum', $tax->taxnum);
732 $_->set('taxtype', ref($tax));
735 push @{ $self->cust_tax_exempt_pkg }, @new_exemptions;
736 return @new_exemptions;
742 Returns the invoice (see L<FS::cust_bill>) for this invoice line item.
746 Returns the customer (L<FS::cust_main> object) for this line item.
751 carp "->cust_main called" if $DEBUG;
752 # required for cust_main_Mixin equivalence
753 # and use cust_bill instead of cust_pkg because this might not have a
756 my $cust_bill = $self->cust_bill or return '';
757 $cust_bill->cust_main;
760 =item previous_cust_bill_pkg
762 Returns the previous cust_bill_pkg for this package, if any.
766 sub previous_cust_bill_pkg {
768 return unless $self->sdate;
770 'table' => 'cust_bill_pkg',
771 'hashref' => { 'pkgnum' => $self->pkgnum,
772 'sdate' => { op=>'<', value=>$self->sdate },
774 'order_by' => 'ORDER BY sdate DESC LIMIT 1',
780 Returns the amount owed (still outstanding) on this line item's setup fee,
781 which is the amount of the line item minus all payment applications (see
782 L<FS::cust_bill_pay_pkg> and credit applications (see
783 L<FS::cust_credit_bill_pkg>).
789 $self->owed('setup', @_);
794 Returns the amount owed (still outstanding) on this line item's recurring fee,
795 which is the amount of the line item minus all payment applications (see
796 L<FS::cust_bill_pay_pkg> and credit applications (see
797 L<FS::cust_credit_bill_pkg>).
803 $self->owed('recur', @_);
806 # modeled after cust_bill::owed...
808 my( $self, $field ) = @_;
809 my $balance = $self->$field();
810 $balance -= $_->amount foreach ( $self->cust_bill_pay_pkg($field) );
811 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) );
812 $balance = sprintf( '%.2f', $balance );
813 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
819 my( $self, $field ) = @_;
820 my $balance = $self->$field();
821 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) );
822 $balance = sprintf( '%.2f', $balance );
823 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
827 sub cust_bill_pay_pkg {
828 my( $self, $field ) = @_;
829 qsearch( 'cust_bill_pay_pkg', { 'billpkgnum' => $self->billpkgnum,
830 'setuprecur' => $field,
835 sub cust_credit_bill_pkg {
836 my( $self, $field ) = @_;
837 qsearch( 'cust_credit_bill_pkg', { 'billpkgnum' => $self->billpkgnum,
838 'setuprecur' => $field,
845 Returns the number of billing units (for tax purposes) represented by this,
852 $self->pkgnum ? $self->part_pkg->calc_units($self->cust_pkg) : 0; # 1?
857 If this item has any discounts, returns a hashref in the format used
858 by L<FS::Template_Mixin/_items_cust_bill_pkg> to describe the discount(s)
859 on an invoice. This will contain the keys 'description', 'amount',
860 'ext_description' (an arrayref of text lines describing the discounts),
861 and '_is_discount' (a flag).
863 The value for 'amount' will be negative, and will be scaled for the package
872 my $d; # this will be returned.
874 my @pkg_discounts = $self->pkg_discount;
875 if (@pkg_discounts) {
876 # special case: if there are old "discount details" on this line item,
877 # don't show discount line items
878 if ( FS::cust_bill_pkg_detail->count("detail LIKE 'Includes discount%' AND billpkgnum = ?", $self->billpkgnum || 0) > 0 ) {
885 description => $self->mt('Discount'),
888 ext_description => \@ext,
889 pkgpart => $self->pkgpart,
890 feepart => $self->feepart,
891 # maybe should show quantity/unit discount?
893 foreach my $pkg_discount (@pkg_discounts) {
894 push @ext, $pkg_discount->description;
895 my $setuprecur = $pkg_discount->cust_pkg_discount->setuprecur;
896 $d->{$setuprecur.'_amount'} -= $pkg_discount->amount;
900 # show introductory rate as a pseudo-discount
901 if (!$d) { # this will conflict with showing real discounts
902 my $part_pkg = $self->part_pkg;
903 if ( $part_pkg and $part_pkg->option('show_as_discount',1) ) {
904 my $cust_pkg = $self->cust_pkg;
905 my $intro_end = $part_pkg->intro_end($cust_pkg);
906 my $_date = $self->cust_bill->_date;
907 if ( $intro_end > $_date ) {
908 $d = $part_pkg->item_discount($cust_pkg);
914 $d->{setup_amount} *= $self->quantity || 1; # ??
915 $d->{recur_amount} *= $self->quantity || 1; # ??
921 =item set_display OPTION => VALUE ...
923 A helper method for I<insert>, populates the pseudo-field B<display> with
924 appropriate FS::cust_bill_pkg_display objects.
926 Options are passed as a list of name/value pairs. Options are:
928 part_pkg: FS::part_pkg object from this line item's package.
930 real_pkgpart: if this line item comes from a bundled package, the pkgpart
931 of the owning package. Otherwise the same as the part_pkg's pkgpart above.
936 my( $self, %opt ) = @_;
937 my $part_pkg = $opt{'part_pkg'};
938 my $cust_pkg = new FS::cust_pkg { pkgpart => $opt{real_pkgpart} };
940 my $conf = new FS::Conf;
942 # whether to break this down into setup/recur/usage
943 my $separate = $conf->exists('separate_usage');
945 my $usage_mandate = $part_pkg->option('usage_mandate', 'Hush!')
946 || $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
948 # or use the category from $opt{'part_pkg'} if its not bundled?
949 my $categoryname = $cust_pkg->part_pkg->categoryname;
951 # if we don't have to separate setup/recur/usage, or put this in a
952 # package-specific section, or display a usage summary, then don't
953 # even create one of these. The item will just display in the unnamed
954 # section as a single line plus details.
955 return $self->set('display', [])
956 unless $separate || $categoryname || $usage_mandate;
960 my %hash = ( 'section' => $categoryname );
962 # whether to put usage details in a separate section, and if so, which one
963 my $usage_section = $part_pkg->option('usage_section', 'Hush!')
964 || $cust_pkg->part_pkg->option('usage_section', 'Hush!');
966 # whether to show a usage summary line (total usage charges, no details)
967 my $summary = $part_pkg->option('summarize_usage', 'Hush!')
968 || $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
971 # create lines for setup and (non-usage) recur, in the main section
972 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
973 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
975 # display everything in a single line
976 push @display, new FS::cust_bill_pkg_display
979 # and if usage_mandate is enabled, hide details
980 # (this only works on multisection invoices...)
981 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
985 if ($separate && $usage_section && $summary) {
986 # create a line for the usage summary in the main section
987 push @display, new FS::cust_bill_pkg_display { type => 'U',
993 if ($usage_mandate || ($usage_section && $summary) ) {
994 $hash{post_total} = 'Y';
997 if ($separate || $usage_mandate) {
998 # show call details for this line item in the usage section.
999 # if usage_mandate is on, this will display below the section subtotal.
1000 # this also happens if usage is in a separate section and there's a
1001 # summary in the main section, though I'm not sure why.
1002 $hash{section} = $usage_section if $usage_section;
1003 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1006 $self->set('display', \@display);
1012 Returns a hash: keys are "setup", "recur" or usage classnum, values are
1013 FS::cust_bill_pkg objects, each with no more than a single class (setup or
1020 # XXX this goes away with cust_bill_pkg refactor
1021 # or at least I wish it would, but it turns out to be harder than
1024 #my $cust_bill_pkg = new FS::cust_bill_pkg { $self->hash }; # wha huh?
1025 my %cust_bill_pkg = ();
1028 foreach my $classnum ($self->usage_classes) {
1029 my $amount = $self->usage($classnum);
1030 next if $amount == 0; # though if so we shouldn't be here
1031 my $usage_item = FS::cust_bill_pkg->new({
1035 'taxclass' => $classnum,
1038 $cust_bill_pkg{$classnum} = $usage_item;
1039 $usage_total += $amount;
1042 foreach (qw(setup recur)) {
1043 next if ($self->get($_) == 0);
1044 my $item = FS::cust_bill_pkg->new({
1051 $item->set($_, $self->get($_));
1052 $cust_bill_pkg{$_} = $item;
1056 $cust_bill_pkg{recur}->set('recur',
1057 sprintf('%.2f', $cust_bill_pkg{recur}->get('recur') - $usage_total)
1064 =item usage CLASSNUM
1066 Returns the amount of the charge associated with usage class CLASSNUM if
1067 CLASSNUM is defined. Otherwise returns the total charge associated with
1073 my( $self, $classnum ) = @_;
1074 $self->regularize_details;
1076 if ( $self->get('details') ) {
1079 map { $_->amount || 0 }
1080 grep { !defined($classnum) or $classnum eq $_->classnum }
1081 @{ $self->get('details') }
1086 my $sql = 'SELECT SUM(COALESCE(amount,0)) FROM cust_bill_pkg_detail '.
1087 ' WHERE billpkgnum = '. $self->billpkgnum;
1088 if (defined $classnum) {
1089 if ($classnum =~ /^(\d+)$/) {
1090 $sql .= " AND classnum = $1";
1091 } elsif ($classnum eq '') {
1092 $sql .= " AND classnum IS NULL";
1096 my $sth = dbh->prepare($sql) or die dbh->errstr;
1097 $sth->execute or die $sth->errstr;
1099 return $sth->fetchrow_arrayref->[0] || 0;
1107 Returns a list of usage classnums associated with this invoice line's
1114 $self->regularize_details;
1116 if ( $self->get('details') ) {
1118 my %seen = ( map { $_->classnum => 1 } @{ $self->get('details') } );
1123 map { $_->classnum }
1124 qsearch({ table => 'cust_bill_pkg_detail',
1125 hashref => { billpkgnum => $self->billpkgnum },
1126 select => 'DISTINCT classnum',
1133 sub cust_tax_exempt_pkg {
1136 my $array = $self->{Hash}->{cust_tax_exempt_pkg} ||= [];
1139 =item cust_bill_pkg_tax_Xlocation
1141 Returns the list of associated cust_bill_pkg_tax_location and/or
1142 cust_bill_pkg_tax_rate_location objects
1146 sub cust_bill_pkg_tax_Xlocation {
1149 my %hash = ( 'billpkgnum' => $self->billpkgnum );
1152 qsearch ( 'cust_bill_pkg_tax_location', { %hash } ),
1153 qsearch ( 'cust_bill_pkg_tax_rate_location', { %hash } )
1158 =item recur_show_zero
1160 Whether to show a zero recurring amount. This is true if the package or its
1161 definition has the recur_show_zero flag, and the recurring fee is actually
1162 zero for this period.
1166 sub recur_show_zero {
1167 my( $self, $what ) = @_;
1169 return 0 unless $self->get('recur') == 0 && $self->pkgnum;
1171 $self->cust_pkg->_X_show_zero('recur');
1174 =item setup_show_zero
1176 Whether to show a zero setup charge. This requires the package or its
1177 definition to have the setup_show_zero flag, but it also returns false if
1178 the package's setup date is before this line item's start date.
1182 sub setup_show_zero {
1184 return 0 unless $self->get('setup') == 0 && $self->pkgnum;
1185 my $cust_pkg = $self->cust_pkg;
1186 return 0 if ( $self->sdate || 0 ) > ( $cust_pkg->setup || 0 );
1187 return $cust_pkg->_X_show_zero('setup');
1190 =item credited [ BEFORE, AFTER, OPTIONS ]
1192 Returns the sum of credits applied to this item. Arguments are the same as
1193 owed_sql/paid_sql/credited_sql.
1199 $self->scalar_sql('SELECT '. $self->credited_sql(@_).' FROM cust_bill_pkg WHERE billpkgnum = ?', $self->billpkgnum);
1202 =item tax_locationnum
1204 Returns the L<FS::cust_location> number that this line item is in for tax
1205 purposes. For package sales, it's the package tax location; for fees,
1206 it's the customer's default service location.
1210 sub tax_locationnum {
1212 if ( $self->pkgnum ) { # normal sales
1213 return $self->cust_pkg->tax_locationnum;
1214 } elsif ( $self->feepart ) { # fees
1215 my $custnum = $self->fee_origin->custnum;
1217 return FS::cust_main->by_key($custnum)->ship_locationnum;
1226 if ( $self->pkgnum ) { # normal sales
1227 return $self->cust_pkg->tax_location;
1228 } elsif ( $self->feepart ) { # fees
1229 my $fee_origin = $self->fee_origin;
1230 if ( $fee_origin ) {
1231 my $custnum = $fee_origin->custnum;
1233 return FS::cust_main->by_key($custnum)->ship_location;
1243 =head1 CLASS METHODS
1249 Returns an SQL expression for the total usage charges in details on
1255 '(SELECT COALESCE(SUM(cust_bill_pkg_detail.amount),0)
1256 FROM cust_bill_pkg_detail
1257 WHERE cust_bill_pkg_detail.billpkgnum = cust_bill_pkg.billpkgnum)';
1259 sub usage_sql { $usage_sql }
1261 # this makes owed_sql, etc. much more concise
1263 my ($class, $start, $end, %opt) = @_;
1264 my $setuprecur = $opt{setuprecur} || '';
1266 $setuprecur =~ /^s/ ? 'cust_bill_pkg.setup' :
1267 $setuprecur =~ /^r/ ? 'cust_bill_pkg.recur' :
1268 'cust_bill_pkg.setup + cust_bill_pkg.recur';
1270 if ($opt{no_usage} and $charged =~ /recur/) {
1271 $charged = "$charged - $usage_sql"
1278 =item owed_sql [ BEFORE, AFTER, OPTIONS ]
1280 Returns an SQL expression for the amount owed. BEFORE and AFTER specify
1281 a date window. OPTIONS may include 'no_usage' (excludes usage charges)
1282 and 'setuprecur' (set to "setup" or "recur" to limit to one or the other).
1288 '(' . $class->charged_sql(@_) .
1289 ' - ' . $class->paid_sql(@_) .
1290 ' - ' . $class->credited_sql(@_) . ')'
1293 =item paid_sql [ BEFORE, AFTER, OPTIONS ]
1295 Returns an SQL expression for the sum of payments applied to this item.
1300 my ($class, $start, $end, %opt) = @_;
1301 my $s = $start ? "AND cust_pay._date <= $start" : '';
1302 my $e = $end ? "AND cust_pay._date > $end" : '';
1303 my $setuprecur = $opt{setuprecur} || '';
1304 $setuprecur = 'setup' if $setuprecur =~ /^s/;
1305 $setuprecur = 'recur' if $setuprecur =~ /^r/;
1306 $setuprecur &&= "AND setuprecur = '$setuprecur'";
1308 my $paid = "( SELECT COALESCE(SUM(cust_bill_pay_pkg.amount),0)
1309 FROM cust_bill_pay_pkg JOIN cust_bill_pay USING (billpaynum)
1310 JOIN cust_pay USING (paynum)
1311 WHERE cust_bill_pay_pkg.billpkgnum = cust_bill_pkg.billpkgnum
1312 $s $e $setuprecur )";
1314 if ( $opt{no_usage} ) {
1315 # cap the amount paid at the sum of non-usage charges,
1316 # minus the amount credited against non-usage charges
1318 $class->charged_sql($start, $end, %opt) . ' - ' .
1319 $class->credited_sql($start, $end, %opt).')';
1328 my ($class, $start, $end, %opt) = @_;
1329 my $s = $start ? "AND cust_credit._date <= $start" : '';
1330 my $e = $end ? "AND cust_credit._date > $end" : '';
1331 my $setuprecur = $opt{setuprecur} || '';
1332 $setuprecur = 'setup' if $setuprecur =~ /^s/;
1333 $setuprecur = 'recur' if $setuprecur =~ /^r/;
1334 $setuprecur &&= "AND setuprecur = '$setuprecur'";
1336 my $credited = "( SELECT COALESCE(SUM(cust_credit_bill_pkg.amount),0)
1337 FROM cust_credit_bill_pkg JOIN cust_credit_bill USING (creditbillnum)
1338 JOIN cust_credit USING (crednum)
1339 WHERE cust_credit_bill_pkg.billpkgnum = cust_bill_pkg.billpkgnum
1340 $s $e $setuprecur )";
1342 if ( $opt{no_usage} ) {
1343 # cap the amount credited at the sum of non-usage charges
1344 "LEAST($credited, ". $class->charged_sql($start, $end, %opt).')';
1352 sub upgrade_tax_location {
1353 # For taxes that were calculated/invoiced before cust_location refactoring
1354 # (May-June 2012), there are no cust_bill_pkg_tax_location records unless
1355 # they were calculated on a package-location basis. Create them here,
1356 # along with any necessary cust_location records and any tax exemption
1359 my ($class, %opt) = @_;
1360 # %opt may include 's' and 'e': start and end date ranges
1361 # and 'X': abort on any error, instead of just rolling back changes to
1364 my $oldAutoCommit = $FS::UID::AutoCommit;
1365 local $FS::UID::AutoCommit = 0;
1368 use FS::h_cust_main;
1369 use FS::h_cust_bill;
1371 use FS::h_cust_main_exemption;
1374 local $FS::cust_location::import = 1;
1376 my $conf = FS::Conf->new; # h_conf?
1377 return if $conf->config('tax_data_vendor'); #don't touch this case
1378 my $use_ship = $conf->exists('tax-ship_address');
1379 my $use_pkgloc = $conf->exists('tax-pkg_address');
1381 my $date_where = '';
1383 $date_where .= " AND cust_bill._date >= $opt{s}";
1386 $date_where .= " AND cust_bill._date < $opt{e}";
1389 my $commit_each_invoice = 1 unless $opt{X};
1391 # if an invoice has either of these kinds of objects, then it doesn't
1392 # need to be upgraded...probably
1393 my $sub_has_tax_link = 'SELECT 1 FROM cust_bill_pkg_tax_location'.
1394 ' JOIN cust_bill_pkg USING (billpkgnum)'.
1395 ' WHERE cust_bill_pkg.invnum = cust_bill.invnum';
1396 my $sub_has_exempt = 'SELECT 1 FROM cust_tax_exempt_pkg'.
1397 ' JOIN cust_bill_pkg USING (billpkgnum)'.
1398 ' WHERE cust_bill_pkg.invnum = cust_bill.invnum'.
1399 ' AND exempt_monthly IS NULL';
1401 my %all_tax_names = (
1404 map { $_->taxname => 1 }
1405 qsearch('h_cust_main_county', { taxname => { op => '!=', value => '' }})
1408 my $search = FS::Cursor->new({
1409 table => 'cust_bill',
1411 extra_sql => "WHERE NOT EXISTS($sub_has_tax_link) ".
1412 "AND NOT EXISTS($sub_has_exempt) ".
1416 #print "Processing ".scalar(@invnums)." invoices...\n";
1420 while (my $cust_bill = $search->fetch) {
1421 my $invnum = $cust_bill->invnum;
1423 print STDERR "Invoice #$invnum\n";
1425 my %pkgpart_taxclass; # pkgpart => taxclass
1426 my %pkgpart_exempt_setup;
1427 my %pkgpart_exempt_recur;
1428 my $h_cust_bill = qsearchs('h_cust_bill',
1429 { invnum => $invnum,
1430 history_action => 'insert' });
1431 if (!$h_cust_bill) {
1432 warn "no insert record for invoice $invnum; skipped\n";
1433 #$date = $cust_bill->_date as a fallback?
1434 # We're trying to avoid using non-real dates (-d/-y invoice dates)
1435 # when looking up history records in other tables.
1438 my $custnum = $h_cust_bill->custnum;
1440 # Determine the address corresponding to this tax region.
1441 # It's either the bill or ship address of the customer as of the
1442 # invoice date-of-insertion. (Not necessarily the invoice date.)
1443 my $date = $h_cust_bill->history_date;
1444 local($FS::Record::qsearch_qualify_columns) = 0;
1445 my $h_cust_main = qsearchs('h_cust_main',
1446 { custnum => $custnum },
1447 FS::h_cust_main->sql_h_searchs($date)
1449 if (!$h_cust_main ) {
1450 warn "no historical address for cust#".$h_cust_bill->custnum."; skipped\n";
1452 # fallback to current $cust_main? sounds dangerous.
1455 # This is a historical customer record, so it has a historical address.
1456 # If there's no cust_location matching this custnum and address (there
1457 # probably isn't), create one.
1458 my %tax_loc; # keys are pkgnums, values are cust_location objects
1459 my $default_tax_loc;
1460 if ( $h_cust_main->bill_locationnum ) {
1461 # the location has already been upgraded
1463 $default_tax_loc = $h_cust_main->ship_location;
1465 $default_tax_loc = $h_cust_main->bill_location;
1468 $pre = 'ship_' if $use_ship and length($h_cust_main->get('ship_last'));
1469 my %hash = map { $_ => $h_cust_main->get($pre.$_) }
1470 FS::cust_main->location_fields;
1471 # not really needed for this, and often result in duplicate locations
1472 delete @hash{qw(censustract censusyear latitude longitude coord_auto)};
1474 $hash{custnum} = $h_cust_main->custnum;
1475 $default_tax_loc = FS::cust_location->new(\%hash);
1476 my $error = $default_tax_loc->find_or_insert || $default_tax_loc->disable_if_unused;
1478 warn "couldn't create historical location record for cust#".
1479 $h_cust_main->custnum.": $error\n";
1484 $exempt_cust = 1 if $h_cust_main->tax;
1486 # classify line items
1488 my %nontax_items; # taxclass => array of cust_bill_pkg
1489 foreach my $item ($h_cust_bill->cust_bill_pkg) {
1490 my $pkgnum = $item->pkgnum;
1492 if ( $pkgnum == 0 ) {
1494 push @tax_items, $item;
1497 # (pkgparts really shouldn't change, right?)
1498 local($FS::Record::qsearch_qualify_columns) = 0;
1499 my $h_cust_pkg = qsearchs('h_cust_pkg', { pkgnum => $pkgnum },
1500 FS::h_cust_pkg->sql_h_searchs($date)
1502 if ( !$h_cust_pkg ) {
1503 warn "no historical package #".$item->pkgpart."; skipped\n";
1506 my $pkgpart = $h_cust_pkg->pkgpart;
1508 if ( $use_pkgloc and $h_cust_pkg->locationnum ) {
1509 # then this package already had a locationnum assigned, and that's
1510 # the one to use for tax calculation
1511 $tax_loc{$pkgnum} = FS::cust_location->by_key($h_cust_pkg->locationnum);
1513 # use the customer's bill or ship loc, which was inserted earlier
1514 $tax_loc{$pkgnum} = $default_tax_loc;
1517 if (!exists $pkgpart_taxclass{$pkgpart}) {
1518 local($FS::Record::qsearch_qualify_columns) = 0;
1519 my $h_part_pkg = qsearchs('h_part_pkg', { pkgpart => $pkgpart },
1520 FS::h_part_pkg->sql_h_searchs($date)
1522 if ( !$h_part_pkg ) {
1523 warn "no historical package def #$pkgpart; skipped\n";
1526 $pkgpart_taxclass{$pkgpart} = $h_part_pkg->taxclass || '';
1527 $pkgpart_exempt_setup{$pkgpart} = 1 if $h_part_pkg->setuptax;
1528 $pkgpart_exempt_recur{$pkgpart} = 1 if $h_part_pkg->recurtax;
1531 # mark any exemptions that apply
1532 if ( $pkgpart_exempt_setup{$pkgpart} ) {
1533 $item->set('exempt_setup' => 1);
1536 if ( $pkgpart_exempt_recur{$pkgpart} ) {
1537 $item->set('exempt_recur' => 1);
1540 my $taxclass = $pkgpart_taxclass{ $pkgpart };
1542 $nontax_items{$taxclass} ||= [];
1543 push @{ $nontax_items{$taxclass} }, $item;
1547 printf("%d tax items: \$%.2f\n", scalar(@tax_items), map {$_->setup} @tax_items)
1550 # Get any per-customer taxname exemptions that were in effect.
1551 my %exempt_cust_taxname;
1552 foreach (keys %all_tax_names) {
1553 local($FS::Record::qsearch_qualify_columns) = 0;
1554 my $h_exemption = qsearchs('h_cust_main_exemption', {
1555 'custnum' => $custnum,
1558 FS::h_cust_main_exemption->sql_h_searchs($date, $date)
1561 $exempt_cust_taxname{ $_ } = 1;
1565 # Use a variation on the procedure in
1566 # FS::cust_main::Billing::_handle_taxes to identify taxes that apply
1568 my @loc_keys = qw( district city county state country );
1569 my %taxdef_by_name; # by name, and then by taxclass
1570 my %est_tax; # by name, and then by taxclass
1571 my %taxable_items; # by taxnum, and then an array
1573 foreach my $taxclass (keys %nontax_items) {
1574 foreach my $orig_item (@{ $nontax_items{$taxclass} }) {
1575 my $my_tax_loc = $tax_loc{ $orig_item->pkgnum };
1576 my %myhash = map { $_ => $my_tax_loc->get($pre.$_) } @loc_keys;
1577 my @elim = qw( district city county state );
1578 my @taxdefs; # because there may be several with different taxnames
1580 $myhash{taxclass} = $taxclass;
1581 @taxdefs = qsearch('cust_main_county', \%myhash);
1583 $myhash{taxclass} = '';
1584 @taxdefs = qsearch('cust_main_county', \%myhash);
1586 $myhash{ shift @elim } = '';
1587 } while scalar(@elim) and !@taxdefs;
1589 foreach my $taxdef (@taxdefs) {
1590 next if $taxdef->tax == 0;
1591 $taxdef_by_name{$taxdef->taxname}{$taxdef->taxclass} = $taxdef;
1593 $taxable_items{$taxdef->taxnum} ||= [];
1594 # clone the item so that taxdef-dependent changes don't
1595 # change it for other taxdefs
1596 my $item = FS::cust_bill_pkg->new({ $orig_item->hash });
1598 # these flags are already set if the part_pkg declares itself exempt
1599 $item->set('exempt_setup' => 1) if $taxdef->setuptax;
1600 $item->set('exempt_recur' => 1) if $taxdef->recurtax;
1603 my $taxable = $item->setup + $item->recur;
1605 # h_cust_credit_bill_pkg?
1606 # NO. Because if these exemptions HAD been created at the time of
1607 # billing, and then a credit applied later, the exemption would
1608 # have been adjusted by the amount of the credit. So we adjust
1609 # the taxable amount before creating the exemption.
1610 # But don't deduct the credit from taxable, because the tax was
1611 # calculated before the credit was applied.
1612 foreach my $f (qw(setup recur)) {
1613 my $credited = FS::Record->scalar_sql(
1614 "SELECT SUM(amount) FROM cust_credit_bill_pkg ".
1615 "WHERE billpkgnum = ? AND setuprecur = ?",
1619 $item->set($f, $item->get($f) - $credited) if $credited;
1621 my $existing_exempt = FS::Record->scalar_sql(
1622 "SELECT SUM(amount) FROM cust_tax_exempt_pkg WHERE ".
1623 "billpkgnum = ? AND taxnum = ?",
1624 $item->billpkgnum, $taxdef->taxnum
1626 $taxable -= $existing_exempt;
1628 if ( $taxable and $exempt_cust ) {
1629 push @new_exempt, { exempt_cust => 'Y', amount => $taxable };
1632 if ( $taxable and $exempt_cust_taxname{$taxdef->taxname} ){
1633 push @new_exempt, { exempt_cust_taxname => 'Y', amount => $taxable };
1636 if ( $taxable and $item->exempt_setup ) {
1637 push @new_exempt, { exempt_setup => 'Y', amount => $item->setup };
1638 $taxable -= $item->setup;
1640 if ( $taxable and $item->exempt_recur ) {
1641 push @new_exempt, { exempt_recur => 'Y', amount => $item->recur };
1642 $taxable -= $item->recur;
1645 $item->set('taxable' => $taxable);
1646 push @{ $taxable_items{$taxdef->taxnum} }, $item
1649 # estimate the amount of tax (this is necessary because different
1650 # taxdefs with the same taxname may have different tax rates)
1651 # and sum that for each taxname/taxclass combination
1653 $est_tax{$taxdef->taxname} ||= {};
1654 $est_tax{$taxdef->taxname}{$taxdef->taxclass} ||= 0;
1655 $est_tax{$taxdef->taxname}{$taxdef->taxclass} +=
1656 $taxable * $taxdef->tax;
1658 foreach (@new_exempt) {
1659 next if $_->{amount} == 0;
1660 my $cust_tax_exempt_pkg = FS::cust_tax_exempt_pkg->new({
1662 billpkgnum => $item->billpkgnum,
1663 taxnum => $taxdef->taxnum,
1665 my $error = $cust_tax_exempt_pkg->insert;
1667 my $pkgnum = $item->pkgnum;
1668 warn "error creating tax exemption for inv$invnum pkg$pkgnum:".
1672 } #foreach @new_exempt
1675 } #foreach $taxclass
1677 # Now go through the billed taxes and match them up with the line items.
1678 TAX_ITEM: foreach my $tax_item ( @tax_items )
1680 my $taxname = $tax_item->itemdesc;
1681 $taxname = '' if $taxname eq 'Tax';
1683 if ( !exists( $taxdef_by_name{$taxname} ) ) {
1684 # then we didn't find any applicable taxes with this name
1685 warn "no definition found for tax item '$taxname', custnum $custnum\n";
1686 # possibly all of these should be "next TAX_ITEM", but whole invoices
1687 # are transaction protected and we can go back and retry them.
1690 # classname => cust_main_county
1691 my %taxdef_by_class = %{ $taxdef_by_name{$taxname} };
1693 # Divide the tax item among taxclasses, if necessary
1694 # classname => estimated tax amount
1695 my $this_est_tax = $est_tax{$taxname};
1696 if (!defined $this_est_tax) {
1697 warn "no taxable sales found for inv#$invnum, tax item '$taxname'.\n";
1700 my $est_total = sum(values %$this_est_tax);
1701 if ( $est_total == 0 ) {
1703 warn "estimated tax on invoice #$invnum is zero.\n";
1707 my $real_tax = $tax_item->setup;
1708 printf ("Distributing \$%.2f tax:\n", $real_tax);
1709 my $cents_remaining = $real_tax * 100; # for rounding error
1710 my @tax_links; # partial CBPTL hashrefs
1711 foreach my $taxclass (keys %taxdef_by_class) {
1712 my $taxdef = $taxdef_by_class{$taxclass};
1713 # these items already have "taxable" set to their charge amount
1714 # after applying any credits or exemptions
1715 my @items = @{ $taxable_items{$taxdef->taxnum} };
1716 my $subtotal = sum(map {$_->get('taxable')} @items);
1717 printf("\t$taxclass: %.2f\n", $this_est_tax->{$taxclass}/$est_total);
1719 foreach my $nontax (@items) {
1720 my $my_tax_loc = $tax_loc{ $nontax->pkgnum };
1721 my $part = int($real_tax
1723 * ($this_est_tax->{$taxclass}/$est_total)
1725 * ($nontax->get('taxable'))/$subtotal
1729 $cents_remaining -= $part;
1731 taxnum => $taxdef->taxnum,
1732 pkgnum => $nontax->pkgnum,
1733 locationnum => $my_tax_loc->locationnum,
1734 billpkgnum => $nontax->billpkgnum,
1738 } #foreach $taxclass
1739 # Distribute any leftover tax round-robin style, one cent at a time.
1741 my $nlinks = scalar(@tax_links);
1743 # ensure that it really is an integer
1744 $cents_remaining = sprintf('%.0f', $cents_remaining);
1745 while ($cents_remaining > 0) {
1746 $tax_links[$i % $nlinks]->{cents} += 1;
1751 warn "Can't create tax links--no taxable items found.\n";
1755 # Gather credit/payment applications so that we can link them
1758 qsearch( 'cust_credit_bill_pkg',
1759 { billpkgnum => $tax_item->billpkgnum, billpkgtaxlocationnum => '' }
1761 qsearch( 'cust_bill_pay_pkg',
1762 { billpkgnum => $tax_item->billpkgnum, billpkgtaxlocationnum => '' }
1766 # grab the first one
1767 my $this_unlinked = shift @unlinked;
1768 my $unlinked_cents = int($this_unlinked->amount * 100) if $this_unlinked;
1770 # Create tax links (yay!)
1771 printf("Creating %d tax links.\n",scalar(@tax_links));
1772 foreach (@tax_links) {
1773 my $link = FS::cust_bill_pkg_tax_location->new({
1774 billpkgnum => $tax_item->billpkgnum,
1775 taxtype => 'FS::cust_main_county',
1776 locationnum => $_->{locationnum},
1777 taxnum => $_->{taxnum},
1778 pkgnum => $_->{pkgnum},
1779 amount => sprintf('%.2f', $_->{cents} / 100),
1780 taxable_billpkgnum => $_->{billpkgnum},
1782 my $error = $link->insert;
1784 warn "Can't create tax link for inv#$invnum: $error\n";
1788 my $link_cents = $_->{cents};
1789 # update/create subitem links
1791 # If $this_unlinked is undef, then we've allocated all of the
1792 # credit/payment applications to the tax item. If $link_cents is 0,
1793 # then we've applied credits/payments to all of this package fraction,
1794 # so go on to the next.
1795 while ($this_unlinked and $link_cents) {
1796 # apply as much as possible of $link_amount to this credit/payment
1798 my $apply_cents = min($link_cents, $unlinked_cents);
1799 $link_cents -= $apply_cents;
1800 $unlinked_cents -= $apply_cents;
1801 # $link_cents or $unlinked_cents or both are now zero
1802 $this_unlinked->set('amount' => sprintf('%.2f',$apply_cents/100));
1803 $this_unlinked->set('billpkgtaxlocationnum' => $link->billpkgtaxlocationnum);
1804 my $pkey = $this_unlinked->primary_key; #creditbillpkgnum or billpaypkgnum
1805 if ( $this_unlinked->$pkey ) {
1806 # then it's an existing link--replace it
1807 $error = $this_unlinked->replace;
1809 $this_unlinked->insert;
1811 # what do we do with errors at this stage?
1813 warn "Error creating tax application link: $error\n";
1814 next INVOICE; # for lack of a better idea
1817 if ( $unlinked_cents == 0 ) {
1818 # then we've allocated all of this payment/credit application,
1819 # so grab the next one
1820 $this_unlinked = shift @unlinked;
1821 $unlinked_cents = int($this_unlinked->amount * 100) if $this_unlinked;
1822 } elsif ( $link_cents == 0 ) {
1823 # then we've covered all of this package tax fraction, so split
1824 # off a new application from this one
1825 $this_unlinked = $this_unlinked->new({
1826 $this_unlinked->hash,
1829 # $unlinked_cents is still what it is
1832 } #while $this_unlinked and $link_cents
1833 } #foreach (@tax_links)
1834 } #foreach $tax_item
1836 $dbh->commit if $commit_each_invoice and $oldAutoCommit;
1842 $dbh->rollback if $oldAutoCommit;
1843 die "Upgrade halted.\n" unless $commit_each_invoice;
1847 $dbh->commit if $oldAutoCommit and !$commit_each_invoice;
1852 # Return an array of hashrefs for each cust_bill_pkg_tax_location
1853 # applied to this bill for this cust_bill_pkg.pkgnum.
1856 # In some situations, this list will contain more tax records than the
1857 # ones directly related to $self->billpkgnum. The returned list contains
1858 # all records, for this bill, charged against this billpkgnum's pkgnum.
1860 # One must keep this in mind when using data returned by this method.
1862 # An unaddressed deficiency in the cust_bill_pkg_tax_location model makes
1863 # this necessary: When a linked-hidden package generates a tax/fee as a row
1864 # in cust_bill_pkg_tax_location, there is not enough information to surmise
1865 # with specificity which billpkgnum row represents the direct parent of the
1866 # the linked-hidden package's tax row. The closest we can get to this
1867 # backwards reassociation is to use the pkgnum. Therefore, when multiple
1868 # billpkgnum's appear with the same pkgnum, this method is going to return
1869 # the tax records for ALL of those billpkgnum's, not just $self->billpkgnum.
1871 # This could be addressed with an update to the model, and to the billing
1872 # routine that generates rows into cust_bill_pkg_tax_location. Perhaps a
1873 # column, link_billpkgnum or parent_billpkgnum, recording the link. I'm not
1874 # doing that now, because there would be no possible repair of data stored
1875 # historically prior to such a fix. I need _pkg_tax_list() to not be
1876 # broken for already-generated bills.
1878 # Any code you write relying on _pkg_tax_list() MUST be aware of, and
1879 # account for, the possible return of duplicated tax records returned
1880 # when method is called on multiple cust_bill_pkg_tax_location rows.
1881 # Duplicates can be identified by billpkgtaxlocationnum column.
1885 my $search_selector;
1886 if ( $self->pkgnum ) {
1888 # For taxes applied to normal billing items
1890 ' cust_bill_pkg_tax_location.pkgnum = '
1891 . dbh->quote( $self->pkgnum );
1893 } elsif ( $self->feepart ) {
1895 # For taxes applied to fees, when the fee is not attached to a package
1896 # i.e. late fees, billing events fees
1898 ' cust_bill_pkg_tax_location.taxable_billpkgnum = '
1899 . dbh->quote( $self->billpkgnum );
1902 warn "_pkg_tax_list() unhandled case breaking taxes into sections";
1903 warn "_pkg_tax_list() $_: ".$self->$_
1904 for qw(pkgnum billpkgnum feepart);
1909 billpkgtaxlocationnum => $_->billpkgtaxlocationnum,
1910 billpkgnum => $_->billpkgnum,
1911 taxnum => $_->taxnum,
1912 amount => $_->amount,
1913 taxname => $_->taxname,
1916 table => 'cust_bill_pkg_tax_location',
1918 LEFT JOIN cust_bill_pkg
1919 ON cust_bill_pkg.billpkgnum
1920 = cust_bill_pkg_tax_location.taxable_billpkgnum
1922 select => join( ', ', (qw|
1923 cust_bill_pkg.billpkgnum
1924 cust_bill_pkg_tax_location.billpkgtaxlocationnum
1925 cust_bill_pkg_tax_location.taxnum
1926 cust_bill_pkg_tax_location.amount
1930 ' cust_bill_pkg.invnum = ' . dbh->quote( $self->invnum ) .
1938 # Create a queue job to run upgrade_tax_location from January 1, 2012 to
1942 use Date::Parse 'str2time';
1945 my $upgrade = 'tax_location_2012';
1946 return if FS::upgrade_journal->is_done($upgrade);
1947 my $job = FS::queue->new({
1948 'job' => 'FS::cust_bill_pkg::upgrade_tax_location'
1950 # call it kind of like a class method, not that it matters much
1951 $job->insert($class, 's' => str2time('2012-01-01'));
1952 # if there's a customer location upgrade queued also, wait for it to
1954 my $location_job = qsearchs('queue', {
1955 job => 'FS::cust_main::Location::process_upgrade_location'
1957 if ( $location_job ) {
1958 $job->depend_insert($location_job->jobnum);
1960 # Then mark the upgrade as done, so that we don't queue the job twice
1961 # and somehow run two of them concurrently.
1962 FS::upgrade_journal->set_done($upgrade);
1963 # This upgrade now does the job of assigning taxable_billpkgnums to
1964 # cust_bill_pkg_tax_location, so set that task done also.
1965 FS::upgrade_journal->set_done('tax_location_taxable_billpkgnum');
1972 setup and recur shouldn't be separate fields. There should be one "amount"
1973 field and a flag to tell you if it is a setup/one-time fee or a recurring fee.
1975 A line item with both should really be two separate records (preserving
1976 sdate and edate for setup fees for recurring packages - that information may
1977 be valuable later). Invoice generation (cust_main::bill), invoice printing
1978 (cust_bill), tax reports (report_tax.cgi) and line item reports
1979 (cust_bill_pkg.cgi) would need to be updated.
1981 owed_setup and owed_recur could then be repaced by just owed, and
1982 cust_bill::open_cust_bill_pkg and
1983 cust_bill_ApplicationCommon::apply_to_lineitems could be simplified.
1985 The upgrade procedure is pretty sketchy.
1989 L<FS::Record>, L<FS::cust_bill>, L<FS::cust_pkg>, L<FS::cust_main>, schema.html
1990 from the base documentation.