FS/FS/cust_bill.pm

   1 package FS::cust_bill;
   2
   3 use strict;
   4 use vars qw( @ISA $DEBUG $me $conf $money_char $date_format $rdate_format );
   5 use vars qw( $invoice_lines @buf ); #yuck
   6 use Fcntl qw(:flock); #for spool_csv
   7 use List::Util qw(min max);
   8 use Date::Format;
   9 use Text::Template 1.20;
  10 use File::Temp 0.14;
  11 use String::ShellQuote;
  12 use HTML::Entities;
  13 use Locale::Country;
  14 use Storable qw( freeze thaw );
  15 use FS::UID qw( datasrc );
  16 use FS::Misc qw( send_email send_fax generate_ps generate_pdf do_print );
  17 use FS::Record qw( qsearch qsearchs dbh );
  18 use FS::cust_main_Mixin;
  19 use FS::cust_main;
  20 use FS::cust_statement;
  21 use FS::cust_bill_pkg;
  22 use FS::cust_bill_pkg_display;
  23 use FS::cust_bill_pkg_detail;
  24 use FS::cust_credit;
  25 use FS::cust_pay;
  26 use FS::cust_pkg;
  27 use FS::cust_credit_bill;
  28 use FS::pay_batch;
  29 use FS::cust_pay_batch;
  30 use FS::cust_bill_event;
  31 use FS::cust_event;
  32 use FS::part_pkg;
  33 use FS::cust_bill_pay;
  34 use FS::cust_bill_pay_batch;
  35 use FS::part_bill_event;
  36 use FS::payby;
  37
  38 @ISA = qw( FS::cust_main_Mixin FS::Record );
  39
  40 $DEBUG = 0;
  41 $me = '[FS::cust_bill]';
  42
  43 #ask FS::UID to run this stuff for us later
  44 FS::UID->install_callback( sub {
  45   $conf = new FS::Conf;
  46   $money_char   = $conf->config('money_char')  || '$';
  47   $date_format  = $conf->config('date_format') || '%x';
  48   $rdate_format = $conf->config('date_format') || '%m/%d/%Y';
  49 } );
  50
  51 =head1 NAME
  52
  53 FS::cust_bill - Object methods for cust_bill records
  54
  55 =head1 SYNOPSIS
  56
  57   use FS::cust_bill;
  58
  59   $record = new FS::cust_bill \%hash;
  60   $record = new FS::cust_bill { 'column' => 'value' };
  61
  62   $error = $record->insert;
  63
  64   $error = $new_record->replace($old_record);
  65
  66   $error = $record->delete;
  67
  68   $error = $record->check;
  69
  70   ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
  71
  72   @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
  73
  74   ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
  75
  76   @cust_pay_objects = $cust_bill->cust_pay;
  77
  78   $tax_amount = $record->tax;
  79
  80   @lines = $cust_bill->print_text;
  81   @lines = $cust_bill->print_text $time;
  82
  83 =head1 DESCRIPTION
  84
  85 An FS::cust_bill object represents an invoice; a declaration that a customer
  86 owes you money.  The specific charges are itemized as B<cust_bill_pkg> records
  87 (see L<FS::cust_bill_pkg>).  FS::cust_bill inherits from FS::Record.  The
  88 following fields are currently supported:
  89
  90 Regular fields
  91
  92 =over 4
  93
  94 =item invnum - primary key (assigned automatically for new invoices)
  95
  96 =item custnum - customer (see L<FS::cust_main>)
  97
  98 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
  99 L<Time::Local> and L<Date::Parse> for conversion functions.
 100
 101 =item charged - amount of this invoice
 102
 103 =item invoice_terms - optional terms override for this specific invoice
 104
 105 =back
 106
 107 Customer info at invoice generation time
 108
 109 =over 4
 110
 111 =item previous_balance
 112
 113 =item billing_balance
 114
 115 =back
 116
 117 Deprecated
 118
 119 =over 4
 120
 121 =item printed - deprecated
 122
 123 =back
 124
 125 Specific use cases
 126
 127 =over 4
 128
 129 =item closed - books closed flag, empty or `Y'
 130
 131 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
 132
 133 =item agent_invid - legacy invoice number
 134
 135 =back
 136
 137 =head1 METHODS
 138
 139 =over 4
 140
 141 =item new HASHREF
 142
 143 Creates a new invoice.  To add the invoice to the database, see L<"insert">.
 144 Invoices are normally created by calling the bill method of a customer object
 145 (see L<FS::cust_main>).
 146
 147 =cut
 148
 149 sub table { 'cust_bill'; }
 150
 151 sub cust_linked { $_[0]->cust_main_custnum; }
 152 sub cust_unlinked_msg {
 153   my $self = shift;
 154   "WARNING: can't find cust_main.custnum ". $self->custnum.
 155   ' (cust_bill.invnum '. $self->invnum. ')';
 156 }
 157
 158 =item insert
 159
 160 Adds this invoice to the database ("Posts" the invoice).  If there is an error,
 161 returns the error, otherwise returns false.
 162
 163 =item delete
 164
 165 This method now works but you probably shouldn't use it.  Instead, apply a
 166 credit against the invoice.
 167
 168 Using this method to delete invoices outright is really, really bad.  There
 169 would be no record you ever posted this invoice, and there are no check to
 170 make sure charged = 0 or that there are no associated cust_bill_pkg records.
 171
 172 Really, don't use it.
 173
 174 =cut
 175
 176 sub delete {
 177   my $self = shift;
 178   return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
 179
 180   local $SIG{HUP} = 'IGNORE';
 181   local $SIG{INT} = 'IGNORE';
 182   local $SIG{QUIT} = 'IGNORE';
 183   local $SIG{TERM} = 'IGNORE';
 184   local $SIG{TSTP} = 'IGNORE';
 185   local $SIG{PIPE} = 'IGNORE';
 186
 187   my $oldAutoCommit = $FS::UID::AutoCommit;
 188   local $FS::UID::AutoCommit = 0;
 189   my $dbh = dbh;
 190
 191   foreach my $table (qw(
 192     cust_bill_event
 193     cust_event
 194     cust_credit_bill
 195     cust_bill_pay
 196     cust_bill_pay
 197     cust_credit_bill
 198     cust_pay_batch
 199     cust_bill_pay_batch
 200     cust_bill_pkg
 201   )) {
 202
 203     foreach my $linked ( $self->$table() ) {
 204       my $error = $linked->delete;
 205       if ( $error ) {
 206         $dbh->rollback if $oldAutoCommit;
 207         return $error;
 208       }
 209     }
 210
 211   }
 212
 213   my $error = $self->SUPER::delete(@_);
 214   if ( $error ) {
 215     $dbh->rollback if $oldAutoCommit;
 216     return $error;
 217   }
 218
 219   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 220
 221   '';
 222
 223 }
 224
 225 =item replace OLD_RECORD
 226
 227 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 228 returns the error, otherwise returns false.
 229
 230 Only printed may be changed.  printed is normally updated by calling the
 231 collect method of a customer object (see L<FS::cust_main>).
 232
 233 =cut
 234
 235 #replace can be inherited from Record.pm
 236
 237 # replace_check is now the preferred way to #implement replace data checks
 238 # (so $object->replace() works without an argument)
 239
 240 sub replace_check {
 241   my( $new, $old ) = ( shift, shift );
 242   return "Can't change custnum!" unless $old->custnum == $new->custnum;
 243   #return "Can't change _date!" unless $old->_date eq $new->_date;
 244   return "Can't change _date!" unless $old->_date == $new->_date;
 245   return "Can't change charged!" unless $old->charged == $new->charged
 246                                      || $old->charged == 0;
 247
 248   '';
 249 }
 250
 251 =item check
 252
 253 Checks all fields to make sure this is a valid invoice.  If there is an error,
 254 returns the error, otherwise returns false.  Called by the insert and replace
 255 methods.
 256
 257 =cut
 258
 259 sub check {
 260   my $self = shift;
 261
 262   my $error =
 263     $self->ut_numbern('invnum')
 264     || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
 265     || $self->ut_numbern('_date')
 266     || $self->ut_money('charged')
 267     || $self->ut_numbern('printed')
 268     || $self->ut_enum('closed', [ '', 'Y' ])
 269     || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
 270     || $self->ut_numbern('agent_invid') #varchar?
 271   ;
 272   return $error if $error;
 273
 274   $self->_date(time) unless $self->_date;
 275
 276   $self->printed(0) if $self->printed eq '';
 277
 278   $self->SUPER::check;
 279 }
 280
 281 =item display_invnum
 282
 283 Returns the displayed invoice number for this invoice: agent_invid if
 284 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
 285
 286 =cut
 287
 288 sub display_invnum {
 289   my $self = shift;
 290   if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
 291     return $self->agent_invid;
 292   } else {
 293     return $self->invnum;
 294   }
 295 }
 296
 297 =item previous
 298
 299 Returns a list consisting of the total previous balance for this customer,
 300 followed by the previous outstanding invoices (as FS::cust_bill objects also).
 301
 302 =cut
 303
 304 sub previous {
 305   my $self = shift;
 306   my $total = 0;
 307   my @cust_bill = sort { $a->_date <=> $b->_date }
 308     grep { $_->owed != 0 && $_->_date < $self->_date }
 309       qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
 310   ;
 311   foreach ( @cust_bill ) { $total += $_->owed; }
 312   $total, @cust_bill;
 313 }
 314
 315 =item cust_bill_pkg
 316
 317 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
 318
 319 =cut
 320
 321 sub cust_bill_pkg {
 322   my $self = shift;
 323   qsearch(
 324     { 'table'    => 'cust_bill_pkg',
 325       'hashref'  => { 'invnum' => $self->invnum },
 326       'order_by' => 'ORDER BY billpkgnum',
 327     }
 328   );
 329 }
 330
 331 =item cust_bill_pkg_pkgnum PKGNUM
 332
 333 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
 334 specified pkgnum.
 335
 336 =cut
 337
 338 sub cust_bill_pkg_pkgnum {
 339   my( $self, $pkgnum ) = @_;
 340   qsearch(
 341     { 'table'    => 'cust_bill_pkg',
 342       'hashref'  => { 'invnum' => $self->invnum,
 343                       'pkgnum' => $pkgnum,
 344                     },
 345       'order_by' => 'ORDER BY billpkgnum',
 346     }
 347   );
 348 }
 349
 350 =item cust_pkg
 351
 352 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
 353 this invoice.
 354
 355 =cut
 356
 357 sub cust_pkg {
 358   my $self = shift;
 359   my @cust_pkg = map { $_->cust_pkg } $self->cust_bill_pkg;
 360   my %saw = ();
 361   grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
 362 }
 363
 364 =item open_cust_bill_pkg
 365
 366 Returns the open line items for this invoice.
 367
 368 Note that cust_bill_pkg with both setup and recur fees are returned as two
 369 separate line items, each with only one fee.
 370
 371 =cut
 372
 373 # modeled after cust_main::open_cust_bill
 374 sub open_cust_bill_pkg {
 375   my $self = shift;
 376
 377   # grep { $_->owed > 0 } $self->cust_bill_pkg
 378
 379   my %other = ( 'recur' => 'setup',
 380                 'setup' => 'recur', );
 381   my @open = ();
 382   foreach my $field ( qw( recur setup )) {
 383     push @open, map  { $_->set( $other{$field}, 0 ); $_; }
 384                 grep { $_->owed($field) > 0 }
 385                 $self->cust_bill_pkg;
 386   }
 387
 388   @open;
 389 }
 390
 391 =item cust_bill_event
 392
 393 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
 394
 395 =cut
 396
 397 sub cust_bill_event {
 398   my $self = shift;
 399   qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
 400 }
 401
 402 =item num_cust_bill_event
 403
 404 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
 405
 406 =cut
 407
 408 sub num_cust_bill_event {
 409   my $self = shift;
 410   my $sql =
 411     "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
 412   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
 413   $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
 414   $sth->fetchrow_arrayref->[0];
 415 }
 416
 417 =item cust_event
 418
 419 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
 420
 421 =cut
 422
 423 #false laziness w/cust_pkg.pm
 424 sub cust_event {
 425   my $self = shift;
 426   qsearch({
 427     'table'     => 'cust_event',
 428     'addl_from' => 'JOIN part_event USING ( eventpart )',
 429     'hashref'   => { 'tablenum' => $self->invnum },
 430     'extra_sql' => " AND eventtable = 'cust_bill' ",
 431   });
 432 }
 433
 434 =item num_cust_event
 435
 436 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
 437
 438 =cut
 439
 440 #false laziness w/cust_pkg.pm
 441 sub num_cust_event {
 442   my $self = shift;
 443   my $sql =
 444     "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
 445     "  WHERE tablenum = ? AND eventtable = 'cust_bill'";
 446   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
 447   $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
 448   $sth->fetchrow_arrayref->[0];
 449 }
 450
 451 =item cust_main
 452
 453 Returns the customer (see L<FS::cust_main>) for this invoice.
 454
 455 =cut
 456
 457 sub cust_main {
 458   my $self = shift;
 459   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 460 }
 461
 462 =item cust_suspend_if_balance_over AMOUNT
 463
 464 Suspends the customer associated with this invoice if the total amount owed on
 465 this invoice and all older invoices is greater than the specified amount.
 466
 467 Returns a list: an empty list on success or a list of errors.
 468
 469 =cut
 470
 471 sub cust_suspend_if_balance_over {
 472   my( $self, $amount ) = ( shift, shift );
 473   my $cust_main = $self->cust_main;
 474   if ( $cust_main->total_owed_date($self->_date) < $amount ) {
 475     return ();
 476   } else {
 477     $cust_main->suspend(@_);
 478   }
 479 }
 480
 481 =item cust_credit
 482
 483 Depreciated.  See the cust_credited method.
 484
 485  #Returns a list consisting of the total previous credited (see
 486  #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
 487  #outstanding credits (FS::cust_credit objects).
 488
 489 =cut
 490
 491 sub cust_credit {
 492   use Carp;
 493   croak "FS::cust_bill->cust_credit depreciated; see ".
 494         "FS::cust_bill->cust_credit_bill";
 495   #my $self = shift;
 496   #my $total = 0;
 497   #my @cust_credit = sort { $a->_date <=> $b->_date }
 498   #  grep { $_->credited != 0 && $_->_date < $self->_date }
 499   #    qsearch('cust_credit', { 'custnum' => $self->custnum } )
 500   #;
 501   #foreach (@cust_credit) { $total += $_->credited; }
 502   #$total, @cust_credit;
 503 }
 504
 505 =item cust_pay
 506
 507 Depreciated.  See the cust_bill_pay method.
 508
 509 #Returns all payments (see L<FS::cust_pay>) for this invoice.
 510
 511 =cut
 512
 513 sub cust_pay {
 514   use Carp;
 515   croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
 516   #my $self = shift;
 517   #sort { $a->_date <=> $b->_date }
 518   #  qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
 519   #;
 520 }
 521
 522 sub cust_pay_batch {
 523   my $self = shift;
 524   qsearch('cust_pay_batch', { 'invnum' => $self->invnum } );
 525 }
 526
 527 sub cust_bill_pay_batch {
 528   my $self = shift;
 529   qsearch('cust_bill_pay_batch', { 'invnum' => $self->invnum } );
 530 }
 531
 532 =item cust_bill_pay
 533
 534 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
 535
 536 =cut
 537
 538 sub cust_bill_pay {
 539   my $self = shift;
 540   map { $_ } #return $self->num_cust_bill_pay unless wantarray;
 541   sort { $a->_date <=> $b->_date }
 542     qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
 543 }
 544
 545 =item cust_credited
 546
 547 =item cust_credit_bill
 548
 549 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
 550
 551 =cut
 552
 553 sub cust_credited {
 554   my $self = shift;
 555   map { $_ } #return $self->num_cust_credit_bill unless wantarray;
 556   sort { $a->_date <=> $b->_date }
 557     qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
 558   ;
 559 }
 560
 561 sub cust_credit_bill {
 562   shift->cust_credited(@_);
 563 }
 564
 565 =item cust_bill_pay_pkgnum PKGNUM
 566
 567 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
 568 with matching pkgnum.
 569
 570 =cut
 571
 572 sub cust_bill_pay_pkgnum {
 573   my( $self, $pkgnum ) = @_;
 574   map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
 575   sort { $a->_date <=> $b->_date }
 576     qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
 577                                 'pkgnum' => $pkgnum,
 578                               }
 579            );
 580 }
 581
 582 =item cust_credited_pkgnum PKGNUM
 583
 584 =item cust_credit_bill_pkgnum PKGNUM
 585
 586 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
 587 with matching pkgnum.
 588
 589 =cut
 590
 591 sub cust_credited_pkgnum {
 592   my( $self, $pkgnum ) = @_;
 593   map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
 594   sort { $a->_date <=> $b->_date }
 595     qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
 596                                    'pkgnum' => $pkgnum,
 597                                  }
 598            );
 599 }
 600
 601 sub cust_credit_bill_pkgnum {
 602   shift->cust_credited_pkgnum(@_);
 603 }
 604
 605 =item tax
 606
 607 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
 608
 609 =cut
 610
 611 sub tax {
 612   my $self = shift;
 613   my $total = 0;
 614   my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
 615                                              'pkgnum' => 0 } );
 616   foreach (@taxlines) { $total += $_->setup; }
 617   $total;
 618 }
 619
 620 =item owed
 621
 622 Returns the amount owed (still outstanding) on this invoice, which is charged
 623 minus all payment applications (see L<FS::cust_bill_pay>) and credit
 624 applications (see L<FS::cust_credit_bill>).
 625
 626 =cut
 627
 628 sub owed {
 629   my $self = shift;
 630   my $balance = $self->charged;
 631   $balance -= $_->amount foreach ( $self->cust_bill_pay );
 632   $balance -= $_->amount foreach ( $self->cust_credited );
 633   $balance = sprintf( "%.2f", $balance);
 634   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
 635   $balance;
 636 }
 637
 638 sub owed_pkgnum {
 639   my( $self, $pkgnum ) = @_;
 640
 641   #my $balance = $self->charged;
 642   my $balance = 0;
 643   $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
 644
 645   $balance -= $_->amount            for $self->cust_bill_pay_pkgnum($pkgnum);
 646   $balance -= $_->amount            for $self->cust_credited_pkgnum($pkgnum);
 647
 648   $balance = sprintf( "%.2f", $balance);
 649   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
 650   $balance;
 651 }
 652
 653 =item apply_payments_and_credits [ OPTION => VALUE ... ]
 654
 655 Applies unapplied payments and credits to this invoice.
 656
 657 A hash of optional arguments may be passed.  Currently "manual" is supported.
 658 If true, a payment receipt is sent instead of a statement when
 659 'payment_receipt_email' configuration option is set.
 660
 661 If there is an error, returns the error, otherwise returns false.
 662
 663 =cut
 664
 665 sub apply_payments_and_credits {
 666   my( $self, %options ) = @_;
 667
 668   local $SIG{HUP} = 'IGNORE';
 669   local $SIG{INT} = 'IGNORE';
 670   local $SIG{QUIT} = 'IGNORE';
 671   local $SIG{TERM} = 'IGNORE';
 672   local $SIG{TSTP} = 'IGNORE';
 673   local $SIG{PIPE} = 'IGNORE';
 674
 675   my $oldAutoCommit = $FS::UID::AutoCommit;
 676   local $FS::UID::AutoCommit = 0;
 677   my $dbh = dbh;
 678
 679   $self->select_for_update; #mutex
 680
 681   my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
 682   my @credits  = grep { $_->credited > 0 } $self->cust_main->cust_credit;
 683
 684   if ( $conf->exists('pkg-balances') ) {
 685     # limit @payments & @credits to those w/ a pkgnum grepped from $self
 686     my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
 687     @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
 688     @credits  = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
 689   }
 690
 691   while ( $self->owed > 0 and ( @payments || @credits ) ) {
 692
 693     my $app = '';
 694     if ( @payments && @credits ) {
 695
 696       #decide which goes first by weight of top (unapplied) line item
 697
 698       my @open_lineitems = $self->open_cust_bill_pkg;
 699
 700       my $max_pay_weight =
 701         max( map  { $_->part_pkg->pay_weight || 0 }
 702              grep { $_ }
 703              map  { $_->cust_pkg }
 704                   @open_lineitems
 705            );
 706       my $max_credit_weight =
 707         max( map  { $_->part_pkg->credit_weight || 0 }
 708              grep { $_ }
 709              map  { $_->cust_pkg }
 710                   @open_lineitems
 711            );
 712
 713       #if both are the same... payments first?  it has to be something
 714       if ( $max_pay_weight >= $max_credit_weight ) {
 715         $app = 'pay';
 716       } else {
 717         $app = 'credit';
 718       }
 719
 720     } elsif ( @payments ) {
 721       $app = 'pay';
 722     } elsif ( @credits ) {
 723       $app = 'credit';
 724     } else {
 725       die "guru meditation #12 and 35";
 726     }
 727
 728     my $unapp_amount;
 729     if ( $app eq 'pay' ) {
 730
 731       my $payment = shift @payments;
 732       $unapp_amount = $payment->unapplied;
 733       $app = new FS::cust_bill_pay { 'paynum'  => $payment->paynum };
 734       $app->pkgnum( $payment->pkgnum )
 735         if $conf->exists('pkg-balances') && $payment->pkgnum;
 736
 737     } elsif ( $app eq 'credit' ) {
 738
 739       my $credit = shift @credits;
 740       $unapp_amount = $credit->credited;
 741       $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
 742       $app->pkgnum( $credit->pkgnum )
 743         if $conf->exists('pkg-balances') && $credit->pkgnum;
 744
 745     } else {
 746       die "guru meditation #12 and 35";
 747     }
 748
 749     my $owed;
 750     if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
 751       warn "owed_pkgnum ". $app->pkgnum;
 752       $owed = $self->owed_pkgnum($app->pkgnum);
 753     } else {
 754       $owed = $self->owed;
 755     }
 756     next unless $owed > 0;
 757
 758     warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
 759     $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
 760
 761     $app->invnum( $self->invnum );
 762
 763     my $error = $app->insert(%options);
 764     if ( $error ) {
 765       $dbh->rollback if $oldAutoCommit;
 766       return "Error inserting ". $app->table. " record: $error";
 767     }
 768     die $error if $error;
 769
 770   }
 771
 772   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 773   ''; #no error
 774
 775 }
 776
 777 =item generate_email OPTION => VALUE ...
 778
 779 Options:
 780
 781 =over 4
 782
 783 =item from
 784
 785 sender address, required
 786
 787 =item tempate
 788
 789 alternate template name, optional
 790
 791 =item print_text
 792
 793 text attachment arrayref, optional
 794
 795 =item subject
 796
 797 email subject, optional
 798
 799 =item notice_name
 800
 801 notice name instead of "Invoice", optional
 802
 803 =back
 804
 805 Returns an argument list to be passed to L<FS::Misc::send_email>.
 806
 807 =cut
 808
 809 use MIME::Entity;
 810
 811 sub generate_email {
 812
 813   my $self = shift;
 814   my %args = @_;
 815
 816   my $me = '[FS::cust_bill::generate_email]';
 817
 818   my %return = (
 819     'from'      => $args{'from'},
 820     'subject'   => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
 821   );
 822
 823   my %opt = (
 824     'unsquelch_cdr' => $conf->exists('voip-cdr_email'),
 825     'template'      => $args{'template'},
 826     'notice_name'   => ( $args{'notice_name'} || 'Invoice' ),
 827   );
 828
 829   my $cust_main = $self->cust_main;
 830
 831   if (ref($args{'to'}) eq 'ARRAY') {
 832     $return{'to'} = $args{'to'};
 833   } else {
 834     $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
 835                            $cust_main->invoicing_list
 836                     ];
 837   }
 838
 839   if ( $conf->exists('invoice_html') ) {
 840
 841     warn "$me creating HTML/text multipart message"
 842       if $DEBUG;
 843
 844     $return{'nobody'} = 1;
 845
 846     my $alternative = build MIME::Entity
 847       'Type'        => 'multipart/alternative',
 848       'Encoding'    => '7bit',
 849       'Disposition' => 'inline'
 850     ;
 851
 852     my $data;
 853     if ( $conf->exists('invoice_email_pdf')
 854          and scalar($conf->config('invoice_email_pdf_note')) ) {
 855
 856       warn "$me using 'invoice_email_pdf_note' in multipart message"
 857         if $DEBUG;
 858       $data = [ map { $_ . "\n" }
 859                     $conf->config('invoice_email_pdf_note')
 860               ];
 861
 862     } else {
 863
 864       warn "$me not using 'invoice_email_pdf_note' in multipart message"
 865         if $DEBUG;
 866       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
 867         $data = $args{'print_text'};
 868       } else {
 869         $data = [ $self->print_text(\%opt) ];
 870       }
 871
 872     }
 873
 874     $alternative->attach(
 875       'Type'        => 'text/plain',
 876       #'Encoding'    => 'quoted-printable',
 877       'Encoding'    => '7bit',
 878       'Data'        => $data,
 879       'Disposition' => 'inline',
 880     );
 881
 882     $args{'from'} =~ /\@([\w\.\-]+)/;
 883     my $from = $1 || 'example.com';
 884     my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
 885
 886     my $logo;
 887     my $agentnum = $cust_main->agentnum;
 888     if ( defined($args{'template'}) && length($args{'template'})
 889          && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
 890        )
 891     {
 892       $logo = 'logo_'. $args{'template'}. '.png';
 893     } else {
 894       $logo = "logo.png";
 895     }
 896     my $image_data = $conf->config_binary( $logo, $agentnum);
 897
 898     my $image = build MIME::Entity
 899       'Type'       => 'image/png',
 900       'Encoding'   => 'base64',
 901       'Data'       => $image_data,
 902       'Filename'   => 'logo.png',
 903       'Content-ID' => "<$content_id>",
 904     ;
 905
 906     $alternative->attach(
 907       'Type'        => 'text/html',
 908       'Encoding'    => 'quoted-printable',
 909       'Data'        => [ '<html>',
 910                          '  <head>',
 911                          '    <title>',
 912                          '      '. encode_entities($return{'subject'}),
 913                          '    </title>',
 914                          '  </head>',
 915                          '  <body bgcolor="#e8e8e8">',
 916                          $self->print_html({ 'cid'=>$content_id, %opt }),
 917                          '  </body>',
 918                          '</html>',
 919                        ],
 920       'Disposition' => 'inline',
 921       #'Filename'    => 'invoice.pdf',
 922     );
 923
 924     my @otherparts = ();
 925     if ( $cust_main->email_csv_cdr ) {
 926
 927       push @otherparts, build MIME::Entity
 928         'Type'        => 'text/csv',
 929         'Encoding'    => '7bit',
 930         'Data'        => [ map { "$_\n" }
 931                              $self->call_details('prepend_billed_number' => 1)
 932                          ],
 933         'Disposition' => 'attachment',
 934         'Filename'    => 'usage-'. $self->invnum. '.csv',
 935       ;
 936
 937     }
 938
 939     if ( $conf->exists('invoice_email_pdf') ) {
 940
 941       #attaching pdf too:
 942       # multipart/mixed
 943       #   multipart/related
 944       #     multipart/alternative
 945       #       text/plain
 946       #       text/html
 947       #     image/png
 948       #   application/pdf
 949
 950       my $related = build MIME::Entity 'Type'     => 'multipart/related',
 951                                        'Encoding' => '7bit';
 952
 953       #false laziness w/Misc::send_email
 954       $related->head->replace('Content-type',
 955         $related->mime_type.
 956         '; boundary="'. $related->head->multipart_boundary. '"'.
 957         '; type=multipart/alternative'
 958       );
 959
 960       $related->add_part($alternative);
 961
 962       $related->add_part($image);
 963
 964       my $pdf = build MIME::Entity $self->mimebuild_pdf(\%opt);
 965
 966       $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
 967
 968     } else {
 969
 970       #no other attachment:
 971       # multipart/related
 972       #   multipart/alternative
 973       #     text/plain
 974       #     text/html
 975       #   image/png
 976
 977       $return{'content-type'} = 'multipart/related';
 978       $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
 979       $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
 980       #$return{'disposition'} = 'inline';
 981
 982     }
 983
 984   } else {
 985
 986     if ( $conf->exists('invoice_email_pdf') ) {
 987       warn "$me creating PDF attachment"
 988         if $DEBUG;
 989
 990       #mime parts arguments a la MIME::Entity->build().
 991       $return{'mimeparts'} = [
 992         { $self->mimebuild_pdf(\%opt) }
 993       ];
 994     }
 995
 996     if ( $conf->exists('invoice_email_pdf')
 997          and scalar($conf->config('invoice_email_pdf_note')) ) {
 998
 999       warn "$me using 'invoice_email_pdf_note'"
1000         if $DEBUG;
1001       $return{'body'} = [ map { $_ . "\n" }
1002                               $conf->config('invoice_email_pdf_note')
1003                         ];
1004
1005     } else {
1006
1007       warn "$me not using 'invoice_email_pdf_note'"
1008         if $DEBUG;
1009       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1010         $return{'body'} = $args{'print_text'};
1011       } else {
1012         $return{'body'} = [ $self->print_text(\%opt) ];
1013       }
1014
1015     }
1016
1017   }
1018
1019   %return;
1020
1021 }
1022
1023 =item mimebuild_pdf
1024
1025 Returns a list suitable for passing to MIME::Entity->build(), representing
1026 this invoice as PDF attachment.
1027
1028 =cut
1029
1030 sub mimebuild_pdf {
1031   my $self = shift;
1032   (
1033     'Type'        => 'application/pdf',
1034     'Encoding'    => 'base64',
1035     'Data'        => [ $self->print_pdf(@_) ],
1036     'Disposition' => 'attachment',
1037     'Filename'    => 'invoice-'. $self->invnum. '.pdf',
1038   );
1039 }
1040
1041 =item send HASHREF | [ TEMPLATE [ , AGENTNUM [ , INVOICE_FROM [ , AMOUNT ] ] ] ]
1042
1043 Sends this invoice to the destinations configured for this customer: sends
1044 email, prints and/or faxes.  See L<FS::cust_main_invoice>.
1045
1046 Options can be passed as a hashref (recommended) or as a list of up to
1047 four values for templatename, agentnum, invoice_from and amount.
1048
1049 I<template>, if specified, is the name of a suffix for alternate invoices.
1050
1051 I<agentnum>, if specified, means that this invoice will only be sent for customers
1052 of the specified agent or agent(s).  AGENTNUM can be a scalar agentnum (for a
1053 single agent) or an arrayref of agentnums.
1054
1055 I<invoice_from>, if specified, overrides the default email invoice From: address.
1056
1057 I<amount>, if specified, only sends the invoice if the total amount owed on this
1058 invoice and all older invoices is greater than the specified amount.
1059
1060 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1061
1062 =cut
1063
1064 sub queueable_send {
1065   my %opt = @_;
1066
1067   my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1068     or die "invalid invoice number: " . $opt{invnum};
1069
1070   my @args = ( $opt{template}, $opt{agentnum} );
1071   push @args, $opt{invoice_from}
1072     if exists($opt{invoice_from}) && $opt{invoice_from};
1073
1074   my $error = $self->send( @args );
1075   die $error if $error;
1076
1077 }
1078
1079 sub send {
1080   my $self = shift;
1081
1082   my( $template, $invoice_from, $notice_name );
1083   my $agentnums = '';
1084   my $balance_over = 0;
1085
1086   if ( ref($_[0]) ) {
1087     my $opt = shift;
1088     $template = $opt->{'template'} || '';
1089     if ( $agentnums = $opt->{'agentnum'} ) {
1090       $agentnums = [ $agentnums ] unless ref($agentnums);
1091     }
1092     $invoice_from = $opt->{'invoice_from'};
1093     $balance_over = $opt->{'balance_over'} if $opt->{'balance_over'};
1094     $notice_name = $opt->{'notice_name'};
1095   } else {
1096     $template = scalar(@_) ? shift : '';
1097     if ( scalar(@_) && $_[0]  ) {
1098       $agentnums = ref($_[0]) ? shift : [ shift ];
1099     }
1100     $invoice_from = shift if scalar(@_);
1101     $balance_over = shift if scalar(@_) && $_[0] !~ /^\s*$/;
1102   }
1103
1104   return 'N/A' unless ! $agentnums
1105                    or grep { $_ == $self->cust_main->agentnum } @$agentnums;
1106
1107   return ''
1108     unless $self->cust_main->total_owed_date($self->_date) > $balance_over;
1109
1110   $invoice_from ||= $self->_agent_invoice_from ||    #XXX should go away
1111                     $conf->config('invoice_from', $self->cust_main->agentnum );
1112
1113   my %opt = (
1114     'template'     => $template,
1115     'invoice_from' => $invoice_from,
1116     'notice_name'  => ( $notice_name || 'Invoice' ),
1117   );
1118
1119   my @invoicing_list = $self->cust_main->invoicing_list;
1120
1121   #$self->email_invoice(\%opt)
1122   $self->email(\%opt)
1123     if grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list;
1124
1125   #$self->print_invoice(\%opt)
1126   $self->print(\%opt)
1127     if grep { $_ eq 'POST' } @invoicing_list; #postal
1128
1129   $self->fax_invoice(\%opt)
1130     if grep { $_ eq 'FAX' } @invoicing_list; #fax
1131
1132   '';
1133
1134 }
1135
1136 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1137
1138 Emails this invoice.
1139
1140 Options can be passed as a hashref (recommended) or as a list of up to
1141 two values for templatename and invoice_from.
1142
1143 I<template>, if specified, is the name of a suffix for alternate invoices.
1144
1145 I<invoice_from>, if specified, overrides the default email invoice From: address.
1146
1147 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1148
1149 =cut
1150
1151 sub queueable_email {
1152   my %opt = @_;
1153
1154   my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1155     or die "invalid invoice number: " . $opt{invnum};
1156
1157   my @args = ( $opt{template} );
1158   push @args, $opt{invoice_from}
1159     if exists($opt{invoice_from}) && $opt{invoice_from};
1160
1161   my $error = $self->email( @args );
1162   die $error if $error;
1163
1164 }
1165
1166 #sub email_invoice {
1167 sub email {
1168   my $self = shift;
1169
1170   my( $template, $invoice_from, $notice_name );
1171   if ( ref($_[0]) ) {
1172     my $opt = shift;
1173     $template = $opt->{'template'} || '';
1174     $invoice_from = $opt->{'invoice_from'};
1175     $notice_name = $opt->{'notice_name'} || 'Invoice';
1176   } else {
1177     $template = scalar(@_) ? shift : '';
1178     $invoice_from = shift if scalar(@_);
1179     $notice_name = 'Invoice';
1180   }
1181
1182   $invoice_from ||= $self->_agent_invoice_from ||    #XXX should go away
1183                     $conf->config('invoice_from', $self->cust_main->agentnum );
1184
1185   my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1186                             $self->cust_main->invoicing_list;
1187
1188   #better to notify this person than silence
1189   @invoicing_list = ($invoice_from) unless @invoicing_list;
1190
1191   my $subject = $self->email_subject($template);
1192
1193   my $error = send_email(
1194     $self->generate_email(
1195       'from'        => $invoice_from,
1196       'to'          => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1197       'subject'     => $subject,
1198       'template'    => $template,
1199       'notice_name' => $notice_name,
1200     )
1201   );
1202   die "can't email invoice: $error\n" if $error;
1203   #die "$error\n" if $error;
1204
1205 }
1206
1207 sub email_subject {
1208   my $self = shift;
1209
1210   #my $template = scalar(@_) ? shift : '';
1211   #per-template?
1212
1213   my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1214                 || 'Invoice';
1215
1216   my $cust_main = $self->cust_main;
1217   my $name = $cust_main->name;
1218   my $name_short = $cust_main->name_short;
1219   my $invoice_number = $self->invnum;
1220   my $invoice_date = $self->_date_pretty;
1221
1222   eval qq("$subject");
1223 }
1224
1225 =item lpr_data HASHREF | [ TEMPLATE ]
1226
1227 Returns the postscript or plaintext for this invoice as an arrayref.
1228
1229 Options can be passed as a hashref (recommended) or as a single optional value
1230 for template.
1231
1232 I<template>, if specified, is the name of a suffix for alternate invoices.
1233
1234 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1235
1236 =cut
1237
1238 sub lpr_data {
1239   my $self = shift;
1240   my( $template, $notice_name );
1241   if ( ref($_[0]) ) {
1242     my $opt = shift;
1243     $template = $opt->{'template'} || '';
1244     $notice_name = $opt->{'notice_name'} || 'Invoice';
1245   } else {
1246     $template = scalar(@_) ? shift : '';
1247     $notice_name = 'Invoice';
1248   }
1249
1250   my %opt = (
1251     'template'    => $template,
1252     'notice_name' => $notice_name,
1253   );
1254
1255   my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1256   [ $self->$method( \%opt ) ];
1257 }
1258
1259 =item print HASHREF | [ TEMPLATE ]
1260
1261 Prints this invoice.
1262
1263 Options can be passed as a hashref (recommended) or as a single optional
1264 value for template.
1265
1266 I<template>, if specified, is the name of a suffix for alternate invoices.
1267
1268 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1269
1270 =cut
1271
1272 #sub print_invoice {
1273 sub print {
1274   my $self = shift;
1275   my( $template, $notice_name );
1276   if ( ref($_[0]) ) {
1277     my $opt = shift;
1278     $template = $opt->{'template'} || '';
1279     $notice_name = $opt->{'notice_name'} || 'Invoice';
1280   } else {
1281     $template = scalar(@_) ? shift : '';
1282     $notice_name = 'Invoice';
1283   }
1284
1285   my %opt = (
1286     'template'    => $template,
1287     'notice_name' => $notice_name,
1288   );
1289
1290   do_print $self->lpr_data(\%opt);
1291 }
1292
1293 =item fax_invoice HASHREF | [ TEMPLATE ]
1294
1295 Faxes this invoice.
1296
1297 Options can be passed as a hashref (recommended) or as a single optional
1298 value for template.
1299
1300 I<template>, if specified, is the name of a suffix for alternate invoices.
1301
1302 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1303
1304 =cut
1305
1306 sub fax_invoice {
1307   my $self = shift;
1308   my( $template, $notice_name );
1309   if ( ref($_[0]) ) {
1310     my $opt = shift;
1311     $template = $opt->{'template'} || '';
1312     $notice_name = $opt->{'notice_name'} || 'Invoice';
1313   } else {
1314     $template = scalar(@_) ? shift : '';
1315     $notice_name = 'Invoice';
1316   }
1317
1318   die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1319     unless $conf->exists('invoice_latex');
1320
1321   my $dialstring = $self->cust_main->getfield('fax');
1322   #Check $dialstring?
1323
1324   my %opt = (
1325     'template'    => $template,
1326     'notice_name' => $notice_name,
1327   );
1328
1329   my $error = send_fax( 'docdata'    => $self->lpr_data(\%opt),
1330                         'dialstring' => $dialstring,
1331                       );
1332   die $error if $error;
1333
1334 }
1335
1336 =item ftp_invoice [ TEMPLATENAME ]
1337
1338 Sends this invoice data via FTP.
1339
1340 TEMPLATENAME is unused?
1341
1342 =cut
1343
1344 sub ftp_invoice {
1345   my $self = shift;
1346   my $template = scalar(@_) ? shift : '';
1347
1348   $self->send_csv(
1349     'protocol'   => 'ftp',
1350     'server'     => $conf->config('cust_bill-ftpserver'),
1351     'username'   => $conf->config('cust_bill-ftpusername'),
1352     'password'   => $conf->config('cust_bill-ftppassword'),
1353     'dir'        => $conf->config('cust_bill-ftpdir'),
1354     'format'     => $conf->config('cust_bill-ftpformat'),
1355   );
1356 }
1357
1358 =item spool_invoice [ TEMPLATENAME ]
1359
1360 Spools this invoice data (see L<FS::spool_csv>)
1361
1362 TEMPLATENAME is unused?
1363
1364 =cut
1365
1366 sub spool_invoice {
1367   my $self = shift;
1368   my $template = scalar(@_) ? shift : '';
1369
1370   $self->spool_csv(
1371     'format'       => $conf->config('cust_bill-spoolformat'),
1372     'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1373   );
1374 }
1375
1376 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
1377
1378 Like B<send>, but only sends the invoice if it is the newest open invoice for
1379 this customer.
1380
1381 =cut
1382
1383 sub send_if_newest {
1384   my $self = shift;
1385
1386   return ''
1387     if scalar(
1388                grep { $_->owed > 0 }
1389                     qsearch('cust_bill', {
1390                       'custnum' => $self->custnum,
1391                       #'_date'   => { op=>'>', value=>$self->_date },
1392                       'invnum'  => { op=>'>', value=>$self->invnum },
1393                     } )
1394              );
1395
1396   $self->send(@_);
1397 }
1398
1399 =item send_csv OPTION => VALUE, ...
1400
1401 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1402
1403 Options are:
1404
1405 protocol - currently only "ftp"
1406 server
1407 username
1408 password
1409 dir
1410
1411 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1412 and YYMMDDHHMMSS is a timestamp.
1413
1414 See L</print_csv> for a description of the output format.
1415
1416 =cut
1417
1418 sub send_csv {
1419   my($self, %opt) = @_;
1420
1421   #create file(s)
1422
1423   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1424   mkdir $spooldir, 0700 unless -d $spooldir;
1425
1426   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1427   my $file = "$spooldir/$tracctnum.csv";
1428
1429   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1430
1431   open(CSV, ">$file") or die "can't open $file: $!";
1432   print CSV $header;
1433
1434   print CSV $detail;
1435
1436   close CSV;
1437
1438   my $net;
1439   if ( $opt{protocol} eq 'ftp' ) {
1440     eval "use Net::FTP;";
1441     die $@ if $@;
1442     $net = Net::FTP->new($opt{server}) or die @$;
1443   } else {
1444     die "unknown protocol: $opt{protocol}";
1445   }
1446
1447   $net->login( $opt{username}, $opt{password} )
1448     or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1449
1450   $net->binary or die "can't set binary mode";
1451
1452   $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1453
1454   $net->put($file) or die "can't put $file: $!";
1455
1456   $net->quit;
1457
1458   unlink $file;
1459
1460 }
1461
1462 =item spool_csv
1463
1464 Spools CSV invoice data.
1465
1466 Options are:
1467
1468 =over 4
1469
1470 =item format - 'default' or 'billco'
1471
1472 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the customer has the corresponding invoice destinations set (see L<FS::cust_main_invoice>).
1473
1474 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
1475
1476 =item balanceover - if set, only spools the invoice if the total amount owed on this invoice and all older invoices is greater than the specified amount.
1477
1478 =back
1479
1480 =cut
1481
1482 sub spool_csv {
1483   my($self, %opt) = @_;
1484
1485   my $cust_main = $self->cust_main;
1486
1487   if ( $opt{'dest'} ) {
1488     my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1489                              $cust_main->invoicing_list;
1490     return 'N/A' unless $invoicing_list{$opt{'dest'}}
1491                      || ! keys %invoicing_list;
1492   }
1493
1494   if ( $opt{'balanceover'} ) {
1495     return 'N/A'
1496       if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1497   }
1498
1499   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1500   mkdir $spooldir, 0700 unless -d $spooldir;
1501
1502   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1503
1504   my $file =
1505     "$spooldir/".
1506     ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1507     ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1508     '.csv';
1509
1510   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1511
1512   open(CSV, ">>$file") or die "can't open $file: $!";
1513   flock(CSV, LOCK_EX);
1514   seek(CSV, 0, 2);
1515
1516   print CSV $header;
1517
1518   if ( lc($opt{'format'}) eq 'billco' ) {
1519
1520     flock(CSV, LOCK_UN);
1521     close CSV;
1522
1523     $file =
1524       "$spooldir/".
1525       ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1526       '-detail.csv';
1527
1528     open(CSV,">>$file") or die "can't open $file: $!";
1529     flock(CSV, LOCK_EX);
1530     seek(CSV, 0, 2);
1531   }
1532
1533   print CSV $detail;
1534
1535   flock(CSV, LOCK_UN);
1536   close CSV;
1537
1538   return '';
1539
1540 }
1541
1542 =item print_csv OPTION => VALUE, ...
1543
1544 Returns CSV data for this invoice.
1545
1546 Options are:
1547
1548 format - 'default' or 'billco'
1549
1550 Returns a list consisting of two scalars.  The first is a single line of CSV
1551 header information for this invoice.  The second is one or more lines of CSV
1552 detail information for this invoice.
1553
1554 If I<format> is not specified or "default", the fields of the CSV file are as
1555 follows:
1556
1557 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1558
1559 =over 4
1560
1561 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1562
1563 B<record_type> is C<cust_bill> for the initial header line only.  The
1564 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1565 fields are filled in.
1566
1567 B<record_type> is C<cust_bill_pkg> for detail lines.  Only the first two fields
1568 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1569 are filled in.
1570
1571 =item invnum - invoice number
1572
1573 =item custnum - customer number
1574
1575 =item _date - invoice date
1576
1577 =item charged - total invoice amount
1578
1579 =item first - customer first name
1580
1581 =item last - customer first name
1582
1583 =item company - company name
1584
1585 =item address1 - address line 1
1586
1587 =item address2 - address line 1
1588
1589 =item city
1590
1591 =item state
1592
1593 =item zip
1594
1595 =item country
1596
1597 =item pkg - line item description
1598
1599 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1600
1601 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1602
1603 =item sdate - start date for recurring fee
1604
1605 =item edate - end date for recurring fee
1606
1607 =back
1608
1609 If I<format> is "billco", the fields of the header CSV file are as follows:
1610
1611   +-------------------------------------------------------------------+
1612   |                        FORMAT HEADER FILE                         |
1613   |-------------------------------------------------------------------|
1614   | Field | Description                   | Name       | Type | Width |
1615   | 1     | N/A-Leave Empty               | RC         | CHAR |     2 |
1616   | 2     | N/A-Leave Empty               | CUSTID     | CHAR |    15 |
1617   | 3     | Transaction Account No        | TRACCTNUM  | CHAR |    15 |
1618   | 4     | Transaction Invoice No        | TRINVOICE  | CHAR |    15 |
1619   | 5     | Transaction Zip Code          | TRZIP      | CHAR |     5 |
1620   | 6     | Transaction Company Bill To   | TRCOMPANY  | CHAR |    30 |
1621   | 7     | Transaction Contact Bill To   | TRNAME     | CHAR |    30 |
1622   | 8     | Additional Address Unit Info  | TRADDR1    | CHAR |    30 |
1623   | 9     | Bill To Street Address        | TRADDR2    | CHAR |    30 |
1624   | 10    | Ancillary Billing Information | TRADDR3    | CHAR |    30 |
1625   | 11    | Transaction City Bill To      | TRCITY     | CHAR |    20 |
1626   | 12    | Transaction State Bill To     | TRSTATE    | CHAR |     2 |
1627   | 13    | Bill Cycle Close Date         | CLOSEDATE  | CHAR |    10 |
1628   | 14    | Bill Due Date                 | DUEDATE    | CHAR |    10 |
1629   | 15    | Previous Balance              | BALFWD     | NUM* |     9 |
1630   | 16    | Pmt/CR Applied                | CREDAPPLY  | NUM* |     9 |
1631   | 17    | Total Current Charges         | CURRENTCHG | NUM* |     9 |
1632   | 18    | Total Amt Due                 | TOTALDUE   | NUM* |     9 |
1633   | 19    | Total Amt Due                 | AMTDUE     | NUM* |     9 |
1634   | 20    | 30 Day Aging                  | AMT30      | NUM* |     9 |
1635   | 21    | 60 Day Aging                  | AMT60      | NUM* |     9 |
1636   | 22    | 90 Day Aging                  | AMT90      | NUM* |     9 |
1637   | 23    | Y/N                           | AGESWITCH  | CHAR |     1 |
1638   | 24    | Remittance automation         | SCANLINE   | CHAR |   100 |
1639   | 25    | Total Taxes & Fees            | TAXTOT     | NUM* |     9 |
1640   | 26    | Customer Reference Number     | CUSTREF    | CHAR |    15 |
1641   | 27    | Federal Tax***                | FEDTAX     | NUM* |     9 |
1642   | 28    | State Tax***                  | STATETAX   | NUM* |     9 |
1643   | 29    | Other Taxes & Fees***         | OTHERTAX   | NUM* |     9 |
1644   +-------+-------------------------------+------------+------+-------+
1645
1646 If I<format> is "billco", the fields of the detail CSV file are as follows:
1647
1648                                   FORMAT FOR DETAIL FILE
1649         |                            |           |      |
1650   Field | Description                | Name      | Type | Width
1651   1     | N/A-Leave Empty            | RC        | CHAR |     2
1652   2     | N/A-Leave Empty            | CUSTID    | CHAR |    15
1653   3     | Account Number             | TRACCTNUM | CHAR |    15
1654   4     | Invoice Number             | TRINVOICE | CHAR |    15
1655   5     | Line Sequence (sort order) | LINESEQ   | NUM  |     6
1656   6     | Transaction Detail         | DETAILS   | CHAR |   100
1657   7     | Amount                     | AMT       | NUM* |     9
1658   8     | Line Format Control**      | LNCTRL    | CHAR |     2
1659   9     | Grouping Code              | GROUP     | CHAR |     2
1660   10    | User Defined               | ACCT CODE | CHAR |    15
1661
1662 =cut
1663
1664 sub print_csv {
1665   my($self, %opt) = @_;
1666
1667   eval "use Text::CSV_XS";
1668   die $@ if $@;
1669
1670   my $cust_main = $self->cust_main;
1671
1672   my $csv = Text::CSV_XS->new({'always_quote'=>1});
1673
1674   if ( lc($opt{'format'}) eq 'billco' ) {
1675
1676     my $taxtotal = 0;
1677     $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1678
1679     my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1680
1681     my( $previous_balance, @unused ) = $self->previous; #previous balance
1682
1683     my $pmt_cr_applied = 0;
1684     $pmt_cr_applied += $_->{'amount'}
1685       foreach ( $self->_items_payments, $self->_items_credits ) ;
1686
1687     my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1688
1689     $csv->combine(
1690       '',                         #  1 | N/A-Leave Empty               CHAR   2
1691       '',                         #  2 | N/A-Leave Empty               CHAR  15
1692       $opt{'tracctnum'},          #  3 | Transaction Account No        CHAR  15
1693       $self->invnum,              #  4 | Transaction Invoice No        CHAR  15
1694       $cust_main->zip,            #  5 | Transaction Zip Code          CHAR   5
1695       $cust_main->company,        #  6 | Transaction Company Bill To   CHAR  30
1696       #$cust_main->payname,        #  7 | Transaction Contact Bill To   CHAR  30
1697       $cust_main->contact,        #  7 | Transaction Contact Bill To   CHAR  30
1698       $cust_main->address2,       #  8 | Additional Address Unit Info  CHAR  30
1699       $cust_main->address1,       #  9 | Bill To Street Address        CHAR  30
1700       '',                         # 10 | Ancillary Billing Information CHAR  30
1701       $cust_main->city,           # 11 | Transaction City Bill To      CHAR  20
1702       $cust_main->state,          # 12 | Transaction State Bill To     CHAR   2
1703
1704       # XXX ?
1705       time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR  10
1706
1707       # XXX ?
1708       $duedate,                   # 14 | Bill Due Date                 CHAR  10
1709
1710       $previous_balance,          # 15 | Previous Balance              NUM*   9
1711       $pmt_cr_applied,            # 16 | Pmt/CR Applied                NUM*   9
1712       sprintf("%.2f", $self->charged), # 17 | Total Current Charges    NUM*   9
1713       $totaldue,                  # 18 | Total Amt Due                 NUM*   9
1714       $totaldue,                  # 19 | Total Amt Due                 NUM*   9
1715       '',                         # 20 | 30 Day Aging                  NUM*   9
1716       '',                         # 21 | 60 Day Aging                  NUM*   9
1717       '',                         # 22 | 90 Day Aging                  NUM*   9
1718       'N',                        # 23 | Y/N                           CHAR   1
1719       '',                         # 24 | Remittance automation         CHAR 100
1720       $taxtotal,                  # 25 | Total Taxes & Fees            NUM*   9
1721       $self->custnum,             # 26 | Customer Reference Number     CHAR  15
1722       '0',                        # 27 | Federal Tax***                NUM*   9
1723       sprintf("%.2f", $taxtotal), # 28 | State Tax***                  NUM*   9
1724       '0',                        # 29 | Other Taxes & Fees***         NUM*   9
1725     );
1726
1727   } else {
1728
1729     $csv->combine(
1730       'cust_bill',
1731       $self->invnum,
1732       $self->custnum,
1733       time2str("%x", $self->_date),
1734       sprintf("%.2f", $self->charged),
1735       ( map { $cust_main->getfield($_) }
1736           qw( first last company address1 address2 city state zip country ) ),
1737       map { '' } (1..5),
1738     ) or die "can't create csv";
1739   }
1740
1741   my $header = $csv->string. "\n";
1742
1743   my $detail = '';
1744   if ( lc($opt{'format'}) eq 'billco' ) {
1745
1746     my $lineseq = 0;
1747     foreach my $item ( $self->_items_pkg ) {
1748
1749       $csv->combine(
1750         '',                     #  1 | N/A-Leave Empty            CHAR   2
1751         '',                     #  2 | N/A-Leave Empty            CHAR  15
1752         $opt{'tracctnum'},      #  3 | Account Number             CHAR  15
1753         $self->invnum,          #  4 | Invoice Number             CHAR  15
1754         $lineseq++,             #  5 | Line Sequence (sort order) NUM    6
1755         $item->{'description'}, #  6 | Transaction Detail         CHAR 100
1756         $item->{'amount'},      #  7 | Amount                     NUM*   9
1757         '',                     #  8 | Line Format Control**      CHAR   2
1758         '',                     #  9 | Grouping Code              CHAR   2
1759         '',                     # 10 | User Defined               CHAR  15
1760       );
1761
1762       $detail .= $csv->string. "\n";
1763
1764     }
1765
1766   } else {
1767
1768     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1769
1770       my($pkg, $setup, $recur, $sdate, $edate);
1771       if ( $cust_bill_pkg->pkgnum ) {
1772
1773         ($pkg, $setup, $recur, $sdate, $edate) = (
1774           $cust_bill_pkg->part_pkg->pkg,
1775           ( $cust_bill_pkg->setup != 0
1776             ? sprintf("%.2f", $cust_bill_pkg->setup )
1777             : '' ),
1778           ( $cust_bill_pkg->recur != 0
1779             ? sprintf("%.2f", $cust_bill_pkg->recur )
1780             : '' ),
1781           ( $cust_bill_pkg->sdate
1782             ? time2str("%x", $cust_bill_pkg->sdate)
1783             : '' ),
1784           ($cust_bill_pkg->edate
1785             ?time2str("%x", $cust_bill_pkg->edate)
1786             : '' ),
1787         );
1788
1789       } else { #pkgnum tax
1790         next unless $cust_bill_pkg->setup != 0;
1791         $pkg = $cust_bill_pkg->desc;
1792         $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
1793         ( $sdate, $edate ) = ( '', '' );
1794       }
1795
1796       $csv->combine(
1797         'cust_bill_pkg',
1798         $self->invnum,
1799         ( map { '' } (1..11) ),
1800         ($pkg, $setup, $recur, $sdate, $edate)
1801       ) or die "can't create csv";
1802
1803       $detail .= $csv->string. "\n";
1804
1805     }
1806
1807   }
1808
1809   ( $header, $detail );
1810
1811 }
1812
1813 =item comp
1814
1815 Pays this invoice with a compliemntary payment.  If there is an error,
1816 returns the error, otherwise returns false.
1817
1818 =cut
1819
1820 sub comp {
1821   my $self = shift;
1822   my $cust_pay = new FS::cust_pay ( {
1823     'invnum'   => $self->invnum,
1824     'paid'     => $self->owed,
1825     '_date'    => '',
1826     'payby'    => 'COMP',
1827     'payinfo'  => $self->cust_main->payinfo,
1828     'paybatch' => '',
1829   } );
1830   $cust_pay->insert;
1831 }
1832
1833 =item realtime_card
1834
1835 Attempts to pay this invoice with a credit card payment via a
1836 Business::OnlinePayment realtime gateway.  See
1837 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1838 for supported processors.
1839
1840 =cut
1841
1842 sub realtime_card {
1843   my $self = shift;
1844   $self->realtime_bop( 'CC', @_ );
1845 }
1846
1847 =item realtime_ach
1848
1849 Attempts to pay this invoice with an electronic check (ACH) payment via a
1850 Business::OnlinePayment realtime gateway.  See
1851 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1852 for supported processors.
1853
1854 =cut
1855
1856 sub realtime_ach {
1857   my $self = shift;
1858   $self->realtime_bop( 'ECHECK', @_ );
1859 }
1860
1861 =item realtime_lec
1862
1863 Attempts to pay this invoice with phone bill (LEC) payment via a
1864 Business::OnlinePayment realtime gateway.  See
1865 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1866 for supported processors.
1867
1868 =cut
1869
1870 sub realtime_lec {
1871   my $self = shift;
1872   $self->realtime_bop( 'LEC', @_ );
1873 }
1874
1875 sub realtime_bop {
1876   my( $self, $method ) = @_;
1877
1878   my $cust_main = $self->cust_main;
1879   my $balance = $cust_main->balance;
1880   my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
1881   $amount = sprintf("%.2f", $amount);
1882   return "not run (balance $balance)" unless $amount > 0;
1883
1884   my $description = 'Internet Services';
1885   if ( $conf->exists('business-onlinepayment-description') ) {
1886     my $dtempl = $conf->config('business-onlinepayment-description');
1887
1888     my $agent_obj = $cust_main->agent
1889       or die "can't retreive agent for $cust_main (agentnum ".
1890              $cust_main->agentnum. ")";
1891     my $agent = $agent_obj->agent;
1892     my $pkgs = join(', ',
1893       map { $_->part_pkg->pkg }
1894         grep { $_->pkgnum } $self->cust_bill_pkg
1895     );
1896     $description = eval qq("$dtempl");
1897   }
1898
1899   $cust_main->realtime_bop($method, $amount,
1900     'description' => $description,
1901     'invnum'      => $self->invnum,
1902   );
1903
1904 }
1905
1906 =item batch_card OPTION => VALUE...
1907
1908 Adds a payment for this invoice to the pending credit card batch (see
1909 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
1910 runs the payment using a realtime gateway.
1911
1912 =cut
1913
1914 sub batch_card {
1915   my ($self, %options) = @_;
1916   my $cust_main = $self->cust_main;
1917
1918   $options{invnum} = $self->invnum;
1919
1920   $cust_main->batch_card(%options);
1921 }
1922
1923 sub _agent_template {
1924   my $self = shift;
1925   $self->cust_main->agent_template;
1926 }
1927
1928 sub _agent_invoice_from {
1929   my $self = shift;
1930   $self->cust_main->agent_invoice_from;
1931 }
1932
1933 =item print_text HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
1934
1935 Returns an text invoice, as a list of lines.
1936
1937 Options can be passed as a hashref (recommended) or as a list of time, template
1938 and then any key/value pairs for any other options.
1939
1940 I<time>, if specified, is used to control the printing of overdue messages.  The
1941 default is now.  It isn't the date of the invoice; that's the `_date' field.
1942 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1943 L<Time::Local> and L<Date::Parse> for conversion functions.
1944
1945 I<template>, if specified, is the name of a suffix for alternate invoices.
1946
1947 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1948
1949 =cut
1950
1951 sub print_text {
1952   my $self = shift;
1953   my( $today, $template, %opt );
1954   if ( ref($_[0]) ) {
1955     %opt = %{ shift() };
1956     $today = delete($opt{'time'}) || '';
1957     $template = delete($opt{template}) || '';
1958   } else {
1959     ( $today, $template, %opt ) = @_;
1960   }
1961
1962   my %params = ( 'format' => 'template' );
1963   $params{'time'} = $today if $today;
1964   $params{'template'} = $template if $template;
1965   $params{$_} = $opt{$_}
1966     foreach grep $opt{$_}, qw( unsquealch_cdr notice_name );
1967
1968   $self->print_generic( %params );
1969 }
1970
1971 =item print_latex HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
1972
1973 Internal method - returns a filename of a filled-in LaTeX template for this
1974 invoice (Note: add ".tex" to get the actual filename), and a filename of
1975 an associated logo (with the .eps extension included).
1976
1977 See print_ps and print_pdf for methods that return PostScript and PDF output.
1978
1979 Options can be passed as a hashref (recommended) or as a list of time, template
1980 and then any key/value pairs for any other options.
1981
1982 I<time>, if specified, is used to control the printing of overdue messages.  The
1983 default is now.  It isn't the date of the invoice; that's the `_date' field.
1984 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1985 L<Time::Local> and L<Date::Parse> for conversion functions.
1986
1987 I<template>, if specified, is the name of a suffix for alternate invoices.
1988
1989 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1990
1991 =cut
1992
1993 sub print_latex {
1994   my $self = shift;
1995   my( $today, $template, %opt );
1996   if ( ref($_[0]) ) {
1997     %opt = %{ shift() };
1998     $today = delete($opt{'time'}) || '';
1999     $template = delete($opt{template}) || '';
2000   } else {
2001     ( $today, $template, %opt ) = @_;
2002   }
2003
2004   my %params = ( 'format' => 'latex' );
2005   $params{'time'} = $today if $today;
2006   $params{'template'} = $template if $template;
2007   $params{$_} = $opt{$_}
2008     foreach grep $opt{$_}, qw( unsquealch_cdr notice_name );
2009
2010   $template ||= $self->_agent_template;
2011
2012   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2013   my $lh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2014                            DIR      => $dir,
2015                            SUFFIX   => '.eps',
2016                            UNLINK   => 0,
2017                          ) or die "can't open temp file: $!\n";
2018
2019   my $agentnum = $self->cust_main->agentnum;
2020
2021   if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
2022     print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
2023       or die "can't write temp file: $!\n";
2024   } else {
2025     print $lh $conf->config_binary('logo.eps', $agentnum)
2026       or die "can't write temp file: $!\n";
2027   }
2028   close $lh;
2029   $params{'logo_file'} = $lh->filename;
2030
2031   my @filled_in = $self->print_generic( %params );
2032
2033   my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2034                            DIR      => $dir,
2035                            SUFFIX   => '.tex',
2036                            UNLINK   => 0,
2037                          ) or die "can't open temp file: $!\n";
2038   print $fh join('', @filled_in );
2039   close $fh;
2040
2041   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
2042   return ($1, $params{'logo_file'});
2043
2044 }
2045
2046 =item print_generic OPTION => VALUE ...
2047
2048 Internal method - returns a filled-in template for this invoice as a scalar.
2049
2050 See print_ps and print_pdf for methods that return PostScript and PDF output.
2051
2052 Non optional options include
2053   format - latex, html, template
2054
2055 Optional options include
2056
2057 template - a value used as a suffix for a configuration template
2058
2059 time - a value used to control the printing of overdue messages.  The
2060 default is now.  It isn't the date of the invoice; that's the `_date' field.
2061 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2062 L<Time::Local> and L<Date::Parse> for conversion functions.
2063
2064 cid -
2065
2066 unsquelch_cdr - overrides any per customer cdr squelching when true
2067
2068 notice_name - overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2069
2070 =cut
2071
2072 #what's with all the sprintf('%10.2f')'s in here?  will it cause any
2073 # (alignment in text invoice?) problems to change them all to '%.2f' ?
2074 # yes: fixed width (dot matrix) text printing will be borked
2075 sub print_generic {
2076
2077   my( $self, %params ) = @_;
2078   my $today = $params{today} ? $params{today} : time;
2079   warn "$me print_generic called on $self with suffix $params{template}\n"
2080     if $DEBUG;
2081
2082   my $format = $params{format};
2083   die "Unknown format: $format"
2084     unless $format =~ /^(latex|html|template)$/;
2085
2086   my $cust_main = $self->cust_main;
2087   $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
2088     unless $cust_main->payname
2089         && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
2090
2091   my %delimiters = ( 'latex'    => [ '[@--', '--@]' ],
2092                      'html'     => [ '<%=', '%>' ],
2093                      'template' => [ '{', '}' ],
2094                    );
2095
2096   #create the template
2097   my $template = $params{template} ? $params{template} : $self->_agent_template;
2098   my $templatefile = "invoice_$format";
2099   $templatefile .= "_$template"
2100     if length($template);
2101   my @invoice_template = map "$_\n", $conf->config($templatefile)
2102     or die "cannot load config data $templatefile";
2103
2104   my $old_latex = '';
2105   if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
2106     #change this to a die when the old code is removed
2107     warn "old-style invoice template $templatefile; ".
2108          "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
2109     $old_latex = 'true';
2110     @invoice_template = _translate_old_latex_format(@invoice_template);
2111   }
2112
2113   my $text_template = new Text::Template(
2114     TYPE => 'ARRAY',
2115     SOURCE => \@invoice_template,
2116     DELIMITERS => $delimiters{$format},
2117   );
2118
2119   $text_template->compile()
2120     or die "Can't compile $templatefile: $Text::Template::ERROR\n";
2121
2122
2123   # additional substitution could possibly cause breakage in existing templates
2124   my %convert_maps = (
2125     'latex' => {
2126                  'notes'         => sub { map "$_", @_ },
2127                  'footer'        => sub { map "$_", @_ },
2128                  'smallfooter'   => sub { map "$_", @_ },
2129                  'returnaddress' => sub { map "$_", @_ },
2130                  'coupon'        => sub { map "$_", @_ },
2131                  'summary'       => sub { map "$_", @_ },
2132                },
2133     'html'  => {
2134                  'notes' =>
2135                    sub {
2136                      map {
2137                        s/%%(.*)$/<!-- $1 -->/g;
2138                        s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
2139                        s/\\begin\{enumerate\}/<ol>/g;
2140                        s/\\item /  <li>/g;
2141                        s/\\end\{enumerate\}/<\/ol>/g;
2142                        s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
2143                        s/\\\\\*/<br>/g;
2144                        s/\\dollar ?/\$/g;
2145                        s/\\#/#/g;
2146                        s/~/&nbsp;/g;
2147                        $_;
2148                      }  @_
2149                    },
2150                  'footer' =>
2151                    sub { map { s/~/&nbsp;/g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2152                  'smallfooter' =>
2153                    sub { map { s/~/&nbsp;/g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2154                  'returnaddress' =>
2155                    sub {
2156                      map {
2157                        s/~/&nbsp;/g;
2158                        s/\\\\\*?\s*$/<BR>/;
2159                        s/\\hyphenation\{[\w\s\-]+}//;
2160                        s/\\([&])/$1/g;
2161                        $_;
2162                      }  @_
2163                    },
2164                  'coupon'        => sub { "" },
2165                  'summary'       => sub { "" },
2166                },
2167     'template' => {
2168                  'notes' =>
2169                    sub {
2170                      map {
2171                        s/%%.*$//g;
2172                        s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
2173                        s/\\begin\{enumerate\}//g;
2174                        s/\\item /  * /g;
2175                        s/\\end\{enumerate\}//g;
2176                        s/\\textbf\{(.*)\}/$1/g;
2177                        s/\\\\\*/ /;
2178                        s/\\dollar ?/\$/g;
2179                        $_;
2180                      }  @_
2181                    },
2182                  'footer' =>
2183                    sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2184                  'smallfooter' =>
2185                    sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2186                  'returnaddress' =>
2187                    sub {
2188                      map {
2189                        s/~/ /g;
2190                        s/\\\\\*?\s*$/\n/;             # dubious
2191                        s/\\hyphenation\{[\w\s\-]+}//;
2192                        $_;
2193                      }  @_
2194                    },
2195                  'coupon'        => sub { "" },
2196                  'summary'       => sub { "" },
2197                },
2198   );
2199
2200
2201   # hashes for differing output formats
2202   my %nbsps = ( 'latex'    => '~',
2203                 'html'     => '',    # '&nbps;' would be nice
2204                 'template' => '',    # not used
2205               );
2206   my $nbsp = $nbsps{$format};
2207
2208   my %escape_functions = ( 'latex'    => \&_latex_escape,
2209                            'html'     => \&encode_entities,
2210                            'template' => sub { shift },
2211                          );
2212   my $escape_function = $escape_functions{$format};
2213
2214   my %date_formats = ( 'latex'    => '%b %o, %Y',
2215                        'html'     => '%b&nbsp;%o,&nbsp;%Y',
2216                        'template' => '%s',
2217                      );
2218   my $date_format = $date_formats{$format};
2219
2220   my %embolden_functions = ( 'latex'    => sub { return '\textbf{'. shift(). '}'
2221                                                },
2222                              'html'     => sub { return '<b>'. shift(). '</b>'
2223                                                },
2224                              'template' => sub { shift },
2225                            );
2226   my $embolden_function = $embolden_functions{$format};
2227
2228
2229   # generate template variables
2230   my $returnaddress;
2231   if (
2232          defined( $conf->config_orbase( "invoice_${format}returnaddress",
2233                                         $template
2234                                       )
2235                 )
2236        && length( $conf->config_orbase( "invoice_${format}returnaddress",
2237                                         $template
2238                                       )
2239                 )
2240   ) {
2241
2242     $returnaddress = join("\n",
2243       $conf->config_orbase("invoice_${format}returnaddress", $template)
2244     );
2245
2246   } elsif ( grep /\S/,
2247             $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
2248
2249     my $convert_map = $convert_maps{$format}{'returnaddress'};
2250     $returnaddress =
2251       join( "\n",
2252             &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
2253                                                  $template
2254                                                )
2255                          )
2256           );
2257   } elsif ( grep /\S/, $conf->config('company_address', $self->cust_main->agentnum) ) {
2258
2259     my $convert_map = $convert_maps{$format}{'returnaddress'};
2260     $returnaddress = join( "\n", &$convert_map(
2261                                    map { s/( {2,})/'~' x length($1)/eg;
2262                                          s/$/\\\\\*/;
2263                                          $_
2264                                        }
2265                                      ( $conf->config('company_name', $self->cust_main->agentnum),
2266                                        $conf->config('company_address', $self->cust_main->agentnum),
2267                                      )
2268                                  )
2269                      );
2270
2271   } else {
2272
2273     my $warning = "Couldn't find a return address; ".
2274                   "do you need to set the company_address configuration value?";
2275     warn "$warning\n";
2276     $returnaddress = $nbsp;
2277     #$returnaddress = $warning;
2278
2279   }
2280
2281   my $agentnum = $self->cust_main->agentnum;
2282
2283   my %invoice_data = (
2284
2285     #invoice from info
2286     'company_name'    => scalar( $conf->config('company_name', $agentnum) ),
2287     'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
2288     'returnaddress'   => $returnaddress,
2289     'agent'           => &$escape_function($cust_main->agent->agent),
2290
2291     #invoice info
2292     'invnum'          => $self->invnum,
2293     'date'            => time2str($date_format, $self->_date),
2294     'today'           => time2str('%b %o, %Y', $today),
2295     'terms'           => $self->terms,
2296     'template'        => $template, #params{'template'},
2297     'notice_name'     => ($params{'notice_name'} || 'Invoice'),#escape_function?
2298     'current_charges' => sprintf("%.2f", $self->charged),
2299     'duedate'         => $self->due_date2str($rdate_format), #date_format?
2300
2301     #customer info
2302     'custnum'         => $cust_main->display_custnum,
2303     'agent_custid'    => &$escape_function($cust_main->agent_custid),
2304     ( map { $_ => &$escape_function($cust_main->$_()) } qw(
2305       payname company address1 address2 city state zip fax
2306     )),
2307
2308     #global config
2309     'ship_enable'     => $conf->exists('invoice-ship_address'),
2310     'unitprices'      => $conf->exists('invoice-unitprice'),
2311     'smallernotes'    => $conf->exists('invoice-smallernotes'),
2312     'smallerfooter'   => $conf->exists('invoice-smallerfooter'),
2313     'balance_due_below_line' => $conf->exists('balance_due_below_line'),
2314
2315     #layout info -- would be fancy to calc some of this and bury the template
2316     #               here in the code
2317     'topmargin'             => scalar($conf->config('invoice_latextopmargin', $agentnum)),
2318     'headsep'               => scalar($conf->config('invoice_latexheadsep', $agentnum)),
2319     'textheight'            => scalar($conf->config('invoice_latextextheight', $agentnum)),
2320     'extracouponspace'      => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
2321     'couponfootsep'         => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
2322     'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
2323     'addresssep'            => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
2324     'amountenclosedsep'     => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
2325     'coupontoaddresssep'    => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
2326     'addcompanytoaddress'   => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
2327
2328     # better hang on to conf_dir for a while (for old templates)
2329     'conf_dir'        => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
2330
2331     #these are only used when doing paged plaintext
2332     'page'            => 1,
2333     'total_pages'     => 1,
2334
2335   );
2336
2337   $invoice_data{finance_section} = '';
2338   if ( $conf->config('finance_pkgclass') ) {
2339     my $pkg_class =
2340       qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
2341     $invoice_data{finance_section} = $pkg_class->categoryname;
2342   }
2343  $invoice_data{finance_amount} = '0.00';
2344
2345   my $countrydefault = $conf->config('countrydefault') || 'US';
2346   my $prefix = $cust_main->has_ship_address ? 'ship_' : '';
2347   foreach ( qw( contact company address1 address2 city state zip country fax) ){
2348     my $method = $prefix.$_;
2349     $invoice_data{"ship_$_"} = _latex_escape($cust_main->$method);
2350   }
2351   $invoice_data{'ship_country'} = ''
2352     if ( $invoice_data{'ship_country'} eq $countrydefault );
2353
2354   $invoice_data{'cid'} = $params{'cid'}
2355     if $params{'cid'};
2356
2357   if ( $cust_main->country eq $countrydefault ) {
2358     $invoice_data{'country'} = '';
2359   } else {
2360     $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
2361   }
2362
2363   my @address = ();
2364   $invoice_data{'address'} = \@address;
2365   push @address,
2366     $cust_main->payname.
2367       ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
2368         ? " (P.O. #". $cust_main->payinfo. ")"
2369         : ''
2370       )
2371   ;
2372   push @address, $cust_main->company
2373     if $cust_main->company;
2374   push @address, $cust_main->address1;
2375   push @address, $cust_main->address2
2376     if $cust_main->address2;
2377   push @address,
2378     $cust_main->city. ", ". $cust_main->state. "  ".  $cust_main->zip;
2379   push @address, $invoice_data{'country'}
2380     if $invoice_data{'country'};
2381   push @address, ''
2382     while (scalar(@address) < 5);
2383
2384   $invoice_data{'logo_file'} = $params{'logo_file'}
2385     if $params{'logo_file'};
2386
2387   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2388 #  my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
2389   #my $balance_due = $self->owed + $pr_total - $cr_total;
2390   my $balance_due = $self->owed + $pr_total;
2391   $invoice_data{'true_previous_balance'} = sprintf("%.2f", ($self->previous_balance || 0) );
2392   $invoice_data{'balance_adjustments'} = sprintf("%.2f", ($self->previous_balance || 0) - ($self->billing_balance || 0) );
2393   $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
2394   $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
2395
2396   my $summarypage = '';
2397   if ( $conf->exists('invoice_usesummary', $agentnum) ) {
2398     $summarypage = 1;
2399   }
2400   $invoice_data{'summarypage'} = $summarypage;
2401
2402   #do variable substitution in notes, footer, smallfooter
2403   foreach my $include (qw( notes footer smallfooter coupon )) {
2404
2405     my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
2406     my @inc_src;
2407
2408     if ( $conf->exists($inc_file, $agentnum)
2409          && length( $conf->config($inc_file, $agentnum) ) ) {
2410
2411       @inc_src = $conf->config($inc_file, $agentnum);
2412
2413     } else {
2414
2415       $inc_file = $conf->key_orbase("invoice_latex$include", $template);
2416
2417       my $convert_map = $convert_maps{$format}{$include};
2418
2419       @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
2420                        s/--\@\]/$delimiters{$format}[1]/g;
2421                        $_;
2422                      }
2423                  &$convert_map( $conf->config($inc_file, $agentnum) );
2424
2425     }
2426
2427     my $inc_tt = new Text::Template (
2428       TYPE       => 'ARRAY',
2429       SOURCE     => [ map "$_\n", @inc_src ],
2430       DELIMITERS => $delimiters{$format},
2431     ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
2432
2433     unless ( $inc_tt->compile() ) {
2434       my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
2435       warn $error. "Template:\n". join('', map "$_\n", @inc_src);
2436       die $error;
2437     }
2438
2439     $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
2440
2441     $invoice_data{$include} =~ s/\n+$//
2442       if ($format eq 'latex');
2443   }
2444
2445   $invoice_data{'po_line'} =
2446     (  $cust_main->payby eq 'BILL' && $cust_main->payinfo )
2447       ? &$escape_function("Purchase Order #". $cust_main->payinfo)
2448       : $nbsp;
2449
2450   my %money_chars = ( 'latex'    => '',
2451                       'html'     => $conf->config('money_char') || '$',
2452                       'template' => '',
2453                     );
2454   my $money_char = $money_chars{$format};
2455
2456   my %other_money_chars = ( 'latex'    => '\dollar ',#XXX should be a config too
2457                             'html'     => $conf->config('money_char') || '$',
2458                             'template' => '',
2459                           );
2460   my $other_money_char = $other_money_chars{$format};
2461   $invoice_data{'dollar'} = $other_money_char;
2462
2463   my @detail_items = ();
2464   my @total_items = ();
2465   my @buf = ();
2466   my @sections = ();
2467
2468   $invoice_data{'detail_items'} = \@detail_items;
2469   $invoice_data{'total_items'} = \@total_items;
2470   $invoice_data{'buf'} = \@buf;
2471   $invoice_data{'sections'} = \@sections;
2472
2473   my $previous_section = { 'description' => 'Previous Charges',
2474                            'subtotal'    => $other_money_char.
2475                                             sprintf('%.2f', $pr_total),
2476                            'summarized'  => $summarypage ? 'Y' : '',
2477                          };
2478   $previous_section->{posttotal} = '0 / 30 / 60/ 90 days overdue '.
2479     join(' / ', map { $cust_main->balance_date_range(@$_) }
2480                 $self->_prior_month30s
2481         )
2482     if $conf->exists('invoice_include_aging');
2483
2484   my $taxtotal = 0;
2485   my $tax_section = { 'description' => 'Taxes, Surcharges, and Fees',
2486                       'subtotal'    => $taxtotal,   # adjusted below
2487                       'summarized'  => $summarypage ? 'Y' : '',
2488                     };
2489   my $tax_weight = _pkg_category($tax_section->{description})
2490                         ? _pkg_category($tax_section->{description})->weight
2491                         : 0;
2492   $tax_section->{'summarized'} = $summarypage && !$tax_weight ? 'Y' : '';
2493   $tax_section->{'sort_weight'} = $tax_weight;
2494
2495
2496   my $adjusttotal = 0;
2497   my $adjust_section = { 'description' => 'Credits, Payments, and Adjustments',
2498                          'subtotal'    => 0,   # adjusted below
2499                          'summarized'  => $summarypage ? 'Y' : '',
2500                        };
2501   my $adjust_weight = _pkg_category($adjust_section->{description})
2502                         ? _pkg_category($adjust_section->{description})->weight
2503                         : 0;
2504   $adjust_section->{'summarized'} = $summarypage && !$adjust_weight ? 'Y' : '';
2505   $adjust_section->{'sort_weight'} = $adjust_weight;
2506
2507   my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
2508   my $multisection = $conf->exists('invoice_sections', $cust_main->agentnum);
2509   $invoice_data{'multisection'} = $multisection;
2510   my $late_sections = [];
2511   my $extra_sections = [];
2512   my $extra_lines = ();
2513   if ( $multisection ) {
2514     ($extra_sections, $extra_lines) =
2515       $self->_items_extra_usage_sections($escape_function, $format)
2516       if $conf->exists('usage_class_as_a_section', $cust_main->agentnum);
2517
2518     push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
2519
2520     push @detail_items, @$extra_lines if $extra_lines;
2521     push @sections,
2522       $self->_items_sections( $late_sections,      # this could stand a refactor
2523                               $summarypage,
2524                               $escape_function,
2525                               $extra_sections,
2526                               $format,             #bah
2527                             );
2528     if ($conf->exists('svc_phone_sections')) {
2529       my ($phone_sections, $phone_lines) =
2530         $self->_items_svc_phone_sections($escape_function, $format);
2531       push @{$late_sections}, @$phone_sections;
2532       push @detail_items, @$phone_lines;
2533     }
2534   }else{
2535     push @sections, { 'description' => '', 'subtotal' => '' };
2536   }
2537
2538   unless (    $conf->exists('disable_previous_balance')
2539            || $conf->exists('previous_balance-summary_only')
2540          )
2541   {
2542
2543     foreach my $line_item ( $self->_items_previous ) {
2544
2545       my $detail = {
2546         ext_description => [],
2547       };
2548       $detail->{'ref'} = $line_item->{'pkgnum'};
2549       $detail->{'quantity'} = 1;
2550       $detail->{'section'} = $previous_section;
2551       $detail->{'description'} = &$escape_function($line_item->{'description'});
2552       if ( exists $line_item->{'ext_description'} ) {
2553         @{$detail->{'ext_description'}} = map {
2554           &$escape_function($_);
2555         } @{$line_item->{'ext_description'}};
2556       }
2557       $detail->{'amount'} = ( $old_latex ? '' : $money_char).
2558                             $line_item->{'amount'};
2559       $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2560
2561       push @detail_items, $detail;
2562       push @buf, [ $detail->{'description'},
2563                    $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2564                  ];
2565     }
2566
2567   }
2568
2569   if ( @pr_cust_bill && !$conf->exists('disable_previous_balance') ) {
2570     push @buf, ['','-----------'];
2571     push @buf, [ 'Total Previous Balance',
2572                  $money_char. sprintf("%10.2f", $pr_total) ];
2573     push @buf, ['',''];
2574   }
2575
2576   foreach my $section (@sections, @$late_sections) {
2577
2578     $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
2579       if ( $invoice_data{finance_section} &&
2580            $section->{'description'} eq $invoice_data{finance_section} );
2581
2582     $section->{'subtotal'} = $other_money_char.
2583                              sprintf('%.2f', $section->{'subtotal'})
2584       if $multisection;
2585
2586     # begin some normalization
2587     $section->{'amount'}   = $section->{'subtotal'}
2588       if $multisection;
2589
2590
2591     if ( $section->{'description'} ) {
2592       push @buf, ( [ &$escape_function($section->{'description'}), '' ],
2593                    [ '', '' ],
2594                  );
2595     }
2596
2597     my $multilocation = scalar($cust_main->cust_location); #too expensive?
2598     my %options = ();
2599     $options{'section'} = $section if $multisection;
2600     $options{'format'} = $format;
2601     $options{'escape_function'} = $escape_function;
2602     $options{'format_function'} = sub { () } unless $unsquelched;
2603     $options{'unsquelched'} = $unsquelched;
2604     $options{'summary_page'} = $summarypage;
2605     $options{'skip_usage'} =
2606       scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
2607     $options{'multilocation'} = $multilocation;
2608
2609     foreach my $line_item ( $self->_items_pkg(%options) ) {
2610       my $detail = {
2611         ext_description => [],
2612       };
2613       $detail->{'ref'} = $line_item->{'pkgnum'};
2614       $detail->{'quantity'} = $line_item->{'quantity'};
2615       $detail->{'section'} = $section;
2616       $detail->{'description'} = &$escape_function($line_item->{'description'});
2617       if ( exists $line_item->{'ext_description'} ) {
2618         @{$detail->{'ext_description'}} = @{$line_item->{'ext_description'}};
2619       }
2620       $detail->{'amount'} = ( $old_latex ? '' : $money_char ).
2621                               $line_item->{'amount'};
2622       $detail->{'unit_amount'} = ( $old_latex ? '' : $money_char ).
2623                                  $line_item->{'unit_amount'};
2624       $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2625
2626       push @detail_items, $detail;
2627       push @buf, ( [ $detail->{'description'},
2628                      $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2629                    ],
2630                    map { [ " ". $_, '' ] } @{$detail->{'ext_description'}},
2631                  );
2632     }
2633
2634     if ( $section->{'description'} ) {
2635       push @buf, ( ['','-----------'],
2636                    [ $section->{'description'}. ' sub-total',
2637                       $money_char. sprintf("%10.2f", $section->{'subtotal'})
2638                    ],
2639                    [ '', '' ],
2640                    [ '', '' ],
2641                  );
2642     }
2643
2644   }
2645
2646   $invoice_data{current_less_finance} =
2647     sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
2648
2649   if ( $multisection && !$conf->exists('disable_previous_balance')
2650     || $conf->exists('previous_balance-summary_only') )
2651   {
2652     unshift @sections, $previous_section if $pr_total;
2653   }
2654
2655   foreach my $tax ( $self->_items_tax ) {
2656
2657     $taxtotal += $tax->{'amount'};
2658
2659     my $description = &$escape_function( $tax->{'description'} );
2660     my $amount      = sprintf( '%.2f', $tax->{'amount'} );
2661
2662     if ( $multisection ) {
2663
2664       my $money = $old_latex ? '' : $money_char;
2665       push @detail_items, {
2666         ext_description => [],
2667         ref          => '',
2668         quantity     => '',
2669         description  => $description,
2670         amount       => $money. $amount,
2671         product_code => '',
2672         section      => $tax_section,
2673       };
2674
2675     } else {
2676
2677       push @total_items, {
2678         'total_item'   => $description,
2679         'total_amount' => $other_money_char. $amount,
2680       };
2681
2682     }
2683
2684     push @buf,[ $description,
2685                 $money_char. $amount,
2686               ];
2687
2688   }
2689
2690   if ( $taxtotal ) {
2691     my $total = {};
2692     $total->{'total_item'} = 'Sub-total';
2693     $total->{'total_amount'} =
2694       $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
2695
2696     if ( $multisection ) {
2697       $tax_section->{'subtotal'} = $other_money_char.
2698                                    sprintf('%.2f', $taxtotal);
2699       $tax_section->{'pretotal'} = 'New charges sub-total '.
2700                                    $total->{'total_amount'};
2701       push @sections, $tax_section if $taxtotal;
2702     }else{
2703       unshift @total_items, $total;
2704     }
2705   }
2706   $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
2707
2708   push @buf,['','-----------'];
2709   push @buf,[( $conf->exists('disable_previous_balance')
2710                ? 'Total Charges'
2711                : 'Total New Charges'
2712              ),
2713              $money_char. sprintf("%10.2f",$self->charged) ];
2714   push @buf,['',''];
2715
2716   {
2717     my $total = {};
2718     my $item = 'Total';
2719     $item = $conf->config('previous_balance-exclude_from_total')
2720          || 'Total New Charges'
2721       if $conf->exists('previous_balance-exclude_from_total');
2722     my $amount = $self->charged +
2723                    ( $conf->exists('disable_previous_balance') ||
2724                      $conf->exists('previous_balance-exclude_from_total')
2725                      ? 0
2726                      : $pr_total
2727                    );
2728     $total->{'total_item'} = &$embolden_function($item);
2729     $total->{'total_amount'} =
2730       &$embolden_function( $other_money_char.  sprintf( '%.2f', $amount ) );
2731     if ( $multisection ) {
2732       if ( $adjust_section->{'sort_weight'} ) {
2733         $adjust_section->{'posttotal'} = 'Balance Forward '. $other_money_char.
2734           sprintf("%.2f", ($self->billing_balance || 0) );
2735       } else {
2736         $adjust_section->{'pretotal'} = 'New charges total '. $other_money_char.
2737                                         sprintf('%.2f', $self->charged );
2738       }
2739     }else{
2740       push @total_items, $total;
2741     }
2742     push @buf,['','-----------'];
2743     push @buf,[$item,
2744                $money_char.
2745                sprintf( '%10.2f', $amount )
2746               ];
2747     push @buf,['',''];
2748   }
2749
2750   unless ( $conf->exists('disable_previous_balance') ) {
2751     #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
2752
2753     # credits
2754     my $credittotal = 0;
2755     foreach my $credit ( $self->_items_credits('trim_len'=>60) ) {
2756
2757       my $total;
2758       $total->{'total_item'} = &$escape_function($credit->{'description'});
2759       $credittotal += $credit->{'amount'};
2760       $total->{'total_amount'} = '-'. $other_money_char. $credit->{'amount'};
2761       $adjusttotal += $credit->{'amount'};
2762       if ( $multisection ) {
2763         my $money = $old_latex ? '' : $money_char;
2764         push @detail_items, {
2765           ext_description => [],
2766           ref          => '',
2767           quantity     => '',
2768           description  => &$escape_function($credit->{'description'}),
2769           amount       => $money. $credit->{'amount'},
2770           product_code => '',
2771           section      => $adjust_section,
2772         };
2773       } else {
2774         push @total_items, $total;
2775       }
2776
2777     }
2778     $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
2779
2780     #credits (again)
2781     foreach my $credit ( $self->_items_credits('trim_len'=>32) ) {
2782       push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
2783     }
2784
2785     # payments
2786     my $paymenttotal = 0;
2787     foreach my $payment ( $self->_items_payments ) {
2788       my $total = {};
2789       $total->{'total_item'} = &$escape_function($payment->{'description'});
2790       $paymenttotal += $payment->{'amount'};
2791       $total->{'total_amount'} = '-'. $other_money_char. $payment->{'amount'};
2792       $adjusttotal += $payment->{'amount'};
2793       if ( $multisection ) {
2794         my $money = $old_latex ? '' : $money_char;
2795         push @detail_items, {
2796           ext_description => [],
2797           ref          => '',
2798           quantity     => '',
2799           description  => &$escape_function($payment->{'description'}),
2800           amount       => $money. $payment->{'amount'},
2801           product_code => '',
2802           section      => $adjust_section,
2803         };
2804       }else{
2805         push @total_items, $total;
2806       }
2807       push @buf, [ $payment->{'description'},
2808                    $money_char. sprintf("%10.2f", $payment->{'amount'}),
2809                  ];
2810     }
2811     $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
2812
2813     if ( $multisection ) {
2814       $adjust_section->{'subtotal'} = $other_money_char.
2815                                       sprintf('%.2f', $adjusttotal);
2816       push @sections, $adjust_section
2817         unless $adjust_section->{sort_weight};
2818     }
2819
2820     {
2821       my $total;
2822       $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
2823       $total->{'total_amount'} =
2824         &$embolden_function(
2825           $other_money_char. sprintf('%.2f', $summarypage
2826                                                ? $self->charged +
2827                                                  $self->billing_balance
2828                                                : $self->owed + $pr_total
2829                                     )
2830         );
2831       if ( $multisection && !$adjust_section->{sort_weight} ) {
2832         $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
2833                                          $total->{'total_amount'};
2834       }else{
2835         push @total_items, $total;
2836       }
2837       push @buf,['','-----------'];
2838       push @buf,[$self->balance_due_msg, $money_char.
2839         sprintf("%10.2f", $balance_due ) ];
2840     }
2841   }
2842
2843   if ( $multisection ) {
2844     if ($conf->exists('svc_phone_sections')) {
2845       my $total;
2846       $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
2847       $total->{'total_amount'} =
2848         &$embolden_function(
2849           $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
2850         );
2851       my $last_section = pop @sections;
2852       $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
2853                                      $total->{'total_amount'};
2854       push @sections, $last_section;
2855     }
2856     push @sections, @$late_sections
2857       if $unsquelched;
2858   }
2859
2860   my @includelist = ();
2861   push @includelist, 'summary' if $summarypage;
2862   foreach my $include ( @includelist ) {
2863
2864     my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
2865     my @inc_src;
2866
2867     if ( length( $conf->config($inc_file, $agentnum) ) ) {
2868
2869       @inc_src = $conf->config($inc_file, $agentnum);
2870
2871     } else {
2872
2873       $inc_file = $conf->key_orbase("invoice_latex$include", $template);
2874
2875       my $convert_map = $convert_maps{$format}{$include};
2876
2877       @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
2878                        s/--\@\]/$delimiters{$format}[1]/g;
2879                        $_;
2880                      }
2881                  &$convert_map( $conf->config($inc_file, $agentnum) );
2882
2883     }
2884
2885     my $inc_tt = new Text::Template (
2886       TYPE       => 'ARRAY',
2887       SOURCE     => [ map "$_\n", @inc_src ],
2888       DELIMITERS => $delimiters{$format},
2889     ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
2890
2891     unless ( $inc_tt->compile() ) {
2892       my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
2893       warn $error. "Template:\n". join('', map "$_\n", @inc_src);
2894       die $error;
2895     }
2896
2897     $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
2898
2899     $invoice_data{$include} =~ s/\n+$//
2900       if ($format eq 'latex');
2901   }
2902
2903   $invoice_lines = 0;
2904   my $wasfunc = 0;
2905   foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
2906     /invoice_lines\((\d*)\)/;
2907     $invoice_lines += $1 || scalar(@buf);
2908     $wasfunc=1;
2909   }
2910   die "no invoice_lines() functions in template?"
2911     if ( $format eq 'template' && !$wasfunc );
2912
2913   if ($format eq 'template') {
2914
2915     if ( $invoice_lines ) {
2916       $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
2917       $invoice_data{'total_pages'}++
2918         if scalar(@buf) % $invoice_lines;
2919     }
2920
2921     #setup subroutine for the template
2922     sub FS::cust_bill::_template::invoice_lines {
2923       my $lines = shift || scalar(@FS::cust_bill::_template::buf);
2924       map {
2925         scalar(@FS::cust_bill::_template::buf)
2926           ? shift @FS::cust_bill::_template::buf
2927           : [ '', '' ];
2928       }
2929       ( 1 .. $lines );
2930     }
2931
2932     my $lines;
2933     my @collect;
2934     while (@buf) {
2935       push @collect, split("\n",
2936         $text_template->fill_in( HASH => \%invoice_data,
2937                                  PACKAGE => 'FS::cust_bill::_template'
2938                                )
2939       );
2940       $FS::cust_bill::_template::page++;
2941     }
2942     map "$_\n", @collect;
2943   }else{
2944     warn "filling in template for invoice ". $self->invnum. "\n"
2945       if $DEBUG;
2946     warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
2947       if $DEBUG > 1;
2948
2949     $text_template->fill_in(HASH => \%invoice_data);
2950   }
2951 }
2952
2953 # helper routine for generating date ranges
2954 sub _prior_month30s {
2955   my $self = shift;
2956   my @ranges = (
2957    [ 1,       2592000 ], # 0-30 days ago
2958    [ 2592000, 5184000 ], # 30-60 days ago
2959    [ 5184000, 7776000 ], # 60-90 days ago
2960    [ 7776000, 0       ], # 90+   days ago
2961   );
2962
2963   map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
2964           $_->[1] ? $self->_date - $_->[1] - 1 : '',
2965       ] }
2966   @ranges;
2967 }
2968
2969 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
2970
2971 Returns an postscript invoice, as a scalar.
2972
2973 Options can be passed as a hashref (recommended) or as a list of time, template
2974 and then any key/value pairs for any other options.
2975
2976 I<time> an optional value used to control the printing of overdue messages.  The
2977 default is now.  It isn't the date of the invoice; that's the `_date' field.
2978 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2979 L<Time::Local> and L<Date::Parse> for conversion functions.
2980
2981 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2982
2983 =cut
2984
2985 sub print_ps {
2986   my $self = shift;
2987
2988   my ($file, $lfile) = $self->print_latex(@_);
2989   my $ps = generate_ps($file);
2990   unlink($lfile);
2991
2992   $ps;
2993 }
2994
2995 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
2996
2997 Returns an PDF invoice, as a scalar.
2998
2999 Options can be passed as a hashref (recommended) or as a list of time, template
3000 and then any key/value pairs for any other options.
3001
3002 I<time> an optional value used to control the printing of overdue messages.  The
3003 default is now.  It isn't the date of the invoice; that's the `_date' field.
3004 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
3005 L<Time::Local> and L<Date::Parse> for conversion functions.
3006
3007 I<template>, if specified, is the name of a suffix for alternate invoices.
3008
3009 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3010
3011 =cut
3012
3013 sub print_pdf {
3014   my $self = shift;
3015
3016   my ($file, $lfile) = $self->print_latex(@_);
3017   my $pdf = generate_pdf($file);
3018   unlink($lfile);
3019
3020   $pdf;
3021 }
3022
3023 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
3024
3025 Returns an HTML invoice, as a scalar.
3026
3027 I<time> an optional value used to control the printing of overdue messages.  The
3028 default is now.  It isn't the date of the invoice; that's the `_date' field.
3029 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
3030 L<Time::Local> and L<Date::Parse> for conversion functions.
3031
3032 I<template>, if specified, is the name of a suffix for alternate invoices.
3033
3034 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3035
3036 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
3037 when emailing the invoice as part of a multipart/related MIME email.
3038
3039 =cut
3040
3041 sub print_html {
3042   my $self = shift;
3043   my %params;
3044   if ( ref($_[0]) ) {
3045     %params = %{ shift() };
3046   }else{
3047     $params{'time'} = shift;
3048     $params{'template'} = shift;
3049     $params{'cid'} = shift;
3050   }
3051
3052   $params{'format'} = 'html';
3053
3054   $self->print_generic( %params );
3055 }
3056
3057 # quick subroutine for print_latex
3058 #
3059 # There are ten characters that LaTeX treats as special characters, which
3060 # means that they do not simply typeset themselves:
3061 #      # $ % & ~ _ ^ \ { }
3062 #
3063 # TeX ignores blanks following an escaped character; if you want a blank (as
3064 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
3065
3066 sub _latex_escape {
3067   my $value = shift;
3068   $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
3069   $value =~ s/([<>])/\$$1\$/g;
3070   $value;
3071 }
3072
3073 #utility methods for print_*
3074
3075 sub _translate_old_latex_format {
3076   warn "_translate_old_latex_format called\n"
3077     if $DEBUG;
3078
3079   my @template = ();
3080   while ( @_ ) {
3081     my $line = shift;
3082
3083     if ( $line =~ /^%%Detail\s*$/ ) {
3084
3085       push @template, q![@--!,
3086                       q!  foreach my $_tr_line (@detail_items) {!,
3087                       q!    if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
3088                       q!      $_tr_line->{'description'} .= !,
3089                       q!        "\\tabularnewline\n~~".!,
3090                       q!        join( "\\tabularnewline\n~~",!,
3091                       q!          @{$_tr_line->{'ext_description'}}!,
3092                       q!        );!,
3093                       q!    }!;
3094
3095       while ( ( my $line_item_line = shift )
3096               !~ /^%%EndDetail\s*$/                            ) {
3097         $line_item_line =~ s/'/\\'/g;    # nice LTS
3098         $line_item_line =~ s/\\/\\\\/g;  # escape quotes and backslashes
3099         $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3100         push @template, "    \$OUT .= '$line_item_line';";
3101       }
3102
3103       push @template, '}',
3104                       '--@]';
3105       #' doh, gvim
3106     } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
3107
3108       push @template, '[@--',
3109                       '  foreach my $_tr_line (@total_items) {';
3110
3111       while ( ( my $total_item_line = shift )
3112               !~ /^%%EndTotalDetails\s*$/                      ) {
3113         $total_item_line =~ s/'/\\'/g;    # nice LTS
3114         $total_item_line =~ s/\\/\\\\/g;  # escape quotes and backslashes
3115         $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3116         push @template, "    \$OUT .= '$total_item_line';";
3117       }
3118
3119       push @template, '}',
3120                       '--@]';
3121
3122     } else {
3123       $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
3124       push @template, $line;
3125     }
3126
3127   }
3128
3129   if ($DEBUG) {
3130     warn "$_\n" foreach @template;
3131   }
3132
3133   (@template);
3134 }
3135
3136 sub terms {
3137   my $self = shift;
3138
3139   #check for an invoice-specific override
3140   return $self->invoice_terms if $self->invoice_terms;
3141
3142   #check for a customer- specific override
3143   my $cust_main = $self->cust_main;
3144   return $cust_main->invoice_terms if $cust_main->invoice_terms;
3145
3146   #use configured default
3147   $conf->config('invoice_default_terms') || '';
3148 }
3149
3150 sub due_date {
3151   my $self = shift;
3152   my $duedate = '';
3153   if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
3154     $duedate = $self->_date() + ( $1 * 86400 );
3155   }
3156   $duedate;
3157 }
3158
3159 sub due_date2str {
3160   my $self = shift;
3161   $self->due_date ? time2str(shift, $self->due_date) : '';
3162 }
3163
3164 sub balance_due_msg {
3165   my $self = shift;
3166   my $msg = 'Balance Due';
3167   return $msg unless $self->terms;
3168   if ( $self->due_date ) {
3169     $msg .= ' - Please pay by '. $self->due_date2str($date_format);
3170   } elsif ( $self->terms ) {
3171     $msg .= ' - '. $self->terms;
3172   }
3173   $msg;
3174 }
3175
3176 sub balance_due_date {
3177   my $self = shift;
3178   my $duedate = '';
3179   if (    $conf->exists('invoice_default_terms')
3180        && $conf->config('invoice_default_terms')=~ /^\s*Net\s*(\d+)\s*$/ ) {
3181     $duedate = time2str($rdate_format, $self->_date + ($1*86400) );
3182   }
3183   $duedate;
3184 }
3185
3186 =item invnum_date_pretty
3187
3188 Returns a string with the invoice number and date, for example:
3189 "Invoice #54 (3/20/2008)"
3190
3191 =cut
3192
3193 sub invnum_date_pretty {
3194   my $self = shift;
3195   'Invoice #'. $self->invnum. ' ('. $self->_date_pretty. ')';
3196 }
3197
3198 =item _date_pretty
3199
3200 Returns a string with the date, for example: "3/20/2008"
3201
3202 =cut
3203
3204 sub _date_pretty {
3205   my $self = shift;
3206   time2str($date_format, $self->_date);
3207 }
3208
3209 use vars qw(%pkg_category_cache);
3210 sub _items_sections {
3211   my $self = shift;
3212   my $late = shift;
3213   my $summarypage = shift;
3214   my $escape = shift;
3215   my $extra_sections = shift;
3216   my $format = shift;
3217
3218   my %subtotal = ();
3219   my %late_subtotal = ();
3220   my %not_tax = ();
3221
3222   foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
3223   {
3224
3225       my $usage = $cust_bill_pkg->usage;
3226
3227       foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
3228         next if ( $display->summary && $summarypage );
3229
3230         my $section = $display->section;
3231         my $type    = $display->type;
3232
3233         $not_tax{$section} = 1
3234           unless $cust_bill_pkg->pkgnum == 0;
3235
3236         if ( $display->post_total && !$summarypage ) {
3237           if (! $type || $type eq 'S') {
3238             $late_subtotal{$section} += $cust_bill_pkg->setup
3239               if $cust_bill_pkg->setup != 0;
3240           }
3241
3242           if (! $type) {
3243             $late_subtotal{$section} += $cust_bill_pkg->recur
3244               if $cust_bill_pkg->recur != 0;
3245           }
3246
3247           if ($type && $type eq 'R') {
3248             $late_subtotal{$section} += $cust_bill_pkg->recur - $usage
3249               if $cust_bill_pkg->recur != 0;
3250           }
3251
3252           if ($type && $type eq 'U') {
3253             $late_subtotal{$section} += $usage
3254               unless scalar(@$extra_sections);
3255           }
3256
3257         } else {
3258
3259           next if $cust_bill_pkg->pkgnum == 0 && ! $section;
3260
3261           if (! $type || $type eq 'S') {
3262             $subtotal{$section} += $cust_bill_pkg->setup
3263               if $cust_bill_pkg->setup != 0;
3264           }
3265
3266           if (! $type) {
3267             $subtotal{$section} += $cust_bill_pkg->recur
3268               if $cust_bill_pkg->recur != 0;
3269           }
3270
3271           if ($type && $type eq 'R') {
3272             $subtotal{$section} += $cust_bill_pkg->recur - $usage
3273               if $cust_bill_pkg->recur != 0;
3274           }
3275
3276           if ($type && $type eq 'U') {
3277             $subtotal{$section} += $usage
3278               unless scalar(@$extra_sections);
3279           }
3280
3281         }
3282
3283       }
3284
3285   }
3286
3287   %pkg_category_cache = ();
3288
3289   push @$late, map { { 'description' => &{$escape}($_),
3290                        'subtotal'    => $late_subtotal{$_},
3291                        'post_total'  => 1,
3292                        'sort_weight' => ( _pkg_category($_)
3293                                             ? _pkg_category($_)->weight
3294                                             : 0
3295                                        ),
3296                        ((_pkg_category($_) && _pkg_category($_)->condense)
3297                                            ? $self->_condense_section($format)
3298                                            : ()
3299                        ),
3300                    } }
3301                  sort _sectionsort keys %late_subtotal;
3302
3303   my @sections;
3304   if ( $summarypage ) {
3305     @sections = grep { exists($subtotal{$_}) || ! _pkg_category($_)->disabled }
3306                 map { $_->categoryname } qsearch('pkg_category', {});
3307   } else {
3308     @sections = keys %subtotal;
3309   }
3310
3311   my @early = map { { 'description' => &{$escape}($_),
3312                       'subtotal'    => $subtotal{$_},
3313                       'summarized'  => $not_tax{$_} ? '' : 'Y',
3314                       'tax_section' => $not_tax{$_} ? '' : 'Y',
3315                       'sort_weight' => ( _pkg_category($_)
3316                                            ? _pkg_category($_)->weight
3317                                            : 0
3318                                        ),
3319                        ((_pkg_category($_) && _pkg_category($_)->condense)
3320                                            ? $self->_condense_section($format)
3321                                            : ()
3322                        ),
3323                     }
3324                   } @sections;
3325   push @early, @$extra_sections if $extra_sections;
3326
3327   sort { $a->{sort_weight} <=> $b->{sort_weight} } @early;
3328
3329 }
3330
3331 #helper subs for above
3332
3333 sub _sectionsort {
3334   _pkg_category($a)->weight <=> _pkg_category($b)->weight;
3335 }
3336
3337 sub _pkg_category {
3338   my $categoryname = shift;
3339   $pkg_category_cache{$categoryname} ||=
3340     qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
3341 }
3342
3343 my %condensed_format = (
3344   'label' => [ qw( Description Qty Amount ) ],
3345   'fields' => [
3346                 sub { shift->{description} },
3347                 sub { shift->{quantity} },
3348                 sub { shift->{amount} },
3349               ],
3350   'align'  => [ qw( l r r ) ],
3351   'span'   => [ qw( 5 1 1 ) ],            # unitprices?
3352   'width'  => [ qw( 10.7cm 1.4cm 1.6cm ) ],   # don't like this
3353 );
3354
3355 sub _condense_section {
3356   my ( $self, $format ) = ( shift, shift );
3357   ( 'condensed' => 1,
3358     map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
3359       qw( description_generator
3360           header_generator
3361           total_generator
3362           total_line_generator
3363         )
3364   );
3365 }
3366
3367 sub _condensed_generator_defaults {
3368   my ( $self, $format ) = ( shift, shift );
3369   return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
3370 }
3371
3372 my %html_align = (
3373   'c' => 'center',
3374   'l' => 'left',
3375   'r' => 'right',
3376 );
3377
3378 sub _condensed_header_generator {
3379   my ( $self, $format ) = ( shift, shift );
3380
3381   my ( $f, $prefix, $suffix, $separator, $column ) =
3382     _condensed_generator_defaults($format);
3383
3384   if ($format eq 'latex') {
3385     $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
3386     $suffix = "\\\\\n\\hline";
3387     $separator = "&\n";
3388     $column =
3389       sub { my ($d,$a,$s,$w) = @_;
3390             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
3391           };
3392   } elsif ( $format eq 'html' ) {
3393     $prefix = '<th></th>';
3394     $suffix = '';
3395     $separator = '';
3396     $column =
3397       sub { my ($d,$a,$s,$w) = @_;
3398             return qq!<th align="$html_align{$a}">$d</th>!;
3399       };
3400   }
3401
3402   sub {
3403     my @args = @_;
3404     my @result = ();
3405
3406     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
3407       push @result,
3408         &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
3409     }
3410
3411     $prefix. join($separator, @result). $suffix;
3412   };
3413
3414 }
3415
3416 sub _condensed_description_generator {
3417   my ( $self, $format ) = ( shift, shift );
3418
3419   my ( $f, $prefix, $suffix, $separator, $column ) =
3420     _condensed_generator_defaults($format);
3421
3422   if ($format eq 'latex') {
3423     $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
3424     $suffix = '\\\\';
3425     $separator = " & \n";
3426     $column =
3427       sub { my ($d,$a,$s,$w) = @_;
3428             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
3429           };
3430   }elsif ( $format eq 'html' ) {
3431     $prefix = '"><td align="center"></td>';
3432     $suffix = '';
3433     $separator = '';
3434     $column =
3435       sub { my ($d,$a,$s,$w) = @_;
3436             return qq!<td align="$html_align{$a}">$d</td>!;
3437       };
3438   }
3439
3440   sub {
3441     my @args = @_;
3442     my @result = ();
3443
3444     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
3445       push @result, &{$column}( &{$f->{fields}->[$i]}(@args),
3446                                 map { $f->{$_}->[$i] } qw(align span width)
3447                               );
3448     }
3449
3450     $prefix. join( $separator, @result ). $suffix;
3451   };
3452
3453 }
3454
3455 sub _condensed_total_generator {
3456   my ( $self, $format ) = ( shift, shift );
3457
3458   my ( $f, $prefix, $suffix, $separator, $column ) =
3459     _condensed_generator_defaults($format);
3460   my $style = '';
3461
3462   if ($format eq 'latex') {
3463     $prefix = "& ";
3464     $suffix = "\\\\\n";
3465     $separator = " & \n";
3466     $column =
3467       sub { my ($d,$a,$s,$w) = @_;
3468             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3469           };
3470   }elsif ( $format eq 'html' ) {
3471     $prefix = '';
3472     $suffix = '';
3473     $separator = '';
3474     $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3475     $column =
3476       sub { my ($d,$a,$s,$w) = @_;
3477             return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3478       };
3479   }
3480
3481
3482   sub {
3483     my @args = @_;
3484     my @result = ();
3485
3486     #  my $r = &{$f->{fields}->[$i]}(@args);
3487     #  $r .= ' Total' unless $i;
3488
3489     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
3490       push @result,
3491         &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
3492                     map { $f->{$_}->[$i] } qw(align span width)
3493                   );
3494     }
3495
3496     $prefix. join( $separator, @result ). $suffix;
3497   };
3498
3499 }
3500
3501 =item total_line_generator FORMAT
3502
3503 Returns a coderef used for generation of invoice total line items for this
3504 usage_class.  FORMAT is either html or latex
3505
3506 =cut
3507
3508 # should not be used: will have issues with hash element names (description vs
3509 # total_item and amount vs total_amount -- another array of functions?
3510
3511 sub _condensed_total_line_generator {
3512   my ( $self, $format ) = ( shift, shift );
3513
3514   my ( $f, $prefix, $suffix, $separator, $column ) =
3515     _condensed_generator_defaults($format);
3516   my $style = '';
3517
3518   if ($format eq 'latex') {
3519     $prefix = "& ";
3520     $suffix = "\\\\\n";
3521     $separator = " & \n";
3522     $column =
3523       sub { my ($d,$a,$s,$w) = @_;
3524             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3525           };
3526   }elsif ( $format eq 'html' ) {
3527     $prefix = '';
3528     $suffix = '';
3529     $separator = '';
3530     $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3531     $column =
3532       sub { my ($d,$a,$s,$w) = @_;
3533             return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3534       };
3535   }
3536
3537
3538   sub {
3539     my @args = @_;
3540     my @result = ();
3541
3542     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
3543       push @result,
3544         &{$column}( &{$f->{fields}->[$i]}(@args),
3545                     map { $f->{$_}->[$i] } qw(align span width)
3546                   );
3547     }
3548
3549     $prefix. join( $separator, @result ). $suffix;
3550   };
3551
3552 }
3553
3554 #sub _items_extra_usage_sections {
3555 #  my $self = shift;
3556 #  my $escape = shift;
3557 #
3558 #  my %sections = ();
3559 #
3560 #  my %usage_class =  map{ $_->classname, $_ } qsearch('usage_class', {});
3561 #  foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
3562 #  {
3563 #    next unless $cust_bill_pkg->pkgnum > 0;
3564 #
3565 #    foreach my $section ( keys %usage_class ) {
3566 #
3567 #      my $usage = $cust_bill_pkg->usage($section);
3568 #
3569 #      next unless $usage && $usage > 0;
3570 #
3571 #      $sections{$section} ||= 0;
3572 #      $sections{$section} += $usage;
3573 #
3574 #    }
3575 #
3576 #  }
3577 #
3578 #  map { { 'description' => &{$escape}($_),
3579 #          'subtotal'    => $sections{$_},
3580 #          'summarized'  => '',
3581 #          'tax_section' => '',
3582 #        }
3583 #      }
3584 #    sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
3585 #
3586 #}
3587
3588 sub _items_extra_usage_sections {
3589   my $self = shift;
3590   my $escape = shift;
3591   my $format = shift;
3592
3593   my %sections = ();
3594   my %classnums = ();
3595   my %lines = ();
3596
3597   my %usage_class =  map { $_->classnum => $_ } qsearch( 'usage_class', {} );
3598   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
3599     next unless $cust_bill_pkg->pkgnum > 0;
3600
3601     foreach my $classnum ( keys %usage_class ) {
3602       my $section = $usage_class{$classnum}->classname;
3603       $classnums{$section} = $classnum;
3604
3605       foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
3606         my $amount = $detail->amount;
3607         next unless $amount && $amount > 0;
3608
3609         $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
3610         $sections{$section}{amount} += $amount;  #subtotal
3611         $sections{$section}{calls}++;
3612         $sections{$section}{duration} += $detail->duration;
3613
3614         my $desc = $detail->regionname;
3615         my $description = $desc;
3616         $description = substr($desc, 0, 50). '...'
3617           if $format eq 'latex' && length($desc) > 50;
3618
3619         $lines{$section}{$desc} ||= {
3620           description     => &{$escape}($description),
3621           #pkgpart         => $part_pkg->pkgpart,
3622           pkgnum          => $cust_bill_pkg->pkgnum,
3623           ref             => '',
3624           amount          => 0,
3625           calls           => 0,
3626           duration        => 0,
3627           #unit_amount     => $cust_bill_pkg->unitrecur,
3628           quantity        => $cust_bill_pkg->quantity,
3629           product_code    => 'N/A',
3630           ext_description => [],
3631         };
3632
3633         $lines{$section}{$desc}{amount} += $amount;
3634         $lines{$section}{$desc}{calls}++;
3635         $lines{$section}{$desc}{duration} += $detail->duration;
3636
3637       }
3638     }
3639   }
3640
3641   my %sectionmap = ();
3642   foreach (keys %sections) {
3643     my $usage_class = $usage_class{$classnums{$_}};
3644     $sectionmap{$_} = { 'description' => &{$escape}($_),
3645                         'amount'    => $sections{$_}{amount},    #subtotal
3646                         'calls'       => $sections{$_}{calls},
3647                         'duration'    => $sections{$_}{duration},
3648                         'summarized'  => '',
3649                         'tax_section' => '',
3650                         'sort_weight' => $usage_class->weight,
3651                         ( $usage_class->format
3652                           ? ( map { $_ => $usage_class->$_($format) }
3653                               qw( description_generator header_generator total_generator total_line_generator )
3654                             )
3655                           : ()
3656                         ),
3657                       };
3658   }
3659
3660   my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
3661                  values %sectionmap;
3662
3663   my @lines = ();
3664   foreach my $section ( keys %lines ) {
3665     foreach my $line ( keys %{$lines{$section}} ) {
3666       my $l = $lines{$section}{$line};
3667       $l->{section}     = $sectionmap{$section};
3668       $l->{amount}      = sprintf( "%.2f", $l->{amount} );
3669       #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
3670       push @lines, $l;
3671     }
3672   }
3673
3674   return(\@sections, \@lines);
3675
3676 }
3677
3678 sub _items_svc_phone_sections {
3679   my $self = shift;
3680   my $escape = shift;
3681   my $format = shift;
3682
3683   my %sections = ();
3684   my %classnums = ();
3685   my %lines = ();
3686
3687   my %usage_class =  map { $_->classnum => $_ } qsearch( 'usage_class', {} );
3688
3689   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
3690     next unless $cust_bill_pkg->pkgnum > 0;
3691
3692     foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
3693
3694       my $phonenum = $detail->phonenum;
3695       next unless $phonenum;
3696
3697       my $amount = $detail->amount;
3698       next unless $amount && $amount > 0;
3699
3700       $sections{$phonenum} ||= { 'amount'      => 0,
3701                                  'calls'       => 0,
3702                                  'duration'    => 0,
3703                                  'sort_weight' => -1,
3704                                  'phonenum'    => $phonenum,
3705                                 };
3706       $sections{$phonenum}{amount} += $amount;  #subtotal
3707       $sections{$phonenum}{calls}++;
3708       $sections{$phonenum}{duration} += $detail->duration;
3709
3710       my $desc = $detail->regionname;
3711       my $description = $desc;
3712       $description = substr($desc, 0, 50). '...'
3713         if $format eq 'latex' && length($desc) > 50;
3714
3715       $lines{$phonenum}{$desc} ||= {
3716         description     => &{$escape}($description),
3717         #pkgpart         => $part_pkg->pkgpart,
3718         pkgnum          => '',
3719         ref             => '',
3720         amount          => 0,
3721         calls           => 0,
3722         duration        => 0,
3723         #unit_amount     => '',
3724         quantity        => '',
3725         product_code    => 'N/A',
3726         ext_description => [],
3727       };
3728
3729       $lines{$phonenum}{$desc}{amount} += $amount;
3730       $lines{$phonenum}{$desc}{calls}++;
3731       $lines{$phonenum}{$desc}{duration} += $detail->duration;
3732
3733       my $line = $usage_class{$detail->classnum}->classname;
3734       $sections{"$phonenum $line"} ||=
3735         { 'amount' => 0,
3736           'calls' => 0,
3737           'duration' => 0,
3738           'sort_weight' => $usage_class{$detail->classnum}->weight,
3739           'phonenum' => $phonenum,
3740         };
3741       $sections{"$phonenum $line"}{amount} += $amount;  #subtotal
3742       $sections{"$phonenum $line"}{calls}++;
3743       $sections{"$phonenum $line"}{duration} += $detail->duration;
3744
3745       $lines{"$phonenum $line"}{$desc} ||= {
3746         description     => &{$escape}($description),
3747         #pkgpart         => $part_pkg->pkgpart,
3748         pkgnum          => '',
3749         ref             => '',
3750         amount          => 0,
3751         calls           => 0,
3752         duration        => 0,
3753         #unit_amount     => '',
3754         quantity        => '',
3755         product_code    => 'N/A',
3756         ext_description => [],
3757       };
3758
3759       $lines{"$phonenum $line"}{$desc}{amount} += $amount;
3760       $lines{"$phonenum $line"}{$desc}{calls}++;
3761       $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
3762       push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
3763            $detail->formatted('format' => $format);
3764
3765     }
3766   }
3767
3768   my %sectionmap = ();
3769   my $simple = new FS::usage_class { format => 'simple' }; #bleh
3770   my $usage_simple = new FS::usage_class { format => 'usage_simple' }; #bleh
3771   foreach ( keys %sections ) {
3772     my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
3773     my $usage_class = $summary ? $simple : $usage_simple;
3774     my $ending = $summary ? ' usage charges' : '';
3775     $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
3776                         'amount'    => $sections{$_}{amount},    #subtotal
3777                         'calls'       => $sections{$_}{calls},
3778                         'duration'    => $sections{$_}{duration},
3779                         'summarized'  => '',
3780                         'tax_section' => '',
3781                         'phonenum'    => $sections{$_}{phonenum},
3782                         'sort_weight' => $sections{$_}{sort_weight},
3783                         'post_total'  => $summary, #inspire pagebreak
3784                         (
3785                           ( map { $_ => $usage_class->$_($format) }
3786                             qw( description_generator
3787                                 header_generator
3788                                 total_generator
3789                                 total_line_generator
3790                               )
3791                           )
3792                         ),
3793                       };
3794   }
3795
3796   my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
3797                         $a->{sort_weight} <=> $b->{sort_weight}
3798                       }
3799                  values %sectionmap;
3800
3801   my @lines = ();
3802   foreach my $section ( keys %lines ) {
3803     foreach my $line ( keys %{$lines{$section}} ) {
3804       my $l = $lines{$section}{$line};
3805       $l->{section}     = $sectionmap{$section};
3806       $l->{amount}      = sprintf( "%.2f", $l->{amount} );
3807       #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
3808       push @lines, $l;
3809     }
3810   }
3811
3812   return(\@sections, \@lines);
3813
3814 }
3815
3816 sub _items {
3817   my $self = shift;
3818
3819   #my @display = scalar(@_)
3820   #              ? @_
3821   #              : qw( _items_previous _items_pkg );
3822   #              #: qw( _items_pkg );
3823   #              #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
3824   my @display = qw( _items_previous _items_pkg );
3825
3826   my @b = ();
3827   foreach my $display ( @display ) {
3828     push @b, $self->$display(@_);
3829   }
3830   @b;
3831 }
3832
3833 sub _items_previous {
3834   my $self = shift;
3835   my $cust_main = $self->cust_main;
3836   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
3837   my @b = ();
3838   foreach ( @pr_cust_bill ) {
3839     my $date = $conf->exists('invoice_show_prior_due_date')
3840                ? 'due '. $_->due_date2str($date_format)
3841                : time2str($date_format, $_->_date);
3842     push @b, {
3843       'description' => 'Previous Balance, Invoice #'. $_->invnum. " ($date)",
3844       #'pkgpart'     => 'N/A',
3845       'pkgnum'      => 'N/A',
3846       'amount'      => sprintf("%.2f", $_->owed),
3847     };
3848   }
3849   @b;
3850
3851   #{
3852   #    'description'     => 'Previous Balance',
3853   #    #'pkgpart'         => 'N/A',
3854   #    'pkgnum'          => 'N/A',
3855   #    'amount'          => sprintf("%10.2f", $pr_total ),
3856   #    'ext_description' => [ map {
3857   #                                 "Invoice ". $_->invnum.
3858   #                                 " (". time2str("%x",$_->_date). ") ".
3859   #                                 sprintf("%10.2f", $_->owed)
3860   #                         } @pr_cust_bill ],
3861
3862   #};
3863 }
3864
3865 sub _items_pkg {
3866   my $self = shift;
3867   my %options = @_;
3868   my @cust_bill_pkg = grep { $_->pkgnum } $self->cust_bill_pkg;
3869   my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3870   if ($options{section} && $options{section}->{condensed}) {
3871     my %itemshash = ();
3872     local $Storable::canonical = 1;
3873     foreach ( @items ) {
3874       my $item = { %$_ };
3875       delete $item->{ref};
3876       delete $item->{ext_description};
3877       my $key = freeze($item);
3878       $itemshash{$key} ||= 0;
3879       $itemshash{$key} ++; # += $item->{quantity};
3880     }
3881     @items = sort { $a->{description} cmp $b->{description} }
3882              map { my $i = thaw($_);
3883                    $i->{quantity} = $itemshash{$_};
3884                    $i->{amount} =
3885                      sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3886                    $i;
3887                  }
3888              keys %itemshash;
3889   }
3890   @items;
3891 }
3892
3893 sub _taxsort {
3894   return 0 unless $a cmp $b;
3895   return -1 if $b eq 'Tax';
3896   return 1 if $a eq 'Tax';
3897   return -1 if $b eq 'Other surcharges';
3898   return 1 if $a eq 'Other surcharges';
3899   $a cmp $b;
3900 }
3901
3902 sub _items_tax {
3903   my $self = shift;
3904   my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum } $self->cust_bill_pkg;
3905   $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3906 }
3907
3908 sub _items_cust_bill_pkg {
3909   my $self = shift;
3910   my $cust_bill_pkg = shift;
3911   my %opt = @_;
3912
3913   my $format = $opt{format} || '';
3914   my $escape_function = $opt{escape_function} || sub { shift };
3915   my $format_function = $opt{format_function} || '';
3916   my $unsquelched = $opt{unsquelched} || '';
3917   my $section = $opt{section}->{description} if $opt{section};
3918   my $summary_page = $opt{summary_page} || '';
3919   my $multilocation = $opt{multilocation} || '';
3920
3921   my @b = ();
3922   my ($s, $r, $u) = ( undef, undef, undef );
3923   foreach my $cust_bill_pkg ( @$cust_bill_pkg )
3924   {
3925
3926     foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
3927       if ( $_ && !$cust_bill_pkg->hidden ) {
3928         $_->{amount}      = sprintf( "%.2f", $_->{amount} ),
3929         $_->{amount}      =~ s/^\-0\.00$/0.00/;
3930         $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
3931         push @b, { %$_ }
3932           unless $_->{amount} == 0;
3933         $_ = undef;
3934       }
3935     }
3936
3937     foreach my $display ( grep { defined($section)
3938                                  ? $_->section eq $section
3939                                  : 1
3940                                }
3941                           grep { !$_->summary || !$summary_page }
3942                           $cust_bill_pkg->cust_bill_pkg_display
3943                         )
3944     {
3945
3946       my $type = $display->type;
3947
3948       my $desc = $cust_bill_pkg->desc;
3949       $desc = substr($desc, 0, 50). '...'
3950         if $format eq 'latex' && length($desc) > 50;
3951
3952       my %details_opt = ( 'format'          => $format,
3953                           'escape_function' => $escape_function,
3954                           'format_function' => $format_function,
3955                         );
3956
3957       if ( $cust_bill_pkg->pkgnum > 0 ) {
3958
3959         my $cust_pkg = $cust_bill_pkg->cust_pkg;
3960
3961         if ( $cust_bill_pkg->setup != 0 && (!$type || $type eq 'S') ) {
3962
3963           my $description = $desc;
3964           $description .= ' Setup' if $cust_bill_pkg->recur != 0;
3965
3966           my @d = ();
3967           unless ( $cust_pkg->part_pkg->hide_svc_detail
3968                 || $cust_bill_pkg->hidden )
3969           {
3970             push @d, map &{$escape_function}($_),
3971                          $cust_pkg->h_labels_short($self->_date);
3972             if ( $multilocation ) {
3973               my $loc = $cust_pkg->location_label;
3974               $loc = substr($desc, 0, 50). '...'
3975                 if $format eq 'latex' && length($loc) > 50;
3976               push @d, &{$escape_function}($loc);
3977             }
3978           }
3979           push @d, $cust_bill_pkg->details(%details_opt)
3980             if $cust_bill_pkg->recur == 0;
3981
3982           if ( $cust_bill_pkg->hidden ) {
3983             $s->{amount}      += $cust_bill_pkg->setup;
3984             $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3985             push @{ $s->{ext_description} }, @d;
3986           } else {
3987             $s = {
3988               description     => $description,
3989               #pkgpart         => $part_pkg->pkgpart,
3990               pkgnum          => $cust_bill_pkg->pkgnum,
3991               amount          => $cust_bill_pkg->setup,
3992               unit_amount     => $cust_bill_pkg->unitsetup,
3993               quantity        => $cust_bill_pkg->quantity,
3994               ext_description => \@d,
3995             };
3996           };
3997
3998         }
3999
4000         if ( $cust_bill_pkg->recur != 0 &&
4001              ( !$type || $type eq 'R' || $type eq 'U' )
4002            )
4003         {
4004
4005           my $is_summary = $display->summary;
4006           my $description = ($is_summary && $type && $type eq 'U')
4007                             ? "Usage charges" : $desc;
4008
4009           unless ( $conf->exists('disable_line_item_date_ranges') ) {
4010             $description .= " (" . time2str($date_format, $cust_bill_pkg->sdate).
4011                             " - ". time2str($date_format, $cust_bill_pkg->edate). ")";
4012           }
4013
4014           my @d = ();
4015
4016           #at least until cust_bill_pkg has "past" ranges in addition to
4017           #the "future" sdate/edate ones... see #3032
4018           my @dates = ( $self->_date );
4019           my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
4020           push @dates, $prev->sdate if $prev;
4021
4022           unless ( $cust_pkg->part_pkg->hide_svc_detail
4023                 || $cust_bill_pkg->itemdesc
4024                 || $cust_bill_pkg->hidden
4025                 || $is_summary && $type && $type eq 'U' )
4026           {
4027             push @d, map &{$escape_function}($_),
4028                          $cust_pkg->h_labels_short(@dates)
4029                                                    #$cust_bill_pkg->edate,
4030                                                    #$cust_bill_pkg->sdate)
4031             ;
4032             if ( $multilocation ) {
4033               my $loc = $cust_pkg->location_label;
4034               $loc = substr($desc, 0, 50). '...'
4035                 if $format eq 'latex' && length($loc) > 50;
4036               push @d, &{$escape_function}($loc);
4037             }
4038           }
4039
4040           push @d, $cust_bill_pkg->details(%details_opt)
4041             unless ($is_summary || $type && $type eq 'R');
4042
4043           my $amount = 0;
4044           if (!$type) {
4045             $amount = $cust_bill_pkg->recur;
4046           }elsif($type eq 'R') {
4047             $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
4048           }elsif($type eq 'U') {
4049             $amount = $cust_bill_pkg->usage;
4050           }
4051
4052           if ( !$type || $type eq 'R' ) {
4053
4054             if ( $cust_bill_pkg->hidden ) {
4055               $r->{amount}      += $amount;
4056               $r->{unit_amount} += $cust_bill_pkg->unitrecur;
4057               push @{ $r->{ext_description} }, @d;
4058             } else {
4059               $r = {
4060                 description     => $description,
4061                 #pkgpart         => $part_pkg->pkgpart,
4062                 pkgnum          => $cust_bill_pkg->pkgnum,
4063                 amount          => $amount,
4064                 unit_amount     => $cust_bill_pkg->unitrecur,
4065                 quantity        => $cust_bill_pkg->quantity,
4066                 ext_description => \@d,
4067               };
4068             }
4069
4070           } elsif ( $amount ) {  # && $type eq 'U'
4071
4072             if ( $cust_bill_pkg->hidden ) {
4073               $u->{amount}      += $amount;
4074               $u->{unit_amount} += $cust_bill_pkg->unitrecur;
4075               push @{ $u->{ext_description} }, @d;
4076             } else {
4077               $u = {
4078                 description     => $description,
4079                 #pkgpart         => $part_pkg->pkgpart,
4080                 pkgnum          => $cust_bill_pkg->pkgnum,
4081                 amount          => $amount,
4082                 unit_amount     => $cust_bill_pkg->unitrecur,
4083                 quantity        => $cust_bill_pkg->quantity,
4084                 ext_description => \@d,
4085               };
4086             }
4087
4088           }
4089
4090         } # recurring or usage with recurring charge
4091
4092       } else { #pkgnum tax or one-shot line item (??)
4093
4094         if ( $cust_bill_pkg->setup != 0 ) {
4095           push @b, {
4096             'description' => $desc,
4097             'amount'      => sprintf("%.2f", $cust_bill_pkg->setup),
4098           };
4099         }
4100         if ( $cust_bill_pkg->recur != 0 ) {
4101           push @b, {
4102             'description' => "$desc (".
4103                              time2str($date_format, $cust_bill_pkg->sdate). ' - '.
4104                              time2str($date_format, $cust_bill_pkg->edate). ')',
4105             'amount'      => sprintf("%.2f", $cust_bill_pkg->recur),
4106           };
4107         }
4108
4109       }
4110
4111     }
4112
4113   }
4114
4115   foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
4116     if ( $_  ) {
4117       $_->{amount}      = sprintf( "%.2f", $_->{amount} ),
4118       $_->{amount}      =~ s/^\-0\.00$/0.00/;
4119       $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
4120       push @b, { %$_ }
4121         unless $_->{amount} == 0;
4122     }
4123   }
4124
4125   @b;
4126
4127 }
4128
4129 sub _items_credits {
4130   my( $self, %opt ) = @_;
4131   my $trim_len = $opt{'trim_len'} || 60;
4132
4133   my @b;
4134   #credits
4135   foreach ( $self->cust_credited ) {
4136
4137     #something more elaborate if $_->amount ne $_->cust_credit->credited ?
4138
4139     my $reason = substr($_->cust_credit->reason, 0, $trim_len);
4140     $reason .= '...' if length($reason) < length($_->cust_credit->reason);
4141     $reason = " ($reason) " if $reason;
4142
4143     push @b, {
4144       #'description' => 'Credit ref\#'. $_->crednum.
4145       #                 " (". time2str("%x",$_->cust_credit->_date) .")".
4146       #                 $reason,
4147       'description' => 'Credit applied '.
4148                        time2str($date_format,$_->cust_credit->_date). $reason,
4149       'amount'      => sprintf("%.2f",$_->amount),
4150     };
4151   }
4152
4153   @b;
4154
4155 }
4156
4157 sub _items_payments {
4158   my $self = shift;
4159
4160   my @b;
4161   #get & print payments
4162   foreach ( $self->cust_bill_pay ) {
4163
4164     #something more elaborate if $_->amount ne ->cust_pay->paid ?
4165
4166     push @b, {
4167       'description' => "Payment received ".
4168                        time2str($date_format,$_->cust_pay->_date ),
4169       'amount'      => sprintf("%.2f", $_->amount )
4170     };
4171   }
4172
4173   @b;
4174
4175 }
4176
4177 =item call_details [ OPTION => VALUE ... ]
4178
4179 Returns an array of CSV strings representing the call details for this invoice
4180 The only option available is the boolean prepend_billed_number
4181
4182 =cut
4183
4184 sub call_details {
4185   my ($self, %opt) = @_;
4186
4187   my $format_function = sub { shift };
4188
4189   if ($opt{prepend_billed_number}) {
4190     $format_function = sub {
4191       my $detail = shift;
4192       my $row = shift;
4193
4194       $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
4195
4196     };
4197   }
4198
4199   my @details = map { $_->details( 'format_function' => $format_function,
4200                                    'escape_function' => sub{ return() },
4201                                  )
4202                     }
4203                   grep { $_->pkgnum }
4204                   $self->cust_bill_pkg;
4205   my $header = $details[0];
4206   ( $header, grep { $_ ne $header } @details );
4207 }
4208
4209
4210 =back
4211
4212 =head1 SUBROUTINES
4213
4214 =over 4
4215
4216 =item process_reprint
4217
4218 =cut
4219
4220 sub process_reprint {
4221   process_re_X('print', @_);
4222 }
4223
4224 =item process_reemail
4225
4226 =cut
4227
4228 sub process_reemail {
4229   process_re_X('email', @_);
4230 }
4231
4232 =item process_refax
4233
4234 =cut
4235
4236 sub process_refax {
4237   process_re_X('fax', @_);
4238 }
4239
4240 =item process_reftp
4241
4242 =cut
4243
4244 sub process_reftp {
4245   process_re_X('ftp', @_);
4246 }
4247
4248 =item respool
4249
4250 =cut
4251
4252 sub process_respool {
4253   process_re_X('spool', @_);
4254 }
4255
4256 use Storable qw(thaw);
4257 use Data::Dumper;
4258 use MIME::Base64;
4259 sub process_re_X {
4260   my( $method, $job ) = ( shift, shift );
4261   warn "$me process_re_X $method for job $job\n" if $DEBUG;
4262
4263   my $param = thaw(decode_base64(shift));
4264   warn Dumper($param) if $DEBUG;
4265
4266   re_X(
4267     $method,
4268     $job,
4269     %$param,
4270   );
4271
4272 }
4273
4274 sub re_X {
4275   my($method, $job, %param ) = @_;
4276   if ( $DEBUG ) {
4277     warn "re_X $method for job $job with param:\n".
4278          join( '', map { "  $_ => ". $param{$_}. "\n" } keys %param );
4279   }
4280
4281   #some false laziness w/search/cust_bill.html
4282   my $distinct = '';
4283   my $orderby = 'ORDER BY cust_bill._date';
4284
4285   my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
4286
4287   my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
4288
4289   my @cust_bill = qsearch( {
4290     #'select'    => "cust_bill.*",
4291     'table'     => 'cust_bill',
4292     'addl_from' => $addl_from,
4293     'hashref'   => {},
4294     'extra_sql' => $extra_sql,
4295     'order_by'  => $orderby,
4296     'debug' => 1,
4297   } );
4298
4299   $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
4300
4301   warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
4302     if $DEBUG;
4303
4304   my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
4305   foreach my $cust_bill ( @cust_bill ) {
4306     $cust_bill->$method();
4307
4308     if ( $job ) { #progressbar foo
4309       $num++;
4310       if ( time - $min_sec > $last ) {
4311         my $error = $job->update_statustext(
4312           int( 100 * $num / scalar(@cust_bill) )
4313         );
4314         die $error if $error;
4315         $last = time;
4316       }
4317     }
4318
4319   }
4320
4321 }
4322
4323 =back
4324
4325 =head1 CLASS METHODS
4326
4327 =over 4
4328
4329 =item owed_sql
4330
4331 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
4332
4333 =cut
4334
4335 sub owed_sql {
4336   my ($class, $start, $end) = @_;
4337   'charged - '.
4338     $class->paid_sql($start, $end). ' - '.
4339     $class->credited_sql($start, $end);
4340 }
4341
4342 =item net_sql
4343
4344 Returns an SQL fragment to retreive the net amount (charged minus credited).
4345
4346 =cut
4347
4348 sub net_sql {
4349   my ($class, $start, $end) = @_;
4350   'charged - '. $class->credited_sql($start, $end);
4351 }
4352
4353 =item paid_sql
4354
4355 Returns an SQL fragment to retreive the amount paid against this invoice.
4356
4357 =cut
4358
4359 sub paid_sql {
4360   my ($class, $start, $end) = @_;
4361   $start &&= "AND cust_bill_pay._date <= $start";
4362   $end   &&= "AND cust_bill_pay._date > $end";
4363   $start = '' unless defined($start);
4364   $end   = '' unless defined($end);
4365   "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
4366        WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end  )";
4367 }
4368
4369 =item credited_sql
4370
4371 Returns an SQL fragment to retreive the amount credited against this invoice.
4372
4373 =cut
4374
4375 sub credited_sql {
4376   my ($class, $start, $end) = @_;
4377   $start &&= "AND cust_credit_bill._date <= $start";
4378   $end   &&= "AND cust_credit_bill._date >  $end";
4379   $start = '' unless defined($start);
4380   $end   = '' unless defined($end);
4381   "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
4382        WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end  )";
4383 }
4384
4385 =item search_sql_where HASHREF
4386
4387 Class method which returns an SQL WHERE fragment to search for parameters
4388 specified in HASHREF.  Valid parameters are
4389
4390 =over 4
4391
4392 =item _date
4393
4394 List reference of start date, end date, as UNIX timestamps.
4395
4396 =item invnum_min
4397
4398 =item invnum_max
4399
4400 =item agentnum
4401
4402 =item charged
4403
4404 List reference of charged limits (exclusive).
4405
4406 =item owed
4407
4408 List reference of charged limits (exclusive).
4409
4410 =item open
4411
4412 flag, return open invoices only
4413
4414 =item net
4415
4416 flag, return net invoices only
4417
4418 =item days
4419
4420 =item newest_percust
4421
4422 =back
4423
4424 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
4425
4426 =cut
4427
4428 sub search_sql_where {
4429   my($class, $param) = @_;
4430   if ( $DEBUG ) {
4431     warn "$me search_sql_where called with params: \n".
4432          join("\n", map { "  $_: ". $param->{$_} } keys %$param ). "\n";
4433   }
4434
4435   my @search = ();
4436
4437   #agentnum
4438   if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
4439     push @search, "cust_main.agentnum = $1";
4440   }
4441
4442   #_date
4443   if ( $param->{_date} ) {
4444     my($beginning, $ending) = @{$param->{_date}};
4445
4446     push @search, "cust_bill._date >= $beginning",
4447                   "cust_bill._date <  $ending";
4448   }
4449
4450   #invnum
4451   if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
4452     push @search, "cust_bill.invnum >= $1";
4453   }
4454   if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
4455     push @search, "cust_bill.invnum <= $1";
4456   }
4457
4458   #charged
4459   if ( $param->{charged} ) {
4460     my @charged = ref($param->{charged})
4461                     ? @{ $param->{charged} }
4462                     : ($param->{charged});
4463
4464     push @search, map { s/^charged/cust_bill.charged/; $_; }
4465                       @charged;
4466   }
4467
4468   my $owed_sql = FS::cust_bill->owed_sql;
4469
4470   #owed
4471   if ( $param->{owed} ) {
4472     my @owed = ref($param->{owed})
4473                  ? @{ $param->{owed} }
4474                  : ($param->{owed});
4475     push @search, map { s/^owed/$owed_sql/; $_; }
4476                       @owed;
4477   }
4478
4479   #open/net flags
4480   push @search, "0 != $owed_sql"
4481     if $param->{'open'};
4482   push @search, '0 != '. FS::cust_bill->net_sql
4483     if $param->{'net'};
4484
4485   #days
4486   push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
4487     if $param->{'days'};
4488
4489   #newest_percust
4490   if ( $param->{'newest_percust'} ) {
4491
4492     #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
4493     #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
4494
4495     my @newest_where = map { my $x = $_;
4496                              $x =~ s/\bcust_bill\./newest_cust_bill./g;
4497                              $x;
4498                            }
4499                            grep ! /^cust_main./, @search;
4500     my $newest_where = scalar(@newest_where)
4501                          ? ' AND '. join(' AND ', @newest_where)
4502                          : '';
4503
4504
4505     push @search, "cust_bill._date = (
4506       SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
4507         WHERE newest_cust_bill.custnum = cust_bill.custnum
4508           $newest_where
4509     )";
4510
4511   }
4512
4513   #agent virtualization
4514   my $curuser = $FS::CurrentUser::CurrentUser;
4515   if ( $curuser->username eq 'fs_queue'
4516        && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
4517     my $username = $1;
4518     my $newuser = qsearchs('access_user', {
4519       'username' => $username,
4520       'disabled' => '',
4521     } );
4522     if ( $newuser ) {
4523       $curuser = $newuser;
4524     } else {
4525       warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
4526     }
4527   }
4528   push @search, $curuser->agentnums_sql;
4529
4530   join(' AND ', @search );
4531
4532 }
4533
4534 =back
4535
4536 =head1 BUGS
4537
4538 The delete method.
4539
4540 =head1 SEE ALSO
4541
4542 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
4543 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base
4544 documentation.
4545
4546 =cut
4547
4548 1;
4549