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.
597 " sum $sum, recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
600 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
601 push @cust_bill_pkg, @cust_bill_pkg_bundle
603 || ($sum == 0 && ( $discount_show_always
604 || grep $_->recur_show_zero, @cust_bill_pkg_bundle )
606 @cust_bill_pkg_bundle = ();
610 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
611 push @cust_bill_pkg_bundle, $cust_bill_pkg;
615 push @cust_bill_pkg, @cust_bill_pkg_bundle
617 || ($sum == 0 && ( $discount_show_always
618 || grep $_->recur_show_zero, @cust_bill_pkg_bundle )
621 warn " _omit_zero_value_bundles: ". scalar(@in).
622 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
629 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
631 This is a weird one. Perhaps it should not even be exposed.
633 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
634 Usually used internally by bill method B<bill>.
636 If there is an error, returns the error, otherwise returns reference to a
637 list of line items suitable for insertion.
643 An array ref of the line items being billed.
647 A strange beast. The keys to this hash are internal identifiers consisting
648 of the name of the tax object type, a space, and its unique identifier ( e.g.
649 'cust_main_county 23' ). The values of the hash are listrefs. The first
650 item in the list is the tax object. The remaining items are either line
651 items or floating point values (currency amounts).
653 The taxes are calculated on this entity. Calculated exemption records are
654 transferred to the LINEITEMREF items on the assumption that they are related.
660 This specifies the date appearing on the associated invoice. Some
661 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
667 sub calculate_taxes {
668 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
670 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
672 warn "$me calculate_taxes\n"
673 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
676 my @tax_line_items = ();
678 # keys are tax names (as printed on invoices / itemdesc )
679 # values are listrefs of taxlisthash keys (internal identifiers)
682 # keys are taxlisthash keys (internal identifiers)
683 # values are (cumulative) amounts
686 # keys are taxlisthash keys (internal identifiers)
687 # values are listrefs of cust_bill_pkg_tax_location hashrefs
688 my %tax_location = ();
690 # keys are taxlisthash keys (internal identifiers)
691 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
692 my %tax_rate_location = ();
694 foreach my $tax ( keys %$taxlisthash ) {
695 my $tax_object = shift @{ $taxlisthash->{$tax} };
696 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
697 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
698 my $hashref_or_error =
699 $tax_object->taxline( $taxlisthash->{$tax},
700 'custnum' => $self->custnum,
701 'invoice_time' => $invoice_time
703 return $hashref_or_error unless ref($hashref_or_error);
705 unshift @{ $taxlisthash->{$tax} }, $tax_object;
707 my $name = $hashref_or_error->{'name'};
708 my $amount = $hashref_or_error->{'amount'};
710 #warn "adding $amount as $name\n";
711 $taxname{ $name } ||= [];
712 push @{ $taxname{ $name } }, $tax;
714 $tax{ $tax } += $amount;
716 $tax_location{ $tax } ||= [];
717 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
718 push @{ $tax_location{ $tax } },
720 'taxnum' => $tax_object->taxnum,
721 'taxtype' => ref($tax_object),
722 'pkgnum' => $tax_object->get('pkgnum'),
723 'locationnum' => $tax_object->get('locationnum'),
724 'amount' => sprintf('%.2f', $amount ),
728 $tax_rate_location{ $tax } ||= [];
729 if ( ref($tax_object) eq 'FS::tax_rate' ) {
730 my $taxratelocationnum =
731 $tax_object->tax_rate_location->taxratelocationnum;
732 push @{ $tax_rate_location{ $tax } },
734 'taxnum' => $tax_object->taxnum,
735 'taxtype' => ref($tax_object),
736 'amount' => sprintf('%.2f', $amount ),
737 'locationtaxid' => $tax_object->location,
738 'taxratelocationnum' => $taxratelocationnum,
744 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
745 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
746 foreach my $tax ( keys %$taxlisthash ) {
747 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
748 next unless ref($_) eq 'FS::cust_bill_pkg';
750 my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
752 next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
753 die "can't distribute tax exemptions: no line item for ". Dumper($_).
754 " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
755 unless $packagemap{$_->pkgnum};
757 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
758 @cust_tax_exempt_pkg;
762 #consolidate and create tax line items
763 warn "consolidating and generating...\n" if $DEBUG > 2;
764 foreach my $taxname ( keys %taxname ) {
767 my @cust_bill_pkg_tax_location = ();
768 my @cust_bill_pkg_tax_rate_location = ();
769 warn "adding $taxname\n" if $DEBUG > 1;
770 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
771 next if $seen{$taxitem}++;
772 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
773 $tax += $tax{$taxitem};
774 push @cust_bill_pkg_tax_location,
775 map { new FS::cust_bill_pkg_tax_location $_ }
776 @{ $tax_location{ $taxitem } };
777 push @cust_bill_pkg_tax_rate_location,
778 map { new FS::cust_bill_pkg_tax_rate_location $_ }
779 @{ $tax_rate_location{ $taxitem } };
783 $tax = sprintf('%.2f', $tax );
785 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
791 if ( $pkg_category and
792 $conf->config('invoice_latexsummary') ||
793 $conf->config('invoice_htmlsummary')
797 my %hash = ( 'section' => $pkg_category->categoryname );
798 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
802 push @tax_line_items, new FS::cust_bill_pkg {
808 'itemdesc' => $taxname,
809 'display' => \@display,
810 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
811 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
820 my ($self, %params) = @_;
822 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
824 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
825 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
826 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
827 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
828 my $total_setup = $params{setup} or die "no setup accumulator specified";
829 my $total_recur = $params{recur} or die "no recur accumulator specified";
830 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
831 my $time = $params{'time'} or die "no time specified";
832 my (%options) = %{$params{options}};
835 my $real_pkgpart = $params{real_pkgpart};
836 my %hash = $cust_pkg->hash;
837 my $old_cust_pkg = new FS::cust_pkg \%hash;
843 $cust_pkg->pkgpart($part_pkg->pkgpart);
851 my %setup_param = ();
852 if ( ! $options{recurring_only}
853 and ! $options{cancel}
854 and ( $options{'resetup'}
855 || ( ! $cust_pkg->setup
856 && ( ! $cust_pkg->start_date
857 || $cust_pkg->start_date <= $time
859 && ( ! $conf->exists('disable_setup_suspended_pkgs')
860 || ( $conf->exists('disable_setup_suspended_pkgs') &&
861 ! $cust_pkg->getfield('susp')
869 warn " bill setup\n" if $DEBUG > 1;
871 unless ( $cust_pkg->waive_setup ) {
874 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
875 return "$@ running calc_setup for $cust_pkg\n"
878 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
881 $cust_pkg->setfield('setup', $time)
882 unless $cust_pkg->setup;
883 #do need it, but it won't get written to the db
884 #|| $cust_pkg->pkgpart != $real_pkgpart;
886 $cust_pkg->setfield('start_date', '')
887 if $cust_pkg->start_date;
895 #XXX unit stuff here too
899 if ( ! $cust_pkg->start_date
900 and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
902 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $time )
903 || ( $part_pkg->plan eq 'voip_cdr'
904 && $part_pkg->option('bill_every_call')
909 # XXX should this be a package event? probably. events are called
910 # at collection time at the moment, though...
911 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
912 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
913 #don't want to reset usage just cause we want a line item??
914 #&& $part_pkg->pkgpart == $real_pkgpart;
916 warn " bill recur\n" if $DEBUG > 1;
919 # XXX shared with $recur_prog
920 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
924 #over two params! lets at least switch to a hashref for the rest...
925 my $increment_next_bill = ( $part_pkg->freq ne '0'
926 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
929 my %param = ( 'precommit_hooks' => $precommit_hooks,
930 'increment_next_bill' => $increment_next_bill,
931 'discounts' => \@discounts,
932 'real_pkgpart' => $real_pkgpart,
933 'freq_override' => $options{freq_override} || '',
937 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
939 # There may be some part_pkg for which this is wrong. Only those
940 # which can_discount are supported.
941 # (the UI should prevent adding discounts to these at the moment)
943 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
944 return "$@ running $method for $cust_pkg\n"
947 if ( $increment_next_bill ) {
949 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
950 return "unparsable frequency: ". $part_pkg->freq
953 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
954 # only for figuring next bill date, nothing else, so, reset $sdate again
956 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
957 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
958 $cust_pkg->last_bill($sdate);
960 $cust_pkg->setfield('bill', $next_bill );
964 if ( defined $param{'discount_left_setup'} ) {
965 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
966 $setup -= $discount_setup;
972 warn "\$setup is undefined" unless defined($setup);
973 warn "\$recur is undefined" unless defined($recur);
974 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
977 # If there's line items, create em cust_bill_pkg records
978 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
983 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
984 # hmm.. and if just the options are modified in some weird price plan?
986 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
989 my $error = $cust_pkg->replace( $old_cust_pkg,
990 'depend_jobnum'=>$options{depend_jobnum},
991 'options' => { $cust_pkg->options },
993 unless $options{no_commit};
994 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
995 if $error; #just in case
998 $setup = sprintf( "%.2f", $setup );
999 $recur = sprintf( "%.2f", $recur );
1000 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1001 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1003 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1004 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1007 my $discount_show_always = ($recur == 0 && scalar(@discounts)
1008 && $conf->exists('discount-show-always'));
1012 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1013 || $discount_show_always
1014 || ($recur == 0 && $part_pkg->recur_show_zero)
1018 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1021 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1023 warn " adding customer package invoice detail: $_\n"
1024 foreach @cust_pkg_detail;
1026 push @details, @cust_pkg_detail;
1028 my $cust_bill_pkg = new FS::cust_bill_pkg {
1029 'pkgnum' => $cust_pkg->pkgnum,
1031 'unitsetup' => $unitsetup,
1033 'unitrecur' => $unitrecur,
1034 'quantity' => $cust_pkg->quantity,
1035 'details' => \@details,
1036 'discounts' => \@discounts,
1037 'hidden' => $part_pkg->hidden,
1038 'freq' => $part_pkg->freq,
1041 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
1042 $cust_bill_pkg->sdate( $hash{last_bill} );
1043 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1044 $cust_bill_pkg->edate( $time ) if $options{cancel};
1045 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
1046 $cust_bill_pkg->sdate( $sdate );
1047 $cust_bill_pkg->edate( $cust_pkg->bill );
1048 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1051 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1052 unless $part_pkg->pkgpart == $real_pkgpart;
1054 $$total_setup += $setup;
1055 $$total_recur += $recur;
1061 unless ( $discount_show_always ) {
1063 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1064 return $error if $error;
1067 push @$cust_bill_pkgs, $cust_bill_pkg;
1069 } #if $setup != 0 || $recur != 0
1079 my $part_pkg = shift;
1080 my $taxlisthash = shift;
1081 my $cust_bill_pkg = shift;
1082 my $cust_pkg = shift;
1083 my $invoice_time = shift;
1084 my $real_pkgpart = shift;
1085 my $options = shift;
1087 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1089 my %cust_bill_pkg = ();
1093 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1094 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1095 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1096 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1098 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1100 if ( $conf->exists('enable_taxproducts')
1101 && ( scalar($part_pkg->part_pkg_taxoverride)
1102 || $part_pkg->has_taxproduct
1107 foreach my $class (@classes) {
1108 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1109 return $err_or_ref unless ref($err_or_ref);
1110 $taxes{$class} = $err_or_ref;
1113 unless (exists $taxes{''}) {
1114 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1115 return $err_or_ref unless ref($err_or_ref);
1116 $taxes{''} = $err_or_ref;
1121 my @loc_keys = qw( city county state country );
1123 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1124 my $cust_location = $cust_pkg->cust_location;
1125 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1128 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1131 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1134 $taxhash{'taxclass'} = $part_pkg->taxclass;
1137 my %taxhash_elim = %taxhash;
1138 my @elim = qw( city county state );
1141 #first try a match with taxclass
1142 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1144 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1145 #then try a match without taxclass
1146 my %no_taxclass = %taxhash_elim;
1147 $no_taxclass{ 'taxclass' } = '';
1148 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1151 $taxhash_elim{ shift(@elim) } = '';
1153 } while ( !scalar(@taxes) && scalar(@elim) );
1155 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1157 if $self->cust_main_exemption; #just to be safe
1159 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1161 $_->set('pkgnum', $cust_pkg->pkgnum );
1162 $_->set('locationnum', $cust_pkg->locationnum );
1166 $taxes{''} = [ @taxes ];
1167 $taxes{'setup'} = [ @taxes ];
1168 $taxes{'recur'} = [ @taxes ];
1169 $taxes{$_} = [ @taxes ] foreach (@classes);
1171 # # maybe eliminate this entirely, along with all the 0% records
1172 # unless ( @taxes ) {
1174 # "fatal: can't find tax rate for state/county/country/taxclass ".
1175 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1178 } #if $conf->exists('enable_taxproducts') ...
1183 my $separate = $conf->exists('separate_usage');
1184 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1185 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1186 my $section = $temp_pkg->part_pkg->categoryname;
1187 if ( $separate || $section || $usage_mandate ) {
1189 my %hash = ( 'section' => $section );
1191 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1192 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1194 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1195 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1197 push @display, new FS::cust_bill_pkg_display
1200 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1204 if ($separate && $section && $summary) {
1205 push @display, new FS::cust_bill_pkg_display { type => 'U',
1210 if ($usage_mandate || $section && $summary) {
1211 $hash{post_total} = 'Y';
1214 if ($separate || $usage_mandate) {
1215 $hash{section} = $section if ($separate || $usage_mandate);
1216 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1220 $cust_bill_pkg->set('display', \@display);
1222 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1223 foreach my $key (keys %tax_cust_bill_pkg) {
1224 my @taxes = @{ $taxes{$key} || [] };
1225 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1227 my %localtaxlisthash = ();
1228 foreach my $tax ( @taxes ) {
1230 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1231 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1232 # ' locationnum'. $cust_pkg->locationnum
1233 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1235 $taxlisthash->{ $taxname } ||= [ $tax ];
1236 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1238 $localtaxlisthash{ $taxname } ||= [ $tax ];
1239 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1243 warn "finding taxed taxes...\n" if $DEBUG > 2;
1244 foreach my $tax ( keys %localtaxlisthash ) {
1245 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1246 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1248 next unless $tax_object->can('tax_on_tax');
1250 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1251 my $totname = ref( $tot ). ' '. $tot->taxnum;
1253 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1255 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1257 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1258 my $hashref_or_error =
1259 $tax_object->taxline( $localtaxlisthash{$tax},
1260 'custnum' => $self->custnum,
1261 'invoice_time' => $invoice_time,
1263 return $hashref_or_error
1264 unless ref($hashref_or_error);
1266 $taxlisthash->{ $totname } ||= [ $tot ];
1267 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1279 my $part_pkg = shift;
1281 my $cust_pkg = shift;
1283 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1286 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1287 $geocode = $cust_pkg->cust_location->geocode('cch');
1289 $geocode = $self->geocode('cch');
1294 my @taxclassnums = map { $_->taxclassnum }
1295 $part_pkg->part_pkg_taxoverride($class);
1297 unless (@taxclassnums) {
1298 @taxclassnums = map { $_->taxclassnum }
1299 grep { $_->taxable eq 'Y' }
1300 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1302 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1307 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1309 @taxes = qsearch({ 'table' => 'tax_rate',
1310 'hashref' => { 'geocode' => $geocode, },
1311 'extra_sql' => $extra_sql,
1313 if scalar(@taxclassnums);
1315 warn "Found taxes ".
1316 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1323 =item collect [ HASHREF | OPTION => VALUE ... ]
1325 (Attempt to) collect money for this customer's outstanding invoices (see
1326 L<FS::cust_bill>). Usually used after the bill method.
1328 Actions are now triggered by billing events; see L<FS::part_event> and the
1329 billing events web interface. Old-style invoice events (see
1330 L<FS::part_bill_event>) have been deprecated.
1332 If there is an error, returns the error, otherwise returns false.
1334 Options are passed as name-value pairs.
1336 Currently available options are:
1342 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.
1346 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1350 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1354 set true to surpress email card/ACH decline notices.
1358 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)
1364 # allows for one time override of normal customer billing method
1369 my( $self, %options ) = @_;
1371 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1373 my $invoice_time = $options{'invoice_time'} || time;
1376 local $SIG{HUP} = 'IGNORE';
1377 local $SIG{INT} = 'IGNORE';
1378 local $SIG{QUIT} = 'IGNORE';
1379 local $SIG{TERM} = 'IGNORE';
1380 local $SIG{TSTP} = 'IGNORE';
1381 local $SIG{PIPE} = 'IGNORE';
1383 my $oldAutoCommit = $FS::UID::AutoCommit;
1384 local $FS::UID::AutoCommit = 0;
1387 $self->select_for_update; #mutex
1390 my $balance = $self->balance;
1391 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1394 if ( exists($options{'retry_card'}) ) {
1395 carp 'retry_card option passed to collect is deprecated; use retry';
1396 $options{'retry'} ||= $options{'retry_card'};
1398 if ( exists($options{'retry'}) && $options{'retry'} ) {
1399 my $error = $self->retry_realtime;
1401 $dbh->rollback if $oldAutoCommit;
1406 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1408 #never want to roll back an event just because it returned an error
1409 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1411 $self->do_cust_event(
1412 'debug' => ( $options{'debug'} || 0 ),
1413 'time' => $invoice_time,
1414 'check_freq' => $options{'check_freq'},
1415 'stage' => 'collect',
1420 =item retry_realtime
1422 Schedules realtime / batch credit card / electronic check / LEC billing
1423 events for for retry. Useful if card information has changed or manual
1424 retry is desired. The 'collect' method must be called to actually retry
1427 Implementation details: For either this customer, or for each of this
1428 customer's open invoices, changes the status of the first "done" (with
1429 statustext error) realtime processing event to "failed".
1433 sub retry_realtime {
1436 local $SIG{HUP} = 'IGNORE';
1437 local $SIG{INT} = 'IGNORE';
1438 local $SIG{QUIT} = 'IGNORE';
1439 local $SIG{TERM} = 'IGNORE';
1440 local $SIG{TSTP} = 'IGNORE';
1441 local $SIG{PIPE} = 'IGNORE';
1443 my $oldAutoCommit = $FS::UID::AutoCommit;
1444 local $FS::UID::AutoCommit = 0;
1447 #a little false laziness w/due_cust_event (not too bad, really)
1449 my $join = FS::part_event_condition->join_conditions_sql;
1450 my $order = FS::part_event_condition->order_conditions_sql;
1453 . join ( ' OR ' , map {
1454 "( part_event.eventtable = " . dbh->quote($_)
1455 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1456 } FS::part_event->eventtables)
1459 #here is the agent virtualization
1460 my $agent_virt = " ( part_event.agentnum IS NULL
1461 OR part_event.agentnum = ". $self->agentnum. ' )';
1463 #XXX this shouldn't be hardcoded, actions should declare it...
1464 my @realtime_events = qw(
1465 cust_bill_realtime_card
1466 cust_bill_realtime_check
1467 cust_bill_realtime_lec
1471 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1476 my @cust_event = qsearchs({
1477 'table' => 'cust_event',
1478 'select' => 'cust_event.*',
1479 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1480 'hashref' => { 'status' => 'done' },
1481 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1482 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1485 my %seen_invnum = ();
1486 foreach my $cust_event (@cust_event) {
1488 #max one for the customer, one for each open invoice
1489 my $cust_X = $cust_event->cust_X;
1490 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1494 or $cust_event->part_event->eventtable eq 'cust_bill'
1497 my $error = $cust_event->retry;
1499 $dbh->rollback if $oldAutoCommit;
1500 return "error scheduling event for retry: $error";
1505 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1510 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1512 Runs billing events; see L<FS::part_event> and the billing events web
1515 If there is an error, returns the error, otherwise returns false.
1517 Options are passed as name-value pairs.
1519 Currently available options are:
1525 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.
1529 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1533 "collect" (the default) or "pre-bill"
1537 set true to surpress email card/ACH decline notices.
1541 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)
1548 # allows for one time override of normal customer billing method
1552 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1555 my( $self, %options ) = @_;
1557 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1559 my $time = $options{'time'} || time;
1562 local $SIG{HUP} = 'IGNORE';
1563 local $SIG{INT} = 'IGNORE';
1564 local $SIG{QUIT} = 'IGNORE';
1565 local $SIG{TERM} = 'IGNORE';
1566 local $SIG{TSTP} = 'IGNORE';
1567 local $SIG{PIPE} = 'IGNORE';
1569 my $oldAutoCommit = $FS::UID::AutoCommit;
1570 local $FS::UID::AutoCommit = 0;
1573 $self->select_for_update; #mutex
1576 my $balance = $self->balance;
1577 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1580 # if ( exists($options{'retry_card'}) ) {
1581 # carp 'retry_card option passed to collect is deprecated; use retry';
1582 # $options{'retry'} ||= $options{'retry_card'};
1584 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1585 # my $error = $self->retry_realtime;
1587 # $dbh->rollback if $oldAutoCommit;
1592 # false laziness w/pay_batch::import_results
1594 my $due_cust_event = $self->due_cust_event(
1595 'debug' => ( $options{'debug'} || 0 ),
1597 'check_freq' => $options{'check_freq'},
1598 'stage' => ( $options{'stage'} || 'collect' ),
1600 unless( ref($due_cust_event) ) {
1601 $dbh->rollback if $oldAutoCommit;
1602 return $due_cust_event;
1605 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1606 #never want to roll back an event just because it or a different one
1608 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1610 foreach my $cust_event ( @$due_cust_event ) {
1614 #re-eval event conditions (a previous event could have changed things)
1615 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1616 #don't leave stray "new/locked" records around
1617 my $error = $cust_event->delete;
1618 return $error if $error;
1623 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1624 if $options{'quiet'};
1625 warn " running cust_event ". $cust_event->eventnum. "\n"
1628 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1629 if ( my $error = $cust_event->do_event() ) {
1630 #XXX wtf is this? figure out a proper dealio with return value
1642 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1644 Inserts database records for and returns an ordered listref of new events due
1645 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1646 events are due, an empty listref is returned. If there is an error, returns a
1647 scalar error message.
1649 To actually run the events, call each event's test_condition method, and if
1650 still true, call the event's do_event method.
1652 Options are passed as a hashref or as a list of name-value pairs. Available
1659 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.
1663 "collect" (the default) or "pre-bill"
1667 "Current time" for the events.
1671 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)
1675 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1679 Explicitly pass the objects to be tested (typically used with eventtable).
1683 Set to true to return the objects, but not actually insert them into the
1690 sub due_cust_event {
1692 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1695 #my $DEBUG = $opt{'debug'}
1696 local($DEBUG) = $opt{'debug'}
1697 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1698 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1700 warn "$me due_cust_event called with options ".
1701 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1704 $opt{'time'} ||= time;
1706 local $SIG{HUP} = 'IGNORE';
1707 local $SIG{INT} = 'IGNORE';
1708 local $SIG{QUIT} = 'IGNORE';
1709 local $SIG{TERM} = 'IGNORE';
1710 local $SIG{TSTP} = 'IGNORE';
1711 local $SIG{PIPE} = 'IGNORE';
1713 my $oldAutoCommit = $FS::UID::AutoCommit;
1714 local $FS::UID::AutoCommit = 0;
1717 $self->select_for_update #mutex
1718 unless $opt{testonly};
1721 # find possible events (initial search)
1724 my @cust_event = ();
1726 my @eventtable = $opt{'eventtable'}
1727 ? ( $opt{'eventtable'} )
1728 : FS::part_event->eventtables_runorder;
1730 my $check_freq = $opt{'check_freq'} || '1d';
1732 foreach my $eventtable ( @eventtable ) {
1735 if ( $opt{'objects'} ) {
1737 @objects = @{ $opt{'objects'} };
1741 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1742 if ( $eventtable eq 'cust_main' ) {
1743 @objects = ( $self );
1747 "LEFT JOIN cust_main USING ( custnum )";
1749 #some false laziness w/Cron::bill bill_where
1751 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1752 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1753 'time'=>$opt{'time'},
1755 $where = $where ? "AND $where" : '';
1757 my $are_part_event =
1758 "EXISTS ( SELECT 1 FROM part_event $join
1759 WHERE check_freq = '$check_freq'
1760 AND eventtable = '$eventtable'
1761 AND ( disabled = '' OR disabled IS NULL )
1767 @objects = $self->$eventtable(
1768 'addl_from' => $cm_join,
1769 'extra_sql' => " AND $are_part_event",
1775 my @e_cust_event = ();
1777 my $cross = "CROSS JOIN $eventtable";
1778 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1779 unless $eventtable eq 'cust_main';
1781 foreach my $object ( @objects ) {
1783 #this first search uses the condition_sql magic for optimization.
1784 #the more possible events we can eliminate in this step the better
1786 my $cross_where = '';
1787 my $pkey = $object->primary_key;
1788 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1790 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1792 FS::part_event_condition->where_conditions_sql( $eventtable,
1793 'time'=>$opt{'time'}
1795 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1797 $extra_sql = "AND $extra_sql" if $extra_sql;
1799 #here is the agent virtualization
1800 $extra_sql .= " AND ( part_event.agentnum IS NULL
1801 OR part_event.agentnum = ". $self->agentnum. ' )';
1803 $extra_sql .= " $order";
1805 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1806 if $opt{'debug'} > 2;
1807 my @part_event = qsearch( {
1808 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1809 'select' => 'part_event.*',
1810 'table' => 'part_event',
1811 'addl_from' => "$cross $join",
1812 'hashref' => { 'check_freq' => $check_freq,
1813 'eventtable' => $eventtable,
1816 'extra_sql' => "AND $cross_where $extra_sql",
1820 my $pkey = $object->primary_key;
1821 warn " ". scalar(@part_event).
1822 " possible events found for $eventtable ". $object->$pkey(). "\n";
1825 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1829 warn " ". scalar(@e_cust_event).
1830 " subtotal possible cust events found for $eventtable\n"
1833 push @cust_event, @e_cust_event;
1837 warn " ". scalar(@cust_event).
1838 " total possible cust events found in initial search\n"
1846 $opt{stage} ||= 'collect';
1848 grep { my $stage = $_->part_event->event_stage;
1849 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1859 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1860 'stats_hashref' => \%unsat ),
1863 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1866 warn " invalid conditions not eliminated with condition_sql:\n".
1867 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1868 if keys %unsat && $DEBUG; # > 1;
1874 unless( $opt{testonly} ) {
1875 foreach my $cust_event ( @cust_event ) {
1877 my $error = $cust_event->insert();
1879 $dbh->rollback if $oldAutoCommit;
1886 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1892 warn " returning events: ". Dumper(@cust_event). "\n"
1899 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1901 Applies unapplied payments and credits.
1903 In most cases, this new method should be used in place of sequential
1904 apply_payments and apply_credits methods.
1906 A hash of optional arguments may be passed. Currently "manual" is supported.
1907 If true, a payment receipt is sent instead of a statement when
1908 'payment_receipt_email' configuration option is set.
1910 If there is an error, returns the error, otherwise returns false.
1914 sub apply_payments_and_credits {
1915 my( $self, %options ) = @_;
1917 local $SIG{HUP} = 'IGNORE';
1918 local $SIG{INT} = 'IGNORE';
1919 local $SIG{QUIT} = 'IGNORE';
1920 local $SIG{TERM} = 'IGNORE';
1921 local $SIG{TSTP} = 'IGNORE';
1922 local $SIG{PIPE} = 'IGNORE';
1924 my $oldAutoCommit = $FS::UID::AutoCommit;
1925 local $FS::UID::AutoCommit = 0;
1928 $self->select_for_update; #mutex
1930 foreach my $cust_bill ( $self->open_cust_bill ) {
1931 my $error = $cust_bill->apply_payments_and_credits(%options);
1933 $dbh->rollback if $oldAutoCommit;
1934 return "Error applying: $error";
1938 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1943 =item apply_credits OPTION => VALUE ...
1945 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1946 to outstanding invoice balances in chronological order (or reverse
1947 chronological order if the I<order> option is set to B<newest>) and returns the
1948 value of any remaining unapplied credits available for refund (see
1949 L<FS::cust_refund>).
1951 Dies if there is an error.
1959 local $SIG{HUP} = 'IGNORE';
1960 local $SIG{INT} = 'IGNORE';
1961 local $SIG{QUIT} = 'IGNORE';
1962 local $SIG{TERM} = 'IGNORE';
1963 local $SIG{TSTP} = 'IGNORE';
1964 local $SIG{PIPE} = 'IGNORE';
1966 my $oldAutoCommit = $FS::UID::AutoCommit;
1967 local $FS::UID::AutoCommit = 0;
1970 $self->select_for_update; #mutex
1972 unless ( $self->total_unapplied_credits ) {
1973 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1977 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1978 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1980 my @invoices = $self->open_cust_bill;
1981 @invoices = sort { $b->_date <=> $a->_date } @invoices
1982 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1984 if ( $conf->exists('pkg-balances') ) {
1985 # limit @credits to those w/ a pkgnum grepped from $self
1987 foreach my $i (@invoices) {
1988 foreach my $li ( $i->cust_bill_pkg ) {
1989 $pkgnums{$li->pkgnum} = 1;
1992 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
1997 foreach my $cust_bill ( @invoices ) {
1999 if ( !defined($credit) || $credit->credited == 0) {
2000 $credit = pop @credits or last;
2004 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2005 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2007 $owed = $cust_bill->owed;
2009 unless ( $owed > 0 ) {
2010 push @credits, $credit;
2014 my $amount = min( $credit->credited, $owed );
2016 my $cust_credit_bill = new FS::cust_credit_bill ( {
2017 'crednum' => $credit->crednum,
2018 'invnum' => $cust_bill->invnum,
2019 'amount' => $amount,
2021 $cust_credit_bill->pkgnum( $credit->pkgnum )
2022 if $conf->exists('pkg-balances') && $credit->pkgnum;
2023 my $error = $cust_credit_bill->insert;
2025 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2029 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2033 my $total_unapplied_credits = $self->total_unapplied_credits;
2035 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2037 return $total_unapplied_credits;
2040 =item apply_payments [ OPTION => VALUE ... ]
2042 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2043 to outstanding invoice balances in chronological order.
2045 #and returns the value of any remaining unapplied payments.
2047 A hash of optional arguments may be passed. Currently "manual" is supported.
2048 If true, a payment receipt is sent instead of a statement when
2049 'payment_receipt_email' configuration option is set.
2051 Dies if there is an error.
2055 sub apply_payments {
2056 my( $self, %options ) = @_;
2058 local $SIG{HUP} = 'IGNORE';
2059 local $SIG{INT} = 'IGNORE';
2060 local $SIG{QUIT} = 'IGNORE';
2061 local $SIG{TERM} = 'IGNORE';
2062 local $SIG{TSTP} = 'IGNORE';
2063 local $SIG{PIPE} = 'IGNORE';
2065 my $oldAutoCommit = $FS::UID::AutoCommit;
2066 local $FS::UID::AutoCommit = 0;
2069 $self->select_for_update; #mutex
2073 my @payments = sort { $b->_date <=> $a->_date }
2074 grep { $_->unapplied > 0 }
2077 my @invoices = sort { $a->_date <=> $b->_date}
2078 grep { $_->owed > 0 }
2081 if ( $conf->exists('pkg-balances') ) {
2082 # limit @payments to those w/ a pkgnum grepped from $self
2084 foreach my $i (@invoices) {
2085 foreach my $li ( $i->cust_bill_pkg ) {
2086 $pkgnums{$li->pkgnum} = 1;
2089 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2094 foreach my $cust_bill ( @invoices ) {
2096 if ( !defined($payment) || $payment->unapplied == 0 ) {
2097 $payment = pop @payments or last;
2101 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2102 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2104 $owed = $cust_bill->owed;
2106 unless ( $owed > 0 ) {
2107 push @payments, $payment;
2111 my $amount = min( $payment->unapplied, $owed );
2113 my $cust_bill_pay = new FS::cust_bill_pay ( {
2114 'paynum' => $payment->paynum,
2115 'invnum' => $cust_bill->invnum,
2116 'amount' => $amount,
2118 $cust_bill_pay->pkgnum( $payment->pkgnum )
2119 if $conf->exists('pkg-balances') && $payment->pkgnum;
2120 my $error = $cust_bill_pay->insert(%options);
2122 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2126 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2130 my $total_unapplied_payments = $self->total_unapplied_payments;
2132 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2134 return $total_unapplied_payments;
2143 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>