FS/FS/cust_main/Billing.pm

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