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 #fix the invoice amount
496 my $cust_bill = $self->cust_bill;
497 $cust_bill->charged( $cust_bill->charged - $self->setup - $self->recur );
499 #not adding a cc surcharge, but this override lets us modify charged
500 $cust_bill->{'Hash'}{'cc_surcharge_replace_hack'} = 1;
502 my $error = $cust_bill->replace
503 || $self->SUPER::delete(@_);
505 $dbh->rollback if $oldAutoCommit;
509 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
515 #alas, bin/follow-tax-rename
517 #=item replace OLD_RECORD
519 #Currently unimplemented. This would be even more of an accounting nightmare
520 #than deleteing the items. Just don't do it.
525 # return "Can't modify cust_bill_pkg records!";
530 Checks all fields to make sure this is a valid line item. If there is an
531 error, returns the error, otherwise returns false. Called by the insert
540 $self->ut_numbern('billpkgnum')
541 || $self->ut_snumber('pkgnum')
542 || $self->ut_number('invnum')
543 || $self->ut_money('setup')
544 || $self->ut_moneyn('unitsetup')
545 || $self->ut_currencyn('setup_billed_currency')
546 || $self->ut_moneyn('setup_billed_amount')
547 || $self->ut_money('recur')
548 || $self->ut_moneyn('unitrecur')
549 || $self->ut_currencyn('recur_billed_currency')
550 || $self->ut_moneyn('recur_billed_amount')
551 || $self->ut_numbern('sdate')
552 || $self->ut_numbern('edate')
553 || $self->ut_textn('itemdesc')
554 || $self->ut_textn('itemcomment')
555 || $self->ut_enum('hidden', [ '', 'Y' ])
557 return $error if $error;
559 $self->regularize_details;
561 #if ( $self->pkgnum != 0 ) { #allow unchecked pkgnum 0 for tax! (add to part_pkg?)
562 if ( $self->pkgnum > 0 ) { #allow -1 for non-pkg line items and 0 for tax (add to part_pkg?)
563 return "Unknown pkgnum ". $self->pkgnum
564 unless qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
567 return "Unknown invnum"
568 unless qsearchs( 'cust_bill' ,{ 'invnum' => $self->invnum } );
573 =item regularize_details
575 Converts the contents of the 'details' pseudo-field to
576 L<FS::cust_bill_pkg_detail> objects, if they aren't already.
580 sub regularize_details {
582 if ( $self->get('details') ) {
583 foreach my $detail ( @{$self->get('details')} ) {
584 if ( ref($detail) ne 'FS::cust_bill_pkg_detail' ) {
585 # then turn it into one
587 if ( ! ref($detail) ) {
588 $hash{'detail'} = $detail;
590 elsif ( ref($detail) eq 'HASH' ) {
593 elsif ( ref($detail) eq 'ARRAY' ) {
594 carp "passing invoice details as arrays is deprecated";
595 #carp "this way sucks, use a hash"; #but more useful/friendly
596 $hash{'format'} = $detail->[0];
597 $hash{'detail'} = $detail->[1];
598 $hash{'amount'} = $detail->[2];
599 $hash{'classnum'} = $detail->[3];
600 $hash{'phonenum'} = $detail->[4];
601 $hash{'accountcode'} = $detail->[5];
602 $hash{'startdate'} = $detail->[6];
603 $hash{'duration'} = $detail->[7];
604 $hash{'regionname'} = $detail->[8];
607 die "unknown detail type ". ref($detail);
609 $detail = new FS::cust_bill_pkg_detail \%hash;
611 $detail->billpkgnum($self->billpkgnum) if $self->billpkgnum;
617 =item set_exemptions TAXOBJECT, OPTIONS
619 Sets up tax exemptions. TAXOBJECT is the L<FS::cust_main_county> or
620 L<FS::tax_rate> record for the tax.
622 This will deal with the following cases:
626 =item Fully exempt customers (cust_main.tax flag) or customer classes
629 =item Customers exempt from specific named taxes (cust_main_exemption
632 =item Taxes that don't apply to setup or recurring fees
633 (cust_main_county.setuptax and recurtax, tax_rate.setuptax and recurtax).
635 =item Packages that are marked as tax-exempt (part_pkg.setuptax,
638 =item Fees that aren't marked as taxable (part_fee.taxable).
642 It does NOT deal with monthly tax exemptions, which need more context
643 than this humble little method cares to deal with.
645 OPTIONS should include "custnum" => the customer number if this tax line
646 hasn't been inserted (which it probably hasn't).
648 Returns a list of exemption objects, which will also be attached to the
649 line item as the 'cust_tax_exempt_pkg' pseudo-field. Inserting the line
650 item will insert these records as well.
659 my $part_pkg = $self->part_pkg;
660 my $part_fee = $self->part_fee;
663 my $custnum = $opt{custnum};
664 $custnum ||= $self->cust_bill->custnum if $self->cust_bill;
666 $cust_main = FS::cust_main->by_key( $custnum )
667 or die "set_exemptions can't identify customer (pass custnum option)\n";
670 my $taxable_charged = $self->setup + $self->recur;
671 return unless $taxable_charged > 0;
673 ### Fully exempt customer ###
675 my $conf = FS::Conf->new;
676 if ( $conf->exists('cust_class-tax_exempt') ) {
677 my $cust_class = $cust_main->cust_class;
678 $exempt_cust = $cust_class->tax if $cust_class;
680 $exempt_cust = $cust_main->tax;
683 ### Exemption from named tax ###
684 my $exempt_cust_taxname;
685 if ( !$exempt_cust and $tax->taxname ) {
686 $exempt_cust_taxname = $cust_main->tax_exemption($tax->taxname);
689 if ( $exempt_cust ) {
691 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
692 amount => $taxable_charged,
695 $taxable_charged = 0;
697 } elsif ( $exempt_cust_taxname ) {
699 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
700 amount => $taxable_charged,
701 exempt_cust_taxname => 'Y',
703 $taxable_charged = 0;
707 my $exempt_setup = ( ($part_fee and not $part_fee->taxable)
708 or ($part_pkg and $part_pkg->setuptax)
713 and $taxable_charged > 0 ) {
715 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
716 amount => $self->setup,
719 $taxable_charged -= $self->setup;
723 my $exempt_recur = ( ($part_fee and not $part_fee->taxable)
724 or ($part_pkg and $part_pkg->recurtax)
729 and $taxable_charged > 0 ) {
731 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
732 amount => $self->recur,
735 $taxable_charged -= $self->recur;
739 foreach (@new_exemptions) {
740 $_->set('taxnum', $tax->taxnum);
741 $_->set('taxtype', ref($tax));
744 push @{ $self->cust_tax_exempt_pkg }, @new_exemptions;
745 return @new_exemptions;
751 Returns the invoice (see L<FS::cust_bill>) for this invoice line item.
755 Returns the customer (L<FS::cust_main> object) for this line item.
760 carp "->cust_main called" if $DEBUG;
761 # required for cust_main_Mixin equivalence
762 # and use cust_bill instead of cust_pkg because this might not have a
765 my $cust_bill = $self->cust_bill or return '';
766 $cust_bill->cust_main;
769 =item previous_cust_bill_pkg
771 Returns the previous cust_bill_pkg for this package, if any.
775 sub previous_cust_bill_pkg {
777 return unless $self->sdate;
779 'table' => 'cust_bill_pkg',
780 'hashref' => { 'pkgnum' => $self->pkgnum,
781 'sdate' => { op=>'<', value=>$self->sdate },
783 'order_by' => 'ORDER BY sdate DESC LIMIT 1',
789 Returns the amount owed (still outstanding) on this line item's setup fee,
790 which is the amount of the line item minus all payment applications (see
791 L<FS::cust_bill_pay_pkg> and credit applications (see
792 L<FS::cust_credit_bill_pkg>).
798 $self->owed('setup', @_);
803 Returns the amount owed (still outstanding) on this line item's recurring fee,
804 which is the amount of the line item minus all payment applications (see
805 L<FS::cust_bill_pay_pkg> and credit applications (see
806 L<FS::cust_credit_bill_pkg>).
812 $self->owed('recur', @_);
815 # modeled after cust_bill::owed...
817 my( $self, $field ) = @_;
818 my $balance = $self->$field();
819 $balance -= $_->amount foreach ( $self->cust_bill_pay_pkg($field) );
820 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) );
821 $balance = sprintf( '%.2f', $balance );
822 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
828 my( $self, $field ) = @_;
829 my $balance = $self->$field();
830 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) );
831 $balance = sprintf( '%.2f', $balance );
832 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
836 sub cust_bill_pay_pkg {
837 my( $self, $field ) = @_;
838 qsearch( 'cust_bill_pay_pkg', { 'billpkgnum' => $self->billpkgnum,
839 'setuprecur' => $field,
844 sub cust_credit_bill_pkg {
845 my( $self, $field ) = @_;
846 qsearch( 'cust_credit_bill_pkg', { 'billpkgnum' => $self->billpkgnum,
847 'setuprecur' => $field,
854 Returns the number of billing units (for tax purposes) represented by this,
861 $self->pkgnum ? $self->part_pkg->calc_units($self->cust_pkg) : 0; # 1?
866 If this item has any discounts, returns a hashref in the format used
867 by L<FS::Template_Mixin/_items_cust_bill_pkg> to describe the discount(s)
868 on an invoice. This will contain the keys 'description', 'amount',
869 'ext_description' (an arrayref of text lines describing the discounts),
870 and '_is_discount' (a flag).
872 The value for 'amount' will be negative, and will be scaled for the package
881 my $d; # this will be returned.
883 my @pkg_discounts = $self->pkg_discount;
884 if (@pkg_discounts) {
885 # special case: if there are old "discount details" on this line item,
886 # don't show discount line items
887 if ( FS::cust_bill_pkg_detail->count("detail LIKE 'Includes discount%' AND billpkgnum = ?", $self->billpkgnum || 0) > 0 ) {
894 description => $self->mt('Discount'),
897 ext_description => \@ext,
898 pkgpart => $self->pkgpart,
899 feepart => $self->feepart,
900 # maybe should show quantity/unit discount?
902 foreach my $pkg_discount (@pkg_discounts) {
903 push @ext, $pkg_discount->description;
904 my $setuprecur = $pkg_discount->cust_pkg_discount->setuprecur;
905 $d->{$setuprecur.'_amount'} -= $pkg_discount->amount;
909 # show introductory rate as a pseudo-discount
910 if (!$d) { # this will conflict with showing real discounts
911 my $part_pkg = $self->part_pkg;
912 if ( $part_pkg and $part_pkg->option('show_as_discount',1) ) {
913 my $cust_pkg = $self->cust_pkg;
914 my $intro_end = $part_pkg->intro_end($cust_pkg);
915 my $_date = $self->cust_bill->_date;
916 if ( $intro_end > $_date ) {
917 $d = $part_pkg->item_discount($cust_pkg);
923 $d->{setup_amount} *= $self->quantity || 1; # ??
924 $d->{recur_amount} *= $self->quantity || 1; # ??
930 =item set_display OPTION => VALUE ...
932 A helper method for I<insert>, populates the pseudo-field B<display> with
933 appropriate FS::cust_bill_pkg_display objects.
935 Options are passed as a list of name/value pairs. Options are:
937 part_pkg: FS::part_pkg object from this line item's package.
939 real_pkgpart: if this line item comes from a bundled package, the pkgpart
940 of the owning package. Otherwise the same as the part_pkg's pkgpart above.
945 my( $self, %opt ) = @_;
946 my $part_pkg = $opt{'part_pkg'};
947 my $cust_pkg = new FS::cust_pkg { pkgpart => $opt{real_pkgpart} };
949 my $conf = new FS::Conf;
951 # whether to break this down into setup/recur/usage
952 my $separate = $conf->exists('separate_usage');
954 my $usage_mandate = $part_pkg->option('usage_mandate', 'Hush!')
955 || $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
957 # or use the category from $opt{'part_pkg'} if its not bundled?
958 my $categoryname = $cust_pkg->part_pkg->categoryname;
960 # if we don't have to separate setup/recur/usage, or put this in a
961 # package-specific section, or display a usage summary, then don't
962 # even create one of these. The item will just display in the unnamed
963 # section as a single line plus details.
964 return $self->set('display', [])
965 unless $separate || $categoryname || $usage_mandate;
969 my %hash = ( 'section' => $categoryname );
971 # whether to put usage details in a separate section, and if so, which one
972 my $usage_section = $part_pkg->option('usage_section', 'Hush!')
973 || $cust_pkg->part_pkg->option('usage_section', 'Hush!');
975 # whether to show a usage summary line (total usage charges, no details)
976 my $summary = $part_pkg->option('summarize_usage', 'Hush!')
977 || $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
980 # create lines for setup and (non-usage) recur, in the main section
981 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
982 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
984 # display everything in a single line
985 push @display, new FS::cust_bill_pkg_display
988 # and if usage_mandate is enabled, hide details
989 # (this only works on multisection invoices...)
990 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
994 if ($separate && $usage_section && $summary) {
995 # create a line for the usage summary in the main section
996 push @display, new FS::cust_bill_pkg_display { type => 'U',
1002 if ($usage_mandate || ($usage_section && $summary) ) {
1003 $hash{post_total} = 'Y';
1006 if ($separate || $usage_mandate) {
1007 # show call details for this line item in the usage section.
1008 # if usage_mandate is on, this will display below the section subtotal.
1009 # this also happens if usage is in a separate section and there's a
1010 # summary in the main section, though I'm not sure why.
1011 $hash{section} = $usage_section if $usage_section;
1012 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1015 $self->set('display', \@display);
1021 Returns a hash: keys are "setup", "recur" or usage classnum, values are
1022 FS::cust_bill_pkg objects, each with no more than a single class (setup or
1029 # XXX this goes away with cust_bill_pkg refactor
1030 # or at least I wish it would, but it turns out to be harder than
1033 #my $cust_bill_pkg = new FS::cust_bill_pkg { $self->hash }; # wha huh?
1034 my %cust_bill_pkg = ();
1037 foreach my $classnum ($self->usage_classes) {
1038 my $amount = $self->usage($classnum);
1039 next if $amount == 0; # though if so we shouldn't be here
1040 my $usage_item = FS::cust_bill_pkg->new({
1044 'taxclass' => $classnum,
1047 $cust_bill_pkg{$classnum} = $usage_item;
1048 $usage_total += $amount;
1051 foreach (qw(setup recur)) {
1052 next if ($self->get($_) == 0);
1053 my $item = FS::cust_bill_pkg->new({
1060 $item->set($_, $self->get($_));
1061 $cust_bill_pkg{$_} = $item;
1065 $cust_bill_pkg{recur}->set('recur',
1066 sprintf('%.2f', $cust_bill_pkg{recur}->get('recur') - $usage_total)
1073 =item usage CLASSNUM
1075 Returns the amount of the charge associated with usage class CLASSNUM if
1076 CLASSNUM is defined. Otherwise returns the total charge associated with
1082 my( $self, $classnum ) = @_;
1083 $self->regularize_details;
1085 if ( $self->get('details') ) {
1088 map { $_->amount || 0 }
1089 grep { !defined($classnum) or $classnum eq $_->classnum }
1090 @{ $self->get('details') }
1095 my $sql = 'SELECT SUM(COALESCE(amount,0)) FROM cust_bill_pkg_detail '.
1096 ' WHERE billpkgnum = '. $self->billpkgnum;
1097 if (defined $classnum) {
1098 if ($classnum =~ /^(\d+)$/) {
1099 $sql .= " AND classnum = $1";
1100 } elsif ($classnum eq '') {
1101 $sql .= " AND classnum IS NULL";
1105 my $sth = dbh->prepare($sql) or die dbh->errstr;
1106 $sth->execute or die $sth->errstr;
1108 return $sth->fetchrow_arrayref->[0] || 0;
1116 Returns a list of usage classnums associated with this invoice line's
1123 $self->regularize_details;
1125 if ( $self->get('details') ) {
1127 my %seen = ( map { $_->classnum => 1 } @{ $self->get('details') } );
1132 map { $_->classnum }
1133 qsearch({ table => 'cust_bill_pkg_detail',
1134 hashref => { billpkgnum => $self->billpkgnum },
1135 select => 'DISTINCT classnum',
1142 sub cust_tax_exempt_pkg {
1145 my $array = $self->{Hash}->{cust_tax_exempt_pkg} ||= [];
1148 =item cust_bill_pkg_tax_Xlocation
1150 Returns the list of associated cust_bill_pkg_tax_location and/or
1151 cust_bill_pkg_tax_rate_location objects
1155 sub cust_bill_pkg_tax_Xlocation {
1158 my %hash = ( 'billpkgnum' => $self->billpkgnum );
1161 qsearch ( 'cust_bill_pkg_tax_location', { %hash } ),
1162 qsearch ( 'cust_bill_pkg_tax_rate_location', { %hash } )
1167 =item recur_show_zero
1169 Whether to show a zero recurring amount. This is true if the package or its
1170 definition has the recur_show_zero flag, and the recurring fee is actually
1171 zero for this period.
1175 sub recur_show_zero {
1176 my( $self, $what ) = @_;
1178 return 0 unless $self->get('recur') == 0 && $self->pkgnum;
1180 $self->cust_pkg->_X_show_zero('recur');
1183 =item setup_show_zero
1185 Whether to show a zero setup charge. This requires the package or its
1186 definition to have the setup_show_zero flag, but it also returns false if
1187 the package's setup date is before this line item's start date.
1191 sub setup_show_zero {
1193 return 0 unless $self->get('setup') == 0 && $self->pkgnum;
1194 my $cust_pkg = $self->cust_pkg;
1195 return 0 if ( $self->sdate || 0 ) > ( $cust_pkg->setup || 0 );
1196 return $cust_pkg->_X_show_zero('setup');
1199 =item credited [ BEFORE, AFTER, OPTIONS ]
1201 Returns the sum of credits applied to this item. Arguments are the same as
1202 owed_sql/paid_sql/credited_sql.
1208 $self->scalar_sql('SELECT '. $self->credited_sql(@_).' FROM cust_bill_pkg WHERE billpkgnum = ?', $self->billpkgnum);
1211 =item tax_locationnum
1213 Returns the L<FS::cust_location> number that this line item is in for tax
1214 purposes. For package sales, it's the package tax location; for fees,
1215 it's the customer's default service location.
1219 sub tax_locationnum {
1221 if ( $self->pkgnum ) { # normal sales
1222 return $self->cust_pkg->tax_locationnum;
1223 } elsif ( $self->feepart ) { # fees
1224 my $custnum = $self->fee_origin->custnum;
1226 return FS::cust_main->by_key($custnum)->ship_locationnum;
1235 if ( $self->pkgnum ) { # normal sales
1236 return $self->cust_pkg->tax_location;
1237 } elsif ( $self->feepart ) { # fees
1238 my $fee_origin = $self->fee_origin;
1239 if ( $fee_origin ) {
1240 my $custnum = $fee_origin->custnum;
1242 return FS::cust_main->by_key($custnum)->ship_location;
1252 =head1 CLASS METHODS
1258 Returns an SQL expression for the total usage charges in details on
1264 '(SELECT COALESCE(SUM(cust_bill_pkg_detail.amount),0)
1265 FROM cust_bill_pkg_detail
1266 WHERE cust_bill_pkg_detail.billpkgnum = cust_bill_pkg.billpkgnum)';
1268 sub usage_sql { $usage_sql }
1270 # this makes owed_sql, etc. much more concise
1272 my ($class, $start, $end, %opt) = @_;
1273 my $setuprecur = $opt{setuprecur} || '';
1275 $setuprecur =~ /^s/ ? 'cust_bill_pkg.setup' :
1276 $setuprecur =~ /^r/ ? 'cust_bill_pkg.recur' :
1277 'cust_bill_pkg.setup + cust_bill_pkg.recur';
1279 if ($opt{no_usage} and $charged =~ /recur/) {
1280 $charged = "$charged - $usage_sql"
1287 =item owed_sql [ BEFORE, AFTER, OPTIONS ]
1289 Returns an SQL expression for the amount owed. BEFORE and AFTER specify
1290 a date window. OPTIONS may include 'no_usage' (excludes usage charges)
1291 and 'setuprecur' (set to "setup" or "recur" to limit to one or the other).
1297 '(' . $class->charged_sql(@_) .
1298 ' - ' . $class->paid_sql(@_) .
1299 ' - ' . $class->credited_sql(@_) . ')'
1302 =item paid_sql [ BEFORE, AFTER, OPTIONS ]
1304 Returns an SQL expression for the sum of payments applied to this item.
1309 my ($class, $start, $end, %opt) = @_;
1310 my $s = $start ? "AND cust_pay._date <= $start" : '';
1311 my $e = $end ? "AND cust_pay._date > $end" : '';
1312 my $setuprecur = $opt{setuprecur} || '';
1313 $setuprecur = 'setup' if $setuprecur =~ /^s/;
1314 $setuprecur = 'recur' if $setuprecur =~ /^r/;
1315 $setuprecur &&= "AND setuprecur = '$setuprecur'";
1317 my $paid = "( SELECT COALESCE(SUM(cust_bill_pay_pkg.amount),0)
1318 FROM cust_bill_pay_pkg JOIN cust_bill_pay USING (billpaynum)
1319 JOIN cust_pay USING (paynum)
1320 WHERE cust_bill_pay_pkg.billpkgnum = cust_bill_pkg.billpkgnum
1321 $s $e $setuprecur )";
1323 if ( $opt{no_usage} ) {
1324 # cap the amount paid at the sum of non-usage charges,
1325 # minus the amount credited against non-usage charges
1327 $class->charged_sql($start, $end, %opt) . ' - ' .
1328 $class->credited_sql($start, $end, %opt).')';
1337 my ($class, $start, $end, %opt) = @_;
1338 my $s = $start ? "AND cust_credit._date <= $start" : '';
1339 my $e = $end ? "AND cust_credit._date > $end" : '';
1340 my $setuprecur = $opt{setuprecur} || '';
1341 $setuprecur = 'setup' if $setuprecur =~ /^s/;
1342 $setuprecur = 'recur' if $setuprecur =~ /^r/;
1343 $setuprecur &&= "AND setuprecur = '$setuprecur'";
1345 my $credited = "( SELECT COALESCE(SUM(cust_credit_bill_pkg.amount),0)
1346 FROM cust_credit_bill_pkg JOIN cust_credit_bill USING (creditbillnum)
1347 JOIN cust_credit USING (crednum)
1348 WHERE cust_credit_bill_pkg.billpkgnum = cust_bill_pkg.billpkgnum
1349 $s $e $setuprecur )";
1351 if ( $opt{no_usage} ) {
1352 # cap the amount credited at the sum of non-usage charges
1353 "LEAST($credited, ". $class->charged_sql($start, $end, %opt).')';
1361 sub upgrade_tax_location {
1362 # For taxes that were calculated/invoiced before cust_location refactoring
1363 # (May-June 2012), there are no cust_bill_pkg_tax_location records unless
1364 # they were calculated on a package-location basis. Create them here,
1365 # along with any necessary cust_location records and any tax exemption
1368 my ($class, %opt) = @_;
1369 # %opt may include 's' and 'e': start and end date ranges
1370 # and 'X': abort on any error, instead of just rolling back changes to
1373 my $oldAutoCommit = $FS::UID::AutoCommit;
1374 local $FS::UID::AutoCommit = 0;
1377 use FS::h_cust_main;
1378 use FS::h_cust_bill;
1380 use FS::h_cust_main_exemption;
1383 local $FS::cust_location::import = 1;
1385 my $conf = FS::Conf->new; # h_conf?
1386 return if $conf->config('tax_data_vendor'); #don't touch this case
1387 my $use_ship = $conf->exists('tax-ship_address');
1388 my $use_pkgloc = $conf->exists('tax-pkg_address');
1390 my $date_where = '';
1392 $date_where .= " AND cust_bill._date >= $opt{s}";
1395 $date_where .= " AND cust_bill._date < $opt{e}";
1398 my $commit_each_invoice = 1 unless $opt{X};
1400 # if an invoice has either of these kinds of objects, then it doesn't
1401 # need to be upgraded...probably
1402 my $sub_has_tax_link = 'SELECT 1 FROM cust_bill_pkg_tax_location'.
1403 ' JOIN cust_bill_pkg USING (billpkgnum)'.
1404 ' WHERE cust_bill_pkg.invnum = cust_bill.invnum';
1405 my $sub_has_exempt = 'SELECT 1 FROM cust_tax_exempt_pkg'.
1406 ' JOIN cust_bill_pkg USING (billpkgnum)'.
1407 ' WHERE cust_bill_pkg.invnum = cust_bill.invnum'.
1408 ' AND exempt_monthly IS NULL';
1410 my %all_tax_names = (
1413 map { $_->taxname => 1 }
1414 qsearch('h_cust_main_county', { taxname => { op => '!=', value => '' }})
1417 my $search = FS::Cursor->new({
1418 table => 'cust_bill',
1420 extra_sql => "WHERE NOT EXISTS($sub_has_tax_link) ".
1421 "AND NOT EXISTS($sub_has_exempt) ".
1425 #print "Processing ".scalar(@invnums)." invoices...\n";
1429 while (my $cust_bill = $search->fetch) {
1430 my $invnum = $cust_bill->invnum;
1432 print STDERR "Invoice #$invnum\n";
1434 my %pkgpart_taxclass; # pkgpart => taxclass
1435 my %pkgpart_exempt_setup;
1436 my %pkgpart_exempt_recur;
1437 my $h_cust_bill = qsearchs('h_cust_bill',
1438 { invnum => $invnum,
1439 history_action => 'insert' });
1440 if (!$h_cust_bill) {
1441 warn "no insert record for invoice $invnum; skipped\n";
1442 #$date = $cust_bill->_date as a fallback?
1443 # We're trying to avoid using non-real dates (-d/-y invoice dates)
1444 # when looking up history records in other tables.
1447 my $custnum = $h_cust_bill->custnum;
1449 # Determine the address corresponding to this tax region.
1450 # It's either the bill or ship address of the customer as of the
1451 # invoice date-of-insertion. (Not necessarily the invoice date.)
1452 my $date = $h_cust_bill->history_date;
1453 local($FS::Record::qsearch_qualify_columns) = 0;
1454 my $h_cust_main = qsearchs('h_cust_main',
1455 { custnum => $custnum },
1456 FS::h_cust_main->sql_h_searchs($date)
1458 if (!$h_cust_main ) {
1459 warn "no historical address for cust#".$h_cust_bill->custnum."; skipped\n";
1461 # fallback to current $cust_main? sounds dangerous.
1464 # This is a historical customer record, so it has a historical address.
1465 # If there's no cust_location matching this custnum and address (there
1466 # probably isn't), create one.
1467 my %tax_loc; # keys are pkgnums, values are cust_location objects
1468 my $default_tax_loc;
1469 if ( $h_cust_main->bill_locationnum ) {
1470 # the location has already been upgraded
1472 $default_tax_loc = $h_cust_main->ship_location;
1474 $default_tax_loc = $h_cust_main->bill_location;
1477 $pre = 'ship_' if $use_ship and length($h_cust_main->get('ship_last'));
1478 my %hash = map { $_ => $h_cust_main->get($pre.$_) }
1479 FS::cust_main->location_fields;
1480 # not really needed for this, and often result in duplicate locations
1481 delete @hash{qw(censustract censusyear latitude longitude coord_auto)};
1483 $hash{custnum} = $h_cust_main->custnum;
1484 $default_tax_loc = FS::cust_location->new(\%hash);
1485 my $error = $default_tax_loc->find_or_insert || $default_tax_loc->disable_if_unused;
1487 warn "couldn't create historical location record for cust#".
1488 $h_cust_main->custnum.": $error\n";
1493 $exempt_cust = 1 if $h_cust_main->tax;
1495 # classify line items
1497 my %nontax_items; # taxclass => array of cust_bill_pkg
1498 foreach my $item ($h_cust_bill->cust_bill_pkg) {
1499 my $pkgnum = $item->pkgnum;
1501 if ( $pkgnum == 0 ) {
1503 push @tax_items, $item;
1506 # (pkgparts really shouldn't change, right?)
1507 local($FS::Record::qsearch_qualify_columns) = 0;
1508 my $h_cust_pkg = qsearchs('h_cust_pkg', { pkgnum => $pkgnum },
1509 FS::h_cust_pkg->sql_h_searchs($date)
1511 if ( !$h_cust_pkg ) {
1512 warn "no historical package #".$item->pkgpart."; skipped\n";
1515 my $pkgpart = $h_cust_pkg->pkgpart;
1517 if ( $use_pkgloc and $h_cust_pkg->locationnum ) {
1518 # then this package already had a locationnum assigned, and that's
1519 # the one to use for tax calculation
1520 $tax_loc{$pkgnum} = FS::cust_location->by_key($h_cust_pkg->locationnum);
1522 # use the customer's bill or ship loc, which was inserted earlier
1523 $tax_loc{$pkgnum} = $default_tax_loc;
1526 if (!exists $pkgpart_taxclass{$pkgpart}) {
1527 local($FS::Record::qsearch_qualify_columns) = 0;
1528 my $h_part_pkg = qsearchs('h_part_pkg', { pkgpart => $pkgpart },
1529 FS::h_part_pkg->sql_h_searchs($date)
1531 if ( !$h_part_pkg ) {
1532 warn "no historical package def #$pkgpart; skipped\n";
1535 $pkgpart_taxclass{$pkgpart} = $h_part_pkg->taxclass || '';
1536 $pkgpart_exempt_setup{$pkgpart} = 1 if $h_part_pkg->setuptax;
1537 $pkgpart_exempt_recur{$pkgpart} = 1 if $h_part_pkg->recurtax;
1540 # mark any exemptions that apply
1541 if ( $pkgpart_exempt_setup{$pkgpart} ) {
1542 $item->set('exempt_setup' => 1);
1545 if ( $pkgpart_exempt_recur{$pkgpart} ) {
1546 $item->set('exempt_recur' => 1);
1549 my $taxclass = $pkgpart_taxclass{ $pkgpart };
1551 $nontax_items{$taxclass} ||= [];
1552 push @{ $nontax_items{$taxclass} }, $item;
1556 printf("%d tax items: \$%.2f\n", scalar(@tax_items), map {$_->setup} @tax_items)
1559 # Get any per-customer taxname exemptions that were in effect.
1560 my %exempt_cust_taxname;
1561 foreach (keys %all_tax_names) {
1562 local($FS::Record::qsearch_qualify_columns) = 0;
1563 my $h_exemption = qsearchs('h_cust_main_exemption', {
1564 'custnum' => $custnum,
1567 FS::h_cust_main_exemption->sql_h_searchs($date, $date)
1570 $exempt_cust_taxname{ $_ } = 1;
1574 # Use a variation on the procedure in
1575 # FS::cust_main::Billing::_handle_taxes to identify taxes that apply
1577 my @loc_keys = qw( district city county state country );
1578 my %taxdef_by_name; # by name, and then by taxclass
1579 my %est_tax; # by name, and then by taxclass
1580 my %taxable_items; # by taxnum, and then an array
1582 foreach my $taxclass (keys %nontax_items) {
1583 foreach my $orig_item (@{ $nontax_items{$taxclass} }) {
1584 my $my_tax_loc = $tax_loc{ $orig_item->pkgnum };
1585 my %myhash = map { $_ => $my_tax_loc->get($pre.$_) } @loc_keys;
1586 my @elim = qw( district city county state );
1587 my @taxdefs; # because there may be several with different taxnames
1589 $myhash{taxclass} = $taxclass;
1590 @taxdefs = qsearch('cust_main_county', \%myhash);
1592 $myhash{taxclass} = '';
1593 @taxdefs = qsearch('cust_main_county', \%myhash);
1595 $myhash{ shift @elim } = '';
1596 } while scalar(@elim) and !@taxdefs;
1598 foreach my $taxdef (@taxdefs) {
1599 next if $taxdef->tax == 0;
1600 $taxdef_by_name{$taxdef->taxname}{$taxdef->taxclass} = $taxdef;
1602 $taxable_items{$taxdef->taxnum} ||= [];
1603 # clone the item so that taxdef-dependent changes don't
1604 # change it for other taxdefs
1605 my $item = FS::cust_bill_pkg->new({ $orig_item->hash });
1607 # these flags are already set if the part_pkg declares itself exempt
1608 $item->set('exempt_setup' => 1) if $taxdef->setuptax;
1609 $item->set('exempt_recur' => 1) if $taxdef->recurtax;
1612 my $taxable = $item->setup + $item->recur;
1614 # h_cust_credit_bill_pkg?
1615 # NO. Because if these exemptions HAD been created at the time of
1616 # billing, and then a credit applied later, the exemption would
1617 # have been adjusted by the amount of the credit. So we adjust
1618 # the taxable amount before creating the exemption.
1619 # But don't deduct the credit from taxable, because the tax was
1620 # calculated before the credit was applied.
1621 foreach my $f (qw(setup recur)) {
1622 my $credited = FS::Record->scalar_sql(
1623 "SELECT SUM(amount) FROM cust_credit_bill_pkg ".
1624 "WHERE billpkgnum = ? AND setuprecur = ?",
1628 $item->set($f, $item->get($f) - $credited) if $credited;
1630 my $existing_exempt = FS::Record->scalar_sql(
1631 "SELECT SUM(amount) FROM cust_tax_exempt_pkg WHERE ".
1632 "billpkgnum = ? AND taxnum = ?",
1633 $item->billpkgnum, $taxdef->taxnum
1635 $taxable -= $existing_exempt;
1637 if ( $taxable and $exempt_cust ) {
1638 push @new_exempt, { exempt_cust => 'Y', amount => $taxable };
1641 if ( $taxable and $exempt_cust_taxname{$taxdef->taxname} ){
1642 push @new_exempt, { exempt_cust_taxname => 'Y', amount => $taxable };
1645 if ( $taxable and $item->exempt_setup ) {
1646 push @new_exempt, { exempt_setup => 'Y', amount => $item->setup };
1647 $taxable -= $item->setup;
1649 if ( $taxable and $item->exempt_recur ) {
1650 push @new_exempt, { exempt_recur => 'Y', amount => $item->recur };
1651 $taxable -= $item->recur;
1654 $item->set('taxable' => $taxable);
1655 push @{ $taxable_items{$taxdef->taxnum} }, $item
1658 # estimate the amount of tax (this is necessary because different
1659 # taxdefs with the same taxname may have different tax rates)
1660 # and sum that for each taxname/taxclass combination
1662 $est_tax{$taxdef->taxname} ||= {};
1663 $est_tax{$taxdef->taxname}{$taxdef->taxclass} ||= 0;
1664 $est_tax{$taxdef->taxname}{$taxdef->taxclass} +=
1665 $taxable * $taxdef->tax;
1667 foreach (@new_exempt) {
1668 next if $_->{amount} == 0;
1669 my $cust_tax_exempt_pkg = FS::cust_tax_exempt_pkg->new({
1671 billpkgnum => $item->billpkgnum,
1672 taxnum => $taxdef->taxnum,
1674 my $error = $cust_tax_exempt_pkg->insert;
1676 my $pkgnum = $item->pkgnum;
1677 warn "error creating tax exemption for inv$invnum pkg$pkgnum:".
1681 } #foreach @new_exempt
1684 } #foreach $taxclass
1686 # Now go through the billed taxes and match them up with the line items.
1687 TAX_ITEM: foreach my $tax_item ( @tax_items )
1689 my $taxname = $tax_item->itemdesc;
1690 $taxname = '' if $taxname eq 'Tax';
1692 if ( !exists( $taxdef_by_name{$taxname} ) ) {
1693 # then we didn't find any applicable taxes with this name
1694 warn "no definition found for tax item '$taxname', custnum $custnum\n";
1695 # possibly all of these should be "next TAX_ITEM", but whole invoices
1696 # are transaction protected and we can go back and retry them.
1699 # classname => cust_main_county
1700 my %taxdef_by_class = %{ $taxdef_by_name{$taxname} };
1702 # Divide the tax item among taxclasses, if necessary
1703 # classname => estimated tax amount
1704 my $this_est_tax = $est_tax{$taxname};
1705 if (!defined $this_est_tax) {
1706 warn "no taxable sales found for inv#$invnum, tax item '$taxname'.\n";
1709 my $est_total = sum(values %$this_est_tax);
1710 if ( $est_total == 0 ) {
1712 warn "estimated tax on invoice #$invnum is zero.\n";
1716 my $real_tax = $tax_item->setup;
1717 printf ("Distributing \$%.2f tax:\n", $real_tax);
1718 my $cents_remaining = $real_tax * 100; # for rounding error
1719 my @tax_links; # partial CBPTL hashrefs
1720 foreach my $taxclass (keys %taxdef_by_class) {
1721 my $taxdef = $taxdef_by_class{$taxclass};
1722 # these items already have "taxable" set to their charge amount
1723 # after applying any credits or exemptions
1724 my @items = @{ $taxable_items{$taxdef->taxnum} };
1725 my $subtotal = sum(map {$_->get('taxable')} @items);
1726 printf("\t$taxclass: %.2f\n", $this_est_tax->{$taxclass}/$est_total);
1728 foreach my $nontax (@items) {
1729 my $my_tax_loc = $tax_loc{ $nontax->pkgnum };
1730 my $part = int($real_tax
1732 * ($this_est_tax->{$taxclass}/$est_total)
1734 * ($nontax->get('taxable'))/$subtotal
1738 $cents_remaining -= $part;
1740 taxnum => $taxdef->taxnum,
1741 pkgnum => $nontax->pkgnum,
1742 locationnum => $my_tax_loc->locationnum,
1743 billpkgnum => $nontax->billpkgnum,
1747 } #foreach $taxclass
1748 # Distribute any leftover tax round-robin style, one cent at a time.
1750 my $nlinks = scalar(@tax_links);
1752 # ensure that it really is an integer
1753 $cents_remaining = sprintf('%.0f', $cents_remaining);
1754 while ($cents_remaining > 0) {
1755 $tax_links[$i % $nlinks]->{cents} += 1;
1760 warn "Can't create tax links--no taxable items found.\n";
1764 # Gather credit/payment applications so that we can link them
1767 qsearch( 'cust_credit_bill_pkg',
1768 { billpkgnum => $tax_item->billpkgnum, billpkgtaxlocationnum => '' }
1770 qsearch( 'cust_bill_pay_pkg',
1771 { billpkgnum => $tax_item->billpkgnum, billpkgtaxlocationnum => '' }
1775 # grab the first one
1776 my $this_unlinked = shift @unlinked;
1777 my $unlinked_cents = int($this_unlinked->amount * 100) if $this_unlinked;
1779 # Create tax links (yay!)
1780 printf("Creating %d tax links.\n",scalar(@tax_links));
1781 foreach (@tax_links) {
1782 my $link = FS::cust_bill_pkg_tax_location->new({
1783 billpkgnum => $tax_item->billpkgnum,
1784 taxtype => 'FS::cust_main_county',
1785 locationnum => $_->{locationnum},
1786 taxnum => $_->{taxnum},
1787 pkgnum => $_->{pkgnum},
1788 amount => sprintf('%.2f', $_->{cents} / 100),
1789 taxable_billpkgnum => $_->{billpkgnum},
1791 my $error = $link->insert;
1793 warn "Can't create tax link for inv#$invnum: $error\n";
1797 my $link_cents = $_->{cents};
1798 # update/create subitem links
1800 # If $this_unlinked is undef, then we've allocated all of the
1801 # credit/payment applications to the tax item. If $link_cents is 0,
1802 # then we've applied credits/payments to all of this package fraction,
1803 # so go on to the next.
1804 while ($this_unlinked and $link_cents) {
1805 # apply as much as possible of $link_amount to this credit/payment
1807 my $apply_cents = min($link_cents, $unlinked_cents);
1808 $link_cents -= $apply_cents;
1809 $unlinked_cents -= $apply_cents;
1810 # $link_cents or $unlinked_cents or both are now zero
1811 $this_unlinked->set('amount' => sprintf('%.2f',$apply_cents/100));
1812 $this_unlinked->set('billpkgtaxlocationnum' => $link->billpkgtaxlocationnum);
1813 my $pkey = $this_unlinked->primary_key; #creditbillpkgnum or billpaypkgnum
1814 if ( $this_unlinked->$pkey ) {
1815 # then it's an existing link--replace it
1816 $error = $this_unlinked->replace;
1818 $this_unlinked->insert;
1820 # what do we do with errors at this stage?
1822 warn "Error creating tax application link: $error\n";
1823 next INVOICE; # for lack of a better idea
1826 if ( $unlinked_cents == 0 ) {
1827 # then we've allocated all of this payment/credit application,
1828 # so grab the next one
1829 $this_unlinked = shift @unlinked;
1830 $unlinked_cents = int($this_unlinked->amount * 100) if $this_unlinked;
1831 } elsif ( $link_cents == 0 ) {
1832 # then we've covered all of this package tax fraction, so split
1833 # off a new application from this one
1834 $this_unlinked = $this_unlinked->new({
1835 $this_unlinked->hash,
1838 # $unlinked_cents is still what it is
1841 } #while $this_unlinked and $link_cents
1842 } #foreach (@tax_links)
1843 } #foreach $tax_item
1845 $dbh->commit if $commit_each_invoice and $oldAutoCommit;
1851 $dbh->rollback if $oldAutoCommit;
1852 die "Upgrade halted.\n" unless $commit_each_invoice;
1856 $dbh->commit if $oldAutoCommit and !$commit_each_invoice;
1861 # Return an array of hashrefs for each cust_bill_pkg_tax_location
1862 # applied to this bill for this cust_bill_pkg.pkgnum.
1865 # In some situations, this list will contain more tax records than the
1866 # ones directly related to $self->billpkgnum. The returned list contains
1867 # all records, for this bill, charged against this billpkgnum's pkgnum.
1869 # One must keep this in mind when using data returned by this method.
1871 # An unaddressed deficiency in the cust_bill_pkg_tax_location model makes
1872 # this necessary: When a linked-hidden package generates a tax/fee as a row
1873 # in cust_bill_pkg_tax_location, there is not enough information to surmise
1874 # with specificity which billpkgnum row represents the direct parent of the
1875 # the linked-hidden package's tax row. The closest we can get to this
1876 # backwards reassociation is to use the pkgnum. Therefore, when multiple
1877 # billpkgnum's appear with the same pkgnum, this method is going to return
1878 # the tax records for ALL of those billpkgnum's, not just $self->billpkgnum.
1880 # This could be addressed with an update to the model, and to the billing
1881 # routine that generates rows into cust_bill_pkg_tax_location. Perhaps a
1882 # column, link_billpkgnum or parent_billpkgnum, recording the link. I'm not
1883 # doing that now, because there would be no possible repair of data stored
1884 # historically prior to such a fix. I need _pkg_tax_list() to not be
1885 # broken for already-generated bills.
1887 # Any code you write relying on _pkg_tax_list() MUST be aware of, and
1888 # account for, the possible return of duplicated tax records returned
1889 # when method is called on multiple cust_bill_pkg_tax_location rows.
1890 # Duplicates can be identified by billpkgtaxlocationnum column.
1894 my $search_selector;
1895 if ( $self->pkgnum ) {
1897 # For taxes applied to normal billing items
1899 ' cust_bill_pkg_tax_location.pkgnum = '
1900 . dbh->quote( $self->pkgnum );
1902 } elsif ( $self->feepart ) {
1904 # For taxes applied to fees, when the fee is not attached to a package
1905 # i.e. late fees, billing events fees
1907 ' cust_bill_pkg_tax_location.taxable_billpkgnum = '
1908 . dbh->quote( $self->billpkgnum );
1911 warn "_pkg_tax_list() unhandled case breaking taxes into sections";
1912 warn "_pkg_tax_list() $_: ".$self->$_
1913 for qw(pkgnum billpkgnum feepart);
1918 billpkgtaxlocationnum => $_->billpkgtaxlocationnum,
1919 billpkgnum => $_->billpkgnum,
1920 taxnum => $_->taxnum,
1921 amount => $_->amount,
1922 taxname => $_->taxname,
1925 table => 'cust_bill_pkg_tax_location',
1927 LEFT JOIN cust_bill_pkg
1928 ON cust_bill_pkg.billpkgnum
1929 = cust_bill_pkg_tax_location.taxable_billpkgnum
1931 select => join( ', ', (qw|
1932 cust_bill_pkg.billpkgnum
1933 cust_bill_pkg_tax_location.billpkgtaxlocationnum
1934 cust_bill_pkg_tax_location.taxnum
1935 cust_bill_pkg_tax_location.amount
1939 ' cust_bill_pkg.invnum = ' . dbh->quote( $self->invnum ) .
1947 # Create a queue job to run upgrade_tax_location from January 1, 2012 to
1951 use Date::Parse 'str2time';
1954 my $upgrade = 'tax_location_2012';
1955 return if FS::upgrade_journal->is_done($upgrade);
1956 my $job = FS::queue->new({
1957 'job' => 'FS::cust_bill_pkg::upgrade_tax_location'
1959 # call it kind of like a class method, not that it matters much
1960 $job->insert($class, 's' => str2time('2012-01-01'));
1961 # if there's a customer location upgrade queued also, wait for it to
1963 my $location_job = qsearchs('queue', {
1964 job => 'FS::cust_main::Location::process_upgrade_location'
1966 if ( $location_job ) {
1967 $job->depend_insert($location_job->jobnum);
1969 # Then mark the upgrade as done, so that we don't queue the job twice
1970 # and somehow run two of them concurrently.
1971 FS::upgrade_journal->set_done($upgrade);
1972 # This upgrade now does the job of assigning taxable_billpkgnums to
1973 # cust_bill_pkg_tax_location, so set that task done also.
1974 FS::upgrade_journal->set_done('tax_location_taxable_billpkgnum');
1981 setup and recur shouldn't be separate fields. There should be one "amount"
1982 field and a flag to tell you if it is a setup/one-time fee or a recurring fee.
1984 A line item with both should really be two separate records (preserving
1985 sdate and edate for setup fees for recurring packages - that information may
1986 be valuable later). Invoice generation (cust_main::bill), invoice printing
1987 (cust_bill), tax reports (report_tax.cgi) and line item reports
1988 (cust_bill_pkg.cgi) would need to be updated.
1990 owed_setup and owed_recur could then be repaced by just owed, and
1991 cust_bill::open_cust_bill_pkg and
1992 cust_bill_ApplicationCommon::apply_to_lineitems could be simplified.
1994 The upgrade procedure is pretty sketchy.
1998 L<FS::Record>, L<FS::cust_bill>, L<FS::cust_pkg>, L<FS::cust_main>, schema.html
1999 from the base documentation.