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   my @in = @_;
 584
 585   my @cust_bill_pkg = ();
 586   my @cust_bill_pkg_bundle = ();
 587   my $sum = 0;
 588   my $discount_show_always = 0;
 589
 590   foreach my $cust_bill_pkg ( @in ) {
 591
 592     $discount_show_always = ($cust_bill_pkg->get('discounts')
 593                                 && scalar(@{$cust_bill_pkg->get('discounts')})
 594                                 && $conf->exists('discount-show-always'));
 595
 596     warn "  pkgnum ". $cust_bill_pkg->pkgnum.
 597          " sum $sum, recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
 598       if $DEBUG > 0;
 599
 600     if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
 601       push @cust_bill_pkg, @cust_bill_pkg_bundle
 602         if $sum > 0
 603         || ($sum == 0 && (    $discount_show_always
 604                            || grep $_->recur_show_zero, @cust_bill_pkg_bundle )
 605            );
 606       @cust_bill_pkg_bundle = ();
 607       $sum = 0;
 608     }
 609
 610     $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
 611     push @cust_bill_pkg_bundle, $cust_bill_pkg;
 612
 613   }
 614
 615   push @cust_bill_pkg, @cust_bill_pkg_bundle
 616     if $sum > 0
 617     || ($sum == 0 && (    $discount_show_always
 618                        || grep $_->recur_show_zero, @cust_bill_pkg_bundle )
 619        );
 620
 621   warn "  _omit_zero_value_bundles: ". scalar(@in).
 622        '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
 623     if $DEBUG > 2;
 624
 625   (@cust_bill_pkg);
 626
 627 }
 628
 629 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
 630
 631 This is a weird one.  Perhaps it should not even be exposed.
 632
 633 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
 634 Usually used internally by bill method B<bill>.
 635
 636 If there is an error, returns the error, otherwise returns reference to a
 637 list of line items suitable for insertion.
 638
 639 =over 4
 640
 641 =item LINEITEMREF
 642
 643 An array ref of the line items being billed.
 644
 645 =item TAXHASHREF
 646
 647 A strange beast.  The keys to this hash are internal identifiers consisting
 648 of the name of the tax object type, a space, and its unique identifier ( e.g.
 649  'cust_main_county 23' ).  The values of the hash are listrefs.  The first
 650 item in the list is the tax object.  The remaining items are either line
 651 items or floating point values (currency amounts).
 652
 653 The taxes are calculated on this entity.  Calculated exemption records are
 654 transferred to the LINEITEMREF items on the assumption that they are related.
 655
 656 Read the source.
 657
 658 =item INVOICE_TIME
 659
 660 This specifies the date appearing on the associated invoice.  Some
 661 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
 662
 663 =back
 664
 665 =cut
 666
 667 sub calculate_taxes {
 668   my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
 669
 670   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 671
 672   warn "$me calculate_taxes\n"
 673        #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
 674     if $DEBUG > 2;
 675
 676   my @tax_line_items = ();
 677
 678   # keys are tax names (as printed on invoices / itemdesc )
 679   # values are listrefs of taxlisthash keys (internal identifiers)
 680   my %taxname = ();
 681
 682   # keys are taxlisthash keys (internal identifiers)
 683   # values are (cumulative) amounts
 684   my %tax = ();
 685
 686   # keys are taxlisthash keys (internal identifiers)
 687   # values are listrefs of cust_bill_pkg_tax_location hashrefs
 688   my %tax_location = ();
 689
 690   # keys are taxlisthash keys (internal identifiers)
 691   # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
 692   my %tax_rate_location = ();
 693
 694   foreach my $tax ( keys %$taxlisthash ) {
 695     my $tax_object = shift @{ $taxlisthash->{$tax} };
 696     warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
 697     warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
 698     my $hashref_or_error =
 699       $tax_object->taxline( $taxlisthash->{$tax},
 700                             'custnum'      => $self->custnum,
 701                             'invoice_time' => $invoice_time
 702                           );
 703     return $hashref_or_error unless ref($hashref_or_error);
 704
 705     unshift @{ $taxlisthash->{$tax} }, $tax_object;
 706
 707     my $name   = $hashref_or_error->{'name'};
 708     my $amount = $hashref_or_error->{'amount'};
 709
 710     #warn "adding $amount as $name\n";
 711     $taxname{ $name } ||= [];
 712     push @{ $taxname{ $name } }, $tax;
 713
 714     $tax{ $tax } += $amount;
 715
 716     $tax_location{ $tax } ||= [];
 717     if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
 718       push @{ $tax_location{ $tax }  },
 719         {
 720           'taxnum'      => $tax_object->taxnum,
 721           'taxtype'     => ref($tax_object),
 722           'pkgnum'      => $tax_object->get('pkgnum'),
 723           'locationnum' => $tax_object->get('locationnum'),
 724           'amount'      => sprintf('%.2f', $amount ),
 725         };
 726     }
 727
 728     $tax_rate_location{ $tax } ||= [];
 729     if ( ref($tax_object) eq 'FS::tax_rate' ) {
 730       my $taxratelocationnum =
 731         $tax_object->tax_rate_location->taxratelocationnum;
 732       push @{ $tax_rate_location{ $tax }  },
 733         {
 734           'taxnum'             => $tax_object->taxnum,
 735           'taxtype'            => ref($tax_object),
 736           'amount'             => sprintf('%.2f', $amount ),
 737           'locationtaxid'      => $tax_object->location,
 738           'taxratelocationnum' => $taxratelocationnum,
 739         };
 740     }
 741
 742   }
 743
 744   #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
 745   my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
 746   foreach my $tax ( keys %$taxlisthash ) {
 747     foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
 748       next unless ref($_) eq 'FS::cust_bill_pkg';
 749
 750       my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
 751
 752       next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
 753       die "can't distribute tax exemptions: no line item for ".  Dumper($_).
 754           " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
 755         unless $packagemap{$_->pkgnum};
 756
 757       push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
 758            @cust_tax_exempt_pkg;
 759     }
 760   }
 761
 762   #consolidate and create tax line items
 763   warn "consolidating and generating...\n" if $DEBUG > 2;
 764   foreach my $taxname ( keys %taxname ) {
 765     my $tax = 0;
 766     my %seen = ();
 767     my @cust_bill_pkg_tax_location = ();
 768     my @cust_bill_pkg_tax_rate_location = ();
 769     warn "adding $taxname\n" if $DEBUG > 1;
 770     foreach my $taxitem ( @{ $taxname{$taxname} } ) {
 771       next if $seen{$taxitem}++;
 772       warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
 773       $tax += $tax{$taxitem};
 774       push @cust_bill_pkg_tax_location,
 775         map { new FS::cust_bill_pkg_tax_location $_ }
 776             @{ $tax_location{ $taxitem } };
 777       push @cust_bill_pkg_tax_rate_location,
 778         map { new FS::cust_bill_pkg_tax_rate_location $_ }
 779             @{ $tax_rate_location{ $taxitem } };
 780     }
 781     next unless $tax;
 782
 783     $tax = sprintf('%.2f', $tax );
 784
 785     my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
 786                                                    'disabled'     => '',
 787                                                  },
 788                                );
 789
 790     my @display = ();
 791     if ( $pkg_category and
 792          $conf->config('invoice_latexsummary') ||
 793          $conf->config('invoice_htmlsummary')
 794        )
 795     {
 796
 797       my %hash = (  'section' => $pkg_category->categoryname );
 798       push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
 799
 800     }
 801
 802     push @tax_line_items, new FS::cust_bill_pkg {
 803       'pkgnum'   => 0,
 804       'setup'    => $tax,
 805       'recur'    => 0,
 806       'sdate'    => '',
 807       'edate'    => '',
 808       'itemdesc' => $taxname,
 809       'display'  => \@display,
 810       'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
 811       'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
 812     };
 813
 814   }
 815
 816   \@tax_line_items;
 817 }
 818
 819 sub _make_lines {
 820   my ($self, %params) = @_;
 821
 822   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 823
 824   my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
 825   my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
 826   my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
 827   my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
 828   my $total_setup = $params{setup} or die "no setup accumulator specified";
 829   my $total_recur = $params{recur} or die "no recur accumulator specified";
 830   my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
 831   my $time = $params{'time'} or die "no time specified";
 832   my (%options) = %{$params{options}};
 833
 834   my $dbh = dbh;
 835   my $real_pkgpart = $params{real_pkgpart};
 836   my %hash = $cust_pkg->hash;
 837   my $old_cust_pkg = new FS::cust_pkg \%hash;
 838
 839   my @details = ();
 840   my @discounts = ();
 841   my $lineitems = 0;
 842
 843   $cust_pkg->pkgpart($part_pkg->pkgpart);
 844
 845   ###
 846   # bill setup
 847   ###
 848
 849   my $setup = 0;
 850   my $unitsetup = 0;
 851   my %setup_param = ();
 852   if (     ! $options{recurring_only}
 853        and ! $options{cancel}
 854        and ( $options{'resetup'}
 855              || ( ! $cust_pkg->setup
 856                   && ( ! $cust_pkg->start_date
 857                        || $cust_pkg->start_date <= $time
 858                      )
 859                   && ( ! $conf->exists('disable_setup_suspended_pkgs')
 860                        || ( $conf->exists('disable_setup_suspended_pkgs') &&
 861                             ! $cust_pkg->getfield('susp')
 862                           )
 863                      )
 864                 )
 865            )
 866      )
 867   {
 868
 869     warn "    bill setup\n" if $DEBUG > 1;
 870
 871     unless ( $cust_pkg->waive_setup ) {
 872         $lineitems++;
 873
 874         $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
 875         return "$@ running calc_setup for $cust_pkg\n"
 876           if $@;
 877
 878         $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
 879     }
 880
 881     $cust_pkg->setfield('setup', $time)
 882       unless $cust_pkg->setup;
 883           #do need it, but it won't get written to the db
 884           #|| $cust_pkg->pkgpart != $real_pkgpart;
 885
 886     $cust_pkg->setfield('start_date', '')
 887       if $cust_pkg->start_date;
 888
 889   }
 890
 891   ###
 892   # bill recurring fee
 893   ###
 894
 895   #XXX unit stuff here too
 896   my $recur = 0;
 897   my $unitrecur = 0;
 898   my $sdate;
 899   if (     ! $cust_pkg->start_date
 900        and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
 901        and
 902             ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $time )
 903          || ( $part_pkg->plan eq 'voip_cdr'
 904                && $part_pkg->option('bill_every_call')
 905             )
 906          || $options{cancel}
 907   ) {
 908
 909     # XXX should this be a package event?  probably.  events are called
 910     # at collection time at the moment, though...
 911     $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
 912       if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
 913       #don't want to reset usage just cause we want a line item??
 914       #&& $part_pkg->pkgpart == $real_pkgpart;
 915
 916     warn "    bill recur\n" if $DEBUG > 1;
 917     $lineitems++;
 918
 919     # XXX shared with $recur_prog
 920     $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
 921              || $cust_pkg->setup
 922              || $time;
 923
 924     #over two params!  lets at least switch to a hashref for the rest...
 925     my $increment_next_bill = ( $part_pkg->freq ne '0'
 926                                 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
 927                                 && !$options{cancel}
 928                               );
 929     my %param = ( 'precommit_hooks'     => $precommit_hooks,
 930                   'increment_next_bill' => $increment_next_bill,
 931                   'discounts'           => \@discounts,
 932                   'real_pkgpart'        => $real_pkgpart,
 933                   'freq_override'       => $options{freq_override} || '',
 934                   %setup_param,
 935                 );
 936
 937     my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
 938
 939     # There may be some part_pkg for which this is wrong.  Only those
 940     # which can_discount are supported.
 941     # (the UI should prevent adding discounts to these at the moment)
 942
 943     $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
 944     return "$@ running $method for $cust_pkg\n"
 945       if ( $@ );
 946
 947     if ( $increment_next_bill ) {
 948
 949       my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
 950       return "unparsable frequency: ". $part_pkg->freq
 951         if $next_bill == -1;
 952
 953       #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
 954       # only for figuring next bill date, nothing else, so, reset $sdate again
 955       # here
 956       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
 957       #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
 958       $cust_pkg->last_bill($sdate);
 959
 960       $cust_pkg->setfield('bill', $next_bill );
 961
 962     }
 963
 964     if ( defined $param{'discount_left_setup'} ) {
 965         foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
 966             $setup -= $discount_setup;
 967         }
 968     }
 969
 970   }
 971
 972   warn "\$setup is undefined" unless defined($setup);
 973   warn "\$recur is undefined" unless defined($recur);
 974   warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
 975
 976   ###
 977   # If there's line items, create em cust_bill_pkg records
 978   # If $cust_pkg has been modified, update it (if we're a real pkgpart)
 979   ###
 980
 981   if ( $lineitems ) {
 982
 983     if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
 984       # hmm.. and if just the options are modified in some weird price plan?
 985
 986       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
 987         if $DEBUG >1;
 988
 989       my $error = $cust_pkg->replace( $old_cust_pkg,
 990                                       'depend_jobnum'=>$options{depend_jobnum},
 991                                       'options' => { $cust_pkg->options },
 992                                     )
 993         unless $options{no_commit};
 994       return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
 995         if $error; #just in case
 996     }
 997
 998     $setup = sprintf( "%.2f", $setup );
 999     $recur = sprintf( "%.2f", $recur );
