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;
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( 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( 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 $error = $self->unsuspend_resumed_pkgs( day_end( $options{actual_time} ) );
134 $error = "Error resuming custnum ".$self->custnum. ": $error";
135 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
136 elsif ( $options{fatal} ) { die $error; }
137 else { warn $error; }
140 $job->update_statustext('20,billing packages') if $job;
141 $error = $self->bill( %options );
143 $error = "Error billing custnum ". $self->custnum. ": $error";
144 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
145 elsif ( $options{fatal} ) { die $error; }
146 else { warn $error; }
149 $job->update_statustext('50,applying payments and credits') if $job;
150 $error = $self->apply_payments_and_credits;
152 $error = "Error applying custnum ". $self->custnum. ": $error";
153 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
154 elsif ( $options{fatal} ) { die $error; }
155 else { warn $error; }
158 $job->update_statustext('70,running collection events') if $job;
159 unless ( $conf->exists('cancelled_cust-noevents')
160 && ! $self->num_ncancelled_pkgs
162 $error = $self->collect( %options );
164 $error = "Error collecting custnum ". $self->custnum. ": $error";
165 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
166 elsif ($options{fatal} ) { die $error; }
167 else { warn $error; }
170 $job->update_statustext('100,finished') if $job;
176 sub cancel_expired_pkgs {
177 my ( $self, $time, %options ) = @_;
179 my @cancel_pkgs = $self->ncancelled_pkgs( {
180 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
185 foreach my $cust_pkg ( @cancel_pkgs ) {
186 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
187 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
188 'reason_otaker' => $cpr->otaker,
193 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
196 join(' / ', @errors);
200 sub suspend_adjourned_pkgs {
201 my ( $self, $time, %options ) = @_;
203 my @susp_pkgs = $self->ncancelled_pkgs( {
205 " AND ( susp IS NULL OR susp = 0 )
206 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
207 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
212 #only because there's no SQL test for is_prepaid :/
214 grep { ( $_->part_pkg->is_prepaid
219 && $_->adjourn <= $time
227 foreach my $cust_pkg ( @susp_pkgs ) {
228 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
229 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
230 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
231 'reason_otaker' => $cpr->otaker
235 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
238 join(' / ', @errors);
242 sub unsuspend_resumed_pkgs {
243 my ( $self, $time, %options ) = @_;
245 my @unsusp_pkgs = $self->ncancelled_pkgs( {
246 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
251 foreach my $cust_pkg ( @unsusp_pkgs ) {
252 my $error = $cust_pkg->unsuspend( 'time' => $time );
253 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
256 join(' / ', @errors);
262 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
263 conjunction with the collect method by calling B<bill_and_collect>.
265 If there is an error, returns the error, otherwise returns false.
267 Options are passed as name-value pairs. Currently available options are:
273 If set true, re-charges setup fees.
277 If set true then only bill recurring charges, not setup, usage, one time
282 If set, then override the normal frequency and look for a part_pkg_discount
283 to take at that frequency. This is appropriate only when the normal
284 frequency for all packages is monthly, and is an error otherwise. Use
285 C<pkg_list> to limit the set of packages included in billing.
289 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:
293 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
297 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
299 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
303 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
307 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.
311 This boolean value informs the us that the package is being cancelled. This
312 typically might mean not charging the normal recurring fee but only usage
313 fees since the last billing. Setup charges may be charged. Not all package
314 plans support this feature (they tend to charge 0).
318 Prevent the resetting of usage limits during this call.
322 Do not save the generated bill in the database. Useful with return_bill
326 A list reference on which the generated bill(s) will be returned.
330 Optional terms to be printed on this invoice. Otherwise, customer-specific
331 terms or the default terms are used.
338 my( $self, %options ) = @_;
340 return '' if $self->payby eq 'COMP';
342 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
344 warn "$me bill customer ". $self->custnum. "\n"
347 my $time = $options{'time'} || time;
348 my $invoice_time = $options{'invoice_time'} || $time;
350 $options{'not_pkgpart'} ||= {};
351 $options{'not_pkgpart'} = { map { $_ => 1 }
352 split(/\s*,\s*/, $options{'not_pkgpart'})
354 unless ref($options{'not_pkgpart'});
356 local $SIG{HUP} = 'IGNORE';
357 local $SIG{INT} = 'IGNORE';
358 local $SIG{QUIT} = 'IGNORE';
359 local $SIG{TERM} = 'IGNORE';
360 local $SIG{TSTP} = 'IGNORE';
361 local $SIG{PIPE} = 'IGNORE';
363 my $oldAutoCommit = $FS::UID::AutoCommit;
364 local $FS::UID::AutoCommit = 0;
367 warn "$me acquiring lock on customer ". $self->custnum. "\n"
370 $self->select_for_update; #mutex
372 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
375 my $error = $self->do_cust_event(
376 'debug' => ( $options{'debug'} || 0 ),
377 'time' => $invoice_time,
378 'check_freq' => $options{'check_freq'},
379 'stage' => 'pre-bill',
381 unless $options{no_commit};
383 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
387 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
390 #keep auto-charge and non-auto-charge line items separate
391 my @passes = ( '', 'no_auto' );
393 my %cust_bill_pkg = map { $_ => [] } @passes;
396 # find the packages which are due for billing, find out how much they are
397 # & generate invoice database.
400 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
401 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
403 my %taxlisthash = map { $_ => {} } @passes;
405 my @precommit_hooks = ();
407 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
408 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
410 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
412 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
414 #? to avoid use of uninitialized value errors... ?
415 $cust_pkg->setfield('bill', '')
416 unless defined($cust_pkg->bill);
418 #my $part_pkg = $cust_pkg->part_pkg;
420 my $real_pkgpart = $cust_pkg->pkgpart;
421 my %hash = $cust_pkg->hash;
423 # we could implement this bit as FS::part_pkg::has_hidden, but we already
424 # suffer from performance issues
425 $options{has_hidden} = 0;
426 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
427 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
429 foreach my $part_pkg ( @part_pkg ) {
431 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
433 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
435 my $next_bill = $cust_pkg->getfield('bill') || 0;
437 # let this run once if this is the last bill upon cancellation
438 while ( $next_bill <= $time or $options{cancel} ) {
440 $self->_make_lines( 'part_pkg' => $part_pkg,
441 'cust_pkg' => $cust_pkg,
442 'precommit_hooks' => \@precommit_hooks,
443 'line_items' => $cust_bill_pkg{$pass},
444 'setup' => $total_setup{$pass},
445 'recur' => $total_recur{$pass},
446 'tax_matrix' => $taxlisthash{$pass},
448 'real_pkgpart' => $real_pkgpart,
449 'options' => \%options,
452 # Stop if anything goes wrong
455 # or if we're not incrementing the bill date.
456 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
458 # or if we're letting it run only once
459 last if $options{cancel};
461 $next_bill = $cust_pkg->getfield('bill') || 0;
463 #stop if -o was passed to freeside-daily
464 last if $options{'one_recur'};
467 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
471 } #foreach my $part_pkg
473 } #foreach my $cust_pkg
475 #if the customer isn't on an automatic payby, everything can go on a single
477 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
478 #merge everything into one list
481 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
483 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
485 next unless @cust_bill_pkg; #don't create an invoice w/o line items
487 warn "$me billing pass $pass\n"
488 #.Dumper(\@cust_bill_pkg)."\n"
491 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
492 !$conf->exists('postal_invoice-recurring_only')
496 my $postal_pkg = $self->charge_postal_fee();
497 if ( $postal_pkg && !ref( $postal_pkg ) ) {
499 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
500 return "can't charge postal invoice fee for customer ".
501 $self->custnum. ": $postal_pkg";
503 } elsif ( $postal_pkg ) {
505 my $real_pkgpart = $postal_pkg->pkgpart;
506 # we could implement this bit as FS::part_pkg::has_hidden, but we already
507 # suffer from performance issues
508 $options{has_hidden} = 0;
509 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
510 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
512 foreach my $part_pkg ( @part_pkg ) {
513 my %postal_options = %options;
514 delete $postal_options{cancel};
516 $self->_make_lines( 'part_pkg' => $part_pkg,
517 'cust_pkg' => $postal_pkg,
518 'precommit_hooks' => \@precommit_hooks,
519 'line_items' => \@cust_bill_pkg,
520 'setup' => $total_setup{$pass},
521 'recur' => $total_recur{$pass},
522 'tax_matrix' => $taxlisthash{$pass},
524 'real_pkgpart' => $real_pkgpart,
525 'options' => \%postal_options,
528 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
533 # it's silly to have a zero value postal_pkg, but....
534 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
540 my $listref_or_error =
541 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
543 unless ( ref( $listref_or_error ) ) {
544 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
545 return $listref_or_error;
548 foreach my $taxline ( @$listref_or_error ) {
549 ${ $total_setup{$pass} } =
550 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
551 push @cust_bill_pkg, $taxline;
555 warn "adding tax adjustments...\n" if $DEBUG > 2;
556 foreach my $cust_tax_adjustment (
557 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
563 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
565 my $itemdesc = $cust_tax_adjustment->taxname;
566 $itemdesc = '' if $itemdesc eq 'Tax';
568 push @cust_bill_pkg, new FS::cust_bill_pkg {
574 'itemdesc' => $itemdesc,
575 'itemcomment' => $cust_tax_adjustment->comment,
576 'cust_tax_adjustment' => $cust_tax_adjustment,
577 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
582 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
584 my @cust_bill = $self->cust_bill;
585 my $balance = $self->balance;
586 my $previous_balance = scalar(@cust_bill)
587 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
590 $previous_balance += $cust_bill[$#cust_bill]->charged
591 if scalar(@cust_bill);
592 #my $balance_adjustments =
593 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
595 warn "creating the new invoice\n" if $DEBUG;
596 #create the new invoice
597 my $cust_bill = new FS::cust_bill ( {
598 'custnum' => $self->custnum,
599 '_date' => $invoice_time,
600 'charged' => $charged,
601 'billing_balance' => $balance,
602 'previous_balance' => $previous_balance,
603 'invoice_terms' => $options{'invoice_terms'},
604 'cust_bill_pkg' => \@cust_bill_pkg,
606 $error = $cust_bill->insert unless $options{no_commit};
608 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
609 return "can't create invoice for customer #". $self->custnum. ": $error";
611 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
613 } #foreach my $pass ( keys %cust_bill_pkg )
615 foreach my $hook ( @precommit_hooks ) {
618 } unless $options{no_commit};
620 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
621 return "$@ running precommit hook $hook\n";
625 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
630 #discard bundled packages of 0 value
631 sub _omit_zero_value_bundles {
634 my @cust_bill_pkg = ();
635 my @cust_bill_pkg_bundle = ();
637 my $discount_show_always = 0;
639 foreach my $cust_bill_pkg ( @in ) {
641 $discount_show_always = ($cust_bill_pkg->get('discounts')
642 && scalar(@{$cust_bill_pkg->get('discounts')})
643 && $conf->exists('discount-show-always'));
645 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
646 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
647 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
650 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
651 push @cust_bill_pkg, @cust_bill_pkg_bundle
653 || ($sum == 0 && ( $discount_show_always
654 || grep {$_->recur_show_zero || $_->setup_show_zero}
655 @cust_bill_pkg_bundle
658 @cust_bill_pkg_bundle = ();
662 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
663 push @cust_bill_pkg_bundle, $cust_bill_pkg;
667 push @cust_bill_pkg, @cust_bill_pkg_bundle
669 || ($sum == 0 && ( $discount_show_always
670 || grep {$_->recur_show_zero || $_->setup_show_zero}
671 @cust_bill_pkg_bundle
675 warn " _omit_zero_value_bundles: ". scalar(@in).
676 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
683 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
685 This is a weird one. Perhaps it should not even be exposed.
687 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
688 Usually used internally by bill method B<bill>.
690 If there is an error, returns the error, otherwise returns reference to a
691 list of line items suitable for insertion.
697 An array ref of the line items being billed.
701 A strange beast. The keys to this hash are internal identifiers consisting
702 of the name of the tax object type, a space, and its unique identifier ( e.g.
703 'cust_main_county 23' ). The values of the hash are listrefs. The first
704 item in the list is the tax object. The remaining items are either line
705 items or floating point values (currency amounts).
707 The taxes are calculated on this entity. Calculated exemption records are
708 transferred to the LINEITEMREF items on the assumption that they are related.
714 This specifies the date appearing on the associated invoice. Some
715 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
721 sub calculate_taxes {
722 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
724 # $taxlisthash is a hashref
725 # keys are identifiers, values are arrayrefs
726 # each arrayref starts with a tax object (cust_main_county or tax_rate)
727 # then any cust_bill_pkg objects the tax applies to
729 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
731 warn "$me calculate_taxes\n"
732 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
735 my @tax_line_items = ();
737 # keys are tax names (as printed on invoices / itemdesc )
738 # values are arrayrefs of taxlisthash keys (internal identifiers)
741 # keys are taxlisthash keys (internal identifiers)
742 # values are (cumulative) amounts
745 # keys are taxlisthash keys (internal identifiers)
746 # values are arrayrefs of cust_bill_pkg_tax_location hashrefs
747 my %tax_location = ();
749 # keys are taxlisthash keys (internal identifiers)
750 # values are arrayrefs of cust_bill_pkg_tax_rate_location hashrefs
751 my %tax_rate_location = ();
753 # keys are taxnums (not internal identifiers!)
754 # values are arrayrefs of cust_tax_exempt_pkg objects
757 foreach my $tax ( keys %$taxlisthash ) {
758 # $tax is a tax identifier
759 my $tax_object = shift @{ $taxlisthash->{$tax} };
760 # $tax_object is a cust_main_county or tax_rate
761 # (with pkgnum and locationnum set)
762 # the rest of @{ $taxlisthash->{$tax} } is cust_bill_pkg objects
763 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
764 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
765 # taxline calculates the tax on all cust_bill_pkgs in the
766 # first (arrayref) argument, and returns a hashref of 'name'
767 # (the line item description) and 'amount'.
768 # It also calculates exemptions and attaches them to the cust_bill_pkgs
770 my $taxables = $taxlisthash->{$tax};
771 my $exemptions = $tax_exemption{$tax_object->taxnum} ||= [];
772 my $hashref_or_error =
773 $tax_object->taxline( $taxables,
774 'custnum' => $self->custnum,
775 'invoice_time' => $invoice_time,
776 'exemptions' => $exemptions,
778 return $hashref_or_error unless ref($hashref_or_error);
780 # then collect any new exemptions generated for this tax
781 push @$exemptions, @{ $_->cust_tax_exempt_pkg }
784 unshift @{ $taxlisthash->{$tax} }, $tax_object;
786 my $name = $hashref_or_error->{'name'};
787 my $amount = $hashref_or_error->{'amount'};
789 #warn "adding $amount as $name\n";
790 $taxname{ $name } ||= [];
791 push @{ $taxname{ $name } }, $tax;
793 $tax_amount{ $tax } += $amount;
795 # link records between cust_main_county/tax_rate and cust_location
796 $tax_location{ $tax } ||= [];
797 $tax_rate_location{ $tax } ||= [];
798 if ( ref($tax_object) eq 'FS::cust_main_county' ) {
799 push @{ $tax_location{ $tax } },
801 'taxnum' => $tax_object->taxnum,
802 'taxtype' => ref($tax_object),
803 'pkgnum' => $tax_object->get('pkgnum'),
804 'locationnum' => $tax_object->get('locationnum'),
805 'amount' => sprintf('%.2f', $amount ),
808 elsif ( ref($tax_object) eq 'FS::tax_rate' ) {
809 my $taxratelocationnum =
810 $tax_object->tax_rate_location->taxratelocationnum;
811 push @{ $tax_rate_location{ $tax } },
813 'taxnum' => $tax_object->taxnum,
814 'taxtype' => ref($tax_object),
815 'amount' => sprintf('%.2f', $amount ),
816 'locationtaxid' => $tax_object->location,
817 'taxratelocationnum' => $taxratelocationnum,
823 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
824 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
825 foreach my $tax ( keys %$taxlisthash ) {
826 my $taxables = $taxlisthash->{$tax};
827 my $tax_object = shift @$taxables; # the rest are line items
828 foreach my $cust_bill_pkg ( @$taxables ) {
829 next unless ref($cust_bill_pkg) eq 'FS::cust_bill_pkg';
831 my @cust_tax_exempt_pkg = splice @{ $cust_bill_pkg->cust_tax_exempt_pkg };
833 next unless @cust_tax_exempt_pkg;
834 # get the non-disintegrated version
835 my $real_cust_bill_pkg = $packagemap{$cust_bill_pkg->pkgnum}
836 or die "can't distribute tax exemptions: no line item for ".
837 Dumper($_). " in packagemap ".
838 join(',', sort {$a<=>$b} keys %packagemap). "\n";
840 push @{ $real_cust_bill_pkg->cust_tax_exempt_pkg },
841 @cust_tax_exempt_pkg;
845 #consolidate and create tax line items
846 warn "consolidating and generating...\n" if $DEBUG > 2;
847 foreach my $taxname ( keys %taxname ) {
850 my @cust_bill_pkg_tax_location = ();
851 my @cust_bill_pkg_tax_rate_location = ();
852 warn "adding $taxname\n" if $DEBUG > 1;
853 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
854 next if $seen{$taxitem}++;
855 warn "adding $tax_amount{$taxitem}\n" if $DEBUG > 1;
856 $tax_total += $tax_amount{$taxitem};
857 push @cust_bill_pkg_tax_location,
858 map { new FS::cust_bill_pkg_tax_location $_ }
859 @{ $tax_location{ $taxitem } };
860 push @cust_bill_pkg_tax_rate_location,
861 map { new FS::cust_bill_pkg_tax_rate_location $_ }
862 @{ $tax_rate_location{ $taxitem } };
864 next unless $tax_total;
866 $tax_total = sprintf('%.2f', $tax_total );
868 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
874 if ( $pkg_category and
875 $conf->config('invoice_latexsummary') ||
876 $conf->config('invoice_htmlsummary')
880 my %hash = ( 'section' => $pkg_category->categoryname );
881 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
885 push @tax_line_items, new FS::cust_bill_pkg {
887 'setup' => $tax_total,
891 'itemdesc' => $taxname,
892 'display' => \@display,
893 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
894 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
903 my ($self, %params) = @_;
905 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
907 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
908 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
909 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
910 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
911 my $total_setup = $params{setup} or die "no setup accumulator specified";
912 my $total_recur = $params{recur} or die "no recur accumulator specified";
913 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
914 my $time = $params{'time'} or die "no time specified";
915 my (%options) = %{$params{options}};
917 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
918 # this should never happen
919 die 'freq_override billing attempted on non-monthly package '.
924 my $real_pkgpart = $params{real_pkgpart};
925 my %hash = $cust_pkg->hash;
926 my $old_cust_pkg = new FS::cust_pkg \%hash;
931 $cust_pkg->pkgpart($part_pkg->pkgpart);
939 my @setup_discounts = ();
940 my %setup_param = ( 'discounts' => \@setup_discounts );
941 if ( ! $options{recurring_only}
942 and ! $options{cancel}
943 and ( $options{'resetup'}
944 || ( ! $cust_pkg->setup
945 && ( ! $cust_pkg->start_date
946 || $cust_pkg->start_date <= day_end($time)
948 && ( ! $conf->exists('disable_setup_suspended_pkgs')
949 || ( $conf->exists('disable_setup_suspended_pkgs') &&
950 ! $cust_pkg->getfield('susp')
958 warn " bill setup\n" if $DEBUG > 1;
960 unless ( $cust_pkg->waive_setup ) {
963 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
964 return "$@ running calc_setup for $cust_pkg\n"
967 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
970 $cust_pkg->setfield('setup', $time)
971 unless $cust_pkg->setup;
972 #do need it, but it won't get written to the db
973 #|| $cust_pkg->pkgpart != $real_pkgpart;
975 $cust_pkg->setfield('start_date', '')
976 if $cust_pkg->start_date;
986 my @recur_discounts = ();
988 if ( ! $cust_pkg->start_date
989 and ( ! $cust_pkg->susp || $cust_pkg->option('suspend_bill',1)
990 || ( $part_pkg->option('suspend_bill', 1) )
991 && ! $cust_pkg->option('no_suspend_bill',1)
994 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= day_end($time) )
995 || ( $part_pkg->plan eq 'voip_cdr'
996 && $part_pkg->option('bill_every_call')
1001 # XXX should this be a package event? probably. events are called
1002 # at collection time at the moment, though...
1003 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1004 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1005 #don't want to reset usage just cause we want a line item??
1006 #&& $part_pkg->pkgpart == $real_pkgpart;
1008 warn " bill recur\n" if $DEBUG > 1;
1011 # XXX shared with $recur_prog
1012 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1016 #over two params! lets at least switch to a hashref for the rest...
1017 my $increment_next_bill = ( $part_pkg->freq ne '0'
1018 && ( $cust_pkg->getfield('bill') || 0 ) <= day_end($time)
1019 && !$options{cancel}
1021 my %param = ( %setup_param,
1022 'precommit_hooks' => $precommit_hooks,
1023 'increment_next_bill' => $increment_next_bill,
1024 'discounts' => \@recur_discounts,
1025 'real_pkgpart' => $real_pkgpart,
1026 'freq_override' => $options{freq_override} || '',
1030 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1032 # There may be some part_pkg for which this is wrong. Only those
1033 # which can_discount are supported.
1034 # (the UI should prevent adding discounts to these at the moment)
1036 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1037 " for pkgpart ". $cust_pkg->pkgpart.
1038 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1041 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1042 return "$@ running $method for $cust_pkg\n"
1046 $unitrecur = $cust_pkg->part_pkg->base_recur || $recur; #XXX uuh
1048 if ( $increment_next_bill ) {
1050 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1051 return "unparsable frequency: ". $part_pkg->freq
1052 if $next_bill == -1;
1054 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1055 # only for figuring next bill date, nothing else, so, reset $sdate again
1057 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1058 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1059 $cust_pkg->last_bill($sdate);
1061 $cust_pkg->setfield('bill', $next_bill );
1065 if ( $param{'setup_fee'} ) {
1066 # Add an additional setup fee at the billing stage.
1067 # Used for prorate_defer_bill.
1068 $setup += $param{'setup_fee'};
1069 $unitsetup += $param{'setup_fee'};
1073 if ( defined $param{'discount_left_setup'} ) {
1074 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1075 $setup -= $discount_setup;
1081 warn "\$setup is undefined" unless defined($setup);
1082 warn "\$recur is undefined" unless defined($recur);
1083 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1086 # If there's line items, create em cust_bill_pkg records
1087 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1092 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1093 # hmm.. and if just the options are modified in some weird price plan?
1095 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1098 my $error = $cust_pkg->replace( $old_cust_pkg,
1099 'depend_jobnum'=>$options{depend_jobnum},
1100 'options' => { $cust_pkg->options },
1102 unless $options{no_commit};
1103 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1104 if $error; #just in case
1107 $setup = sprintf( "%.2f", $setup );
1108 $recur = sprintf( "%.2f", $recur );
1109 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1110 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1112 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1113 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1116 my $discount_show_always = $conf->exists('discount-show-always')
1117 && ( ($setup == 0 && scalar(@setup_discounts))
1118 || ($recur == 0 && scalar(@recur_discounts))
1123 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1124 || $discount_show_always
1125 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1126 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1130 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1133 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1135 warn " adding customer package invoice detail: $_\n"
1136 foreach @cust_pkg_detail;
1138 push @details, @cust_pkg_detail;
1140 my $cust_bill_pkg = new FS::cust_bill_pkg {
1141 'pkgnum' => $cust_pkg->pkgnum,
1143 'unitsetup' => $unitsetup,
1145 'unitrecur' => $unitrecur,
1146 'quantity' => $cust_pkg->quantity,
1147 'details' => \@details,
1148 'discounts' => [ @setup_discounts, @recur_discounts ],
1149 'hidden' => $part_pkg->hidden,
1150 'freq' => $part_pkg->freq,
1153 if ( $part_pkg->option('prorate_defer_bill',1)
1154 and !$hash{last_bill} ) {
1155 # both preceding and upcoming, technically
1156 $cust_bill_pkg->sdate( $cust_pkg->setup );
1157 $cust_bill_pkg->edate( $cust_pkg->bill );
1158 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1159 $cust_bill_pkg->sdate( $hash{last_bill} );
1160 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1161 $cust_bill_pkg->edate( $time ) if $options{cancel};
1162 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1163 $cust_bill_pkg->sdate( $sdate );
1164 $cust_bill_pkg->edate( $cust_pkg->bill );
1165 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1168 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1169 unless $part_pkg->pkgpart == $real_pkgpart;
1171 $$total_setup += $setup;
1172 $$total_recur += $recur;
1178 unless ( $discount_show_always ) {
1180 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1181 return $error if $error;
1184 push @$cust_bill_pkgs, $cust_bill_pkg;
1186 } #if $setup != 0 || $recur != 0
1196 my $part_pkg = shift;
1197 my $taxlisthash = shift;
1198 my $cust_bill_pkg = shift;
1199 my $cust_pkg = shift;
1200 my $invoice_time = shift;
1201 my $real_pkgpart = shift;
1202 my $options = shift;
1204 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1206 my %cust_bill_pkg = ();
1210 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1211 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1212 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1213 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1215 my $exempt = $conf->exists('cust_class-tax_exempt')
1216 ? ( $self->cust_class ? $self->cust_class->tax : '' )
1218 # standardize this just to be sure
1219 $exempt = ($exempt eq 'Y') ? 'Y' : '';
1221 #if ( $exempt !~ /Y/i && $self->payby ne 'COMP' ) {
1222 if ( $self->payby ne 'COMP' ) {
1224 if ( $conf->exists('enable_taxproducts')
1225 && ( scalar($part_pkg->part_pkg_taxoverride)
1226 || $part_pkg->has_taxproduct
1233 foreach my $class (@classes) {
1234 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1235 return $err_or_ref unless ref($err_or_ref);
1236 $taxes{$class} = $err_or_ref;
1239 unless (exists $taxes{''}) {
1240 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1241 return $err_or_ref unless ref($err_or_ref);
1242 $taxes{''} = $err_or_ref;
1247 } else { # cust_main_county tax system
1249 # We fetch taxes even if the customer is completely exempt,
1250 # because we need to record that fact.
1252 my @loc_keys = qw( district city county state country );
1253 my $location = $cust_pkg->tax_location;
1254 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1256 $taxhash{'taxclass'} = $part_pkg->taxclass;
1258 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1260 my @taxes = (); # entries are cust_main_county objects
1261 my %taxhash_elim = %taxhash;
1262 my @elim = qw( district city county state );
1265 #first try a match with taxclass
1266 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1268 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1269 #then try a match without taxclass
1270 my %no_taxclass = %taxhash_elim;
1271 $no_taxclass{ 'taxclass' } = '';
1272 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1275 $taxhash_elim{ shift(@elim) } = '';
1277 } while ( !scalar(@taxes) && scalar(@elim) );
1280 # These could become cust_bill_pkg_tax_location records,
1281 # or cust_tax_exempt_pkg. We'll decide later.
1282 $_->set('pkgnum', $cust_pkg->pkgnum);
1283 $_->set('locationnum', $cust_pkg->tax_locationnum);
1286 $taxes{''} = [ @taxes ];
1287 $taxes{'setup'} = [ @taxes ];
1288 $taxes{'recur'} = [ @taxes ];
1289 $taxes{$_} = [ @taxes ] foreach (@classes);
1291 # # maybe eliminate this entirely, along with all the 0% records
1292 # unless ( @taxes ) {
1294 # "fatal: can't find tax rate for state/county/country/taxclass ".
1295 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1298 } #if $conf->exists('enable_taxproducts') ...
1300 } # if $self->payby eq 'COMP'
1302 #what's this doing in the middle of _handle_taxes? probably should split
1303 #this into three parts above in _make_lines
1304 $cust_bill_pkg->set_display( part_pkg => $part_pkg,
1305 real_pkgpart => $real_pkgpart,
1308 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1309 foreach my $key (keys %tax_cust_bill_pkg) {
1310 # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1311 # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1313 # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1314 # apply to $key-class charges.
1315 my @taxes = @{ $taxes{$key} || [] };
1316 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1318 my %localtaxlisthash = ();
1319 foreach my $tax ( @taxes ) {
1321 # this is the tax identifier, not the taxname
1322 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1323 $taxname .= ' pkgnum'. $cust_pkg->pkgnum;
1324 # We need to create a separate $taxlisthash entry for each pkgnum
1325 # on the invoice, so that cust_bill_pkg_tax_location records will
1326 # be linked correctly.
1328 # $taxlisthash: keys are "setup", "recur", and usage classes.
1329 # Values are arrayrefs, first the tax object (cust_main_county
1330 # or tax_rate) and then any cust_bill_pkg objects that the
1332 $taxlisthash->{ $taxname } ||= [ $tax ];
1333 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1335 $localtaxlisthash{ $taxname } ||= [ $tax ];
1336 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1340 warn "finding taxed taxes...\n" if $DEBUG > 2;
1341 foreach my $tax ( keys %localtaxlisthash ) {
1342 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1343 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1345 next unless $tax_object->can('tax_on_tax');
1347 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1348 my $totname = ref( $tot ). ' '. $tot->taxnum;
1350 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1352 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1354 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1355 my $hashref_or_error =
1356 $tax_object->taxline( $localtaxlisthash{$tax},
1357 'custnum' => $self->custnum,
1358 'invoice_time' => $invoice_time,
1360 return $hashref_or_error
1361 unless ref($hashref_or_error);
1363 $taxlisthash->{ $totname } ||= [ $tot ];
1364 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1376 my $part_pkg = shift;
1378 my $cust_pkg = shift;
1380 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1383 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1384 $geocode = $cust_pkg->cust_location->geocode('cch');
1386 $geocode = $self->geocode('cch');
1391 my @taxclassnums = map { $_->taxclassnum }
1392 $part_pkg->part_pkg_taxoverride($class);
1394 unless (@taxclassnums) {
1395 @taxclassnums = map { $_->taxclassnum }
1396 grep { $_->taxable eq 'Y' }
1397 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1399 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1404 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1406 @taxes = qsearch({ 'table' => 'tax_rate',
1407 'hashref' => { 'geocode' => $geocode, },
1408 'extra_sql' => $extra_sql,
1410 if scalar(@taxclassnums);
1412 warn "Found taxes ".
1413 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1420 =item collect [ HASHREF | OPTION => VALUE ... ]
1422 (Attempt to) collect money for this customer's outstanding invoices (see
1423 L<FS::cust_bill>). Usually used after the bill method.
1425 Actions are now triggered by billing events; see L<FS::part_event> and the
1426 billing events web interface. Old-style invoice events (see
1427 L<FS::part_bill_event>) have been deprecated.
1429 If there is an error, returns the error, otherwise returns false.
1431 Options are passed as name-value pairs.
1433 Currently available options are:
1439 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.
1443 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1447 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1451 set true to surpress email card/ACH decline notices.
1455 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)
1461 # allows for one time override of normal customer billing method
1466 my( $self, %options ) = @_;
1468 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1470 my $invoice_time = $options{'invoice_time'} || time;
1473 local $SIG{HUP} = 'IGNORE';
1474 local $SIG{INT} = 'IGNORE';
1475 local $SIG{QUIT} = 'IGNORE';
1476 local $SIG{TERM} = 'IGNORE';
1477 local $SIG{TSTP} = 'IGNORE';
1478 local $SIG{PIPE} = 'IGNORE';
1480 my $oldAutoCommit = $FS::UID::AutoCommit;
1481 local $FS::UID::AutoCommit = 0;
1484 $self->select_for_update; #mutex
1487 my $balance = $self->balance;
1488 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1491 if ( exists($options{'retry_card'}) ) {
1492 carp 'retry_card option passed to collect is deprecated; use retry';
1493 $options{'retry'} ||= $options{'retry_card'};
1495 if ( exists($options{'retry'}) && $options{'retry'} ) {
1496 my $error = $self->retry_realtime;
1498 $dbh->rollback if $oldAutoCommit;
1503 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1505 #never want to roll back an event just because it returned an error
1506 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1508 $self->do_cust_event(
1509 'debug' => ( $options{'debug'} || 0 ),
1510 'time' => $invoice_time,
1511 'check_freq' => $options{'check_freq'},
1512 'stage' => 'collect',
1517 =item retry_realtime
1519 Schedules realtime / batch credit card / electronic check / LEC billing
1520 events for for retry. Useful if card information has changed or manual
1521 retry is desired. The 'collect' method must be called to actually retry
1524 Implementation details: For either this customer, or for each of this
1525 customer's open invoices, changes the status of the first "done" (with
1526 statustext error) realtime processing event to "failed".
1530 sub retry_realtime {
1533 local $SIG{HUP} = 'IGNORE';
1534 local $SIG{INT} = 'IGNORE';
1535 local $SIG{QUIT} = 'IGNORE';
1536 local $SIG{TERM} = 'IGNORE';
1537 local $SIG{TSTP} = 'IGNORE';
1538 local $SIG{PIPE} = 'IGNORE';
1540 my $oldAutoCommit = $FS::UID::AutoCommit;
1541 local $FS::UID::AutoCommit = 0;
1544 #a little false laziness w/due_cust_event (not too bad, really)
1546 my $join = FS::part_event_condition->join_conditions_sql;
1547 my $order = FS::part_event_condition->order_conditions_sql;
1550 . join ( ' OR ' , map {
1551 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1552 my $custnum = FS::part_event->eventtables_custnum->{$_};
1553 "( part_event.eventtable = " . dbh->quote($_)
1554 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1555 . " from $_ $cust_join"
1556 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1557 } FS::part_event->eventtables)
1560 #here is the agent virtualization
1561 my $agent_virt = " ( part_event.agentnum IS NULL
1562 OR part_event.agentnum = ". $self->agentnum. ' )';
1564 #XXX this shouldn't be hardcoded, actions should declare it...
1565 my @realtime_events = qw(
1566 cust_bill_realtime_card
1567 cust_bill_realtime_check
1568 cust_bill_realtime_lec
1572 my $is_realtime_event =
1573 ' part_event.action IN ( '.
1574 join(',', map "'$_'", @realtime_events ).
1577 my $batch_or_statustext =
1578 "( part_event.action = 'cust_bill_batch'
1579 OR ( statustext IS NOT NULL AND statustext != '' )
1583 my @cust_event = qsearch({
1584 'table' => 'cust_event',
1585 'select' => 'cust_event.*',
1586 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1587 'hashref' => { 'status' => 'done' },
1588 'extra_sql' => " AND $batch_or_statustext ".
1589 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1592 my %seen_invnum = ();
1593 foreach my $cust_event (@cust_event) {
1595 #max one for the customer, one for each open invoice
1596 my $cust_X = $cust_event->cust_X;
1597 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1601 or $cust_event->part_event->eventtable eq 'cust_bill'
1604 my $error = $cust_event->retry;
1606 $dbh->rollback if $oldAutoCommit;
1607 return "error scheduling event for retry: $error";
1612 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1617 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1619 Runs billing events; see L<FS::part_event> and the billing events web
1622 If there is an error, returns the error, otherwise returns false.
1624 Options are passed as name-value pairs.
1626 Currently available options are:
1632 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.
1636 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1640 "collect" (the default) or "pre-bill"
1644 set true to surpress email card/ACH decline notices.
1648 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)
1655 # allows for one time override of normal customer billing method
1659 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1662 my( $self, %options ) = @_;
1664 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1666 my $time = $options{'time'} || time;
1669 local $SIG{HUP} = 'IGNORE';
1670 local $SIG{INT} = 'IGNORE';
1671 local $SIG{QUIT} = 'IGNORE';
1672 local $SIG{TERM} = 'IGNORE';
1673 local $SIG{TSTP} = 'IGNORE';
1674 local $SIG{PIPE} = 'IGNORE';
1676 my $oldAutoCommit = $FS::UID::AutoCommit;
1677 local $FS::UID::AutoCommit = 0;
1680 $self->select_for_update; #mutex
1683 my $balance = $self->balance;
1684 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1687 # if ( exists($options{'retry_card'}) ) {
1688 # carp 'retry_card option passed to collect is deprecated; use retry';
1689 # $options{'retry'} ||= $options{'retry_card'};
1691 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1692 # my $error = $self->retry_realtime;
1694 # $dbh->rollback if $oldAutoCommit;
1699 # false laziness w/pay_batch::import_results
1701 my $due_cust_event = $self->due_cust_event(
1702 'debug' => ( $options{'debug'} || 0 ),
1704 'check_freq' => $options{'check_freq'},
1705 'stage' => ( $options{'stage'} || 'collect' ),
1707 unless( ref($due_cust_event) ) {
1708 $dbh->rollback if $oldAutoCommit;
1709 return $due_cust_event;
1712 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1713 #never want to roll back an event just because it or a different one
1715 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1717 foreach my $cust_event ( @$due_cust_event ) {
1721 #re-eval event conditions (a previous event could have changed things)
1722 unless ( $cust_event->test_conditions ) {
1723 #don't leave stray "new/locked" records around
1724 my $error = $cust_event->delete;
1725 return $error if $error;
1730 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1731 if $options{'quiet'};
1732 warn " running cust_event ". $cust_event->eventnum. "\n"
1735 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1736 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1737 #XXX wtf is this? figure out a proper dealio with return value
1749 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1751 Inserts database records for and returns an ordered listref of new events due
1752 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1753 events are due, an empty listref is returned. If there is an error, returns a
1754 scalar error message.
1756 To actually run the events, call each event's test_condition method, and if
1757 still true, call the event's do_event method.
1759 Options are passed as a hashref or as a list of name-value pairs. Available
1766 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.
1770 "collect" (the default) or "pre-bill"
1774 "Current time" for the events.
1778 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)
1782 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1786 Explicitly pass the objects to be tested (typically used with eventtable).
1790 Set to true to return the objects, but not actually insert them into the
1797 sub due_cust_event {
1799 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1802 #my $DEBUG = $opt{'debug'}
1803 local($DEBUG) = $opt{'debug'}
1804 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1805 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1807 warn "$me due_cust_event called with options ".
1808 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1811 $opt{'time'} ||= time;
1813 local $SIG{HUP} = 'IGNORE';
1814 local $SIG{INT} = 'IGNORE';
1815 local $SIG{QUIT} = 'IGNORE';
1816 local $SIG{TERM} = 'IGNORE';
1817 local $SIG{TSTP} = 'IGNORE';
1818 local $SIG{PIPE} = 'IGNORE';
1820 my $oldAutoCommit = $FS::UID::AutoCommit;
1821 local $FS::UID::AutoCommit = 0;
1824 $self->select_for_update #mutex
1825 unless $opt{testonly};
1828 # find possible events (initial search)
1831 my @cust_event = ();
1833 my @eventtable = $opt{'eventtable'}
1834 ? ( $opt{'eventtable'} )
1835 : FS::part_event->eventtables_runorder;
1837 my $check_freq = $opt{'check_freq'} || '1d';
1839 foreach my $eventtable ( @eventtable ) {
1842 if ( $opt{'objects'} ) {
1844 @objects = @{ $opt{'objects'} };
1846 } elsif ( $eventtable eq 'cust_main' ) {
1848 @objects = ( $self );
1852 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
1853 # linkage not needed here because FS::cust_main->$eventtable will
1856 #some false laziness w/Cron::bill bill_where
1858 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1859 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1860 'time'=>$opt{'time'},
1862 $where = $where ? "AND $where" : '';
1864 my $are_part_event =
1865 "EXISTS ( SELECT 1 FROM part_event $join
1866 WHERE check_freq = '$check_freq'
1867 AND eventtable = '$eventtable'
1868 AND ( disabled = '' OR disabled IS NULL )
1874 @objects = $self->$eventtable(
1875 'addl_from' => $cm_join,
1876 'extra_sql' => " AND $are_part_event",
1878 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
1880 my @e_cust_event = ();
1882 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
1884 my $cross = "CROSS JOIN $eventtable $linkage";
1885 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1886 unless $eventtable eq 'cust_main';
1888 foreach my $object ( @objects ) {
1890 #this first search uses the condition_sql magic for optimization.
1891 #the more possible events we can eliminate in this step the better
1893 my $cross_where = '';
1894 my $pkey = $object->primary_key;
1895 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1897 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1899 FS::part_event_condition->where_conditions_sql( $eventtable,
1900 'time'=>$opt{'time'}
1902 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1904 $extra_sql = "AND $extra_sql" if $extra_sql;
1906 #here is the agent virtualization
1907 $extra_sql .= " AND ( part_event.agentnum IS NULL
1908 OR part_event.agentnum = ". $self->agentnum. ' )';
1910 $extra_sql .= " $order";
1912 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1913 if $opt{'debug'} > 2;
1914 my @part_event = qsearch( {
1915 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1916 'select' => 'part_event.*',
1917 'table' => 'part_event',
1918 'addl_from' => "$cross $join",
1919 'hashref' => { 'check_freq' => $check_freq,
1920 'eventtable' => $eventtable,
1923 'extra_sql' => "AND $cross_where $extra_sql",
1927 my $pkey = $object->primary_key;
1928 warn " ". scalar(@part_event).
1929 " possible events found for $eventtable ". $object->$pkey(). "\n";
1932 push @e_cust_event, map {
1933 $_->new_cust_event($object, 'time' => $opt{'time'})
1938 warn " ". scalar(@e_cust_event).
1939 " subtotal possible cust events found for $eventtable\n"
1942 push @cust_event, @e_cust_event;
1946 warn " ". scalar(@cust_event).
1947 " total possible cust events found in initial search\n"
1955 $opt{stage} ||= 'collect';
1957 grep { my $stage = $_->part_event->event_stage;
1958 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1968 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
1971 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1974 warn " invalid conditions not eliminated with condition_sql:\n".
1975 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1976 if keys %unsat && $DEBUG; # > 1;
1982 unless( $opt{testonly} ) {
1983 foreach my $cust_event ( @cust_event ) {
1985 my $error = $cust_event->insert();
1987 $dbh->rollback if $oldAutoCommit;
1994 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2000 warn " returning events: ". Dumper(@cust_event). "\n"
2007 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2009 Applies unapplied payments and credits.
2011 In most cases, this new method should be used in place of sequential
2012 apply_payments and apply_credits methods.
2014 A hash of optional arguments may be passed. Currently "manual" is supported.
2015 If true, a payment receipt is sent instead of a statement when
2016 'payment_receipt_email' configuration option is set.
2018 If there is an error, returns the error, otherwise returns false.
2022 sub apply_payments_and_credits {
2023 my( $self, %options ) = @_;
2025 local $SIG{HUP} = 'IGNORE';
2026 local $SIG{INT} = 'IGNORE';
2027 local $SIG{QUIT} = 'IGNORE';
2028 local $SIG{TERM} = 'IGNORE';
2029 local $SIG{TSTP} = 'IGNORE';
2030 local $SIG{PIPE} = 'IGNORE';
2032 my $oldAutoCommit = $FS::UID::AutoCommit;
2033 local $FS::UID::AutoCommit = 0;
2036 $self->select_for_update; #mutex
2038 foreach my $cust_bill ( $self->open_cust_bill ) {
2039 my $error = $cust_bill->apply_payments_and_credits(%options);
2041 $dbh->rollback if $oldAutoCommit;
2042 return "Error applying: $error";
2046 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2051 =item apply_credits OPTION => VALUE ...
2053 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2054 to outstanding invoice balances in chronological order (or reverse
2055 chronological order if the I<order> option is set to B<newest>) and returns the
2056 value of any remaining unapplied credits available for refund (see
2057 L<FS::cust_refund>).
2059 Dies if there is an error.
2067 local $SIG{HUP} = 'IGNORE';
2068 local $SIG{INT} = 'IGNORE';
2069 local $SIG{QUIT} = 'IGNORE';
2070 local $SIG{TERM} = 'IGNORE';
2071 local $SIG{TSTP} = 'IGNORE';
2072 local $SIG{PIPE} = 'IGNORE';
2074 my $oldAutoCommit = $FS::UID::AutoCommit;
2075 local $FS::UID::AutoCommit = 0;
2078 $self->select_for_update; #mutex
2080 unless ( $self->total_unapplied_credits ) {
2081 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2085 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2086 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2088 my @invoices = $self->open_cust_bill;
2089 @invoices = sort { $b->_date <=> $a->_date } @invoices
2090 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2092 if ( $conf->exists('pkg-balances') ) {
2093 # limit @credits to those w/ a pkgnum grepped from $self
2095 foreach my $i (@invoices) {
2096 foreach my $li ( $i->cust_bill_pkg ) {
2097 $pkgnums{$li->pkgnum} = 1;
2100 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2105 foreach my $cust_bill ( @invoices ) {
2107 if ( !defined($credit) || $credit->credited == 0) {
2108 $credit = pop @credits or last;
2112 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2113 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2115 $owed = $cust_bill->owed;
2117 unless ( $owed > 0 ) {
2118 push @credits, $credit;
2122 my $amount = min( $credit->credited, $owed );
2124 my $cust_credit_bill = new FS::cust_credit_bill ( {
2125 'crednum' => $credit->crednum,
2126 'invnum' => $cust_bill->invnum,
2127 'amount' => $amount,
2129 $cust_credit_bill->pkgnum( $credit->pkgnum )
2130 if $conf->exists('pkg-balances') && $credit->pkgnum;
2131 my $error = $cust_credit_bill->insert;
2133 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2137 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2141 my $total_unapplied_credits = $self->total_unapplied_credits;
2143 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2145 return $total_unapplied_credits;
2148 =item apply_payments [ OPTION => VALUE ... ]
2150 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2151 to outstanding invoice balances in chronological order.
2153 #and returns the value of any remaining unapplied payments.
2155 A hash of optional arguments may be passed. Currently "manual" is supported.
2156 If true, a payment receipt is sent instead of a statement when
2157 'payment_receipt_email' configuration option is set.
2159 Dies if there is an error.
2163 sub apply_payments {
2164 my( $self, %options ) = @_;
2166 local $SIG{HUP} = 'IGNORE';
2167 local $SIG{INT} = 'IGNORE';
2168 local $SIG{QUIT} = 'IGNORE';
2169 local $SIG{TERM} = 'IGNORE';
2170 local $SIG{TSTP} = 'IGNORE';
2171 local $SIG{PIPE} = 'IGNORE';
2173 my $oldAutoCommit = $FS::UID::AutoCommit;
2174 local $FS::UID::AutoCommit = 0;
2177 $self->select_for_update; #mutex
2181 my @payments = sort { $b->_date <=> $a->_date }
2182 grep { $_->unapplied > 0 }
2185 my @invoices = sort { $a->_date <=> $b->_date}
2186 grep { $_->owed > 0 }
2189 if ( $conf->exists('pkg-balances') ) {
2190 # limit @payments to those w/ a pkgnum grepped from $self
2192 foreach my $i (@invoices) {
2193 foreach my $li ( $i->cust_bill_pkg ) {
2194 $pkgnums{$li->pkgnum} = 1;
2197 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2202 foreach my $cust_bill ( @invoices ) {
2204 if ( !defined($payment) || $payment->unapplied == 0 ) {
2205 $payment = pop @payments or last;
2209 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2210 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2212 $owed = $cust_bill->owed;
2214 unless ( $owed > 0 ) {
2215 push @payments, $payment;
2219 my $amount = min( $payment->unapplied, $owed );
2222 'paynum' => $payment->paynum,
2223 'invnum' => $cust_bill->invnum,
2224 'amount' => $amount,
2226 $cbp->{_date} = $payment->_date
2227 if $options{'manual'} && $options{'backdate_application'};
2228 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2229 $cust_bill_pay->pkgnum( $payment->pkgnum )
2230 if $conf->exists('pkg-balances') && $payment->pkgnum;
2231 my $error = $cust_bill_pay->insert(%options);
2233 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2237 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2241 my $total_unapplied_payments = $self->total_unapplied_payments;
2243 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2245 return $total_unapplied_payments;
2255 suspend_adjourned_pkgs
2256 unsuspend_resumed_pkgs
2259 (do_cust_event pre-bill)
2262 (vendor-only) _gather_taxes
2263 _omit_zero_value_bundles
2266 apply_payments_and_credits
2275 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>