1 package FS::cust_main::Billing;
4 use vars qw( $conf $DEBUG $me );
7 use List::Util qw( min );
9 use FS::Record qw( qsearch qsearchs dbdef );
10 use FS::Misc::DateTime qw( day_end );
12 use FS::cust_bill_pkg;
13 use FS::cust_bill_pkg_display;
14 use FS::cust_bill_pay;
15 use FS::cust_credit_bill;
16 use FS::cust_tax_adjustment;
18 use FS::tax_rate_location;
19 use FS::cust_bill_pkg_tax_location;
20 use FS::cust_bill_pkg_tax_rate_location;
22 use FS::part_event_condition;
26 # 1 is mostly method/subroutine entry and options
27 # 2 traces progress of some operations
28 # 3 is even more information including possibly sensitive data
30 $me = '[FS::cust_main::Billing]';
32 install_callback FS::UID sub {
34 #yes, need it for stuff below (prolly should be cached)
39 FS::cust_main::Billing - Billing mixin for cust_main
45 These methods are available on FS::cust_main objects.
51 =item bill_and_collect
53 Cancels and suspends any packages due, generates bills, applies payments and
54 credits, and applies collection events to run cards, send bills and notices,
57 By default, warns on errors and continues with the next operation (but see the
60 Options are passed as name-value pairs. Currently available options are:
66 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
70 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
74 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
78 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
82 If set true, re-charges setup fees.
86 If set any errors prevent subsequent operations from continusing. If set
87 specifically to "return", returns the error (or false, if there is no error).
88 Any other true value causes errors to die.
92 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
96 Optional FS::queue entry to receive status updates.
100 Options are passed to the B<bill> and B<collect> methods verbatim, so all
101 options of those methods are also available.
105 sub bill_and_collect {
106 my( $self, %options ) = @_;
108 my $log = FS::Log->new('bill_and_collect');
109 $log->debug('start', object => $self, agentnum => $self->agentnum);
113 #$options{actual_time} not $options{time} because freeside-daily -d is for
114 #pre-printing invoices
116 $options{'actual_time'} ||= time;
117 my $job = $options{'job'};
119 $job->update_statustext('0,cleaning expired packages') if $job;
120 $error = $self->cancel_expired_pkgs( day_end( $options{actual_time} ) );
122 $error = "Error expiring custnum ". $self->custnum. ": $error";
123 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
124 elsif ( $options{fatal} ) { die $error; }
125 else { warn $error; }
128 $error = $self->suspend_adjourned_pkgs( day_end( $options{actual_time} ) );
130 $error = "Error adjourning custnum ". $self->custnum. ": $error";
131 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
132 elsif ( $options{fatal} ) { die $error; }
133 else { warn $error; }
136 $error = $self->unsuspend_resumed_pkgs( day_end( $options{actual_time} ) );
138 $error = "Error resuming custnum ".$self->custnum. ": $error";
139 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
140 elsif ( $options{fatal} ) { die $error; }
141 else { warn $error; }
144 $job->update_statustext('20,billing packages') if $job;
145 $error = $self->bill( %options );
147 $error = "Error billing custnum ". $self->custnum. ": $error";
148 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
149 elsif ( $options{fatal} ) { die $error; }
150 else { warn $error; }
153 $job->update_statustext('50,applying payments and credits') if $job;
154 $error = $self->apply_payments_and_credits;
156 $error = "Error applying 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('70,running collection events') if $job;
163 unless ( $conf->exists('cancelled_cust-noevents')
164 && ! $self->num_ncancelled_pkgs
166 $error = $self->collect( %options );
168 $error = "Error collecting custnum ". $self->custnum. ": $error";
169 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
170 elsif ($options{fatal} ) { die $error; }
171 else { warn $error; }
174 $job->update_statustext('100,finished') if $job;
175 $log->debug('finish', object => $self, agentnum => $self->agentnum);
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,
198 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
201 join(' / ', @errors);
205 sub suspend_adjourned_pkgs {
206 my ( $self, $time, %options ) = @_;
208 my @susp_pkgs = $self->ncancelled_pkgs( {
210 " AND ( susp IS NULL OR susp = 0 )
211 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
212 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
217 #only because there's no SQL test for is_prepaid :/
219 grep { ( $_->part_pkg->is_prepaid
224 && $_->adjourn <= $time
232 foreach my $cust_pkg ( @susp_pkgs ) {
233 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
234 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
235 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
236 'reason_otaker' => $cpr->otaker
240 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
243 join(' / ', @errors);
247 sub unsuspend_resumed_pkgs {
248 my ( $self, $time, %options ) = @_;
250 my @unsusp_pkgs = $self->ncancelled_pkgs( {
251 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
256 foreach my $cust_pkg ( @unsusp_pkgs ) {
257 my $error = $cust_pkg->unsuspend( 'time' => $time );
258 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
261 join(' / ', @errors);
267 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
268 conjunction with the collect method by calling B<bill_and_collect>.
270 If there is an error, returns the error, otherwise returns false.
272 Options are passed as name-value pairs. Currently available options are:
278 If set true, re-charges setup fees.
282 If set true then only bill recurring charges, not setup, usage, one time
287 If set, then override the normal frequency and look for a part_pkg_discount
288 to take at that frequency. This is appropriate only when the normal
289 frequency for all packages is monthly, and is an error otherwise. Use
290 C<pkg_list> to limit the set of packages included in billing.
294 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:
298 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
302 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
304 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
308 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
312 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.
316 This boolean value informs the us that the package is being cancelled. This
317 typically might mean not charging the normal recurring fee but only usage
318 fees since the last billing. Setup charges may be charged. Not all package
319 plans support this feature (they tend to charge 0).
323 Prevent the resetting of usage limits during this call.
327 Do not save the generated bill in the database. Useful with return_bill
331 A list reference on which the generated bill(s) will be returned.
335 Optional terms to be printed on this invoice. Otherwise, customer-specific
336 terms or the default terms are used.
343 my( $self, %options ) = @_;
345 return '' if $self->payby eq 'COMP';
347 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
349 warn "$me bill customer ". $self->custnum. "\n"
352 my $time = $options{'time'} || time;
353 my $invoice_time = $options{'invoice_time'} || $time;
355 $options{'not_pkgpart'} ||= {};
356 $options{'not_pkgpart'} = { map { $_ => 1 }
357 split(/\s*,\s*/, $options{'not_pkgpart'})
359 unless ref($options{'not_pkgpart'});
361 local $SIG{HUP} = 'IGNORE';
362 local $SIG{INT} = 'IGNORE';
363 local $SIG{QUIT} = 'IGNORE';
364 local $SIG{TERM} = 'IGNORE';
365 local $SIG{TSTP} = 'IGNORE';
366 local $SIG{PIPE} = 'IGNORE';
368 my $oldAutoCommit = $FS::UID::AutoCommit;
369 local $FS::UID::AutoCommit = 0;
372 warn "$me acquiring lock on customer ". $self->custnum. "\n"
375 $self->select_for_update; #mutex
377 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
380 my $error = $self->do_cust_event(
381 'debug' => ( $options{'debug'} || 0 ),
382 'time' => $invoice_time,
383 'check_freq' => $options{'check_freq'},
384 'stage' => 'pre-bill',
386 unless $options{no_commit};
388 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
392 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
395 #keep auto-charge and non-auto-charge line items separate
396 my @passes = ( '', 'no_auto' );
398 my %cust_bill_pkg = map { $_ => [] } @passes;
401 # find the packages which are due for billing, find out how much they are
402 # & generate invoice database.
405 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
406 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
408 my %taxlisthash = map { $_ => {} } @passes;
410 my @precommit_hooks = ();
412 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
413 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
415 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
417 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
419 #? to avoid use of uninitialized value errors... ?
420 $cust_pkg->setfield('bill', '')
421 unless defined($cust_pkg->bill);
423 #my $part_pkg = $cust_pkg->part_pkg;
425 my $real_pkgpart = $cust_pkg->pkgpart;
426 my %hash = $cust_pkg->hash;
428 # we could implement this bit as FS::part_pkg::has_hidden, but we already
429 # suffer from performance issues
430 $options{has_hidden} = 0;
431 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
432 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
434 foreach my $part_pkg ( @part_pkg ) {
436 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
438 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
440 my $next_bill = $cust_pkg->getfield('bill') || 0;
442 # let this run once if this is the last bill upon cancellation
443 while ( $next_bill <= $time or $options{cancel} ) {
445 $self->_make_lines( 'part_pkg' => $part_pkg,
446 'cust_pkg' => $cust_pkg,
447 'precommit_hooks' => \@precommit_hooks,
448 'line_items' => $cust_bill_pkg{$pass},
449 'setup' => $total_setup{$pass},
450 'recur' => $total_recur{$pass},
451 'tax_matrix' => $taxlisthash{$pass},
453 'real_pkgpart' => $real_pkgpart,
454 'options' => \%options,
457 # Stop if anything goes wrong
460 # or if we're not incrementing the bill date.
461 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
463 # or if we're letting it run only once
464 last if $options{cancel};
466 $next_bill = $cust_pkg->getfield('bill') || 0;
468 #stop if -o was passed to freeside-daily
469 last if $options{'one_recur'};
472 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
476 } #foreach my $part_pkg
478 } #foreach my $cust_pkg
480 #if the customer isn't on an automatic payby, everything can go on a single
482 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
483 #merge everything into one list
486 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
488 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
490 next unless @cust_bill_pkg; #don't create an invoice w/o line items
492 warn "$me billing pass $pass\n"
493 #.Dumper(\@cust_bill_pkg)."\n"
496 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
497 !$conf->exists('postal_invoice-recurring_only')
501 my $postal_pkg = $self->charge_postal_fee();
502 if ( $postal_pkg && !ref( $postal_pkg ) ) {
504 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
505 return "can't charge postal invoice fee for customer ".
506 $self->custnum. ": $postal_pkg";
508 } elsif ( $postal_pkg ) {
510 my $real_pkgpart = $postal_pkg->pkgpart;
511 # we could implement this bit as FS::part_pkg::has_hidden, but we already
512 # suffer from performance issues
513 $options{has_hidden} = 0;
514 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
515 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
517 foreach my $part_pkg ( @part_pkg ) {
518 my %postal_options = %options;
519 delete $postal_options{cancel};
521 $self->_make_lines( 'part_pkg' => $part_pkg,
522 'cust_pkg' => $postal_pkg,
523 'precommit_hooks' => \@precommit_hooks,
524 'line_items' => \@cust_bill_pkg,
525 'setup' => $total_setup{$pass},
526 'recur' => $total_recur{$pass},
527 'tax_matrix' => $taxlisthash{$pass},
529 'real_pkgpart' => $real_pkgpart,
530 'options' => \%postal_options,
533 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
538 # it's silly to have a zero value postal_pkg, but....
539 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
545 my $listref_or_error =
546 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
548 unless ( ref( $listref_or_error ) ) {
549 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
550 return $listref_or_error;
553 foreach my $taxline ( @$listref_or_error ) {
554 ${ $total_setup{$pass} } =
555 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
556 push @cust_bill_pkg, $taxline;
560 warn "adding tax adjustments...\n" if $DEBUG > 2;
561 foreach my $cust_tax_adjustment (
562 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
568 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
570 my $itemdesc = $cust_tax_adjustment->taxname;
571 $itemdesc = '' if $itemdesc eq 'Tax';
573 push @cust_bill_pkg, new FS::cust_bill_pkg {
579 'itemdesc' => $itemdesc,
580 'itemcomment' => $cust_tax_adjustment->comment,
581 'cust_tax_adjustment' => $cust_tax_adjustment,
582 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
587 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
589 my @cust_bill = $self->cust_bill;
590 my $balance = $self->balance;
591 my $previous_balance = scalar(@cust_bill)
592 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
595 $previous_balance += $cust_bill[$#cust_bill]->charged
596 if scalar(@cust_bill);
597 #my $balance_adjustments =
598 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
600 warn "creating the new invoice\n" if $DEBUG;
601 #create the new invoice
602 my $cust_bill = new FS::cust_bill ( {
603 'custnum' => $self->custnum,
604 '_date' => $invoice_time,
605 'charged' => $charged,
606 'billing_balance' => $balance,
607 'previous_balance' => $previous_balance,
608 'invoice_terms' => $options{'invoice_terms'},
609 'cust_bill_pkg' => \@cust_bill_pkg,
611 $error = $cust_bill->insert unless $options{no_commit};
613 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
614 return "can't create invoice for customer #". $self->custnum. ": $error";
616 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
618 } #foreach my $pass ( keys %cust_bill_pkg )
620 foreach my $hook ( @precommit_hooks ) {
623 } unless $options{no_commit};
625 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
626 return "$@ running precommit hook $hook\n";
630 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
635 #discard bundled packages of 0 value
636 sub _omit_zero_value_bundles {
639 my @cust_bill_pkg = ();
640 my @cust_bill_pkg_bundle = ();
642 my $discount_show_always = 0;
644 foreach my $cust_bill_pkg ( @in ) {
646 $discount_show_always = ($cust_bill_pkg->get('discounts')
647 && scalar(@{$cust_bill_pkg->get('discounts')})
648 && $conf->exists('discount-show-always'));
650 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
651 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
652 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
655 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
656 push @cust_bill_pkg, @cust_bill_pkg_bundle
658 || ($sum == 0 && ( $discount_show_always
659 || grep {$_->recur_show_zero || $_->setup_show_zero}
660 @cust_bill_pkg_bundle
663 @cust_bill_pkg_bundle = ();
667 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
668 push @cust_bill_pkg_bundle, $cust_bill_pkg;
672 push @cust_bill_pkg, @cust_bill_pkg_bundle
674 || ($sum == 0 && ( $discount_show_always
675 || grep {$_->recur_show_zero || $_->setup_show_zero}
676 @cust_bill_pkg_bundle
680 warn " _omit_zero_value_bundles: ". scalar(@in).
681 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
688 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
690 This is a weird one. Perhaps it should not even be exposed.
692 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
693 Usually used internally by bill method B<bill>.
695 If there is an error, returns the error, otherwise returns reference to a
696 list of line items suitable for insertion.
702 An array ref of the line items being billed.
706 A strange beast. The keys to this hash are internal identifiers consisting
707 of the name of the tax object type, a space, and its unique identifier ( e.g.
708 'cust_main_county 23' ). The values of the hash are listrefs. The first
709 item in the list is the tax object. The remaining items are either line
710 items or floating point values (currency amounts).
712 The taxes are calculated on this entity. Calculated exemption records are
713 transferred to the LINEITEMREF items on the assumption that they are related.
719 This specifies the date appearing on the associated invoice. Some
720 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
726 sub calculate_taxes {
727 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
729 # $taxlisthash is a hashref
730 # keys are identifiers, values are arrayrefs
731 # each arrayref starts with a tax object (cust_main_county or tax_rate)
732 # then any cust_bill_pkg objects the tax applies to
734 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
736 warn "$me calculate_taxes\n"
737 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
740 my @tax_line_items = ();
742 # keys are tax names (as printed on invoices / itemdesc )
743 # values are arrayrefs of taxlisthash keys (internal identifiers)
746 # keys are taxlisthash keys (internal identifiers)
747 # values are (cumulative) amounts
750 # keys are taxlisthash keys (internal identifiers)
751 # values are arrayrefs of cust_bill_pkg_tax_location hashrefs
752 my %tax_location = ();
754 # keys are taxlisthash keys (internal identifiers)
755 # values are arrayrefs of cust_bill_pkg_tax_rate_location hashrefs
756 my %tax_rate_location = ();
758 # keys are taxnums (not internal identifiers!)
759 # values are arrayrefs of cust_tax_exempt_pkg objects
762 foreach my $tax ( keys %$taxlisthash ) {
763 # $tax is a tax identifier
764 my $tax_object = shift @{ $taxlisthash->{$tax} };
765 # $tax_object is a cust_main_county or tax_rate
766 # (with pkgnum and locationnum set)
767 # the rest of @{ $taxlisthash->{$tax} } is cust_bill_pkg objects
768 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
769 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
770 # taxline calculates the tax on all cust_bill_pkgs in the
771 # first (arrayref) argument, and returns a hashref of 'name'
772 # (the line item description) and 'amount'.
773 # It also calculates exemptions and attaches them to the cust_bill_pkgs
775 my $taxables = $taxlisthash->{$tax};
776 my $exemptions = $tax_exemption{$tax_object->taxnum} ||= [];
777 my $hashref_or_error =
778 $tax_object->taxline( $taxables,
779 'custnum' => $self->custnum,
780 'invoice_time' => $invoice_time,
781 'exemptions' => $exemptions,
783 return $hashref_or_error unless ref($hashref_or_error);
785 # then collect any new exemptions generated for this tax
786 push @$exemptions, @{ $_->cust_tax_exempt_pkg }
789 unshift @{ $taxlisthash->{$tax} }, $tax_object;
791 my $name = $hashref_or_error->{'name'};
792 my $amount = $hashref_or_error->{'amount'};
794 #warn "adding $amount as $name\n";
795 $taxname{ $name } ||= [];
796 push @{ $taxname{ $name } }, $tax;
798 $tax_amount{ $tax } += $amount;
800 # link records between cust_main_county/tax_rate and cust_location
801 $tax_location{ $tax } ||= [];
802 $tax_rate_location{ $tax } ||= [];
803 if ( ref($tax_object) eq 'FS::cust_main_county' ) {
804 push @{ $tax_location{ $tax } },
806 'taxnum' => $tax_object->taxnum,
807 'taxtype' => ref($tax_object),
808 'pkgnum' => $tax_object->get('pkgnum'),
809 'locationnum' => $tax_object->get('locationnum'),
810 'amount' => sprintf('%.2f', $amount ),
813 elsif ( ref($tax_object) eq 'FS::tax_rate' ) {
814 my $taxratelocationnum =
815 $tax_object->tax_rate_location->taxratelocationnum;
816 push @{ $tax_rate_location{ $tax } },
818 'taxnum' => $tax_object->taxnum,
819 'taxtype' => ref($tax_object),
820 'amount' => sprintf('%.2f', $amount ),
821 'locationtaxid' => $tax_object->location,
822 'taxratelocationnum' => $taxratelocationnum,
828 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
829 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
830 foreach my $tax ( keys %$taxlisthash ) {
831 my $taxables = $taxlisthash->{$tax};
832 my $tax_object = shift @$taxables; # the rest are line items
833 foreach my $cust_bill_pkg ( @$taxables ) {
834 next unless ref($cust_bill_pkg) eq 'FS::cust_bill_pkg';
836 my @cust_tax_exempt_pkg = splice @{ $cust_bill_pkg->cust_tax_exempt_pkg };
838 next unless @cust_tax_exempt_pkg;
839 # get the non-disintegrated version
840 my $real_cust_bill_pkg = $packagemap{$cust_bill_pkg->pkgnum}
841 or die "can't distribute tax exemptions: no line item for ".
842 Dumper($_). " in packagemap ".
843 join(',', sort {$a<=>$b} keys %packagemap). "\n";
845 push @{ $real_cust_bill_pkg->cust_tax_exempt_pkg },
846 @cust_tax_exempt_pkg;
850 #consolidate and create tax line items
851 warn "consolidating and generating...\n" if $DEBUG > 2;
852 foreach my $taxname ( keys %taxname ) {
855 my @cust_bill_pkg_tax_location = ();
856 my @cust_bill_pkg_tax_rate_location = ();
857 warn "adding $taxname\n" if $DEBUG > 1;
858 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
859 next if $seen{$taxitem}++;
860 warn "adding $tax_amount{$taxitem}\n" if $DEBUG > 1;
861 $tax_total += $tax_amount{$taxitem};
862 push @cust_bill_pkg_tax_location,
863 map { new FS::cust_bill_pkg_tax_location $_ }
864 @{ $tax_location{ $taxitem } };
865 push @cust_bill_pkg_tax_rate_location,
866 map { new FS::cust_bill_pkg_tax_rate_location $_ }
867 @{ $tax_rate_location{ $taxitem } };
869 next unless $tax_total;
871 $tax_total = sprintf('%.2f', $tax_total );
873 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
879 if ( $pkg_category and
880 $conf->config('invoice_latexsummary') ||
881 $conf->config('invoice_htmlsummary')
885 my %hash = ( 'section' => $pkg_category->categoryname );
886 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
890 push @tax_line_items, new FS::cust_bill_pkg {
892 'setup' => $tax_total,
896 'itemdesc' => $taxname,
897 'display' => \@display,
898 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
899 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
908 my ($self, %params) = @_;
910 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
912 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
913 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
914 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
915 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
916 my $total_setup = $params{setup} or die "no setup accumulator specified";
917 my $total_recur = $params{recur} or die "no recur accumulator specified";
918 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
919 my $time = $params{'time'} or die "no time specified";
920 my (%options) = %{$params{options}};
922 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
923 # this should never happen
924 die 'freq_override billing attempted on non-monthly package '.
929 my $real_pkgpart = $params{real_pkgpart};
930 my %hash = $cust_pkg->hash;
931 my $old_cust_pkg = new FS::cust_pkg \%hash;
936 $cust_pkg->pkgpart($part_pkg->pkgpart);
944 my @setup_discounts = ();
945 my %setup_param = ( 'discounts' => \@setup_discounts );
946 if ( ! $options{recurring_only}
947 and ! $options{cancel}
948 and ( $options{'resetup'}
949 || ( ! $cust_pkg->setup
950 && ( ! $cust_pkg->start_date
951 || $cust_pkg->start_date <= day_end($time)
953 && ( ! $conf->exists('disable_setup_suspended_pkgs')
954 || ( $conf->exists('disable_setup_suspended_pkgs') &&
955 ! $cust_pkg->getfield('susp')
963 warn " bill setup\n" if $DEBUG > 1;
965 unless ( $cust_pkg->waive_setup ) {
968 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
969 return "$@ running calc_setup for $cust_pkg\n"
972 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
975 $cust_pkg->setfield('setup', $time)
976 unless $cust_pkg->setup;
977 #do need it, but it won't get written to the db
978 #|| $cust_pkg->pkgpart != $real_pkgpart;
980 $cust_pkg->setfield('start_date', '')
981 if $cust_pkg->start_date;
991 my @recur_discounts = ();
993 if ( ! $cust_pkg->start_date
994 and ( ! $cust_pkg->susp || $cust_pkg->option('suspend_bill',1)
995 || ( $part_pkg->option('suspend_bill', 1) )
996 && ! $cust_pkg->option('no_suspend_bill',1)
999 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= day_end($time) )
1000 || ( $part_pkg->plan eq 'voip_cdr'
1001 && $part_pkg->option('bill_every_call')
1006 # XXX should this be a package event? probably. events are called
1007 # at collection time at the moment, though...
1008 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1009 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1010 #don't want to reset usage just cause we want a line item??
1011 #&& $part_pkg->pkgpart == $real_pkgpart;
1013 warn " bill recur\n" if $DEBUG > 1;
1016 # XXX shared with $recur_prog
1017 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1021 #over two params! lets at least switch to a hashref for the rest...
1022 my $increment_next_bill = ( $part_pkg->freq ne '0'
1023 && ( $cust_pkg->getfield('bill') || 0 ) <= day_end($time)
1024 && !$options{cancel}
1026 my %param = ( %setup_param,
1027 'precommit_hooks' => $precommit_hooks,
1028 'increment_next_bill' => $increment_next_bill,
1029 'discounts' => \@recur_discounts,
1030 'real_pkgpart' => $real_pkgpart,
1031 'freq_override' => $options{freq_override} || '',
1035 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1037 # There may be some part_pkg for which this is wrong. Only those
1038 # which can_discount are supported.
1039 # (the UI should prevent adding discounts to these at the moment)
1041 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1042 " for pkgpart ". $cust_pkg->pkgpart.
1043 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1046 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1047 return "$@ running $method for $cust_pkg\n"
1051 $unitrecur = $cust_pkg->part_pkg->base_recur || $recur; #XXX uuh
1053 if ( $increment_next_bill ) {
1055 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1056 return "unparsable frequency: ". $part_pkg->freq
1057 if $next_bill == -1;
1059 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1060 # only for figuring next bill date, nothing else, so, reset $sdate again
1062 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1063 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1064 $cust_pkg->last_bill($sdate);
1066 $cust_pkg->setfield('bill', $next_bill );
1070 if ( $param{'setup_fee'} ) {
1071 # Add an additional setup fee at the billing stage.
1072 # Used for prorate_defer_bill.
1073 $setup += $param{'setup_fee'};
1074 $unitsetup += $param{'setup_fee'};
1078 if ( defined $param{'discount_left_setup'} ) {
1079 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1080 $setup -= $discount_setup;
1086 warn "\$setup is undefined" unless defined($setup);
1087 warn "\$recur is undefined" unless defined($recur);
1088 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1091 # If there's line items, create em cust_bill_pkg records
1092 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1097 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1098 # hmm.. and if just the options are modified in some weird price plan?
1100 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1103 my $error = $cust_pkg->replace( $old_cust_pkg,
1104 'depend_jobnum'=>$options{depend_jobnum},
1105 'options' => { $cust_pkg->options },
1107 unless $options{no_commit};
1108 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1109 if $error; #just in case
1112 $setup = sprintf( "%.2f", $setup );
1113 $recur = sprintf( "%.2f", $recur );
1114 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1115 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1117 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1118 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1121 my $discount_show_always = $conf->exists('discount-show-always')
1122 && ( ($setup == 0 && scalar(@setup_discounts))
1123 || ($recur == 0 && scalar(@recur_discounts))
1128 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1129 || $discount_show_always
1130 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1131 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1135 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1138 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1140 warn " adding customer package invoice detail: $_\n"
1141 foreach @cust_pkg_detail;
1143 push @details, @cust_pkg_detail;
1145 my $cust_bill_pkg = new FS::cust_bill_pkg {
1146 'pkgnum' => $cust_pkg->pkgnum,
1148 'unitsetup' => $unitsetup,
1150 'unitrecur' => $unitrecur,
1151 'quantity' => $cust_pkg->quantity,
1152 'details' => \@details,
1153 'discounts' => [ @setup_discounts, @recur_discounts ],
1154 'hidden' => $part_pkg->hidden,
1155 'freq' => $part_pkg->freq,
1158 if ( $part_pkg->option('prorate_defer_bill',1)
1159 and !$hash{last_bill} ) {
1160 # both preceding and upcoming, technically
1161 $cust_bill_pkg->sdate( $cust_pkg->setup );
1162 $cust_bill_pkg->edate( $cust_pkg->bill );
1163 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1164 $cust_bill_pkg->sdate( $hash{last_bill} );
1165 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1166 $cust_bill_pkg->edate( $time ) if $options{cancel};
1167 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1168 $cust_bill_pkg->sdate( $sdate );
1169 $cust_bill_pkg->edate( $cust_pkg->bill );
1170 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1173 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1174 unless $part_pkg->pkgpart == $real_pkgpart;
1176 $$total_setup += $setup;
1177 $$total_recur += $recur;
1183 unless ( $discount_show_always ) {
1185 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1186 return $error if $error;
1189 push @$cust_bill_pkgs, $cust_bill_pkg;
1191 } #if $setup != 0 || $recur != 0
1201 my $part_pkg = shift;
1202 my $taxlisthash = shift;
1203 my $cust_bill_pkg = shift;
1204 my $cust_pkg = shift;
1205 my $invoice_time = shift;
1206 my $real_pkgpart = shift;
1207 my $options = shift;
1209 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1211 my %cust_bill_pkg = ();
1215 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1216 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1217 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1218 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1220 my $exempt = $conf->exists('cust_class-tax_exempt')
1221 ? ( $self->cust_class ? $self->cust_class->tax : '' )
1223 # standardize this just to be sure
1224 $exempt = ($exempt eq 'Y') ? 'Y' : '';
1226 #if ( $exempt !~ /Y/i && $self->payby ne 'COMP' ) {
1227 if ( $self->payby ne 'COMP' ) {
1229 if ( $conf->exists('enable_taxproducts')
1230 && ( scalar($part_pkg->part_pkg_taxoverride)
1231 || $part_pkg->has_taxproduct
1238 foreach my $class (@classes) {
1239 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1240 return $err_or_ref unless ref($err_or_ref);
1241 $taxes{$class} = $err_or_ref;
1244 unless (exists $taxes{''}) {
1245 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1246 return $err_or_ref unless ref($err_or_ref);
1247 $taxes{''} = $err_or_ref;
1252 } else { # cust_main_county tax system
1254 # We fetch taxes even if the customer is completely exempt,
1255 # because we need to record that fact.
1257 my @loc_keys = qw( district city county state country );
1258 my $location = $cust_pkg->tax_location;
1259 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1261 $taxhash{'taxclass'} = $part_pkg->taxclass;
1263 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1265 my @taxes = (); # entries are cust_main_county objects
1266 my %taxhash_elim = %taxhash;
1267 my @elim = qw( district city county state );
1270 #first try a match with taxclass
1271 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1273 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1274 #then try a match without taxclass
1275 my %no_taxclass = %taxhash_elim;
1276 $no_taxclass{ 'taxclass' } = '';
1277 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1280 $taxhash_elim{ shift(@elim) } = '';
1282 } while ( !scalar(@taxes) && scalar(@elim) );
1285 # These could become cust_bill_pkg_tax_location records,
1286 # or cust_tax_exempt_pkg. We'll decide later.
1287 $_->set('pkgnum', $cust_pkg->pkgnum);
1288 $_->set('locationnum', $cust_pkg->tax_locationnum);
1291 $taxes{''} = [ @taxes ];
1292 $taxes{'setup'} = [ @taxes ];
1293 $taxes{'recur'} = [ @taxes ];
1294 $taxes{$_} = [ @taxes ] foreach (@classes);
1296 # # maybe eliminate this entirely, along with all the 0% records
1297 # unless ( @taxes ) {
1299 # "fatal: can't find tax rate for state/county/country/taxclass ".
1300 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1303 } #if $conf->exists('enable_taxproducts') ...
1305 } # if $self->payby eq 'COMP'
1307 #what's this doing in the middle of _handle_taxes? probably should split
1308 #this into three parts above in _make_lines
1309 $cust_bill_pkg->set_display( part_pkg => $part_pkg,
1310 real_pkgpart => $real_pkgpart,
1313 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1314 foreach my $key (keys %tax_cust_bill_pkg) {
1315 # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1316 # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1318 # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1319 # apply to $key-class charges.
1320 my @taxes = @{ $taxes{$key} || [] };
1321 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1323 my %localtaxlisthash = ();
1324 foreach my $tax ( @taxes ) {
1326 # this is the tax identifier, not the taxname
1327 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1328 $taxname .= ' pkgnum'. $cust_pkg->pkgnum;
1329 # We need to create a separate $taxlisthash entry for each pkgnum
1330 # on the invoice, so that cust_bill_pkg_tax_location records will
1331 # be linked correctly.
1333 # $taxlisthash: keys are "setup", "recur", and usage classes.
1334 # Values are arrayrefs, first the tax object (cust_main_county
1335 # or tax_rate) and then any cust_bill_pkg objects that the
1337 $taxlisthash->{ $taxname } ||= [ $tax ];
1338 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1340 $localtaxlisthash{ $taxname } ||= [ $tax ];
1341 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1345 warn "finding taxed taxes...\n" if $DEBUG > 2;
1346 foreach my $tax ( keys %localtaxlisthash ) {
1347 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1348 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1350 next unless $tax_object->can('tax_on_tax');
1352 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1353 my $totname = ref( $tot ). ' '. $tot->taxnum;
1355 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1357 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1359 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1360 my $hashref_or_error =
1361 $tax_object->taxline( $localtaxlisthash{$tax},
1362 'custnum' => $self->custnum,
1363 'invoice_time' => $invoice_time,
1365 return $hashref_or_error
1366 unless ref($hashref_or_error);
1368 $taxlisthash->{ $totname } ||= [ $tot ];
1369 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1381 my $part_pkg = shift;
1383 my $cust_pkg = shift;
1385 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1388 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1389 $geocode = $cust_pkg->cust_location->geocode('cch');
1391 $geocode = $self->geocode('cch');
1396 my @taxclassnums = map { $_->taxclassnum }
1397 $part_pkg->part_pkg_taxoverride($class);
1399 unless (@taxclassnums) {
1400 @taxclassnums = map { $_->taxclassnum }
1401 grep { $_->taxable eq 'Y' }
1402 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1404 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1409 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1411 @taxes = qsearch({ 'table' => 'tax_rate',
1412 'hashref' => { 'geocode' => $geocode, },
1413 'extra_sql' => $extra_sql,
1415 if scalar(@taxclassnums);
1417 warn "Found taxes ".
1418 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1425 =item collect [ HASHREF | OPTION => VALUE ... ]
1427 (Attempt to) collect money for this customer's outstanding invoices (see
1428 L<FS::cust_bill>). Usually used after the bill method.
1430 Actions are now triggered by billing events; see L<FS::part_event> and the
1431 billing events web interface. Old-style invoice events (see
1432 L<FS::part_bill_event>) have been deprecated.
1434 If there is an error, returns the error, otherwise returns false.
1436 Options are passed as name-value pairs.
1438 Currently available options are:
1444 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.
1448 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1452 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1456 set true to surpress email card/ACH decline notices.
1460 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)
1466 # allows for one time override of normal customer billing method
1471 my( $self, %options ) = @_;
1473 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1475 my $invoice_time = $options{'invoice_time'} || time;
1478 local $SIG{HUP} = 'IGNORE';
1479 local $SIG{INT} = 'IGNORE';
1480 local $SIG{QUIT} = 'IGNORE';
1481 local $SIG{TERM} = 'IGNORE';
1482 local $SIG{TSTP} = 'IGNORE';
1483 local $SIG{PIPE} = 'IGNORE';
1485 my $oldAutoCommit = $FS::UID::AutoCommit;
1486 local $FS::UID::AutoCommit = 0;
1489 $self->select_for_update; #mutex
1492 my $balance = $self->balance;
1493 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1496 if ( exists($options{'retry_card'}) ) {
1497 carp 'retry_card option passed to collect is deprecated; use retry';
1498 $options{'retry'} ||= $options{'retry_card'};
1500 if ( exists($options{'retry'}) && $options{'retry'} ) {
1501 my $error = $self->retry_realtime;
1503 $dbh->rollback if $oldAutoCommit;
1508 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1510 #never want to roll back an event just because it returned an error
1511 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1513 $self->do_cust_event(
1514 'debug' => ( $options{'debug'} || 0 ),
1515 'time' => $invoice_time,
1516 'check_freq' => $options{'check_freq'},
1517 'stage' => 'collect',
1522 =item retry_realtime
1524 Schedules realtime / batch credit card / electronic check / LEC billing
1525 events for for retry. Useful if card information has changed or manual
1526 retry is desired. The 'collect' method must be called to actually retry
1529 Implementation details: For either this customer, or for each of this
1530 customer's open invoices, changes the status of the first "done" (with
1531 statustext error) realtime processing event to "failed".
1535 sub retry_realtime {
1538 local $SIG{HUP} = 'IGNORE';
1539 local $SIG{INT} = 'IGNORE';
1540 local $SIG{QUIT} = 'IGNORE';
1541 local $SIG{TERM} = 'IGNORE';
1542 local $SIG{TSTP} = 'IGNORE';
1543 local $SIG{PIPE} = 'IGNORE';
1545 my $oldAutoCommit = $FS::UID::AutoCommit;
1546 local $FS::UID::AutoCommit = 0;
1549 #a little false laziness w/due_cust_event (not too bad, really)
1551 my $join = FS::part_event_condition->join_conditions_sql;
1552 my $order = FS::part_event_condition->order_conditions_sql;
1555 . join ( ' OR ' , map {
1556 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1557 my $custnum = FS::part_event->eventtables_custnum->{$_};
1558 "( part_event.eventtable = " . dbh->quote($_)
1559 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1560 . " from $_ $cust_join"
1561 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1562 } FS::part_event->eventtables)
1565 #here is the agent virtualization
1566 my $agent_virt = " ( part_event.agentnum IS NULL
1567 OR part_event.agentnum = ". $self->agentnum. ' )';
1569 #XXX this shouldn't be hardcoded, actions should declare it...
1570 my @realtime_events = qw(
1571 cust_bill_realtime_card
1572 cust_bill_realtime_check
1573 cust_bill_realtime_lec
1577 my $is_realtime_event =
1578 ' part_event.action IN ( '.
1579 join(',', map "'$_'", @realtime_events ).
1582 my $batch_or_statustext =
1583 "( part_event.action = 'cust_bill_batch'
1584 OR ( statustext IS NOT NULL AND statustext != '' )
1588 my @cust_event = qsearch({
1589 'table' => 'cust_event',
1590 'select' => 'cust_event.*',
1591 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1592 'hashref' => { 'status' => 'done' },
1593 'extra_sql' => " AND $batch_or_statustext ".
1594 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1597 my %seen_invnum = ();
1598 foreach my $cust_event (@cust_event) {
1600 #max one for the customer, one for each open invoice
1601 my $cust_X = $cust_event->cust_X;
1602 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1606 or $cust_event->part_event->eventtable eq 'cust_bill'
1609 my $error = $cust_event->retry;
1611 $dbh->rollback if $oldAutoCommit;
1612 return "error scheduling event for retry: $error";
1617 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1622 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1624 Runs billing events; see L<FS::part_event> and the billing events web
1627 If there is an error, returns the error, otherwise returns false.
1629 Options are passed as name-value pairs.
1631 Currently available options are:
1637 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.
1641 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1645 "collect" (the default) or "pre-bill"
1649 set true to surpress email card/ACH decline notices.
1653 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)
1660 # allows for one time override of normal customer billing method
1664 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1667 my( $self, %options ) = @_;
1669 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1671 my $time = $options{'time'} || time;
1674 local $SIG{HUP} = 'IGNORE';
1675 local $SIG{INT} = 'IGNORE';
1676 local $SIG{QUIT} = 'IGNORE';
1677 local $SIG{TERM} = 'IGNORE';
1678 local $SIG{TSTP} = 'IGNORE';
1679 local $SIG{PIPE} = 'IGNORE';
1681 my $oldAutoCommit = $FS::UID::AutoCommit;
1682 local $FS::UID::AutoCommit = 0;
1685 $self->select_for_update; #mutex
1688 my $balance = $self->balance;
1689 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1692 # if ( exists($options{'retry_card'}) ) {
1693 # carp 'retry_card option passed to collect is deprecated; use retry';
1694 # $options{'retry'} ||= $options{'retry_card'};
1696 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1697 # my $error = $self->retry_realtime;
1699 # $dbh->rollback if $oldAutoCommit;
1704 # false laziness w/pay_batch::import_results
1706 my $due_cust_event = $self->due_cust_event(
1707 'debug' => ( $options{'debug'} || 0 ),
1709 'check_freq' => $options{'check_freq'},
1710 'stage' => ( $options{'stage'} || 'collect' ),
1712 unless( ref($due_cust_event) ) {
1713 $dbh->rollback if $oldAutoCommit;
1714 return $due_cust_event;
1717 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1718 #never want to roll back an event just because it or a different one
1720 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1722 foreach my $cust_event ( @$due_cust_event ) {
1726 #re-eval event conditions (a previous event could have changed things)
1727 unless ( $cust_event->test_conditions ) {
1728 #don't leave stray "new/locked" records around
1729 my $error = $cust_event->delete;
1730 return $error if $error;
1735 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1736 if $options{'quiet'};
1737 warn " running cust_event ". $cust_event->eventnum. "\n"
1740 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1741 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1742 #XXX wtf is this? figure out a proper dealio with return value
1754 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1756 Inserts database records for and returns an ordered listref of new events due
1757 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1758 events are due, an empty listref is returned. If there is an error, returns a
1759 scalar error message.
1761 To actually run the events, call each event's test_condition method, and if
1762 still true, call the event's do_event method.
1764 Options are passed as a hashref or as a list of name-value pairs. Available
1771 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.
1775 "collect" (the default) or "pre-bill"
1779 "Current time" for the events.
1783 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)
1787 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1791 Explicitly pass the objects to be tested (typically used with eventtable).
1795 Set to true to return the objects, but not actually insert them into the
1802 sub due_cust_event {
1804 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1807 #my $DEBUG = $opt{'debug'}
1808 local($DEBUG) = $opt{'debug'}
1809 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1810 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1812 warn "$me due_cust_event called with options ".
1813 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1816 $opt{'time'} ||= time;
1818 local $SIG{HUP} = 'IGNORE';
1819 local $SIG{INT} = 'IGNORE';
1820 local $SIG{QUIT} = 'IGNORE';
1821 local $SIG{TERM} = 'IGNORE';
1822 local $SIG{TSTP} = 'IGNORE';
1823 local $SIG{PIPE} = 'IGNORE';
1825 my $oldAutoCommit = $FS::UID::AutoCommit;
1826 local $FS::UID::AutoCommit = 0;
1829 $self->select_for_update #mutex
1830 unless $opt{testonly};
1833 # find possible events (initial search)
1836 my @cust_event = ();
1838 my @eventtable = $opt{'eventtable'}
1839 ? ( $opt{'eventtable'} )
1840 : FS::part_event->eventtables_runorder;
1842 my $check_freq = $opt{'check_freq'} || '1d';
1844 foreach my $eventtable ( @eventtable ) {
1847 if ( $opt{'objects'} ) {
1849 @objects = @{ $opt{'objects'} };
1851 } elsif ( $eventtable eq 'cust_main' ) {
1853 @objects = ( $self );
1857 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
1858 # linkage not needed here because FS::cust_main->$eventtable will
1861 #some false laziness w/Cron::bill bill_where
1863 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1864 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1865 'time'=>$opt{'time'},
1867 $where = $where ? "AND $where" : '';
1869 my $are_part_event =
1870 "EXISTS ( SELECT 1 FROM part_event $join
1871 WHERE check_freq = '$check_freq'
1872 AND eventtable = '$eventtable'
1873 AND ( disabled = '' OR disabled IS NULL )
1879 @objects = $self->$eventtable(
1880 'addl_from' => $cm_join,
1881 'extra_sql' => " AND $are_part_event",
1883 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
1885 my @e_cust_event = ();
1887 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
1889 my $cross = "CROSS JOIN $eventtable $linkage";
1890 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1891 unless $eventtable eq 'cust_main';
1893 foreach my $object ( @objects ) {
1895 #this first search uses the condition_sql magic for optimization.
1896 #the more possible events we can eliminate in this step the better
1898 my $cross_where = '';
1899 my $pkey = $object->primary_key;
1900 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1902 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1904 FS::part_event_condition->where_conditions_sql( $eventtable,
1905 'time'=>$opt{'time'}
1907 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1909 $extra_sql = "AND $extra_sql" if $extra_sql;
1911 #here is the agent virtualization
1912 $extra_sql .= " AND ( part_event.agentnum IS NULL
1913 OR part_event.agentnum = ". $self->agentnum. ' )';
1915 $extra_sql .= " $order";
1917 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1918 if $opt{'debug'} > 2;
1919 my @part_event = qsearch( {
1920 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1921 'select' => 'part_event.*',
1922 'table' => 'part_event',
1923 'addl_from' => "$cross $join",
1924 'hashref' => { 'check_freq' => $check_freq,
1925 'eventtable' => $eventtable,
1928 'extra_sql' => "AND $cross_where $extra_sql",
1932 my $pkey = $object->primary_key;
1933 warn " ". scalar(@part_event).
1934 " possible events found for $eventtable ". $object->$pkey(). "\n";
1937 push @e_cust_event, map {
1938 $_->new_cust_event($object, 'time' => $opt{'time'})
1943 warn " ". scalar(@e_cust_event).
1944 " subtotal possible cust events found for $eventtable\n"
1947 push @cust_event, @e_cust_event;
1951 warn " ". scalar(@cust_event).
1952 " total possible cust events found in initial search\n"
1960 $opt{stage} ||= 'collect';
1962 grep { my $stage = $_->part_event->event_stage;
1963 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1973 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
1976 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1979 warn " invalid conditions not eliminated with condition_sql:\n".
1980 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1981 if keys %unsat && $DEBUG; # > 1;
1987 unless( $opt{testonly} ) {
1988 foreach my $cust_event ( @cust_event ) {
1990 my $error = $cust_event->insert();
1992 $dbh->rollback if $oldAutoCommit;
1999 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2005 warn " returning events: ". Dumper(@cust_event). "\n"
2012 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2014 Applies unapplied payments and credits.
2016 In most cases, this new method should be used in place of sequential
2017 apply_payments and apply_credits methods.
2019 A hash of optional arguments may be passed. Currently "manual" is supported.
2020 If true, a payment receipt is sent instead of a statement when
2021 'payment_receipt_email' configuration option is set.
2023 If there is an error, returns the error, otherwise returns false.
2027 sub apply_payments_and_credits {
2028 my( $self, %options ) = @_;
2030 local $SIG{HUP} = 'IGNORE';
2031 local $SIG{INT} = 'IGNORE';
2032 local $SIG{QUIT} = 'IGNORE';
2033 local $SIG{TERM} = 'IGNORE';
2034 local $SIG{TSTP} = 'IGNORE';
2035 local $SIG{PIPE} = 'IGNORE';
2037 my $oldAutoCommit = $FS::UID::AutoCommit;
2038 local $FS::UID::AutoCommit = 0;
2041 $self->select_for_update; #mutex
2043 foreach my $cust_bill ( $self->open_cust_bill ) {
2044 my $error = $cust_bill->apply_payments_and_credits(%options);
2046 $dbh->rollback if $oldAutoCommit;
2047 return "Error applying: $error";
2051 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2056 =item apply_credits OPTION => VALUE ...
2058 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2059 to outstanding invoice balances in chronological order (or reverse
2060 chronological order if the I<order> option is set to B<newest>) and returns the
2061 value of any remaining unapplied credits available for refund (see
2062 L<FS::cust_refund>).
2064 Dies if there is an error.
2072 local $SIG{HUP} = 'IGNORE';
2073 local $SIG{INT} = 'IGNORE';
2074 local $SIG{QUIT} = 'IGNORE';
2075 local $SIG{TERM} = 'IGNORE';
2076 local $SIG{TSTP} = 'IGNORE';
2077 local $SIG{PIPE} = 'IGNORE';
2079 my $oldAutoCommit = $FS::UID::AutoCommit;
2080 local $FS::UID::AutoCommit = 0;
2083 $self->select_for_update; #mutex
2085 unless ( $self->total_unapplied_credits ) {
2086 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2090 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2091 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2093 my @invoices = $self->open_cust_bill;
2094 @invoices = sort { $b->_date <=> $a->_date } @invoices
2095 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2097 if ( $conf->exists('pkg-balances') ) {
2098 # limit @credits to those w/ a pkgnum grepped from $self
2100 foreach my $i (@invoices) {
2101 foreach my $li ( $i->cust_bill_pkg ) {
2102 $pkgnums{$li->pkgnum} = 1;
2105 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2110 foreach my $cust_bill ( @invoices ) {
2112 if ( !defined($credit) || $credit->credited == 0) {
2113 $credit = pop @credits or last;
2117 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2118 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2120 $owed = $cust_bill->owed;
2122 unless ( $owed > 0 ) {
2123 push @credits, $credit;
2127 my $amount = min( $credit->credited, $owed );
2129 my $cust_credit_bill = new FS::cust_credit_bill ( {
2130 'crednum' => $credit->crednum,
2131 'invnum' => $cust_bill->invnum,
2132 'amount' => $amount,
2134 $cust_credit_bill->pkgnum( $credit->pkgnum )
2135 if $conf->exists('pkg-balances') && $credit->pkgnum;
2136 my $error = $cust_credit_bill->insert;
2138 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2142 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2146 my $total_unapplied_credits = $self->total_unapplied_credits;
2148 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2150 return $total_unapplied_credits;
2153 =item apply_payments [ OPTION => VALUE ... ]
2155 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2156 to outstanding invoice balances in chronological order.
2158 #and returns the value of any remaining unapplied payments.
2160 A hash of optional arguments may be passed. Currently "manual" is supported.
2161 If true, a payment receipt is sent instead of a statement when
2162 'payment_receipt_email' configuration option is set.
2164 Dies if there is an error.
2168 sub apply_payments {
2169 my( $self, %options ) = @_;
2171 local $SIG{HUP} = 'IGNORE';
2172 local $SIG{INT} = 'IGNORE';
2173 local $SIG{QUIT} = 'IGNORE';
2174 local $SIG{TERM} = 'IGNORE';
2175 local $SIG{TSTP} = 'IGNORE';
2176 local $SIG{PIPE} = 'IGNORE';
2178 my $oldAutoCommit = $FS::UID::AutoCommit;
2179 local $FS::UID::AutoCommit = 0;
2182 $self->select_for_update; #mutex
2186 my @payments = sort { $b->_date <=> $a->_date }
2187 grep { $_->unapplied > 0 }
2190 my @invoices = sort { $a->_date <=> $b->_date}
2191 grep { $_->owed > 0 }
2194 if ( $conf->exists('pkg-balances') ) {
2195 # limit @payments to those w/ a pkgnum grepped from $self
2197 foreach my $i (@invoices) {
2198 foreach my $li ( $i->cust_bill_pkg ) {
2199 $pkgnums{$li->pkgnum} = 1;
2202 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2207 foreach my $cust_bill ( @invoices ) {
2209 if ( !defined($payment) || $payment->unapplied == 0 ) {
2210 $payment = pop @payments or last;
2214 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2215 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2217 $owed = $cust_bill->owed;
2219 unless ( $owed > 0 ) {
2220 push @payments, $payment;
2224 my $amount = min( $payment->unapplied, $owed );
2227 'paynum' => $payment->paynum,
2228 'invnum' => $cust_bill->invnum,
2229 'amount' => $amount,
2231 $cbp->{_date} = $payment->_date
2232 if $options{'manual'} && $options{'backdate_application'};
2233 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2234 $cust_bill_pay->pkgnum( $payment->pkgnum )
2235 if $conf->exists('pkg-balances') && $payment->pkgnum;
2236 my $error = $cust_bill_pay->insert(%options);
2238 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2242 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2246 my $total_unapplied_payments = $self->total_unapplied_payments;
2248 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2250 return $total_unapplied_payments;
2260 suspend_adjourned_pkgs
2261 unsuspend_resumed_pkgs
2264 (do_cust_event pre-bill)
2267 (vendor-only) _gather_taxes
2268 _omit_zero_value_bundles
2271 apply_payments_and_credits
2280 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>