1000     if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1001       return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1002     }
1003     if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1004       return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1005     }
1006
1007     my $discount_show_always = ($recur == 0 && scalar(@discounts)
1008                                 && $conf->exists('discount-show-always'));
1009
1010     if (    $setup != 0
1011          || $recur != 0
1012          || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1013          || $discount_show_always
1014          || ($recur == 0 && $part_pkg->recur_show_zero)
1015        )
1016     {
1017
1018       warn "    charges (setup=$setup, recur=$recur); adding line items\n"
1019         if $DEBUG > 1;
1020
1021       my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1022       if ( $DEBUG > 1 ) {
1023         warn "      adding customer package invoice detail: $_\n"
1024           foreach @cust_pkg_detail;
1025       }
1026       push @details, @cust_pkg_detail;
1027
1028       my $cust_bill_pkg = new FS::cust_bill_pkg {
1029         'pkgnum'    => $cust_pkg->pkgnum,
1030         'setup'     => $setup,
1031         'unitsetup' => $unitsetup,
1032         'recur'     => $recur,
1033         'unitrecur' => $unitrecur,
1034         'quantity'  => $cust_pkg->quantity,
1035         'details'   => \@details,
1036         'discounts' => \@discounts,
1037         'hidden'    => $part_pkg->hidden,
1038         'freq'      => $part_pkg->freq,
1039       };
1040
1041       if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
1042         $cust_bill_pkg->sdate( $hash{last_bill} );
1043         $cust_bill_pkg->edate( $sdate - 86399   ); #60s*60m*24h-1
1044         $cust_bill_pkg->edate( $time ) if $options{cancel};
1045       } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
1046         $cust_bill_pkg->sdate( $sdate );
1047         $cust_bill_pkg->edate( $cust_pkg->bill );
1048         #$cust_bill_pkg->edate( $time ) if $options{cancel};
1049       }
1050
1051       $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1052         unless $part_pkg->pkgpart == $real_pkgpart;
1053
1054       $$total_setup += $setup;
1055       $$total_recur += $recur;
1056
1057       ###
1058       # handle taxes
1059       ###
1060
1061       unless ( $discount_show_always ) {
1062       my $error =
1063         $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1064       return $error if $error;
1065       }
1066
1067       push @$cust_bill_pkgs, $cust_bill_pkg;
1068
1069     } #if $setup != 0 || $recur != 0
1070
1071   } #if $line_items
1072
1073   '';
1074
1075 }
1076
1077 sub _handle_taxes {
1078   my $self = shift;
1079   my $part_pkg = shift;
1080   my $taxlisthash = shift;
1081   my $cust_bill_pkg = shift;
1082   my $cust_pkg = shift;
1083   my $invoice_time = shift;
1084   my $real_pkgpart = shift;
1085   my $options = shift;
1086
1087   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1088
1089   my %cust_bill_pkg = ();
1090   my %taxes = ();
1091
1092   my @classes;
1093   #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1094   push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1095   push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1096   push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1097
1098   if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1099
1100     if ( $conf->exists('enable_taxproducts')
1101          && ( scalar($part_pkg->part_pkg_taxoverride)
1102               || $part_pkg->has_taxproduct
1103             )
1104        )
1105     {
1106
1107       foreach my $class (@classes) {
1108         my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1109         return $err_or_ref unless ref($err_or_ref);
1110         $taxes{$class} = $err_or_ref;
1111       }
1112
1113       unless (exists $taxes{''}) {
1114         my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1115         return $err_or_ref unless ref($err_or_ref);
1116         $taxes{''} = $err_or_ref;
1117       }
1118
1119     } else {
1120
1121       my @loc_keys = qw( city county state country );
1122       my %taxhash;
1123       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1124         my $cust_location = $cust_pkg->cust_location;
1125         %taxhash = map { $_ => $cust_location->$_()    } @loc_keys;
1126       } else {
1127         my $prefix =
1128           ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1129           ? 'ship_'
1130           : '';
1131         %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1132       }
1133
1134       $taxhash{'taxclass'} = $part_pkg->taxclass;
1135
1136       my @taxes = ();
1137       my %taxhash_elim = %taxhash;
1138       my @elim = qw( city county state );
1139       do {
1140
1141         #first try a match with taxclass
1142         @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1143
1144         if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1145           #then try a match without taxclass
1146           my %no_taxclass = %taxhash_elim;
1147           $no_taxclass{ 'taxclass' } = '';
1148           @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1149         }
1150
1151         $taxhash_elim{ shift(@elim) } = '';
1152
1153       } while ( !scalar(@taxes) && scalar(@elim) );
1154
1155       @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1156                     @taxes
1157         if $self->cust_main_exemption; #just to be safe
1158
1159       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1160         foreach (@taxes) {
1161           $_->set('pkgnum',      $cust_pkg->pkgnum );
1162           $_->set('locationnum', $cust_pkg->locationnum );
1163         }
1164       }
1165
1166       $taxes{''} = [ @taxes ];
1167       $taxes{'setup'} = [ @taxes ];
1168       $taxes{'recur'} = [ @taxes ];
1169       $taxes{$_} = [ @taxes ] foreach (@classes);
1170
1171       # # maybe eliminate this entirely, along with all the 0% records
1172       # unless ( @taxes ) {
1173       #   return
1174       #     "fatal: can't find tax rate for state/county/country/taxclass ".
1175       #     join('/', map $taxhash{$_}, qw(state county country taxclass) );
1176       # }
1177
1178     } #if $conf->exists('enable_taxproducts') ...
1179
1180   }
1181
1182   my @display = ();
1183   my $separate = $conf->exists('separate_usage');
1184   my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1185   my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1186   my $section = $temp_pkg->part_pkg->categoryname;
1187   if ( $separate || $section || $usage_mandate ) {
1188
1189     my %hash = ( 'section' => $section );
1190
1191     $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1192     my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1193     if ( $separate ) {
1194       push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1195       push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1196     } else {
1197       push @display, new FS::cust_bill_pkg_display
1198                        { type => '',
1199                          %hash,
1200                          ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1201                        };
1202     }
1203
1204     if ($separate && $section && $summary) {
1205       push @display, new FS::cust_bill_pkg_display { type    => 'U',
1206                                                      summary => 'Y',
1207                                                      %hash,
1208                                                    };
1209     }
1210     if ($usage_mandate || $section && $summary) {
1211       $hash{post_total} = 'Y';
1212     }
1213
1214     if ($separate || $usage_mandate) {
1215       $hash{section} = $section if ($separate || $usage_mandate);
1216       push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1217     }
1218
1219   }
1220   $cust_bill_pkg->set('display', \@display);
1221
1222   my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1223   foreach my $key (keys %tax_cust_bill_pkg) {
1224     my @taxes = @{ $taxes{$key} || [] };
1225     my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1226
1227     my %localtaxlisthash = ();
1228     foreach my $tax ( @taxes ) {
1229
1230       my $taxname = ref( $tax ). ' '. $tax->taxnum;
1231 #      $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1232 #                  ' locationnum'. $cust_pkg->locationnum
1233 #        if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1234
1235       $taxlisthash->{ $taxname } ||= [ $tax ];
1236       push @{ $taxlisthash->{ $taxname  } }, $tax_cust_bill_pkg;
1237
1238       $localtaxlisthash{ $taxname } ||= [ $tax ];
1239       push @{ $localtaxlisthash{ $taxname  } }, $tax_cust_bill_pkg;
1240
1241     }
1242
1243     warn "finding taxed taxes...\n" if $DEBUG > 2;
1244     foreach my $tax ( keys %localtaxlisthash ) {
1245       my $tax_object = shift @{ $localtaxlisthash{$tax} };
1246       warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1247         if $DEBUG > 2;
1248       next unless $tax_object->can('tax_on_tax');
1249
1250       foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1251         my $totname = ref( $tot ). ' '. $tot->taxnum;
1252
1253         warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1254           if $DEBUG > 2;
1255         next unless exists( $localtaxlisthash{ $totname } ); # only increase
1256                                                              # existing taxes
1257         warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1258         my $hashref_or_error =
1259           $tax_object->taxline( $localtaxlisthash{$tax},
1260                                 'custnum'      => $self->custnum,
1261                                 'invoice_time' => $invoice_time,
1262                               );
1263         return $hashref_or_error
1264           unless ref($hashref_or_error);
1265
1266         $taxlisthash->{ $totname } ||= [ $tot ];
1267         push @{ $taxlisthash->{ $totname  } }, $hashref_or_error->{amount};
1268
1269       }
1270     }
1271
1272   }
1273
1274   '';
1275 }
1276
1277 sub _gather_taxes {
1278   my $self = shift;
1279   my $part_pkg = shift;
1280   my $class = shift;
1281   my $cust_pkg = shift;
1282
1283   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1284
1285   my $geocode;
1286   if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1287     $geocode = $cust_pkg->cust_location->geocode('cch');
1288   } else {
1289     $geocode = $self->geocode('cch');
1290   }
1291
1292   my @taxes = ();
1293
1294   my @taxclassnums = map { $_->taxclassnum }
1295                      $part_pkg->part_pkg_taxoverride($class);
1296
1297   unless (@taxclassnums) {
1298     @taxclassnums = map { $_->taxclassnum }
1299                     grep { $_->taxable eq 'Y' }
1300                     $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1301   }
1302   warn "Found taxclassnum values of ". join(',', @taxclassnums)
1303     if $DEBUG;
1304
1305   my $extra_sql =
1306     "AND (".
1307     join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1308
1309   @taxes = qsearch({ 'table' => 'tax_rate',
1310                      'hashref' => { 'geocode' => $geocode, },
1311                      'extra_sql' => $extra_sql,
1312                   })
1313     if scalar(@taxclassnums);
1314
1315   warn "Found taxes ".
1316        join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1317    if $DEBUG;
1318
1319   [ @taxes ];
1320
1321 }
1322
1323 =item collect [ HASHREF | OPTION => VALUE ... ]
1324
1325 (Attempt to) collect money for this customer's outstanding invoices (see
1326 L<FS::cust_bill>).  Usually used after the bill method.
1327
1328 Actions are now triggered by billing events; see L<FS::part_event> and the
1329 billing events web interface.  Old-style invoice events (see
1330 L<FS::part_bill_event>) have been deprecated.
1331
1332 If there is an error, returns the error, otherwise returns false.
1333
1334 Options are passed as name-value pairs.
1335
1336 Currently available options are:
1337
1338 =over 4
1339
1340 =item invoice_time
1341
1342 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.
1343
1344 =item retry
1345
1346 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1347
1348 =item check_freq
1349
1350 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1351
1352 =item quiet
1353
1354 set true to surpress email card/ACH decline notices.
1355
1356 =item debug
1357
1358 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)
1359
1360 =back
1361
1362 # =item payby
1363 #
1364 # allows for one time override of normal customer billing method
1365
1366 =cut
1367
1368 sub collect {
1369   my( $self, %options ) = @_;
1370
1371   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1372
1373   my $invoice_time = $options{'invoice_time'} || time;
1374
1375   #put below somehow?
1376   local $SIG{HUP} = 'IGNORE';
1377   local $SIG{INT} = 'IGNORE';
1378   local $SIG{QUIT} = 'IGNORE';
1379   local $SIG{TERM} = 'IGNORE';
1380   local $SIG{TSTP} = 'IGNORE';
1381   local $SIG{PIPE} = 'IGNORE';
1382
1383   my $oldAutoCommit = $FS::UID::AutoCommit;
1384   local $FS::UID::AutoCommit = 0;
1385   my $dbh = dbh;
1386
1387   $self->select_for_update; #mutex
1388
1389   if ( $DEBUG ) {
1390     my $balance = $self->balance;
1391     warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1392   }
1393
1394   if ( exists($options{'retry_card'}) ) {
1395     carp 'retry_card option passed to collect is deprecated; use retry';
1396     $options{'retry'} ||= $options{'retry_card'};
1397   }
1398   if ( exists($options{'retry'}) && $options{'retry'} ) {
1399     my $error = $self->retry_realtime;
1400     if ( $error ) {
1401       $dbh->rollback if $oldAutoCommit;
1402       return $error;
1403     }
1404   }
1405
1406   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1407
1408   #never want to roll back an event just because it returned an error
1409   local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1410
1411   $self->do_cust_event(
1412     'debug'      => ( $options{'debug'} || 0 ),
1413     'time'       => $invoice_time,
1414     'check_freq' => $options{'check_freq'},
1415     'stage'      => 'collect',
1416   );
1417
1418 }
1419
1420 =item retry_realtime
1421
1422 Schedules realtime / batch  credit card / electronic check / LEC billing
1423 events for for retry.  Useful if card information has changed or manual
1424 retry is desired.  The 'collect' method must be called to actually retry
1425 the transaction.
1426
1427 Implementation details: For either this customer, or for each of this
1428 customer's open invoices, changes the status of the first "done" (with
1429 statustext error) realtime processing event to "failed".
1430
1431 =cut
1432
1433 sub retry_realtime {
1434   my $self = shift;
1435
1436   local $SIG{HUP} = 'IGNORE';
1437   local $SIG{INT} = 'IGNORE';
1438   local $SIG{QUIT} = 'IGNORE';
1439   local $SIG{TERM} = 'IGNORE';
1440   local $SIG{TSTP} = 'IGNORE';
1441   local $SIG{PIPE} = 'IGNORE';
1442
1443   my $oldAutoCommit = $FS::UID::AutoCommit;
1444   local $FS::UID::AutoCommit = 0;
1445   my $dbh = dbh;
1446
1447   #a little false laziness w/due_cust_event (not too bad, really)
1448
1449   my $join = FS::part_event_condition->join_conditions_sql;
1450   my $order = FS::part_event_condition->order_conditions_sql;
1451   my $mine =
1452   '( '
1453    . join ( ' OR ' , map {
1454     "( part_event.eventtable = " . dbh->quote($_)
1455     . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1456    } FS::part_event->eventtables)
1457    . ') ';
1458
1459   #here is the agent virtualization
1460   my $agent_virt = " (    part_event.agentnum IS NULL
1461                        OR part_event.agentnum = ". $self->agentnum. ' )';
1462
1463   #XXX this shouldn't be hardcoded, actions should declare it...
1464   my @realtime_events = qw(
1465     cust_bill_realtime_card
1466     cust_bill_realtime_check
1467     cust_bill_realtime_lec
1468     cust_bill_batch
1469   );
1470
1471   my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1472                                                   @realtime_events
1473                                      ).
1474                           ' ) ';
1475
1476   my @cust_event = qsearchs({
1477     'table'     => 'cust_event',
1478     'select'    => 'cust_event.*',
1479     'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1480     'hashref'   => { 'status' => 'done' },
1481     'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1482                    " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1483   });
1484
1485   my %seen_invnum = ();
1486   foreach my $cust_event (@cust_event) {
1487
1488     #max one for the customer, one for each open invoice
1489     my $cust_X = $cust_event->cust_X;
1490     next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1491                           ? $cust_X->invnum
1492                           : 0
1493                         }++
1494          or $cust_event->part_event->eventtable eq 'cust_bill'
1495             && ! $cust_X->owed;
1496
1497     my $error = $cust_event->retry;
1498     if ( $error ) {
1499       $dbh->rollback if $oldAutoCommit;
1500       return "error scheduling event for retry: $error";
1501     }
1502
1503   }
1504
1505   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1506   '';
1507
1508 }
1509
1510 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1511
1512 Runs billing events; see L<FS::part_event> and the billing events web
1513 interface.
1514
1515 If there is an error, returns the error, otherwise returns false.
1516
1517 Options are passed as name-value pairs.
1518
1519 Currently available options are:
1520
1521 =over 4
1522
1523 =item time
1524
1525 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.
1526
1527 =item check_freq
1528
1529 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1530
1531 =item stage
1532
1533 "collect" (the default) or "pre-bill"
1534
1535 =item quiet
1536
1537 set true to surpress email card/ACH decline notices.
1538
1539 =item debug
1540
1541 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)
1542
1543 =back
1544 =cut
1545
1546 # =item payby
1547 #
1548 # allows for one time override of normal customer billing method
1549
1550 # =item retry
1551 #
1552 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1553
1554 sub do_cust_event {
1555   my( $self, %options ) = @_;
1556
1557   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1558
1559   my $time = $options{'time'} || time;
1560
1561   #put below somehow?
1562   local $SIG{HUP} = 'IGNORE';
1563   local $SIG{INT} = 'IGNORE';
1564   local $SIG{QUIT} = 'IGNORE';
1565   local $SIG{TERM} = 'IGNORE';
1566   local $SIG{TSTP} = 'IGNORE';
1567   local $SIG{PIPE} = 'IGNORE';
1568
1569   my $oldAutoCommit = $FS::UID::AutoCommit;
1570   local $FS::UID::AutoCommit = 0;
1571   my $dbh = dbh;
1572
1573   $self->select_for_update; #mutex
1574
1575   if ( $DEBUG ) {
1576     my $balance = $self->balance;
1577     warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1578   }
1579
1580 #  if ( exists($options{'retry_card'}) ) {
1581 #    carp 'retry_card option passed to collect is deprecated; use retry';
1582 #    $options{'retry'} ||= $options{'retry_card'};
1583 #  }
1584 #  if ( exists($options{'retry'}) && $options{'retry'} ) {
1585 #    my $error = $self->retry_realtime;
1586 #    if ( $error ) {
1587 #      $dbh->rollback if $oldAutoCommit;
1588 #      return $error;
1589 #    }
1590 #  }
1591
1592   # false laziness w/pay_batch::import_results
1593
1594   my $due_cust_event = $self->due_cust_event(
1595     'debug'      => ( $options{'debug'} || 0 ),
1596     'time'       => $time,
1597     'check_freq' => $options{'check_freq'},
1598     'stage'      => ( $options{'stage'} || 'collect' ),
1599   );
1600   unless( ref($due_cust_event) ) {
1601     $dbh->rollback if $oldAutoCommit;
1602     return $due_cust_event;
1603   }
1604
1605   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1606   #never want to roll back an event just because it or a different one
1607   # returned an error
1608   local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1609
1610   foreach my $cust_event ( @$due_cust_event ) {
1611
1612     #XXX lock event
1613
1614     #re-eval event conditions (a previous event could have changed things)
1615     unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1616       #don't leave stray "new/locked" records around
1617       my $error = $cust_event->delete;
1618       return $error if $error;
1619       next;
1620     }
1621
1622     {
1623       local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1624         if $options{'quiet'};
1625       warn "  running cust_event ". $cust_event->eventnum. "\n"
1626         if $DEBUG > 1;
1627
1628       #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1629       if ( my $error = $cust_event->do_event() ) {
1630         #XXX wtf is this?  figure out a proper dealio with return value
1631         #from do_event
1632         return $error;
1633       }
1634     }
1635
1636   }
1637
1638   '';
1639
1640 }
1641
1642 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1643
1644 Inserts database records for and returns an ordered listref of new events due
1645 for this customer, as FS::cust_event objects (see L<FS::cust_event>).  If no
1646 events are due, an empty listref is returned.  If there is an error, returns a
1647 scalar error message.
1648
1649 To actually run the events, call each event's test_condition method, and if
1650 still true, call the event's do_event method.
1651
1652 Options are passed as a hashref or as a list of name-value pairs.  Available
1653 options are:
1654
1655 =over 4
1656
1657 =item check_freq
1658
1659 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.
1660
1661 =item stage
1662
1663 "collect" (the default) or "pre-bill"
1664
1665 =item time
1666
1667 "Current time" for the events.
1668
1669 =item debug
1670
1671 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)
1672
1673 =item eventtable
1674
1675 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1676
1677 =item objects
1678
1679 Explicitly pass the objects to be tested (typically used with eventtable).
1680
1681 =item testonly
1682
1683 Set to true to return the objects, but not actually insert them into the
1684 database.
1685
1686 =back
1687
1688 =cut
1689
1690 sub due_cust_event {
1691   my $self = shift;
1692   my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1693
1694   #???
1695   #my $DEBUG = $opt{'debug'}
1696   local($DEBUG) = $opt{'debug'}
1697     if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1698   $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1699
1700   warn "$me due_cust_event called with options ".
1701        join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1702     if $DEBUG;
1703
1704   $opt{'time'} ||= time;
1705
1706   local $SIG{HUP} = 'IGNORE';
1707   local $SIG{INT} = 'IGNORE';
1708   local $SIG{QUIT} = 'IGNORE';
1709   local $SIG{TERM} = 'IGNORE';
1710   local $SIG{TSTP} = 'IGNORE';
1711   local $SIG{PIPE} = 'IGNORE';
1712
1713   my $oldAutoCommit = $FS::UID::AutoCommit;
1714   local $FS::UID::AutoCommit = 0;
1715   my $dbh = dbh;
1716
1717   $self->select_for_update #mutex
1718     unless $opt{testonly};
1719
1720   ###
1721   # find possible events (initial search)
1722   ###
1723
1724   my @cust_event = ();
1725
1726   my @eventtable = $opt{'eventtable'}
1727                      ? ( $opt{'eventtable'} )
1728                      : FS::part_event->eventtables_runorder;
1729
1730   my $check_freq = $opt{'check_freq'} || '1d';
1731
1732   foreach my $eventtable ( @eventtable ) {
1733
1734     my @objects;
1735     if ( $opt{'objects'} ) {
1736
1737       @objects = @{ $opt{'objects'} };
1738
1739     } else {
1740
1741       #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1742       if ( $eventtable eq 'cust_main' ) {
1743         @objects = ( $self );
1744       } else {
1745
1746         my $cm_join =
1747           "LEFT JOIN cust_main USING ( custnum )";
1748
1749         #some false laziness w/Cron::bill bill_where
1750
1751         my $join  = FS::part_event_condition->join_conditions_sql( $eventtable);
1752         my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1753                                                            'time'=>$opt{'time'},
1754                                                                   );
1755         $where = $where ? "AND $where" : '';
1756
1757         my $are_part_event =
1758           "EXISTS ( SELECT 1 FROM part_event $join
1759                       WHERE check_freq = '$check_freq'
1760                         AND eventtable = '$eventtable'
1761                         AND ( disabled = '' OR disabled IS NULL )
1762                         $where
1763                   )
1764           ";
1765         #eofalse
1766
1767         @objects = $self->$eventtable(
1768                      'addl_from' => $cm_join,
1769                      'extra_sql' => " AND $are_part_event",
1770                    );
1771       }
1772
1773     }
1774
1775     my @e_cust_event = ();
1776
1777     my $cross = "CROSS JOIN $eventtable";
1778     $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1779       unless $eventtable eq 'cust_main';
1780
1781     foreach my $object ( @objects ) {
1782
1783       #this first search uses the condition_sql magic for optimization.
1784       #the more possible events we can eliminate in this step the better
1785
1786       my $cross_where = '';
1787       my $pkey = $object->primary_key;
1788       $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1789
1790       my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1791       my $extra_sql =
1792         FS::part_event_condition->where_conditions_sql( $eventtable,
1793                                                         'time'=>$opt{'time'}
1794                                                       );
1795       my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1796
1797       $extra_sql = "AND $extra_sql" if $extra_sql;
1798
1799       #here is the agent virtualization
1800       $extra_sql .= " AND (    part_event.agentnum IS NULL
1801                             OR part_event.agentnum = ". $self->agentnum. ' )';
1802
1803       $extra_sql .= " $order";
1804
1805       warn "searching for events for $eventtable ". $object->$pkey. "\n"
1806         if $opt{'debug'} > 2;
1807       my @part_event = qsearch( {
1808         'debug'     => ( $opt{'debug'} > 3 ? 1 : 0 ),
1809         'select'    => 'part_event.*',
1810         'table'     => 'part_event',
1811         'addl_from' => "$cross $join",
1812         'hashref'   => { 'check_freq' => $check_freq,
1813                          'eventtable' => $eventtable,
1814                          'disabled'   => '',
1815                        },
1816         'extra_sql' => "AND $cross_where $extra_sql",
1817       } );
1818
1819       if ( $DEBUG > 2 ) {
1820         my $pkey = $object->primary_key;
1821         warn "      ". scalar(@part_event).
1822              " possible events found for $eventtable ". $object->$pkey(). "\n";
1823       }
1824
1825       push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1826
1827     }
1828
1829     warn "    ". scalar(@e_cust_event).
1830          " subtotal possible cust events found for $eventtable\n"
1831       if $DEBUG > 1;
1832
1833     push @cust_event, @e_cust_event;
1834
1835   }
1836
1837   warn "  ". scalar(@cust_event).
1838        " total possible cust events found in initial search\n"
1839     if $DEBUG; # > 1;
1840
1841
1842   ##
1843   # test stage
1844   ##
1845
1846   $opt{stage} ||= 'collect';
1847   @cust_event =
1848     grep { my $stage = $_->part_event->event_stage;
1849            $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1850          }
1851          @cust_event;
1852
1853   ##
1854   # test conditions
1855   ##
1856
1857   my %unsat = ();
1858
1859   @cust_event = grep $_->test_conditions( 'time'          => $opt{'time'},
1860                                           'stats_hashref' => \%unsat ),
1861                      @cust_event;
1862
1863   warn "  ". scalar(@cust_event). " cust events left satisfying conditions\n"
1864     if $DEBUG; # > 1;
1865
1866   warn "    invalid conditions not eliminated with condition_sql:\n".
1867        join('', map "      $_: ".$unsat{$_}."\n", keys %unsat )
1868     if keys %unsat && $DEBUG; # > 1;
1869
1870   ##
1871   # insert
1872   ##
1873
1874   unless( $opt{testonly} ) {
1875     foreach my $cust_event ( @cust_event ) {
1876
1877       my $error = $cust_event->insert();
1878       if ( $error ) {
1879         $dbh->rollback if $oldAutoCommit;
1880         return $error;
1881       }
1882
1883     }
1884   }
1885
1886   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1887
1888   ##
1889   # return
1890   ##
1891
1892   warn "  returning events: ". Dumper(@cust_event). "\n"
1893     if $DEBUG > 2;
1894
1895   \@cust_event;
1896
1897 }
1898
1899 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1900
1901 Applies unapplied payments and credits.
1902
1903 In most cases, this new method should be used in place of sequential
1904 apply_payments and apply_credits methods.
1905
1906 A hash of optional arguments may be passed.  Currently "manual" is supported.
1907 If true, a payment receipt is sent instead of a statement when
1908 'payment_receipt_email' configuration option is set.
1909
1910 If there is an error, returns the error, otherwise returns false.
1911
1912 =cut
1913
1914 sub apply_payments_and_credits {
1915   my( $self, %options ) = @_;
1916
1917   local $SIG{HUP} = 'IGNORE';
1918   local $SIG{INT} = 'IGNORE';
1919   local $SIG{QUIT} = 'IGNORE';
1920   local $SIG{TERM} = 'IGNORE';
1921   local $SIG{TSTP} = 'IGNORE';
1922   local $SIG{PIPE} = 'IGNORE';
1923
1924   my $oldAutoCommit = $FS::UID::AutoCommit;
1925   local $FS::UID::AutoCommit = 0;
1926   my $dbh = dbh;
1927
1928   $self->select_for_update; #mutex
1929
1930   foreach my $cust_bill ( $self->open_cust_bill ) {
1931     my $error = $cust_bill->apply_payments_and_credits(%options);
1932     if ( $error ) {
1933       $dbh->rollback if $oldAutoCommit;
1934       return "Error applying: $error";
1935     }
1936   }
1937
1938   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1939   ''; #no error
1940
1941 }
1942
1943 =item apply_credits OPTION => VALUE ...
1944
1945 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1946 to outstanding invoice balances in chronological order (or reverse
1947 chronological order if the I<order> option is set to B<newest>) and returns the
1948 value of any remaining unapplied credits available for refund (see
1949 L<FS::cust_refund>).
1950
1951 Dies if there is an error.
1952
1953 =cut
1954
1955 sub apply_credits {
1956   my $self = shift;
1957   my %opt = @_;
1958
1959   local $SIG{HUP} = 'IGNORE';
1960   local $SIG{INT} = 'IGNORE';
1961   local $SIG{QUIT} = 'IGNORE';
1962   local $SIG{TERM} = 'IGNORE';
1963   local $SIG{TSTP} = 'IGNORE';
1964   local $SIG{PIPE} = 'IGNORE';
1965
1966   my $oldAutoCommit = $FS::UID::AutoCommit;
1967   local $FS::UID::AutoCommit = 0;
1968   my $dbh = dbh;
1969
1970   $self->select_for_update; #mutex
1971
1972   unless ( $self->total_unapplied_credits ) {
1973     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1974     return 0;
1975   }
1976
1977   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1978       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1979
1980   my @invoices = $self->open_cust_bill;
1981   @invoices = sort { $b->_date <=> $a->_date } @invoices
1982     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1983
1984   if ( $conf->exists('pkg-balances') ) {
1985     # limit @credits to those w/ a pkgnum grepped from $self
1986     my %pkgnums = ();
1987     foreach my $i (@invoices) {
1988       foreach my $li ( $i->cust_bill_pkg ) {
1989         $pkgnums{$li->pkgnum} = 1;
1990       }
1991     }
1992     @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
1993   }
1994
1995   my $credit;
1996
1997   foreach my $cust_bill ( @invoices ) {
1998
1999     if ( !defined($credit) || $credit->credited == 0) {
2000       $credit = pop @credits or last;
2001     }
2002
2003     my $owed;
2004     if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2005       $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2006     } else {
2007       $owed = $cust_bill->owed;
2008     }
2009     unless ( $owed > 0 ) {
2010       push @credits, $credit;
2011       next;
2012     }
2013
2014     my $amount = min( $credit->credited, $owed );
2015
2016     my $cust_credit_bill = new FS::cust_credit_bill ( {
2017       'crednum' => $credit->crednum,
2018       'invnum'  => $cust_bill->invnum,
2019       'amount'  => $amount,
2020     } );
2021     $cust_credit_bill->pkgnum( $credit->pkgnum )
2022       if $conf->exists('pkg-balances') && $credit->pkgnum;
2023     my $error = $cust_credit_bill->insert;
2024     if ( $error ) {
2025       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2026       die $error;
2027     }
2028
2029     redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2030
2031   }
2032
2033   my $total_unapplied_credits = $self->total_unapplied_credits;
2034
2035   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2036
2037   return $total_unapplied_credits;
2038 }
2039
2040 =item apply_payments  [ OPTION => VALUE ... ]
2041
2042 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2043 to outstanding invoice balances in chronological order.
2044
2045  #and returns the value of any remaining unapplied payments.
2046
2047 A hash of optional arguments may be passed.  Currently "manual" is supported.
2048 If true, a payment receipt is sent instead of a statement when
2049 'payment_receipt_email' configuration option is set.
2050
2051 Dies if there is an error.
2052
2053 =cut
2054
2055 sub apply_payments {
2056   my( $self, %options ) = @_;
2057
2058   local $SIG{HUP} = 'IGNORE';
2059   local $SIG{INT} = 'IGNORE';
2060   local $SIG{QUIT} = 'IGNORE';
2061   local $SIG{TERM} = 'IGNORE';
2062   local $SIG{TSTP} = 'IGNORE';
2063   local $SIG{PIPE} = 'IGNORE';
2064
2065   my $oldAutoCommit = $FS::UID::AutoCommit;
2066   local $FS::UID::AutoCommit = 0;
2067   my $dbh = dbh;
2068
2069   $self->select_for_update; #mutex
2070
2071   #return 0 unless
2072
2073   my @payments = sort { $b->_date <=> $a->_date }
2074                  grep { $_->unapplied > 0 }
2075                  $self->cust_pay;
2076
2077   my @invoices = sort { $a->_date <=> $b->_date}
2078                  grep { $_->owed > 0 }
2079                  $self->cust_bill;
2080
2081   if ( $conf->exists('pkg-balances') ) {
2082     # limit @payments to those w/ a pkgnum grepped from $self
2083     my %pkgnums = ();
2084     foreach my $i (@invoices) {
2085       foreach my $li ( $i->cust_bill_pkg ) {
2086         $pkgnums{$li->pkgnum} = 1;
2087       }
2088     }
2089     @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2090   }
2091
2092   my $payment;
2093
2094   foreach my $cust_bill ( @invoices ) {
2095
2096     if ( !defined($payment) || $payment->unapplied == 0 ) {
2097       $payment = pop @payments or last;
2098     }
2099
2100     my $owed;
2101     if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2102       $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2103     } else {
2104       $owed = $cust_bill->owed;
2105     }
2106     unless ( $owed > 0 ) {
2107       push @payments, $payment;
2108       next;
2109     }
2110
2111     my $amount = min( $payment->unapplied, $owed );
2112
2113     my $cbp = {
2114       'paynum' => $payment->paynum,
2115       'invnum' => $cust_bill->invnum,
2116       'amount' => $amount,
2117     };
2118     $cbp->{_date} = $payment->_date
2119         if $options{'manual'} && $options{'backdate_application'};
2120     my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2121     $cust_bill_pay->pkgnum( $payment->pkgnum )
2122       if $conf->exists('pkg-balances') && $payment->pkgnum;
2123     my $error = $cust_bill_pay->insert(%options);
2124     if ( $error ) {
2125       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2126       die $error;
2127     }
2128
2129     redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2130
2131   }
2132
2133   my $total_unapplied_payments = $self->total_unapplied_payments;
2134
2135   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2136
2137   return $total_unapplied_payments;
2138 }
2139
2140 =back
2141
2142 =head1 BUGS
2143
2144 =head1 SEE ALSO
2145
2146 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>
2147
2148 =cut
2149
2150 1;