1 package FS::cust_bill_pkg;
2 use base qw( FS::TemplateItem_Mixin FS::cust_main_Mixin FS::Record );
5 use vars qw( @ISA $DEBUG $me );
7 use List::Util qw( sum min );
9 use FS::Record qw( qsearch qsearchs dbh );
12 use FS::cust_bill_pkg_detail;
13 use FS::cust_bill_pkg_display;
14 use FS::cust_bill_pkg_discount;
15 use FS::cust_bill_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;
30 $me = '[FS::cust_bill_pkg]';
34 FS::cust_bill_pkg - Object methods for cust_bill_pkg records
38 use FS::cust_bill_pkg;
40 $record = new FS::cust_bill_pkg \%hash;
41 $record = new FS::cust_bill_pkg { 'column' => 'value' };
43 $error = $record->insert;
45 $error = $record->check;
49 An FS::cust_bill_pkg object represents an invoice line item.
50 FS::cust_bill_pkg inherits from FS::Record. The following fields are currently
61 invoice (see L<FS::cust_bill>)
65 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)
67 =item pkgpart_override
69 optional package definition (see L<FS::part_pkg>) override
81 starting date of recurring fee
85 ending date of recurring fee
89 Line item description (overrides normal package description)
93 If not set, defaults to 1
97 If not set, defaults to setup
101 If not set, defaults to recur
105 If set to Y, indicates data should not appear as separate line item on invoice
109 sdate and edate are specified as UNIX timestamps; see L<perlfunc/"time">. Also
110 see L<Time::Local> and L<Date::Parse> for conversion functions.
118 Creates a new line item. To add the line item to the database, see
119 L<"insert">. Line items are normally created by calling the bill method of a
120 customer object (see L<FS::cust_main>).
124 sub table { 'cust_bill_pkg'; }
126 sub detail_table { 'cust_bill_pkg_detail'; }
127 sub display_table { 'cust_bill_pkg_display'; }
128 sub discount_table { 'cust_bill_pkg_discount'; }
129 #sub tax_location_table { 'cust_bill_pkg_tax_location'; }
130 #sub tax_rate_location_table { 'cust_bill_pkg_tax_rate_location'; }
131 #sub tax_exempt_pkg_table { 'cust_tax_exempt_pkg'; }
135 Adds this line item to the database. If there is an error, returns the error,
136 otherwise returns false.
143 local $SIG{HUP} = 'IGNORE';
144 local $SIG{INT} = 'IGNORE';
145 local $SIG{QUIT} = 'IGNORE';
146 local $SIG{TERM} = 'IGNORE';
147 local $SIG{TSTP} = 'IGNORE';
148 local $SIG{PIPE} = 'IGNORE';
150 my $oldAutoCommit = $FS::UID::AutoCommit;
151 local $FS::UID::AutoCommit = 0;
154 my $error = $self->SUPER::insert;
156 $dbh->rollback if $oldAutoCommit;
160 if ( $self->get('details') ) {
161 foreach my $detail ( @{$self->get('details')} ) {
162 $detail->billpkgnum($self->billpkgnum);
163 $error = $detail->insert;
165 $dbh->rollback if $oldAutoCommit;
166 return "error inserting cust_bill_pkg_detail: $error";
171 if ( $self->get('display') ) {
172 foreach my $cust_bill_pkg_display ( @{ $self->get('display') } ) {
173 $cust_bill_pkg_display->billpkgnum($self->billpkgnum);
174 $error = $cust_bill_pkg_display->insert;
176 $dbh->rollback if $oldAutoCommit;
177 return "error inserting cust_bill_pkg_display: $error";
182 if ( $self->get('discounts') ) {
183 foreach my $cust_bill_pkg_discount ( @{$self->get('discounts')} ) {
184 $cust_bill_pkg_discount->billpkgnum($self->billpkgnum);
185 $error = $cust_bill_pkg_discount->insert;
187 $dbh->rollback if $oldAutoCommit;
188 return "error inserting cust_bill_pkg_discount: $error";
193 foreach my $cust_tax_exempt_pkg ( @{$self->cust_tax_exempt_pkg} ) {
194 $cust_tax_exempt_pkg->billpkgnum($self->billpkgnum);
195 $error = $cust_tax_exempt_pkg->insert;
197 $dbh->rollback if $oldAutoCommit;
198 return "error inserting cust_tax_exempt_pkg: $error";
202 my $tax_location = $self->get('cust_bill_pkg_tax_location');
203 if ( $tax_location ) {
204 foreach my $link ( @$tax_location ) {
205 next if $link->billpkgtaxlocationnum; # don't try to double-insert
206 # This cust_bill_pkg can be linked on either side (i.e. it can be the
207 # tax or the taxed item). If the other side is already inserted,
208 # then set billpkgnum to ours, and insert the link. Otherwise,
209 # set billpkgnum to ours and pass the link off to the cust_bill_pkg
210 # on the other side, to be inserted later.
212 my $tax_cust_bill_pkg = $link->get('tax_cust_bill_pkg');
213 if ( $tax_cust_bill_pkg && $tax_cust_bill_pkg->billpkgnum ) {
214 $link->set('billpkgnum', $tax_cust_bill_pkg->billpkgnum);
215 # break circular links when doing this
216 $link->set('tax_cust_bill_pkg', '');
218 my $taxable_cust_bill_pkg = $link->get('taxable_cust_bill_pkg');
219 if ( $taxable_cust_bill_pkg && $taxable_cust_bill_pkg->billpkgnum ) {
220 $link->set('taxable_billpkgnum', $taxable_cust_bill_pkg->billpkgnum);
221 # XXX if we ever do tax-on-tax for these, this will have to change
222 # since pkgnum will be zero
223 $link->set('pkgnum', $taxable_cust_bill_pkg->pkgnum);
224 $link->set('locationnum',
225 $taxable_cust_bill_pkg->cust_pkg->tax_locationnum);
226 $link->set('taxable_cust_bill_pkg', '');
229 if ( $link->billpkgnum and $link->taxable_billpkgnum ) {
230 $error = $link->insert;
232 $dbh->rollback if $oldAutoCommit;
233 return "error inserting cust_bill_pkg_tax_location: $error";
237 $other = $link->billpkgnum ? $link->get('taxable_cust_bill_pkg')
238 : $link->get('tax_cust_bill_pkg');
239 my $link_array = $other->get('cust_bill_pkg_tax_location') || [];
240 push @$link_array, $link;
241 $other->set('cust_bill_pkg_tax_location' => $link_array);
246 # someday you will be as awesome as cust_bill_pkg_tax_location...
248 my $tax_rate_location = $self->get('cust_bill_pkg_tax_rate_location');
249 if ( $tax_rate_location ) {
250 foreach my $cust_bill_pkg_tax_rate_location ( @$tax_rate_location ) {
251 $cust_bill_pkg_tax_rate_location->billpkgnum($self->billpkgnum);
252 $error = $cust_bill_pkg_tax_rate_location->insert;
254 $dbh->rollback if $oldAutoCommit;
255 return "error inserting cust_bill_pkg_tax_rate_location: $error";
260 my $cust_tax_adjustment = $self->get('cust_tax_adjustment');
261 if ( $cust_tax_adjustment ) {
262 $cust_tax_adjustment->billpkgnum($self->billpkgnum);
263 $error = $cust_tax_adjustment->replace;
265 $dbh->rollback if $oldAutoCommit;
266 return "error replacing cust_tax_adjustment: $error";
270 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
277 Voids this line item: deletes the line item and adds a record of the voided
278 line item to the FS::cust_bill_pkg_void table (and related tables).
284 my $reason = scalar(@_) ? shift : '';
286 local $SIG{HUP} = 'IGNORE';
287 local $SIG{INT} = 'IGNORE';
288 local $SIG{QUIT} = 'IGNORE';
289 local $SIG{TERM} = 'IGNORE';
290 local $SIG{TSTP} = 'IGNORE';
291 local $SIG{PIPE} = 'IGNORE';
293 my $oldAutoCommit = $FS::UID::AutoCommit;
294 local $FS::UID::AutoCommit = 0;
297 my $cust_bill_pkg_void = new FS::cust_bill_pkg_void ( {
298 map { $_ => $self->get($_) } $self->fields
300 $cust_bill_pkg_void->reason($reason);
301 my $error = $cust_bill_pkg_void->insert;
303 $dbh->rollback if $oldAutoCommit;
307 foreach my $table (qw(
309 cust_bill_pkg_display
310 cust_bill_pkg_discount
311 cust_bill_pkg_tax_location
312 cust_bill_pkg_tax_rate_location
316 foreach my $linked ( qsearch($table, { billpkgnum=>$self->billpkgnum }) ) {
318 my $vclass = 'FS::'.$table.'_void';
319 my $void = $vclass->new( {
320 map { $_ => $linked->get($_) } $linked->fields
322 my $error = $void->insert || $linked->delete;
324 $dbh->rollback if $oldAutoCommit;
332 $error = $self->delete;
334 $dbh->rollback if $oldAutoCommit;
338 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
353 local $SIG{HUP} = 'IGNORE';
354 local $SIG{INT} = 'IGNORE';
355 local $SIG{QUIT} = 'IGNORE';
356 local $SIG{TERM} = 'IGNORE';
357 local $SIG{TSTP} = 'IGNORE';
358 local $SIG{PIPE} = 'IGNORE';
360 my $oldAutoCommit = $FS::UID::AutoCommit;
361 local $FS::UID::AutoCommit = 0;
364 foreach my $table (qw(
366 cust_bill_pkg_display
367 cust_bill_pkg_discount
368 cust_bill_pkg_tax_location
369 cust_bill_pkg_tax_rate_location
375 foreach my $linked ( qsearch($table, { billpkgnum=>$self->billpkgnum }) ) {
376 my $error = $linked->delete;
378 $dbh->rollback if $oldAutoCommit;
385 foreach my $cust_tax_adjustment (
386 qsearch('cust_tax_adjustment', { billpkgnum=>$self->billpkgnum })
388 $cust_tax_adjustment->billpkgnum(''); #NULL
389 my $error = $cust_tax_adjustment->replace;
391 $dbh->rollback if $oldAutoCommit;
396 my $error = $self->SUPER::delete(@_);
398 $dbh->rollback if $oldAutoCommit;
402 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
408 #alas, bin/follow-tax-rename
410 #=item replace OLD_RECORD
412 #Currently unimplemented. This would be even more of an accounting nightmare
413 #than deleteing the items. Just don't do it.
418 # return "Can't modify cust_bill_pkg records!";
423 Checks all fields to make sure this is a valid line item. If there is an
424 error, returns the error, otherwise returns false. Called by the insert
433 $self->ut_numbern('billpkgnum')
434 || $self->ut_snumber('pkgnum')
435 || $self->ut_number('invnum')
436 || $self->ut_money('setup')
437 || $self->ut_money('recur')
438 || $self->ut_numbern('sdate')
439 || $self->ut_numbern('edate')
440 || $self->ut_textn('itemdesc')
441 || $self->ut_textn('itemcomment')
442 || $self->ut_enum('hidden', [ '', 'Y' ])
444 return $error if $error;
446 $self->regularize_details;
448 #if ( $self->pkgnum != 0 ) { #allow unchecked pkgnum 0 for tax! (add to part_pkg?)
449 if ( $self->pkgnum > 0 ) { #allow -1 for non-pkg line items and 0 for tax (add to part_pkg?)
450 return "Unknown pkgnum ". $self->pkgnum
451 unless qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
454 return "Unknown invnum"
455 unless qsearchs( 'cust_bill' ,{ 'invnum' => $self->invnum } );
460 =item regularize_details
462 Converts the contents of the 'details' pseudo-field to
463 L<FS::cust_bill_pkg_detail> objects, if they aren't already.
467 sub regularize_details {
469 if ( $self->get('details') ) {
470 foreach my $detail ( @{$self->get('details')} ) {
471 if ( ref($detail) ne 'FS::cust_bill_pkg_detail' ) {
472 # then turn it into one
474 if ( ! ref($detail) ) {
475 $hash{'detail'} = $detail;
477 elsif ( ref($detail) eq 'HASH' ) {
480 elsif ( ref($detail) eq 'ARRAY' ) {
481 carp "passing invoice details as arrays is deprecated";
482 #carp "this way sucks, use a hash"; #but more useful/friendly
483 $hash{'format'} = $detail->[0];
484 $hash{'detail'} = $detail->[1];
485 $hash{'amount'} = $detail->[2];
486 $hash{'classnum'} = $detail->[3];
487 $hash{'phonenum'} = $detail->[4];
488 $hash{'accountcode'} = $detail->[5];
489 $hash{'startdate'} = $detail->[6];
490 $hash{'duration'} = $detail->[7];
491 $hash{'regionname'} = $detail->[8];
494 die "unknown detail type ". ref($detail);
496 $detail = new FS::cust_bill_pkg_detail \%hash;
498 $detail->billpkgnum($self->billpkgnum) if $self->billpkgnum;
506 Returns the invoice (see L<FS::cust_bill>) for this invoice line item.
512 qsearchs( 'cust_bill', { 'invnum' => $self->invnum } );
515 =item previous_cust_bill_pkg
517 Returns the previous cust_bill_pkg for this package, if any.
521 sub previous_cust_bill_pkg {
523 return unless $self->sdate;
525 'table' => 'cust_bill_pkg',
526 'hashref' => { 'pkgnum' => $self->pkgnum,
527 'sdate' => { op=>'<', value=>$self->sdate },
529 'order_by' => 'ORDER BY sdate DESC LIMIT 1',
535 Returns the amount owed (still outstanding) on this line item's setup fee,
536 which is the amount of the line item minus all payment applications (see
537 L<FS::cust_bill_pay_pkg> and credit applications (see
538 L<FS::cust_credit_bill_pkg>).
544 $self->owed('setup', @_);
549 Returns the amount owed (still outstanding) on this line item's recurring fee,
550 which is the amount of the line item minus all payment applications (see
551 L<FS::cust_bill_pay_pkg> and credit applications (see
552 L<FS::cust_credit_bill_pkg>).
558 $self->owed('recur', @_);
561 # modeled after cust_bill::owed...
563 my( $self, $field ) = @_;
564 my $balance = $self->$field();
565 $balance -= $_->amount foreach ( $self->cust_bill_pay_pkg($field) );
566 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) );
567 $balance = sprintf( '%.2f', $balance );
568 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
574 my( $self, $field ) = @_;
575 my $balance = $self->$field();
576 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) );
577 $balance = sprintf( '%.2f', $balance );
578 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
582 sub cust_bill_pay_pkg {
583 my( $self, $field ) = @_;
584 qsearch( 'cust_bill_pay_pkg', { 'billpkgnum' => $self->billpkgnum,
585 'setuprecur' => $field,
590 sub cust_credit_bill_pkg {
591 my( $self, $field ) = @_;
592 qsearch( 'cust_credit_bill_pkg', { 'billpkgnum' => $self->billpkgnum,
593 'setuprecur' => $field,
600 Returns the number of billing units (for tax purposes) represented by this,
607 $self->pkgnum ? $self->part_pkg->calc_units($self->cust_pkg) : 0; # 1?
611 =item set_display OPTION => VALUE ...
613 A helper method for I<insert>, populates the pseudo-field B<display> with
614 appropriate FS::cust_bill_pkg_display objects.
616 Options are passed as a list of name/value pairs. Options are:
618 part_pkg: FS::part_pkg object from this line item's package.
620 real_pkgpart: if this line item comes from a bundled package, the pkgpart
621 of the owning package. Otherwise the same as the part_pkg's pkgpart above.
626 my( $self, %opt ) = @_;
627 my $part_pkg = $opt{'part_pkg'};
628 my $cust_pkg = new FS::cust_pkg { pkgpart => $opt{real_pkgpart} };
630 my $conf = new FS::Conf;
632 # whether to break this down into setup/recur/usage
633 my $separate = $conf->exists('separate_usage');
635 my $usage_mandate = $part_pkg->option('usage_mandate', 'Hush!')
636 || $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
638 # or use the category from $opt{'part_pkg'} if its not bundled?
639 my $categoryname = $cust_pkg->part_pkg->categoryname;
641 # if we don't have to separate setup/recur/usage, or put this in a
642 # package-specific section, or display a usage summary, then don't
643 # even create one of these. The item will just display in the unnamed
644 # section as a single line plus details.
645 return $self->set('display', [])
646 unless $separate || $categoryname || $usage_mandate;
650 my %hash = ( 'section' => $categoryname );
652 # whether to put usage details in a separate section, and if so, which one
653 my $usage_section = $part_pkg->option('usage_section', 'Hush!')
654 || $cust_pkg->part_pkg->option('usage_section', 'Hush!');
656 # whether to show a usage summary line (total usage charges, no details)
657 my $summary = $part_pkg->option('summarize_usage', 'Hush!')
658 || $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
661 # create lines for setup and (non-usage) recur, in the main section
662 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
663 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
665 # display everything in a single line
666 push @display, new FS::cust_bill_pkg_display
669 # and if usage_mandate is enabled, hide details
670 # (this only works on multisection invoices...)
671 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
675 if ($separate && $usage_section && $summary) {
676 # create a line for the usage summary in the main section
677 push @display, new FS::cust_bill_pkg_display { type => 'U',
683 if ($usage_mandate || ($usage_section && $summary) ) {
684 $hash{post_total} = 'Y';
687 if ($separate || $usage_mandate) {
688 # show call details for this line item in the usage section.
689 # if usage_mandate is on, this will display below the section subtotal.
690 # this also happens if usage is in a separate section and there's a
691 # summary in the main section, though I'm not sure why.
692 $hash{section} = $usage_section if $usage_section;
693 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
696 $self->set('display', \@display);
702 Returns a hash: keys are "setup", "recur" or usage classnum, values are
703 FS::cust_bill_pkg objects, each with no more than a single class (setup or
710 # XXX this goes away with cust_bill_pkg refactor
712 my $cust_bill_pkg = new FS::cust_bill_pkg { $self->hash };
713 my %cust_bill_pkg = ();
715 $cust_bill_pkg{setup} = $cust_bill_pkg if $cust_bill_pkg->setup;
716 $cust_bill_pkg{recur} = $cust_bill_pkg if $cust_bill_pkg->recur;
719 #split setup and recur
720 if ($cust_bill_pkg->setup && $cust_bill_pkg->recur) {
721 my $cust_bill_pkg_recur = new FS::cust_bill_pkg { $cust_bill_pkg->hash };
722 $cust_bill_pkg->set('details', []);
723 $cust_bill_pkg->recur(0);
724 $cust_bill_pkg->unitrecur(0);
725 $cust_bill_pkg->type('');
726 $cust_bill_pkg_recur->setup(0);
727 $cust_bill_pkg_recur->unitsetup(0);
728 $cust_bill_pkg{recur} = $cust_bill_pkg_recur;
732 #split usage from recur
733 my $usage = sprintf( "%.2f", $cust_bill_pkg{recur}->usage )
734 if exists($cust_bill_pkg{recur});
735 warn "usage is $usage\n" if $DEBUG > 1;
737 my $cust_bill_pkg_usage =
738 new FS::cust_bill_pkg { $cust_bill_pkg{recur}->hash };
739 $cust_bill_pkg_usage->recur( $usage );
740 $cust_bill_pkg_usage->type( 'U' );
741 my $recur = sprintf( "%.2f", $cust_bill_pkg{recur}->recur - $usage );
742 $cust_bill_pkg{recur}->recur( $recur );
743 $cust_bill_pkg{recur}->type( '' );
744 $cust_bill_pkg{recur}->set('details', []);
745 $cust_bill_pkg{''} = $cust_bill_pkg_usage;
748 #subdivide usage by usage_class
749 if (exists($cust_bill_pkg{''})) {
750 foreach my $class (grep { $_ } $self->usage_classes) {
751 my $usage = sprintf( "%.2f", $cust_bill_pkg{''}->usage($class) );
752 my $cust_bill_pkg_usage =
753 new FS::cust_bill_pkg { $cust_bill_pkg{''}->hash };
754 $cust_bill_pkg_usage->recur( $usage );
755 $cust_bill_pkg_usage->set('details', []);
756 my $classless = sprintf( "%.2f", $cust_bill_pkg{''}->recur - $usage );
757 $cust_bill_pkg{''}->recur( $classless );
758 $cust_bill_pkg{$class} = $cust_bill_pkg_usage;
760 warn "Unexpected classless usage value: ". $cust_bill_pkg{''}->recur
761 if ($cust_bill_pkg{''}->recur && $cust_bill_pkg{''}->recur < 0);
762 delete $cust_bill_pkg{''}
763 unless ($cust_bill_pkg{''}->recur && $cust_bill_pkg{''}->recur > 0);
766 # # sort setup,recur,'', and the rest numeric && return
767 # my @result = map { $cust_bill_pkg{$_} }
768 # sort { my $ad = ($a=~/^\d+$/); my $bd = ($b=~/^\d+$/);
769 # ( $ad cmp $bd ) || ( $ad ? $a<=>$b : $b cmp $a )
771 # keys %cust_bill_pkg;
780 Returns the amount of the charge associated with usage class CLASSNUM if
781 CLASSNUM is defined. Otherwise returns the total charge associated with
787 my( $self, $classnum ) = @_;
788 $self->regularize_details;
790 if ( $self->get('details') ) {
793 map { $_->amount || 0 }
794 grep { !defined($classnum) or $classnum eq $_->classnum }
795 @{ $self->get('details') }
800 my $sql = 'SELECT SUM(COALESCE(amount,0)) FROM cust_bill_pkg_detail '.
801 ' WHERE billpkgnum = '. $self->billpkgnum;
802 $sql .= " AND classnum = $classnum" if defined($classnum);
804 my $sth = dbh->prepare($sql) or die dbh->errstr;
805 $sth->execute or die $sth->errstr;
807 return $sth->fetchrow_arrayref->[0] || 0;
815 Returns a list of usage classnums associated with this invoice line's
822 $self->regularize_details;
824 if ( $self->get('details') ) {
826 my %seen = ( map { $_->classnum => 1 } @{ $self->get('details') } );
832 qsearch({ table => 'cust_bill_pkg_detail',
833 hashref => { billpkgnum => $self->billpkgnum },
834 select => 'DISTINCT classnum',
841 sub cust_tax_exempt_pkg {
844 $self->{Hash}->{cust_tax_exempt_pkg} ||= [];
847 =item cust_bill_pkg_tax_Xlocation
849 Returns the list of associated cust_bill_pkg_tax_location and/or
850 cust_bill_pkg_tax_rate_location objects
854 sub cust_bill_pkg_tax_Xlocation {
857 my %hash = ( 'billpkgnum' => $self->billpkgnum );
860 qsearch ( 'cust_bill_pkg_tax_location', { %hash } ),
861 qsearch ( 'cust_bill_pkg_tax_rate_location', { %hash } )
866 =item recur_show_zero
870 sub recur_show_zero { shift->_X_show_zero('recur'); }
871 sub setup_show_zero { shift->_X_show_zero('setup'); }
874 my( $self, $what ) = @_;
876 return 0 unless $self->$what() == 0 && $self->pkgnum;
878 $self->cust_pkg->_X_show_zero($what);
881 =item credited [ BEFORE, AFTER, OPTIONS ]
883 Returns the sum of credits applied to this item. Arguments are the same as
884 owed_sql/paid_sql/credited_sql.
890 $self->scalar_sql('SELECT '. $self->credited_sql(@_).' FROM cust_bill_pkg WHERE billpkgnum = ?', $self->billpkgnum);
901 Returns an SQL expression for the total usage charges in details on
907 '(SELECT COALESCE(SUM(cust_bill_pkg_detail.amount),0)
908 FROM cust_bill_pkg_detail
909 WHERE cust_bill_pkg_detail.billpkgnum = cust_bill_pkg.billpkgnum)';
911 sub usage_sql { $usage_sql }
913 # this makes owed_sql, etc. much more concise
915 my ($class, $start, $end, %opt) = @_;
917 $opt{setuprecur} =~ /^s/ ? 'cust_bill_pkg.setup' :
918 $opt{setuprecur} =~ /^r/ ? 'cust_bill_pkg.recur' :
919 'cust_bill_pkg.setup + cust_bill_pkg.recur';
921 if ($opt{no_usage} and $charged =~ /recur/) {
922 $charged = "$charged - $usage_sql"
929 =item owed_sql [ BEFORE, AFTER, OPTIONS ]
931 Returns an SQL expression for the amount owed. BEFORE and AFTER specify
932 a date window. OPTIONS may include 'no_usage' (excludes usage charges)
933 and 'setuprecur' (set to "setup" or "recur" to limit to one or the other).
939 '(' . $class->charged_sql(@_) .
940 ' - ' . $class->paid_sql(@_) .
941 ' - ' . $class->credited_sql(@_) . ')'
944 =item paid_sql [ BEFORE, AFTER, OPTIONS ]
946 Returns an SQL expression for the sum of payments applied to this item.
951 my ($class, $start, $end, %opt) = @_;
952 my $s = $start ? "AND cust_pay._date <= $start" : '';
953 my $e = $end ? "AND cust_pay._date > $end" : '';
955 $opt{setuprecur} =~ /^s/ ? 'setup' :
956 $opt{setuprecur} =~ /^r/ ? 'recur' :
958 $setuprecur &&= "AND setuprecur = '$setuprecur'";
960 my $paid = "( SELECT COALESCE(SUM(cust_bill_pay_pkg.amount),0)
961 FROM cust_bill_pay_pkg JOIN cust_bill_pay USING (billpaynum)
962 JOIN cust_pay USING (paynum)
963 WHERE cust_bill_pay_pkg.billpkgnum = cust_bill_pkg.billpkgnum
964 $s $e $setuprecur )";
966 if ( $opt{no_usage} ) {
967 # cap the amount paid at the sum of non-usage charges,
968 # minus the amount credited against non-usage charges
970 $class->charged_sql($start, $end, %opt) . ' - ' .
971 $class->credited_sql($start, $end, %opt).')';
980 my ($class, $start, $end, %opt) = @_;
981 my $s = $start ? "AND cust_credit._date <= $start" : '';
982 my $e = $end ? "AND cust_credit._date > $end" : '';
984 $opt{setuprecur} =~ /^s/ ? 'setup' :
985 $opt{setuprecur} =~ /^r/ ? 'recur' :
987 $setuprecur &&= "AND setuprecur = '$setuprecur'";
989 my $credited = "( SELECT COALESCE(SUM(cust_credit_bill_pkg.amount),0)
990 FROM cust_credit_bill_pkg JOIN cust_credit_bill USING (creditbillnum)
991 JOIN cust_credit USING (crednum)
992 WHERE cust_credit_bill_pkg.billpkgnum = cust_bill_pkg.billpkgnum
993 $s $e $setuprecur )";
995 if ( $opt{no_usage} ) {
996 # cap the amount credited at the sum of non-usage charges
997 "LEAST($credited, ". $class->charged_sql($start, $end, %opt).')';
1005 sub upgrade_tax_location {
1006 # For taxes that were calculated/invoiced before cust_location refactoring
1007 # (May-June 2012), there are no cust_bill_pkg_tax_location records unless
1008 # they were calculated on a package-location basis. Create them here,
1009 # along with any necessary cust_location records and any tax exemption
1012 my ($class, %opt) = @_;
1013 # %opt may include 's' and 'e': start and end date ranges
1014 # and 'X': abort on any error, instead of just rolling back changes to
1017 my $oldAutoCommit = $FS::UID::AutoCommit;
1018 local $FS::UID::AutoCommit = 0;
1021 use FS::h_cust_main;
1022 use FS::h_cust_bill;
1024 use FS::h_cust_main_exemption;
1027 local $FS::cust_location::import = 1;
1029 my $conf = FS::Conf->new; # h_conf?
1030 return if $conf->exists('enable_taxproducts'); #don't touch this case
1031 my $use_ship = $conf->exists('tax-ship_address');
1033 my $date_where = '';
1035 $date_where .= " AND cust_bill._date >= $opt{s}";
1038 $date_where .= " AND cust_bill._date < $opt{e}";
1041 my $commit_each_invoice = 1 unless $opt{X};
1043 # if an invoice has either of these kinds of objects, then it doesn't
1044 # need to be upgraded...probably
1045 my $sub_has_tax_link = 'SELECT 1 FROM cust_bill_pkg_tax_location'.
1046 ' JOIN cust_bill_pkg USING (billpkgnum)'.
1047 ' WHERE cust_bill_pkg.invnum = cust_bill.invnum';
1048 my $sub_has_exempt = 'SELECT 1 FROM cust_tax_exempt_pkg'.
1049 ' JOIN cust_bill_pkg USING (billpkgnum)'.
1050 ' WHERE cust_bill_pkg.invnum = cust_bill.invnum'.
1051 ' AND exempt_monthly IS NULL';
1053 my @invnums = map { $_->invnum } qsearch({
1054 select => 'cust_bill.invnum',
1055 table => 'cust_bill',
1057 extra_sql => "WHERE NOT EXISTS($sub_has_tax_link) ".
1058 "AND NOT EXISTS($sub_has_exempt) ".
1062 print "Processing ".scalar(@invnums)." invoices...\n";
1066 foreach my $invnum (@invnums) {
1068 print STDERR "Invoice #$invnum\n";
1070 my %pkgpart_taxclass; # pkgpart => taxclass
1071 my %pkgpart_exempt_setup;
1072 my %pkgpart_exempt_recur;
1073 my $h_cust_bill = qsearchs('h_cust_bill',
1074 { invnum => $invnum,
1075 history_action => 'insert' });
1076 if (!$h_cust_bill) {
1077 warn "no insert record for invoice $invnum; skipped\n";
1078 #$date = $cust_bill->_date as a fallback?
1079 # We're trying to avoid using non-real dates (-d/-y invoice dates)
1080 # when looking up history records in other tables.
1083 my $custnum = $h_cust_bill->custnum;
1085 # Determine the address corresponding to this tax region.
1086 # It's either the bill or ship address of the customer as of the
1087 # invoice date-of-insertion. (Not necessarily the invoice date.)
1088 my $date = $h_cust_bill->history_date;
1089 my $h_cust_main = qsearchs('h_cust_main',
1090 { custnum => $custnum },
1091 FS::h_cust_main->sql_h_searchs($date)
1093 if (!$h_cust_main ) {
1094 warn "no historical address for cust#".$h_cust_bill->custnum."; skipped\n";
1096 # fallback to current $cust_main? sounds dangerous.
1099 # This is a historical customer record, so it has a historical address.
1100 # If there's no cust_location matching this custnum and address (there
1101 # probably isn't), create one.
1102 $pre = 'ship_' if $use_ship and length($h_cust_main->get('ship_last'));
1103 my %hash = map { $_ => $h_cust_main->get($pre.$_) }
1104 FS::cust_main->location_fields;
1105 # not really needed for this, and often result in duplicate locations
1106 delete @hash{qw(censustract censusyear latitude longitude coord_auto)};
1108 $hash{custnum} = $h_cust_main->custnum;
1109 my $tax_loc = FS::cust_location->new(\%hash);
1110 my $error = $tax_loc->find_or_insert || $tax_loc->disable_if_unused;
1112 warn "couldn't create historical location record for cust#".
1113 $h_cust_main->custnum.": $error\n";
1116 my $exempt_cust = 1 if $h_cust_main->tax;
1118 # Get any per-customer taxname exemptions that were in effect.
1119 my %exempt_cust_taxname = map {
1121 } qsearch('h_cust_main_exemption', { 'custnum' => $custnum },
1122 FS::h_cust_main_exemption->sql_h_searchs($date)
1125 # classify line items
1127 my %nontax_items; # taxclass => array of cust_bill_pkg
1128 foreach my $item ($h_cust_bill->cust_bill_pkg) {
1129 my $pkgnum = $item->pkgnum;
1131 if ( $pkgnum == 0 ) {
1133 push @tax_items, $item;
1136 # (pkgparts really shouldn't change, right?)
1137 my $h_cust_pkg = qsearchs('h_cust_pkg', { pkgnum => $pkgnum },
1138 FS::h_cust_pkg->sql_h_searchs($date)
1140 if ( !$h_cust_pkg ) {
1141 warn "no historical package #".$item->pkgpart."; skipped\n";
1144 my $pkgpart = $h_cust_pkg->pkgpart;
1146 if (!exists $pkgpart_taxclass{$pkgpart}) {
1147 my $h_part_pkg = qsearchs('h_part_pkg', { pkgpart => $pkgpart },
1148 FS::h_part_pkg->sql_h_searchs($date)
1150 if ( !$h_part_pkg ) {
1151 warn "no historical package def #$pkgpart; skipped\n";
1154 $pkgpart_taxclass{$pkgpart} = $h_part_pkg->taxclass || '';
1155 $pkgpart_exempt_setup{$pkgpart} = 1 if $h_part_pkg->setuptax;
1156 $pkgpart_exempt_recur{$pkgpart} = 1 if $h_part_pkg->recurtax;
1159 # mark any exemptions that apply
1160 if ( $pkgpart_exempt_setup{$pkgpart} ) {
1161 $item->set('exempt_setup' => 1);
1164 if ( $pkgpart_exempt_recur{$pkgpart} ) {
1165 $item->set('exempt_recur' => 1);
1168 my $taxclass = $pkgpart_taxclass{ $pkgpart };
1170 $nontax_items{$taxclass} ||= [];
1171 push @{ $nontax_items{$taxclass} }, $item;
1174 printf("%d tax items: \$%.2f\n", scalar(@tax_items), map {$_->setup} @tax_items)
1177 # Use a variation on the procedure in
1178 # FS::cust_main::Billing::_handle_taxes to identify taxes that apply
1180 my @loc_keys = qw( district city county state country );
1181 my %taxhash = map { $_ => $h_cust_main->get($pre.$_) } @loc_keys;
1182 my %taxdef_by_name; # by name, and then by taxclass
1183 my %est_tax; # by name, and then by taxclass
1184 my %taxable_items; # by taxnum, and then an array
1186 foreach my $taxclass (keys %nontax_items) {
1187 my %myhash = %taxhash;
1188 my @elim = qw( district city county state );
1189 my @taxdefs; # because there may be several with different taxnames
1191 $myhash{taxclass} = $taxclass;
1192 @taxdefs = qsearch('cust_main_county', \%myhash);
1194 $myhash{taxclass} = '';
1195 @taxdefs = qsearch('cust_main_county', \%myhash);
1197 $myhash{ shift @elim } = '';
1198 } while scalar(@elim) and !@taxdefs;
1200 print "Class '$taxclass': ". scalar(@{ $nontax_items{$taxclass} }).
1201 " items, ". scalar(@taxdefs)." tax defs found.\n";
1202 foreach my $taxdef (@taxdefs) {
1203 next if $taxdef->tax == 0;
1204 $taxdef_by_name{$taxdef->taxname}{$taxdef->taxclass} = $taxdef;
1206 $taxable_items{$taxdef->taxnum} ||= [];
1207 foreach my $orig_item (@{ $nontax_items{$taxclass} }) {
1208 # clone the item so that taxdef-dependent changes don't
1209 # change it for other taxdefs
1210 my $item = FS::cust_bill_pkg->new({ $orig_item->hash });
1212 # these flags are already set if the part_pkg declares itself exempt
1213 $item->set('exempt_setup' => 1) if $taxdef->setuptax;
1214 $item->set('exempt_recur' => 1) if $taxdef->recurtax;
1217 my $taxable = $item->setup + $item->recur;
1219 # h_cust_credit_bill_pkg?
1220 # NO. Because if these exemptions HAD been created at the time of
1221 # billing, and then a credit applied later, the exemption would
1222 # have been adjusted by the amount of the credit. So we adjust
1223 # the taxable amount before creating the exemption.
1224 # But don't deduct the credit from taxable, because the tax was
1225 # calculated before the credit was applied.
1226 foreach my $f (qw(setup recur)) {
1227 my $credited = FS::Record->scalar_sql(
1228 "SELECT SUM(amount) FROM cust_credit_bill_pkg ".
1229 "WHERE billpkgnum = ? AND setuprecur = ?",
1233 $item->set($f, $item->get($f) - $credited) if $credited;
1235 my $existing_exempt = FS::Record->scalar_sql(
1236 "SELECT SUM(amount) FROM cust_tax_exempt_pkg WHERE ".
1237 "billpkgnum = ? AND taxnum = ?",
1238 $item->billpkgnum, $taxdef->taxnum
1240 $taxable -= $existing_exempt;
1242 if ( $taxable and $exempt_cust ) {
1243 push @new_exempt, { exempt_cust => 'Y', amount => $taxable };
1246 if ( $taxable and $exempt_cust_taxname{$taxdef->taxname} ){
1247 push @new_exempt, { exempt_cust_taxname => 'Y', amount => $taxable };
1250 if ( $taxable and $item->exempt_setup ) {
1251 push @new_exempt, { exempt_setup => 'Y', amount => $item->setup };
1252 $taxable -= $item->setup;
1254 if ( $taxable and $item->exempt_recur ) {
1255 push @new_exempt, { exempt_recur => 'Y', amount => $item->recur };
1256 $taxable -= $item->recur;
1259 $item->set('taxable' => $taxable);
1260 push @{ $taxable_items{$taxdef->taxnum} }, $item
1263 # estimate the amount of tax (this is necessary because different
1264 # taxdefs with the same taxname may have different tax rates)
1265 # and sum that for each taxname/taxclass combination
1267 $est_tax{$taxdef->taxname} ||= {};
1268 $est_tax{$taxdef->taxname}{$taxdef->taxclass} ||= 0;
1269 $est_tax{$taxdef->taxname}{$taxdef->taxclass} +=
1270 $taxable * $taxdef->tax;
1272 foreach (@new_exempt) {
1273 next if $_->{amount} == 0;
1274 my $cust_tax_exempt_pkg = FS::cust_tax_exempt_pkg->new({
1276 billpkgnum => $item->billpkgnum,
1277 taxnum => $taxdef->taxnum,
1279 my $error = $cust_tax_exempt_pkg->insert;
1281 my $pkgnum = $item->pkgnum;
1282 warn "error creating tax exemption for inv$invnum pkg$pkgnum:".
1286 } #foreach @new_exempt
1289 } #foreach $taxclass
1291 # Now go through the billed taxes and match them up with the line items.
1292 TAX_ITEM: foreach my $tax_item ( @tax_items )
1294 my $taxname = $tax_item->itemdesc;
1295 $taxname = '' if $taxname eq 'Tax';
1297 if ( !exists( $taxdef_by_name{$taxname} ) ) {
1298 # then we didn't find any applicable taxes with this name
1299 warn "no definition found for tax item '$taxname'.\n".
1300 '('.join(' ', @hash{qw(country state county city district)}).")\n";
1301 # possibly all of these should be "next TAX_ITEM", but whole invoices
1302 # are transaction protected and we can go back and retry them.
1305 # classname => cust_main_county
1306 my %taxdef_by_class = %{ $taxdef_by_name{$taxname} };
1308 # Divide the tax item among taxclasses, if necessary
1309 # classname => estimated tax amount
1310 my $this_est_tax = $est_tax{$taxname};
1311 if (!defined $this_est_tax) {
1312 warn "no taxable sales found for inv#$invnum, tax item '$taxname'.\n";
1315 my $est_total = sum(values %$this_est_tax);
1316 if ( $est_total == 0 ) {
1318 warn "estimated tax on invoice #$invnum is zero.\n";
1322 my $real_tax = $tax_item->setup;
1323 printf ("Distributing \$%.2f tax:\n", $real_tax);
1324 my $cents_remaining = $real_tax * 100; # for rounding error
1325 my @tax_links; # partial CBPTL hashrefs
1326 foreach my $taxclass (keys %taxdef_by_class) {
1327 my $taxdef = $taxdef_by_class{$taxclass};
1328 # these items already have "taxable" set to their charge amount
1329 # after applying any credits or exemptions
1330 my @items = @{ $taxable_items{$taxdef->taxnum} };
1331 my $subtotal = sum(map {$_->get('taxable')} @items);
1332 printf("\t$taxclass: %.2f\n", $this_est_tax->{$taxclass}/$est_total);
1334 foreach my $nontax (@items) {
1335 my $part = int($real_tax
1337 * ($this_est_tax->{$taxclass}/$est_total)
1339 * ($nontax->get('taxable'))/$subtotal
1343 $cents_remaining -= $part;
1345 taxnum => $taxdef->taxnum,
1346 pkgnum => $nontax->pkgnum,
1347 billpkgnum => $nontax->billpkgnum,
1351 } #foreach $taxclass
1352 # Distribute any leftover tax round-robin style, one cent at a time.
1354 my $nlinks = scalar(@tax_links);
1356 while (int($cents_remaining) > 0) {
1357 $tax_links[$i % $nlinks]->{cents} += 1;
1362 warn "Can't create tax links--no taxable items found.\n";
1366 # Gather credit/payment applications so that we can link them
1369 qsearch( 'cust_credit_bill_pkg',
1370 { billpkgnum => $tax_item->billpkgnum, billpkgtaxlocationnum => '' }
1372 qsearch( 'cust_bill_pay_pkg',
1373 { billpkgnum => $tax_item->billpkgnum, billpkgtaxlocationnum => '' }
1377 # grab the first one
1378 my $this_unlinked = shift @unlinked;
1379 my $unlinked_cents = int($this_unlinked->amount * 100) if $this_unlinked;
1381 # Create tax links (yay!)
1382 printf("Creating %d tax links.\n",scalar(@tax_links));
1383 foreach (@tax_links) {
1384 my $link = FS::cust_bill_pkg_tax_location->new({
1385 billpkgnum => $tax_item->billpkgnum,
1386 taxtype => 'FS::cust_main_county',
1387 locationnum => $tax_loc->locationnum,
1388 taxnum => $_->{taxnum},
1389 pkgnum => $_->{pkgnum},
1390 amount => sprintf('%.2f', $_->{cents} / 100),
1391 taxable_billpkgnum => $_->{billpkgnum},
1393 my $error = $link->insert;
1395 warn "Can't create tax link for inv#$invnum: $error\n";
1399 my $link_cents = $_->{cents};
1400 # update/create subitem links
1402 # If $this_unlinked is undef, then we've allocated all of the
1403 # credit/payment applications to the tax item. If $link_cents is 0,
1404 # then we've applied credits/payments to all of this package fraction,
1405 # so go on to the next.
1406 while ($this_unlinked and $link_cents) {
1407 # apply as much as possible of $link_amount to this credit/payment
1409 my $apply_cents = min($link_cents, $unlinked_cents);
1410 $link_cents -= $apply_cents;
1411 $unlinked_cents -= $apply_cents;
1412 # $link_cents or $unlinked_cents or both are now zero
1413 $this_unlinked->set('amount' => sprintf('%.2f',$apply_cents/100));
1414 $this_unlinked->set('billpkgtaxlocationnum' => $link->billpkgtaxlocationnum);
1415 my $pkey = $this_unlinked->primary_key; #creditbillpkgnum or billpaypkgnum
1416 if ( $this_unlinked->$pkey ) {
1417 # then it's an existing link--replace it
1418 $error = $this_unlinked->replace;
1420 $this_unlinked->insert;
1422 # what do we do with errors at this stage?
1424 warn "Error creating tax application link: $error\n";
1425 next INVOICE; # for lack of a better idea
1428 if ( $unlinked_cents == 0 ) {
1429 # then we've allocated all of this payment/credit application,
1430 # so grab the next one
1431 $this_unlinked = shift @unlinked;
1432 $unlinked_cents = int($this_unlinked->amount * 100) if $this_unlinked;
1433 } elsif ( $link_cents == 0 ) {
1434 # then we've covered all of this package tax fraction, so split
1435 # off a new application from this one
1436 $this_unlinked = $this_unlinked->new({
1437 $this_unlinked->hash,
1440 # $unlinked_cents is still what it is
1443 } #while $this_unlinked and $link_cents
1444 } #foreach (@tax_links)
1445 } #foreach $tax_item
1447 $dbh->commit if $commit_each_invoice and $oldAutoCommit;
1453 $dbh->rollback if $oldAutoCommit;
1454 die "Upgrade halted.\n" unless $commit_each_invoice;
1458 $dbh->commit if $oldAutoCommit and !$commit_each_invoice;
1463 # Create a queue job to run upgrade_tax_location from January 1, 2012 to
1467 use Date::Parse 'str2time';
1470 my $upgrade = 'tax_location_2012';
1471 return if FS::upgrade_journal->is_done($upgrade);
1472 my $job = FS::queue->new({
1473 'job' => 'FS::cust_bill_pkg::upgrade_tax_location'
1475 # call it kind of like a class method, not that it matters much
1476 $job->insert($class, 's' => str2time('2012-01-01'));
1477 # Then mark the upgrade as done, so that we don't queue the job twice
1478 # and somehow run two of them concurrently.
1479 FS::upgrade_journal->set_done($upgrade);
1480 # This upgrade now does the job of assigning taxable_billpkgnums to
1481 # cust_bill_pkg_tax_location, so set that task done also.
1482 FS::upgrade_journal->set_done('tax_location_taxable_billpkgnum');
1489 setup and recur shouldn't be separate fields. There should be one "amount"
1490 field and a flag to tell you if it is a setup/one-time fee or a recurring fee.
1492 A line item with both should really be two separate records (preserving
1493 sdate and edate for setup fees for recurring packages - that information may
1494 be valuable later). Invoice generation (cust_main::bill), invoice printing
1495 (cust_bill), tax reports (report_tax.cgi) and line item reports
1496 (cust_bill_pkg.cgi) would need to be updated.
1498 owed_setup and owed_recur could then be repaced by just owed, and
1499 cust_bill::open_cust_bill_pkg and
1500 cust_bill_ApplicationCommon::apply_to_lineitems could be simplified.
1502 The upgrade procedure is pretty sketchy.
1506 L<FS::Record>, L<FS::cust_bill>, L<FS::cust_pkg>, L<FS::cust_main>, schema.html
1507 from the base documentation.