FS/FS/cust_main/Billing.pm

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