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