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;
25 # 1 is mostly method/subroutine entry and options
26 # 2 traces progress of some operations
27 # 3 is even more information including possibly sensitive data
29 $me = '[FS::cust_main::Billing]';
31 install_callback FS::UID sub {
33 #yes, need it for stuff below (prolly should be cached)
38 FS::cust_main::Billing - Billing mixin for cust_main
44 These methods are available on FS::cust_main objects.
50 =item bill_and_collect
52 Cancels and suspends any packages due, generates bills, applies payments and
53 credits, and applies collection events to run cards, send bills and notices,
56 By default, warns on errors and continues with the next operation (but see the
59 Options are passed as name-value pairs. Currently available options are:
65 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:
69 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
73 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.
77 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
81 If set true, re-charges setup fees.
85 If set any errors prevent subsequent operations from continusing. If set
86 specifically to "return", returns the error (or false, if there is no error).
87 Any other true value causes errors to die.
91 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)
95 Optional FS::queue entry to receive status updates.
99 Options are passed to the B<bill> and B<collect> methods verbatim, so all
100 options of those methods are also available.
104 sub bill_and_collect {
105 my( $self, %options ) = @_;
109 #$options{actual_time} not $options{time} because freeside-daily -d is for
110 #pre-printing invoices
112 $options{'actual_time'} ||= time;
113 my $job = $options{'job'};
115 $job->update_statustext('0,cleaning expired packages') if $job;
116 $error = $self->cancel_expired_pkgs( $self->day_end( $options{actual_time} ) );
118 $error = "Error expiring custnum ". $self->custnum. ": $error";
119 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
120 elsif ( $options{fatal} ) { die $error; }
121 else { warn $error; }
124 $error = $self->suspend_adjourned_pkgs( $self->day_end( $options{actual_time} ) );
126 $error = "Error adjourning custnum ". $self->custnum. ": $error";
127 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
128 elsif ( $options{fatal} ) { die $error; }
129 else { warn $error; }
132 $job->update_statustext('20,billing packages') if $job;
133 $error = $self->bill( %options );
135 $error = "Error billing 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 $job->update_statustext('50,applying payments and credits') if $job;
142 $error = $self->apply_payments_and_credits;
144 $error = "Error applying custnum ". $self->custnum. ": $error";
145 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
146 elsif ( $options{fatal} ) { die $error; }
147 else { warn $error; }
150 $job->update_statustext('70,running collection events') if $job;
151 unless ( $conf->exists('cancelled_cust-noevents')
152 && ! $self->num_ncancelled_pkgs
154 $error = $self->collect( %options );
156 $error = "Error collecting custnum ". $self->custnum. ": $error";
157 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
158 elsif ($options{fatal} ) { die $error; }
159 else { warn $error; }
162 $job->update_statustext('100,finished') if $job;
169 # XXX: sometimes "incorrect" if crossing DST boundaries?
174 return $time unless $conf->exists('next-bill-ignore-time');
176 my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
178 mktime(59,59,23,$mday,$mon,$year,$wday,$yday,$isdst);
181 sub cancel_expired_pkgs {
182 my ( $self, $time, %options ) = @_;
184 my @cancel_pkgs = $self->ncancelled_pkgs( {
185 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
190 foreach my $cust_pkg ( @cancel_pkgs ) {
191 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
192 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
193 'reason_otaker' => $cpr->otaker
197 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
200 scalar(@errors) ? join(' / ', @errors) : '';
204 sub suspend_adjourned_pkgs {
205 my ( $self, $time, %options ) = @_;
207 my @susp_pkgs = $self->ncancelled_pkgs( {
209 " AND ( susp IS NULL OR susp = 0 )
210 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
211 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
216 #only because there's no SQL test for is_prepaid :/
218 grep { ( $_->part_pkg->is_prepaid
223 && $_->adjourn <= $time
231 foreach my $cust_pkg ( @susp_pkgs ) {
232 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
233 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
234 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
235 'reason_otaker' => $cpr->otaker
239 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
242 scalar(@errors) ? join(' / ', @errors) : '';
248 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
249 conjunction with the collect method by calling B<bill_and_collect>.
251 If there is an error, returns the error, otherwise returns false.
253 Options are passed as name-value pairs. Currently available options are:
259 If set true, re-charges setup fees.
263 If set true then only bill recurring charges, not setup, usage, one time
268 If set, then override the normal frequency and look for a part_pkg_discount
269 to take at that frequency.
273 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:
277 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
281 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
283 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
287 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
291 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.
295 This boolean value informs the us that the package is being cancelled. This
296 typically might mean not charging the normal recurring fee but only usage
297 fees since the last billing. Setup charges may be charged. Not all package
298 plans support this feature (they tend to charge 0).
302 Prevent the resetting of usage limits during this call.
306 Do not save the generated bill in the database. Useful with return_bill
310 A list reference on which the generated bill(s) will be returned.
314 Optional terms to be printed on this invoice. Otherwise, customer-specific
315 terms or the default terms are used.
322 my( $self, %options ) = @_;
324 return '' if $self->payby eq 'COMP';
326 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
328 warn "$me bill customer ". $self->custnum. "\n"
331 my $time = $options{'time'} || time;
332 my $invoice_time = $options{'invoice_time'} || $time;
334 $options{'not_pkgpart'} ||= {};
335 $options{'not_pkgpart'} = { map { $_ => 1 }
336 split(/\s*,\s*/, $options{'not_pkgpart'})
338 unless ref($options{'not_pkgpart'});
340 local $SIG{HUP} = 'IGNORE';
341 local $SIG{INT} = 'IGNORE';
342 local $SIG{QUIT} = 'IGNORE';
343 local $SIG{TERM} = 'IGNORE';
344 local $SIG{TSTP} = 'IGNORE';
345 local $SIG{PIPE} = 'IGNORE';
347 my $oldAutoCommit = $FS::UID::AutoCommit;
348 local $FS::UID::AutoCommit = 0;
351 warn "$me acquiring lock on customer ". $self->custnum. "\n"
354 $self->select_for_update; #mutex
356 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
359 my $error = $self->do_cust_event(
360 'debug' => ( $options{'debug'} || 0 ),
361 'time' => $invoice_time,
362 'check_freq' => $options{'check_freq'},
363 'stage' => 'pre-bill',
365 unless $options{no_commit};
367 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
371 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
374 #keep auto-charge and non-auto-charge line items separate
375 my @passes = ( '', 'no_auto' );
377 my %cust_bill_pkg = map { $_ => [] } @passes;
380 # find the packages which are due for billing, find out how much they are
381 # & generate invoice database.
384 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
385 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
387 my %taxlisthash = map { $_ => {} } @passes;
389 my @precommit_hooks = ();
391 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
392 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
394 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
396 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
398 #? to avoid use of uninitialized value errors... ?
399 $cust_pkg->setfield('bill', '')
400 unless defined($cust_pkg->bill);
402 #my $part_pkg = $cust_pkg->part_pkg;
404 my $real_pkgpart = $cust_pkg->pkgpart;
405 my %hash = $cust_pkg->hash;
407 # we could implement this bit as FS::part_pkg::has_hidden, but we already
408 # suffer from performance issues
409 $options{has_hidden} = 0;
410 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
411 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
413 foreach my $part_pkg ( @part_pkg ) {
415 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
417 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
419 my $next_bill = $cust_pkg->getfield('bill') || 0;
421 while ( $next_bill <= $time ) {
423 $self->_make_lines( 'part_pkg' => $part_pkg,
424 'cust_pkg' => $cust_pkg,
425 'precommit_hooks' => \@precommit_hooks,
426 'line_items' => $cust_bill_pkg{$pass},
427 'setup' => $total_setup{$pass},
428 'recur' => $total_recur{$pass},
429 'tax_matrix' => $taxlisthash{$pass},
431 'real_pkgpart' => $real_pkgpart,
432 'options' => \%options,
434 # Stop if anything goes wrong, or if we're not incrementing
437 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
438 $next_bill = $cust_pkg->getfield('bill') || 0;
441 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
445 } #foreach my $part_pkg
447 } #foreach my $cust_pkg
449 #if the customer isn't on an automatic payby, everything can go on a single
451 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
452 #merge everything into one list
455 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
457 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
459 next unless @cust_bill_pkg; #don't create an invoice w/o line items
461 warn "$me billing pass $pass\n"
462 #.Dumper(\@cust_bill_pkg)."\n"
465 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
466 !$conf->exists('postal_invoice-recurring_only')
470 my $postal_pkg = $self->charge_postal_fee();
471 if ( $postal_pkg && !ref( $postal_pkg ) ) {
473 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
474 return "can't charge postal invoice fee for customer ".
475 $self->custnum. ": $postal_pkg";
477 } elsif ( $postal_pkg ) {
479 my $real_pkgpart = $postal_pkg->pkgpart;
480 # we could implement this bit as FS::part_pkg::has_hidden, but we already
481 # suffer from performance issues
482 $options{has_hidden} = 0;
483 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
484 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
486 foreach my $part_pkg ( @part_pkg ) {
487 my %postal_options = %options;
488 delete $postal_options{cancel};
490 $self->_make_lines( 'part_pkg' => $part_pkg,
491 'cust_pkg' => $postal_pkg,
492 'precommit_hooks' => \@precommit_hooks,
493 'line_items' => \@cust_bill_pkg,
494 'setup' => $total_setup{$pass},
495 'recur' => $total_recur{$pass},
496 'tax_matrix' => $taxlisthash{$pass},
498 'real_pkgpart' => $real_pkgpart,
499 'options' => \%postal_options,
502 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
507 # it's silly to have a zero value postal_pkg, but....
508 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
514 my $listref_or_error =
515 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
517 unless ( ref( $listref_or_error ) ) {
518 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
519 return $listref_or_error;
522 foreach my $taxline ( @$listref_or_error ) {
523 ${ $total_setup{$pass} } =
524 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
525 push @cust_bill_pkg, $taxline;
529 warn "adding tax adjustments...\n" if $DEBUG > 2;
530 foreach my $cust_tax_adjustment (
531 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
537 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
539 my $itemdesc = $cust_tax_adjustment->taxname;
540 $itemdesc = '' if $itemdesc eq 'Tax';
542 push @cust_bill_pkg, new FS::cust_bill_pkg {
548 'itemdesc' => $itemdesc,
549 'itemcomment' => $cust_tax_adjustment->comment,
550 'cust_tax_adjustment' => $cust_tax_adjustment,
551 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
556 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
558 my @cust_bill = $self->cust_bill;
559 my $balance = $self->balance;
560 my $previous_balance = scalar(@cust_bill)
561 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
564 $previous_balance += $cust_bill[$#cust_bill]->charged
565 if scalar(@cust_bill);
566 #my $balance_adjustments =
567 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
569 warn "creating the new invoice\n" if $DEBUG;
570 #create the new invoice
571 my $cust_bill = new FS::cust_bill ( {
572 'custnum' => $self->custnum,
573 '_date' => $invoice_time,
574 'charged' => $charged,
575 'billing_balance' => $balance,
576 'previous_balance' => $previous_balance,
577 'invoice_terms' => $options{'invoice_terms'},
578 'cust_bill_pkg' => \@cust_bill_pkg,
580 $error = $cust_bill->insert unless $options{no_commit};
582 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
583 return "can't create invoice for customer #". $self->custnum. ": $error";
585 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
587 } #foreach my $pass ( keys %cust_bill_pkg )
589 foreach my $hook ( @precommit_hooks ) {
592 } unless $options{no_commit};
594 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
595 return "$@ running precommit hook $hook\n";
599 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
604 #discard bundled packages of 0 value
605 sub _omit_zero_value_bundles {
607 my @cust_bill_pkg = ();
608 my @cust_bill_pkg_bundle = ();
610 my $discount_show_always = 0;
612 foreach my $cust_bill_pkg ( @_ ) {
613 $discount_show_always = ($cust_bill_pkg->get('discounts')
614 && scalar(@{$cust_bill_pkg->get('discounts')})
615 && $conf->exists('discount-show-always'));
616 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
617 push @cust_bill_pkg, @cust_bill_pkg_bundle
618 if ($sum > 0 || ($sum == 0 && $discount_show_always));
619 @cust_bill_pkg_bundle = ();
622 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
623 push @cust_bill_pkg_bundle, $cust_bill_pkg;
625 push @cust_bill_pkg, @cust_bill_pkg_bundle
626 if ($sum > 0 || ($sum == 0 && $discount_show_always));
632 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
634 This is a weird one. Perhaps it should not even be exposed.
636 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
637 Usually used internally by bill method B<bill>.
639 If there is an error, returns the error, otherwise returns reference to a
640 list of line items suitable for insertion.
646 An array ref of the line items being billed.
650 A strange beast. The keys to this hash are internal identifiers consisting
651 of the name of the tax object type, a space, and its unique identifier ( e.g.
652 'cust_main_county 23' ). The values of the hash are listrefs. The first
653 item in the list is the tax object. The remaining items are either line
654 items or floating point values (currency amounts).
656 The taxes are calculated on this entity. Calculated exemption records are
657 transferred to the LINEITEMREF items on the assumption that they are related.
663 This specifies the date appearing on the associated invoice. Some
664 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
670 sub calculate_taxes {
671 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
673 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
675 warn "$me calculate_taxes\n"
676 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
679 my @tax_line_items = ();
681 # keys are tax names (as printed on invoices / itemdesc )
682 # values are listrefs of taxlisthash keys (internal identifiers)
685 # keys are taxlisthash keys (internal identifiers)
686 # values are (cumulative) amounts
689 # keys are taxlisthash keys (internal identifiers)
690 # values are listrefs of cust_bill_pkg_tax_location hashrefs
691 my %tax_location = ();
693 # keys are taxlisthash keys (internal identifiers)
694 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
695 my %tax_rate_location = ();
697 foreach my $tax ( keys %$taxlisthash ) {
698 my $tax_object = shift @{ $taxlisthash->{$tax} };
699 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
700 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
701 my $hashref_or_error =
702 $tax_object->taxline( $taxlisthash->{$tax},
703 'custnum' => $self->custnum,
704 'invoice_time' => $invoice_time
706 return $hashref_or_error unless ref($hashref_or_error);
708 unshift @{ $taxlisthash->{$tax} }, $tax_object;
710 my $name = $hashref_or_error->{'name'};
711 my $amount = $hashref_or_error->{'amount'};
713 #warn "adding $amount as $name\n";
714 $taxname{ $name } ||= [];
715 push @{ $taxname{ $name } }, $tax;
717 $tax{ $tax } += $amount;
719 $tax_location{ $tax } ||= [];
720 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
721 push @{ $tax_location{ $tax } },
723 'taxnum' => $tax_object->taxnum,
724 'taxtype' => ref($tax_object),
725 'pkgnum' => $tax_object->get('pkgnum'),
726 'locationnum' => $tax_object->get('locationnum'),
727 'amount' => sprintf('%.2f', $amount ),
731 $tax_rate_location{ $tax } ||= [];
732 if ( ref($tax_object) eq 'FS::tax_rate' ) {
733 my $taxratelocationnum =
734 $tax_object->tax_rate_location->taxratelocationnum;
735 push @{ $tax_rate_location{ $tax } },
737 'taxnum' => $tax_object->taxnum,
738 'taxtype' => ref($tax_object),
739 'amount' => sprintf('%.2f', $amount ),
740 'locationtaxid' => $tax_object->location,
741 'taxratelocationnum' => $taxratelocationnum,
747 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
748 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
749 foreach my $tax ( keys %$taxlisthash ) {
750 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
751 next unless ref($_) eq 'FS::cust_bill_pkg';
753 my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
755 next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
756 die "can't distribute tax exemptions: no line item for ". Dumper($_).
757 " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
758 unless $packagemap{$_->pkgnum};
760 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
761 @cust_tax_exempt_pkg;
765 #consolidate and create tax line items
766 warn "consolidating and generating...\n" if $DEBUG > 2;
767 foreach my $taxname ( keys %taxname ) {
770 my @cust_bill_pkg_tax_location = ();
771 my @cust_bill_pkg_tax_rate_location = ();
772 warn "adding $taxname\n" if $DEBUG > 1;
773 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
774 next if $seen{$taxitem}++;
775 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
776 $tax += $tax{$taxitem};
777 push @cust_bill_pkg_tax_location,
778 map { new FS::cust_bill_pkg_tax_location $_ }
779 @{ $tax_location{ $taxitem } };
780 push @cust_bill_pkg_tax_rate_location,
781 map { new FS::cust_bill_pkg_tax_rate_location $_ }
782 @{ $tax_rate_location{ $taxitem } };
786 $tax = sprintf('%.2f', $tax );
788 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
794 if ( $pkg_category and
795 $conf->config('invoice_latexsummary') ||
796 $conf->config('invoice_htmlsummary')
800 my %hash = ( 'section' => $pkg_category->categoryname );
801 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
805 push @tax_line_items, new FS::cust_bill_pkg {
811 'itemdesc' => $taxname,
812 'display' => \@display,
813 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
814 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
823 my ($self, %params) = @_;
825 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
827 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
828 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
829 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
830 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
831 my $total_setup = $params{setup} or die "no setup accumulator specified";
832 my $total_recur = $params{recur} or die "no recur accumulator specified";
833 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
834 my $time = $params{'time'} or die "no time specified";
835 my (%options) = %{$params{options}};
838 my $real_pkgpart = $params{real_pkgpart};
839 my %hash = $cust_pkg->hash;
840 my $old_cust_pkg = new FS::cust_pkg \%hash;
846 $cust_pkg->pkgpart($part_pkg->pkgpart);
854 my %setup_param = ();
855 if ( ! $options{recurring_only}
856 and ! $options{cancel}
857 and ( $options{'resetup'}
858 || ( ! $cust_pkg->setup
859 && ( ! $cust_pkg->start_date
860 || $cust_pkg->start_date <= $self->day_end($time)
862 && ( ! $conf->exists('disable_setup_suspended_pkgs')
863 || ( $conf->exists('disable_setup_suspended_pkgs') &&
864 ! $cust_pkg->getfield('susp')
872 warn " bill setup\n" if $DEBUG > 1;
874 unless ( $cust_pkg->waive_setup ) {
877 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
878 return "$@ running calc_setup for $cust_pkg\n"
881 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
884 $cust_pkg->setfield('setup', $time)
885 unless $cust_pkg->setup;
886 #do need it, but it won't get written to the db
887 #|| $cust_pkg->pkgpart != $real_pkgpart;
889 $cust_pkg->setfield('start_date', '')
890 if $cust_pkg->start_date;
898 #XXX unit stuff here too
902 if ( ! $cust_pkg->start_date
903 and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
905 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $self->day_end($time) )
906 || ( $part_pkg->plan eq 'voip_cdr'
907 && $part_pkg->option('bill_every_call')
912 # XXX should this be a package event? probably. events are called
913 # at collection time at the moment, though...
914 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
915 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
916 #don't want to reset usage just cause we want a line item??
917 #&& $part_pkg->pkgpart == $real_pkgpart;
919 warn " bill recur\n" if $DEBUG > 1;
922 # XXX shared with $recur_prog
923 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
927 #over two params! lets at least switch to a hashref for the rest...
928 my $increment_next_bill = ( $part_pkg->freq ne '0'
929 && ( $cust_pkg->getfield('bill') || 0 ) <= $self->day_end($time)
932 my %param = ( 'precommit_hooks' => $precommit_hooks,
933 'increment_next_bill' => $increment_next_bill,
934 'discounts' => \@discounts,
935 'real_pkgpart' => $real_pkgpart,
936 'freq_override' => $options{freq_override} || '',
941 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
943 # There may be some part_pkg for which this is wrong. Only those
944 # which can_discount are supported.
945 # (the UI should prevent adding discounts to these at the moment)
947 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
948 " for pkgpart ". $cust_pkg->pkgpart.
949 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
952 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
953 return "$@ running $method for $cust_pkg\n"
956 if ( $increment_next_bill ) {
958 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
959 return "unparsable frequency: ". $part_pkg->freq
962 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
963 # only for figuring next bill date, nothing else, so, reset $sdate again
965 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
966 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
967 $cust_pkg->last_bill($sdate);
969 $cust_pkg->setfield('bill', $next_bill );
973 if ( $param{'setup_fee'} ) {
974 # Add an additional setup fee at the billing stage.
975 # Used for prorate_defer_bill.
976 $setup += $param{'setup_fee'};
977 $unitsetup += $param{'setup_fee'};
981 if ( defined $param{'discount_left_setup'} ) {
982 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
983 $setup -= $discount_setup;
989 warn "\$setup is undefined" unless defined($setup);
990 warn "\$recur is undefined" unless defined($recur);
991 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
994 # If there's line items, create em cust_bill_pkg records
995 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1000 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1001 # hmm.. and if just the options are modified in some weird price plan?
1003 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1006 my $error = $cust_pkg->replace( $old_cust_pkg,
1007 'depend_jobnum'=>$options{depend_jobnum},
1008 'options' => { $cust_pkg->options },
1010 unless $options{no_commit};
1011 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1012 if $error; #just in case
1015 $setup = sprintf( "%.2f", $setup );
1016 $recur = sprintf( "%.2f", $recur );
1017 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1018 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1020 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1021 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1024 my $discount_show_always = ($recur == 0 && scalar(@discounts)
1025 && $conf->exists('discount-show-always'));
1029 (!$part_pkg->hidden && $options{has_hidden}) || #include some $0 lines
1030 $discount_show_always )
1033 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1036 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1038 warn " adding customer package invoice detail: $_\n"
1039 foreach @cust_pkg_detail;
1041 push @details, @cust_pkg_detail;
1043 my $cust_bill_pkg = new FS::cust_bill_pkg {
1044 'pkgnum' => $cust_pkg->pkgnum,
1046 'unitsetup' => $unitsetup,
1048 'unitrecur' => $unitrecur,
1049 'quantity' => $cust_pkg->quantity,
1050 'details' => \@details,
1051 'discounts' => \@discounts,
1052 'hidden' => $part_pkg->hidden,
1053 'freq' => $part_pkg->freq,
1056 if ( $part_pkg->recur_temporality eq 'preceding' ) {
1057 $cust_bill_pkg->sdate( $hash{last_bill} );
1058 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1059 $cust_bill_pkg->edate( $time ) if $options{cancel};
1060 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1061 $cust_bill_pkg->sdate( $sdate );
1062 $cust_bill_pkg->edate( $cust_pkg->bill );
1063 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1066 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1067 unless $part_pkg->pkgpart == $real_pkgpart;
1069 $$total_setup += $setup;
1070 $$total_recur += $recur;
1076 unless ( $discount_show_always ) {
1078 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1079 return $error if $error;
1082 push @$cust_bill_pkgs, $cust_bill_pkg;
1084 } #if $setup != 0 || $recur != 0
1094 my $part_pkg = shift;
1095 my $taxlisthash = shift;
1096 my $cust_bill_pkg = shift;
1097 my $cust_pkg = shift;
1098 my $invoice_time = shift;
1099 my $real_pkgpart = shift;
1100 my $options = shift;
1102 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1104 my %cust_bill_pkg = ();
1108 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1109 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1110 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1111 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1113 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1115 if ( $conf->exists('enable_taxproducts')
1116 && ( scalar($part_pkg->part_pkg_taxoverride)
1117 || $part_pkg->has_taxproduct
1122 foreach my $class (@classes) {
1123 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1124 return $err_or_ref unless ref($err_or_ref);
1125 $taxes{$class} = $err_or_ref;
1128 unless (exists $taxes{''}) {
1129 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1130 return $err_or_ref unless ref($err_or_ref);
1131 $taxes{''} = $err_or_ref;
1136 my @loc_keys = qw( city county state country );
1138 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1139 my $cust_location = $cust_pkg->cust_location;
1140 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1143 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1146 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1149 $taxhash{'taxclass'} = $part_pkg->taxclass;
1152 my %taxhash_elim = %taxhash;
1153 my @elim = qw( city county state );
1156 #first try a match with taxclass
1157 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1159 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1160 #then try a match without taxclass
1161 my %no_taxclass = %taxhash_elim;
1162 $no_taxclass{ 'taxclass' } = '';
1163 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1166 $taxhash_elim{ shift(@elim) } = '';
1168 } while ( !scalar(@taxes) && scalar(@elim) );
1170 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1172 if $self->cust_main_exemption; #just to be safe
1174 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1176 $_->set('pkgnum', $cust_pkg->pkgnum );
1177 $_->set('locationnum', $cust_pkg->locationnum );
1181 $taxes{''} = [ @taxes ];
1182 $taxes{'setup'} = [ @taxes ];
1183 $taxes{'recur'} = [ @taxes ];
1184 $taxes{$_} = [ @taxes ] foreach (@classes);
1186 # # maybe eliminate this entirely, along with all the 0% records
1187 # unless ( @taxes ) {
1189 # "fatal: can't find tax rate for state/county/country/taxclass ".
1190 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1193 } #if $conf->exists('enable_taxproducts') ...
1198 my $separate = $conf->exists('separate_usage');
1199 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1200 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1201 my $section = $temp_pkg->part_pkg->categoryname;
1202 if ( $separate || $section || $usage_mandate ) {
1204 my %hash = ( 'section' => $section );
1206 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1207 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1209 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1210 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1212 push @display, new FS::cust_bill_pkg_display
1215 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1219 if ($separate && $section && $summary) {
1220 push @display, new FS::cust_bill_pkg_display { type => 'U',
1225 if ($usage_mandate || $section && $summary) {
1226 $hash{post_total} = 'Y';
1229 if ($separate || $usage_mandate) {
1230 $hash{section} = $section if ($separate || $usage_mandate);
1231 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1235 $cust_bill_pkg->set('display', \@display);
1237 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1238 foreach my $key (keys %tax_cust_bill_pkg) {
1239 my @taxes = @{ $taxes{$key} || [] };
1240 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1242 my %localtaxlisthash = ();
1243 foreach my $tax ( @taxes ) {
1245 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1246 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1247 # ' locationnum'. $cust_pkg->locationnum
1248 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1250 $taxlisthash->{ $taxname } ||= [ $tax ];
1251 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1253 $localtaxlisthash{ $taxname } ||= [ $tax ];
1254 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1258 warn "finding taxed taxes...\n" if $DEBUG > 2;
1259 foreach my $tax ( keys %localtaxlisthash ) {
1260 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1261 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1263 next unless $tax_object->can('tax_on_tax');
1265 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1266 my $totname = ref( $tot ). ' '. $tot->taxnum;
1268 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1270 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1272 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1273 my $hashref_or_error =
1274 $tax_object->taxline( $localtaxlisthash{$tax},
1275 'custnum' => $self->custnum,
1276 'invoice_time' => $invoice_time,
1278 return $hashref_or_error
1279 unless ref($hashref_or_error);
1281 $taxlisthash->{ $totname } ||= [ $tot ];
1282 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1294 my $part_pkg = shift;
1296 my $cust_pkg = shift;
1298 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1301 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1302 $geocode = $cust_pkg->cust_location->geocode('cch');
1304 $geocode = $self->geocode('cch');
1309 my @taxclassnums = map { $_->taxclassnum }
1310 $part_pkg->part_pkg_taxoverride($class);
1312 unless (@taxclassnums) {
1313 @taxclassnums = map { $_->taxclassnum }
1314 grep { $_->taxable eq 'Y' }
1315 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1317 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1322 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1324 @taxes = qsearch({ 'table' => 'tax_rate',
1325 'hashref' => { 'geocode' => $geocode, },
1326 'extra_sql' => $extra_sql,
1328 if scalar(@taxclassnums);
1330 warn "Found taxes ".
1331 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1338 =item collect [ HASHREF | OPTION => VALUE ... ]
1340 (Attempt to) collect money for this customer's outstanding invoices (see
1341 L<FS::cust_bill>). Usually used after the bill method.
1343 Actions are now triggered by billing events; see L<FS::part_event> and the
1344 billing events web interface. Old-style invoice events (see
1345 L<FS::part_bill_event>) have been deprecated.
1347 If there is an error, returns the error, otherwise returns false.
1349 Options are passed as name-value pairs.
1351 Currently available options are:
1357 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.
1361 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1365 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1369 set true to surpress email card/ACH decline notices.
1373 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)
1379 # allows for one time override of normal customer billing method
1384 my( $self, %options ) = @_;
1386 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1388 my $invoice_time = $options{'invoice_time'} || time;
1391 local $SIG{HUP} = 'IGNORE';
1392 local $SIG{INT} = 'IGNORE';
1393 local $SIG{QUIT} = 'IGNORE';
1394 local $SIG{TERM} = 'IGNORE';
1395 local $SIG{TSTP} = 'IGNORE';
1396 local $SIG{PIPE} = 'IGNORE';
1398 my $oldAutoCommit = $FS::UID::AutoCommit;
1399 local $FS::UID::AutoCommit = 0;
1402 $self->select_for_update; #mutex
1405 my $balance = $self->balance;
1406 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1409 if ( exists($options{'retry_card'}) ) {
1410 carp 'retry_card option passed to collect is deprecated; use retry';
1411 $options{'retry'} ||= $options{'retry_card'};
1413 if ( exists($options{'retry'}) && $options{'retry'} ) {
1414 my $error = $self->retry_realtime;
1416 $dbh->rollback if $oldAutoCommit;
1421 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1423 #never want to roll back an event just because it returned an error
1424 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1426 $self->do_cust_event(
1427 'debug' => ( $options{'debug'} || 0 ),
1428 'time' => $invoice_time,
1429 'check_freq' => $options{'check_freq'},
1430 'stage' => 'collect',
1435 =item retry_realtime
1437 Schedules realtime / batch credit card / electronic check / LEC billing
1438 events for for retry. Useful if card information has changed or manual
1439 retry is desired. The 'collect' method must be called to actually retry
1442 Implementation details: For either this customer, or for each of this
1443 customer's open invoices, changes the status of the first "done" (with
1444 statustext error) realtime processing event to "failed".
1448 sub retry_realtime {
1451 local $SIG{HUP} = 'IGNORE';
1452 local $SIG{INT} = 'IGNORE';
1453 local $SIG{QUIT} = 'IGNORE';
1454 local $SIG{TERM} = 'IGNORE';
1455 local $SIG{TSTP} = 'IGNORE';
1456 local $SIG{PIPE} = 'IGNORE';
1458 my $oldAutoCommit = $FS::UID::AutoCommit;
1459 local $FS::UID::AutoCommit = 0;
1462 #a little false laziness w/due_cust_event (not too bad, really)
1464 my $join = FS::part_event_condition->join_conditions_sql;
1465 my $order = FS::part_event_condition->order_conditions_sql;
1468 . join ( ' OR ' , map {
1469 "( part_event.eventtable = " . dbh->quote($_)
1470 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1471 } FS::part_event->eventtables)
1474 #here is the agent virtualization
1475 my $agent_virt = " ( part_event.agentnum IS NULL
1476 OR part_event.agentnum = ". $self->agentnum. ' )';
1478 #XXX this shouldn't be hardcoded, actions should declare it...
1479 my @realtime_events = qw(
1480 cust_bill_realtime_card
1481 cust_bill_realtime_check
1482 cust_bill_realtime_lec
1486 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1491 my @cust_event = qsearchs({
1492 'table' => 'cust_event',
1493 'select' => 'cust_event.*',
1494 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1495 'hashref' => { 'status' => 'done' },
1496 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1497 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1500 my %seen_invnum = ();
1501 foreach my $cust_event (@cust_event) {
1503 #max one for the customer, one for each open invoice
1504 my $cust_X = $cust_event->cust_X;
1505 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1509 or $cust_event->part_event->eventtable eq 'cust_bill'
1512 my $error = $cust_event->retry;
1514 $dbh->rollback if $oldAutoCommit;
1515 return "error scheduling event for retry: $error";
1520 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1525 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1527 Runs billing events; see L<FS::part_event> and the billing events web
1530 If there is an error, returns the error, otherwise returns false.
1532 Options are passed as name-value pairs.
1534 Currently available options are:
1540 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.
1544 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1548 "collect" (the default) or "pre-bill"
1552 set true to surpress email card/ACH decline notices.
1556 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)
1563 # allows for one time override of normal customer billing method
1567 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1570 my( $self, %options ) = @_;
1572 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1574 my $time = $options{'time'} || time;
1577 local $SIG{HUP} = 'IGNORE';
1578 local $SIG{INT} = 'IGNORE';
1579 local $SIG{QUIT} = 'IGNORE';
1580 local $SIG{TERM} = 'IGNORE';
1581 local $SIG{TSTP} = 'IGNORE';
1582 local $SIG{PIPE} = 'IGNORE';
1584 my $oldAutoCommit = $FS::UID::AutoCommit;
1585 local $FS::UID::AutoCommit = 0;
1588 $self->select_for_update; #mutex
1591 my $balance = $self->balance;
1592 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1595 # if ( exists($options{'retry_card'}) ) {
1596 # carp 'retry_card option passed to collect is deprecated; use retry';
1597 # $options{'retry'} ||= $options{'retry_card'};
1599 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1600 # my $error = $self->retry_realtime;
1602 # $dbh->rollback if $oldAutoCommit;
1607 # false laziness w/pay_batch::import_results
1609 my $due_cust_event = $self->due_cust_event(
1610 'debug' => ( $options{'debug'} || 0 ),
1612 'check_freq' => $options{'check_freq'},
1613 'stage' => ( $options{'stage'} || 'collect' ),
1615 unless( ref($due_cust_event) ) {
1616 $dbh->rollback if $oldAutoCommit;
1617 return $due_cust_event;
1620 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1621 #never want to roll back an event just because it or a different one
1623 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1625 foreach my $cust_event ( @$due_cust_event ) {
1629 #re-eval event conditions (a previous event could have changed things)
1630 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1631 #don't leave stray "new/locked" records around
1632 my $error = $cust_event->delete;
1633 return $error if $error;
1638 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1639 if $options{'quiet'};
1640 warn " running cust_event ". $cust_event->eventnum. "\n"
1643 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1644 if ( my $error = $cust_event->do_event() ) {
1645 #XXX wtf is this? figure out a proper dealio with return value
1657 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1659 Inserts database records for and returns an ordered listref of new events due
1660 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1661 events are due, an empty listref is returned. If there is an error, returns a
1662 scalar error message.
1664 To actually run the events, call each event's test_condition method, and if
1665 still true, call the event's do_event method.
1667 Options are passed as a hashref or as a list of name-value pairs. Available
1674 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.
1678 "collect" (the default) or "pre-bill"
1682 "Current time" for the events.
1686 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)
1690 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1694 Explicitly pass the objects to be tested (typically used with eventtable).
1698 Set to true to return the objects, but not actually insert them into the
1705 sub due_cust_event {
1707 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1710 #my $DEBUG = $opt{'debug'}
1711 local($DEBUG) = $opt{'debug'}
1712 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1713 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1715 warn "$me due_cust_event called with options ".
1716 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1719 $opt{'time'} ||= time;
1721 local $SIG{HUP} = 'IGNORE';
1722 local $SIG{INT} = 'IGNORE';
1723 local $SIG{QUIT} = 'IGNORE';
1724 local $SIG{TERM} = 'IGNORE';
1725 local $SIG{TSTP} = 'IGNORE';
1726 local $SIG{PIPE} = 'IGNORE';
1728 my $oldAutoCommit = $FS::UID::AutoCommit;
1729 local $FS::UID::AutoCommit = 0;
1732 $self->select_for_update #mutex
1733 unless $opt{testonly};
1736 # find possible events (initial search)
1739 my @cust_event = ();
1741 my @eventtable = $opt{'eventtable'}
1742 ? ( $opt{'eventtable'} )
1743 : FS::part_event->eventtables_runorder;
1745 my $check_freq = $opt{'check_freq'} || '1d';
1747 foreach my $eventtable ( @eventtable ) {
1750 if ( $opt{'objects'} ) {
1752 @objects = @{ $opt{'objects'} };
1756 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1757 if ( $eventtable eq 'cust_main' ) {
1758 @objects = ( $self );
1762 "LEFT JOIN cust_main USING ( custnum )";
1764 #some false laziness w/Cron::bill bill_where
1766 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1767 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1768 'time'=>$opt{'time'},
1770 $where = $where ? "AND $where" : '';
1772 my $are_part_event =
1773 "EXISTS ( SELECT 1 FROM part_event $join
1774 WHERE check_freq = '$check_freq'
1775 AND eventtable = '$eventtable'
1776 AND ( disabled = '' OR disabled IS NULL )
1782 @objects = $self->$eventtable(
1783 'addl_from' => $cm_join,
1784 'extra_sql' => " AND $are_part_event",
1790 my @e_cust_event = ();
1792 my $cross = "CROSS JOIN $eventtable";
1793 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1794 unless $eventtable eq 'cust_main';
1796 foreach my $object ( @objects ) {
1798 #this first search uses the condition_sql magic for optimization.
1799 #the more possible events we can eliminate in this step the better
1801 my $cross_where = '';
1802 my $pkey = $object->primary_key;
1803 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1805 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1807 FS::part_event_condition->where_conditions_sql( $eventtable,
1808 'time'=>$opt{'time'}
1810 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1812 $extra_sql = "AND $extra_sql" if $extra_sql;
1814 #here is the agent virtualization
1815 $extra_sql .= " AND ( part_event.agentnum IS NULL
1816 OR part_event.agentnum = ". $self->agentnum. ' )';
1818 $extra_sql .= " $order";
1820 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1821 if $opt{'debug'} > 2;
1822 my @part_event = qsearch( {
1823 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1824 'select' => 'part_event.*',
1825 'table' => 'part_event',
1826 'addl_from' => "$cross $join",
1827 'hashref' => { 'check_freq' => $check_freq,
1828 'eventtable' => $eventtable,
1831 'extra_sql' => "AND $cross_where $extra_sql",
1835 my $pkey = $object->primary_key;
1836 warn " ". scalar(@part_event).
1837 " possible events found for $eventtable ". $object->$pkey(). "\n";
1840 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1844 warn " ". scalar(@e_cust_event).
1845 " subtotal possible cust events found for $eventtable\n"
1848 push @cust_event, @e_cust_event;
1852 warn " ". scalar(@cust_event).
1853 " total possible cust events found in initial search\n"
1861 $opt{stage} ||= 'collect';
1863 grep { my $stage = $_->part_event->event_stage;
1864 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1874 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1875 'stats_hashref' => \%unsat ),
1878 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1881 warn " invalid conditions not eliminated with condition_sql:\n".
1882 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1883 if keys %unsat && $DEBUG; # > 1;
1889 unless( $opt{testonly} ) {
1890 foreach my $cust_event ( @cust_event ) {
1892 my $error = $cust_event->insert();
1894 $dbh->rollback if $oldAutoCommit;
1901 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1907 warn " returning events: ". Dumper(@cust_event). "\n"
1914 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1916 Applies unapplied payments and credits.
1918 In most cases, this new method should be used in place of sequential
1919 apply_payments and apply_credits methods.
1921 A hash of optional arguments may be passed. Currently "manual" is supported.
1922 If true, a payment receipt is sent instead of a statement when
1923 'payment_receipt_email' configuration option is set.
1925 If there is an error, returns the error, otherwise returns false.
1929 sub apply_payments_and_credits {
1930 my( $self, %options ) = @_;
1932 local $SIG{HUP} = 'IGNORE';
1933 local $SIG{INT} = 'IGNORE';
1934 local $SIG{QUIT} = 'IGNORE';
1935 local $SIG{TERM} = 'IGNORE';
1936 local $SIG{TSTP} = 'IGNORE';
1937 local $SIG{PIPE} = 'IGNORE';
1939 my $oldAutoCommit = $FS::UID::AutoCommit;
1940 local $FS::UID::AutoCommit = 0;
1943 $self->select_for_update; #mutex
1945 foreach my $cust_bill ( $self->open_cust_bill ) {
1946 my $error = $cust_bill->apply_payments_and_credits(%options);
1948 $dbh->rollback if $oldAutoCommit;
1949 return "Error applying: $error";
1953 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1958 =item apply_credits OPTION => VALUE ...
1960 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1961 to outstanding invoice balances in chronological order (or reverse
1962 chronological order if the I<order> option is set to B<newest>) and returns the
1963 value of any remaining unapplied credits available for refund (see
1964 L<FS::cust_refund>).
1966 Dies if there is an error.
1974 local $SIG{HUP} = 'IGNORE';
1975 local $SIG{INT} = 'IGNORE';
1976 local $SIG{QUIT} = 'IGNORE';
1977 local $SIG{TERM} = 'IGNORE';
1978 local $SIG{TSTP} = 'IGNORE';
1979 local $SIG{PIPE} = 'IGNORE';
1981 my $oldAutoCommit = $FS::UID::AutoCommit;
1982 local $FS::UID::AutoCommit = 0;
1985 $self->select_for_update; #mutex
1987 unless ( $self->total_unapplied_credits ) {
1988 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1992 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1993 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1995 my @invoices = $self->open_cust_bill;
1996 @invoices = sort { $b->_date <=> $a->_date } @invoices
1997 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1999 if ( $conf->exists('pkg-balances') ) {
2000 # limit @credits to those w/ a pkgnum grepped from $self
2002 foreach my $i (@invoices) {
2003 foreach my $li ( $i->cust_bill_pkg ) {
2004 $pkgnums{$li->pkgnum} = 1;
2007 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2012 foreach my $cust_bill ( @invoices ) {
2014 if ( !defined($credit) || $credit->credited == 0) {
2015 $credit = pop @credits or last;
2019 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2020 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2022 $owed = $cust_bill->owed;
2024 unless ( $owed > 0 ) {
2025 push @credits, $credit;
2029 my $amount = min( $credit->credited, $owed );
2031 my $cust_credit_bill = new FS::cust_credit_bill ( {
2032 'crednum' => $credit->crednum,
2033 'invnum' => $cust_bill->invnum,
2034 'amount' => $amount,
2036 $cust_credit_bill->pkgnum( $credit->pkgnum )
2037 if $conf->exists('pkg-balances') && $credit->pkgnum;
2038 my $error = $cust_credit_bill->insert;
2040 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2044 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2048 my $total_unapplied_credits = $self->total_unapplied_credits;
2050 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2052 return $total_unapplied_credits;
2055 =item apply_payments [ OPTION => VALUE ... ]
2057 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2058 to outstanding invoice balances in chronological order.
2060 #and returns the value of any remaining unapplied payments.
2062 A hash of optional arguments may be passed. Currently "manual" is supported.
2063 If true, a payment receipt is sent instead of a statement when
2064 'payment_receipt_email' configuration option is set.
2066 Dies if there is an error.
2070 sub apply_payments {
2071 my( $self, %options ) = @_;
2073 local $SIG{HUP} = 'IGNORE';
2074 local $SIG{INT} = 'IGNORE';
2075 local $SIG{QUIT} = 'IGNORE';
2076 local $SIG{TERM} = 'IGNORE';
2077 local $SIG{TSTP} = 'IGNORE';
2078 local $SIG{PIPE} = 'IGNORE';
2080 my $oldAutoCommit = $FS::UID::AutoCommit;
2081 local $FS::UID::AutoCommit = 0;
2084 $self->select_for_update; #mutex
2088 my @payments = sort { $b->_date <=> $a->_date }
2089 grep { $_->unapplied > 0 }
2092 my @invoices = sort { $a->_date <=> $b->_date}
2093 grep { $_->owed > 0 }
2096 if ( $conf->exists('pkg-balances') ) {
2097 # limit @payments to those w/ a pkgnum grepped from $self
2099 foreach my $i (@invoices) {
2100 foreach my $li ( $i->cust_bill_pkg ) {
2101 $pkgnums{$li->pkgnum} = 1;
2104 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2109 foreach my $cust_bill ( @invoices ) {
2111 if ( !defined($payment) || $payment->unapplied == 0 ) {
2112 $payment = pop @payments or last;
2116 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2117 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2119 $owed = $cust_bill->owed;
2121 unless ( $owed > 0 ) {
2122 push @payments, $payment;
2126 my $amount = min( $payment->unapplied, $owed );
2128 my $cust_bill_pay = new FS::cust_bill_pay ( {
2129 'paynum' => $payment->paynum,
2130 'invnum' => $cust_bill->invnum,
2131 'amount' => $amount,
2133 $cust_bill_pay->pkgnum( $payment->pkgnum )
2134 if $conf->exists('pkg-balances') && $payment->pkgnum;
2135 my $error = $cust_bill_pay->insert(%options);
2137 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2141 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2145 my $total_unapplied_payments = $self->total_unapplied_payments;
2147 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2149 return $total_unapplied_payments;
2159 suspend_adjourned_pkgs
2162 (do_cust_event pre-bill)
2165 (vendor-only) _gather_taxes
2166 _omit_zero_value_bundles
2169 apply_payments_and_credits
2178 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>