1 package FS::cust_main::Billing;
4 use vars qw( $conf $DEBUG $me );
7 use List::Util qw( min );
9 use FS::Record qw( qsearch qsearchs dbdef );
11 use FS::cust_bill_pkg;
12 use FS::cust_bill_pkg_display;
13 use FS::cust_bill_pay;
14 use FS::cust_credit_bill;
15 use FS::cust_tax_adjustment;
17 use FS::tax_rate_location;
18 use FS::cust_bill_pkg_tax_location;
19 use FS::cust_bill_pkg_tax_rate_location;
21 use FS::part_event_condition;
24 # 1 is mostly method/subroutine entry and options
25 # 2 traces progress of some operations
26 # 3 is even more information including possibly sensitive data
28 $me = '[FS::cust_main::Billing]';
30 install_callback FS::UID sub {
32 #yes, need it for stuff below (prolly should be cached)
37 FS::cust_main::Billing - Billing mixin for cust_main
43 These methods are available on FS::cust_main objects.
49 =item bill_and_collect
51 Cancels and suspends any packages due, generates bills, applies payments and
52 credits, and applies collection events to run cards, send bills and notices,
55 By default, warns on errors and continues with the next operation (but see the
58 Options are passed as name-value pairs. Currently available options are:
64 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
68 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
72 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
76 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
80 If set true, re-charges setup fees.
84 If set any errors prevent subsequent operations from continusing. If set
85 specifically to "return", returns the error (or false, if there is no error).
86 Any other true value causes errors to die.
90 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
94 Optional FS::queue entry to receive status updates.
98 Options are passed to the B<bill> and B<collect> methods verbatim, so all
99 options of those methods are also available.
103 sub bill_and_collect {
104 my( $self, %options ) = @_;
108 #$options{actual_time} not $options{time} because freeside-daily -d is for
109 #pre-printing invoices
111 $options{'actual_time'} ||= time;
112 my $job = $options{'job'};
114 $job->update_statustext('0,cleaning expired packages') if $job;
115 $error = $self->cancel_expired_pkgs( $options{actual_time} );
117 $error = "Error expiring custnum ". $self->custnum. ": $error";
118 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
119 elsif ( $options{fatal} ) { die $error; }
120 else { warn $error; }
123 $error = $self->suspend_adjourned_pkgs( $options{actual_time} );
125 $error = "Error adjourning custnum ". $self->custnum. ": $error";
126 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
127 elsif ( $options{fatal} ) { die $error; }
128 else { warn $error; }
131 $job->update_statustext('20,billing packages') if $job;
132 $error = $self->bill( %options );
134 $error = "Error billing custnum ". $self->custnum. ": $error";
135 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
136 elsif ( $options{fatal} ) { die $error; }
137 else { warn $error; }
140 $job->update_statustext('50,applying payments and credits') if $job;
141 $error = $self->apply_payments_and_credits;
143 $error = "Error applying custnum ". $self->custnum. ": $error";
144 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
145 elsif ( $options{fatal} ) { die $error; }
146 else { warn $error; }
149 $job->update_statustext('70,running collection events') if $job;
150 unless ( $conf->exists('cancelled_cust-noevents')
151 && ! $self->num_ncancelled_pkgs
153 $error = $self->collect( %options );
155 $error = "Error collecting custnum ". $self->custnum. ": $error";
156 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
157 elsif ($options{fatal} ) { die $error; }
158 else { warn $error; }
161 $job->update_statustext('100,finished') if $job;
167 sub cancel_expired_pkgs {
168 my ( $self, $time, %options ) = @_;
170 my @cancel_pkgs = $self->ncancelled_pkgs( {
171 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
176 foreach my $cust_pkg ( @cancel_pkgs ) {
177 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
178 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
179 'reason_otaker' => $cpr->otaker
183 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
186 scalar(@errors) ? join(' / ', @errors) : '';
190 sub suspend_adjourned_pkgs {
191 my ( $self, $time, %options ) = @_;
193 my @susp_pkgs = $self->ncancelled_pkgs( {
195 " AND ( susp IS NULL OR susp = 0 )
196 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
197 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
202 #only because there's no SQL test for is_prepaid :/
204 grep { ( $_->part_pkg->is_prepaid
209 && $_->adjourn <= $time
217 foreach my $cust_pkg ( @susp_pkgs ) {
218 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
219 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
220 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
221 'reason_otaker' => $cpr->otaker
225 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
228 scalar(@errors) ? join(' / ', @errors) : '';
234 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
235 conjunction with the collect method by calling B<bill_and_collect>.
237 If there is an error, returns the error, otherwise returns false.
239 Options are passed as name-value pairs. Currently available options are:
245 If set true, re-charges setup fees.
249 If set true then only bill recurring charges, not setup, usage, one time
254 If set, then override the normal frequency and look for a part_pkg_discount
255 to take at that frequency.
259 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
263 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
267 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
269 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
273 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
277 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
281 This boolean value informs the us that the package is being cancelled. This
282 typically might mean not charging the normal recurring fee but only usage
283 fees since the last billing. Setup charges may be charged. Not all package
284 plans support this feature (they tend to charge 0).
288 Prevent the resetting of usage limits during this call.
292 Do not save the generated bill in the database. Useful with return_bill
296 A list reference on which the generated bill(s) will be returned.
300 Optional terms to be printed on this invoice. Otherwise, customer-specific
301 terms or the default terms are used.
308 my( $self, %options ) = @_;
310 return '' if $self->payby eq 'COMP';
312 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
314 warn "$me bill customer ". $self->custnum. "\n"
317 my $time = $options{'time'} || time;
318 my $invoice_time = $options{'invoice_time'} || $time;
320 $options{'not_pkgpart'} ||= {};
321 $options{'not_pkgpart'} = { map { $_ => 1 }
322 split(/\s*,\s*/, $options{'not_pkgpart'})
324 unless ref($options{'not_pkgpart'});
326 local $SIG{HUP} = 'IGNORE';
327 local $SIG{INT} = 'IGNORE';
328 local $SIG{QUIT} = 'IGNORE';
329 local $SIG{TERM} = 'IGNORE';
330 local $SIG{TSTP} = 'IGNORE';
331 local $SIG{PIPE} = 'IGNORE';
333 my $oldAutoCommit = $FS::UID::AutoCommit;
334 local $FS::UID::AutoCommit = 0;
337 warn "$me acquiring lock on customer ". $self->custnum. "\n"
340 $self->select_for_update; #mutex
342 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
345 my $error = $self->do_cust_event(
346 'debug' => ( $options{'debug'} || 0 ),
347 'time' => $invoice_time,
348 'check_freq' => $options{'check_freq'},
349 'stage' => 'pre-bill',
351 unless $options{no_commit};
353 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
357 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
360 #keep auto-charge and non-auto-charge line items separate
361 my @passes = ( '', 'no_auto' );
363 my %cust_bill_pkg = map { $_ => [] } @passes;
366 # find the packages which are due for billing, find out how much they are
367 # & generate invoice database.
370 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
371 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
373 my %taxlisthash = map { $_ => {} } @passes;
375 my @precommit_hooks = ();
377 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
378 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
380 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
382 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
384 #? to avoid use of uninitialized value errors... ?
385 $cust_pkg->setfield('bill', '')
386 unless defined($cust_pkg->bill);
388 #my $part_pkg = $cust_pkg->part_pkg;
390 my $real_pkgpart = $cust_pkg->pkgpart;
391 my %hash = $cust_pkg->hash;
393 # we could implement this bit as FS::part_pkg::has_hidden, but we already
394 # suffer from performance issues
395 $options{has_hidden} = 0;
396 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
397 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
399 foreach my $part_pkg ( @part_pkg ) {
401 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
403 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
406 $self->_make_lines( 'part_pkg' => $part_pkg,
407 'cust_pkg' => $cust_pkg,
408 'precommit_hooks' => \@precommit_hooks,
409 'line_items' => $cust_bill_pkg{$pass},
410 'setup' => $total_setup{$pass},
411 'recur' => $total_recur{$pass},
412 'tax_matrix' => $taxlisthash{$pass},
414 'real_pkgpart' => $real_pkgpart,
415 'options' => \%options,
418 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
422 } #foreach my $part_pkg
424 } #foreach my $cust_pkg
426 #if the customer isn't on an automatic payby, everything can go on a single
428 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
429 #merge everything into one list
432 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
434 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
436 next unless @cust_bill_pkg; #don't create an invoice w/o line items
438 warn "$me billing pass $pass\n"
439 #.Dumper(\@cust_bill_pkg)."\n"
442 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
443 !$conf->exists('postal_invoice-recurring_only')
447 my $postal_pkg = $self->charge_postal_fee();
448 if ( $postal_pkg && !ref( $postal_pkg ) ) {
450 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
451 return "can't charge postal invoice fee for customer ".
452 $self->custnum. ": $postal_pkg";
454 } elsif ( $postal_pkg ) {
456 my $real_pkgpart = $postal_pkg->pkgpart;
457 # we could implement this bit as FS::part_pkg::has_hidden, but we already
458 # suffer from performance issues
459 $options{has_hidden} = 0;
460 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
461 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
463 foreach my $part_pkg ( @part_pkg ) {
464 my %postal_options = %options;
465 delete $postal_options{cancel};
467 $self->_make_lines( 'part_pkg' => $part_pkg,
468 'cust_pkg' => $postal_pkg,
469 'precommit_hooks' => \@precommit_hooks,
470 'line_items' => \@cust_bill_pkg,
471 'setup' => $total_setup{$pass},
472 'recur' => $total_recur{$pass},
473 'tax_matrix' => $taxlisthash{$pass},
475 'real_pkgpart' => $real_pkgpart,
476 'options' => \%postal_options,
479 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
484 # it's silly to have a zero value postal_pkg, but....
485 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
491 my $listref_or_error =
492 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
494 unless ( ref( $listref_or_error ) ) {
495 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
496 return $listref_or_error;
499 foreach my $taxline ( @$listref_or_error ) {
500 ${ $total_setup{$pass} } =
501 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
502 push @cust_bill_pkg, $taxline;
506 warn "adding tax adjustments...\n" if $DEBUG > 2;
507 foreach my $cust_tax_adjustment (
508 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
514 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
516 my $itemdesc = $cust_tax_adjustment->taxname;
517 $itemdesc = '' if $itemdesc eq 'Tax';
519 push @cust_bill_pkg, new FS::cust_bill_pkg {
525 'itemdesc' => $itemdesc,
526 'itemcomment' => $cust_tax_adjustment->comment,
527 'cust_tax_adjustment' => $cust_tax_adjustment,
528 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
533 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
535 my @cust_bill = $self->cust_bill;
536 my $balance = $self->balance;
537 my $previous_balance = scalar(@cust_bill)
538 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
541 $previous_balance += $cust_bill[$#cust_bill]->charged
542 if scalar(@cust_bill);
543 #my $balance_adjustments =
544 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
546 warn "creating the new invoice\n" if $DEBUG;
547 #create the new invoice
548 my $cust_bill = new FS::cust_bill ( {
549 'custnum' => $self->custnum,
550 '_date' => $invoice_time,
551 'charged' => $charged,
552 'billing_balance' => $balance,
553 'previous_balance' => $previous_balance,
554 'invoice_terms' => $options{'invoice_terms'},
555 'cust_bill_pkg' => \@cust_bill_pkg,
557 $error = $cust_bill->insert unless $options{no_commit};
559 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
560 return "can't create invoice for customer #". $self->custnum. ": $error";
562 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
564 } #foreach my $pass ( keys %cust_bill_pkg )
566 foreach my $hook ( @precommit_hooks ) {
569 } unless $options{no_commit};
571 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
572 return "$@ running precommit hook $hook\n";
576 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
581 #discard bundled packages of 0 value
582 sub _omit_zero_value_bundles {
585 my @cust_bill_pkg = ();
586 my @cust_bill_pkg_bundle = ();
588 my $discount_show_always = 0;
590 foreach my $cust_bill_pkg ( @in ) {
592 $discount_show_always = ($cust_bill_pkg->get('discounts')
593 && scalar(@{$cust_bill_pkg->get('discounts')})
594 && $conf->exists('discount-show-always'));
596 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
597 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
598 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
601 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
602 push @cust_bill_pkg, @cust_bill_pkg_bundle
604 || ($sum == 0 && ( $discount_show_always
605 || grep {$_->recur_show_zero || $_->setup_show_zero}
606 @cust_bill_pkg_bundle
609 @cust_bill_pkg_bundle = ();
613 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
614 push @cust_bill_pkg_bundle, $cust_bill_pkg;
618 push @cust_bill_pkg, @cust_bill_pkg_bundle
620 || ($sum == 0 && ( $discount_show_always
621 || grep {$_->recur_show_zero || $_->setup_show_zero}
622 @cust_bill_pkg_bundle
626 warn " _omit_zero_value_bundles: ". scalar(@in).
627 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
634 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
636 This is a weird one. Perhaps it should not even be exposed.
638 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
639 Usually used internally by bill method B<bill>.
641 If there is an error, returns the error, otherwise returns reference to a
642 list of line items suitable for insertion.
648 An array ref of the line items being billed.
652 A strange beast. The keys to this hash are internal identifiers consisting
653 of the name of the tax object type, a space, and its unique identifier ( e.g.
654 'cust_main_county 23' ). The values of the hash are listrefs. The first
655 item in the list is the tax object. The remaining items are either line
656 items or floating point values (currency amounts).
658 The taxes are calculated on this entity. Calculated exemption records are
659 transferred to the LINEITEMREF items on the assumption that they are related.
665 This specifies the date appearing on the associated invoice. Some
666 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
672 sub calculate_taxes {
673 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
675 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
677 warn "$me calculate_taxes\n"
678 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
681 my @tax_line_items = ();
683 # keys are tax names (as printed on invoices / itemdesc )
684 # values are listrefs of taxlisthash keys (internal identifiers)
687 # keys are taxlisthash keys (internal identifiers)
688 # values are (cumulative) amounts
691 # keys are taxlisthash keys (internal identifiers)
692 # values are listrefs of cust_bill_pkg_tax_location hashrefs
693 my %tax_location = ();
695 # keys are taxlisthash keys (internal identifiers)
696 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
697 my %tax_rate_location = ();
699 foreach my $tax ( keys %$taxlisthash ) {
700 my $tax_object = shift @{ $taxlisthash->{$tax} };
701 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
702 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
703 my $hashref_or_error =
704 $tax_object->taxline( $taxlisthash->{$tax},
705 'custnum' => $self->custnum,
706 'invoice_time' => $invoice_time
708 return $hashref_or_error unless ref($hashref_or_error);
710 unshift @{ $taxlisthash->{$tax} }, $tax_object;
712 my $name = $hashref_or_error->{'name'};
713 my $amount = $hashref_or_error->{'amount'};
715 #warn "adding $amount as $name\n";
716 $taxname{ $name } ||= [];
717 push @{ $taxname{ $name } }, $tax;
719 $tax{ $tax } += $amount;
721 $tax_location{ $tax } ||= [];
722 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
723 push @{ $tax_location{ $tax } },
725 'taxnum' => $tax_object->taxnum,
726 'taxtype' => ref($tax_object),
727 'pkgnum' => $tax_object->get('pkgnum'),
728 'locationnum' => $tax_object->get('locationnum'),
729 'amount' => sprintf('%.2f', $amount ),
733 $tax_rate_location{ $tax } ||= [];
734 if ( ref($tax_object) eq 'FS::tax_rate' ) {
735 my $taxratelocationnum =
736 $tax_object->tax_rate_location->taxratelocationnum;
737 push @{ $tax_rate_location{ $tax } },
739 'taxnum' => $tax_object->taxnum,
740 'taxtype' => ref($tax_object),
741 'amount' => sprintf('%.2f', $amount ),
742 'locationtaxid' => $tax_object->location,
743 'taxratelocationnum' => $taxratelocationnum,
749 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
750 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
751 foreach my $tax ( keys %$taxlisthash ) {
752 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
753 next unless ref($_) eq 'FS::cust_bill_pkg';
755 my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
757 next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
758 die "can't distribute tax exemptions: no line item for ". Dumper($_).
759 " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
760 unless $packagemap{$_->pkgnum};
762 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
763 @cust_tax_exempt_pkg;
767 #consolidate and create tax line items
768 warn "consolidating and generating...\n" if $DEBUG > 2;
769 foreach my $taxname ( keys %taxname ) {
772 my @cust_bill_pkg_tax_location = ();
773 my @cust_bill_pkg_tax_rate_location = ();
774 warn "adding $taxname\n" if $DEBUG > 1;
775 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
776 next if $seen{$taxitem}++;
777 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
778 $tax += $tax{$taxitem};
779 push @cust_bill_pkg_tax_location,
780 map { new FS::cust_bill_pkg_tax_location $_ }
781 @{ $tax_location{ $taxitem } };
782 push @cust_bill_pkg_tax_rate_location,
783 map { new FS::cust_bill_pkg_tax_rate_location $_ }
784 @{ $tax_rate_location{ $taxitem } };
788 $tax = sprintf('%.2f', $tax );
790 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
796 if ( $pkg_category and
797 $conf->config('invoice_latexsummary') ||
798 $conf->config('invoice_htmlsummary')
802 my %hash = ( 'section' => $pkg_category->categoryname );
803 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
807 push @tax_line_items, new FS::cust_bill_pkg {
813 'itemdesc' => $taxname,
814 'display' => \@display,
815 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
816 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
825 my ($self, %params) = @_;
827 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
829 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
830 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
831 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
832 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
833 my $total_setup = $params{setup} or die "no setup accumulator specified";
834 my $total_recur = $params{recur} or die "no recur accumulator specified";
835 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
836 my $time = $params{'time'} or die "no time specified";
837 my (%options) = %{$params{options}};
840 my $real_pkgpart = $params{real_pkgpart};
841 my %hash = $cust_pkg->hash;
842 my $old_cust_pkg = new FS::cust_pkg \%hash;
848 $cust_pkg->pkgpart($part_pkg->pkgpart);
856 my %setup_param = ();
857 if ( ! $options{recurring_only}
858 and ! $options{cancel}
859 and ( $options{'resetup'}
860 || ( ! $cust_pkg->setup
861 && ( ! $cust_pkg->start_date
862 || $cust_pkg->start_date <= $time
864 && ( ! $conf->exists('disable_setup_suspended_pkgs')
865 || ( $conf->exists('disable_setup_suspended_pkgs') &&
866 ! $cust_pkg->getfield('susp')
874 warn " bill setup\n" if $DEBUG > 1;
876 unless ( $cust_pkg->waive_setup ) {
879 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
880 return "$@ running calc_setup for $cust_pkg\n"
883 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
886 $cust_pkg->setfield('setup', $time)
887 unless $cust_pkg->setup;
888 #do need it, but it won't get written to the db
889 #|| $cust_pkg->pkgpart != $real_pkgpart;
891 $cust_pkg->setfield('start_date', '')
892 if $cust_pkg->start_date;
900 #XXX unit stuff here too
904 if ( ! $cust_pkg->start_date
905 and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
907 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $time )
908 || ( $part_pkg->plan eq 'voip_cdr'
909 && $part_pkg->option('bill_every_call')
914 # XXX should this be a package event? probably. events are called
915 # at collection time at the moment, though...
916 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
917 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
918 #don't want to reset usage just cause we want a line item??
919 #&& $part_pkg->pkgpart == $real_pkgpart;
921 warn " bill recur\n" if $DEBUG > 1;
924 # XXX shared with $recur_prog
925 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
929 #over two params! lets at least switch to a hashref for the rest...
930 my $increment_next_bill = ( $part_pkg->freq ne '0'
931 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
934 my %param = ( 'precommit_hooks' => $precommit_hooks,
935 'increment_next_bill' => $increment_next_bill,
936 'discounts' => \@discounts,
937 'real_pkgpart' => $real_pkgpart,
938 'freq_override' => $options{freq_override} || '',
942 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
944 # There may be some part_pkg for which this is wrong. Only those
945 # which can_discount are supported.
946 # (the UI should prevent adding discounts to these at the moment)
948 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
949 return "$@ running $method for $cust_pkg\n"
952 if ( $increment_next_bill ) {
954 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
955 return "unparsable frequency: ". $part_pkg->freq
958 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
959 # only for figuring next bill date, nothing else, so, reset $sdate again
961 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
962 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
963 $cust_pkg->last_bill($sdate);
965 $cust_pkg->setfield('bill', $next_bill );
969 if ( defined $param{'discount_left_setup'} ) {
970 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
971 $setup -= $discount_setup;
977 warn "\$setup is undefined" unless defined($setup);
978 warn "\$recur is undefined" unless defined($recur);
979 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
982 # If there's line items, create em cust_bill_pkg records
983 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
988 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
989 # hmm.. and if just the options are modified in some weird price plan?
991 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
994 my $error = $cust_pkg->replace( $old_cust_pkg,
995 'depend_jobnum'=>$options{depend_jobnum},
996 'options' => { $cust_pkg->options },
998 unless $options{no_commit};
999 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1000 if $error; #just in case
1003 $setup = sprintf( "%.2f", $setup );
1004 $recur = sprintf( "%.2f", $recur );
1005 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1006 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1008 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1009 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1012 my $discount_show_always = ($recur == 0 && scalar(@discounts)
1013 && $conf->exists('discount-show-always'));
1017 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1018 || $discount_show_always
1019 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1020 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1024 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1027 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1029 warn " adding customer package invoice detail: $_\n"
1030 foreach @cust_pkg_detail;
1032 push @details, @cust_pkg_detail;
1034 my $cust_bill_pkg = new FS::cust_bill_pkg {
1035 'pkgnum' => $cust_pkg->pkgnum,
1037 'unitsetup' => $unitsetup,
1039 'unitrecur' => $unitrecur,
1040 'quantity' => $cust_pkg->quantity,
1041 'details' => \@details,
1042 'discounts' => \@discounts,
1043 'hidden' => $part_pkg->hidden,
1044 'freq' => $part_pkg->freq,
1047 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
1048 $cust_bill_pkg->sdate( $hash{last_bill} );
1049 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1050 $cust_bill_pkg->edate( $time ) if $options{cancel};
1051 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
1052 $cust_bill_pkg->sdate( $sdate );
1053 $cust_bill_pkg->edate( $cust_pkg->bill );
1054 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1057 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1058 unless $part_pkg->pkgpart == $real_pkgpart;
1060 $$total_setup += $setup;
1061 $$total_recur += $recur;
1067 unless ( $discount_show_always ) {
1069 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1070 return $error if $error;
1073 push @$cust_bill_pkgs, $cust_bill_pkg;
1075 } #if $setup != 0 || $recur != 0
1085 my $part_pkg = shift;
1086 my $taxlisthash = shift;
1087 my $cust_bill_pkg = shift;
1088 my $cust_pkg = shift;
1089 my $invoice_time = shift;
1090 my $real_pkgpart = shift;
1091 my $options = shift;
1093 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1095 my %cust_bill_pkg = ();
1099 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1100 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1101 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1102 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1104 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1106 if ( $conf->exists('enable_taxproducts')
1107 && ( scalar($part_pkg->part_pkg_taxoverride)
1108 || $part_pkg->has_taxproduct
1113 foreach my $class (@classes) {
1114 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1115 return $err_or_ref unless ref($err_or_ref);
1116 $taxes{$class} = $err_or_ref;
1119 unless (exists $taxes{''}) {
1120 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1121 return $err_or_ref unless ref($err_or_ref);
1122 $taxes{''} = $err_or_ref;
1127 my @loc_keys = qw( city county state country );
1129 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1130 my $cust_location = $cust_pkg->cust_location;
1131 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1134 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1137 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1140 $taxhash{'taxclass'} = $part_pkg->taxclass;
1143 my %taxhash_elim = %taxhash;
1144 my @elim = qw( city county state );
1147 #first try a match with taxclass
1148 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1150 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1151 #then try a match without taxclass
1152 my %no_taxclass = %taxhash_elim;
1153 $no_taxclass{ 'taxclass' } = '';
1154 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1157 $taxhash_elim{ shift(@elim) } = '';
1159 } while ( !scalar(@taxes) && scalar(@elim) );
1161 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1163 if $self->cust_main_exemption; #just to be safe
1165 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1167 $_->set('pkgnum', $cust_pkg->pkgnum );
1168 $_->set('locationnum', $cust_pkg->locationnum );
1172 $taxes{''} = [ @taxes ];
1173 $taxes{'setup'} = [ @taxes ];
1174 $taxes{'recur'} = [ @taxes ];
1175 $taxes{$_} = [ @taxes ] foreach (@classes);
1177 # # maybe eliminate this entirely, along with all the 0% records
1178 # unless ( @taxes ) {
1180 # "fatal: can't find tax rate for state/county/country/taxclass ".
1181 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1184 } #if $conf->exists('enable_taxproducts') ...
1189 my $separate = $conf->exists('separate_usage');
1190 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1191 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1192 my $section = $temp_pkg->part_pkg->categoryname;
1193 if ( $separate || $section || $usage_mandate ) {
1195 my %hash = ( 'section' => $section );
1197 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1198 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1200 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1201 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1203 push @display, new FS::cust_bill_pkg_display
1206 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1210 if ($separate && $section && $summary) {
1211 push @display, new FS::cust_bill_pkg_display { type => 'U',
1216 if ($usage_mandate || $section && $summary) {
1217 $hash{post_total} = 'Y';
1220 if ($separate || $usage_mandate) {
1221 $hash{section} = $section if ($separate || $usage_mandate);
1222 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1226 $cust_bill_pkg->set('display', \@display);
1228 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1229 foreach my $key (keys %tax_cust_bill_pkg) {
1230 my @taxes = @{ $taxes{$key} || [] };
1231 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1233 my %localtaxlisthash = ();
1234 foreach my $tax ( @taxes ) {
1236 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1237 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1238 # ' locationnum'. $cust_pkg->locationnum
1239 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1241 $taxlisthash->{ $taxname } ||= [ $tax ];
1242 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1244 $localtaxlisthash{ $taxname } ||= [ $tax ];
1245 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1249 warn "finding taxed taxes...\n" if $DEBUG > 2;
1250 foreach my $tax ( keys %localtaxlisthash ) {
1251 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1252 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1254 next unless $tax_object->can('tax_on_tax');
1256 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1257 my $totname = ref( $tot ). ' '. $tot->taxnum;
1259 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1261 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1263 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1264 my $hashref_or_error =
1265 $tax_object->taxline( $localtaxlisthash{$tax},
1266 'custnum' => $self->custnum,
1267 'invoice_time' => $invoice_time,
1269 return $hashref_or_error
1270 unless ref($hashref_or_error);
1272 $taxlisthash->{ $totname } ||= [ $tot ];
1273 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1285 my $part_pkg = shift;
1287 my $cust_pkg = shift;
1289 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1292 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1293 $geocode = $cust_pkg->cust_location->geocode('cch');
1295 $geocode = $self->geocode('cch');
1300 my @taxclassnums = map { $_->taxclassnum }
1301 $part_pkg->part_pkg_taxoverride($class);
1303 unless (@taxclassnums) {
1304 @taxclassnums = map { $_->taxclassnum }
1305 grep { $_->taxable eq 'Y' }
1306 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1308 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1313 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1315 @taxes = qsearch({ 'table' => 'tax_rate',
1316 'hashref' => { 'geocode' => $geocode, },
1317 'extra_sql' => $extra_sql,
1319 if scalar(@taxclassnums);
1321 warn "Found taxes ".
1322 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1329 =item collect [ HASHREF | OPTION => VALUE ... ]
1331 (Attempt to) collect money for this customer's outstanding invoices (see
1332 L<FS::cust_bill>). Usually used after the bill method.
1334 Actions are now triggered by billing events; see L<FS::part_event> and the
1335 billing events web interface. Old-style invoice events (see
1336 L<FS::part_bill_event>) have been deprecated.
1338 If there is an error, returns the error, otherwise returns false.
1340 Options are passed as name-value pairs.
1342 Currently available options are:
1348 Use this time when deciding when to print invoices and late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions.
1352 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1356 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1360 set true to surpress email card/ACH decline notices.
1364 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1370 # allows for one time override of normal customer billing method
1375 my( $self, %options ) = @_;
1377 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1379 my $invoice_time = $options{'invoice_time'} || time;
1382 local $SIG{HUP} = 'IGNORE';
1383 local $SIG{INT} = 'IGNORE';
1384 local $SIG{QUIT} = 'IGNORE';
1385 local $SIG{TERM} = 'IGNORE';
1386 local $SIG{TSTP} = 'IGNORE';
1387 local $SIG{PIPE} = 'IGNORE';
1389 my $oldAutoCommit = $FS::UID::AutoCommit;
1390 local $FS::UID::AutoCommit = 0;
1393 $self->select_for_update; #mutex
1396 my $balance = $self->balance;
1397 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1400 if ( exists($options{'retry_card'}) ) {
1401 carp 'retry_card option passed to collect is deprecated; use retry';
1402 $options{'retry'} ||= $options{'retry_card'};
1404 if ( exists($options{'retry'}) && $options{'retry'} ) {
1405 my $error = $self->retry_realtime;
1407 $dbh->rollback if $oldAutoCommit;
1412 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1414 #never want to roll back an event just because it returned an error
1415 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1417 $self->do_cust_event(
1418 'debug' => ( $options{'debug'} || 0 ),
1419 'time' => $invoice_time,
1420 'check_freq' => $options{'check_freq'},
1421 'stage' => 'collect',
1426 =item retry_realtime
1428 Schedules realtime / batch credit card / electronic check / LEC billing
1429 events for for retry. Useful if card information has changed or manual
1430 retry is desired. The 'collect' method must be called to actually retry
1433 Implementation details: For either this customer, or for each of this
1434 customer's open invoices, changes the status of the first "done" (with
1435 statustext error) realtime processing event to "failed".
1439 sub retry_realtime {
1442 local $SIG{HUP} = 'IGNORE';
1443 local $SIG{INT} = 'IGNORE';
1444 local $SIG{QUIT} = 'IGNORE';
1445 local $SIG{TERM} = 'IGNORE';
1446 local $SIG{TSTP} = 'IGNORE';
1447 local $SIG{PIPE} = 'IGNORE';
1449 my $oldAutoCommit = $FS::UID::AutoCommit;
1450 local $FS::UID::AutoCommit = 0;
1453 #a little false laziness w/due_cust_event (not too bad, really)
1455 my $join = FS::part_event_condition->join_conditions_sql;
1456 my $order = FS::part_event_condition->order_conditions_sql;
1459 . join ( ' OR ' , map {
1460 "( part_event.eventtable = " . dbh->quote($_)
1461 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1462 } FS::part_event->eventtables)
1465 #here is the agent virtualization
1466 my $agent_virt = " ( part_event.agentnum IS NULL
1467 OR part_event.agentnum = ". $self->agentnum. ' )';
1469 #XXX this shouldn't be hardcoded, actions should declare it...
1470 my @realtime_events = qw(
1471 cust_bill_realtime_card
1472 cust_bill_realtime_check
1473 cust_bill_realtime_lec
1477 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1482 my @cust_event = qsearchs({
1483 'table' => 'cust_event',
1484 'select' => 'cust_event.*',
1485 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1486 'hashref' => { 'status' => 'done' },
1487 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1488 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1491 my %seen_invnum = ();
1492 foreach my $cust_event (@cust_event) {
1494 #max one for the customer, one for each open invoice
1495 my $cust_X = $cust_event->cust_X;
1496 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1500 or $cust_event->part_event->eventtable eq 'cust_bill'
1503 my $error = $cust_event->retry;
1505 $dbh->rollback if $oldAutoCommit;
1506 return "error scheduling event for retry: $error";
1511 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1516 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1518 Runs billing events; see L<FS::part_event> and the billing events web
1521 If there is an error, returns the error, otherwise returns false.
1523 Options are passed as name-value pairs.
1525 Currently available options are:
1531 Use this time when deciding when to print invoices and late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions.
1535 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1539 "collect" (the default) or "pre-bill"
1543 set true to surpress email card/ACH decline notices.
1547 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1554 # allows for one time override of normal customer billing method
1558 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1561 my( $self, %options ) = @_;
1563 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1565 my $time = $options{'time'} || time;
1568 local $SIG{HUP} = 'IGNORE';
1569 local $SIG{INT} = 'IGNORE';
1570 local $SIG{QUIT} = 'IGNORE';
1571 local $SIG{TERM} = 'IGNORE';
1572 local $SIG{TSTP} = 'IGNORE';
1573 local $SIG{PIPE} = 'IGNORE';
1575 my $oldAutoCommit = $FS::UID::AutoCommit;
1576 local $FS::UID::AutoCommit = 0;
1579 $self->select_for_update; #mutex
1582 my $balance = $self->balance;
1583 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1586 # if ( exists($options{'retry_card'}) ) {
1587 # carp 'retry_card option passed to collect is deprecated; use retry';
1588 # $options{'retry'} ||= $options{'retry_card'};
1590 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1591 # my $error = $self->retry_realtime;
1593 # $dbh->rollback if $oldAutoCommit;
1598 # false laziness w/pay_batch::import_results
1600 my $due_cust_event = $self->due_cust_event(
1601 'debug' => ( $options{'debug'} || 0 ),
1603 'check_freq' => $options{'check_freq'},
1604 'stage' => ( $options{'stage'} || 'collect' ),
1606 unless( ref($due_cust_event) ) {
1607 $dbh->rollback if $oldAutoCommit;
1608 return $due_cust_event;
1611 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1612 #never want to roll back an event just because it or a different one
1614 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1616 foreach my $cust_event ( @$due_cust_event ) {
1620 #re-eval event conditions (a previous event could have changed things)
1621 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1622 #don't leave stray "new/locked" records around
1623 my $error = $cust_event->delete;
1624 return $error if $error;
1629 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1630 if $options{'quiet'};
1631 warn " running cust_event ". $cust_event->eventnum. "\n"
1634 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1635 if ( my $error = $cust_event->do_event() ) {
1636 #XXX wtf is this? figure out a proper dealio with return value
1648 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1650 Inserts database records for and returns an ordered listref of new events due
1651 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1652 events are due, an empty listref is returned. If there is an error, returns a
1653 scalar error message.
1655 To actually run the events, call each event's test_condition method, and if
1656 still true, call the event's do_event method.
1658 Options are passed as a hashref or as a list of name-value pairs. Available
1665 Search only for events of this check frequency (how often events of this type are checked); currently "1d" (daily, the default) and "1m" (monthly) are recognized.
1669 "collect" (the default) or "pre-bill"
1673 "Current time" for the events.
1677 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1681 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1685 Explicitly pass the objects to be tested (typically used with eventtable).
1689 Set to true to return the objects, but not actually insert them into the
1696 sub due_cust_event {
1698 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1701 #my $DEBUG = $opt{'debug'}
1702 local($DEBUG) = $opt{'debug'}
1703 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1704 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1706 warn "$me due_cust_event called with options ".
1707 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1710 $opt{'time'} ||= time;
1712 local $SIG{HUP} = 'IGNORE';
1713 local $SIG{INT} = 'IGNORE';
1714 local $SIG{QUIT} = 'IGNORE';
1715 local $SIG{TERM} = 'IGNORE';
1716 local $SIG{TSTP} = 'IGNORE';
1717 local $SIG{PIPE} = 'IGNORE';
1719 my $oldAutoCommit = $FS::UID::AutoCommit;
1720 local $FS::UID::AutoCommit = 0;
1723 $self->select_for_update #mutex
1724 unless $opt{testonly};
1727 # find possible events (initial search)
1730 my @cust_event = ();
1732 my @eventtable = $opt{'eventtable'}
1733 ? ( $opt{'eventtable'} )
1734 : FS::part_event->eventtables_runorder;
1736 my $check_freq = $opt{'check_freq'} || '1d';
1738 foreach my $eventtable ( @eventtable ) {
1741 if ( $opt{'objects'} ) {
1743 @objects = @{ $opt{'objects'} };
1747 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1748 if ( $eventtable eq 'cust_main' ) {
1749 @objects = ( $self );
1753 "LEFT JOIN cust_main USING ( custnum )";
1755 #some false laziness w/Cron::bill bill_where
1757 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1758 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1759 'time'=>$opt{'time'},
1761 $where = $where ? "AND $where" : '';
1763 my $are_part_event =
1764 "EXISTS ( SELECT 1 FROM part_event $join
1765 WHERE check_freq = '$check_freq'
1766 AND eventtable = '$eventtable'
1767 AND ( disabled = '' OR disabled IS NULL )
1773 @objects = $self->$eventtable(
1774 'addl_from' => $cm_join,
1775 'extra_sql' => " AND $are_part_event",
1781 my @e_cust_event = ();
1783 my $cross = "CROSS JOIN $eventtable";
1784 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1785 unless $eventtable eq 'cust_main';
1787 foreach my $object ( @objects ) {
1789 #this first search uses the condition_sql magic for optimization.
1790 #the more possible events we can eliminate in this step the better
1792 my $cross_where = '';
1793 my $pkey = $object->primary_key;
1794 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1796 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1798 FS::part_event_condition->where_conditions_sql( $eventtable,
1799 'time'=>$opt{'time'}
1801 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1803 $extra_sql = "AND $extra_sql" if $extra_sql;
1805 #here is the agent virtualization
1806 $extra_sql .= " AND ( part_event.agentnum IS NULL
1807 OR part_event.agentnum = ". $self->agentnum. ' )';
1809 $extra_sql .= " $order";
1811 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1812 if $opt{'debug'} > 2;
1813 my @part_event = qsearch( {
1814 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1815 'select' => 'part_event.*',
1816 'table' => 'part_event',
1817 'addl_from' => "$cross $join",
1818 'hashref' => { 'check_freq' => $check_freq,
1819 'eventtable' => $eventtable,
1822 'extra_sql' => "AND $cross_where $extra_sql",
1826 my $pkey = $object->primary_key;
1827 warn " ". scalar(@part_event).
1828 " possible events found for $eventtable ". $object->$pkey(). "\n";
1831 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1835 warn " ". scalar(@e_cust_event).
1836 " subtotal possible cust events found for $eventtable\n"
1839 push @cust_event, @e_cust_event;
1843 warn " ". scalar(@cust_event).
1844 " total possible cust events found in initial search\n"
1852 $opt{stage} ||= 'collect';
1854 grep { my $stage = $_->part_event->event_stage;
1855 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1865 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1866 'stats_hashref' => \%unsat ),
1869 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1872 warn " invalid conditions not eliminated with condition_sql:\n".
1873 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1874 if keys %unsat && $DEBUG; # > 1;
1880 unless( $opt{testonly} ) {
1881 foreach my $cust_event ( @cust_event ) {
1883 my $error = $cust_event->insert();
1885 $dbh->rollback if $oldAutoCommit;
1892 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1898 warn " returning events: ". Dumper(@cust_event). "\n"
1905 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1907 Applies unapplied payments and credits.
1909 In most cases, this new method should be used in place of sequential
1910 apply_payments and apply_credits methods.
1912 A hash of optional arguments may be passed. Currently "manual" is supported.
1913 If true, a payment receipt is sent instead of a statement when
1914 'payment_receipt_email' configuration option is set.
1916 If there is an error, returns the error, otherwise returns false.
1920 sub apply_payments_and_credits {
1921 my( $self, %options ) = @_;
1923 local $SIG{HUP} = 'IGNORE';
1924 local $SIG{INT} = 'IGNORE';
1925 local $SIG{QUIT} = 'IGNORE';
1926 local $SIG{TERM} = 'IGNORE';
1927 local $SIG{TSTP} = 'IGNORE';
1928 local $SIG{PIPE} = 'IGNORE';
1930 my $oldAutoCommit = $FS::UID::AutoCommit;
1931 local $FS::UID::AutoCommit = 0;
1934 $self->select_for_update; #mutex
1936 foreach my $cust_bill ( $self->open_cust_bill ) {
1937 my $error = $cust_bill->apply_payments_and_credits(%options);
1939 $dbh->rollback if $oldAutoCommit;
1940 return "Error applying: $error";
1944 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1949 =item apply_credits OPTION => VALUE ...
1951 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1952 to outstanding invoice balances in chronological order (or reverse
1953 chronological order if the I<order> option is set to B<newest>) and returns the
1954 value of any remaining unapplied credits available for refund (see
1955 L<FS::cust_refund>).
1957 Dies if there is an error.
1965 local $SIG{HUP} = 'IGNORE';
1966 local $SIG{INT} = 'IGNORE';
1967 local $SIG{QUIT} = 'IGNORE';
1968 local $SIG{TERM} = 'IGNORE';
1969 local $SIG{TSTP} = 'IGNORE';
1970 local $SIG{PIPE} = 'IGNORE';
1972 my $oldAutoCommit = $FS::UID::AutoCommit;
1973 local $FS::UID::AutoCommit = 0;
1976 $self->select_for_update; #mutex
1978 unless ( $self->total_unapplied_credits ) {
1979 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1983 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1984 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1986 my @invoices = $self->open_cust_bill;
1987 @invoices = sort { $b->_date <=> $a->_date } @invoices
1988 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1990 if ( $conf->exists('pkg-balances') ) {
1991 # limit @credits to those w/ a pkgnum grepped from $self
1993 foreach my $i (@invoices) {
1994 foreach my $li ( $i->cust_bill_pkg ) {
1995 $pkgnums{$li->pkgnum} = 1;
1998 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2003 foreach my $cust_bill ( @invoices ) {
2005 if ( !defined($credit) || $credit->credited == 0) {
2006 $credit = pop @credits or last;
2010 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2011 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2013 $owed = $cust_bill->owed;
2015 unless ( $owed > 0 ) {
2016 push @credits, $credit;
2020 my $amount = min( $credit->credited, $owed );
2022 my $cust_credit_bill = new FS::cust_credit_bill ( {
2023 'crednum' => $credit->crednum,
2024 'invnum' => $cust_bill->invnum,
2025 'amount' => $amount,
2027 $cust_credit_bill->pkgnum( $credit->pkgnum )
2028 if $conf->exists('pkg-balances') && $credit->pkgnum;
2029 my $error = $cust_credit_bill->insert;
2031 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2035 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2039 my $total_unapplied_credits = $self->total_unapplied_credits;
2041 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2043 return $total_unapplied_credits;
2046 =item apply_payments [ OPTION => VALUE ... ]
2048 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2049 to outstanding invoice balances in chronological order.
2051 #and returns the value of any remaining unapplied payments.
2053 A hash of optional arguments may be passed. Currently "manual" is supported.
2054 If true, a payment receipt is sent instead of a statement when
2055 'payment_receipt_email' configuration option is set.
2057 Dies if there is an error.
2061 sub apply_payments {
2062 my( $self, %options ) = @_;
2064 local $SIG{HUP} = 'IGNORE';
2065 local $SIG{INT} = 'IGNORE';
2066 local $SIG{QUIT} = 'IGNORE';
2067 local $SIG{TERM} = 'IGNORE';
2068 local $SIG{TSTP} = 'IGNORE';
2069 local $SIG{PIPE} = 'IGNORE';
2071 my $oldAutoCommit = $FS::UID::AutoCommit;
2072 local $FS::UID::AutoCommit = 0;
2075 $self->select_for_update; #mutex
2079 my @payments = sort { $b->_date <=> $a->_date }
2080 grep { $_->unapplied > 0 }
2083 my @invoices = sort { $a->_date <=> $b->_date}
2084 grep { $_->owed > 0 }
2087 if ( $conf->exists('pkg-balances') ) {
2088 # limit @payments to those w/ a pkgnum grepped from $self
2090 foreach my $i (@invoices) {
2091 foreach my $li ( $i->cust_bill_pkg ) {
2092 $pkgnums{$li->pkgnum} = 1;
2095 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2100 foreach my $cust_bill ( @invoices ) {
2102 if ( !defined($payment) || $payment->unapplied == 0 ) {
2103 $payment = pop @payments or last;
2107 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2108 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2110 $owed = $cust_bill->owed;
2112 unless ( $owed > 0 ) {
2113 push @payments, $payment;
2117 my $amount = min( $payment->unapplied, $owed );
2120 'paynum' => $payment->paynum,
2121 'invnum' => $cust_bill->invnum,
2122 'amount' => $amount,
2124 $cbp->{_date} = $payment->_date
2125 if $options{'manual'} && $options{'backdate_application'};
2126 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2127 $cust_bill_pay->pkgnum( $payment->pkgnum )
2128 if $conf->exists('pkg-balances') && $payment->pkgnum;
2129 my $error = $cust_bill_pay->insert(%options);
2131 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2135 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2139 my $total_unapplied_payments = $self->total_unapplied_payments;
2141 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2143 return $total_unapplied_payments;
2152 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>