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