FS/FS/cust_bill.pm

   1 package FS::cust_bill;
   2
   3 use strict;
   4 use vars qw( @ISA $conf $money_char );
   5 use vars qw( $lpr $invoice_from $smtpmachine );
   6 use vars qw( $cybercash );
   7 use vars qw( $xaction $E_NoErr );
   8 use vars qw( $bop_processor $bop_login $bop_password $bop_action @bop_options );
   9 use vars qw( $ach_processor $ach_login $ach_password $ach_action @ach_options );
  10 use vars qw( $invoice_lines @buf ); #yuck
  11 use vars qw( $realtime_bop_decline_quiet );
  12 use Date::Format;
  13 use Mail::Internet 1.44;
  14 use Mail::Header;
  15 use Text::Template;
  16 use FS::UID qw( datasrc );
  17 use FS::Record qw( qsearch qsearchs );
  18 use FS::cust_main;
  19 use FS::cust_bill_pkg;
  20 use FS::cust_credit;
  21 use FS::cust_pay;
  22 use FS::cust_pkg;
  23 use FS::cust_credit_bill;
  24 use FS::cust_pay_batch;
  25 use FS::cust_bill_event;
  26
  27 @ISA = qw( FS::Record );
  28
  29 $realtime_bop_decline_quiet = 0;
  30
  31 #ask FS::UID to run this stuff for us later
  32 $FS::UID::callback{'FS::cust_bill'} = sub {
  33
  34   $conf = new FS::Conf;
  35
  36   $money_char = $conf->config('money_char') || '$';
  37
  38   $lpr = $conf->config('lpr');
  39   $invoice_from = $conf->config('invoice_from');
  40   $smtpmachine = $conf->config('smtpmachine');
  41
  42   ( $bop_processor,$bop_login, $bop_password, $bop_action ) = ( '', '', '', '');
  43   @bop_options = ();
  44   ( $ach_processor,$ach_login, $ach_password, $ach_action ) = ( '', '', '', '');
  45   @ach_options = ();
  46
  47   if ( $conf->exists('cybercash3.2') ) {
  48     require CCMckLib3_2;
  49       #qw($MCKversion %Config InitConfig CCError CCDebug CCDebug2);
  50     require CCMckDirectLib3_2;
  51       #qw(SendCC2_1Server);
  52     require CCMckErrno3_2;
  53       #qw(MCKGetErrorMessage $E_NoErr);
  54     import CCMckErrno3_2 qw($E_NoErr);
  55
  56     my $merchant_conf;
  57     ($merchant_conf,$xaction)= $conf->config('cybercash3.2');
  58     my $status = &CCMckLib3_2::InitConfig($merchant_conf);
  59     if ( $status != $E_NoErr ) {
  60       warn "CCMckLib3_2::InitConfig error:\n";
  61       foreach my $key (keys %CCMckLib3_2::Config) {
  62         warn "  $key => $CCMckLib3_2::Config{$key}\n"
  63       }
  64       my($errmsg) = &CCMckErrno3_2::MCKGetErrorMessage($status);
  65       die "CCMckLib3_2::InitConfig fatal error: $errmsg\n";
  66     }
  67     $cybercash='cybercash3.2';
  68   } elsif ( $conf->exists('business-onlinepayment') ) {
  69     ( $bop_processor,
  70       $bop_login,
  71       $bop_password,
  72       $bop_action,
  73       @bop_options
  74     ) = $conf->config('business-onlinepayment');
  75     $bop_action ||= 'normal authorization';
  76     ( $ach_processor, $ach_login, $ach_password, $ach_action, @ach_options ) =
  77       ( $bop_processor, $bop_login, $bop_password, $bop_action, @bop_options );
  78     eval "use Business::OnlinePayment";
  79   }
  80
  81   if ( $conf->exists('business-onlinepayment-ach') ) {
  82     ( $ach_processor,
  83       $ach_login,
  84       $ach_password,
  85       $ach_action,
  86       @ach_options
  87     ) = $conf->config('business-onlinepayment-ach');
  88     $ach_action ||= 'normal authorization';
  89     eval "use Business::OnlinePayment";
  90   }
  91
  92 };
  93
  94 =head1 NAME
  95
  96 FS::cust_bill - Object methods for cust_bill records
  97
  98 =head1 SYNOPSIS
  99
 100   use FS::cust_bill;
 101
 102   $record = new FS::cust_bill \%hash;
 103   $record = new FS::cust_bill { 'column' => 'value' };
 104
 105   $error = $record->insert;
 106
 107   $error = $new_record->replace($old_record);
 108
 109   $error = $record->delete;
 110
 111   $error = $record->check;
 112
 113   ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
 114
 115   @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
 116
 117   ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
 118
 119   @cust_pay_objects = $cust_bill->cust_pay;
 120
 121   $tax_amount = $record->tax;
 122
 123   @lines = $cust_bill->print_text;
 124   @lines = $cust_bill->print_text $time;
 125
 126 =head1 DESCRIPTION
 127
 128 An FS::cust_bill object represents an invoice; a declaration that a customer
 129 owes you money.  The specific charges are itemized as B<cust_bill_pkg> records
 130 (see L<FS::cust_bill_pkg>).  FS::cust_bill inherits from FS::Record.  The
 131 following fields are currently supported:
 132
 133 =over 4
 134
 135 =item invnum - primary key (assigned automatically for new invoices)
 136
 137 =item custnum - customer (see L<FS::cust_main>)
 138
 139 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
 140 L<Time::Local> and L<Date::Parse> for conversion functions.
 141
 142 =item charged - amount of this invoice
 143
 144 =item printed - deprecated
 145
 146 =item closed - books closed flag, empty or `Y'
 147
 148 =back
 149
 150 =head1 METHODS
 151
 152 =over 4
 153
 154 =item new HASHREF
 155
 156 Creates a new invoice.  To add the invoice to the database, see L<"insert">.
 157 Invoices are normally created by calling the bill method of a customer object
 158 (see L<FS::cust_main>).
 159
 160 =cut
 161
 162 sub table { 'cust_bill'; }
 163
 164 =item insert
 165
 166 Adds this invoice to the database ("Posts" the invoice).  If there is an error,
 167 returns the error, otherwise returns false.
 168
 169 =item delete
 170
 171 Currently unimplemented.  I don't remove invoices because there would then be
 172 no record you ever posted this invoice (which is bad, no?)
 173
 174 =cut
 175
 176 sub delete {
 177   my $self = shift;
 178   return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
 179   $self->SUPER::delete(@_);
 180 }
 181
 182 =item replace OLD_RECORD
 183
 184 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 185 returns the error, otherwise returns false.
 186
 187 Only printed may be changed.  printed is normally updated by calling the
 188 collect method of a customer object (see L<FS::cust_main>).
 189
 190 =cut
 191
 192 sub replace {
 193   my( $new, $old ) = ( shift, shift );
 194   return "Can't change custnum!" unless $old->custnum == $new->custnum;
 195   #return "Can't change _date!" unless $old->_date eq $new->_date;
 196   return "Can't change _date!" unless $old->_date == $new->_date;
 197   return "Can't change charged!" unless $old->charged == $new->charged;
 198
 199   $new->SUPER::replace($old);
 200 }
 201
 202 =item check
 203
 204 Checks all fields to make sure this is a valid invoice.  If there is an error,
 205 returns the error, otherwise returns false.  Called by the insert and replace
 206 methods.
 207
 208 =cut
 209
 210 sub check {
 211   my $self = shift;
 212
 213   my $error =
 214     $self->ut_numbern('invnum')
 215     || $self->ut_number('custnum')
 216     || $self->ut_numbern('_date')
 217     || $self->ut_money('charged')
 218     || $self->ut_numbern('printed')
 219     || $self->ut_enum('closed', [ '', 'Y' ])
 220   ;
 221   return $error if $error;
 222
 223   return "Unknown customer"
 224     unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 225
 226   $self->_date(time) unless $self->_date;
 227
 228   $self->printed(0) if $self->printed eq '';
 229
 230   ''; #no error
 231 }
 232
 233 =item previous
 234
 235 Returns a list consisting of the total previous balance for this customer,
 236 followed by the previous outstanding invoices (as FS::cust_bill objects also).
 237
 238 =cut
 239
 240 sub previous {
 241   my $self = shift;
 242   my $total = 0;
 243   my @cust_bill = sort { $a->_date <=> $b->_date }
 244     grep { $_->owed != 0 && $_->_date < $self->_date }
 245       qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
 246   ;
 247   foreach ( @cust_bill ) { $total += $_->owed; }
 248   $total, @cust_bill;
 249 }
 250
 251 =item cust_bill_pkg
 252
 253 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
 254
 255 =cut
 256
 257 sub cust_bill_pkg {
 258   my $self = shift;
 259   qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum } );
 260 }
 261
 262 =item cust_bill_event
 263
 264 Returns the completed invoice events (see L<FS::cust_bill_event>) for this
 265 invoice.
 266
 267 =cut
 268
 269 sub cust_bill_event {
 270   my $self = shift;
 271   qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
 272 }
 273
 274
 275 =item cust_main
 276
 277 Returns the customer (see L<FS::cust_main>) for this invoice.
 278
 279 =cut
 280
 281 sub cust_main {
 282   my $self = shift;
 283   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 284 }
 285
 286 =item cust_credit
 287
 288 Depreciated.  See the cust_credited method.
 289
 290  #Returns a list consisting of the total previous credited (see
 291  #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
 292  #outstanding credits (FS::cust_credit objects).
 293
 294 =cut
 295
 296 sub cust_credit {
 297   use Carp;
 298   croak "FS::cust_bill->cust_credit depreciated; see ".
 299         "FS::cust_bill->cust_credit_bill";
 300   #my $self = shift;
 301   #my $total = 0;
 302   #my @cust_credit = sort { $a->_date <=> $b->_date }
 303   #  grep { $_->credited != 0 && $_->_date < $self->_date }
 304   #    qsearch('cust_credit', { 'custnum' => $self->custnum } )
 305   #;
 306   #foreach (@cust_credit) { $total += $_->credited; }
 307   #$total, @cust_credit;
 308 }
 309
 310 =item cust_pay
 311
 312 Depreciated.  See the cust_bill_pay method.
 313
 314 #Returns all payments (see L<FS::cust_pay>) for this invoice.
 315
 316 =cut
 317
 318 sub cust_pay {
 319   use Carp;
 320   croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
 321   #my $self = shift;
 322   #sort { $a->_date <=> $b->_date }
 323   #  qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
 324   #;
 325 }
 326
 327 =item cust_bill_pay
 328
 329 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
 330
 331 =cut
 332
 333 sub cust_bill_pay {
 334   my $self = shift;
 335   sort { $a->_date <=> $b->_date }
 336     qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
 337 }
 338
 339 =item cust_credited
 340
 341 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
 342
 343 =cut
 344
 345 sub cust_credited {
 346   my $self = shift;
 347   sort { $a->_date <=> $b->_date }
 348     qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
 349   ;
 350 }
 351
 352 =item tax
 353
 354 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
 355
 356 =cut
 357
 358 sub tax {
 359   my $self = shift;
 360   my $total = 0;
 361   my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
 362                                              'pkgnum' => 0 } );
 363   foreach (@taxlines) { $total += $_->setup; }
 364   $total;
 365 }
 366
 367 =item owed
 368
 369 Returns the amount owed (still outstanding) on this invoice, which is charged
 370 minus all payment applications (see L<FS::cust_bill_pay>) and credit
 371 applications (see L<FS::cust_credit_bill>).
 372
 373 =cut
 374
 375 sub owed {
 376   my $self = shift;
 377   my $balance = $self->charged;
 378   $balance -= $_->amount foreach ( $self->cust_bill_pay );
 379   $balance -= $_->amount foreach ( $self->cust_credited );
 380   $balance = sprintf( "%.2f", $balance);
 381   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
 382   $balance;
 383 }
 384
 385 =item send
 386
 387 Sends this invoice to the destinations configured for this customer: send
 388 emails or print.  See L<FS::cust_main_invoice>.
 389
 390 =cut
 391
 392 sub send {
 393   my($self,$template) = @_;
 394   my @print_text = $self->print_text('', $template);
 395   my @invoicing_list = $self->cust_main->invoicing_list;
 396
 397   if ( grep { $_ ne 'POST' } @invoicing_list or !@invoicing_list ) { #email
 398
 399     #better to notify this person than silence
 400     @invoicing_list = ($invoice_from) unless @invoicing_list;
 401
 402     #false laziness w/FS::cust_pay::delete & fs_signup_server && ::realtime_card
 403     #$ENV{SMTPHOSTS} = $smtpmachine;
 404     $ENV{MAILADDRESS} = $invoice_from;
 405     my $header = new Mail::Header ( [
 406       "From: $invoice_from",
 407       "To: ". join(', ', grep { $_ ne 'POST' } @invoicing_list ),
 408       "Sender: $invoice_from",
 409       "Reply-To: $invoice_from",
 410       "Date: ". time2str("%a, %d %b %Y %X %z", time),
 411       "Subject: Invoice",
 412     ] );
 413     my $message = new Mail::Internet (
 414       'Header' => $header,
 415       'Body' => [ @print_text ], #( date)
 416     );
 417     $!=0;
 418     $message->smtpsend( Host => $smtpmachine )
 419       or $message->smtpsend( Host => $smtpmachine, Debug => 1 )
 420         or return "(customer # ". $self->custnum. ") can't send invoice email".
 421                   " to ". join(', ', grep { $_ ne 'POST' } @invoicing_list ).
 422                   " via server $smtpmachine with SMTP: $!";
 423
 424   }
 425
 426   if ( grep { $_ eq 'POST' } @invoicing_list ) { #postal
 427     open(LPR, "|$lpr")
 428       or return "Can't open pipe to $lpr: $!";
 429     print LPR @print_text;
 430     close LPR
 431       or return $! ? "Error closing $lpr: $!"
 432                    : "Exit status $? from $lpr";
 433   }
 434
 435   '';
 436
 437 }
 438
 439 =item send_csv OPTIONS
 440
 441 Sends invoice as a CSV data-file to a remote host with the specified protocol.
 442
 443 Options are:
 444
 445 protocol - currently only "ftp"
 446 server
 447 username
 448 password
 449 dir
 450
 451 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
 452 and YYMMDDHHMMSS is a timestamp.
 453
 454 The fields of the CSV file is as follows:
 455
 456 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
 457
 458 =over 4
 459
 460 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
 461
 462 If B<record_type> is C<cust_bill>, this is a primary invoice record.  The
 463 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
 464 fields are filled in.
 465
 466 If B<record_type> is C<cust_bill_pkg>, this is a line item record.  Only the
 467 first two fields (B<record_type> and B<invnum>) and the last five fields
 468 (B<pkg> through B<edate>) are filled in.
 469
 470 =item invnum - invoice number
 471
 472 =item custnum - customer number
 473
 474 =item _date - invoice date
 475
 476 =item charged - total invoice amount
 477
 478 =item first - customer first name
 479
 480 =item last - customer first name
 481
 482 =item company - company name
 483
 484 =item address1 - address line 1
 485
 486 =item address2 - address line 1
 487
 488 =item city
 489
 490 =item state
 491
 492 =item zip
 493
 494 =item country
 495
 496 =item pkg - line item description
 497
 498 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
 499
 500 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
 501
 502 =item sdate - start date for recurring fee
 503
 504 =item edate - end date for recurring fee
 505
 506 =back
 507
 508 =cut
 509
 510 sub send_csv {
 511   my($self, %opt) = @_;
 512
 513   #part one: create file
 514
 515   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
 516   mkdir $spooldir, 0700 unless -d $spooldir;
 517
 518   my $file = $spooldir. '/'. $self->invnum. time2str('-%Y%m%d%H%M%S.csv', time);
 519
 520   open(CSV, ">$file") or die "can't open $file: $!";
 521
 522   eval "use Text::CSV_XS";
 523   die $@ if $@;
 524
 525   my $csv = Text::CSV_XS->new({'always_quote'=>1});
 526
 527   my $cust_main = $self->cust_main;
 528
 529   $csv->combine(
 530     'cust_bill',
 531     $self->invnum,
 532     $self->custnum,
 533     time2str("%x", $self->_date),
 534     sprintf("%.2f", $self->charged),
 535     ( map { $cust_main->getfield($_) }
 536         qw( first last company address1 address2 city state zip country ) ),
 537     map { '' } (1..5),
 538   ) or die "can't create csv";
 539   print CSV $csv->string. "\n";
 540
 541   #new charges (false laziness w/print_text)
 542   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
 543
 544     my($pkg, $setup, $recur, $sdate, $edate);
 545     if ( $cust_bill_pkg->pkgnum ) {
 546
 547       ($pkg, $setup, $recur, $sdate, $edate) = (
 548         $cust_bill_pkg->cust_pkg->part_pkg->pkg,
 549         ( $cust_bill_pkg->setup != 0
 550           ? sprintf("%.2f", $cust_bill_pkg->setup )
 551           : '' ),
 552         ( $cust_bill_pkg->recur != 0
 553           ? sprintf("%.2f", $cust_bill_pkg->recur )
 554           : '' ),
 555         time2str("%x", $cust_bill_pkg->sdate),
 556         time2str("%x", $cust_bill_pkg->edate),
 557       );
 558
 559     } else { #pkgnum Tax
 560       next unless $cust_bill_pkg->setup != 0;
 561       ($pkg, $setup, $recur, $sdate, $edate) =
 562         ( 'Tax', sprintf("%10.2f",$cust_bill_pkg->setup), '', '', '' );
 563     }
 564
 565     $csv->combine(
 566       'cust_bill_pkg',
 567       $self->invnum,
 568       ( map { '' } (1..11) ),
 569       ($pkg, $setup, $recur, $sdate, $edate)
 570     ) or die "can't create csv";
 571     print CSV $csv->string. "\n";
 572
 573   }
 574
 575   close CSV or die "can't close CSV: $!";
 576
 577   #part two: upload it
 578
 579   my $net;
 580   if ( $opt{protocol} eq 'ftp' ) {
 581     eval "use Net::FTP;";
 582     die $@ if $@;
 583     $net = Net::FTP->new($opt{server}) or die @$;
 584   } else {
 585     die "unknown protocol: $opt{protocol}";
 586   }
 587
 588   $net->login( $opt{username}, $opt{password} )
 589     or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
 590
 591   $net->binary or die "can't set binary mode";
 592
 593   $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
 594
 595   $net->put($file) or die "can't put $file: $!";
 596
 597   $net->quit;
 598
 599   unlink $file;
 600
 601 }
 602
 603 =item comp
 604
 605 Pays this invoice with a compliemntary payment.  If there is an error,
 606 returns the error, otherwise returns false.
 607
 608 =cut
 609
 610 sub comp {
 611   my $self = shift;
 612   my $cust_pay = new FS::cust_pay ( {
 613     'invnum'   => $self->invnum,
 614     'paid'     => $self->owed,
 615     '_date'    => '',
 616     'payby'    => 'COMP',
 617     'payinfo'  => $self->cust_main->payinfo,
 618     'paybatch' => '',
 619   } );
 620   $cust_pay->insert;
 621 }
 622
 623 =item realtime_card
 624
 625 Attempts to pay this invoice with a credit card payment via a
 626 Business::OnlinePayment realtime gateway.  See
 627 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
 628 for supported processors.
 629
 630 =cut
 631
 632 sub realtime_card {
 633   my $self = shift;
 634   $self->realtime_bop(
 635     'CC',
 636     $bop_processor,
 637     $bop_login,
 638     $bop_password,
 639     $bop_action,
 640     \@bop_options,
 641     @_
 642   );
 643 }
 644
 645 =item realtime_ach
 646
 647 Attempts to pay this invoice with an electronic check (ACH) payment via a
 648 Business::OnlinePayment realtime gateway.  See
 649 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
 650 for supported processors.
 651
 652 =cut
 653
 654 sub realtime_ach {
 655   my $self = shift;
 656   $self->realtime_bop(
 657     'ECHECK',
 658     $ach_processor,
 659     $ach_login,
 660     $ach_password,
 661     $ach_action,
 662     \@ach_options,
 663     @_
 664   );
 665 }
 666
 667 =item realtime_lec
 668
 669 Attempts to pay this invoice with phone bill (LEC) payment via a
 670 Business::OnlinePayment realtime gateway.  See
 671 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
 672 for supported processors.
 673
 674 =cut
 675
 676 sub realtime_lec {
 677   my $self = shift;
 678   $self->realtime_bop(
 679     'LEC',
 680     $bop_processor,
 681     $bop_login,
 682     $bop_password,
 683     $bop_action,
 684     \@bop_options,
 685     @_
 686   );
 687 }
 688
 689 sub realtime_bop {
 690   my( $self, $method, $processor, $login, $password, $action, $options ) = @_;
 691
 692   #trim an extraneous blank line
 693   pop @$options if scalar(@$options) % 2 && $options->[-1] =~ /^\s*$/;
 694
 695   my $cust_main = $self->cust_main;
 696   my $amount = $self->owed;
 697
 698   my $address = $cust_main->address1;
 699   $address .= ", ". $cust_main->address2 if $cust_main->address2;
 700
 701   my($payname, $payfirst, $paylast);
 702   if ( $cust_main->payname && $method ne 'ECHECK' ) {
 703     $payname = $cust_main->payname;
 704     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
 705       or do {
 706               #$dbh->rollback if $oldAutoCommit;
 707               return "Illegal payname $payname";
 708             };
 709     ($payfirst, $paylast) = ($1, $2);
 710   } else {
 711     $payfirst = $cust_main->getfield('first');
 712     $paylast = $cust_main->getfield('last');
 713     $payname =  "$payfirst $paylast";
 714   }
 715
 716   my @invoicing_list = grep { $_ ne 'POST' } $cust_main->invoicing_list;
 717   if ( $conf->exists('emailinvoiceauto')
 718        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
 719     push @invoicing_list, $cust_main->all_emails;
 720   }
 721   my $email = $invoicing_list[0];
 722
 723   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
 724
 725   my $description = 'Internet Services';
 726   if ( $conf->exists('business-onlinepayment-description') ) {
 727     my $dtempl = $conf->config('business-onlinepayment-description');
 728
 729     my $agent_obj = $cust_main->agent
 730       or die "can't retreive agent for $cust_main (agentnum ".
 731              $cust_main->agentnum. ")";
 732     my $agent = $agent_obj->agent;
 733     my $pkgs = join(', ',
 734       map { $_->cust_pkg->part_pkg->pkg }
 735         grep { $_->pkgnum } $self->cust_bill_pkg
 736     );
 737     $description = eval qq("$dtempl");
 738
 739   }
 740
 741   my %content;
 742   if ( $method eq 'CC' ) {
 743     $content{card_number} = $cust_main->payinfo;
 744     $cust_main->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
 745     $content{expiration} = "$2/$1";
 746   } elsif ( $method eq 'ECHECK' ) {
 747     my($account_number,$routing_code) = $cust_main->payinfo;
 748     ( $content{account_number}, $content{routing_code} ) =
 749       split('@', $cust_main->payinfo);
 750     $content{bank_name} = $cust_main->payname;
 751     $content{account_type} = 'CHECKING';
 752     $content{account_name} = $payname;
 753     $content{customer_org} = $self->company ? 'B' : 'I';
 754     $content{customer_ssn} = $self->ss;
 755   } elsif ( $method eq 'LEC' ) {
 756     $content{phone} = $cust_main->payinfo;
 757   }
 758
 759   my $transaction =
 760     new Business::OnlinePayment( $processor, @$options );
 761   $transaction->content(
 762     'type'           => $method,
 763     'login'          => $login,
 764     'password'       => $password,
 765     'action'         => $action1,
 766     'description'    => $description,
 767     'amount'         => $amount,
 768     'invoice_number' => $self->invnum,
 769     'customer_id'    => $self->custnum,
 770     'last_name'      => $paylast,
 771     'first_name'     => $payfirst,
 772     'name'           => $payname,
 773     'address'        => $address,
 774     'city'           => $cust_main->city,
 775     'state'          => $cust_main->state,
 776     'zip'            => $cust_main->zip,
 777     'country'        => $cust_main->country,
 778     'referer'        => 'http://cleanwhisker.420.am/',
 779     'email'          => $email,
 780     'phone'          => $cust_main->daytime || $cust_main->night,
 781     %content, #after
 782   );
 783   $transaction->submit();
 784
 785   if ( $transaction->is_success() && $action2 ) {
 786     my $auth = $transaction->authorization;
 787     my $ordernum = $transaction->can('order_number')
 788                    ? $transaction->order_number
 789                    : '';
 790
 791     #warn "********* $auth ***********\n";
 792     #warn "********* $ordernum ***********\n";
 793     my $capture =
 794       new Business::OnlinePayment( $processor, @$options );
 795
 796     my %capture = (
 797       %content,
 798       type           => $method,
 799       action         => $action2,
 800       login          => $login,
 801       password       => $password,
 802       order_number   => $ordernum,
 803       amount         => $amount,
 804       authorization  => $auth,
 805       description    => $description,
 806     );
 807
 808     foreach my $field (qw( authorization_source_code returned_ACI                                          transaction_identifier validation_code
 809                            transaction_sequence_num local_transaction_date
 810                            local_transaction_time AVS_result_code          )) {
 811       $capture{$field} = $transaction->$field() if $transaction->can($field);
 812     }
 813
 814     $capture->content( %capture );
 815
 816     $capture->submit();
 817
 818     unless ( $capture->is_success ) {
 819       my $e = "Authorization sucessful but capture failed, invnum #".
 820               $self->invnum. ': '.  $capture->result_code.
 821               ": ". $capture->error_message;
 822       warn $e;
 823       return $e;
 824     }
 825
 826   }
 827
 828   if ( $transaction->is_success() ) {
 829
 830     my %method2payby = (
 831       'CC'     => 'CARD',
 832       'ECHECK' => 'CHEK',
 833       'LEC'    => 'LECB',
 834     );
 835
 836     my $cust_pay = new FS::cust_pay ( {
 837        'invnum'   => $self->invnum,
 838        'paid'     => $amount,
 839        '_date'     => '',
 840        'payby'    => $method2payby{$method},
 841        'payinfo'  => $cust_main->payinfo,
 842        'paybatch' => "$processor:". $transaction->authorization,
 843     } );
 844     my $error = $cust_pay->insert;
 845     if ( $error ) {
 846       # gah, even with transactions.
 847       my $e = 'WARNING: Card/ACH debited but database not updated - '.
 848               'error applying payment, invnum #' . $self->invnum.
 849               " ($processor): $error";
 850       warn $e;
 851       return $e;
 852     } else {
 853       return '';
 854     }
 855   #} elsif ( $options{'report_badcard'} ) {
 856   } else {
 857
 858     my $perror = "$processor error, invnum #". $self->invnum. ': '.
 859                  $transaction->result_code. ": ". $transaction->error_message;
 860
 861     if ( !$realtime_bop_decline_quiet && $conf->exists('emaildecline')
 862          && grep { $_ ne 'POST' } $cust_main->invoicing_list
 863          && ! grep { $_ eq $transaction->error_message }
 864                    $conf->config('emaildecline-exclude')
 865     ) {
 866       my @templ = $conf->config('declinetemplate');
 867       my $template = new Text::Template (
 868         TYPE   => 'ARRAY',
 869         SOURCE => [ map "$_\n", @templ ],
 870       ) or return "($perror) can't create template: $Text::Template::ERROR";
 871       $template->compile()
 872         or return "($perror) can't compile template: $Text::Template::ERROR";
 873
 874       my $templ_hash = { error => $transaction->error_message };
 875
 876       #false laziness w/FS::cust_pay::delete & fs_signup_server && ::send
 877       $ENV{MAILADDRESS} = $invoice_from;
 878       my $header = new Mail::Header ( [
 879         "From: $invoice_from",
 880         "To: ". join(', ', grep { $_ ne 'POST' } $cust_main->invoicing_list ),
 881         "Sender: $invoice_from",
 882         "Reply-To: $invoice_from",
 883         "Date: ". time2str("%a, %d %b %Y %X %z", time),
 884         "Subject: Your payment could not be processed",
 885       ] );
 886       my $message = new Mail::Internet (
 887         'Header' => $header,
 888         'Body' => [ $template->fill_in(HASH => $templ_hash) ],
 889       );
 890       $!=0;
 891       $message->smtpsend( Host => $smtpmachine )
 892         or $message->smtpsend( Host => $smtpmachine, Debug => 1 )
 893           or return "($perror) (customer # ". $self->custnum.
 894             ") can't send card decline email to ".
 895             join(', ', grep { $_ ne 'POST' } $cust_main->invoicing_list ).
 896             " via server $smtpmachine with SMTP: $!";
 897     }
 898
 899     return $perror;
 900   }
 901
 902 }
 903
 904 =item realtime_card_cybercash
 905
 906 Attempts to pay this invoice with the CyberCash CashRegister realtime gateway.
 907
 908 =cut
 909
 910 sub realtime_card_cybercash {
 911   my $self = shift;
 912   my $cust_main = $self->cust_main;
 913   my $amount = $self->owed;
 914
 915   return "CyberCash CashRegister real-time card processing not enabled!"
 916     unless $cybercash eq 'cybercash3.2';
 917
 918   my $address = $cust_main->address1;
 919   $address .= ", ". $cust_main->address2 if $cust_main->address2;
 920
 921   #fix exp. date
 922   #$cust_main->paydate =~ /^(\d+)\/\d*(\d{2})$/;
 923   $cust_main->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
 924   my $exp = "$2/$1";
 925
 926   #
 927
 928   my $paybatch = $self->invnum.
 929                   '-' . time2str("%y%m%d%H%M%S", time);
 930
 931   my $payname = $cust_main->payname ||
 932                 $cust_main->getfield('first').' '.$cust_main->getfield('last');
 933
 934   my $country = $cust_main->country eq 'US' ? 'USA' : $cust_main->country;
 935
 936   my @full_xaction = ( $xaction,
 937     'Order-ID'     => $paybatch,
 938     'Amount'       => "usd $amount",
 939     'Card-Number'  => $cust_main->getfield('payinfo'),
 940     'Card-Name'    => $payname,
 941     'Card-Address' => $address,
 942     'Card-City'    => $cust_main->getfield('city'),
 943     'Card-State'   => $cust_main->getfield('state'),
 944     'Card-Zip'     => $cust_main->getfield('zip'),
 945     'Card-Country' => $country,
 946     'Card-Exp'     => $exp,
 947   );
 948
 949   my %result;
 950   %result = &CCMckDirectLib3_2::SendCC2_1Server(@full_xaction);
 951
 952   if ( $result{'MStatus'} eq 'success' ) { #cybercash smps v.2 or 3
 953     my $cust_pay = new FS::cust_pay ( {
 954        'invnum'   => $self->invnum,
 955        'paid'     => $amount,
 956        '_date'     => '',
 957        'payby'    => 'CARD',
 958        'payinfo'  => $cust_main->payinfo,
 959        'paybatch' => "$cybercash:$paybatch",
 960     } );
 961     my $error = $cust_pay->insert;
 962     if ( $error ) {
 963       # gah, even with transactions.
 964       my $e = 'WARNING: Card debited but database not updated - '.
 965               'error applying payment, invnum #' . $self->invnum.
 966               " (CyberCash Order-ID $paybatch): $error";
 967       warn $e;
 968       return $e;
 969     } else {
 970       return '';
 971     }
 972 #  } elsif ( $result{'Mstatus'} ne 'failure-bad-money'
 973 #            || $options{'report_badcard'}
 974 #          ) {
 975   } else {
 976      return 'Cybercash error, invnum #' .
 977        $self->invnum. ':'. $result{'MErrMsg'};
 978   }
 979
 980 }
 981
 982 =item batch_card
 983
 984 Adds a payment for this invoice to the pending credit card batch (see
 985 L<FS::cust_pay_batch>).
 986
 987 =cut
 988
 989 sub batch_card {
 990   my $self = shift;
 991   my $cust_main = $self->cust_main;
 992
 993   my $cust_pay_batch = new FS::cust_pay_batch ( {
 994     'invnum'   => $self->getfield('invnum'),
 995     'custnum'  => $cust_main->getfield('custnum'),
 996     'last'     => $cust_main->getfield('last'),
 997     'first'    => $cust_main->getfield('first'),
 998     'address1' => $cust_main->getfield('address1'),
 999     'address2' => $cust_main->getfield('address2'),
1000     'city'     => $cust_main->getfield('city'),
1001     'state'    => $cust_main->getfield('state'),
1002     'zip'      => $cust_main->getfield('zip'),
1003     'country'  => $cust_main->getfield('country'),
1004     'cardnum'  => $cust_main->getfield('payinfo'),
1005     'exp'      => $cust_main->getfield('paydate'),
1006     'payname'  => $cust_main->getfield('payname'),
1007     'amount'   => $self->owed,
1008   } );
1009   my $error = $cust_pay_batch->insert;
1010   die $error if $error;
1011
1012   '';
1013 }
1014
1015 =item print_text [TIME];
1016
1017 Returns an text invoice, as a list of lines.
1018
1019 TIME an optional value used to control the printing of overdue messages.  The
1020 default is now.  It isn't the date of the invoice; that's the `_date' field.
1021 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1022 L<Time::Local> and L<Date::Parse> for conversion functions.
1023
1024 =cut
1025
1026 sub print_text {
1027
1028   my( $self, $today, $template ) = @_;
1029   $today ||= time;
1030 #  my $invnum = $self->invnum;
1031   my $cust_main = qsearchs('cust_main', { 'custnum', $self->custnum } );
1032   $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1033     unless $cust_main->payname && $cust_main->payby ne 'CHEK';
1034
1035   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1036 #  my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1037   #my $balance_due = $self->owed + $pr_total - $cr_total;
1038   my $balance_due = $self->owed + $pr_total;
1039
1040   #my @collect = ();
1041   #my($description,$amount);
1042   @buf = ();
1043
1044   #previous balance
1045   foreach ( @pr_cust_bill ) {
1046     push @buf, [
1047       "Previous Balance, Invoice #". $_->invnum.
1048                  " (". time2str("%x",$_->_date). ")",
1049       $money_char. sprintf("%10.2f",$_->owed)
1050     ];
1051   }
1052   if (@pr_cust_bill) {
1053     push @buf,['','-----------'];
1054     push @buf,[ 'Total Previous Balance',
1055                 $money_char. sprintf("%10.2f",$pr_total ) ];
1056     push @buf,['',''];
1057   }
1058
1059   #new charges
1060   foreach my $cust_bill_pkg (
1061     ( grep {   $_->pkgnum } $self->cust_bill_pkg ),  #packages first
1062     ( grep { ! $_->pkgnum } $self->cust_bill_pkg ),  #then taxes
1063   ) {
1064
1065     if ( $cust_bill_pkg->pkgnum ) {
1066
1067       my $cust_pkg = qsearchs('cust_pkg', { pkgnum =>$cust_bill_pkg->pkgnum } );
1068       my $part_pkg = qsearchs('part_pkg', { pkgpart=>$cust_pkg->pkgpart } );
1069       my $pkg = $part_pkg->pkg;
1070
1071       if ( $cust_bill_pkg->setup != 0 ) {
1072         push @buf, [ "$pkg Setup",
1073                      $money_char. sprintf("%10.2f", $cust_bill_pkg->setup) ];
1074         push @buf,
1075           map { [ "  ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
1076       }
1077
1078       if ( $cust_bill_pkg->recur != 0 ) {
1079         push @buf, [
1080           "$pkg (" . time2str("%x", $cust_bill_pkg->sdate) . " - " .
1081                                 time2str("%x", $cust_bill_pkg->edate) . ")",
1082           $money_char. sprintf("%10.2f", $cust_bill_pkg->recur)
1083         ];
1084         push @buf,
1085           map { [ "  ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
1086       }
1087
1088     } else { #pkgnum tax or one-shot line item
1089       my $itemdesc = defined $cust_bill_pkg->dbdef_table->column('itemdesc')
1090                      ? ( $cust_bill_pkg->itemdesc || 'Tax' )
1091                      : 'Tax';
1092       if ( $cust_bill_pkg->setup != 0 ) {
1093         push @buf, [ $itemdesc,
1094                      $money_char. sprintf("%10.2f", $cust_bill_pkg->setup) ];
1095       }
1096       if ( $cust_bill_pkg->recur != 0 ) {
1097         push @buf, [ "$itemdesc (". time2str("%x", $cust_bill_pkg->sdate). " - "
1098                                   . time2str("%x", $cust_bill_pkg->edate). ")",
1099                      $money_char. sprintf("%10.2f", $cust_bill_pkg->recur)
1100                    ];
1101       }
1102     }
1103   }
1104
1105   push @buf,['','-----------'];
1106   push @buf,['Total New Charges',
1107              $money_char. sprintf("%10.2f",$self->charged) ];
1108   push @buf,['',''];
1109
1110   push @buf,['','-----------'];
1111   push @buf,['Total Charges',
1112              $money_char. sprintf("%10.2f",$self->charged + $pr_total) ];
1113   push @buf,['',''];
1114
1115   #credits
1116   foreach ( $self->cust_credited ) {
1117
1118     #something more elaborate if $_->amount ne $_->cust_credit->credited ?
1119
1120     my $reason = substr($_->cust_credit->reason,0,32);
1121     $reason .= '...' if length($reason) < length($_->cust_credit->reason);
1122     $reason = " ($reason) " if $reason;
1123     push @buf,[
1124       "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")".
1125         $reason,
1126       $money_char. sprintf("%10.2f",$_->amount)
1127     ];
1128   }
1129   #foreach ( @cr_cust_credit ) {
1130   #  push @buf,[
1131   #    "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
1132   #    $money_char. sprintf("%10.2f",$_->credited)
1133   #  ];
1134   #}
1135
1136   #get & print payments
1137   foreach ( $self->cust_bill_pay ) {
1138
1139     #something more elaborate if $_->amount ne ->cust_pay->paid ?
1140
1141     push @buf,[
1142       "Payment received ". time2str("%x",$_->cust_pay->_date ),
1143       $money_char. sprintf("%10.2f",$_->amount )
1144     ];
1145   }
1146
1147   #balance due
1148   push @buf,['','-----------'];
1149   push @buf,['Balance Due', $money_char.
1150     sprintf("%10.2f", $balance_due ) ];
1151
1152   #create the template
1153   my $templatefile = 'invoice_template';
1154   $templatefile .= "_$template" if $template;
1155   my @invoice_template = $conf->config($templatefile)
1156   or die "cannot load config file $templatefile";
1157   $invoice_lines = 0;
1158   my $wasfunc = 0;
1159   foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1160     /invoice_lines\((\d*)\)/;
1161     $invoice_lines += $1 || scalar(@buf);
1162     $wasfunc=1;
1163   }
1164   die "no invoice_lines() functions in template?" unless $wasfunc;
1165   my $invoice_template = new Text::Template (
1166     TYPE   => 'ARRAY',
1167     SOURCE => [ map "$_\n", @invoice_template ],
1168   ) or die "can't create new Text::Template object: $Text::Template::ERROR";
1169   $invoice_template->compile()
1170     or die "can't compile template: $Text::Template::ERROR";
1171
1172   #setup template variables
1173   package FS::cust_bill::_template; #!
1174   use vars qw( $invnum $date $page $total_pages @address $overdue @buf $agent );
1175
1176   $invnum = $self->invnum;
1177   $date = $self->_date;
1178   $page = 1;
1179   $agent = $self->cust_main->agent->agent;
1180
1181   if ( $FS::cust_bill::invoice_lines ) {
1182     $total_pages =
1183       int( scalar(@FS::cust_bill::buf) / $FS::cust_bill::invoice_lines );
1184     $total_pages++
1185       if scalar(@FS::cust_bill::buf) % $FS::cust_bill::invoice_lines;
1186   } else {
1187     $total_pages = 1;
1188   }
1189
1190   #format address (variable for the template)
1191   my $l = 0;
1192   @address = ( '', '', '', '', '', '' );
1193   package FS::cust_bill; #!
1194   $FS::cust_bill::_template::address[$l++] =
1195     $cust_main->payname.
1196       ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
1197         ? " (P.O. #". $cust_main->payinfo. ")"
1198         : ''
1199       )
1200   ;
1201   $FS::cust_bill::_template::address[$l++] = $cust_main->company
1202     if $cust_main->company;
1203   $FS::cust_bill::_template::address[$l++] = $cust_main->address1;
1204   $FS::cust_bill::_template::address[$l++] = $cust_main->address2
1205     if $cust_main->address2;
1206   $FS::cust_bill::_template::address[$l++] =
1207     $cust_main->city. ", ". $cust_main->state. "  ".  $cust_main->zip;
1208   $FS::cust_bill::_template::address[$l++] = $cust_main->country
1209     unless $cust_main->country eq 'US';
1210
1211         #  #overdue? (variable for the template)
1212         #  $FS::cust_bill::_template::overdue = (
1213         #    $balance_due > 0
1214         #    && $today > $self->_date
1215         ##    && $self->printed > 1
1216         #    && $self->printed > 0
1217         #  );
1218
1219   #and subroutine for the template
1220   sub FS::cust_bill::_template::invoice_lines {
1221     my $lines = shift || scalar(@buf);
1222     map {
1223       scalar(@buf) ? shift @buf : [ '', '' ];
1224     }
1225     ( 1 .. $lines );
1226   }
1227
1228   #and fill it in
1229   $FS::cust_bill::_template::page = 1;
1230   my $lines;
1231   my @collect;
1232   while (@buf) {
1233     push @collect, split("\n",
1234       $invoice_template->fill_in( PACKAGE => 'FS::cust_bill::_template' )
1235     );
1236     $FS::cust_bill::_template::page++;
1237   }
1238
1239   map "$_\n", @collect;
1240
1241 }
1242
1243 =back
1244
1245 =head1 BUGS
1246
1247 The delete method.
1248
1249 print_text formatting (and some logic :/) is in source, but needs to be
1250 slurped in from a file.  Also number of lines ($=).
1251
1252 missing print_ps for a nice postscript copy (maybe HylaFAX-cover-page-style
1253 or something similar so the look can be completely customized?)
1254
1255 =head1 SEE ALSO
1256
1257 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
1258 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base
1259 documentation.
1260
1261 =cut
1262
1263 1;
1264