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 );
10 use FS::Misc::DateTime qw( day_end );
12 use FS::cust_bill_pkg;
13 use FS::cust_bill_pkg_display;
14 use FS::cust_bill_pay;
15 use FS::cust_credit_bill;
16 use FS::cust_tax_adjustment;
18 use FS::tax_rate_location;
19 use FS::cust_bill_pkg_tax_location;
20 use FS::cust_bill_pkg_tax_rate_location;
22 use FS::part_event_condition;
26 # 1 is mostly method/subroutine entry and options
27 # 2 traces progress of some operations
28 # 3 is even more information including possibly sensitive data
30 $me = '[FS::cust_main::Billing]';
32 install_callback FS::UID sub {
34 #yes, need it for stuff below (prolly should be cached)
39 FS::cust_main::Billing - Billing mixin for cust_main
45 These methods are available on FS::cust_main objects.
51 =item bill_and_collect
53 Cancels and suspends any packages due, generates bills, applies payments and
54 credits, and applies collection events to run cards, send bills and notices,
57 By default, warns on errors and continues with the next operation (but see the
60 Options are passed as name-value pairs. Currently available options are:
66 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:
70 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
74 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.
78 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
82 If set true, re-charges setup fees.
86 If set any errors prevent subsequent operations from continusing. If set
87 specifically to "return", returns the error (or false, if there is no error).
88 Any other true value causes errors to die.
92 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)
96 Optional FS::queue entry to receive status updates.
100 Options are passed to the B<bill> and B<collect> methods verbatim, so all
101 options of those methods are also available.
105 sub bill_and_collect {
106 my( $self, %options ) = @_;
108 my $log = FS::Log->new('bill_and_collect');
109 $log->debug('start', object => $self, agentnum => $self->agentnum);
113 #$options{actual_time} not $options{time} because freeside-daily -d is for
114 #pre-printing invoices
116 $options{'actual_time'} ||= time;
117 my $job = $options{'job'};
119 my $actual_time = ( $conf->exists('next-bill-ignore-time')
120 ? day_end( $options{actual_time} )
121 : $options{actual_time}
124 $job->update_statustext('0,cleaning expired packages') if $job;
125 $error = $self->cancel_expired_pkgs( $actual_time );
127 $error = "Error expiring custnum ". $self->custnum. ": $error";
128 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
129 elsif ( $options{fatal} ) { die $error; }
130 else { warn $error; }
133 $error = $self->suspend_adjourned_pkgs( $actual_time );
135 $error = "Error adjourning custnum ". $self->custnum. ": $error";
136 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
137 elsif ( $options{fatal} ) { die $error; }
138 else { warn $error; }
141 $error = $self->unsuspend_resumed_pkgs( $actual_time );
143 $error = "Error resuming 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('20,billing packages') if $job;
150 $error = $self->bill( %options );
152 $error = "Error billing custnum ". $self->custnum. ": $error";
153 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
154 elsif ( $options{fatal} ) { die $error; }
155 else { warn $error; }
158 $job->update_statustext('50,applying payments and credits') if $job;
159 $error = $self->apply_payments_and_credits;
161 $error = "Error applying custnum ". $self->custnum. ": $error";
162 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
163 elsif ( $options{fatal} ) { die $error; }
164 else { warn $error; }
167 $job->update_statustext('70,running collection events') if $job;
168 unless ( $conf->exists('cancelled_cust-noevents')
169 && ! $self->num_ncancelled_pkgs
171 $error = $self->collect( %options );
173 $error = "Error collecting custnum ". $self->custnum. ": $error";
174 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
175 elsif ($options{fatal} ) { die $error; }
176 else { warn $error; }
179 $job->update_statustext('100,finished') if $job;
180 $log->debug('finish', object => $self, agentnum => $self->agentnum);
186 sub cancel_expired_pkgs {
187 my ( $self, $time, %options ) = @_;
189 my @cancel_pkgs = $self->ncancelled_pkgs( {
190 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
195 foreach my $cust_pkg ( @cancel_pkgs ) {
196 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
197 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
198 'reason_otaker' => $cpr->otaker
202 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
205 join(' / ', @errors);
209 sub suspend_adjourned_pkgs {
210 my ( $self, $time, %options ) = @_;
212 my @susp_pkgs = $self->ncancelled_pkgs( {
214 " AND ( susp IS NULL OR susp = 0 )
215 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
216 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
221 #only because there's no SQL test for is_prepaid :/
223 grep { ( $_->part_pkg->is_prepaid
228 && $_->adjourn <= $time
236 foreach my $cust_pkg ( @susp_pkgs ) {
237 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
238 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
239 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
240 'reason_otaker' => $cpr->otaker
244 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
247 join(' / ', @errors);
251 sub unsuspend_resumed_pkgs {
252 my ( $self, $time, %options ) = @_;
254 my @unsusp_pkgs = $self->ncancelled_pkgs( {
255 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
260 foreach my $cust_pkg ( @unsusp_pkgs ) {
261 my $error = $cust_pkg->unsuspend( 'time' => $time );
262 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
265 join(' / ', @errors);
271 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
272 conjunction with the collect method by calling B<bill_and_collect>.
274 If there is an error, returns the error, otherwise returns false.
276 Options are passed as name-value pairs. Currently available options are:
282 If set true, re-charges setup fees.
286 If set true then only bill recurring charges, not setup, usage, one time
291 If set, then override the normal frequency and look for a part_pkg_discount
292 to take at that frequency. This is appropriate only when the normal
293 frequency for all packages is monthly, and is an error otherwise. Use
294 C<pkg_list> to limit the set of packages included in billing.
298 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:
302 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
306 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
308 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
312 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
316 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.
320 This boolean value informs the us that the package is being cancelled. This
321 typically might mean not charging the normal recurring fee but only usage
322 fees since the last billing. Setup charges may be charged. Not all package
323 plans support this feature (they tend to charge 0).
327 Prevent the resetting of usage limits during this call.
331 Do not save the generated bill in the database. Useful with return_bill
335 A list reference on which the generated bill(s) will be returned.
339 Optional terms to be printed on this invoice. Otherwise, customer-specific
340 terms or the default terms are used.
347 my( $self, %options ) = @_;
349 return '' if $self->payby eq 'COMP';
351 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
353 warn "$me bill customer ". $self->custnum. "\n"
356 my $time = $options{'time'} || time;
357 my $invoice_time = $options{'invoice_time'} || $time;
359 $options{'not_pkgpart'} ||= {};
360 $options{'not_pkgpart'} = { map { $_ => 1 }
361 split(/\s*,\s*/, $options{'not_pkgpart'})
363 unless ref($options{'not_pkgpart'});
365 local $SIG{HUP} = 'IGNORE';
366 local $SIG{INT} = 'IGNORE';
367 local $SIG{QUIT} = 'IGNORE';
368 local $SIG{TERM} = 'IGNORE';
369 local $SIG{TSTP} = 'IGNORE';
370 local $SIG{PIPE} = 'IGNORE';
372 my $oldAutoCommit = $FS::UID::AutoCommit;
373 local $FS::UID::AutoCommit = 0;
376 warn "$me acquiring lock on customer ". $self->custnum. "\n"
379 $self->select_for_update; #mutex
381 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
384 my $error = $self->do_cust_event(
385 'debug' => ( $options{'debug'} || 0 ),
386 'time' => $invoice_time,
387 'check_freq' => $options{'check_freq'},
388 'stage' => 'pre-bill',
390 unless $options{no_commit};
392 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
396 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
399 #keep auto-charge and non-auto-charge line items separate
400 my @passes = ( '', 'no_auto' );
402 my %cust_bill_pkg = map { $_ => [] } @passes;
405 # find the packages which are due for billing, find out how much they are
406 # & generate invoice database.
409 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
410 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
412 my %taxlisthash = map { $_ => {} } @passes;
414 my @precommit_hooks = ();
416 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
417 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
419 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
421 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
423 #? to avoid use of uninitialized value errors... ?
424 $cust_pkg->setfield('bill', '')
425 unless defined($cust_pkg->bill);
427 #my $part_pkg = $cust_pkg->part_pkg;
429 my $real_pkgpart = $cust_pkg->pkgpart;
430 my %hash = $cust_pkg->hash;
432 # we could implement this bit as FS::part_pkg::has_hidden, but we already
433 # suffer from performance issues
434 $options{has_hidden} = 0;
435 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
436 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
438 foreach my $part_pkg ( @part_pkg ) {
440 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
442 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
444 my $next_bill = $cust_pkg->getfield('bill') || 0;
446 while ( $next_bill <= $time ) {
448 $self->_make_lines( 'part_pkg' => $part_pkg,
449 'cust_pkg' => $cust_pkg,
450 'precommit_hooks' => \@precommit_hooks,
451 'line_items' => $cust_bill_pkg{$pass},
452 'setup' => $total_setup{$pass},
453 'recur' => $total_recur{$pass},
454 'tax_matrix' => $taxlisthash{$pass},
456 'real_pkgpart' => $real_pkgpart,
457 'options' => \%options,
460 # Stop if anything goes wrong
463 # or if we're not incrementing the bill date.
464 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
466 $next_bill = $cust_pkg->getfield('bill') || 0;
468 #stop if -o was passed to freeside-daily
469 last if $options{'one_recur'};
472 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
476 } #foreach my $part_pkg
478 } #foreach my $cust_pkg
480 #if the customer isn't on an automatic payby, everything can go on a single
482 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
483 #merge everything into one list
486 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
488 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
490 next unless @cust_bill_pkg; #don't create an invoice w/o line items
492 warn "$me billing pass $pass\n"
493 #.Dumper(\@cust_bill_pkg)."\n"
496 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
497 !$conf->exists('postal_invoice-recurring_only')
501 my $postal_pkg = $self->charge_postal_fee();
502 if ( $postal_pkg && !ref( $postal_pkg ) ) {
504 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
505 return "can't charge postal invoice fee for customer ".
506 $self->custnum. ": $postal_pkg";
508 } elsif ( $postal_pkg ) {
510 my $real_pkgpart = $postal_pkg->pkgpart;
511 # we could implement this bit as FS::part_pkg::has_hidden, but we already
512 # suffer from performance issues
513 $options{has_hidden} = 0;
514 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
515 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
517 foreach my $part_pkg ( @part_pkg ) {
518 my %postal_options = %options;
519 delete $postal_options{cancel};
521 $self->_make_lines( 'part_pkg' => $part_pkg,
522 'cust_pkg' => $postal_pkg,
523 'precommit_hooks' => \@precommit_hooks,
524 'line_items' => \@cust_bill_pkg,
525 'setup' => $total_setup{$pass},
526 'recur' => $total_recur{$pass},
527 'tax_matrix' => $taxlisthash{$pass},
529 'real_pkgpart' => $real_pkgpart,
530 'options' => \%postal_options,
533 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
538 # it's silly to have a zero value postal_pkg, but....
539 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
545 my $listref_or_error =
546 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
548 unless ( ref( $listref_or_error ) ) {
549 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
550 return $listref_or_error;
553 foreach my $taxline ( @$listref_or_error ) {
554 ${ $total_setup{$pass} } =
555 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
556 push @cust_bill_pkg, $taxline;
560 warn "adding tax adjustments...\n" if $DEBUG > 2;
561 foreach my $cust_tax_adjustment (
562 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
568 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
570 my $itemdesc = $cust_tax_adjustment->taxname;
571 $itemdesc = '' if $itemdesc eq 'Tax';
573 push @cust_bill_pkg, new FS::cust_bill_pkg {
579 'itemdesc' => $itemdesc,
580 'itemcomment' => $cust_tax_adjustment->comment,
581 'cust_tax_adjustment' => $cust_tax_adjustment,
582 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
587 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
589 my @cust_bill = $self->cust_bill;
590 my $balance = $self->balance;
591 my $previous_balance = scalar(@cust_bill)
592 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
595 $previous_balance += $cust_bill[$#cust_bill]->charged
596 if scalar(@cust_bill);
597 #my $balance_adjustments =
598 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
600 warn "creating the new invoice\n" if $DEBUG;
601 #create the new invoice
602 my $cust_bill = new FS::cust_bill ( {
603 'custnum' => $self->custnum,
604 '_date' => $invoice_time,
605 'charged' => $charged,
606 'billing_balance' => $balance,
607 'previous_balance' => $previous_balance,
608 'invoice_terms' => $options{'invoice_terms'},
609 'cust_bill_pkg' => \@cust_bill_pkg,
611 $error = $cust_bill->insert unless $options{no_commit};
613 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
614 return "can't create invoice for customer #". $self->custnum. ": $error";
616 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
618 } #foreach my $pass ( keys %cust_bill_pkg )
620 foreach my $hook ( @precommit_hooks ) {
623 } unless $options{no_commit};
625 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
626 return "$@ running precommit hook $hook\n";
630 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
635 #discard bundled packages of 0 value
636 sub _omit_zero_value_bundles {
639 my @cust_bill_pkg = ();
640 my @cust_bill_pkg_bundle = ();
642 my $discount_show_always = 0;
644 foreach my $cust_bill_pkg ( @in ) {
646 $discount_show_always = ($cust_bill_pkg->get('discounts')
647 && scalar(@{$cust_bill_pkg->get('discounts')})
648 && $conf->exists('discount-show-always'));
650 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
651 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
652 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
655 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
656 push @cust_bill_pkg, @cust_bill_pkg_bundle
658 || ($sum == 0 && ( $discount_show_always
659 || grep {$_->recur_show_zero || $_->setup_show_zero}
660 @cust_bill_pkg_bundle
663 @cust_bill_pkg_bundle = ();
667 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
668 push @cust_bill_pkg_bundle, $cust_bill_pkg;
672 push @cust_bill_pkg, @cust_bill_pkg_bundle
674 || ($sum == 0 && ( $discount_show_always
675 || grep {$_->recur_show_zero || $_->setup_show_zero}
676 @cust_bill_pkg_bundle
680 warn " _omit_zero_value_bundles: ". scalar(@in).
681 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
688 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
690 This is a weird one. Perhaps it should not even be exposed.
692 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
693 Usually used internally by bill method B<bill>.
695 If there is an error, returns the error, otherwise returns reference to a
696 list of line items suitable for insertion.
702 An array ref of the line items being billed.
706 A strange beast. The keys to this hash are internal identifiers consisting
707 of the name of the tax object type, a space, and its unique identifier ( e.g.
708 'cust_main_county 23' ). The values of the hash are listrefs. The first
709 item in the list is the tax object. The remaining items are either line
710 items or floating point values (currency amounts).
712 The taxes are calculated on this entity. Calculated exemption records are
713 transferred to the LINEITEMREF items on the assumption that they are related.
719 This specifies the date appearing on the associated invoice. Some
720 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
726 sub calculate_taxes {
727 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
729 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
731 warn "$me calculate_taxes\n"
732 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
735 my @tax_line_items = ();
737 # keys are tax names (as printed on invoices / itemdesc )
738 # values are listrefs of taxlisthash keys (internal identifiers)
741 # keys are taxlisthash keys (internal identifiers)
742 # values are (cumulative) amounts
745 # keys are taxlisthash keys (internal identifiers)
746 # values are listrefs of cust_bill_pkg_tax_location hashrefs
747 my %tax_location = ();
749 # keys are taxlisthash keys (internal identifiers)
750 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
751 my %tax_rate_location = ();
753 foreach my $tax ( keys %$taxlisthash ) {
754 my $tax_object = shift @{ $taxlisthash->{$tax} };
755 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
756 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
757 my $hashref_or_error =
758 $tax_object->taxline( $taxlisthash->{$tax},
759 'custnum' => $self->custnum,
760 'invoice_time' => $invoice_time
762 return $hashref_or_error unless ref($hashref_or_error);
764 unshift @{ $taxlisthash->{$tax} }, $tax_object;
766 my $name = $hashref_or_error->{'name'};
767 my $amount = $hashref_or_error->{'amount'};
769 #warn "adding $amount as $name\n";
770 $taxname{ $name } ||= [];
771 push @{ $taxname{ $name } }, $tax;
773 $tax{ $tax } += $amount;
775 $tax_location{ $tax } ||= [];
776 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
777 push @{ $tax_location{ $tax } },
779 'taxnum' => $tax_object->taxnum,
780 'taxtype' => ref($tax_object),
781 'pkgnum' => $tax_object->get('pkgnum'),
782 'locationnum' => $tax_object->get('locationnum'),
783 'amount' => sprintf('%.2f', $amount ),
787 $tax_rate_location{ $tax } ||= [];
788 if ( ref($tax_object) eq 'FS::tax_rate' ) {
789 my $taxratelocationnum =
790 $tax_object->tax_rate_location->taxratelocationnum;
791 push @{ $tax_rate_location{ $tax } },
793 'taxnum' => $tax_object->taxnum,
794 'taxtype' => ref($tax_object),
795 'amount' => sprintf('%.2f', $amount ),
796 'locationtaxid' => $tax_object->location,
797 'taxratelocationnum' => $taxratelocationnum,
803 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
804 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
805 foreach my $tax ( keys %$taxlisthash ) {
806 foreach ( @{ $taxlisthash->{$tax} }[1 .. scalar(@{ $taxlisthash->{$tax}}) - 1] ) {
807 next unless ref($_) eq 'FS::cust_bill_pkg'; #IS needed for CCH tax-on-tax
809 my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
811 next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
812 die "can't distribute tax exemptions: no line item for ". Dumper($_).
813 " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
814 unless $packagemap{$_->pkgnum};
816 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
817 @cust_tax_exempt_pkg;
821 #consolidate and create tax line items
822 warn "consolidating and generating...\n" if $DEBUG > 2;
823 foreach my $taxname ( keys %taxname ) {
826 my @cust_bill_pkg_tax_location = ();
827 my @cust_bill_pkg_tax_rate_location = ();
828 warn "adding $taxname\n" if $DEBUG > 1;
829 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
830 next if $seen{$taxitem}++;
831 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
832 $tax += $tax{$taxitem};
833 push @cust_bill_pkg_tax_location,
834 map { new FS::cust_bill_pkg_tax_location $_ }
835 @{ $tax_location{ $taxitem } };
836 push @cust_bill_pkg_tax_rate_location,
837 map { new FS::cust_bill_pkg_tax_rate_location $_ }
838 @{ $tax_rate_location{ $taxitem } };
842 $tax = sprintf('%.2f', $tax );
844 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
850 if ( $pkg_category and
851 $conf->config('invoice_latexsummary') ||
852 $conf->config('invoice_htmlsummary')
856 my %hash = ( 'section' => $pkg_category->categoryname );
857 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
861 push @tax_line_items, new FS::cust_bill_pkg {
867 'itemdesc' => $taxname,
868 'display' => \@display,
869 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
870 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
879 my ($self, %params) = @_;
881 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
883 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
884 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
885 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
886 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
887 my $total_setup = $params{setup} or die "no setup accumulator specified";
888 my $total_recur = $params{recur} or die "no recur accumulator specified";
889 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
890 my $time = $params{'time'} or die "no time specified";
891 my (%options) = %{$params{options}};
893 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
894 # this should never happen
895 die 'freq_override billing attempted on non-monthly package '.
900 my $real_pkgpart = $params{real_pkgpart};
901 my %hash = $cust_pkg->hash;
902 my $old_cust_pkg = new FS::cust_pkg \%hash;
907 $cust_pkg->pkgpart($part_pkg->pkgpart);
909 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
920 my @setup_discounts = ();
921 my %setup_param = ( 'discounts' => \@setup_discounts );
922 if ( ! $options{recurring_only}
923 and ! $options{cancel}
924 and ( $options{'resetup'}
925 || ( ! $cust_pkg->setup
926 && ( ! $cust_pkg->start_date
927 || $cust_pkg->start_date <= $cmp_time
929 && ( ! $conf->exists('disable_setup_suspended_pkgs')
930 || ( $conf->exists('disable_setup_suspended_pkgs') &&
931 ! $cust_pkg->getfield('susp')
939 warn " bill setup\n" if $DEBUG > 1;
941 unless ( $cust_pkg->waive_setup ) {
944 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
945 return "$@ running calc_setup for $cust_pkg\n"
948 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
951 $cust_pkg->setfield('setup', $time)
952 unless $cust_pkg->setup;
953 #do need it, but it won't get written to the db
954 #|| $cust_pkg->pkgpart != $real_pkgpart;
956 $cust_pkg->setfield('start_date', '')
957 if $cust_pkg->start_date;
965 #XXX unit stuff here too
968 my @recur_discounts = ();
970 if ( ! $cust_pkg->start_date
971 and ( ! $cust_pkg->susp || $cust_pkg->option('suspend_bill',1)
972 || ( $part_pkg->option('suspend_bill', 1) )
973 && ! $cust_pkg->option('no_suspend_bill',1)
976 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
977 || ( $part_pkg->plan eq 'voip_cdr'
978 && $part_pkg->option('bill_every_call')
983 # XXX should this be a package event? probably. events are called
984 # at collection time at the moment, though...
985 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
986 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
987 #don't want to reset usage just cause we want a line item??
988 #&& $part_pkg->pkgpart == $real_pkgpart;
990 warn " bill recur\n" if $DEBUG > 1;
993 # XXX shared with $recur_prog
994 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
998 #over two params! lets at least switch to a hashref for the rest...
999 my $increment_next_bill = ( $part_pkg->freq ne '0'
1000 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1001 && !$options{cancel}
1003 my %param = ( %setup_param,
1004 'precommit_hooks' => $precommit_hooks,
1005 'increment_next_bill' => $increment_next_bill,
1006 'discounts' => \@recur_discounts,
1007 'real_pkgpart' => $real_pkgpart,
1008 'freq_override' => $options{freq_override} || '',
1012 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1014 # There may be some part_pkg for which this is wrong. Only those
1015 # which can_discount are supported.
1016 # (the UI should prevent adding discounts to these at the moment)
1018 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1019 " for pkgpart ". $cust_pkg->pkgpart.
1020 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1023 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1024 return "$@ running $method for $cust_pkg\n"
1027 if ( $increment_next_bill ) {
1029 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1030 return "unparsable frequency: ". $part_pkg->freq
1031 if $next_bill == -1;
1033 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1034 # only for figuring next bill date, nothing else, so, reset $sdate again
1036 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1037 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1038 $cust_pkg->last_bill($sdate);
1040 $cust_pkg->setfield('bill', $next_bill );
1044 if ( $param{'setup_fee'} ) {
1045 # Add an additional setup fee at the billing stage.
1046 # Used for prorate_defer_bill.
1047 $setup += $param{'setup_fee'};
1048 $unitsetup += $param{'setup_fee'};
1052 if ( defined $param{'discount_left_setup'} ) {
1053 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1054 $setup -= $discount_setup;
1060 warn "\$setup is undefined" unless defined($setup);
1061 warn "\$recur is undefined" unless defined($recur);
1062 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1065 # If there's line items, create em cust_bill_pkg records
1066 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1071 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1072 # hmm.. and if just the options are modified in some weird price plan?
1074 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1077 my $error = $cust_pkg->replace( $old_cust_pkg,
1078 'depend_jobnum'=>$options{depend_jobnum},
1079 'options' => { $cust_pkg->options },
1081 unless $options{no_commit};
1082 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1083 if $error; #just in case
1086 $setup = sprintf( "%.2f", $setup );
1087 $recur = sprintf( "%.2f", $recur );
1088 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1089 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1091 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1092 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1095 my $discount_show_always = $conf->exists('discount-show-always')
1096 && ( ($setup == 0 && scalar(@setup_discounts))
1097 || ($recur == 0 && scalar(@recur_discounts))
1102 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1103 || $discount_show_always
1104 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1105 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1109 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1112 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1114 warn " adding customer package invoice detail: $_\n"
1115 foreach @cust_pkg_detail;
1117 push @details, @cust_pkg_detail;
1119 my $cust_bill_pkg = new FS::cust_bill_pkg {
1120 'pkgnum' => $cust_pkg->pkgnum,
1122 'unitsetup' => $unitsetup,
1124 'unitrecur' => $unitrecur,
1125 'quantity' => $cust_pkg->quantity,
1126 'details' => \@details,
1127 'discounts' => [ @setup_discounts, @recur_discounts ],
1128 'hidden' => $part_pkg->hidden,
1129 'freq' => $part_pkg->freq,
1132 if ( $part_pkg->option('prorate_defer_bill',1)
1133 and !$hash{last_bill} ) {
1134 # both preceding and upcoming, technically
1135 $cust_bill_pkg->sdate( $cust_pkg->setup );
1136 $cust_bill_pkg->edate( $cust_pkg->bill );
1137 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1138 $cust_bill_pkg->sdate( $hash{last_bill} );
1139 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1140 $cust_bill_pkg->edate( $time ) if $options{cancel};
1141 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1142 $cust_bill_pkg->sdate( $sdate );
1143 $cust_bill_pkg->edate( $cust_pkg->bill );
1144 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1147 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1148 unless $part_pkg->pkgpart == $real_pkgpart;
1150 $$total_setup += $setup;
1151 $$total_recur += $recur;
1157 unless ( $discount_show_always ) {
1159 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1160 return $error if $error;
1163 $cust_bill_pkg->set_display( part_pkg => $part_pkg,
1164 real_pkgpart => $real_pkgpart,
1167 push @$cust_bill_pkgs, $cust_bill_pkg;
1169 } #if $setup != 0 || $recur != 0
1179 my $part_pkg = shift;
1180 my $taxlisthash = shift;
1181 my $cust_bill_pkg = shift;
1182 my $cust_pkg = shift;
1183 my $invoice_time = shift;
1184 my $real_pkgpart = shift;
1185 my $options = shift;
1187 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1189 my %cust_bill_pkg = ();
1193 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1194 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1195 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1196 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1198 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1200 if ( $conf->exists('enable_taxproducts')
1201 && ( scalar($part_pkg->part_pkg_taxoverride)
1202 || $part_pkg->has_taxproduct
1207 foreach my $class (@classes) {
1208 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1209 return $err_or_ref unless ref($err_or_ref);
1210 $taxes{$class} = $err_or_ref;
1213 unless (exists $taxes{''}) {
1214 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1215 return $err_or_ref unless ref($err_or_ref);
1216 $taxes{''} = $err_or_ref;
1221 my @loc_keys = qw( district city county state country );
1223 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1224 my $cust_location = $cust_pkg->cust_location;
1225 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1228 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1231 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1232 # special case--there's no 'ship_district' field
1233 $taxhash{'district'} = $self->get('district');
1236 $taxhash{'taxclass'} = $part_pkg->taxclass;
1239 my %taxhash_elim = %taxhash;
1240 my @elim = qw( district city county state );
1243 #first try a match with taxclass
1244 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1246 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1247 #then try a match without taxclass
1248 my %no_taxclass = %taxhash_elim;
1249 $no_taxclass{ 'taxclass' } = '';
1250 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1253 $taxhash_elim{ shift(@elim) } = '';
1255 } while ( !scalar(@taxes) && scalar(@elim) );
1257 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1259 if $self->cust_main_exemption; #just to be safe
1261 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1263 $_->set('pkgnum', $cust_pkg->pkgnum );
1264 $_->set('locationnum', $cust_pkg->locationnum );
1268 $taxes{''} = [ @taxes ];
1269 $taxes{'setup'} = [ @taxes ];
1270 $taxes{'recur'} = [ @taxes ];
1271 $taxes{$_} = [ @taxes ] foreach (@classes);
1273 # # maybe eliminate this entirely, along with all the 0% records
1274 # unless ( @taxes ) {
1276 # "fatal: can't find tax rate for state/county/country/taxclass ".
1277 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1280 } #if $conf->exists('enable_taxproducts') ...
1284 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1285 foreach my $key (keys %tax_cust_bill_pkg) {
1286 my @taxes = @{ $taxes{$key} || [] };
1287 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1289 my %localtaxlisthash = ();
1290 foreach my $tax ( @taxes ) {
1292 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1293 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1294 # ' locationnum'. $cust_pkg->locationnum
1295 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1297 $taxlisthash->{ $taxname } ||= [ $tax ];
1298 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1300 $localtaxlisthash{ $taxname } ||= [ $tax ];
1301 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1305 warn "finding taxed taxes...\n" if $DEBUG > 2;
1306 foreach my $tax ( keys %localtaxlisthash ) {
1307 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1308 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1310 next unless $tax_object->can('tax_on_tax');
1312 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1313 my $totname = ref( $tot ). ' '. $tot->taxnum;
1315 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1317 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1319 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1320 my $hashref_or_error =
1321 $tax_object->taxline( $localtaxlisthash{$tax},
1322 'custnum' => $self->custnum,
1323 'invoice_time' => $invoice_time,
1325 return $hashref_or_error
1326 unless ref($hashref_or_error);
1328 $taxlisthash->{ $totname } ||= [ $tot ];
1329 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1341 my $part_pkg = shift;
1343 my $cust_pkg = shift;
1345 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1348 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1349 $geocode = $cust_pkg->cust_location->geocode('cch');
1351 $geocode = $self->geocode('cch');
1356 my @taxclassnums = map { $_->taxclassnum }
1357 $part_pkg->part_pkg_taxoverride($class);
1359 unless (@taxclassnums) {
1360 @taxclassnums = map { $_->taxclassnum }
1361 grep { $_->taxable eq 'Y' }
1362 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1364 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1369 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1371 @taxes = qsearch({ 'table' => 'tax_rate',
1372 'hashref' => { 'geocode' => $geocode, },
1373 'extra_sql' => $extra_sql,
1375 if scalar(@taxclassnums);
1377 warn "Found taxes ".
1378 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1385 =item collect [ HASHREF | OPTION => VALUE ... ]
1387 (Attempt to) collect money for this customer's outstanding invoices (see
1388 L<FS::cust_bill>). Usually used after the bill method.
1390 Actions are now triggered by billing events; see L<FS::part_event> and the
1391 billing events web interface. Old-style invoice events (see
1392 L<FS::part_bill_event>) have been deprecated.
1394 If there is an error, returns the error, otherwise returns false.
1396 Options are passed as name-value pairs.
1398 Currently available options are:
1404 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.
1408 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1412 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1416 set true to surpress email card/ACH decline notices.
1420 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)
1426 # allows for one time override of normal customer billing method
1431 my( $self, %options ) = @_;
1433 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1435 my $invoice_time = $options{'invoice_time'} || time;
1438 local $SIG{HUP} = 'IGNORE';
1439 local $SIG{INT} = 'IGNORE';
1440 local $SIG{QUIT} = 'IGNORE';
1441 local $SIG{TERM} = 'IGNORE';
1442 local $SIG{TSTP} = 'IGNORE';
1443 local $SIG{PIPE} = 'IGNORE';
1445 my $oldAutoCommit = $FS::UID::AutoCommit;
1446 local $FS::UID::AutoCommit = 0;
1449 $self->select_for_update; #mutex
1452 my $balance = $self->balance;
1453 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1456 if ( exists($options{'retry_card'}) ) {
1457 carp 'retry_card option passed to collect is deprecated; use retry';
1458 $options{'retry'} ||= $options{'retry_card'};
1460 if ( exists($options{'retry'}) && $options{'retry'} ) {
1461 my $error = $self->retry_realtime;
1463 $dbh->rollback if $oldAutoCommit;
1468 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1470 #never want to roll back an event just because it returned an error
1471 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1473 $self->do_cust_event(
1474 'debug' => ( $options{'debug'} || 0 ),
1475 'time' => $invoice_time,
1476 'check_freq' => $options{'check_freq'},
1477 'stage' => 'collect',
1482 =item retry_realtime
1484 Schedules realtime / batch credit card / electronic check / LEC billing
1485 events for for retry. Useful if card information has changed or manual
1486 retry is desired. The 'collect' method must be called to actually retry
1489 Implementation details: For either this customer, or for each of this
1490 customer's open invoices, changes the status of the first "done" (with
1491 statustext error) realtime processing event to "failed".
1495 sub retry_realtime {
1498 local $SIG{HUP} = 'IGNORE';
1499 local $SIG{INT} = 'IGNORE';
1500 local $SIG{QUIT} = 'IGNORE';
1501 local $SIG{TERM} = 'IGNORE';
1502 local $SIG{TSTP} = 'IGNORE';
1503 local $SIG{PIPE} = 'IGNORE';
1505 my $oldAutoCommit = $FS::UID::AutoCommit;
1506 local $FS::UID::AutoCommit = 0;
1509 #a little false laziness w/due_cust_event (not too bad, really)
1511 my $join = FS::part_event_condition->join_conditions_sql;
1512 my $order = FS::part_event_condition->order_conditions_sql;
1515 . join ( ' OR ' , map {
1516 "( part_event.eventtable = " . dbh->quote($_)
1517 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1518 } FS::part_event->eventtables)
1521 #here is the agent virtualization
1522 my $agent_virt = " ( part_event.agentnum IS NULL
1523 OR part_event.agentnum = ". $self->agentnum. ' )';
1525 #XXX this shouldn't be hardcoded, actions should declare it...
1526 my @realtime_events = qw(
1527 cust_bill_realtime_card
1528 cust_bill_realtime_check
1529 cust_bill_realtime_lec
1533 my $is_realtime_event =
1534 ' part_event.action IN ( '.
1535 join(',', map "'$_'", @realtime_events ).
1538 my $batch_or_statustext =
1539 "( part_event.action = 'cust_bill_batch'
1540 OR ( statustext IS NOT NULL AND statustext != '' )
1544 my @cust_event = qsearch({
1545 'table' => 'cust_event',
1546 'select' => 'cust_event.*',
1547 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1548 'hashref' => { 'status' => 'done' },
1549 'extra_sql' => " AND $batch_or_statustext ".
1550 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1553 my %seen_invnum = ();
1554 foreach my $cust_event (@cust_event) {
1556 #max one for the customer, one for each open invoice
1557 my $cust_X = $cust_event->cust_X;
1558 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1562 or $cust_event->part_event->eventtable eq 'cust_bill'
1565 my $error = $cust_event->retry;
1567 $dbh->rollback if $oldAutoCommit;
1568 return "error scheduling event for retry: $error";
1573 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1578 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1580 Runs billing events; see L<FS::part_event> and the billing events web
1583 If there is an error, returns the error, otherwise returns false.
1585 Options are passed as name-value pairs.
1587 Currently available options are:
1593 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.
1597 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1601 "collect" (the default) or "pre-bill"
1605 set true to surpress email card/ACH decline notices.
1609 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)
1616 # allows for one time override of normal customer billing method
1620 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1623 my( $self, %options ) = @_;
1625 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1627 my $time = $options{'time'} || time;
1630 local $SIG{HUP} = 'IGNORE';
1631 local $SIG{INT} = 'IGNORE';
1632 local $SIG{QUIT} = 'IGNORE';
1633 local $SIG{TERM} = 'IGNORE';
1634 local $SIG{TSTP} = 'IGNORE';
1635 local $SIG{PIPE} = 'IGNORE';
1637 my $oldAutoCommit = $FS::UID::AutoCommit;
1638 local $FS::UID::AutoCommit = 0;
1641 $self->select_for_update; #mutex
1644 my $balance = $self->balance;
1645 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1648 # if ( exists($options{'retry_card'}) ) {
1649 # carp 'retry_card option passed to collect is deprecated; use retry';
1650 # $options{'retry'} ||= $options{'retry_card'};
1652 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1653 # my $error = $self->retry_realtime;
1655 # $dbh->rollback if $oldAutoCommit;
1660 # false laziness w/pay_batch::import_results
1662 my $due_cust_event = $self->due_cust_event(
1663 'debug' => ( $options{'debug'} || 0 ),
1665 'check_freq' => $options{'check_freq'},
1666 'stage' => ( $options{'stage'} || 'collect' ),
1668 unless( ref($due_cust_event) ) {
1669 $dbh->rollback if $oldAutoCommit;
1670 return $due_cust_event;
1673 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1674 #never want to roll back an event just because it or a different one
1676 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1678 foreach my $cust_event ( @$due_cust_event ) {
1682 #re-eval event conditions (a previous event could have changed things)
1683 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1684 #don't leave stray "new/locked" records around
1685 my $error = $cust_event->delete;
1686 return $error if $error;
1691 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1692 if $options{'quiet'};
1693 warn " running cust_event ". $cust_event->eventnum. "\n"
1696 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1697 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1698 #XXX wtf is this? figure out a proper dealio with return value
1710 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1712 Inserts database records for and returns an ordered listref of new events due
1713 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1714 events are due, an empty listref is returned. If there is an error, returns a
1715 scalar error message.
1717 To actually run the events, call each event's test_condition method, and if
1718 still true, call the event's do_event method.
1720 Options are passed as a hashref or as a list of name-value pairs. Available
1727 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.
1731 "collect" (the default) or "pre-bill"
1735 "Current time" for the events.
1739 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)
1743 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1747 Explicitly pass the objects to be tested (typically used with eventtable).
1751 Set to true to return the objects, but not actually insert them into the
1758 sub due_cust_event {
1760 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1763 #my $DEBUG = $opt{'debug'}
1764 $opt{'debug'} ||= 0; # silence some warnings
1765 local($DEBUG) = $opt{'debug'}
1766 if $opt{'debug'} > $DEBUG;
1767 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1769 warn "$me due_cust_event called with options ".
1770 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1773 $opt{'time'} ||= time;
1775 local $SIG{HUP} = 'IGNORE';
1776 local $SIG{INT} = 'IGNORE';
1777 local $SIG{QUIT} = 'IGNORE';
1778 local $SIG{TERM} = 'IGNORE';
1779 local $SIG{TSTP} = 'IGNORE';
1780 local $SIG{PIPE} = 'IGNORE';
1782 my $oldAutoCommit = $FS::UID::AutoCommit;
1783 local $FS::UID::AutoCommit = 0;
1786 $self->select_for_update #mutex
1787 unless $opt{testonly};
1790 # find possible events (initial search)
1793 my @cust_event = ();
1795 my @eventtable = $opt{'eventtable'}
1796 ? ( $opt{'eventtable'} )
1797 : FS::part_event->eventtables_runorder;
1799 my $check_freq = $opt{'check_freq'} || '1d';
1801 foreach my $eventtable ( @eventtable ) {
1804 if ( $opt{'objects'} ) {
1806 @objects = @{ $opt{'objects'} };
1810 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1811 if ( $eventtable eq 'cust_main' ) {
1812 @objects = ( $self );
1816 "LEFT JOIN cust_main USING ( custnum )";
1818 #some false laziness w/Cron::bill bill_where
1820 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1821 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1822 'time'=>$opt{'time'},
1824 $where = $where ? "AND $where" : '';
1826 my $are_part_event =
1827 "EXISTS ( SELECT 1 FROM part_event $join
1828 WHERE check_freq = '$check_freq'
1829 AND eventtable = '$eventtable'
1830 AND ( disabled = '' OR disabled IS NULL )
1836 @objects = $self->$eventtable(
1837 'addl_from' => $cm_join,
1838 'extra_sql' => " AND $are_part_event",
1844 my @e_cust_event = ();
1846 my $cross = "CROSS JOIN $eventtable";
1847 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1848 unless $eventtable eq 'cust_main';
1850 foreach my $object ( @objects ) {
1852 #this first search uses the condition_sql magic for optimization.
1853 #the more possible events we can eliminate in this step the better
1855 my $cross_where = '';
1856 my $pkey = $object->primary_key;
1857 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1859 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1861 FS::part_event_condition->where_conditions_sql( $eventtable,
1862 'time'=>$opt{'time'}
1864 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1866 $extra_sql = "AND $extra_sql" if $extra_sql;
1868 #here is the agent virtualization
1869 $extra_sql .= " AND ( part_event.agentnum IS NULL
1870 OR part_event.agentnum = ". $self->agentnum. ' )';
1872 $extra_sql .= " $order";
1874 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1875 if $opt{'debug'} > 2;
1876 my @part_event = qsearch( {
1877 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1878 'select' => 'part_event.*',
1879 'table' => 'part_event',
1880 'addl_from' => "$cross $join",
1881 'hashref' => { 'check_freq' => $check_freq,
1882 'eventtable' => $eventtable,
1885 'extra_sql' => "AND $cross_where $extra_sql",
1889 my $pkey = $object->primary_key;
1890 warn " ". scalar(@part_event).
1891 " possible events found for $eventtable ". $object->$pkey(). "\n";
1894 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1898 warn " ". scalar(@e_cust_event).
1899 " subtotal possible cust events found for $eventtable\n"
1902 push @cust_event, @e_cust_event;
1906 warn " ". scalar(@cust_event).
1907 " total possible cust events found in initial search\n"
1915 $opt{stage} ||= 'collect';
1917 grep { my $stage = $_->part_event->event_stage;
1918 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1928 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1929 'stats_hashref' => \%unsat ),
1932 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1935 warn " invalid conditions not eliminated with condition_sql:\n".
1936 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1937 if keys %unsat && $DEBUG; # > 1;
1943 unless( $opt{testonly} ) {
1944 foreach my $cust_event ( @cust_event ) {
1946 my $error = $cust_event->insert();
1948 $dbh->rollback if $oldAutoCommit;
1955 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1961 warn " returning events: ". Dumper(@cust_event). "\n"
1968 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1970 Applies unapplied payments and credits.
1972 In most cases, this new method should be used in place of sequential
1973 apply_payments and apply_credits methods.
1975 A hash of optional arguments may be passed. Currently "manual" is supported.
1976 If true, a payment receipt is sent instead of a statement when
1977 'payment_receipt_email' configuration option is set.
1979 If there is an error, returns the error, otherwise returns false.
1983 sub apply_payments_and_credits {
1984 my( $self, %options ) = @_;
1986 local $SIG{HUP} = 'IGNORE';
1987 local $SIG{INT} = 'IGNORE';
1988 local $SIG{QUIT} = 'IGNORE';
1989 local $SIG{TERM} = 'IGNORE';
1990 local $SIG{TSTP} = 'IGNORE';
1991 local $SIG{PIPE} = 'IGNORE';
1993 my $oldAutoCommit = $FS::UID::AutoCommit;
1994 local $FS::UID::AutoCommit = 0;
1997 $self->select_for_update; #mutex
1999 foreach my $cust_bill ( $self->open_cust_bill ) {
2000 my $error = $cust_bill->apply_payments_and_credits(%options);
2002 $dbh->rollback if $oldAutoCommit;
2003 return "Error applying: $error";
2007 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2012 =item apply_credits OPTION => VALUE ...
2014 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2015 to outstanding invoice balances in chronological order (or reverse
2016 chronological order if the I<order> option is set to B<newest>) and returns the
2017 value of any remaining unapplied credits available for refund (see
2018 L<FS::cust_refund>).
2020 Dies if there is an error.
2028 local $SIG{HUP} = 'IGNORE';
2029 local $SIG{INT} = 'IGNORE';
2030 local $SIG{QUIT} = 'IGNORE';
2031 local $SIG{TERM} = 'IGNORE';
2032 local $SIG{TSTP} = 'IGNORE';
2033 local $SIG{PIPE} = 'IGNORE';
2035 my $oldAutoCommit = $FS::UID::AutoCommit;
2036 local $FS::UID::AutoCommit = 0;
2039 $self->select_for_update; #mutex
2041 unless ( $self->total_unapplied_credits ) {
2042 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2046 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2047 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2049 my @invoices = $self->open_cust_bill;
2050 @invoices = sort { $b->_date <=> $a->_date } @invoices
2051 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2053 if ( $conf->exists('pkg-balances') ) {
2054 # limit @credits to those w/ a pkgnum grepped from $self
2056 foreach my $i (@invoices) {
2057 foreach my $li ( $i->cust_bill_pkg ) {
2058 $pkgnums{$li->pkgnum} = 1;
2061 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2066 foreach my $cust_bill ( @invoices ) {
2068 if ( !defined($credit) || $credit->credited == 0) {
2069 $credit = pop @credits or last;
2073 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2074 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2076 $owed = $cust_bill->owed;
2078 unless ( $owed > 0 ) {
2079 push @credits, $credit;
2083 my $amount = min( $credit->credited, $owed );
2085 my $cust_credit_bill = new FS::cust_credit_bill ( {
2086 'crednum' => $credit->crednum,
2087 'invnum' => $cust_bill->invnum,
2088 'amount' => $amount,
2090 $cust_credit_bill->pkgnum( $credit->pkgnum )
2091 if $conf->exists('pkg-balances') && $credit->pkgnum;
2092 my $error = $cust_credit_bill->insert;
2094 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2098 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2102 my $total_unapplied_credits = $self->total_unapplied_credits;
2104 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2106 return $total_unapplied_credits;
2109 =item apply_payments [ OPTION => VALUE ... ]
2111 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2112 to outstanding invoice balances in chronological order.
2114 #and returns the value of any remaining unapplied payments.
2116 A hash of optional arguments may be passed. Currently "manual" is supported.
2117 If true, a payment receipt is sent instead of a statement when
2118 'payment_receipt_email' configuration option is set.
2120 Dies if there is an error.
2124 sub apply_payments {
2125 my( $self, %options ) = @_;
2127 local $SIG{HUP} = 'IGNORE';
2128 local $SIG{INT} = 'IGNORE';
2129 local $SIG{QUIT} = 'IGNORE';
2130 local $SIG{TERM} = 'IGNORE';
2131 local $SIG{TSTP} = 'IGNORE';
2132 local $SIG{PIPE} = 'IGNORE';
2134 my $oldAutoCommit = $FS::UID::AutoCommit;
2135 local $FS::UID::AutoCommit = 0;
2138 $self->select_for_update; #mutex
2142 my @payments = sort { $b->_date <=> $a->_date }
2143 grep { $_->unapplied > 0 }
2146 my @invoices = sort { $a->_date <=> $b->_date}
2147 grep { $_->owed > 0 }
2150 if ( $conf->exists('pkg-balances') ) {
2151 # limit @payments to those w/ a pkgnum grepped from $self
2153 foreach my $i (@invoices) {
2154 foreach my $li ( $i->cust_bill_pkg ) {
2155 $pkgnums{$li->pkgnum} = 1;
2158 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2163 foreach my $cust_bill ( @invoices ) {
2165 if ( !defined($payment) || $payment->unapplied == 0 ) {
2166 $payment = pop @payments or last;
2170 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2171 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2173 $owed = $cust_bill->owed;
2175 unless ( $owed > 0 ) {
2176 push @payments, $payment;
2180 my $amount = min( $payment->unapplied, $owed );
2183 'paynum' => $payment->paynum,
2184 'invnum' => $cust_bill->invnum,
2185 'amount' => $amount,
2187 $cbp->{_date} = $payment->_date
2188 if $options{'manual'} && $options{'backdate_application'};
2189 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2190 $cust_bill_pay->pkgnum( $payment->pkgnum )
2191 if $conf->exists('pkg-balances') && $payment->pkgnum;
2192 my $error = $cust_bill_pay->insert(%options);
2194 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2198 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2202 my $total_unapplied_payments = $self->total_unapplied_payments;
2204 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2206 return $total_unapplied_payments;
2216 suspend_adjourned_pkgs
2217 unsuspend_resumed_pkgs
2220 (do_cust_event pre-bill)
2223 (vendor-only) _gather_taxes
2224 _omit_zero_value_bundles
2227 apply_payments_and_credits
2236 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>