FS/FS/cust_main/Billing.pm

   1 package FS::cust_main::Billing;
   2
   3 use strict;
   4 use vars qw( $conf $DEBUG $me );
   5 use Carp;
   6 use Data::Dumper;
   7 use List::Util qw( min );
   8 use FS::UID qw( dbh );
   9 use FS::Record qw( qsearch qsearchs dbdef );
  10 use FS::Misc::DateTime qw( day_end );
  11 use FS::cust_bill;
  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;
  17 use FS::tax_rate;
  18 use FS::tax_rate_location;
  19 use FS::cust_bill_pkg_tax_location;
  20 use FS::cust_bill_pkg_tax_rate_location;
  21 use FS::part_event;
  22 use FS::part_event_condition;
  23 use FS::pkg_category;
  24
  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
  28 $DEBUG = 0;
  29 $me = '[FS::cust_main::Billing]';
  30
  31 install_callback FS::UID sub {
  32   $conf = new FS::Conf;
  33   #yes, need it for stuff below (prolly should be cached)
  34 };
  35
  36 =head1 NAME
  37
  38 FS::cust_main::Billing - Billing mixin for cust_main
  39
  40 =head1 SYNOPSIS
  41
  42 =head1 DESCRIPTION
  43
  44 These methods are available on FS::cust_main objects.
  45
  46 =head1 METHODS
  47
  48 =over 4
  49
  50 =item bill_and_collect
  51
  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,
  54 etc.
  55
  56 By default, warns on errors and continues with the next operation (but see the
  57 "fatal" flag below).
  58
  59 Options are passed as name-value pairs.  Currently available options are:
  60
  61 =over 4
  62
  63 =item time
  64
  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:
  66
  67  use Date::Parse;
  68  ...
  69  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
  70
  71 =item invoice_time
  72
  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.
  74
  75 =item check_freq
  76
  77 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
  78
  79 =item resetup
  80
  81 If set true, re-charges setup fees.
  82
  83 =item fatal
  84
  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.
  88
  89 =item debug
  90
  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)
  92
  93 =item job
  94
  95 Optional FS::queue entry to receive status updates.
  96
  97 =back
  98
  99 Options are passed to the B<bill> and B<collect> methods verbatim, so all
 100 options of those methods are also available.
 101
 102 =cut
 103
 104 sub bill_and_collect {
 105   my( $self, %options ) = @_;
 106
 107   my $error;
 108
 109   #$options{actual_time} not $options{time} because freeside-daily -d is for
 110   #pre-printing invoices
 111
 112   $options{'actual_time'} ||= time;
 113   my $job = $options{'job'};
 114
 115   $job->update_statustext('0,cleaning expired packages') if $job;
 116   $error = $self->cancel_expired_pkgs( day_end( $options{actual_time} ) );
 117   if ( $error ) {
 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; }
 122   }
 123
 124   $error = $self->suspend_adjourned_pkgs( day_end( $options{actual_time} ) );
 125   if ( $error ) {
 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; }
 130   }
 131
 132   $job->update_statustext('20,billing packages') if $job;
 133   $error = $self->bill( %options );
 134   if ( $error ) {
 135     $error = "Error billing custnum ". $self->custnum. ": $error";
 136     if    ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
 137     elsif ( $options{fatal}                                ) { die    $error; }
 138     else                                                     { warn   $error; }
 139   }
 140
 141   $job->update_statustext('50,applying payments and credits') if $job;
 142   $error = $self->apply_payments_and_credits;
 143   if ( $error ) {
 144     $error = "Error applying custnum ". $self->custnum. ": $error";
 145     if    ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
 146     elsif ( $options{fatal}                                ) { die    $error; }
 147     else                                                     { warn   $error; }
 148   }
 149
 150   $job->update_statustext('70,running collection events') if $job;
 151   unless ( $conf->exists('cancelled_cust-noevents')
 152            && ! $self->num_ncancelled_pkgs
 153   ) {
 154     $error = $self->collect( %options );
 155     if ( $error ) {
 156       $error = "Error collecting custnum ". $self->custnum. ": $error";
 157       if    ($options{fatal} && $options{fatal} eq 'return') { return $error; }
 158       elsif ($options{fatal}                               ) { die    $error; }
 159       else                                                   { warn   $error; }
 160     }
 161   }
 162   $job->update_statustext('100,finished') if $job;
 163
 164   '';
 165
 166 }
 167
 168 sub cancel_expired_pkgs {
 169   my ( $self, $time, %options ) = @_;
 170
 171   my @cancel_pkgs = $self->ncancelled_pkgs( {
 172     'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
 173   } );
 174
 175   my @errors = ();
 176
 177   foreach my $cust_pkg ( @cancel_pkgs ) {
 178     my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
 179     my $error = $cust_pkg->cancel($cpr ? ( 'reason'        => $cpr->reasonnum,
 180                                            'reason_otaker' => $cpr->otaker
 181                                          )
 182                                        : ()
 183                                  );
 184     push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
 185   }
 186
 187   scalar(@errors) ? join(' / ', @errors) : '';
 188
 189 }
 190
 191 sub suspend_adjourned_pkgs {
 192   my ( $self, $time, %options ) = @_;
 193
 194   my @susp_pkgs = $self->ncancelled_pkgs( {
 195     'extra_sql' =>
 196       " AND ( susp IS NULL OR susp = 0 )
 197         AND (    ( bill    IS NOT NULL AND bill    != 0 AND bill    <  $time )
 198               OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
 199             )
 200       ",
 201   } );
 202
 203   #only because there's no SQL test for is_prepaid :/
 204   @susp_pkgs =
 205     grep {     (    $_->part_pkg->is_prepaid
 206                  && $_->bill
 207                  && $_->bill < $time
 208                )
 209             || (    $_->adjourn
 210                  && $_->adjourn <= $time
 211                )
 212
 213          }
 214          @susp_pkgs;
 215
 216   my @errors = ();
 217
 218   foreach my $cust_pkg ( @susp_pkgs ) {
 219     my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
 220       if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
 221     my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
 222                                             'reason_otaker' => $cpr->otaker
 223                                           )
 224                                         : ()
 225                                   );
 226     push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
 227   }
 228
 229   scalar(@errors) ? join(' / ', @errors) : '';
 230
 231 }
 232
 233 =item bill OPTIONS
 234
 235 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
 236 conjunction with the collect method by calling B<bill_and_collect>.
 237
 238 If there is an error, returns the error, otherwise returns false.
 239
 240 Options are passed as name-value pairs.  Currently available options are:
 241
 242 =over 4
 243
 244 =item resetup
 245
 246 If set true, re-charges setup fees.
 247
 248 =item recurring_only
 249
 250 If set true then only bill recurring charges, not setup, usage, one time
 251 charges, etc.
 252
 253 =item freq_override
 254
 255 If set, then override the normal frequency and look for a part_pkg_discount
 256 to take at that frequency.  This will exclude any packages that aren't billed
 257 on a monthly cycle.
 258
 259 =item time
 260
 261 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:
 262
 263  use Date::Parse;
 264  ...
 265  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
 266
 267 =item pkg_list
 268
 269 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
 270
 271  $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
 272
 273 =item not_pkgpart
 274
 275 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
 276
 277 =item invoice_time
 278
 279 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.
 280
 281 =item cancel
 282
 283 This boolean value informs the us that the package is being cancelled.  This
 284 typically might mean not charging the normal recurring fee but only usage
 285 fees since the last billing. Setup charges may be charged.  Not all package
 286 plans support this feature (they tend to charge 0).
 287
 288 =item no_usage_reset
 289
 290 Prevent the resetting of usage limits during this call.
 291
 292 =item no_commit
 293
 294 Do not save the generated bill in the database.  Useful with return_bill
 295
 296 =item return_bill
 297
 298 A list reference on which the generated bill(s) will be returned.
 299
 300 =item invoice_terms
 301
 302 Optional terms to be printed on this invoice.  Otherwise, customer-specific
 303 terms or the default terms are used.
 304
 305 =back
 306
 307 =cut
 308
 309 sub bill {
 310   my( $self, %options ) = @_;
 311
 312   return '' if $self->payby eq 'COMP';
 313
 314   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 315
 316   warn "$me bill customer ". $self->custnum. "\n"
 317     if $DEBUG;
 318
 319   my $time = $options{'time'} || time;
 320   my $invoice_time = $options{'invoice_time'} || $time;
 321
 322   $options{'not_pkgpart'} ||= {};
 323   $options{'not_pkgpart'} = { map { $_ => 1 }
 324                                   split(/\s*,\s*/, $options{'not_pkgpart'})
 325                             }
 326     unless ref($options{'not_pkgpart'});
 327
 328   local $SIG{HUP} = 'IGNORE';
 329   local $SIG{INT} = 'IGNORE';
 330   local $SIG{QUIT} = 'IGNORE';
 331   local $SIG{TERM} = 'IGNORE';
 332   local $SIG{TSTP} = 'IGNORE';
 333   local $SIG{PIPE} = 'IGNORE';
 334
 335   my $oldAutoCommit = $FS::UID::AutoCommit;
 336   local $FS::UID::AutoCommit = 0;
 337   my $dbh = dbh;
 338
 339   warn "$me acquiring lock on customer ". $self->custnum. "\n"
 340     if $DEBUG;
 341
 342   $self->select_for_update; #mutex
 343
 344   warn "$me running pre-bill events for customer ". $self->custnum. "\n"
 345     if $DEBUG;
 346
 347   my $error = $self->do_cust_event(
 348     'debug'      => ( $options{'debug'} || 0 ),
 349     'time'       => $invoice_time,
 350     'check_freq' => $options{'check_freq'},
 351     'stage'      => 'pre-bill',
 352   )
 353     unless $options{no_commit};
 354   if ( $error ) {
 355     $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 356     return $error;
 357   }
 358
 359   warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
 360     if $DEBUG;
 361
 362   #keep auto-charge and non-auto-charge line items separate
 363   my @passes = ( '', 'no_auto' );
 364
 365   my %cust_bill_pkg = map { $_ => [] } @passes;
 366
 367   ###
 368   # find the packages which are due for billing, find out how much they are
 369   # & generate invoice database.
 370   ###
 371
 372   my %total_setup   = map { my $z = 0; $_ => \$z; } @passes;
 373   my %total_recur   = map { my $z = 0; $_ => \$z; } @passes;
 374
 375   my %taxlisthash = map { $_ => {} } @passes;
 376
 377   my @precommit_hooks = ();
 378
 379   $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ];  #param checks?
 380   foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
 381
 382     next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
 383
 384     warn "  bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
 385
 386     #? to avoid use of uninitialized value errors... ?
 387     $cust_pkg->setfield('bill', '')
 388       unless defined($cust_pkg->bill);
 389
 390     #my $part_pkg = $cust_pkg->part_pkg;
 391
 392     my $real_pkgpart = $cust_pkg->pkgpart;
 393     my %hash = $cust_pkg->hash;
 394
 395     # we could implement this bit as FS::part_pkg::has_hidden, but we already
 396     # suffer from performance issues
 397     $options{has_hidden} = 0;
 398     my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
 399     $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
 400
 401     foreach my $part_pkg ( @part_pkg ) {
 402
 403       $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
 404
 405       my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
 406
 407       my $next_bill = $cust_pkg->getfield('bill') || 0;
 408       my $error;
 409       while ( $next_bill <= $time ) {
 410         $error =
 411           $self->_make_lines( 'part_pkg'            => $part_pkg,
 412                               'cust_pkg'            => $cust_pkg,
 413                               'precommit_hooks'     => \@precommit_hooks,
 414                               'line_items'          => $cust_bill_pkg{$pass},
 415                               'setup'               => $total_setup{$pass},
 416                               'recur'               => $total_recur{$pass},
 417                               'tax_matrix'          => $taxlisthash{$pass},
 418                               'time'                => $time,
 419                               'real_pkgpart'        => $real_pkgpart,
 420                               'options'             => \%options,
 421                             );
 422         # Stop if anything goes wrong, or if we're not incrementing
 423         # the bill date.
 424         last if $error;
 425         last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
 426         $next_bill = $cust_pkg->getfield('bill') || 0;
 427       }
 428       if ($error) {
 429         $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 430         return $error;
 431       }
 432
 433     } #foreach my $part_pkg
 434
 435   } #foreach my $cust_pkg
 436
 437   #if the customer isn't on an automatic payby, everything can go on a single
 438   #invoice anyway?
 439   #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
 440     #merge everything into one list
 441   #}
 442
 443   foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
 444
 445     my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
 446
 447     next unless @cust_bill_pkg; #don't create an invoice w/o line items
 448
 449     warn "$me billing pass $pass\n"
 450            #.Dumper(\@cust_bill_pkg)."\n"
 451       if $DEBUG > 2;
 452
 453     if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
 454            !$conf->exists('postal_invoice-recurring_only')
 455        )
 456     {
 457
 458       my $postal_pkg = $self->charge_postal_fee();
 459       if ( $postal_pkg && !ref( $postal_pkg ) ) {
 460
 461         $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 462         return "can't charge postal invoice fee for customer ".
 463           $self->custnum. ": $postal_pkg";
 464
 465       } elsif ( $postal_pkg ) {
 466
 467         my $real_pkgpart = $postal_pkg->pkgpart;
 468         # we could implement this bit as FS::part_pkg::has_hidden, but we already
 469         # suffer from performance issues
 470         $options{has_hidden} = 0;
 471         my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
 472         $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
 473
 474         foreach my $part_pkg ( @part_pkg ) {
 475           my %postal_options = %options;
 476           delete $postal_options{cancel};
 477           my $error =
 478             $self->_make_lines( 'part_pkg'            => $part_pkg,
 479                                 'cust_pkg'            => $postal_pkg,
 480                                 'precommit_hooks'     => \@precommit_hooks,
 481                                 'line_items'          => \@cust_bill_pkg,
 482                                 'setup'               => $total_setup{$pass},
 483                                 'recur'               => $total_recur{$pass},
 484                                 'tax_matrix'          => $taxlisthash{$pass},
 485                                 'time'                => $time,
 486                                 'real_pkgpart'        => $real_pkgpart,
 487                                 'options'             => \%postal_options,
 488                               );
 489           if ($error) {
 490             $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 491             return $error;
 492           }
 493         }
 494
 495         # it's silly to have a zero value postal_pkg, but....
 496         @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
 497
 498       }
 499
 500     }
 501
 502     my $listref_or_error =
 503       $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
 504
 505     unless ( ref( $listref_or_error ) ) {
 506       $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 507       return $listref_or_error;
 508     }
 509
 510     foreach my $taxline ( @$listref_or_error ) {
 511       ${ $total_setup{$pass} } =
 512         sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
 513       push @cust_bill_pkg, $taxline;
 514     }
 515
 516     #add tax adjustments
 517     warn "adding tax adjustments...\n" if $DEBUG > 2;
 518     foreach my $cust_tax_adjustment (
 519       qsearch('cust_tax_adjustment', { 'custnum'    => $self->custnum,
 520                                        'billpkgnum' => '',
 521                                      }
 522              )
 523     ) {
 524
 525       my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
 526
 527       my $itemdesc = $cust_tax_adjustment->taxname;
 528       $itemdesc = '' if $itemdesc eq 'Tax';
 529
 530       push @cust_bill_pkg, new FS::cust_bill_pkg {
 531         'pkgnum'      => 0,
 532         'setup'       => $tax,
 533         'recur'       => 0,
 534         'sdate'       => '',
 535         'edate'       => '',
 536         'itemdesc'    => $itemdesc,
 537         'itemcomment' => $cust_tax_adjustment->comment,
 538         'cust_tax_adjustment' => $cust_tax_adjustment,
 539         #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
 540       };
 541
 542     }
 543
 544     my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
 545
 546     my @cust_bill = $self->cust_bill;
 547     my $balance = $self->balance;
 548     my $previous_balance = scalar(@cust_bill)
 549                              ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
 550                              : 0;
 551
 552     $previous_balance += $cust_bill[$#cust_bill]->charged
 553       if scalar(@cust_bill);
 554     #my $balance_adjustments =
 555     #  sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
 556
 557     warn "creating the new invoice\n" if $DEBUG;
 558     #create the new invoice
 559     my $cust_bill = new FS::cust_bill ( {
 560       'custnum'             => $self->custnum,
 561       '_date'               => $invoice_time,
 562       'charged'             => $charged,
 563       'billing_balance'     => $balance,
 564       'previous_balance'    => $previous_balance,
 565       'invoice_terms'       => $options{'invoice_terms'},
 566       'cust_bill_pkg'       => \@cust_bill_pkg,
 567     } );
 568     $error = $cust_bill->insert unless $options{no_commit};
 569     if ( $error ) {
 570       $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 571       return "can't create invoice for customer #". $self->custnum. ": $error";
 572     }
 573     push @{$options{return_bill}}, $cust_bill if $options{return_bill};
 574
 575   } #foreach my $pass ( keys %cust_bill_pkg )
 576
 577   foreach my $hook ( @precommit_hooks ) {
 578     eval {
 579       &{$hook}; #($self) ?
 580     } unless $options{no_commit};
 581     if ( $@ ) {
 582       $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 583       return "$@ running precommit hook $hook\n";
 584     }
 585   }
 586
 587   $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
 588
 589   ''; #no error
 590 }
 591
 592 #discard bundled packages of 0 value
 593 sub _omit_zero_value_bundles {
 594   my @in = @_;
 595
 596   my @cust_bill_pkg = ();
 597   my @cust_bill_pkg_bundle = ();
 598   my $sum = 0;
 599   my $discount_show_always = 0;
 600
 601   foreach my $cust_bill_pkg ( @in ) {
 602
 603     $discount_show_always = ($cust_bill_pkg->get('discounts')
 604                                 && scalar(@{$cust_bill_pkg->get('discounts')})
 605                                 && $conf->exists('discount-show-always'));
 606
 607     warn "  pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
 608          "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
 609          "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
 610       if $DEBUG > 0;
 611
 612     if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
 613       push @cust_bill_pkg, @cust_bill_pkg_bundle
 614         if $sum > 0
 615         || ($sum == 0 && (    $discount_show_always
 616                            || grep {$_->recur_show_zero || $_->setup_show_zero}
 617                                    @cust_bill_pkg_bundle
 618                          )
 619            );
 620       @cust_bill_pkg_bundle = ();
 621       $sum = 0;
 622     }
 623
 624     $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
 625     push @cust_bill_pkg_bundle, $cust_bill_pkg;
 626
 627   }
 628
 629   push @cust_bill_pkg, @cust_bill_pkg_bundle
 630     if $sum > 0
 631     || ($sum == 0 && (    $discount_show_always
 632                        || grep {$_->recur_show_zero || $_->setup_show_zero}
 633                                @cust_bill_pkg_bundle
 634                      )
 635        );
 636
 637   warn "  _omit_zero_value_bundles: ". scalar(@in).
 638        '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
 639     if $DEBUG > 2;
 640
 641   (@cust_bill_pkg);
 642
 643 }
 644
 645 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
 646
 647 This is a weird one.  Perhaps it should not even be exposed.
 648
 649 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
 650 Usually used internally by bill method B<bill>.
 651
 652 If there is an error, returns the error, otherwise returns reference to a
 653 list of line items suitable for insertion.
 654
 655 =over 4
 656
 657 =item LINEITEMREF
 658
 659 An array ref of the line items being billed.
 660
 661 =item TAXHASHREF
 662
 663 A strange beast.  The keys to this hash are internal identifiers consisting
 664 of the name of the tax object type, a space, and its unique identifier ( e.g.
 665  'cust_main_county 23' ).  The values of the hash are listrefs.  The first
 666 item in the list is the tax object.  The remaining items are either line
 667 items or floating point values (currency amounts).
 668
 669 The taxes are calculated on this entity.  Calculated exemption records are
 670 transferred to the LINEITEMREF items on the assumption that they are related.
 671
 672 Read the source.
 673
 674 =item INVOICE_TIME
 675
 676 This specifies the date appearing on the associated invoice.  Some
 677 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
 678
 679 =back
 680
 681 =cut
 682
 683 sub calculate_taxes {
 684   my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
 685
 686   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 687
 688   warn "$me calculate_taxes\n"
 689        #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
 690     if $DEBUG > 2;
 691
 692   my @tax_line_items = ();
 693
 694   # keys are tax names (as printed on invoices / itemdesc )
 695   # values are listrefs of taxlisthash keys (internal identifiers)
 696   my %taxname = ();
 697
 698   # keys are taxlisthash keys (internal identifiers)
 699   # values are (cumulative) amounts
 700   my %tax = ();
 701
 702   # keys are taxlisthash keys (internal identifiers)
 703   # values are listrefs of cust_bill_pkg_tax_location hashrefs
 704   my %tax_location = ();
 705
 706   # keys are taxlisthash keys (internal identifiers)
 707   # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
 708   my %tax_rate_location = ();
 709
 710   foreach my $tax ( keys %$taxlisthash ) {
 711     my $tax_object = shift @{ $taxlisthash->{$tax} };
 712     warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
 713     warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
 714     my $hashref_or_error =
 715       $tax_object->taxline( $taxlisthash->{$tax},
 716                             'custnum'      => $self->custnum,
 717                             'invoice_time' => $invoice_time
 718                           );
 719     return $hashref_or_error unless ref($hashref_or_error);
 720
 721     unshift @{ $taxlisthash->{$tax} }, $tax_object;
 722
 723     my $name   = $hashref_or_error->{'name'};
 724     my $amount = $hashref_or_error->{'amount'};
 725
 726     #warn "adding $amount as $name\n";
 727     $taxname{ $name } ||= [];
 728     push @{ $taxname{ $name } }, $tax;
 729
 730     $tax{ $tax } += $amount;
 731
 732     $tax_location{ $tax } ||= [];
 733     if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
 734       push @{ $tax_location{ $tax }  },
 735         {
 736           'taxnum'      => $tax_object->taxnum,
 737           'taxtype'     => ref($tax_object),
 738           'pkgnum'      => $tax_object->get('pkgnum'),
 739           'locationnum' => $tax_object->get('locationnum'),
 740           'amount'      => sprintf('%.2f', $amount ),
 741         };
 742     }
 743
 744     $tax_rate_location{ $tax } ||= [];
 745     if ( ref($tax_object) eq 'FS::tax_rate' ) {
 746       my $taxratelocationnum =
 747         $tax_object->tax_rate_location->taxratelocationnum;
 748       push @{ $tax_rate_location{ $tax }  },
 749         {
 750           'taxnum'             => $tax_object->taxnum,
 751           'taxtype'            => ref($tax_object),
 752           'amount'             => sprintf('%.2f', $amount ),
 753           'locationtaxid'      => $tax_object->location,
 754           'taxratelocationnum' => $taxratelocationnum,
 755         };
 756     }
 757
 758   }
 759
 760   #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
 761   my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
 762   foreach my $tax ( keys %$taxlisthash ) {
 763     foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
 764       next unless ref($_) eq 'FS::cust_bill_pkg';
 765
 766       my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
 767
 768       next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
 769       die "can't distribute tax exemptions: no line item for ".  Dumper($_).
 770           " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
 771         unless $packagemap{$_->pkgnum};
 772
 773       push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
 774            @cust_tax_exempt_pkg;
 775     }
 776   }
 777
 778   #consolidate and create tax line items
 779   warn "consolidating and generating...\n" if $DEBUG > 2;
 780   foreach my $taxname ( keys %taxname ) {
 781     my $tax = 0;
 782     my %seen = ();
 783     my @cust_bill_pkg_tax_location = ();
 784     my @cust_bill_pkg_tax_rate_location = ();
 785     warn "adding $taxname\n" if $DEBUG > 1;
 786     foreach my $taxitem ( @{ $taxname{$taxname} } ) {
 787       next if $seen{$taxitem}++;
 788       warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
 789       $tax += $tax{$taxitem};
 790       push @cust_bill_pkg_tax_location,
 791         map { new FS::cust_bill_pkg_tax_location $_ }
 792             @{ $tax_location{ $taxitem } };
 793       push @cust_bill_pkg_tax_rate_location,
 794         map { new FS::cust_bill_pkg_tax_rate_location $_ }
 795             @{ $tax_rate_location{ $taxitem } };
 796     }
 797     next unless $tax;
 798
 799     $tax = sprintf('%.2f', $tax );
 800
 801     my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
 802                                                    'disabled'     => '',
 803                                                  },
 804                                );
 805
 806     my @display = ();
 807     if ( $pkg_category and
 808          $conf->config('invoice_latexsummary') ||
 809          $conf->config('invoice_htmlsummary')
 810        )
 811     {
 812
 813       my %hash = (  'section' => $pkg_category->categoryname );
 814       push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
 815
 816     }
 817
 818     push @tax_line_items, new FS::cust_bill_pkg {
 819       'pkgnum'   => 0,
 820       'setup'    => $tax,
 821       'recur'    => 0,
 822       'sdate'    => '',
 823       'edate'    => '',
 824       'itemdesc' => $taxname,
 825       'display'  => \@display,
 826       'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
 827       'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
 828     };
 829
 830   }
 831
 832   \@tax_line_items;
 833 }
 834
 835 sub _make_lines {
 836   my ($self, %params) = @_;
 837
 838   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 839
 840   my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
 841   my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
 842   my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
 843   my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
 844   my $total_setup = $params{setup} or die "no setup accumulator specified";
 845   my $total_recur = $params{recur} or die "no recur accumulator specified";
 846   my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
 847   my $time = $params{'time'} or die "no time specified";
 848   my (%options) = %{$params{options}};
 849
 850   if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
 851     # this should never happen
 852     die 'freq_override billing attempted on non-monthly package '.
 853       $cust_pkg->pkgnum;
 854   }
 855
 856   my $dbh = dbh;
 857   my $real_pkgpart = $params{real_pkgpart};
 858   my %hash = $cust_pkg->hash;
 859   my $old_cust_pkg = new FS::cust_pkg \%hash;
 860
 861   my @details = ();
 862   my $lineitems = 0;
 863
 864   $cust_pkg->pkgpart($part_pkg->pkgpart);
 865
 866   ###
 867   # bill setup
 868   ###
 869
 870   my $setup = 0;
 871   my $unitsetup = 0;
 872   my @setup_discounts = ();
 873   my %setup_param = ( 'discounts' => \@setup_discounts );
 874   if (     ! $options{recurring_only}
 875        and ! $options{cancel}
 876        and ( $options{'resetup'}
 877              || ( ! $cust_pkg->setup
 878                   && ( ! $cust_pkg->start_date
 879                        || $cust_pkg->start_date <= day_end($time)
 880                      )
 881                   && ( ! $conf->exists('disable_setup_suspended_pkgs')
 882                        || ( $conf->exists('disable_setup_suspended_pkgs') &&
 883                             ! $cust_pkg->getfield('susp')
 884                           )
 885                      )
 886                 )
 887            )
 888      )
 889   {
 890
 891     warn "    bill setup\n" if $DEBUG > 1;
 892
 893     unless ( $cust_pkg->waive_setup ) {
 894         $lineitems++;
 895
 896         $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
 897         return "$@ running calc_setup for $cust_pkg\n"
 898           if $@;
 899
 900         $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
 901     }
 902
 903     $cust_pkg->setfield('setup', $time)
 904       unless $cust_pkg->setup;
 905           #do need it, but it won't get written to the db
 906           #|| $cust_pkg->pkgpart != $real_pkgpart;
 907
 908     $cust_pkg->setfield('start_date', '')
 909       if $cust_pkg->start_date;
 910
 911   }
 912
 913   ###
 914   # bill recurring fee
 915   ###
 916
 917   #XXX unit stuff here too
 918   my $recur = 0;
 919   my $unitrecur = 0;
 920   my @recur_discounts = ();
 921   my $sdate;
 922   if (     ! $cust_pkg->start_date
 923        and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
 924        and
 925             ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= day_end($time) )
 926          || ( $part_pkg->plan eq 'voip_cdr'
 927                && $part_pkg->option('bill_every_call')
 928             )
 929          || $options{cancel}
 930   ) {
 931
 932     # XXX should this be a package event?  probably.  events are called
 933     # at collection time at the moment, though...
 934     $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
 935       if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
 936       #don't want to reset usage just cause we want a line item??
 937       #&& $part_pkg->pkgpart == $real_pkgpart;
 938
 939     warn "    bill recur\n" if $DEBUG > 1;
 940     $lineitems++;
 941
 942     # XXX shared with $recur_prog
 943     $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
 944              || $cust_pkg->setup
 945              || $time;
 946
 947     #over two params!  lets at least switch to a hashref for the rest...
 948     my $increment_next_bill = ( $part_pkg->freq ne '0'
 949                                 && ( $cust_pkg->getfield('bill') || 0 ) <= day_end($time)
 950                                 && !$options{cancel}
 951                               );
 952     my %param = ( %setup_param,
 953                   'precommit_hooks'     => $precommit_hooks,
 954                   'increment_next_bill' => $increment_next_bill,
 955                   'discounts'           => \@recur_discounts,
 956                   'real_pkgpart'        => $real_pkgpart,
 957                   'freq_override'       => $options{freq_override} || '',
 958                   'setup_fee'           => 0,
 959                 );
 960
 961     my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
 962
 963     # There may be some part_pkg for which this is wrong.  Only those
 964     # which can_discount are supported.
 965     # (the UI should prevent adding discounts to these at the moment)
 966
 967     warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
 968          " for pkgpart ". $cust_pkg->pkgpart.
 969          " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
 970       if $DEBUG > 2;
 971
 972     $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
 973     return "$@ running $method for $cust_pkg\n"
 974       if ( $@ );
 975
 976     if ( $increment_next_bill ) {
 977
 978       my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
 979       return "unparsable frequency: ". $part_pkg->freq
 980         if $next_bill == -1;
 981
 982       #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
 983       # only for figuring next bill date, nothing else, so, reset $sdate again
 984       # here
 985       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
 986       #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
 987       $cust_pkg->last_bill($sdate);
 988
 989       $cust_pkg->setfield('bill', $next_bill );
 990
 991     }
 992
 993     if ( $param{'setup_fee'} ) {
 994       # Add an additional setup fee at the billing stage.
 995       # Used for prorate_defer_bill.
 996       $setup += $param{'setup_fee'};
 997       $unitsetup += $param{'setup_fee'};
 998       $lineitems++;
 999     }
1000
1001     if ( defined $param{'discount_left_setup'} ) {
1002         foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1003             $setup -= $discount_setup;
1004         }
1005     }
1006
1007   }
1008
1009   warn "\$setup is undefined" unless defined($setup);
1010   warn "\$recur is undefined" unless defined($recur);
1011   warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1012
1013   ###
1014   # If there's line items, create em cust_bill_pkg records
1015   # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1016   ###
1017
1018   if ( $lineitems ) {
1019
1020     if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1021       # hmm.. and if just the options are modified in some weird price plan?
1022
1023       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
1024         if $DEBUG >1;
1025
1026       my $error = $cust_pkg->replace( $old_cust_pkg,
1027                                       'depend_jobnum'=>$options{depend_jobnum},
1028                                       'options' => { $cust_pkg->options },
1029                                     )
1030         unless $options{no_commit};
1031       return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1032         if $error; #just in case
1033     }
1034
1035     $setup = sprintf( "%.2f", $setup );
1036     $recur = sprintf( "%.2f", $recur );
1037     if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1038       return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1039     }
1040     if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1041       return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1042     }
1043
1044     my $discount_show_always = $conf->exists('discount-show-always')
1045                                && (    ($setup == 0 && scalar(@setup_discounts))
1046                                     || ($recur == 0 && scalar(@recur_discounts))
1047                                   );
1048
1049     if (    $setup != 0
1050          || $recur != 0
1051          || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1052          || $discount_show_always
1053          || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1054          || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1055        )
1056     {
1057
1058       warn "    charges (setup=$setup, recur=$recur); adding line items\n"
1059         if $DEBUG > 1;
1060
1061       my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1062       if ( $DEBUG > 1 ) {
1063         warn "      adding customer package invoice detail: $_\n"
1064           foreach @cust_pkg_detail;
1065       }
1066       push @details, @cust_pkg_detail;
1067
1068       my $cust_bill_pkg = new FS::cust_bill_pkg {
1069         'pkgnum'    => $cust_pkg->pkgnum,
1070         'setup'     => $setup,
1071         'unitsetup' => $unitsetup,
1072         'recur'     => $recur,
1073         'unitrecur' => $unitrecur,
1074         'quantity'  => $cust_pkg->quantity,
1075         'details'   => \@details,
1076         'discounts' => [ @setup_discounts, @recur_discounts ],
1077         'hidden'    => $part_pkg->hidden,
1078         'freq'      => $part_pkg->freq,
1079       };
1080
1081       if ( $part_pkg->recur_temporality eq 'preceding' ) {
1082         $cust_bill_pkg->sdate( $hash{last_bill} );
1083         $cust_bill_pkg->edate( $sdate - 86399   ); #60s*60m*24h-1
1084         $cust_bill_pkg->edate( $time ) if $options{cancel};
1085       } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1086         $cust_bill_pkg->sdate( $sdate );
1087         $cust_bill_pkg->edate( $cust_pkg->bill );
1088         #$cust_bill_pkg->edate( $time ) if $options{cancel};
1089       }
1090
1091       $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1092         unless $part_pkg->pkgpart == $real_pkgpart;
1093
1094       $$total_setup += $setup;
1095       $$total_recur += $recur;
1096
1097       ###
1098       # handle taxes
1099       ###
1100
1101       unless ( $discount_show_always ) {
1102           my $error =
1103             $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1104           return $error if $error;
1105       }
1106
1107       push @$cust_bill_pkgs, $cust_bill_pkg;
1108
1109     } #if $setup != 0 || $recur != 0
1110
1111   } #if $line_items
1112
1113   '';
1114
1115 }
1116
1117 sub _handle_taxes {
1118   my $self = shift;
1119   my $part_pkg = shift;
1120   my $taxlisthash = shift;
1121   my $cust_bill_pkg = shift;
1122   my $cust_pkg = shift;
1123   my $invoice_time = shift;
1124   my $real_pkgpart = shift;
1125   my $options = shift;
1126
1127   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1128
1129   my %cust_bill_pkg = ();
1130   my %taxes = ();
1131
1132   my @classes;
1133   #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1134   push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1135   push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1136   push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1137
1138   if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1139
1140     if ( $conf->exists('enable_taxproducts')
1141          && ( scalar($part_pkg->part_pkg_taxoverride)
1142               || $part_pkg->has_taxproduct
1143             )
1144        )
1145     {
1146
1147       foreach my $class (@classes) {
1148         my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1149         return $err_or_ref unless ref($err_or_ref);
1150         $taxes{$class} = $err_or_ref;
1151       }
1152
1153       unless (exists $taxes{''}) {
1154         my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1155         return $err_or_ref unless ref($err_or_ref);
1156         $taxes{''} = $err_or_ref;
1157       }
1158
1159     } else {
1160
1161       my @loc_keys = qw( city county state country );
1162       my %taxhash;
1163       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1164         my $cust_location = $cust_pkg->cust_location;
1165         %taxhash = map { $_ => $cust_location->$_()    } @loc_keys;
1166       } else {
1167         my $prefix =
1168           ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1169           ? 'ship_'
1170           : '';
1171         %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1172       }
1173
1174       $taxhash{'taxclass'} = $part_pkg->taxclass;
1175
1176       my @taxes = ();
1177       my %taxhash_elim = %taxhash;
1178       my @elim = qw( city county state );
1179       do {
1180
1181         #first try a match with taxclass
1182         @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1183
1184         if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1185           #then try a match without taxclass
1186           my %no_taxclass = %taxhash_elim;
1187           $no_taxclass{ 'taxclass' } = '';
1188           @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1189         }
1190
1191         $taxhash_elim{ shift(@elim) } = '';
1192
1193       } while ( !scalar(@taxes) && scalar(@elim) );
1194
1195       @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1196                     @taxes
1197         if $self->cust_main_exemption; #just to be safe
1198
1199       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1200         foreach (@taxes) {
1201           $_->set('pkgnum',      $cust_pkg->pkgnum );
1202           $_->set('locationnum', $cust_pkg->locationnum );
1203         }
1204       }
1205
1206       $taxes{''} = [ @taxes ];
1207       $taxes{'setup'} = [ @taxes ];
1208       $taxes{'recur'} = [ @taxes ];
1209       $taxes{$_} = [ @taxes ] foreach (@classes);
1210
1211       # # maybe eliminate this entirely, along with all the 0% records
1212       # unless ( @taxes ) {
1213       #   return
1214       #     "fatal: can't find tax rate for state/county/country/taxclass ".
1215       #     join('/', map $taxhash{$_}, qw(state county country taxclass) );
1216       # }
1217
1218     } #if $conf->exists('enable_taxproducts') ...
1219
1220   }
1221
1222   #what's this doing in the middle of _handle_taxes?  probably should split
1223   #this into three parts above in _make_lines
1224   $cust_bill_pkg->set_display(   part_pkg     => $part_pkg,
1225                                  real_pkgpart => $real_pkgpart,
1226                              );
1227
1228   my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1229   foreach my $key (keys %tax_cust_bill_pkg) {
1230     my @taxes = @{ $taxes{$key} || [] };
1231     my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1232
1233     my %localtaxlisthash = ();
1234     foreach my $tax ( @taxes ) {
1235
1236       my $taxname = ref( $tax ). ' '. $tax->taxnum;
1237 #      $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1238 #                  ' locationnum'. $cust_pkg->locationnum
1239 #        if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1240
1241       $taxlisthash->{ $taxname } ||= [ $tax ];
1242       push @{ $taxlisthash->{ $taxname  } }, $tax_cust_bill_pkg;
1243
1244       $localtaxlisthash{ $taxname } ||= [ $tax ];
1245       push @{ $localtaxlisthash{ $taxname  } }, $tax_cust_bill_pkg;
1246
1247     }
1248
1249     warn "finding taxed taxes...\n" if $DEBUG > 2;
1250     foreach my $tax ( keys %localtaxlisthash ) {
1251       my $tax_object = shift @{ $localtaxlisthash{$tax} };
1252       warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1253         if $DEBUG > 2;
1254       next unless $tax_object->can('tax_on_tax');
1255
1256       foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1257         my $totname = ref( $tot ). ' '. $tot->taxnum;
1258
1259         warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1260           if $DEBUG > 2;
1261         next unless exists( $localtaxlisthash{ $totname } ); # only increase
1262                                                              # existing taxes
1263         warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1264         my $hashref_or_error =
1265           $tax_object->taxline( $localtaxlisthash{$tax},
1266                                 'custnum'      => $self->custnum,
1267                                 'invoice_time' => $invoice_time,
1268                               );
1269         return $hashref_or_error
1270           unless ref($hashref_or_error);
1271
1272         $taxlisthash->{ $totname } ||= [ $tot ];
1273         push @{ $taxlisthash->{ $totname  } }, $hashref_or_error->{amount};
1274
1275       }
1276     }
1277
1278   }
1279
1280   '';
1281 }
1282
1283 sub _gather_taxes {
1284   my $self = shift;
1285   my $part_pkg = shift;
1286   my $class = shift;
1287   my $cust_pkg = shift;
1288
1289   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1290
1291   my $geocode;
1292   if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1293     $geocode = $cust_pkg->cust_location->geocode('cch');
1294   } else {
1295     $geocode = $self->geocode('cch');
1296   }
1297
1298   my @taxes = ();
1299
1300   my @taxclassnums = map { $_->taxclassnum }
1301                      $part_pkg->part_pkg_taxoverride($class);
1302
1303   unless (@taxclassnums) {
1304     @taxclassnums = map { $_->taxclassnum }
1305                     grep { $_->taxable eq 'Y' }
1306                     $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1307   }
1308   warn "Found taxclassnum values of ". join(',', @taxclassnums)
1309     if $DEBUG;
1310
1311   my $extra_sql =
1312     "AND (".
1313     join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1314
1315   @taxes = qsearch({ 'table' => 'tax_rate',
1316                      'hashref' => { 'geocode' => $geocode, },
1317                      'extra_sql' => $extra_sql,
1318                   })
1319     if scalar(@taxclassnums);
1320
1321   warn "Found taxes ".
1322        join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1323    if $DEBUG;
1324
1325   [ @taxes ];
1326
1327 }
1328
1329 =item collect [ HASHREF | OPTION => VALUE ... ]
1330
1331 (Attempt to) collect money for this customer's outstanding invoices (see
1332 L<FS::cust_bill>).  Usually used after the bill method.
1333
1334 Actions are now triggered by billing events; see L<FS::part_event> and the
1335 billing events web interface.  Old-style invoice events (see
1336 L<FS::part_bill_event>) have been deprecated.
1337
1338 If there is an error, returns the error, otherwise returns false.
1339
1340 Options are passed as name-value pairs.
1341
1342 Currently available options are:
1343
1344 =over 4
1345
1346 =item invoice_time
1347
1348 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.
1349
1350 =item retry
1351
1352 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1353
1354 =item check_freq
1355
1356 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1357
1358 =item quiet
1359
1360 set true to surpress email card/ACH decline notices.
1361
1362 =item debug
1363
1364 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)
1365
1366 =back
1367
1368 # =item payby
1369 #
1370 # allows for one time override of normal customer billing method
1371
1372 =cut
1373
1374 sub collect {
1375   my( $self, %options ) = @_;
1376
1377   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1378
1379   my $invoice_time = $options{'invoice_time'} || time;
1380
1381   #put below somehow?
1382   local $SIG{HUP} = 'IGNORE';
1383   local $SIG{INT} = 'IGNORE';
1384   local $SIG{QUIT} = 'IGNORE';
1385   local $SIG{TERM} = 'IGNORE';
1386   local $SIG{TSTP} = 'IGNORE';
1387   local $SIG{PIPE} = 'IGNORE';
1388
1389   my $oldAutoCommit = $FS::UID::AutoCommit;
1390   local $FS::UID::AutoCommit = 0;
1391   my $dbh = dbh;
1392
1393   $self->select_for_update; #mutex
1394
1395   if ( $DEBUG ) {
1396     my $balance = $self->balance;
1397     warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1398   }
1399
1400   if ( exists($options{'retry_card'}) ) {
1401     carp 'retry_card option passed to collect is deprecated; use retry';
1402     $options{'retry'} ||= $options{'retry_card'};
1403   }
1404   if ( exists($options{'retry'}) && $options{'retry'} ) {
1405     my $error = $self->retry_realtime;
1406     if ( $error ) {
1407       $dbh->rollback if $oldAutoCommit;
1408       return $error;
1409     }
1410   }
1411
1412   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1413
1414   #never want to roll back an event just because it returned an error
1415   local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1416
1417   $self->do_cust_event(
1418     'debug'      => ( $options{'debug'} || 0 ),
1419     'time'       => $invoice_time,
1420     'check_freq' => $options{'check_freq'},
1421     'stage'      => 'collect',
1422   );
1423
1424 }
1425
1426 =item retry_realtime
1427
1428 Schedules realtime / batch  credit card / electronic check / LEC billing
1429 events for for retry.  Useful if card information has changed or manual
1430 retry is desired.  The 'collect' method must be called to actually retry
1431 the transaction.
1432
1433 Implementation details: For either this customer, or for each of this
1434 customer's open invoices, changes the status of the first "done" (with
1435 statustext error) realtime processing event to "failed".
1436
1437 =cut
1438
1439 sub retry_realtime {
1440   my $self = shift;
1441
1442   local $SIG{HUP} = 'IGNORE';
1443   local $SIG{INT} = 'IGNORE';
1444   local $SIG{QUIT} = 'IGNORE';
1445   local $SIG{TERM} = 'IGNORE';
1446   local $SIG{TSTP} = 'IGNORE';
1447   local $SIG{PIPE} = 'IGNORE';
1448
1449   my $oldAutoCommit = $FS::UID::AutoCommit;
1450   local $FS::UID::AutoCommit = 0;
1451   my $dbh = dbh;
1452
1453   #a little false laziness w/due_cust_event (not too bad, really)
1454
1455   my $join = FS::part_event_condition->join_conditions_sql;
1456   my $order = FS::part_event_condition->order_conditions_sql;
1457   my $mine =
1458   '( '
1459    . join ( ' OR ' , map {
1460     "( part_event.eventtable = " . dbh->quote($_)
1461     . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1462    } FS::part_event->eventtables)
1463    . ') ';
1464
1465   #here is the agent virtualization
1466   my $agent_virt = " (    part_event.agentnum IS NULL
1467                        OR part_event.agentnum = ". $self->agentnum. ' )';
1468
1469   #XXX this shouldn't be hardcoded, actions should declare it...
1470   my @realtime_events = qw(
1471     cust_bill_realtime_card
1472     cust_bill_realtime_check
1473     cust_bill_realtime_lec
1474     cust_bill_batch
1475   );
1476
1477   my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1478                                                   @realtime_events
1479                                      ).
1480                           ' ) ';
1481
1482   my @cust_event = qsearchs({
1483     'table'     => 'cust_event',
1484     'select'    => 'cust_event.*',
1485     'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1486     'hashref'   => { 'status' => 'done' },
1487     'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1488                    " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1489   });
1490
1491   my %seen_invnum = ();
1492   foreach my $cust_event (@cust_event) {
1493
1494     #max one for the customer, one for each open invoice
1495     my $cust_X = $cust_event->cust_X;
1496     next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1497                           ? $cust_X->invnum
1498                           : 0
1499                         }++
1500          or $cust_event->part_event->eventtable eq 'cust_bill'
1501             && ! $cust_X->owed;
1502
1503     my $error = $cust_event->retry;
1504     if ( $error ) {
1505       $dbh->rollback if $oldAutoCommit;
1506       return "error scheduling event for retry: $error";
1507     }
1508
1509   }
1510
1511   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1512   '';
1513
1514 }
1515
1516 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1517
1518 Runs billing events; see L<FS::part_event> and the billing events web
1519 interface.
1520
1521 If there is an error, returns the error, otherwise returns false.
1522
1523 Options are passed as name-value pairs.
1524
1525 Currently available options are:
1526
1527 =over 4
1528
1529 =item time
1530
1531 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.
1532
1533 =item check_freq
1534
1535 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1536
1537 =item stage
1538
1539 "collect" (the default) or "pre-bill"
1540
1541 =item quiet
1542
1543 set true to surpress email card/ACH decline notices.
1544
1545 =item debug
1546
1547 Debugging level.  Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1548
1549 =back
1550 =cut
1551
1552 # =item payby
1553 #
1554 # allows for one time override of normal customer billing method
1555
1556 # =item retry
1557 #
1558 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1559
1560 sub do_cust_event {
1561   my( $self, %options ) = @_;
1562
1563   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1564
1565   my $time = $options{'time'} || time;
1566
1567   #put below somehow?
1568   local $SIG{HUP} = 'IGNORE';
1569   local $SIG{INT} = 'IGNORE';
1570   local $SIG{QUIT} = 'IGNORE';
1571   local $SIG{TERM} = 'IGNORE';
1572   local $SIG{TSTP} = 'IGNORE';
1573   local $SIG{PIPE} = 'IGNORE';
1574
1575   my $oldAutoCommit = $FS::UID::AutoCommit;
1576   local $FS::UID::AutoCommit = 0;
1577   my $dbh = dbh;
1578
1579   $self->select_for_update; #mutex
1580
1581   if ( $DEBUG ) {
1582     my $balance = $self->balance;
1583     warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1584   }
1585
1586 #  if ( exists($options{'retry_card'}) ) {
1587 #    carp 'retry_card option passed to collect is deprecated; use retry';
1588 #    $options{'retry'} ||= $options{'retry_card'};
1589 #  }
1590 #  if ( exists($options{'retry'}) && $options{'retry'} ) {
1591 #    my $error = $self->retry_realtime;
1592 #    if ( $error ) {
1593 #      $dbh->rollback if $oldAutoCommit;
1594 #      return $error;
1595 #    }
1596 #  }
1597
1598   # false laziness w/pay_batch::import_results
1599
1600   my $due_cust_event = $self->due_cust_event(
1601     'debug'      => ( $options{'debug'} || 0 ),
1602     'time'       => $time,
1603     'check_freq' => $options{'check_freq'},
1604     'stage'      => ( $options{'stage'} || 'collect' ),
1605   );
1606   unless( ref($due_cust_event) ) {
1607     $dbh->rollback if $oldAutoCommit;
1608     return $due_cust_event;
1609   }
1610
1611   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1612   #never want to roll back an event just because it or a different one
1613   # returned an error
1614   local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1615
1616   foreach my $cust_event ( @$due_cust_event ) {
1617
1618     #XXX lock event
1619
1620     #re-eval event conditions (a previous event could have changed things)
1621     unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1622       #don't leave stray "new/locked" records around
1623       my $error = $cust_event->delete;
1624       return $error if $error;
1625       next;
1626     }
1627
1628     {
1629       local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1630         if $options{'quiet'};
1631       warn "  running cust_event ". $cust_event->eventnum. "\n"
1632         if $DEBUG > 1;
1633
1634       #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1635       if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1636         #XXX wtf is this?  figure out a proper dealio with return value
1637         #from do_event
1638         return $error;
1639       }
1640     }
1641
1642   }
1643
1644   '';
1645
1646 }
1647
1648 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1649
1650 Inserts database records for and returns an ordered listref of new events due
1651 for this customer, as FS::cust_event objects (see L<FS::cust_event>).  If no
1652 events are due, an empty listref is returned.  If there is an error, returns a
1653 scalar error message.
1654
1655 To actually run the events, call each event's test_condition method, and if
1656 still true, call the event's do_event method.
1657
1658 Options are passed as a hashref or as a list of name-value pairs.  Available
1659 options are:
1660
1661 =over 4
1662
1663 =item check_freq
1664
1665 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.
1666
1667 =item stage
1668
1669 "collect" (the default) or "pre-bill"
1670
1671 =item time
1672
1673 "Current time" for the events.
1674
1675 =item debug
1676
1677 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)
1678
1679 =item eventtable
1680
1681 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1682
1683 =item objects
1684
1685 Explicitly pass the objects to be tested (typically used with eventtable).
1686
1687 =item testonly
1688
1689 Set to true to return the objects, but not actually insert them into the
1690 database.
1691
1692 =back
1693
1694 =cut
1695
1696 sub due_cust_event {
1697   my $self = shift;
1698   my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1699
1700   #???
1701   #my $DEBUG = $opt{'debug'}
1702   local($DEBUG) = $opt{'debug'}
1703     if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1704   $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1705
1706   warn "$me due_cust_event called with options ".
1707        join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1708     if $DEBUG;
1709
1710   $opt{'time'} ||= time;
1711
1712   local $SIG{HUP} = 'IGNORE';
1713   local $SIG{INT} = 'IGNORE';
1714   local $SIG{QUIT} = 'IGNORE';
1715   local $SIG{TERM} = 'IGNORE';
1716   local $SIG{TSTP} = 'IGNORE';
1717   local $SIG{PIPE} = 'IGNORE';
1718
1719   my $oldAutoCommit = $FS::UID::AutoCommit;
1720   local $FS::UID::AutoCommit = 0;
1721   my $dbh = dbh;
1722
1723   $self->select_for_update #mutex
1724     unless $opt{testonly};
1725
1726   ###
1727   # find possible events (initial search)
1728   ###
1729
1730   my @cust_event = ();
1731
1732   my @eventtable = $opt{'eventtable'}
1733                      ? ( $opt{'eventtable'} )
1734                      : FS::part_event->eventtables_runorder;
1735
1736   my $check_freq = $opt{'check_freq'} || '1d';
1737
1738   foreach my $eventtable ( @eventtable ) {
1739
1740     my @objects;
1741     if ( $opt{'objects'} ) {
1742
1743       @objects = @{ $opt{'objects'} };
1744
1745     } else {
1746
1747       #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1748       if ( $eventtable eq 'cust_main' ) {
1749         @objects = ( $self );
1750       } else {
1751
1752         my $cm_join =
1753           "LEFT JOIN cust_main USING ( custnum )";
1754
1755         #some false laziness w/Cron::bill bill_where
1756
1757         my $join  = FS::part_event_condition->join_conditions_sql( $eventtable);
1758         my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1759                                                            'time'=>$opt{'time'},
1760                                                                   );
1761         $where = $where ? "AND $where" : '';
1762
1763         my $are_part_event =
1764           "EXISTS ( SELECT 1 FROM part_event $join
1765                       WHERE check_freq = '$check_freq'
1766                         AND eventtable = '$eventtable'
1767                         AND ( disabled = '' OR disabled IS NULL )
1768                         $where
1769                   )
1770           ";
1771         #eofalse
1772
1773         @objects = $self->$eventtable(
1774                      'addl_from' => $cm_join,
1775                      'extra_sql' => " AND $are_part_event",
1776                    );
1777       }
1778
1779     }
1780
1781     my @e_cust_event = ();
1782
1783     my $cross = "CROSS JOIN $eventtable";
1784     $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1785       unless $eventtable eq 'cust_main';
1786
1787     foreach my $object ( @objects ) {
1788
1789       #this first search uses the condition_sql magic for optimization.
1790       #the more possible events we can eliminate in this step the better
1791
1792       my $cross_where = '';
1793       my $pkey = $object->primary_key;
1794       $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1795
1796       my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1797       my $extra_sql =
1798         FS::part_event_condition->where_conditions_sql( $eventtable,
1799                                                         'time'=>$opt{'time'}
1800                                                       );
1801       my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1802
1803       $extra_sql = "AND $extra_sql" if $extra_sql;
1804
1805       #here is the agent virtualization
1806       $extra_sql .= " AND (    part_event.agentnum IS NULL
1807                             OR part_event.agentnum = ". $self->agentnum. ' )';
1808
1809       $extra_sql .= " $order";
1810
1811       warn "searching for events for $eventtable ". $object->$pkey. "\n"
1812         if $opt{'debug'} > 2;
1813       my @part_event = qsearch( {
1814         'debug'     => ( $opt{'debug'} > 3 ? 1 : 0 ),
1815         'select'    => 'part_event.*',
1816         'table'     => 'part_event',
1817         'addl_from' => "$cross $join",
1818         'hashref'   => { 'check_freq' => $check_freq,
1819                          'eventtable' => $eventtable,
1820                          'disabled'   => '',
1821                        },
1822         'extra_sql' => "AND $cross_where $extra_sql",
1823       } );
1824
1825       if ( $DEBUG > 2 ) {
1826         my $pkey = $object->primary_key;
1827         warn "      ". scalar(@part_event).
1828              " possible events found for $eventtable ". $object->$pkey(). "\n";
1829       }
1830
1831       push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1832
1833     }
1834
1835     warn "    ". scalar(@e_cust_event).
1836          " subtotal possible cust events found for $eventtable\n"
1837       if $DEBUG > 1;
1838
1839     push @cust_event, @e_cust_event;
1840
1841   }
1842
1843   warn "  ". scalar(@cust_event).
1844        " total possible cust events found in initial search\n"
1845     if $DEBUG; # > 1;
1846
1847
1848   ##
1849   # test stage
1850   ##
1851
1852   $opt{stage} ||= 'collect';
1853   @cust_event =
1854     grep { my $stage = $_->part_event->event_stage;
1855            $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1856          }
1857          @cust_event;
1858
1859   ##
1860   # test conditions
1861   ##
1862
1863   my %unsat = ();
1864
1865   @cust_event = grep $_->test_conditions( 'time'          => $opt{'time'},
1866                                           'stats_hashref' => \%unsat ),
1867                      @cust_event;
1868
1869   warn "  ". scalar(@cust_event). " cust events left satisfying conditions\n"
1870     if $DEBUG; # > 1;
1871
1872   warn "    invalid conditions not eliminated with condition_sql:\n".
1873        join('', map "      $_: ".$unsat{$_}."\n", keys %unsat )
1874     if keys %unsat && $DEBUG; # > 1;
1875
1876   ##
1877   # insert
1878   ##
1879
1880   unless( $opt{testonly} ) {
1881     foreach my $cust_event ( @cust_event ) {
1882
1883       my $error = $cust_event->insert();
1884       if ( $error ) {
1885         $dbh->rollback if $oldAutoCommit;
1886         return $error;
1887       }
1888
1889     }
1890   }
1891
1892   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1893
1894   ##
1895   # return
1896   ##
1897
1898   warn "  returning events: ". Dumper(@cust_event). "\n"
1899     if $DEBUG > 2;
1900
1901   \@cust_event;
1902
1903 }
1904
1905 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1906
1907 Applies unapplied payments and credits.
1908
1909 In most cases, this new method should be used in place of sequential
1910 apply_payments and apply_credits methods.
1911
1912 A hash of optional arguments may be passed.  Currently "manual" is supported.
1913 If true, a payment receipt is sent instead of a statement when
1914 'payment_receipt_email' configuration option is set.
1915
1916 If there is an error, returns the error, otherwise returns false.
1917
1918 =cut
1919
1920 sub apply_payments_and_credits {
1921   my( $self, %options ) = @_;
1922
1923   local $SIG{HUP} = 'IGNORE';
1924   local $SIG{INT} = 'IGNORE';
1925   local $SIG{QUIT} = 'IGNORE';
1926   local $SIG{TERM} = 'IGNORE';
1927   local $SIG{TSTP} = 'IGNORE';
1928   local $SIG{PIPE} = 'IGNORE';
1929
1930   my $oldAutoCommit = $FS::UID::AutoCommit;
1931   local $FS::UID::AutoCommit = 0;
1932   my $dbh = dbh;
1933
1934   $self->select_for_update; #mutex
1935
1936   foreach my $cust_bill ( $self->open_cust_bill ) {
1937     my $error = $cust_bill->apply_payments_and_credits(%options);
1938     if ( $error ) {
1939       $dbh->rollback if $oldAutoCommit;
1940       return "Error applying: $error";
1941     }
1942   }
1943
1944   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1945   ''; #no error
1946
1947 }
1948
1949 =item apply_credits OPTION => VALUE ...
1950
1951 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1952 to outstanding invoice balances in chronological order (or reverse
1953 chronological order if the I<order> option is set to B<newest>) and returns the
1954 value of any remaining unapplied credits available for refund (see
1955 L<FS::cust_refund>).
1956
1957 Dies if there is an error.
1958
1959 =cut
1960
1961 sub apply_credits {
1962   my $self = shift;
1963   my %opt = @_;
1964
1965   local $SIG{HUP} = 'IGNORE';
1966   local $SIG{INT} = 'IGNORE';
1967   local $SIG{QUIT} = 'IGNORE';
1968   local $SIG{TERM} = 'IGNORE';
1969   local $SIG{TSTP} = 'IGNORE';
1970   local $SIG{PIPE} = 'IGNORE';
1971
1972   my $oldAutoCommit = $FS::UID::AutoCommit;
1973   local $FS::UID::AutoCommit = 0;
1974   my $dbh = dbh;
1975
1976   $self->select_for_update; #mutex
1977
1978   unless ( $self->total_unapplied_credits ) {
1979     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1980     return 0;
1981   }
1982
1983   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1984       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1985
1986   my @invoices = $self->open_cust_bill;
1987   @invoices = sort { $b->_date <=> $a->_date } @invoices
1988     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1989
1990   if ( $conf->exists('pkg-balances') ) {
1991     # limit @credits to those w/ a pkgnum grepped from $self
1992     my %pkgnums = ();
1993     foreach my $i (@invoices) {
1994       foreach my $li ( $i->cust_bill_pkg ) {
1995         $pkgnums{$li->pkgnum} = 1;
1996       }
1997     }
1998     @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
1999   }
2000
2001   my $credit;
2002
2003   foreach my $cust_bill ( @invoices ) {
2004
2005     if ( !defined($credit) || $credit->credited == 0) {
2006       $credit = pop @credits or last;
2007     }
2008
2009     my $owed;
2010     if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2011       $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2012     } else {
2013       $owed = $cust_bill->owed;
2014     }
2015     unless ( $owed > 0 ) {
2016       push @credits, $credit;
2017       next;
2018     }
2019
2020     my $amount = min( $credit->credited, $owed );
2021
2022     my $cust_credit_bill = new FS::cust_credit_bill ( {
2023       'crednum' => $credit->crednum,
2024       'invnum'  => $cust_bill->invnum,
2025       'amount'  => $amount,
2026     } );
2027     $cust_credit_bill->pkgnum( $credit->pkgnum )
2028       if $conf->exists('pkg-balances') && $credit->pkgnum;
2029     my $error = $cust_credit_bill->insert;
2030     if ( $error ) {
2031       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2032       die $error;
2033     }
2034
2035     redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2036
2037   }
2038
2039   my $total_unapplied_credits = $self->total_unapplied_credits;
2040
2041   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2042
2043   return $total_unapplied_credits;
2044 }
2045
2046 =item apply_payments  [ OPTION => VALUE ... ]
2047
2048 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2049 to outstanding invoice balances in chronological order.
2050
2051  #and returns the value of any remaining unapplied payments.
2052
2053 A hash of optional arguments may be passed.  Currently "manual" is supported.
2054 If true, a payment receipt is sent instead of a statement when
2055 'payment_receipt_email' configuration option is set.
2056
2057 Dies if there is an error.
2058
2059 =cut
2060
2061 sub apply_payments {
2062   my( $self, %options ) = @_;
2063
2064   local $SIG{HUP} = 'IGNORE';
2065   local $SIG{INT} = 'IGNORE';
2066   local $SIG{QUIT} = 'IGNORE';
2067   local $SIG{TERM} = 'IGNORE';
2068   local $SIG{TSTP} = 'IGNORE';
2069   local $SIG{PIPE} = 'IGNORE';
2070
2071   my $oldAutoCommit = $FS::UID::AutoCommit;
2072   local $FS::UID::AutoCommit = 0;
2073   my $dbh = dbh;
2074
2075   $self->select_for_update; #mutex
2076
2077   #return 0 unless
2078
2079   my @payments = sort { $b->_date <=> $a->_date }
2080                  grep { $_->unapplied > 0 }
2081                  $self->cust_pay;
2082
2083   my @invoices = sort { $a->_date <=> $b->_date}
2084                  grep { $_->owed > 0 }
2085                  $self->cust_bill;
2086
2087   if ( $conf->exists('pkg-balances') ) {
2088     # limit @payments to those w/ a pkgnum grepped from $self
2089     my %pkgnums = ();
2090     foreach my $i (@invoices) {
2091       foreach my $li ( $i->cust_bill_pkg ) {
2092         $pkgnums{$li->pkgnum} = 1;
2093       }
2094     }
2095     @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2096   }
2097
2098   my $payment;
2099
2100   foreach my $cust_bill ( @invoices ) {
2101
2102     if ( !defined($payment) || $payment->unapplied == 0 ) {
2103       $payment = pop @payments or last;
2104     }
2105
2106     my $owed;
2107     if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2108       $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2109     } else {
2110       $owed = $cust_bill->owed;
2111     }
2112     unless ( $owed > 0 ) {
2113       push @payments, $payment;
2114       next;
2115     }
2116
2117     my $amount = min( $payment->unapplied, $owed );
2118
2119     my $cbp = {
2120       'paynum' => $payment->paynum,
2121       'invnum' => $cust_bill->invnum,
2122       'amount' => $amount,
2123     };
2124     $cbp->{_date} = $payment->_date
2125         if $options{'manual'} && $options{'backdate_application'};
2126     my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2127     $cust_bill_pay->pkgnum( $payment->pkgnum )
2128       if $conf->exists('pkg-balances') && $payment->pkgnum;
2129     my $error = $cust_bill_pay->insert(%options);
2130     if ( $error ) {
2131       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2132       die $error;
2133     }
2134
2135     redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2136
2137   }
2138
2139   my $total_unapplied_payments = $self->total_unapplied_payments;
2140
2141   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2142
2143   return $total_unapplied_payments;
2144 }
2145
2146 =back
2147
2148 =head1 FLOW
2149
2150   bill_and_collect
2151
2152     cancel_expired_pkgs
2153     suspend_adjourned_pkgs
2154
2155     bill
2156       (do_cust_event pre-bill)
2157       _make_lines
2158         _handle_taxes
2159           (vendor-only) _gather_taxes
2160       _omit_zero_value_bundles
2161       calculate_taxes
2162
2163     apply_payments_and_credits
2164     collect
2165       do_cust_event
2166         due_cust_event
2167
2168 =head1 BUGS
2169
2170 =head1 SEE ALSO
2171
2172 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>
2173
2174 =cut
2175
2176 1;