FS/FS/cust_bill.pm

   1 package FS::cust_bill;
   2 use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::Record );
   3
   4 use strict;
   5 use vars qw( $DEBUG $me $date_format );
   6              # but NOT $conf
   7 use Fcntl qw(:flock); #for spool_csv
   8 use Cwd;
   9 use List::Util qw(min max sum);
  10 use Date::Format;
  11 use File::Temp 0.14;
  12 use HTML::Entities;
  13 use Storable qw( freeze thaw );
  14 use GD::Barcode;
  15 use FS::UID qw( datasrc );
  16 use FS::Misc qw( send_email send_fax do_print );
  17 use FS::Record qw( qsearch qsearchs dbh );
  18 use FS::cust_main;
  19 use FS::cust_statement;
  20 use FS::cust_bill_pkg;
  21 use FS::cust_bill_pkg_display;
  22 use FS::cust_bill_pkg_detail;
  23 use FS::cust_credit;
  24 use FS::cust_pay;
  25 use FS::cust_pkg;
  26 use FS::cust_credit_bill;
  27 use FS::pay_batch;
  28 use FS::cust_pay_batch;
  29 use FS::cust_bill_event;
  30 use FS::cust_event;
  31 use FS::part_pkg;
  32 use FS::cust_bill_pay;
  33 use FS::cust_bill_pay_batch;
  34 use FS::part_bill_event;
  35 use FS::payby;
  36 use FS::bill_batch;
  37 use FS::cust_bill_batch;
  38 use FS::cust_bill_pay_pkg;
  39 use FS::cust_credit_bill_pkg;
  40 use FS::discount_plan;
  41 use FS::cust_bill_void;
  42 use FS::L10N;
  43
  44 $DEBUG = 0;
  45 $me = '[FS::cust_bill]';
  46
  47 #ask FS::UID to run this stuff for us later
  48 FS::UID->install_callback( sub {
  49   my $conf = new FS::Conf; #global
  50   $date_format      = $conf->config('date_format')      || '%x'; #/YY
  51 } );
  52
  53 =head1 NAME
  54
  55 FS::cust_bill - Object methods for cust_bill records
  56
  57 =head1 SYNOPSIS
  58
  59   use FS::cust_bill;
  60
  61   $record = new FS::cust_bill \%hash;
  62   $record = new FS::cust_bill { 'column' => 'value' };
  63
  64   $error = $record->insert;
  65
  66   $error = $new_record->replace($old_record);
  67
  68   $error = $record->delete;
  69
  70   $error = $record->check;
  71
  72   ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
  73
  74   @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
  75
  76   ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
  77
  78   @cust_pay_objects = $cust_bill->cust_pay;
  79
  80   $tax_amount = $record->tax;
  81
  82   @lines = $cust_bill->print_text;
  83   @lines = $cust_bill->print_text('time' => $time);
  84
  85 =head1 DESCRIPTION
  86
  87 An FS::cust_bill object represents an invoice; a declaration that a customer
  88 owes you money.  The specific charges are itemized as B<cust_bill_pkg> records
  89 (see L<FS::cust_bill_pkg>).  FS::cust_bill inherits from FS::Record.  The
  90 following fields are currently supported:
  91
  92 Regular fields
  93
  94 =over 4
  95
  96 =item invnum - primary key (assigned automatically for new invoices)
  97
  98 =item custnum - customer (see L<FS::cust_main>)
  99
 100 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
 101 L<Time::Local> and L<Date::Parse> for conversion functions.
 102
 103 =item charged - amount of this invoice
 104
 105 =item invoice_terms - optional terms override for this specific invoice
 106
 107 =back
 108
 109 Customer info at invoice generation time
 110
 111 =over 4
 112
 113 =item billing_balance - the customer's balance at the time the invoice was
 114 generated (not including charges on this invoice)
 115
 116 =item previous_balance - the billing_balance of this customer's previous
 117 invoice plus the charges on that invoice
 118
 119 =back
 120
 121 Deprecated
 122
 123 =over 4
 124
 125 =item printed - deprecated
 126
 127 =back
 128
 129 Specific use cases
 130
 131 =over 4
 132
 133 =item closed - books closed flag, empty or `Y'
 134
 135 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
 136
 137 =item agent_invid - legacy invoice number
 138
 139 =item promised_date - customer promised payment date, for collection
 140
 141 =back
 142
 143 =head1 METHODS
 144
 145 =over 4
 146
 147 =item new HASHREF
 148
 149 Creates a new invoice.  To add the invoice to the database, see L<"insert">.
 150 Invoices are normally created by calling the bill method of a customer object
 151 (see L<FS::cust_main>).
 152
 153 =cut
 154
 155 sub table { 'cust_bill'; }
 156
 157 # should be the ONLY occurrence of "Invoice" in invoice rendering code.
 158 # (except email_subject and invnum_date_pretty)
 159 sub notice_name {
 160   my $self = shift;
 161   $self->conf->config('notice_name') || 'Invoice'
 162 }
 163
 164 sub cust_linked { $_[0]->cust_main_custnum; }
 165 sub cust_unlinked_msg {
 166   my $self = shift;
 167   "WARNING: can't find cust_main.custnum ". $self->custnum.
 168   ' (cust_bill.invnum '. $self->invnum. ')';
 169 }
 170
 171 =item insert
 172
 173 Adds this invoice to the database ("Posts" the invoice).  If there is an error,
 174 returns the error, otherwise returns false.
 175
 176 =cut
 177
 178 sub insert {
 179   my $self = shift;
 180   warn "$me insert called\n" if $DEBUG;
 181
 182   local $SIG{HUP} = 'IGNORE';
 183   local $SIG{INT} = 'IGNORE';
 184   local $SIG{QUIT} = 'IGNORE';
 185   local $SIG{TERM} = 'IGNORE';
 186   local $SIG{TSTP} = 'IGNORE';
 187   local $SIG{PIPE} = 'IGNORE';
 188
 189   my $oldAutoCommit = $FS::UID::AutoCommit;
 190   local $FS::UID::AutoCommit = 0;
 191   my $dbh = dbh;
 192
 193   my $error = $self->SUPER::insert;
 194   if ( $error ) {
 195     $dbh->rollback if $oldAutoCommit;
 196     return $error;
 197   }
 198
 199   if ( $self->get('cust_bill_pkg') ) {
 200     foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
 201       $cust_bill_pkg->invnum($self->invnum);
 202       my $error = $cust_bill_pkg->insert;
 203       if ( $error ) {
 204         $dbh->rollback if $oldAutoCommit;
 205         return "can't create invoice line item: $error";
 206       }
 207     }
 208   }
 209
 210   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 211   '';
 212
 213 }
 214
 215 =item void
 216
 217 Voids this invoice: deletes the invoice and adds a record of the voided invoice
 218 to the FS::cust_bill_void table (and related tables starting from
 219 FS::cust_bill_pkg_void).
 220
 221 =cut
 222
 223 sub void {
 224   my $self = shift;
 225   my $reason = scalar(@_) ? shift : '';
 226
 227   local $SIG{HUP} = 'IGNORE';
 228   local $SIG{INT} = 'IGNORE';
 229   local $SIG{QUIT} = 'IGNORE';
 230   local $SIG{TERM} = 'IGNORE';
 231   local $SIG{TSTP} = 'IGNORE';
 232   local $SIG{PIPE} = 'IGNORE';
 233
 234   my $oldAutoCommit = $FS::UID::AutoCommit;
 235   local $FS::UID::AutoCommit = 0;
 236   my $dbh = dbh;
 237
 238   my $cust_bill_void = new FS::cust_bill_void ( {
 239     map { $_ => $self->get($_) } $self->fields
 240   } );
 241   $cust_bill_void->reason($reason);
 242   my $error = $cust_bill_void->insert;
 243   if ( $error ) {
 244     $dbh->rollback if $oldAutoCommit;
 245     return $error;
 246   }
 247
 248   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
 249     my $error = $cust_bill_pkg->void($reason);
 250     if ( $error ) {
 251       $dbh->rollback if $oldAutoCommit;
 252       return $error;
 253     }
 254   }
 255
 256   $error = $self->delete;
 257   if ( $error ) {
 258     $dbh->rollback if $oldAutoCommit;
 259     return $error;
 260   }
 261
 262   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 263
 264   '';
 265
 266 }
 267
 268 =item delete
 269
 270 This method now works but you probably shouldn't use it.  Instead, apply a
 271 credit against the invoice, or use the new void method.
 272
 273 Using this method to delete invoices outright is really, really bad.  There
 274 would be no record you ever posted this invoice, and there are no check to
 275 make sure charged = 0 or that there are no associated cust_bill_pkg records.
 276
 277 Really, don't use it.
 278
 279 =cut
 280
 281 sub delete {
 282   my $self = shift;
 283   return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
 284
 285   local $SIG{HUP} = 'IGNORE';
 286   local $SIG{INT} = 'IGNORE';
 287   local $SIG{QUIT} = 'IGNORE';
 288   local $SIG{TERM} = 'IGNORE';
 289   local $SIG{TSTP} = 'IGNORE';
 290   local $SIG{PIPE} = 'IGNORE';
 291
 292   my $oldAutoCommit = $FS::UID::AutoCommit;
 293   local $FS::UID::AutoCommit = 0;
 294   my $dbh = dbh;
 295
 296   foreach my $table (qw(
 297     cust_bill_event
 298     cust_event
 299     cust_credit_bill
 300     cust_bill_pay
 301     cust_pay_batch
 302     cust_bill_pay_batch
 303     cust_bill_batch
 304     cust_bill_pkg
 305   )) {
 306
 307     foreach my $linked ( $self->$table() ) {
 308       my $error = $linked->delete;
 309       if ( $error ) {
 310         $dbh->rollback if $oldAutoCommit;
 311         return $error;
 312       }
 313     }
 314
 315   }
 316
 317   my $error = $self->SUPER::delete(@_);
 318   if ( $error ) {
 319     $dbh->rollback if $oldAutoCommit;
 320     return $error;
 321   }
 322
 323   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 324
 325   '';
 326
 327 }
 328
 329 =item replace [ OLD_RECORD ]
 330
 331 You can, but probably shouldn't modify invoices...
 332
 333 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
 334 supplied, replaces this record.  If there is an error, returns the error,
 335 otherwise returns false.
 336
 337 =cut
 338
 339 #replace can be inherited from Record.pm
 340
 341 # replace_check is now the preferred way to #implement replace data checks
 342 # (so $object->replace() works without an argument)
 343
 344 sub replace_check {
 345   my( $new, $old ) = ( shift, shift );
 346   return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
 347   #return "Can't change _date!" unless $old->_date eq $new->_date;
 348   return "Can't change _date" unless $old->_date == $new->_date;
 349   return "Can't change charged" unless $old->charged == $new->charged
 350                                     || $old->charged == 0
 351                                     || $new->{'Hash'}{'cc_surcharge_replace_hack'};
 352
 353   '';
 354 }
 355
 356
 357 =item add_cc_surcharge
 358
 359 Giant hack
 360
 361 =cut
 362
 363 sub add_cc_surcharge {
 364     my ($self, $pkgnum, $amount) = (shift, shift, shift);
 365
 366     my $error;
 367     my $cust_bill_pkg = new FS::cust_bill_pkg({
 368                                     'invnum' => $self->invnum,
 369                                     'pkgnum' => $pkgnum,
 370                                     'setup' => $amount,
 371                         });
 372     $error = $cust_bill_pkg->insert;
 373     return $error if $error;
 374
 375     $self->{'Hash'}{'cc_surcharge_replace_hack'} = 1;
 376     $self->charged($self->charged+$amount);
 377     $error = $self->replace;
 378     return $error if $error;
 379
 380     $self->apply_payments_and_credits;
 381 }
 382
 383
 384 =item check
 385
 386 Checks all fields to make sure this is a valid invoice.  If there is an error,
 387 returns the error, otherwise returns false.  Called by the insert and replace
 388 methods.
 389
 390 =cut
 391
 392 sub check {
 393   my $self = shift;
 394
 395   my $error =
 396     $self->ut_numbern('invnum')
 397     || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
 398     || $self->ut_numbern('_date')
 399     || $self->ut_money('charged')
 400     || $self->ut_numbern('printed')
 401     || $self->ut_enum('closed', [ '', 'Y' ])
 402     || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
 403     || $self->ut_numbern('agent_invid') #varchar?
 404   ;
 405   return $error if $error;
 406
 407   $self->_date(time) unless $self->_date;
 408
 409   $self->printed(0) if $self->printed eq '';
 410
 411   $self->SUPER::check;
 412 }
 413
 414 =item display_invnum
 415
 416 Returns the displayed invoice number for this invoice: agent_invid if
 417 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
 418
 419 =cut
 420
 421 sub display_invnum {
 422   my $self = shift;
 423   my $conf = $self->conf;
 424   if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
 425     return $self->agent_invid;
 426   } else {
 427     return $self->invnum;
 428   }
 429 }
 430
 431 =item previous_bill
 432
 433 Returns the customer's last invoice before this one.
 434
 435 =cut
 436
 437 sub previous_bill {
 438   my $self = shift;
 439   if ( !$self->get('previous_bill') ) {
 440     $self->set('previous_bill', qsearchs({
 441           'table'     => 'cust_bill',
 442           'hashref'   => { 'custnum'  => $self->custnum,
 443                            '_date'    => { op=>'<', value=>$self->_date } },
 444           'order_by'  => 'ORDER BY _date DESC LIMIT 1',
 445     }) );
 446   }
 447   $self->get('previous_bill');
 448 }
 449
 450 =item previous
 451
 452 Returns a list consisting of the total previous balance for this customer,
 453 followed by the previous outstanding invoices (as FS::cust_bill objects also).
 454
 455 =cut
 456
 457 sub previous {
 458   my $self = shift;
 459   my $total = 0;
 460   my @cust_bill = sort { $a->_date <=> $b->_date }
 461     grep { $_->owed != 0 }
 462       qsearch( 'cust_bill', { 'custnum' => $self->custnum,
 463                               #'_date'   => { op=>'<', value=>$self->_date },
 464                               'invnum'   => { op=>'<', value=>$self->invnum },
 465                             } )
 466   ;
 467   foreach ( @cust_bill ) { $total += $_->owed; }
 468   $total, @cust_bill;
 469 }
 470
 471 =item enable_previous
 472
 473 Whether to show the 'Previous Charges' section when printing this invoice.
 474 The negation of the 'disable_previous_balance' config setting.
 475
 476 =cut
 477
 478 sub enable_previous {
 479   my $self = shift;
 480   my $agentnum = $self->cust_main->agentnum;
 481   !$self->conf->exists('disable_previous_balance', $agentnum);
 482 }
 483
 484 =item cust_bill_pkg
 485
 486 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
 487
 488 =cut
 489
 490 sub cust_bill_pkg {
 491   my $self = shift;
 492   qsearch(
 493     { 'table'    => 'cust_bill_pkg',
 494       'hashref'  => { 'invnum' => $self->invnum },
 495       'order_by' => 'ORDER BY billpkgnum',
 496     }
 497   );
 498 }
 499
 500 =item cust_bill_pkg_pkgnum PKGNUM
 501
 502 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
 503 specified pkgnum.
 504
 505 =cut
 506
 507 sub cust_bill_pkg_pkgnum {
 508   my( $self, $pkgnum ) = @_;
 509   qsearch(
 510     { 'table'    => 'cust_bill_pkg',
 511       'hashref'  => { 'invnum' => $self->invnum,
 512                       'pkgnum' => $pkgnum,
 513                     },
 514       'order_by' => 'ORDER BY billpkgnum',
 515     }
 516   );
 517 }
 518
 519 =item cust_pkg
 520
 521 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
 522 this invoice.
 523
 524 =cut
 525
 526 sub cust_pkg {
 527   my $self = shift;
 528   my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
 529                      $self->cust_bill_pkg;
 530   my %saw = ();
 531   grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
 532 }
 533
 534 =item no_auto
 535
 536 Returns true if any of the packages (or their definitions) corresponding to the
 537 line items for this invoice have the no_auto flag set.
 538
 539 =cut
 540
 541 sub no_auto {
 542   my $self = shift;
 543   grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
 544 }
 545
 546 =item open_cust_bill_pkg
 547
 548 Returns the open line items for this invoice.
 549
 550 Note that cust_bill_pkg with both setup and recur fees are returned as two
 551 separate line items, each with only one fee.
 552
 553 =cut
 554
 555 # modeled after cust_main::open_cust_bill
 556 sub open_cust_bill_pkg {
 557   my $self = shift;
 558
 559   # grep { $_->owed > 0 } $self->cust_bill_pkg
 560
 561   my %other = ( 'recur' => 'setup',
 562                 'setup' => 'recur', );
 563   my @open = ();
 564   foreach my $field ( qw( recur setup )) {
 565     push @open, map  { $_->set( $other{$field}, 0 ); $_; }
 566                 grep { $_->owed($field) > 0 }
 567                 $self->cust_bill_pkg;
 568   }
 569
 570   @open;
 571 }
 572
 573 =item cust_bill_event
 574
 575 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
 576
 577 =cut
 578
 579 sub cust_bill_event {
 580   my $self = shift;
 581   qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
 582 }
 583
 584 =item num_cust_bill_event
 585
 586 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
 587
 588 =cut
 589
 590 sub num_cust_bill_event {
 591   my $self = shift;
 592   my $sql =
 593     "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
 594   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
 595   $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
 596   $sth->fetchrow_arrayref->[0];
 597 }
 598
 599 =item cust_event
 600
 601 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
 602
 603 =cut
 604
 605 #false laziness w/cust_pkg.pm
 606 sub cust_event {
 607   my $self = shift;
 608   qsearch({
 609     'table'     => 'cust_event',
 610     'addl_from' => 'JOIN part_event USING ( eventpart )',
 611     'hashref'   => { 'tablenum' => $self->invnum },
 612     'extra_sql' => " AND eventtable = 'cust_bill' ",
 613   });
 614 }
 615
 616 =item num_cust_event
 617
 618 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
 619
 620 =cut
 621
 622 #false laziness w/cust_pkg.pm
 623 sub num_cust_event {
 624   my $self = shift;
 625   my $sql =
 626     "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
 627     "  WHERE tablenum = ? AND eventtable = 'cust_bill'";
 628   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
 629   $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
 630   $sth->fetchrow_arrayref->[0];
 631 }
 632
 633 =item cust_main
 634
 635 Returns the customer (see L<FS::cust_main>) for this invoice.
 636
 637 =cut
 638
 639 sub cust_main {
 640   my $self = shift;
 641   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 642 }
 643
 644 =item cust_suspend_if_balance_over AMOUNT
 645
 646 Suspends the customer associated with this invoice if the total amount owed on
 647 this invoice and all older invoices is greater than the specified amount.
 648
 649 Returns a list: an empty list on success or a list of errors.
 650
 651 =cut
 652
 653 sub cust_suspend_if_balance_over {
 654   my( $self, $amount ) = ( shift, shift );
 655   my $cust_main = $self->cust_main;
 656   if ( $cust_main->total_owed_date($self->_date) < $amount ) {
 657     return ();
 658   } else {
 659     $cust_main->suspend(@_);
 660   }
 661 }
 662
 663 =item cust_credit
 664
 665 Depreciated.  See the cust_credited method.
 666
 667  #Returns a list consisting of the total previous credited (see
 668  #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
 669  #outstanding credits (FS::cust_credit objects).
 670
 671 =cut
 672
 673 sub cust_credit {
 674   use Carp;
 675   croak "FS::cust_bill->cust_credit depreciated; see ".
 676         "FS::cust_bill->cust_credit_bill";
 677   #my $self = shift;
 678   #my $total = 0;
 679   #my @cust_credit = sort { $a->_date <=> $b->_date }
 680   #  grep { $_->credited != 0 && $_->_date < $self->_date }
 681   #    qsearch('cust_credit', { 'custnum' => $self->custnum } )
 682   #;
 683   #foreach (@cust_credit) { $total += $_->credited; }
 684   #$total, @cust_credit;
 685 }
 686
 687 =item cust_pay
 688
 689 Depreciated.  See the cust_bill_pay method.
 690
 691 #Returns all payments (see L<FS::cust_pay>) for this invoice.
 692
 693 =cut
 694
 695 sub cust_pay {
 696   use Carp;
 697   croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
 698   #my $self = shift;
 699   #sort { $a->_date <=> $b->_date }
 700   #  qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
 701   #;
 702 }
 703
 704 sub cust_pay_batch {
 705   my $self = shift;
 706   qsearch('cust_pay_batch', { 'invnum' => $self->invnum } );
 707 }
 708
 709 sub cust_bill_pay_batch {
 710   my $self = shift;
 711   qsearch('cust_bill_pay_batch', { 'invnum' => $self->invnum } );
 712 }
 713
 714 =item cust_bill_pay
 715
 716 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
 717
 718 =cut
 719
 720 sub cust_bill_pay {
 721   my $self = shift;
 722   map { $_ } #return $self->num_cust_bill_pay unless wantarray;
 723   sort { $a->_date <=> $b->_date }
 724     qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
 725 }
 726
 727 =item cust_credited
 728
 729 =item cust_credit_bill
 730
 731 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
 732
 733 =cut
 734
 735 sub cust_credited {
 736   my $self = shift;
 737   map { $_ } #return $self->num_cust_credit_bill unless wantarray;
 738   sort { $a->_date <=> $b->_date }
 739     qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
 740   ;
 741 }
 742
 743 sub cust_credit_bill {
 744   shift->cust_credited(@_);
 745 }
 746
 747 #=item cust_bill_pay_pkgnum PKGNUM
 748 #
 749 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
 750 #with matching pkgnum.
 751 #
 752 #=cut
 753 #
 754 #sub cust_bill_pay_pkgnum {
 755 #  my( $self, $pkgnum ) = @_;
 756 #  map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
 757 #  sort { $a->_date <=> $b->_date }
 758 #    qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
 759 #                                'pkgnum' => $pkgnum,
 760 #                              }
 761 #           );
 762 #}
 763
 764 =item cust_bill_pay_pkg PKGNUM
 765
 766 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
 767 applied against the matching pkgnum.
 768
 769 =cut
 770
 771 sub cust_bill_pay_pkg {
 772   my( $self, $pkgnum ) = @_;
 773
 774   qsearch({
 775     'select'    => 'cust_bill_pay_pkg.*',
 776     'table'     => 'cust_bill_pay_pkg',
 777     'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
 778                    ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
 779     'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
 780                    "   AND cust_bill_pkg.pkgnum = $pkgnum",
 781   });
 782
 783 }
 784
 785 #=item cust_credited_pkgnum PKGNUM
 786 #
 787 #=item cust_credit_bill_pkgnum PKGNUM
 788 #
 789 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
 790 #with matching pkgnum.
 791 #
 792 #=cut
 793 #
 794 #sub cust_credited_pkgnum {
 795 #  my( $self, $pkgnum ) = @_;
 796 #  map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
 797 #  sort { $a->_date <=> $b->_date }
 798 #    qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
 799 #                                   'pkgnum' => $pkgnum,
 800 #                                 }
 801 #           );
 802 #}
 803 #
 804 #sub cust_credit_bill_pkgnum {
 805 #  shift->cust_credited_pkgnum(@_);
 806 #}
 807
 808 =item cust_credit_bill_pkg PKGNUM
 809
 810 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
 811 applied against the matching pkgnum.
 812
 813 =cut
 814
 815 sub cust_credit_bill_pkg {
 816   my( $self, $pkgnum ) = @_;
 817
 818   qsearch({
 819     'select'    => 'cust_credit_bill_pkg.*',
 820     'table'     => 'cust_credit_bill_pkg',
 821     'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
 822                    ' LEFT JOIN cust_bill_pkg    USING ( billpkgnum    ) ',
 823     'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
 824                    "   AND cust_bill_pkg.pkgnum = $pkgnum",
 825   });
 826
 827 }
 828
 829 =item cust_bill_batch
 830
 831 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
 832
 833 =cut
 834
 835 sub cust_bill_batch {
 836   my $self = shift;
 837   qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
 838 }
 839
 840 =item discount_plans
 841
 842 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
 843 hash keyed by term length.
 844
 845 =cut
 846
 847 sub discount_plans {
 848   my $self = shift;
 849   FS::discount_plan->all($self);
 850 }
 851
 852 =item tax
 853
 854 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
 855
 856 =cut
 857
 858 sub tax {
 859   my $self = shift;
 860   my $total = 0;
 861   my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
 862                                              'pkgnum' => 0 } );
 863   foreach (@taxlines) { $total += $_->setup; }
 864   $total;
 865 }
 866
 867 =item owed
 868
 869 Returns the amount owed (still outstanding) on this invoice, which is charged
 870 minus all payment applications (see L<FS::cust_bill_pay>) and credit
 871 applications (see L<FS::cust_credit_bill>).
 872
 873 =cut
 874
 875 sub owed {
 876   my $self = shift;
 877   my $balance = $self->charged;
 878   $balance -= $_->amount foreach ( $self->cust_bill_pay );
 879   $balance -= $_->amount foreach ( $self->cust_credited );
 880   $balance = sprintf( "%.2f", $balance);
 881   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
 882   $balance;
 883 }
 884
 885 sub owed_pkgnum {
 886   my( $self, $pkgnum ) = @_;
 887
 888   #my $balance = $self->charged;
 889   my $balance = 0;
 890   $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
 891
 892   $balance -= $_->amount            for $self->cust_bill_pay_pkg($pkgnum);
 893   $balance -= $_->amount            for $self->cust_credit_bill_pkg($pkgnum);
 894
 895   $balance = sprintf( "%.2f", $balance);
 896   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
 897   $balance;
 898 }
 899
 900 =item hide
 901
 902 Returns true if this invoice should be hidden.  See the
 903 selfservice-hide_invoices-taxclass configuraiton setting.
 904
 905 =cut
 906
 907 sub hide {
 908   my $self = shift;
 909   my $conf = $self->conf;
 910   my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
 911     or return '';
 912   my @cust_bill_pkg = $self->cust_bill_pkg;
 913   my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
 914   ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
 915 }
 916
 917 =item apply_payments_and_credits [ OPTION => VALUE ... ]
 918
 919 Applies unapplied payments and credits to this invoice.
 920
 921 A hash of optional arguments may be passed.  Currently "manual" is supported.
 922 If true, a payment receipt is sent instead of a statement when
 923 'payment_receipt_email' configuration option is set.
 924
 925 If there is an error, returns the error, otherwise returns false.
 926
 927 =cut
 928
 929 sub apply_payments_and_credits {
 930   my( $self, %options ) = @_;
 931   my $conf = $self->conf;
 932
 933   local $SIG{HUP} = 'IGNORE';
 934   local $SIG{INT} = 'IGNORE';
 935   local $SIG{QUIT} = 'IGNORE';
 936   local $SIG{TERM} = 'IGNORE';
 937   local $SIG{TSTP} = 'IGNORE';
 938   local $SIG{PIPE} = 'IGNORE';
 939
 940   my $oldAutoCommit = $FS::UID::AutoCommit;
 941   local $FS::UID::AutoCommit = 0;
 942   my $dbh = dbh;
 943
 944   $self->select_for_update; #mutex
 945
 946   my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
 947   my @credits  = grep { $_->credited > 0 } $self->cust_main->cust_credit;
 948
 949   if ( $conf->exists('pkg-balances') ) {
 950     # limit @payments & @credits to those w/ a pkgnum grepped from $self
 951     my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
 952     @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
 953     @credits  = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
 954   }
 955
 956   while ( $self->owed > 0 and ( @payments || @credits ) ) {
 957
 958     my $app = '';
 959     if ( @payments && @credits ) {
 960
 961       #decide which goes first by weight of top (unapplied) line item
 962
 963       my @open_lineitems = $self->open_cust_bill_pkg;
 964
 965       my $max_pay_weight =
 966         max( map  { $_->part_pkg->pay_weight || 0 }
 967              grep { $_ }
 968              map  { $_->cust_pkg }
 969                   @open_lineitems
 970            );
 971       my $max_credit_weight =
 972         max( map  { $_->part_pkg->credit_weight || 0 }
 973              grep { $_ }
 974              map  { $_->cust_pkg }
 975                   @open_lineitems
 976            );
 977
 978       #if both are the same... payments first?  it has to be something
 979       if ( $max_pay_weight >= $max_credit_weight ) {
 980         $app = 'pay';
 981       } else {
 982         $app = 'credit';
 983       }
 984
 985     } elsif ( @payments ) {
 986       $app = 'pay';
 987     } elsif ( @credits ) {
 988       $app = 'credit';
 989     } else {
 990       die "guru meditation #12 and 35";
 991     }
 992
 993     my $unapp_amount;
 994     if ( $app eq 'pay' ) {
 995
 996       my $payment = shift @payments;
 997       $unapp_amount = $payment->unapplied;
 998       $app = new FS::cust_bill_pay { 'paynum'  => $payment->paynum };
 999       $app->pkgnum( $payment->pkgnum )
1000         if $conf->exists('pkg-balances') && $payment->pkgnum;
1001
1002     } elsif ( $app eq 'credit' ) {
1003
1004       my $credit = shift @credits;
1005       $unapp_amount = $credit->credited;
1006       $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
1007       $app->pkgnum( $credit->pkgnum )
1008         if $conf->exists('pkg-balances') && $credit->pkgnum;
1009
1010     } else {
1011       die "guru meditation #12 and 35";
1012     }
1013
1014     my $owed;
1015     if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
1016       warn "owed_pkgnum ". $app->pkgnum;
1017       $owed = $self->owed_pkgnum($app->pkgnum);
1018     } else {
1019       $owed = $self->owed;
1020     }
1021     next unless $owed > 0;
1022
1023     warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
1024     $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
1025
1026     $app->invnum( $self->invnum );
1027
1028     my $error = $app->insert(%options);
1029     if ( $error ) {
1030       $dbh->rollback if $oldAutoCommit;
1031       return "Error inserting ". $app->table. " record: $error";
1032     }
1033     die $error if $error;
1034
1035   }
1036
1037   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1038   ''; #no error
1039
1040 }
1041
1042 =item generate_email OPTION => VALUE ...
1043
1044 Options:
1045
1046 =over 4
1047
1048 =item from
1049
1050 sender address, required
1051
1052 =item template
1053
1054 alternate template name, optional
1055
1056 =item print_text
1057
1058 text attachment arrayref, optional
1059
1060 =item subject
1061
1062 email subject, optional
1063
1064 =item notice_name
1065
1066 notice name instead of "Invoice", optional
1067
1068 =back
1069
1070 Returns an argument list to be passed to L<FS::Misc::send_email>.
1071
1072 =cut
1073
1074 use MIME::Entity;
1075
1076 sub generate_email {
1077
1078   my $self = shift;
1079   my %args = @_;
1080   my $conf = $self->conf;
1081
1082   my $me = '[FS::cust_bill::generate_email]';
1083
1084   my %return = (
1085     'from'      => $args{'from'},
1086     'subject'   => ($args{'subject'} || $self->email_subject),
1087   );
1088
1089   $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
1090
1091   my $cust_main = $self->cust_main;
1092
1093   if (ref($args{'to'}) eq 'ARRAY') {
1094     $return{'to'} = $args{'to'};
1095   } else {
1096     $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
1097                            $cust_main->invoicing_list
1098                     ];
1099   }
1100
1101   if ( $conf->exists('invoice_html') ) {
1102
1103     warn "$me creating HTML/text multipart message"
1104       if $DEBUG;
1105
1106     $return{'nobody'} = 1;
1107
1108     my $alternative = build MIME::Entity
1109       'Type'        => 'multipart/alternative',
1110       #'Encoding'    => '7bit',
1111       'Disposition' => 'inline'
1112     ;
1113
1114     my $data;
1115     if ( $conf->exists('invoice_email_pdf')
1116          and scalar($conf->config('invoice_email_pdf_note')) ) {
1117
1118       warn "$me using 'invoice_email_pdf_note' in multipart message"
1119         if $DEBUG;
1120       $data = [ map { $_ . "\n" }
1121                     $conf->config('invoice_email_pdf_note')
1122               ];
1123
1124     } else {
1125
1126       warn "$me not using 'invoice_email_pdf_note' in multipart message"
1127         if $DEBUG;
1128       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1129         $data = $args{'print_text'};
1130       } else {
1131         $data = [ $self->print_text(\%args) ];
1132       }
1133
1134     }
1135
1136     $alternative->attach(
1137       'Type'        => 'text/plain',
1138       'Encoding'    => 'quoted-printable',
1139       #'Encoding'    => '7bit',
1140       'Data'        => $data,
1141       'Disposition' => 'inline',
1142     );
1143
1144
1145     my $htmldata;
1146     my $image = '';
1147     my $barcode = '';
1148     if ( $conf->exists('invoice_email_pdf')
1149          and scalar($conf->config('invoice_email_pdf_note')) ) {
1150
1151       $htmldata = join('<BR>', $conf->config('invoice_email_pdf_note') );
1152
1153     } else {
1154
1155       $args{'from'} =~ /\@([\w\.\-]+)/;
1156       my $from = $1 || 'example.com';
1157       my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1158
1159       my $logo;
1160       my $agentnum = $cust_main->agentnum;
1161       if ( defined($args{'template'}) && length($args{'template'})
1162            && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
1163          )
1164       {
1165         $logo = 'logo_'. $args{'template'}. '.png';
1166       } else {
1167         $logo = "logo.png";
1168       }
1169       my $image_data = $conf->config_binary( $logo, $agentnum);
1170
1171       $image = build MIME::Entity
1172         'Type'       => 'image/png',
1173         'Encoding'   => 'base64',
1174         'Data'       => $image_data,
1175         'Filename'   => 'logo.png',
1176         'Content-ID' => "<$content_id>",
1177       ;
1178
1179       if ($conf->exists('invoice-barcode')) {
1180         my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1181         $barcode = build MIME::Entity
1182           'Type'       => 'image/png',
1183           'Encoding'   => 'base64',
1184           'Data'       => $self->invoice_barcode(0),
1185           'Filename'   => 'barcode.png',
1186           'Content-ID' => "<$barcode_content_id>",
1187         ;
1188         $args{'barcode_cid'} = $barcode_content_id;
1189       }
1190
1191       $htmldata = $self->print_html({ 'cid'=>$content_id, %args });
1192     }
1193
1194     $alternative->attach(
1195       'Type'        => 'text/html',
1196       'Encoding'    => 'quoted-printable',
1197       'Data'        => [ '<html>',
1198                          '  <head>',
1199                          '    <title>',
1200                          '      '. encode_entities($return{'subject'}),
1201                          '    </title>',
1202                          '  </head>',
1203                          '  <body bgcolor="#e8e8e8">',
1204                          $htmldata,
1205                          '  </body>',
1206                          '</html>',
1207                        ],
1208       'Disposition' => 'inline',
1209       #'Filename'    => 'invoice.pdf',
1210     );
1211
1212
1213     my @otherparts = ();
1214     if ( $cust_main->email_csv_cdr ) {
1215
1216       push @otherparts, build MIME::Entity
1217         'Type'        => 'text/csv',
1218         'Encoding'    => '7bit',
1219         'Data'        => [ map { "$_\n" }
1220                              $self->call_details('prepend_billed_number' => 1)
1221                          ],
1222         'Disposition' => 'attachment',
1223         'Filename'    => 'usage-'. $self->invnum. '.csv',
1224       ;
1225
1226     }
1227
1228     if ( $conf->exists('invoice_email_pdf') ) {
1229
1230       #attaching pdf too:
1231       # multipart/mixed
1232       #   multipart/related
1233       #     multipart/alternative
1234       #       text/plain
1235       #       text/html
1236       #     image/png
1237       #   application/pdf
1238
1239       my $related = build MIME::Entity 'Type'     => 'multipart/related',
1240                                        'Encoding' => '7bit';
1241
1242       #false laziness w/Misc::send_email
1243       $related->head->replace('Content-type',
1244         $related->mime_type.
1245         '; boundary="'. $related->head->multipart_boundary. '"'.
1246         '; type=multipart/alternative'
1247       );
1248
1249       $related->add_part($alternative);
1250
1251       $related->add_part($image) if $image;
1252
1253       my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
1254
1255       $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
1256
1257     } else {
1258
1259       #no other attachment:
1260       # multipart/related
1261       #   multipart/alternative
1262       #     text/plain
1263       #     text/html
1264       #   image/png
1265
1266       $return{'content-type'} = 'multipart/related';
1267       if ($conf->exists('invoice-barcode') && $barcode) {
1268         $return{'mimeparts'} = [ $alternative, $image, $barcode, @otherparts ];
1269       } else {
1270         $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
1271       }
1272       $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
1273       #$return{'disposition'} = 'inline';
1274
1275     }
1276
1277   } else {
1278
1279     if ( $conf->exists('invoice_email_pdf') ) {
1280       warn "$me creating PDF attachment"
1281         if $DEBUG;
1282
1283       #mime parts arguments a la MIME::Entity->build().
1284       $return{'mimeparts'} = [
1285         { $self->mimebuild_pdf(\%args) }
1286       ];
1287     }
1288
1289     if ( $conf->exists('invoice_email_pdf')
1290          and scalar($conf->config('invoice_email_pdf_note')) ) {
1291
1292       warn "$me using 'invoice_email_pdf_note'"
1293         if $DEBUG;
1294       $return{'body'} = [ map { $_ . "\n" }
1295                               $conf->config('invoice_email_pdf_note')
1296                         ];
1297
1298     } else {
1299
1300       warn "$me not using 'invoice_email_pdf_note'"
1301         if $DEBUG;
1302       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1303         $return{'body'} = $args{'print_text'};
1304       } else {
1305         $return{'body'} = [ $self->print_text(\%args) ];
1306       }
1307
1308     }
1309
1310   }
1311
1312   %return;
1313
1314 }
1315
1316 =item mimebuild_pdf
1317
1318 Returns a list suitable for passing to MIME::Entity->build(), representing
1319 this invoice as PDF attachment.
1320
1321 =cut
1322
1323 sub mimebuild_pdf {
1324   my $self = shift;
1325   (
1326     'Type'        => 'application/pdf',
1327     'Encoding'    => 'base64',
1328     'Data'        => [ $self->print_pdf(@_) ],
1329     'Disposition' => 'attachment',
1330     'Filename'    => 'invoice-'. $self->invnum. '.pdf',
1331   );
1332 }
1333
1334 =item send HASHREF
1335
1336 Sends this invoice to the destinations configured for this customer: sends
1337 email, prints and/or faxes.  See L<FS::cust_main_invoice>.
1338
1339 Options can be passed as a hashref.  Positional parameters are no longer
1340 allowed.
1341
1342 I<template>: a suffix for alternate invoices
1343
1344 I<agentnum>: obsolete, now does nothing.
1345
1346 I<invoice_from> overrides the default email invoice From: address.
1347
1348 I<amount>: obsolete, does nothing
1349
1350 I<notice_name> overrides "Invoice" as the name of the sent document
1351 (templates from 10/2009 or newer required).
1352
1353 I<lpr> overrides the system 'lpr' option as the command to print a document
1354 from standard input.
1355
1356 =cut
1357
1358 sub send {
1359   my $self = shift;
1360   my $opt = ref($_[0]) ? $_[0] : +{ @_ };
1361   my $conf = $self->conf;
1362
1363   my $cust_main = $self->cust_main;
1364
1365   my @invoicing_list = $cust_main->invoicing_list;
1366
1367   $self->email($opt)
1368     if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list )
1369     && ! $self->invoice_noemail;
1370
1371   $self->print($opt)
1372     if grep { $_ eq 'POST' } @invoicing_list; #postal
1373
1374   #this has never been used post-$ORIGINAL_ISP afaik
1375   $self->fax_invoice($opt)
1376     if grep { $_ eq 'FAX' } @invoicing_list; #fax
1377
1378   '';
1379
1380 }
1381
1382 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1383
1384 Sends this invoice to the customer's email destination(s).
1385
1386 Options must be passed as a hashref.  Positional parameters are no longer
1387 allowed.
1388
1389 I<template>, if specified, is the name of a suffix for alternate invoices.
1390
1391 I<invoice_from>, if specified, overrides the default email invoice From:
1392 address.
1393
1394 I<notice_name> is the name of the sent document.
1395
1396 =cut
1397
1398 sub queueable_email {
1399   my %opt = @_;
1400
1401   my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1402     or die "invalid invoice number: " . $opt{invnum};
1403
1404   my %args = map {$_ => $opt{$_}}
1405              grep { $opt{$_} }
1406               qw( invoice_from notice_name no_coupon template );
1407
1408   my $error = $self->email( \%args );
1409   die $error if $error;
1410
1411 }
1412
1413 sub email {
1414   my $self = shift;
1415   return if $self->hide;
1416   my $conf = $self->conf;
1417   my $opt = shift;
1418   if ($opt and !ref($opt)) {
1419     die "FS::cust_bill::email called with positional parameters";
1420   }
1421
1422   my $template = $opt->{template};
1423   my $from = delete $opt->{invoice_from};
1424
1425   # this is where we set the From: address
1426   $from ||= $self->_agent_invoice_from ||    #XXX should go away
1427             $conf->config('invoice_from', $self->cust_main->agentnum );
1428
1429   my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1430                             $self->cust_main->invoicing_list;
1431
1432   if ( ! @invoicing_list ) { #no recipients
1433     if ( $conf->exists('cust_bill-no_recipients-error') ) {
1434       die 'No recipients for customer #'. $self->custnum;
1435     } else {
1436       #default: better to notify this person than silence
1437       @invoicing_list = ($from);
1438     }
1439   }
1440
1441   # this is where we set the Subject:
1442   my $subject = $self->email_subject($template);
1443
1444   my $error = send_email(
1445     $self->generate_email(
1446       'from'        => $from,
1447       'to'          => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1448       'subject'     => $subject,
1449       %$opt, # template, etc.
1450     )
1451   );
1452   die "can't email invoice: $error\n" if $error;
1453   #die "$error\n" if $error;
1454
1455 }
1456
1457 sub email_subject {
1458   my $self = shift;
1459   my $conf = $self->conf;
1460
1461   #my $template = scalar(@_) ? shift : '';
1462   #per-template?
1463
1464   my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1465                 || 'Invoice';
1466
1467   my $cust_main = $self->cust_main;
1468   my $name = $cust_main->name;
1469   my $name_short = $cust_main->name_short;
1470   my $invoice_number = $self->invnum;
1471   my $invoice_date = $self->_date_pretty;
1472
1473   eval qq("$subject");
1474 }
1475
1476 =item lpr_data HASHREF
1477
1478 Returns the postscript or plaintext for this invoice as an arrayref.
1479
1480 Options must be passed as a hashref.  Positional parameters are no longer
1481 allowed.
1482
1483 I<template>, if specified, is the name of a suffix for alternate invoices.
1484
1485 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1486
1487 =cut
1488
1489 sub lpr_data {
1490   my $self = shift;
1491   my $conf = $self->conf;
1492   my $opt = shift;
1493   if ($opt and !ref($opt)) {
1494     # nobody does this anyway
1495     die "FS::cust_bill::lpr_data called with positional parameters";
1496   }
1497
1498   my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1499   [ $self->$method( $opt ) ];
1500 }
1501
1502 =item print HASHREF
1503
1504 Prints this invoice.
1505
1506 Options must be passed as a hashref.
1507
1508 I<template>, if specified, is the name of a suffix for alternate invoices.
1509
1510 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1511
1512 =cut
1513
1514 sub print {
1515   my $self = shift;
1516   return if $self->hide;
1517   my $conf = $self->conf;
1518   my $opt = shift;
1519   if ($opt and !ref($opt)) {
1520     die "FS::cust_bill::print called with positional parameters";
1521   }
1522
1523   my $lpr = delete $opt->{lpr};
1524   if($conf->exists('invoice_print_pdf')) {
1525     # Add the invoice to the current batch.
1526     $self->batch_invoice($opt);
1527   }
1528   else {
1529     do_print(
1530       $self->lpr_data($opt),
1531       'agentnum' => $self->cust_main->agentnum,
1532       'lpr'      => $lpr,
1533     );
1534   }
1535 }
1536
1537 =item fax_invoice HASHREF
1538
1539 Faxes this invoice.
1540
1541 Options must be passed as a hashref.
1542
1543 I<template>, if specified, is the name of a suffix for alternate invoices.
1544
1545 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1546
1547 =cut
1548
1549 sub fax_invoice {
1550   my $self = shift;
1551   return if $self->hide;
1552   my $conf = $self->conf;
1553   my $opt = shift;
1554   if ($opt and !ref($opt)) {
1555     die "FS::cust_bill::fax_invoice called with positional parameters";
1556   }
1557
1558   die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1559     unless $conf->exists('invoice_latex');
1560
1561   my $dialstring = $self->cust_main->getfield('fax');
1562   #Check $dialstring?
1563
1564   my $error = send_fax( 'docdata'    => $self->lpr_data($opt),
1565                         'dialstring' => $dialstring,
1566                       );
1567   die $error if $error;
1568
1569 }
1570
1571 =item batch_invoice [ HASHREF ]
1572
1573 Place this invoice into the open batch (see C<FS::bill_batch>).  If there
1574 isn't an open batch, one will be created.
1575
1576 =cut
1577
1578 sub batch_invoice {
1579   my ($self, $opt) = @_;
1580   my $bill_batch = $self->get_open_bill_batch;
1581   my $cust_bill_batch = FS::cust_bill_batch->new({
1582       batchnum => $bill_batch->batchnum,
1583       invnum   => $self->invnum,
1584   });
1585   return $cust_bill_batch->insert($opt);
1586 }
1587
1588 =item get_open_batch
1589
1590 Returns the currently open batch as an FS::bill_batch object, creating a new
1591 one if necessary.  (A per-agent batch if invoice_print_pdf-spoolagent is
1592 enabled)
1593
1594 =cut
1595
1596 sub get_open_bill_batch {
1597   my $self = shift;
1598   my $conf = $self->conf;
1599   my $hashref = { status => 'O' };
1600   $hashref->{'agentnum'} = $conf->exists('invoice_print_pdf-spoolagent')
1601                              ? $self->cust_main->agentnum
1602                              : '';
1603   my $batch = qsearchs('bill_batch', $hashref);
1604   return $batch if $batch;
1605   $batch = FS::bill_batch->new($hashref);
1606   my $error = $batch->insert;
1607   die $error if $error;
1608   return $batch;
1609 }
1610
1611 =item ftp_invoice [ TEMPLATENAME ]
1612
1613 Sends this invoice data via FTP.
1614
1615 TEMPLATENAME is unused?
1616
1617 =cut
1618
1619 sub ftp_invoice {
1620   my $self = shift;
1621   my $conf = $self->conf;
1622   my $template = scalar(@_) ? shift : '';
1623
1624   $self->send_csv(
1625     'protocol'   => 'ftp',
1626     'server'     => $conf->config('cust_bill-ftpserver'),
1627     'username'   => $conf->config('cust_bill-ftpusername'),
1628     'password'   => $conf->config('cust_bill-ftppassword'),
1629     'dir'        => $conf->config('cust_bill-ftpdir'),
1630     'format'     => $conf->config('cust_bill-ftpformat'),
1631   );
1632 }
1633
1634 =item spool_invoice [ TEMPLATENAME ]
1635
1636 Spools this invoice data (see L<FS::spool_csv>)
1637
1638 TEMPLATENAME is unused?
1639
1640 =cut
1641
1642 sub spool_invoice {
1643   my $self = shift;
1644   my $conf = $self->conf;
1645   my $template = scalar(@_) ? shift : '';
1646
1647   $self->spool_csv(
1648     'format'       => $conf->config('cust_bill-spoolformat'),
1649     'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1650   );
1651 }
1652
1653 =item send_csv OPTION => VALUE, ...
1654
1655 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1656
1657 Options are:
1658
1659 protocol - currently only "ftp"
1660 server
1661 username
1662 password
1663 dir
1664
1665 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1666 and YYMMDDHHMMSS is a timestamp.
1667
1668 See L</print_csv> for a description of the output format.
1669
1670 =cut
1671
1672 sub send_csv {
1673   my($self, %opt) = @_;
1674
1675   #create file(s)
1676
1677   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1678   mkdir $spooldir, 0700 unless -d $spooldir;
1679
1680   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1681   my $file = "$spooldir/$tracctnum.csv";
1682
1683   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1684
1685   open(CSV, ">$file") or die "can't open $file: $!";
1686   print CSV $header;
1687
1688   print CSV $detail;
1689
1690   close CSV;
1691
1692   my $net;
1693   if ( $opt{protocol} eq 'ftp' ) {
1694     eval "use Net::FTP;";
1695     die $@ if $@;
1696     $net = Net::FTP->new($opt{server}) or die @$;
1697   } else {
1698     die "unknown protocol: $opt{protocol}";
1699   }
1700
1701   $net->login( $opt{username}, $opt{password} )
1702     or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1703
1704   $net->binary or die "can't set binary mode";
1705
1706   $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1707
1708   $net->put($file) or die "can't put $file: $!";
1709
1710   $net->quit;
1711
1712   unlink $file;
1713
1714 }
1715
1716 =item spool_csv
1717
1718 Spools CSV invoice data.
1719
1720 Options are:
1721
1722 =over 4
1723
1724 =item format - any of FS::Misc::::Invoicing::spool_formats
1725
1726 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the
1727 customer has the corresponding invoice destinations set (see
1728 L<FS::cust_main_invoice>).
1729
1730 =item agent_spools - if set to a true value, will spool to per-agent files
1731 rather than a single global file
1732
1733 =item upload_targetnum - if set to a target (see L<FS::upload_target>), will
1734 append to that spool.  L<FS::Cron::upload> will then send the spool file to
1735 that destination.
1736
1737 =item balanceover - if set, only spools the invoice if the total amount owed on
1738 this invoice and all older invoices is greater than the specified amount.
1739
1740 =item time - the "current time".  Controls the printing of past due messages
1741 in the ICS format.
1742
1743 =back
1744
1745 =cut
1746
1747 sub spool_csv {
1748   my($self, %opt) = @_;
1749
1750   my $time = $opt{'time'} || time;
1751   my $cust_main = $self->cust_main;
1752
1753   if ( $opt{'dest'} ) {
1754     my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1755                              $cust_main->invoicing_list;
1756     return 'N/A' unless $invoicing_list{$opt{'dest'}}
1757                      || ! keys %invoicing_list;
1758   }
1759
1760   if ( $opt{'balanceover'} ) {
1761     return 'N/A'
1762       if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1763   }
1764
1765   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1766   mkdir $spooldir, 0700 unless -d $spooldir;
1767
1768   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', $time);
1769
1770   my $file;
1771   if ( $opt{'agent_spools'} ) {
1772     $file = 'agentnum'.$cust_main->agentnum;
1773   } else {
1774     $file = 'spool';
1775   }
1776
1777   if ( $opt{'upload_targetnum'} ) {
1778     $spooldir .= '/target'.$opt{'upload_targetnum'};
1779     mkdir $spooldir, 0700 unless -d $spooldir;
1780   } # otherwise it just goes into export.xxx/cust_bill
1781
1782   if ( lc($opt{'format'}) eq 'billco' ) {
1783     $file .= '-header';
1784   }
1785
1786   $file = "$spooldir/$file.csv";
1787
1788   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum);
1789
1790   open(CSV, ">>$file") or die "can't open $file: $!";
1791   flock(CSV, LOCK_EX);
1792   seek(CSV, 0, 2);
1793
1794   print CSV $header;
1795
1796   if ( lc($opt{'format'}) eq 'billco' ) {
1797
1798     flock(CSV, LOCK_UN);
1799     close CSV;
1800
1801     $file =~ s/-header.csv$/-detail.csv/;
1802
1803     open(CSV,">>$file") or die "can't open $file: $!";
1804     flock(CSV, LOCK_EX);
1805     seek(CSV, 0, 2);
1806   }
1807
1808   print CSV $detail if defined($detail);
1809
1810   flock(CSV, LOCK_UN);
1811   close CSV;
1812
1813   return '';
1814
1815 }
1816
1817 =item print_csv OPTION => VALUE, ...
1818
1819 Returns CSV data for this invoice.
1820
1821 Options are:
1822
1823 format - 'default', 'billco', 'oneline', 'bridgestone'
1824
1825 Returns a list consisting of two scalars.  The first is a single line of CSV
1826 header information for this invoice.  The second is one or more lines of CSV
1827 detail information for this invoice.
1828
1829 If I<format> is not specified or "default", the fields of the CSV file are as
1830 follows:
1831
1832 record_type, invnum, custnum, _date, charged, first, last, company, address1,
1833 address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1834
1835 =over 4
1836
1837 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1838
1839 B<record_type> is C<cust_bill> for the initial header line only.  The
1840 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1841 fields are filled in.
1842
1843 B<record_type> is C<cust_bill_pkg> for detail lines.  Only the first two fields
1844 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1845 are filled in.
1846
1847 =item invnum - invoice number
1848
1849 =item custnum - customer number
1850
1851 =item _date - invoice date
1852
1853 =item charged - total invoice amount
1854
1855 =item first - customer first name
1856
1857 =item last - customer first name
1858
1859 =item company - company name
1860
1861 =item address1 - address line 1
1862
1863 =item address2 - address line 1
1864
1865 =item city
1866
1867 =item state
1868
1869 =item zip
1870
1871 =item country
1872
1873 =item pkg - line item description
1874
1875 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1876
1877 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1878
1879 =item sdate - start date for recurring fee
1880
1881 =item edate - end date for recurring fee
1882
1883 =back
1884
1885 If I<format> is "billco", the fields of the header CSV file are as follows:
1886
1887   +-------------------------------------------------------------------+
1888   |                        FORMAT HEADER FILE                         |
1889   |-------------------------------------------------------------------|
1890   | Field | Description                   | Name       | Type | Width |
1891   | 1     | N/A-Leave Empty               | RC         | CHAR |     2 |
1892   | 2     | N/A-Leave Empty               | CUSTID     | CHAR |    15 |
1893   | 3     | Transaction Account No        | TRACCTNUM  | CHAR |    15 |
1894   | 4     | Transaction Invoice No        | TRINVOICE  | CHAR |    15 |
1895   | 5     | Transaction Zip Code          | TRZIP      | CHAR |     5 |
1896   | 6     | Transaction Company Bill To   | TRCOMPANY  | CHAR |    30 |
1897   | 7     | Transaction Contact Bill To   | TRNAME     | CHAR |    30 |
1898   | 8     | Additional Address Unit Info  | TRADDR1    | CHAR |    30 |
1899   | 9     | Bill To Street Address        | TRADDR2    | CHAR |    30 |
1900   | 10    | Ancillary Billing Information | TRADDR3    | CHAR |    30 |
1901   | 11    | Transaction City Bill To      | TRCITY     | CHAR |    20 |
1902   | 12    | Transaction State Bill To     | TRSTATE    | CHAR |     2 |
1903   | 13    | Bill Cycle Close Date         | CLOSEDATE  | CHAR |    10 |
1904   | 14    | Bill Due Date                 | DUEDATE    | CHAR |    10 |
1905   | 15    | Previous Balance              | BALFWD     | NUM* |     9 |
1906   | 16    | Pmt/CR Applied                | CREDAPPLY  | NUM* |     9 |
1907   | 17    | Total Current Charges         | CURRENTCHG | NUM* |     9 |
1908   | 18    | Total Amt Due                 | TOTALDUE   | NUM* |     9 |
1909   | 19    | Total Amt Due                 | AMTDUE     | NUM* |     9 |
1910   | 20    | 30 Day Aging                  | AMT30      | NUM* |     9 |
1911   | 21    | 60 Day Aging                  | AMT60      | NUM* |     9 |
1912   | 22    | 90 Day Aging                  | AMT90      | NUM* |     9 |
1913   | 23    | Y/N                           | AGESWITCH  | CHAR |     1 |
1914   | 24    | Remittance automation         | SCANLINE   | CHAR |   100 |
1915   | 25    | Total Taxes & Fees            | TAXTOT     | NUM* |     9 |
1916   | 26    | Customer Reference Number     | CUSTREF    | CHAR |    15 |
1917   | 27    | Federal Tax***                | FEDTAX     | NUM* |     9 |
1918   | 28    | State Tax***                  | STATETAX   | NUM* |     9 |
1919   | 29    | Other Taxes & Fees***         | OTHERTAX   | NUM* |     9 |
1920   +-------+-------------------------------+------------+------+-------+
1921
1922 If I<format> is "billco", the fields of the detail CSV file are as follows:
1923
1924                                   FORMAT FOR DETAIL FILE
1925         |                            |           |      |
1926   Field | Description                | Name      | Type | Width
1927   1     | N/A-Leave Empty            | RC        | CHAR |     2
1928   2     | N/A-Leave Empty            | CUSTID    | CHAR |    15
1929   3     | Account Number             | TRACCTNUM | CHAR |    15
1930   4     | Invoice Number             | TRINVOICE | CHAR |    15
1931   5     | Line Sequence (sort order) | LINESEQ   | NUM  |     6
1932   6     | Transaction Detail         | DETAILS   | CHAR |   100
1933   7     | Amount                     | AMT       | NUM* |     9
1934   8     | Line Format Control**      | LNCTRL    | CHAR |     2
1935   9     | Grouping Code              | GROUP     | CHAR |     2
1936   10    | User Defined               | ACCT CODE | CHAR |    15
1937
1938 If format is 'oneline', there is no detail file.  Each invoice has a
1939 header line only, with the fields:
1940
1941 Agent number, agent name, customer number, first name, last name, address
1942 line 1, address line 2, city, state, zip, invoice date, invoice number,
1943 amount charged, amount due, previous balance, due date.
1944
1945 and then, for each line item, three columns containing the package number,
1946 description, and amount.
1947
1948 If format is 'bridgestone', there is no detail file.  Each invoice has a
1949 header line with the following fields in a fixed-width format:
1950
1951 Customer number (in display format), date, name (first last), company,
1952 address 1, address 2, city, state, zip.
1953
1954 This is a mailing list format, and has no per-invoice fields.  To avoid
1955 sending redundant notices, the spooling event should have a "once" or
1956 "once_percust_every" condition.
1957
1958 =cut
1959
1960 sub print_csv {
1961   my($self, %opt) = @_;
1962
1963   eval "use Text::CSV_XS";
1964   die $@ if $@;
1965
1966   my $cust_main = $self->cust_main;
1967
1968   my $csv = Text::CSV_XS->new({'always_quote'=>1});
1969   my $format = lc($opt{'format'});
1970
1971   my $time = $opt{'time'} || time;
1972
1973   if ( $format eq 'billco' ) {
1974
1975     my $account_num =
1976       $self->conf->config('billco-account_num', $cust_main->agentnum);
1977
1978     my $tracctnum = $account_num eq 'display_custnum'
1979                       ? $cust_main->display_custnum
1980                       : $opt{'tracctnum'};
1981
1982     my $taxtotal = 0;
1983     $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1984
1985     my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1986
1987     my( $previous_balance, @unused ) = $self->previous; #previous balance
1988
1989     my $pmt_cr_applied = 0;
1990     $pmt_cr_applied += $_->{'amount'}
1991       foreach ( $self->_items_payments, $self->_items_credits ) ;
1992
1993     my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1994
1995     $csv->combine(
1996       '',                         #  1 | N/A-Leave Empty               CHAR   2
1997       '',                         #  2 | N/A-Leave Empty               CHAR  15
1998       $tracctnum,                 #  3 | Transaction Account No        CHAR  15
1999       $self->invnum,              #  4 | Transaction Invoice No        CHAR  15
2000       $cust_main->zip,            #  5 | Transaction Zip Code          CHAR   5
2001       $cust_main->company,        #  6 | Transaction Company Bill To   CHAR  30
2002       #$cust_main->payname,        #  7 | Transaction Contact Bill To   CHAR  30
2003       $cust_main->contact,        #  7 | Transaction Contact Bill To   CHAR  30
2004       $cust_main->address2,       #  8 | Additional Address Unit Info  CHAR  30
2005       $cust_main->address1,       #  9 | Bill To Street Address        CHAR  30
2006       '',                         # 10 | Ancillary Billing Information CHAR  30
2007       $cust_main->city,           # 11 | Transaction City Bill To      CHAR  20
2008       $cust_main->state,          # 12 | Transaction State Bill To     CHAR   2
2009
2010       # XXX ?
2011       time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR  10
2012
2013       # XXX ?
2014       $duedate,                   # 14 | Bill Due Date                 CHAR  10
2015
2016       $previous_balance,          # 15 | Previous Balance              NUM*   9
2017       $pmt_cr_applied,            # 16 | Pmt/CR Applied                NUM*   9
2018       sprintf("%.2f", $self->charged), # 17 | Total Current Charges    NUM*   9
2019       $totaldue,                  # 18 | Total Amt Due                 NUM*   9
2020       $totaldue,                  # 19 | Total Amt Due                 NUM*   9
2021       '',                         # 20 | 30 Day Aging                  NUM*   9
2022       '',                         # 21 | 60 Day Aging                  NUM*   9
2023       '',                         # 22 | 90 Day Aging                  NUM*   9
2024       'N',                        # 23 | Y/N                           CHAR   1
2025       '',                         # 24 | Remittance automation         CHAR 100
2026       $taxtotal,                  # 25 | Total Taxes & Fees            NUM*   9
2027       $self->custnum,             # 26 | Customer Reference Number     CHAR  15
2028       '0',                        # 27 | Federal Tax***                NUM*   9
2029       sprintf("%.2f", $taxtotal), # 28 | State Tax***                  NUM*   9
2030       '0',                        # 29 | Other Taxes & Fees***         NUM*   9
2031     );
2032
2033   } elsif ( $format eq 'oneline' ) { #name
2034
2035     my ($previous_balance) = $self->previous;
2036     $previous_balance = sprintf('%.2f', $previous_balance);
2037     my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
2038     my @items = map {
2039                       $_->{pkgnum},
2040                       $_->{description},
2041                       $_->{amount}
2042                     }
2043                   $self->_items_pkg, #_items_nontax?  no sections or anything
2044                                      # with this format
2045                   $self->_items_tax;
2046
2047     $csv->combine(
2048       $cust_main->agentnum,
2049       $cust_main->agent->agent,
2050       $self->custnum,
2051       $cust_main->first,
2052       $cust_main->last,
2053       $cust_main->company,
2054       $cust_main->address1,
2055       $cust_main->address2,
2056       $cust_main->city,
2057       $cust_main->state,
2058       $cust_main->zip,
2059
2060       # invoice fields
2061       time2str("%x", $self->_date),
2062       $self->invnum,
2063       $self->charged,
2064       $totaldue,
2065       $previous_balance,
2066       $self->due_date2str("%x"),
2067
2068       @items,
2069     );
2070
2071   } elsif ( $format eq 'bridgestone' ) {
2072
2073     # bypass the CSV stuff and just return this
2074     my $longdate = time2str('%B %d, %Y', $time); #current time, right?
2075     my $zip = $cust_main->zip;
2076     $zip =~ s/\D//;
2077     my $prefix = $self->conf->config('bridgestone-prefix', $cust_main->agentnum)
2078       || '';
2079     return (
2080       sprintf(
2081         "%-5s%-15s%-20s%-30s%-30s%-30s%-30s%-20s%-2s%-9s\n",
2082         $prefix,
2083         $cust_main->display_custnum,
2084         $longdate,
2085         uc(substr($cust_main->contact_firstlast,0,30)),
2086         uc(substr($cust_main->company          ,0,30)),
2087         uc(substr($cust_main->address1         ,0,30)),
2088         uc(substr($cust_main->address2         ,0,30)),
2089         uc(substr($cust_main->city             ,0,20)),
2090         uc($cust_main->state),
2091         $zip
2092       ),
2093       '' #detail
2094       );
2095
2096   } elsif ( $format eq 'ics' ) {
2097
2098     my $bill = $cust_main->bill_location;
2099     my $zip = $bill->zip;
2100     my $zip4 = '';
2101
2102     $zip =~ s/\D//;
2103     if ( $zip =~ /^(\d{5})(\d{4})$/ ) {
2104       $zip = $1;
2105       $zip4 = $2;
2106     }
2107
2108     # minor false laziness with print_generic
2109     my ($previous_balance) = $self->previous;
2110     my $balance_due = $self->owed + $previous_balance;
2111     my $payment_total = sum(0, map { $_->{'amount'} } $self->_items_payments);
2112     my $credit_total  = sum(0, map { $_->{'amount'} } $self->_items_credits);
2113
2114     my $past_due = '';
2115     if ( $self->due_date and $time >= $self->due_date ) {
2116       $past_due = sprintf('Past due:$%0.2f Due Immediately', $balance_due);
2117     }
2118
2119     # again, bypass CSV
2120     my $header = sprintf(
2121       '%-10s%-30s%-48s%-2s%-50s%-30s%-30s%-25s%-2s%-5s%-4s%-8s%-8s%-10s%-10s%-10s%-10s%-10s%-10s%-480s%-35s',
2122       $cust_main->display_custnum, #BID
2123       uc($cust_main->first), #FNAME
2124       uc($cust_main->last), #LNAME
2125       '00', #BATCH, should this ever be anything else?
2126       uc($cust_main->company), #COMP
2127       uc($bill->address1), #STREET1
2128       uc($bill->address2), #STREET2
2129       uc($bill->city), #CITY
2130       uc($bill->state), #STATE
2131       $zip,
2132       $zip4,
2133       time2str('%Y%m%d', $self->_date), #BILL_DATE
2134       $self->due_date2str('%Y%m%d'), #DUE_DATE,
2135       ( map {sprintf('%0.2f', $_)}
2136         $balance_due, #AMNT_DUE
2137         $previous_balance, #PREV_BAL
2138         $payment_total, #PYMT_RCVD
2139         $credit_total, #CREDITS
2140         $previous_balance, #BEG_BAL--is this correct?
2141         $self->charged, #NEW_CHRG
2142       ),
2143       'img01', #MRKT_MSG?
2144       $past_due, #PAST_MSG
2145     );
2146
2147     my @details;
2148     my %svc_class = ('' => ''); # maybe cache this more persistently?
2149
2150     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2151
2152       my $show_pkgnum = $cust_bill_pkg->pkgnum || '';
2153       my $cust_pkg = $cust_bill_pkg->cust_pkg if $show_pkgnum;
2154
2155       if ( $cust_pkg ) {
2156
2157         my @dates = ( $self->_date, undef );
2158         if ( my $prev = $cust_bill_pkg->previous_cust_bill_pkg ) {
2159           $dates[1] = $prev->sdate; #questionable
2160         }
2161
2162         # generate an 01 detail for each service
2163         my @svcs = $cust_pkg->h_cust_svc(@dates, 'I');
2164         foreach my $cust_svc ( @svcs ) {
2165           $show_pkgnum = ''; # hide it if we're showing svcnums
2166
2167           my $svcpart = $cust_svc->svcpart;
2168           if (!exists($svc_class{$svcpart})) {
2169             my $classnum = $cust_svc->part_svc->classnum;
2170             my $part_svc_class = FS::part_svc_class->by_key($classnum)
2171               if $classnum;
2172             $svc_class{$svcpart} = $part_svc_class ?
2173                                    $part_svc_class->classname :
2174                                    '';
2175           }
2176
2177           my @h_label = $cust_svc->label(@dates, 'I');
2178           push @details, sprintf('01%-9s%-20s%-47s',
2179             $cust_svc->svcnum,
2180             $svc_class{$svcpart},
2181             $h_label[1],
2182           );
2183         } #foreach $cust_svc
2184       } #if $cust_pkg
2185
2186       my $desc = $cust_bill_pkg->desc; # itemdesc or part_pkg.pkg
2187       if ($cust_bill_pkg->recur > 0) {
2188         $desc .= ' '.time2str('%d-%b-%Y', $cust_bill_pkg->sdate).' to '.
2189                      time2str('%d-%b-%Y', $cust_bill_pkg->edate - 86400);
2190       }
2191       push @details, sprintf('02%-6s%-60s%-10s',
2192         $show_pkgnum,
2193         $desc,
2194         sprintf('%0.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2195       );
2196     } #foreach $cust_bill_pkg
2197
2198     # Tag this row so that we know whether this is one page (1), two pages
2199     # (2), # or "big" (B).  The tag will be stripped off before uploading.
2200     if ( scalar(@details) < 12 ) {
2201       push @details, '1';
2202     } elsif ( scalar(@details) < 58 ) {
2203       push @details, '2';
2204     } else {
2205       push @details, 'B';
2206     }
2207
2208     return join('', $header, @details, "\n");
2209
2210   } else { # default
2211
2212     $csv->combine(
2213       'cust_bill',
2214       $self->invnum,
2215       $self->custnum,
2216       time2str("%x", $self->_date),
2217       sprintf("%.2f", $self->charged),
2218       ( map { $cust_main->getfield($_) }
2219           qw( first last company address1 address2 city state zip country ) ),
2220       map { '' } (1..5),
2221     ) or die "can't create csv";
2222   }
2223
2224   my $header = $csv->string. "\n";
2225
2226   my $detail = '';
2227   if ( lc($opt{'format'}) eq 'billco' ) {
2228
2229     my $lineseq = 0;
2230     foreach my $item ( $self->_items_pkg ) {
2231
2232       $csv->combine(
2233         '',                     #  1 | N/A-Leave Empty            CHAR   2
2234         '',                     #  2 | N/A-Leave Empty            CHAR  15
2235         $opt{'tracctnum'},      #  3 | Account Number             CHAR  15
2236         $self->invnum,          #  4 | Invoice Number             CHAR  15
2237         $lineseq++,             #  5 | Line Sequence (sort order) NUM    6
2238         $item->{'description'}, #  6 | Transaction Detail         CHAR 100
2239         $item->{'amount'},      #  7 | Amount                     NUM*   9
2240         '',                     #  8 | Line Format Control**      CHAR   2
2241         '',                     #  9 | Grouping Code              CHAR   2
2242         '',                     # 10 | User Defined               CHAR  15
2243       );
2244
2245       $detail .= $csv->string. "\n";
2246
2247     }
2248
2249   } elsif ( lc($opt{'format'}) eq 'oneline' ) {
2250
2251     #do nothing
2252
2253   } else {
2254
2255     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2256
2257       my($pkg, $setup, $recur, $sdate, $edate);
2258       if ( $cust_bill_pkg->pkgnum ) {
2259
2260         ($pkg, $setup, $recur, $sdate, $edate) = (
2261           $cust_bill_pkg->part_pkg->pkg,
2262           ( $cust_bill_pkg->setup != 0
2263             ? sprintf("%.2f", $cust_bill_pkg->setup )
2264             : '' ),
2265           ( $cust_bill_pkg->recur != 0
2266             ? sprintf("%.2f", $cust_bill_pkg->recur )
2267             : '' ),
2268           ( $cust_bill_pkg->sdate
2269             ? time2str("%x", $cust_bill_pkg->sdate)
2270             : '' ),
2271           ($cust_bill_pkg->edate
2272             ?time2str("%x", $cust_bill_pkg->edate)
2273             : '' ),
2274         );
2275
2276       } else { #pkgnum tax
2277         next unless $cust_bill_pkg->setup != 0;
2278         $pkg = $cust_bill_pkg->desc;
2279         $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
2280         ( $sdate, $edate ) = ( '', '' );
2281       }
2282
2283       $csv->combine(
2284         'cust_bill_pkg',
2285         $self->invnum,
2286         ( map { '' } (1..11) ),
2287         ($pkg, $setup, $recur, $sdate, $edate)
2288       ) or die "can't create csv";
2289
2290       $detail .= $csv->string. "\n";
2291
2292     }
2293
2294   }
2295
2296   ( $header, $detail );
2297
2298 }
2299
2300 =item comp
2301
2302 Pays this invoice with a compliemntary payment.  If there is an error,
2303 returns the error, otherwise returns false.
2304
2305 =cut
2306
2307 sub comp {
2308   my $self = shift;
2309   my $cust_pay = new FS::cust_pay ( {
2310     'invnum'   => $self->invnum,
2311     'paid'     => $self->owed,
2312     '_date'    => '',
2313     'payby'    => 'COMP',
2314     'payinfo'  => $self->cust_main->payinfo,
2315     'paybatch' => '',
2316   } );
2317   $cust_pay->insert;
2318 }
2319
2320 =item realtime_card
2321
2322 Attempts to pay this invoice with a credit card payment via a
2323 Business::OnlinePayment realtime gateway.  See
2324 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2325 for supported processors.
2326
2327 =cut
2328
2329 sub realtime_card {
2330   my $self = shift;
2331   $self->realtime_bop( 'CC', @_ );
2332 }
2333
2334 =item realtime_ach
2335
2336 Attempts to pay this invoice with an electronic check (ACH) payment via a
2337 Business::OnlinePayment realtime gateway.  See
2338 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2339 for supported processors.
2340
2341 =cut
2342
2343 sub realtime_ach {
2344   my $self = shift;
2345   $self->realtime_bop( 'ECHECK', @_ );
2346 }
2347
2348 =item realtime_lec
2349
2350 Attempts to pay this invoice with phone bill (LEC) payment via a
2351 Business::OnlinePayment realtime gateway.  See
2352 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2353 for supported processors.
2354
2355 =cut
2356
2357 sub realtime_lec {
2358   my $self = shift;
2359   $self->realtime_bop( 'LEC', @_ );
2360 }
2361
2362 sub realtime_bop {
2363   my( $self, $method ) = (shift,shift);
2364   my $conf = $self->conf;
2365   my %opt = @_;
2366
2367   my $cust_main = $self->cust_main;
2368   my $balance = $cust_main->balance;
2369   my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2370   $amount = sprintf("%.2f", $amount);
2371   return "not run (balance $balance)" unless $amount > 0;
2372
2373   my $description = 'Internet Services';
2374   if ( $conf->exists('business-onlinepayment-description') ) {
2375     my $dtempl = $conf->config('business-onlinepayment-description');
2376
2377     my $agent_obj = $cust_main->agent
2378       or die "can't retreive agent for $cust_main (agentnum ".
2379              $cust_main->agentnum. ")";
2380     my $agent = $agent_obj->agent;
2381     my $pkgs = join(', ',
2382       map { $_->part_pkg->pkg }
2383         grep { $_->pkgnum } $self->cust_bill_pkg
2384     );
2385     $description = eval qq("$dtempl");
2386   }
2387
2388   $cust_main->realtime_bop($method, $amount,
2389     'description' => $description,
2390     'invnum'      => $self->invnum,
2391 #this didn't do what we want, it just calls apply_payments_and_credits
2392 #    'apply'       => 1,
2393     'apply_to_invoice' => 1,
2394     %opt,
2395  #what we want:
2396  #this changes application behavior: auto payments
2397                         #triggered against a specific invoice are now applied
2398                         #to that invoice instead of oldest open.
2399                         #seem okay to me...
2400   );
2401
2402 }
2403
2404 =item batch_card OPTION => VALUE...
2405
2406 Adds a payment for this invoice to the pending credit card batch (see
2407 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2408 runs the payment using a realtime gateway.
2409
2410 =cut
2411
2412 sub batch_card {
2413   my ($self, %options) = @_;
2414   my $cust_main = $self->cust_main;
2415
2416   $options{invnum} = $self->invnum;
2417
2418   $cust_main->batch_card(%options);
2419 }
2420
2421 sub _agent_template {
2422   my $self = shift;
2423   $self->cust_main->agent_template;
2424 }
2425
2426 sub _agent_invoice_from {
2427   my $self = shift;
2428   $self->cust_main->agent_invoice_from;
2429 }
2430
2431 =item invoice_barcode DIR_OR_FALSE
2432
2433 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2434 it is taken as the temp directory where the PNG file will be generated and the
2435 PNG file name is returned. Otherwise, the PNG image itself is returned.
2436
2437 =cut
2438
2439 sub invoice_barcode {
2440     my ($self, $dir) = (shift,shift);
2441
2442     my $gdbar = new GD::Barcode('Code39',$self->invnum);
2443         die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2444     my $gd = $gdbar->plot(Height => 30);
2445
2446     if($dir) {
2447         my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2448                            DIR      => $dir,
2449                            SUFFIX   => '.png',
2450                            UNLINK   => 0,
2451                          ) or die "can't open temp file: $!\n";
2452         print $bh $gd->png or die "cannot write barcode to file: $!\n";
2453         my $png_file = $bh->filename;
2454         close $bh;
2455         return $png_file;
2456     }
2457     return $gd->png;
2458 }
2459
2460 =item invnum_date_pretty
2461
2462 Returns a string with the invoice number and date, for example:
2463 "Invoice #54 (3/20/2008)"
2464
2465 =cut
2466
2467 sub invnum_date_pretty {
2468   my $self = shift;
2469   $self->mt('Invoice #'). $self->invnum. ' ('. $self->_date_pretty. ')';
2470 }
2471
2472 #sub _items_extra_usage_sections {
2473 #  my $self = shift;
2474 #  my $escape = shift;
2475 #
2476 #  my %sections = ();
2477 #
2478 #  my %usage_class =  map{ $_->classname, $_ } qsearch('usage_class', {});
2479 #  foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2480 #  {
2481 #    next unless $cust_bill_pkg->pkgnum > 0;
2482 #
2483 #    foreach my $section ( keys %usage_class ) {
2484 #
2485 #      my $usage = $cust_bill_pkg->usage($section);
2486 #
2487 #      next unless $usage && $usage > 0;
2488 #
2489 #      $sections{$section} ||= 0;
2490 #      $sections{$section} += $usage;
2491 #
2492 #    }
2493 #
2494 #  }
2495 #
2496 #  map { { 'description' => &{$escape}($_),
2497 #          'subtotal'    => $sections{$_},
2498 #          'summarized'  => '',
2499 #          'tax_section' => '',
2500 #        }
2501 #      }
2502 #    sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
2503 #
2504 #}
2505
2506 sub _items_extra_usage_sections {
2507   my $self = shift;
2508   my $conf = $self->conf;
2509   my $escape = shift;
2510   my $format = shift;
2511
2512   my %sections = ();
2513   my %classnums = ();
2514   my %lines = ();
2515
2516   my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2517
2518   my %usage_class =  map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2519   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2520     next unless $cust_bill_pkg->pkgnum > 0;
2521
2522     foreach my $classnum ( keys %usage_class ) {
2523       my $section = $usage_class{$classnum}->classname;
2524       $classnums{$section} = $classnum;
2525
2526       foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
2527         my $amount = $detail->amount;
2528         next unless $amount && $amount > 0;
2529
2530         $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
2531         $sections{$section}{amount} += $amount;  #subtotal
2532         $sections{$section}{calls}++;
2533         $sections{$section}{duration} += $detail->duration;
2534
2535         my $desc = $detail->regionname;
2536         my $description = $desc;
2537         $description = substr($desc, 0, $maxlength). '...'
2538           if $format eq 'latex' && length($desc) > $maxlength;
2539
2540         $lines{$section}{$desc} ||= {
2541           description     => &{$escape}($description),
2542           #pkgpart         => $part_pkg->pkgpart,
2543           pkgnum          => $cust_bill_pkg->pkgnum,
2544           ref             => '',
2545           amount          => 0,
2546           calls           => 0,
2547           duration        => 0,
2548           #unit_amount     => $cust_bill_pkg->unitrecur,
2549           quantity        => $cust_bill_pkg->quantity,
2550           product_code    => 'N/A',
2551           ext_description => [],
2552         };
2553
2554         $lines{$section}{$desc}{amount} += $amount;
2555         $lines{$section}{$desc}{calls}++;
2556         $lines{$section}{$desc}{duration} += $detail->duration;
2557
2558       }
2559     }
2560   }
2561
2562   my %sectionmap = ();
2563   foreach (keys %sections) {
2564     my $usage_class = $usage_class{$classnums{$_}};
2565     $sectionmap{$_} = { 'description' => &{$escape}($_),
2566                         'amount'    => $sections{$_}{amount},    #subtotal
2567                         'calls'       => $sections{$_}{calls},
2568                         'duration'    => $sections{$_}{duration},
2569                         'summarized'  => '',
2570                         'tax_section' => '',
2571                         'sort_weight' => $usage_class->weight,
2572                         ( $usage_class->format
2573                           ? ( map { $_ => $usage_class->$_($format) }
2574                               qw( description_generator header_generator total_generator total_line_generator )
2575                             )
2576                           : ()
2577                         ),
2578                       };
2579   }
2580
2581   my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
2582                  values %sectionmap;
2583
2584   my @lines = ();
2585   foreach my $section ( keys %lines ) {
2586     foreach my $line ( keys %{$lines{$section}} ) {
2587       my $l = $lines{$section}{$line};
2588       $l->{section}     = $sectionmap{$section};
2589       $l->{amount}      = sprintf( "%.2f", $l->{amount} );
2590       #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2591       push @lines, $l;
2592     }
2593   }
2594
2595   return(\@sections, \@lines);
2596
2597 }
2598
2599 sub _did_summary {
2600     my $self = shift;
2601     my $end = $self->_date;
2602
2603     # start at date of previous invoice + 1 second or 0 if no previous invoice
2604     my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
2605     $start = 0 if !$start;
2606     $start++;
2607
2608     my $cust_main = $self->cust_main;
2609     my @pkgs = $cust_main->all_pkgs;
2610     my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
2611         = (0,0,0,0,0);
2612     my @seen = ();
2613     foreach my $pkg ( @pkgs ) {
2614         my @h_cust_svc = $pkg->h_cust_svc($end);
2615         foreach my $h_cust_svc ( @h_cust_svc ) {
2616             next if grep {$_ eq $h_cust_svc->svcnum} @seen;
2617             next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
2618
2619             my $inserted = $h_cust_svc->date_inserted;
2620             my $deleted = $h_cust_svc->date_deleted;
2621             my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
2622             my $phone_deleted;
2623             $phone_deleted =  $h_cust_svc->h_svc_x($deleted) if $deleted;
2624
2625 # DID either activated or ported in; cannot be both for same DID simultaneously
2626             if ($inserted >= $start && $inserted <= $end && $phone_inserted
2627                 && (!$phone_inserted->lnp_status
2628                     || $phone_inserted->lnp_status eq ''
2629                     || $phone_inserted->lnp_status eq 'native')) {
2630                 $num_activated++;
2631             }
2632             else { # this one not so clean, should probably move to (h_)svc_phone
2633                  my $phone_portedin = qsearchs( 'h_svc_phone',
2634                       { 'svcnum' => $h_cust_svc->svcnum,
2635                         'lnp_status' => 'portedin' },
2636                       FS::h_svc_phone->sql_h_searchs($end),
2637                     );
2638                  $num_portedin++ if $phone_portedin;
2639             }
2640
2641 # DID either deactivated or ported out; cannot be both for same DID simultaneously
2642             if($deleted >= $start && $deleted <= $end && $phone_deleted
2643                 && (!$phone_deleted->lnp_status
2644                     || $phone_deleted->lnp_status ne 'portingout')) {
2645                 $num_deactivated++;
2646             }
2647             elsif($deleted >= $start && $deleted <= $end && $phone_deleted
2648                 && $phone_deleted->lnp_status
2649                 && $phone_deleted->lnp_status eq 'portingout') {
2650                 $num_portedout++;
2651             }
2652
2653             # increment usage minutes
2654         if ( $phone_inserted ) {
2655             my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
2656             $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
2657         }
2658         else {
2659             warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
2660         }
2661
2662             # don't look at this service again
2663             push @seen, $h_cust_svc->svcnum;
2664         }
2665     }
2666
2667     $minutes = sprintf("%d", $minutes);
2668     ("Activated: $num_activated  Ported-In: $num_portedin  Deactivated: "
2669         . "$num_deactivated  Ported-Out: $num_portedout ",
2670             "Total Minutes: $minutes");
2671 }
2672
2673 sub _items_accountcode_cdr {
2674     my $self = shift;
2675     my $escape = shift;
2676     my $format = shift;
2677
2678     my $section = { 'amount'        => 0,
2679                     'calls'         => 0,
2680                     'duration'      => 0,
2681                     'sort_weight'   => '',
2682                     'phonenum'      => '',
2683                     'description'   => 'Usage by Account Code',
2684                     'post_total'    => '',
2685                     'summarized'    => '',
2686                     'header'        => '',
2687                   };
2688     my @lines;
2689     my %accountcodes = ();
2690
2691     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2692         next unless $cust_bill_pkg->pkgnum > 0;
2693
2694         my @header = $cust_bill_pkg->details_header;
2695         next unless scalar(@header);
2696         $section->{'header'} = join(',',@header);
2697
2698         foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2699
2700             $section->{'header'} = $detail->formatted('format' => $format)
2701                 if($detail->detail eq $section->{'header'});
2702
2703             my $accountcode = $detail->accountcode;
2704             next unless $accountcode;
2705
2706             my $amount = $detail->amount;
2707             next unless $amount && $amount > 0;
2708
2709             $accountcodes{$accountcode} ||= {
2710                     description => $accountcode,
2711                     pkgnum      => '',
2712                     ref         => '',
2713                     amount      => 0,
2714                     calls       => 0,
2715                     duration    => 0,
2716                     quantity    => '',
2717                     product_code => 'N/A',
2718                     section     => $section,
2719                     ext_description => [ $section->{'header'} ],
2720                     detail_temp => [],
2721             };
2722
2723             $section->{'amount'} += $amount;
2724             $accountcodes{$accountcode}{'amount'} += $amount;
2725             $accountcodes{$accountcode}{calls}++;
2726             $accountcodes{$accountcode}{duration} += $detail->duration;
2727             push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
2728         }
2729     }
2730
2731     foreach my $l ( values %accountcodes ) {
2732         $l->{amount} = sprintf( "%.2f", $l->{amount} );
2733         my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
2734         foreach my $sorted_detail ( @sorted_detail ) {
2735             push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
2736         }
2737         delete $l->{detail_temp};
2738         push @lines, $l;
2739     }
2740
2741     my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
2742
2743     return ($section,\@sorted_lines);
2744 }
2745
2746 sub _items_svc_phone_sections {
2747   my $self = shift;
2748   my $conf = $self->conf;
2749   my $escape = shift;
2750   my $format = shift;
2751
2752   my %sections = ();
2753   my %classnums = ();
2754   my %lines = ();
2755
2756   my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2757
2758   my %usage_class =  map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2759   $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
2760
2761   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2762     next unless $cust_bill_pkg->pkgnum > 0;
2763
2764     my @header = $cust_bill_pkg->details_header;
2765     next unless scalar(@header);
2766
2767     foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2768
2769       my $phonenum = $detail->phonenum;
2770       next unless $phonenum;
2771
2772       my $amount = $detail->amount;
2773       next unless $amount && $amount > 0;
2774
2775       $sections{$phonenum} ||= { 'amount'      => 0,
2776                                  'calls'       => 0,
2777                                  'duration'    => 0,
2778                                  'sort_weight' => -1,
2779                                  'phonenum'    => $phonenum,
2780                                 };
2781       $sections{$phonenum}{amount} += $amount;  #subtotal
2782       $sections{$phonenum}{calls}++;
2783       $sections{$phonenum}{duration} += $detail->duration;
2784
2785       my $desc = $detail->regionname;
2786       my $description = $desc;
2787       $description = substr($desc, 0, $maxlength). '...'
2788         if $format eq 'latex' && length($desc) > $maxlength;
2789
2790       $lines{$phonenum}{$desc} ||= {
2791         description     => &{$escape}($description),
2792         #pkgpart         => $part_pkg->pkgpart,
2793         pkgnum          => '',
2794         ref             => '',
2795         amount          => 0,
2796         calls           => 0,
2797         duration        => 0,
2798         #unit_amount     => '',
2799         quantity        => '',
2800         product_code    => 'N/A',
2801         ext_description => [],
2802       };
2803
2804       $lines{$phonenum}{$desc}{amount} += $amount;
2805       $lines{$phonenum}{$desc}{calls}++;
2806       $lines{$phonenum}{$desc}{duration} += $detail->duration;
2807
2808       my $line = $usage_class{$detail->classnum}->classname;
2809       $sections{"$phonenum $line"} ||=
2810         { 'amount' => 0,
2811           'calls' => 0,
2812           'duration' => 0,
2813           'sort_weight' => $usage_class{$detail->classnum}->weight,
2814           'phonenum' => $phonenum,
2815           'header'  => [ @header ],
2816         };
2817       $sections{"$phonenum $line"}{amount} += $amount;  #subtotal
2818       $sections{"$phonenum $line"}{calls}++;
2819       $sections{"$phonenum $line"}{duration} += $detail->duration;
2820
2821       $lines{"$phonenum $line"}{$desc} ||= {
2822         description     => &{$escape}($description),
2823         #pkgpart         => $part_pkg->pkgpart,
2824         pkgnum          => '',
2825         ref             => '',
2826         amount          => 0,
2827         calls           => 0,
2828         duration        => 0,
2829         #unit_amount     => '',
2830         quantity        => '',
2831         product_code    => 'N/A',
2832         ext_description => [],
2833       };
2834
2835       $lines{"$phonenum $line"}{$desc}{amount} += $amount;
2836       $lines{"$phonenum $line"}{$desc}{calls}++;
2837       $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
2838       push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
2839            $detail->formatted('format' => $format);
2840
2841     }
2842   }
2843
2844   my %sectionmap = ();
2845   my $simple = new FS::usage_class { format => 'simple' }; #bleh
2846   foreach ( keys %sections ) {
2847     my @header = @{ $sections{$_}{header} || [] };
2848     my $usage_simple =
2849       new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
2850     my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
2851     my $usage_class = $summary ? $simple : $usage_simple;
2852     my $ending = $summary ? ' usage charges' : '';
2853     my %gen_opt = ();
2854     unless ($summary) {
2855       $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
2856     }
2857     $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
2858                         'amount'    => $sections{$_}{amount},    #subtotal
2859                         'calls'       => $sections{$_}{calls},
2860                         'duration'    => $sections{$_}{duration},
2861                         'summarized'  => '',
2862                         'tax_section' => '',
2863                         'phonenum'    => $sections{$_}{phonenum},
2864                         'sort_weight' => $sections{$_}{sort_weight},
2865                         'post_total'  => $summary, #inspire pagebreak
2866                         (
2867                           ( map { $_ => $usage_class->$_($format, %gen_opt) }
2868                             qw( description_generator
2869                                 header_generator
2870                                 total_generator
2871                                 total_line_generator
2872                               )
2873                           )
2874                         ),
2875                       };
2876   }
2877
2878   my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
2879                         $a->{sort_weight} <=> $b->{sort_weight}
2880                       }
2881                  values %sectionmap;
2882
2883   my @lines = ();
2884   foreach my $section ( keys %lines ) {
2885     foreach my $line ( keys %{$lines{$section}} ) {
2886       my $l = $lines{$section}{$line};
2887       $l->{section}     = $sectionmap{$section};
2888       $l->{amount}      = sprintf( "%.2f", $l->{amount} );
2889       #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2890       push @lines, $l;
2891     }
2892   }
2893
2894   if($conf->exists('phone_usage_class_summary')) {
2895       # this only works with Latex
2896       my @newlines;
2897       my @newsections;
2898
2899       # after this, we'll have only two sections per DID:
2900       # Calls Summary and Calls Detail
2901       foreach my $section ( @sections ) {
2902         if($section->{'post_total'}) {
2903             $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
2904             $section->{'total_line_generator'} = sub { '' };
2905             $section->{'total_generator'} = sub { '' };
2906             $section->{'header_generator'} = sub { '' };
2907             $section->{'description_generator'} = '';
2908             push @newsections, $section;
2909             my %calls_detail = %$section;
2910             $calls_detail{'post_total'} = '';
2911             $calls_detail{'sort_weight'} = '';
2912             $calls_detail{'description_generator'} = sub { '' };
2913             $calls_detail{'header_generator'} = sub {
2914                 return ' & Date/Time & Called Number & Duration & Price'
2915                     if $format eq 'latex';
2916                 '';
2917             };
2918             $calls_detail{'description'} = 'Calls Detail: '
2919                                                     . $section->{'phonenum'};
2920             push @newsections, \%calls_detail;
2921         }
2922       }
2923
2924       # after this, each usage class is collapsed/summarized into a single
2925       # line under the Calls Summary section
2926       foreach my $newsection ( @newsections ) {
2927         if($newsection->{'post_total'}) { # this means Calls Summary
2928             foreach my $section ( @sections ) {
2929                 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
2930                                 && !$section->{'post_total'});
2931                 my $newdesc = $section->{'description'};
2932                 my $tn = $section->{'phonenum'};
2933                 $newdesc =~ s/$tn//g;
2934                 my $line = {  ext_description => [],
2935                               pkgnum => '',
2936                               ref => '',
2937                               quantity => '',
2938                               calls => $section->{'calls'},
2939                               section => $newsection,
2940                               duration => $section->{'duration'},
2941                               description => $newdesc,
2942                               amount => sprintf("%.2f",$section->{'amount'}),
2943                               product_code => 'N/A',
2944                             };
2945                 push @newlines, $line;
2946             }
2947         }
2948       }
2949
2950       # after this, Calls Details is populated with all CDRs
2951       foreach my $newsection ( @newsections ) {
2952         if(!$newsection->{'post_total'}) { # this means Calls Details
2953             foreach my $line ( @lines ) {
2954                 next unless (scalar(@{$line->{'ext_description'}}) &&
2955                         $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
2956                             );
2957                 my @extdesc = @{$line->{'ext_description'}};
2958                 my @newextdesc;
2959                 foreach my $extdesc ( @extdesc ) {
2960                     $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
2961                     push @newextdesc, $extdesc;
2962                 }
2963                 $line->{'ext_description'} = \@newextdesc;
2964                 $line->{'section'} = $newsection;
2965                 push @newlines, $line;
2966             }
2967         }
2968       }
2969
2970       return(\@newsections, \@newlines);
2971   }
2972
2973   return(\@sections, \@lines);
2974
2975 }
2976
2977 sub _items_previous {
2978   my $self = shift;
2979   my $conf = $self->conf;
2980   my $cust_main = $self->cust_main;
2981   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2982   my @b = ();
2983   foreach ( @pr_cust_bill ) {
2984     my $date = $conf->exists('invoice_show_prior_due_date')
2985                ? 'due '. $_->due_date2str($date_format)
2986                : time2str($date_format, $_->_date);
2987     push @b, {
2988       'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
2989       #'pkgpart'     => 'N/A',
2990       'pkgnum'      => 'N/A',
2991       'amount'      => sprintf("%.2f", $_->owed),
2992     };
2993   }
2994   @b;
2995
2996   #{
2997   #    'description'     => 'Previous Balance',
2998   #    #'pkgpart'         => 'N/A',
2999   #    'pkgnum'          => 'N/A',
3000   #    'amount'          => sprintf("%10.2f", $pr_total ),
3001   #    'ext_description' => [ map {
3002   #                                 "Invoice ". $_->invnum.
3003   #                                 " (". time2str("%x",$_->_date). ") ".
3004   #                                 sprintf("%10.2f", $_->owed)
3005   #                         } @pr_cust_bill ],
3006
3007   #};
3008 }
3009
3010 sub _items_credits {
3011   my( $self, %opt ) = @_;
3012   my $trim_len = $opt{'trim_len'} || 60;
3013
3014   my @b;
3015   #credits
3016   my @objects;
3017   if ( $self->conf->exists('previous_balance-payments_since') ) {
3018     my $date = 0;
3019     $date = $self->previous_bill->_date if $self->previous_bill;
3020     @objects = qsearch('cust_credit', {
3021         'custnum' => $self->custnum,
3022         '_date'   => {op => '>=', value => $date},
3023       });
3024       # hard to do this in the qsearch...
3025     @objects = grep { $_->_date < $self->_date } @objects;
3026   } else {
3027     @objects = $self->cust_credited;
3028   }
3029
3030   foreach my $obj ( @objects ) {
3031     my $cust_credit = $obj->isa('FS::cust_credit') ? $obj : $obj->cust_credit;
3032
3033     my $reason = substr($cust_credit->reason, 0, $trim_len);
3034     $reason .= '...' if length($reason) < length($cust_credit->reason);
3035     $reason = " ($reason) " if $reason;
3036
3037     push @b, {
3038       #'description' => 'Credit ref\#'. $_->crednum.
3039       #                 " (". time2str("%x",$_->cust_credit->_date) .")".
3040       #                 $reason,
3041       'description' => $self->mt('Credit applied').' '.
3042                        time2str($date_format,$obj->_date). $reason,
3043       'amount'      => sprintf("%.2f",$obj->amount),
3044     };
3045   }
3046
3047   @b;
3048
3049 }
3050
3051 sub _items_payments {
3052   my $self = shift;
3053
3054   my @b;
3055   my $detailed = $self->conf->exists('invoice_payment_details');
3056   my @objects;
3057   if ( $self->conf->exists('previous_balance-payments_since') ) {
3058     my $date = 0;
3059     $date = $self->previous_bill->_date if $self->previous_bill;
3060     @objects = qsearch('cust_pay', {
3061         'custnum' => $self->custnum,
3062         '_date'   => {op => '>=', value => $date},
3063       });
3064     @objects = grep { $_->_date < $self->_date } @objects;
3065   } else {
3066     @objects = $self->cust_bill_pay;
3067   }
3068
3069   foreach my $obj (@objects) {
3070     my $cust_pay = $obj->isa('FS::cust_pay') ? $obj : $obj->cust_pay;
3071     my $desc = $self->mt('Payment received').' '.
3072                time2str($date_format, $cust_pay->_date );
3073     $desc .= $self->mt(' via ') .
3074              $cust_pay->payby_payinfo_pretty( $self->cust_main->locale )
3075       if $detailed;
3076
3077     push @b, {
3078       'description' => $desc,
3079       'amount'      => sprintf("%.2f", $obj->amount )
3080     };
3081   }
3082
3083   @b;
3084
3085 }
3086
3087 =item call_details [ OPTION => VALUE ... ]
3088
3089 Returns an array of CSV strings representing the call details for this invoice
3090 The only option available is the boolean prepend_billed_number
3091
3092 =cut
3093
3094 sub call_details {
3095   my ($self, %opt) = @_;
3096
3097   my $format_function = sub { shift };
3098
3099   if ($opt{prepend_billed_number}) {
3100     $format_function = sub {
3101       my $detail = shift;
3102       my $row = shift;
3103
3104       $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
3105
3106     };
3107   }
3108
3109   my @details = map { $_->details( 'format_function' => $format_function,
3110                                    'escape_function' => sub{ return() },
3111                                  )
3112                     }
3113                   grep { $_->pkgnum }
3114                   $self->cust_bill_pkg;
3115   my $header = $details[0];
3116   ( $header, grep { $_ ne $header } @details );
3117 }
3118
3119
3120 =back
3121
3122 =head1 SUBROUTINES
3123
3124 =over 4
3125
3126 =item process_reprint
3127
3128 =cut
3129
3130 sub process_reprint {
3131   process_re_X('print', @_);
3132 }
3133
3134 =item process_reemail
3135
3136 =cut
3137
3138 sub process_reemail {
3139   process_re_X('email', @_);
3140 }
3141
3142 =item process_refax
3143
3144 =cut
3145
3146 sub process_refax {
3147   process_re_X('fax', @_);
3148 }
3149
3150 =item process_reftp
3151
3152 =cut
3153
3154 sub process_reftp {
3155   process_re_X('ftp', @_);
3156 }
3157
3158 =item respool
3159
3160 =cut
3161
3162 sub process_respool {
3163   process_re_X('spool', @_);
3164 }
3165
3166 use Storable qw(thaw);
3167 use Data::Dumper;
3168 use MIME::Base64;
3169 sub process_re_X {
3170   my( $method, $job ) = ( shift, shift );
3171   warn "$me process_re_X $method for job $job\n" if $DEBUG;
3172
3173   my $param = thaw(decode_base64(shift));
3174   warn Dumper($param) if $DEBUG;
3175
3176   re_X(
3177     $method,
3178     $job,
3179     %$param,
3180   );
3181
3182 }
3183
3184 sub re_X {
3185   # spool_invoice ftp_invoice fax_invoice print_invoice
3186   my($method, $job, %param ) = @_;
3187   if ( $DEBUG ) {
3188     warn "re_X $method for job $job with param:\n".
3189          join( '', map { "  $_ => ". $param{$_}. "\n" } keys %param );
3190   }
3191
3192   #some false laziness w/search/cust_bill.html
3193   my $distinct = '';
3194   my $orderby = 'ORDER BY cust_bill._date';
3195
3196   my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
3197
3198   my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
3199
3200   my @cust_bill = qsearch( {
3201     #'select'    => "cust_bill.*",
3202     'table'     => 'cust_bill',
3203     'addl_from' => $addl_from,
3204     'hashref'   => {},
3205     'extra_sql' => $extra_sql,
3206     'order_by'  => $orderby,
3207     'debug' => 1,
3208   } );
3209
3210   $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
3211
3212   warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
3213     if $DEBUG;
3214
3215   my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
3216   foreach my $cust_bill ( @cust_bill ) {
3217     $cust_bill->$method();
3218
3219     if ( $job ) { #progressbar foo
3220       $num++;
3221       if ( time - $min_sec > $last ) {
3222         my $error = $job->update_statustext(
3223           int( 100 * $num / scalar(@cust_bill) )
3224         );
3225         die $error if $error;
3226         $last = time;
3227       }
3228     }
3229
3230   }
3231
3232 }
3233
3234 =back
3235
3236 =head1 CLASS METHODS
3237
3238 =over 4
3239
3240 =item owed_sql
3241
3242 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
3243
3244 =cut
3245
3246 sub owed_sql {
3247   my ($class, $start, $end) = @_;
3248   'charged - '.
3249     $class->paid_sql($start, $end). ' - '.
3250     $class->credited_sql($start, $end);
3251 }
3252
3253 =item net_sql
3254
3255 Returns an SQL fragment to retreive the net amount (charged minus credited).
3256
3257 =cut
3258
3259 sub net_sql {
3260   my ($class, $start, $end) = @_;
3261   'charged - '. $class->credited_sql($start, $end);
3262 }
3263
3264 =item paid_sql
3265
3266 Returns an SQL fragment to retreive the amount paid against this invoice.
3267
3268 =cut
3269
3270 sub paid_sql {
3271   my ($class, $start, $end) = @_;
3272   $start &&= "AND cust_bill_pay._date <= $start";
3273   $end   &&= "AND cust_bill_pay._date > $end";
3274   $start = '' unless defined($start);
3275   $end   = '' unless defined($end);
3276   "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
3277        WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end  )";
3278 }
3279
3280 =item credited_sql
3281
3282 Returns an SQL fragment to retreive the amount credited against this invoice.
3283
3284 =cut
3285
3286 sub credited_sql {
3287   my ($class, $start, $end) = @_;
3288   $start &&= "AND cust_credit_bill._date <= $start";
3289   $end   &&= "AND cust_credit_bill._date >  $end";
3290   $start = '' unless defined($start);
3291   $end   = '' unless defined($end);
3292   "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
3293        WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end  )";
3294 }
3295
3296 =item due_date_sql
3297
3298 Returns an SQL fragment to retrieve the due date of an invoice.
3299 Currently only supported on PostgreSQL.
3300
3301 =cut
3302
3303 sub due_date_sql {
3304   my $conf = new FS::Conf;
3305 'COALESCE(
3306   SUBSTRING(
3307     COALESCE(
3308       cust_bill.invoice_terms,
3309       cust_main.invoice_terms,
3310       \''.($conf->config('invoice_default_terms') || '').'\'
3311     ), E\'Net (\\\\d+)\'
3312   )::INTEGER, 0
3313 ) * 86400 + cust_bill._date'
3314 }
3315
3316 =item search_sql_where HASHREF
3317
3318 Class method which returns an SQL WHERE fragment to search for parameters
3319 specified in HASHREF.  Valid parameters are
3320
3321 =over 4
3322
3323 =item _date
3324
3325 List reference of start date, end date, as UNIX timestamps.
3326
3327 =item invnum_min
3328
3329 =item invnum_max
3330
3331 =item agentnum
3332
3333 =item charged
3334
3335 List reference of charged limits (exclusive).
3336
3337 =item owed
3338
3339 List reference of charged limits (exclusive).
3340
3341 =item open
3342
3343 flag, return open invoices only
3344
3345 =item net
3346
3347 flag, return net invoices only
3348
3349 =item days
3350
3351 =item newest_percust
3352
3353 =back
3354
3355 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
3356
3357 =cut
3358
3359 sub search_sql_where {
3360   my($class, $param) = @_;
3361   if ( $DEBUG ) {
3362     warn "$me search_sql_where called with params: \n".
3363          join("\n", map { "  $_: ". $param->{$_} } keys %$param ). "\n";
3364   }
3365
3366   my @search = ();
3367
3368   #agentnum
3369   if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
3370     push @search, "cust_main.agentnum = $1";
3371   }
3372
3373   #refnum
3374   if ( $param->{'refnum'} =~ /^(\d+)$/ ) {
3375     push @search, "cust_main.refnum = $1";
3376   }
3377
3378   #custnum
3379   if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
3380     push @search, "cust_bill.custnum = $1";
3381   }
3382
3383   #customer classnum (false laziness w/ cust_main/Search.pm)
3384   if ( $param->{'cust_classnum'} ) {
3385
3386     my @classnum = ref( $param->{'cust_classnum'} )
3387                      ? @{ $param->{'cust_classnum'} }
3388                      :  ( $param->{'cust_classnum'} );
3389
3390     @classnum = grep /^(\d*)$/, @classnum;
3391
3392     if ( @classnum ) {
3393       push @search, '( '. join(' OR ', map {
3394                                              $_ ? "cust_main.classnum = $_"
3395                                                 : "cust_main.classnum IS NULL"
3396                                            }
3397                                            @classnum
3398                               ).
3399                     ' )';
3400     }
3401
3402   }
3403
3404   #_date
3405   if ( $param->{_date} ) {
3406     my($beginning, $ending) = @{$param->{_date}};
3407
3408     push @search, "cust_bill._date >= $beginning",
3409                   "cust_bill._date <  $ending";
3410   }
3411
3412   #invnum
3413   if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
3414     push @search, "cust_bill.invnum >= $1";
3415   }
3416   if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
3417     push @search, "cust_bill.invnum <= $1";
3418   }
3419
3420   #charged
3421   if ( $param->{charged} ) {
3422     my @charged = ref($param->{charged})
3423                     ? @{ $param->{charged} }
3424                     : ($param->{charged});
3425
3426     push @search, map { s/^charged/cust_bill.charged/; $_; }
3427                       @charged;
3428   }
3429
3430   my $owed_sql = FS::cust_bill->owed_sql;
3431
3432   #owed
3433   if ( $param->{owed} ) {
3434     my @owed = ref($param->{owed})
3435                  ? @{ $param->{owed} }
3436                  : ($param->{owed});
3437     push @search, map { s/^owed/$owed_sql/; $_; }
3438                       @owed;
3439   }
3440
3441   #open/net flags
3442   push @search, "0 != $owed_sql"
3443     if $param->{'open'};
3444   push @search, '0 != '. FS::cust_bill->net_sql
3445     if $param->{'net'};
3446
3447   #days
3448   push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
3449     if $param->{'days'};
3450
3451   #newest_percust
3452   if ( $param->{'newest_percust'} ) {
3453
3454     #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
3455     #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
3456
3457     my @newest_where = map { my $x = $_;
3458                              $x =~ s/\bcust_bill\./newest_cust_bill./g;
3459                              $x;
3460                            }
3461                            grep ! /^cust_main./, @search;
3462     my $newest_where = scalar(@newest_where)
3463                          ? ' AND '. join(' AND ', @newest_where)
3464                          : '';
3465
3466
3467     push @search, "cust_bill._date = (
3468       SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
3469         WHERE newest_cust_bill.custnum = cust_bill.custnum
3470           $newest_where
3471     )";
3472
3473   }
3474
3475   #promised_date - also has an option to accept nulls
3476   if ( $param->{promised_date} ) {
3477     my($beginning, $ending, $null) = @{$param->{promised_date}};
3478
3479     push @search, "(( cust_bill.promised_date >= $beginning AND ".
3480                     "cust_bill.promised_date <  $ending )" .
3481                     ($null ? ' OR cust_bill.promised_date IS NULL ) ' : ')');
3482   }
3483
3484   #agent virtualization
3485   my $curuser = $FS::CurrentUser::CurrentUser;
3486   if ( $curuser->username eq 'fs_queue'
3487        && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
3488     my $username = $1;
3489     my $newuser = qsearchs('access_user', {
3490       'username' => $username,
3491       'disabled' => '',
3492     } );
3493     if ( $newuser ) {
3494       $curuser = $newuser;
3495     } else {
3496       warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
3497     }
3498   }
3499   push @search, $curuser->agentnums_sql;
3500
3501   join(' AND ', @search );
3502
3503 }
3504
3505 =back
3506
3507 =head1 BUGS
3508
3509 The delete method.
3510
3511 =head1 SEE ALSO
3512
3513 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3514 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base
3515 documentation.
3516
3517 =cut
3518
3519 1;
3520