FS/FS/cust_pay.pm

   1 package FS::cust_pay;
   2
   3 use strict;
   4 use vars qw( @ISA $DEBUG $me $conf @encrypted_fields
   5              $unsuspendauto $ignore_noapply
   6            );
   7 use Date::Format;
   8 use Business::CreditCard;
   9 use Text::Template;
  10 use FS::UID qw( getotaker );
  11 use FS::Misc qw( send_email );
  12 use FS::Record qw( dbh qsearch qsearchs );
  13 use FS::payby;
  14 use FS::cust_main_Mixin;
  15 use FS::payinfo_Mixin;
  16 use FS::cust_bill;
  17 use FS::cust_bill_pay;
  18 use FS::cust_pay_refund;
  19 use FS::cust_main;
  20 use FS::cust_pay_void;
  21
  22 @ISA = qw(FS::Record FS::cust_main_Mixin FS::payinfo_Mixin  );
  23
  24 $DEBUG = 0;
  25
  26 $me = '[FS::cust_pay]';
  27
  28 $ignore_noapply = 0;
  29
  30 #ask FS::UID to run this stuff for us later
  31 FS::UID->install_callback( sub {
  32   $conf = new FS::Conf;
  33   $unsuspendauto = $conf->exists('unsuspendauto');
  34 } );
  35
  36 @encrypted_fields = ('payinfo');
  37
  38 =head1 NAME
  39
  40 FS::cust_pay - Object methods for cust_pay objects
  41
  42 =head1 SYNOPSIS
  43
  44   use FS::cust_pay;
  45
  46   $record = new FS::cust_pay \%hash;
  47   $record = new FS::cust_pay { 'column' => 'value' };
  48
  49   $error = $record->insert;
  50
  51   $error = $new_record->replace($old_record);
  52
  53   $error = $record->delete;
  54
  55   $error = $record->check;
  56
  57 =head1 DESCRIPTION
  58
  59 An FS::cust_pay object represents a payment; the transfer of money from a
  60 customer.  FS::cust_pay inherits from FS::Record.  The following fields are
  61 currently supported:
  62
  63 =over 4
  64
  65 =item paynum - primary key (assigned automatically for new payments)
  66
  67 =item custnum - customer (see L<FS::cust_main>)
  68
  69 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
  70 L<Time::Local> and L<Date::Parse> for conversion functions.
  71
  72 =item paid - Amount of this payment
  73
  74 =item otaker - order taker (assigned automatically, see L<FS::UID>)
  75
  76 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
  77
  78 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
  79
  80 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
  81
  82 =item paybatch - text field for tracking card processing or other batch grouping
  83
  84 =item payunique - Optional unique identifer to prevent duplicate transactions.
  85
  86 =item closed - books closed flag, empty or `Y'
  87
  88 =back
  89
  90 =head1 METHODS
  91
  92 =over 4
  93
  94 =item new HASHREF
  95
  96 Creates a new payment.  To add the payment to the databse, see L<"insert">.
  97
  98 =cut
  99
 100 sub table { 'cust_pay'; }
 101 sub cust_linked { $_[0]->cust_main_custnum; }
 102 sub cust_unlinked_msg {
 103   my $self = shift;
 104   "WARNING: can't find cust_main.custnum ". $self->custnum.
 105   ' (cust_pay.paynum '. $self->paynum. ')';
 106 }
 107
 108 =item insert
 109
 110 Adds this payment to the database.
 111
 112 For backwards-compatibility and convenience, if the additional field invnum
 113 is defined, an FS::cust_bill_pay record for the full amount of the payment
 114 will be created.  In this case, custnum is optional.  An hash of optional
 115 arguments may be passed.  Currently "manual" is supported.  If true, a
 116 payment receipt is sent instead of a statement when 'payment_receipt_email'
 117 configuration option is set.
 118
 119 =cut
 120
 121 sub insert {
 122   my ($self, %options) = @_;
 123
 124   local $SIG{HUP} = 'IGNORE';
 125   local $SIG{INT} = 'IGNORE';
 126   local $SIG{QUIT} = 'IGNORE';
 127   local $SIG{TERM} = 'IGNORE';
 128   local $SIG{TSTP} = 'IGNORE';
 129   local $SIG{PIPE} = 'IGNORE';
 130
 131   my $oldAutoCommit = $FS::UID::AutoCommit;
 132   local $FS::UID::AutoCommit = 0;
 133   my $dbh = dbh;
 134
 135   my $cust_bill;
 136   if ( $self->invnum ) {
 137     $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } )
 138       or do {
 139         $dbh->rollback if $oldAutoCommit;
 140         return "Unknown cust_bill.invnum: ". $self->invnum;
 141       };
 142     $self->custnum($cust_bill->custnum );
 143   }
 144
 145
 146   my $error = $self->check;
 147   return $error if $error;
 148
 149   my $cust_main = $self->cust_main;
 150   my $old_balance = $cust_main->balance;
 151
 152   $error = $self->SUPER::insert;
 153   if ( $error ) {
 154     $dbh->rollback if $oldAutoCommit;
 155     return "error inserting $self: $error";
 156   }
 157
 158   if ( $self->invnum ) {
 159     my $cust_bill_pay = new FS::cust_bill_pay {
 160       'invnum' => $self->invnum,
 161       'paynum' => $self->paynum,
 162       'amount' => $self->paid,
 163       '_date'  => $self->_date,
 164     };
 165     $error = $cust_bill_pay->insert;
 166     if ( $error ) {
 167       if ( $ignore_noapply ) {
 168         warn "warning: error inserting $cust_bill_pay: $error ".
 169              "(ignore_noapply flag set; inserting cust_pay record anyway)\n";
 170       } else {
 171         $dbh->rollback if $oldAutoCommit;
 172         return "error inserting $cust_bill_pay: $error";
 173       }
 174     }
 175   }
 176
 177   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 178
 179   #false laziness w/ cust_credit::insert
 180   if ( $unsuspendauto && $old_balance && $cust_main->balance <= 0 ) {
 181     my @errors = $cust_main->unsuspend;
 182     #return
 183     # side-fx with nested transactions?  upstack rolls back?
 184     warn "WARNING:Errors unsuspending customer ". $cust_main->custnum. ": ".
 185          join(' / ', @errors)
 186       if @errors;
 187   }
 188   #eslaf
 189
 190   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 191
 192   #my $cust_main = $self->cust_main;
 193   if ( $conf->exists('payment_receipt_email')
 194        && grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list
 195   ) {
 196
 197     $cust_bill ||= ($cust_main->cust_bill)[-1]; #rather inefficient though?
 198
 199     my $error;
 200     if (    ( exists($options{'manual'}) && $options{'manual'} )
 201          || ! $conf->exists('invoice_html_statement')
 202          || ! $cust_bill
 203        ) {
 204
 205       my $receipt_template = new Text::Template (
 206         TYPE   => 'ARRAY',
 207         SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ],
 208       ) or do {
 209         warn "can't create payment receipt template: $Text::Template::ERROR";
 210         return '';
 211       };
 212
 213       my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
 214                              $cust_main->invoicing_list;
 215
 216       my $payby = $self->payby;
 217       my $payinfo = $self->payinfo;
 218       $payby =~ s/^BILL$/Check/ if $payinfo;
 219       $payinfo = $self->paymask if $payby eq 'CARD' || $payby eq 'CHEK';
 220       $payby =~ s/^CHEK$/Electronic check/;
 221
 222       $error = send_email(
 223         'from'    => $conf->config('invoice_from'), #??? well as good as any
 224         'to'      => \@invoicing_list,
 225         'subject' => 'Payment receipt',
 226         'body'    => [ $receipt_template->fill_in( HASH => {
 227                        'date'    => time2str("%a %B %o, %Y", $self->_date),
 228                        'name'    => $cust_main->name,
 229                        'paynum'  => $self->paynum,
 230                        'paid'    => sprintf("%.2f", $self->paid),
 231                        'payby'   => ucfirst(lc($payby)),
 232                        'payinfo' => $payinfo,
 233                        'balance' => $cust_main->balance,
 234                      } ) ],
 235       );
 236
 237     } else {
 238
 239       my $queue = new FS::queue {
 240          'paynum' => $self->paynum,
 241          'job'    => 'FS::cust_bill::queueable_email',
 242       };
 243       $error = $queue->insert(
 244         'invnum' => $cust_bill->invnum,
 245         'template' => 'statement',
 246       );
 247
 248     }
 249
 250     if ( $error ) {
 251       warn "can't send payment receipt/statement: $error";
 252     }
 253
 254   }
 255
 256   '';
 257
 258 }
 259
 260 =item void [ REASON ]
 261
 262 Voids this payment: deletes the payment and all associated applications and
 263 adds a record of the voided payment to the FS::cust_pay_void table.
 264
 265 =cut
 266
 267 sub void {
 268   my $self = shift;
 269
 270   local $SIG{HUP} = 'IGNORE';
 271   local $SIG{INT} = 'IGNORE';
 272   local $SIG{QUIT} = 'IGNORE';
 273   local $SIG{TERM} = 'IGNORE';
 274   local $SIG{TSTP} = 'IGNORE';
 275   local $SIG{PIPE} = 'IGNORE';
 276
 277   my $oldAutoCommit = $FS::UID::AutoCommit;
 278   local $FS::UID::AutoCommit = 0;
 279   my $dbh = dbh;
 280
 281   my $cust_pay_void = new FS::cust_pay_void ( {
 282     map { $_ => $self->get($_) } $self->fields
 283   } );
 284   $cust_pay_void->reason(shift) if scalar(@_);
 285   my $error = $cust_pay_void->insert;
 286   if ( $error ) {
 287     $dbh->rollback if $oldAutoCommit;
 288     return $error;
 289   }
 290
 291   $error = $self->delete;
 292   if ( $error ) {
 293     $dbh->rollback if $oldAutoCommit;
 294     return $error;
 295   }
 296
 297   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 298
 299   '';
 300
 301 }
 302
 303 =item delete
 304
 305 Unless the closed flag is set, deletes this payment and all associated
 306 applications (see L<FS::cust_bill_pay> and L<FS::cust_pay_refund>).  In most
 307 cases, you want to use the void method instead to leave a record of the
 308 deleted payment.
 309
 310 =cut
 311
 312 # very similar to FS::cust_credit::delete
 313 sub delete {
 314   my $self = shift;
 315   return "Can't delete closed payment" if $self->closed =~ /^Y/i;
 316
 317   local $SIG{HUP} = 'IGNORE';
 318   local $SIG{INT} = 'IGNORE';
 319   local $SIG{QUIT} = 'IGNORE';
 320   local $SIG{TERM} = 'IGNORE';
 321   local $SIG{TSTP} = 'IGNORE';
 322   local $SIG{PIPE} = 'IGNORE';
 323
 324   my $oldAutoCommit = $FS::UID::AutoCommit;
 325   local $FS::UID::AutoCommit = 0;
 326   my $dbh = dbh;
 327
 328   foreach my $app ( $self->cust_bill_pay, $self->cust_pay_refund ) {
 329     my $error = $app->delete;
 330     if ( $error ) {
 331       $dbh->rollback if $oldAutoCommit;
 332       return $error;
 333     }
 334   }
 335
 336   my $error = $self->SUPER::delete(@_);
 337   if ( $error ) {
 338     $dbh->rollback if $oldAutoCommit;
 339     return $error;
 340   }
 341
 342   if ( $conf->config('deletepayments') ne '' ) {
 343
 344     my $cust_main = $self->cust_main;
 345
 346     my $error = send_email(
 347       'from'    => $conf->config('invoice_from'), #??? well as good as any
 348       'to'      => $conf->config('deletepayments'),
 349       'subject' => 'FREESIDE NOTIFICATION: Payment deleted',
 350       'body'    => [
 351         "This is an automatic message from your Freeside installation\n",
 352         "informing you that the following payment has been deleted:\n",
 353         "\n",
 354         'paynum: '. $self->paynum. "\n",
 355         'custnum: '. $self->custnum.
 356           " (". $cust_main->last. ", ". $cust_main->first. ")\n",
 357         'paid: $'. sprintf("%.2f", $self->paid). "\n",
 358         'date: '. time2str("%a %b %e %T %Y", $self->_date). "\n",
 359         'payby: '. $self->payby. "\n",
 360         'payinfo: '. $self->paymask. "\n",
 361         'paybatch: '. $self->paybatch. "\n",
 362       ],
 363     );
 364
 365     if ( $error ) {
 366       $dbh->rollback if $oldAutoCommit;
 367       return "can't send payment deletion notification: $error";
 368     }
 369
 370   }
 371
 372   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 373
 374   '';
 375
 376 }
 377
 378 =item replace OLD_RECORD
 379
 380 You can, but probably shouldn't modify payments...
 381
 382 =cut
 383
 384 sub replace {
 385   #return "Can't modify payment!"
 386   my $self = shift;
 387   return "Can't modify closed payment" if $self->closed =~ /^Y/i;
 388   $self->SUPER::replace(@_);
 389 }
 390
 391 =item check
 392
 393 Checks all fields to make sure this is a valid payment.  If there is an error,
 394 returns the error, otherwise returns false.  Called by the insert method.
 395
 396 =cut
 397
 398 sub check {
 399   my $self = shift;
 400
 401   $self->otaker(getotaker) unless ($self->otaker);
 402
 403   my $error =
 404     $self->ut_numbern('paynum')
 405     || $self->ut_numbern('custnum')
 406     || $self->ut_numbern('_date')
 407     || $self->ut_money('paid')
 408     || $self->ut_alpha('otaker')
 409     || $self->ut_textn('paybatch')
 410     || $self->ut_textn('payunique')
 411     || $self->ut_enum('closed', [ '', 'Y' ])
 412     || $self->payinfo_check()
 413   ;
 414   return $error if $error;
 415
 416   return "paid must be > 0 " if $self->paid <= 0;
 417
 418   return "unknown cust_main.custnum: ". $self->custnum
 419     unless $self->invnum
 420            || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 421
 422   $self->_date(time) unless $self->_date;
 423
 424 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it
 425 #  # UNIQUE index should catch this too, without race conditions, but this
 426 #  # should give a better error message the other 99.9% of the time...
 427 #  if ( length($self->payunique)
 428 #       && qsearchs('cust_pay', { 'payunique' => $self->payunique } ) ) {
 429 #    #well, it *could* be a better error message
 430 #    return "duplicate transaction".
 431 #           " - a payment with unique identifer ". $self->payunique.
 432 #           " already exists";
 433 #  }
 434
 435   $self->otaker(getotaker);
 436
 437   $self->SUPER::check;
 438 }
 439
 440 =item batch_insert CUST_PAY_OBJECT, ...
 441
 442 Class method which inserts multiple payments.  Takes a list of FS::cust_pay
 443 objects.  Returns a list, each element representing the status of inserting the
 444 corresponding payment - empty.  If there is an error inserting any payment, the
 445 entire transaction is rolled back, i.e. all payments are inserted or none are.
 446
 447 For example:
 448
 449   my @errors = FS::cust_pay->batch_insert(@cust_pay);
 450   my $num_errors = scalar(grep $_, @errors);
 451   if ( $num_errors == 0 ) {
 452     #success; all payments were inserted
 453   } else {
 454     #failure; no payments were inserted.
 455   }
 456
 457 =cut
 458
 459 sub batch_insert {
 460   my $self = shift; #class method
 461
 462   local $SIG{HUP} = 'IGNORE';
 463   local $SIG{INT} = 'IGNORE';
 464   local $SIG{QUIT} = 'IGNORE';
 465   local $SIG{TERM} = 'IGNORE';
 466   local $SIG{TSTP} = 'IGNORE';
 467   local $SIG{PIPE} = 'IGNORE';
 468
 469   my $oldAutoCommit = $FS::UID::AutoCommit;
 470   local $FS::UID::AutoCommit = 0;
 471   my $dbh = dbh;
 472
 473   my $errors = 0;
 474
 475   my @errors = map {
 476     my $error = $_->insert( 'manual' => 1 );
 477     if ( $error ) {
 478       $errors++;
 479     } else {
 480       $_->cust_main->apply_payments;
 481     }
 482     $error;
 483   } @_;
 484
 485   if ( $errors ) {
 486     $dbh->rollback if $oldAutoCommit;
 487   } else {
 488     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 489   }
 490
 491   @errors;
 492
 493 }
 494
 495 =item cust_bill_pay
 496
 497 Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
 498 payment.
 499
 500 =cut
 501
 502 sub cust_bill_pay {
 503   my $self = shift;
 504   sort {    $a->_date  <=> $b->_date
 505          || $a->invnum <=> $b->invnum }
 506     qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
 507   ;
 508 }
 509
 510 =item cust_pay_refund
 511
 512 Returns all applications of refunds (see L<FS::cust_pay_refund>) to this
 513 payment.
 514
 515 =cut
 516
 517 sub cust_pay_refund {
 518   my $self = shift;
 519   sort { $a->_date <=> $b->_date }
 520     qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } )
 521   ;
 522 }
 523
 524
 525 =item unapplied
 526
 527 Returns the amount of this payment that is still unapplied; which is
 528 paid minus all payment applications (see L<FS::cust_bill_pay>) and refund
 529 applications (see L<FS::cust_pay_refund>).
 530
 531 =cut
 532
 533 sub unapplied {
 534   my $self = shift;
 535   my $amount = $self->paid;
 536   $amount -= $_->amount foreach ( $self->cust_bill_pay );
 537   $amount -= $_->amount foreach ( $self->cust_pay_refund );
 538   sprintf("%.2f", $amount );
 539 }
 540
 541 =item unrefunded
 542
 543 Returns the amount of this payment that has not been refuned; which is
 544 paid minus all  refund applications (see L<FS::cust_pay_refund>).
 545
 546 =cut
 547
 548 sub unrefunded {
 549   my $self = shift;
 550   my $amount = $self->paid;
 551   $amount -= $_->amount foreach ( $self->cust_pay_refund );
 552   sprintf("%.2f", $amount );
 553 }
 554
 555
 556 =item cust_main
 557
 558 Returns the parent customer object (see L<FS::cust_main>).
 559
 560 =cut
 561
 562 sub cust_main {
 563   my $self = shift;
 564   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 565 }
 566
 567 =item payby_name
 568
 569 Returns a name for the payby field.
 570
 571 =cut
 572
 573 sub payby_name {
 574   my $self = shift;
 575   FS::payby->shortname( $self->payby );
 576 }
 577
 578 =item gatewaynum
 579
 580 Returns a gatewaynum for the processing gateway.
 581
 582 =item processor
 583
 584 Returns a name for the processing gateway.
 585
 586 =item authorization
 587
 588 Returns a name for the processing gateway.
 589
 590 =item order_number
 591
 592 Returns a name for the processing gateway.
 593
 594 =cut
 595
 596 sub gatewaynum    { shift->_parse_paybatch->{'gatewaynum'}; }
 597 sub processor     { shift->_parse_paybatch->{'processor'}; }
 598 sub authorization { shift->_parse_paybatch->{'authorization'}; }
 599 sub order_number  { shift->_parse_paybatch->{'order_number'}; }
 600
 601 #sucks that this stuff is in paybatch like this in the first place,
 602 #but at least other code can start to use new field names
 603 #(code nicked from FS::cust_main::realtime_refund_bop)
 604 sub _parse_paybatch {
 605   my $self = shift;
 606
 607   $self->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
 608     or return {};
 609               #"Can't parse paybatch for paynum $options{'paynum'}: ".
 610               #  $cust_pay->paybatch;
 611
 612   my( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
 613
 614   if ( $gatewaynum ) { #gateway for the payment to be refunded
 615
 616     my $payment_gateway =
 617       qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
 618
 619     die "payment gateway $gatewaynum not found" #?
 620       unless $payment_gateway;
 621
 622     $processor = $payment_gateway->gateway_module;
 623
 624   }
 625
 626   {
 627     'gatewaynum'    => $gatewaynum,
 628     'processor'     => $processor,
 629     'authorization' => $auth,
 630     'order_number'  => $order_number,
 631   };
 632
 633 }
 634
 635 =back
 636
 637 =head1 CLASS METHODS
 638
 639 =over 4
 640
 641 =item unapplied_sql
 642
 643 Returns an SQL fragment to retreive the unapplied amount.
 644
 645 =cut
 646
 647 sub unapplied_sql {
 648   #my $class = shift;
 649
 650   "paid
 651         - COALESCE(
 652                     ( SELECT SUM(amount) FROM cust_bill_pay
 653                         WHERE cust_pay.paynum = cust_bill_pay.paynum )
 654                     ,0
 655                   )
 656         - COALESCE(
 657                     ( SELECT SUM(amount) FROM cust_pay_refund
 658                         WHERE cust_pay.paynum = cust_pay_refund.paynum )
 659                     ,0
 660                   )
 661   ";
 662
 663 }
 664
 665 # _upgrade_data
 666 #
 667 # Used by FS::Upgrade to migrate to a new database.
 668
 669 use FS::h_cust_pay;
 670
 671 sub _upgrade_data {  #class method
 672   my ($class, %opts) = @_;
 673
 674   warn "$me upgrading $class\n" if $DEBUG;
 675
 676   #not the most efficient, but hey, it only has to run once
 677
 678   my $count_sql =
 679     "SELECT COUNT(*) FROM cust_pay WHERE otaker IS NULL OR otaker = ''";
 680
 681   my $sth = dbh->prepare($count_sql) or die dbh->errstr;
 682   $sth->execute or die $sth->errstr;
 683   my $total = $sth->fetchrow_arrayref->[0];
 684
 685   local($DEBUG) = 2 if $total > 1000; #could be a while, force progress info
 686
 687   my $count = 0;
 688   my $lastprog = 0;
 689   while (1) {
 690
 691     my $cust_pay = qsearchs( {
 692       'table'     => 'cust_pay',
 693       'hashref'   => {},
 694       'extra_sql' => "WHERE otaker IS NULL OR otaker = ''",
 695       'order_by'  => 'ORDER BY paynum LIMIT 1',
 696     } );
 697
 698     return unless $cust_pay;
 699
 700     my $h_cust_pay = $cust_pay->h_search('insert');
 701     if ( $h_cust_pay ) {
 702       $cust_pay->otaker($h_cust_pay->history_user);
 703     } else {
 704       $cust_pay->otaker('legacy');
 705     }
 706     my $error = $cust_pay->replace;
 707     die $error if $error;
 708
 709     $count++;
 710     if ( $DEBUG > 1 && $lastprog + 30 < time ) {
 711       warn "$me $count/$total (". sprintf('%.2f',100*$count/$total). '%)'. "\n";
 712       $lastprog = time;
 713     }
 714
 715   }
 716
 717 }
 718
 719 =back
 720
 721 =head1 SUBROUTINES
 722
 723 =over 4
 724
 725 =item batch_import HASHREF
 726
 727 Inserts new payments.
 728
 729 =cut
 730
 731 sub batch_import {
 732   my $param = shift;
 733
 734   my $fh = $param->{filehandle};
 735   my $agentnum = $param->{agentnum};
 736   my $format = $param->{'format'};
 737   my $paybatch = $param->{'paybatch'};
 738
 739   # here is the agent virtualization
 740   my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
 741
 742   my @fields;
 743   my $payby;
 744   if ( $format eq 'simple' ) {
 745     @fields = qw( custnum agent_custid paid payinfo );
 746     $payby = 'BILL';
 747   } elsif ( $format eq 'extended' ) {
 748     die "unimplemented\n";
 749     @fields = qw( );
 750     $payby = 'BILL';
 751   } else {
 752     die "unknown format $format";
 753   }
 754
 755   eval "use Text::CSV_XS;";
 756   die $@ if $@;
 757
 758   my $csv = new Text::CSV_XS;
 759
 760   my $imported = 0;
 761
 762   local $SIG{HUP} = 'IGNORE';
 763   local $SIG{INT} = 'IGNORE';
 764   local $SIG{QUIT} = 'IGNORE';
 765   local $SIG{TERM} = 'IGNORE';
 766   local $SIG{TSTP} = 'IGNORE';
 767   local $SIG{PIPE} = 'IGNORE';
 768
 769   my $oldAutoCommit = $FS::UID::AutoCommit;
 770   local $FS::UID::AutoCommit = 0;
 771   my $dbh = dbh;
 772
 773   my $line;
 774   while ( defined($line=<$fh>) ) {
 775
 776     $csv->parse($line) or do {
 777       $dbh->rollback if $oldAutoCommit;
 778       return "can't parse: ". $csv->error_input();
 779     };
 780
 781     my @columns = $csv->fields();
 782
 783     my %cust_pay = (
 784       payby    => $payby,
 785       paybatch => $paybatch,
 786     );
 787
 788     my $cust_main;
 789     foreach my $field ( @fields ) {
 790
 791       if ( $field eq 'agent_custid'
 792         && $agentnum
 793         && $columns[0] =~ /\S+/ )
 794       {
 795
 796         my $agent_custid = $columns[0];
 797         my %hash = ( 'agent_custid' => $agent_custid,
 798                      'agentnum'     => $agentnum,
 799                    );
 800
 801         if ( $cust_pay{'custnum'} !~ /^\s*$/ ) {
 802           $dbh->rollback if $oldAutoCommit;
 803           return "can't specify custnum with agent_custid $agent_custid";
 804         }
 805
 806         $cust_main = qsearchs({
 807                                 'table'     => 'cust_main',
 808                                 'hashref'   => \%hash,
 809                                 'extra_sql' => $extra_sql,
 810                              });
 811
 812         unless ( $cust_main ) {
 813           $dbh->rollback if $oldAutoCommit;
 814           return "can't find customer with agent_custid $agent_custid";
 815         }
 816
 817         $field = 'custnum';
 818         $columns[0] = $cust_main->custnum;
 819       }
 820
 821       $cust_pay{$field} = shift @columns;
 822     }
 823
 824     my $cust_pay = new FS::cust_pay( \%cust_pay );
 825     my $error = $cust_pay->insert;
 826
 827     if ( $error ) {
 828       $dbh->rollback if $oldAutoCommit;
 829       return "can't insert payment for $line: $error";
 830     }
 831
 832     if ( $format eq 'simple' ) {
 833       # include agentnum for less surprise?
 834       $cust_main = qsearchs({
 835                              'table'     => 'cust_main',
 836                              'hashref'   => { 'custnum' => $cust_pay->custnum },
 837                              'extra_sql' => $extra_sql,
 838                            })
 839         unless $cust_main;
 840
 841       unless ( $cust_main ) {
 842         $dbh->rollback if $oldAutoCommit;
 843         return "can't find customer to which payments apply at line: $line";
 844       }
 845
 846       $error = $cust_main->apply_payments_and_credits;
 847       if ( $error ) {
 848         $dbh->rollback if $oldAutoCommit;
 849         return "can't apply payments to customer for $line: $error";
 850       }
 851
 852     }
 853
 854     $imported++;
 855   }
 856
 857   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 858
 859   return "Empty file!" unless $imported;
 860
 861   ''; #no error
 862
 863 }
 864
 865 =back
 866
 867 =head1 BUGS
 868
 869 Delete and replace methods.
 870
 871 =head1 SEE ALSO
 872
 873 L<FS::cust_pay_pending>, L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>,
 874 schema.html from the base documentation.
 875
 876 =cut
 877
 878 1;
 879