FS/FS/cust_main/Billing_Batch.pm

   1 package FS::cust_main::Billing_Batch;
   2
   3 use strict;
   4 use vars qw( $conf );
   5 use FS::Record qw( qsearch qsearchs dbh );
   6 use FS::pay_batch;
   7 use FS::cust_pay_batch;
   8 use FS::cust_bill_pay_batch;
   9
  10 install_callback FS::UID sub {
  11   $conf = new FS::Conf;
  12   #yes, need it for stuff below (prolly should be cached)
  13 };
  14
  15 =item batch_card OPTION => VALUE...
  16
  17 Adds a payment for this invoice to the pending credit card batch (see
  18 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
  19 runs the payment using a realtime gateway.
  20
  21 Options may include:
  22
  23 B<amount>: the amount to be paid; defaults to the customer's balance minus
  24 any payments in transit.
  25
  26 B<realtime>: runs this as a realtime payment instead of adding it to a
  27 batch.  Deprecated.
  28
  29 B<invnum>: sets cust_pay_batch.invnum.
  30
  31 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
  32 the billing address for the payment; defaults to the customer's billing
  33 location.
  34
  35 B<payby>, B<payinfo>, B<paydate>, B<payname>: sets the payment method,
  36 payment account, expiration date, and name; defaults to those fields
  37 in cust_main.
  38
  39 =cut
  40
  41 sub batch_card {
  42   my ($self, %options) = @_;
  43
  44   my $amount;
  45   if (exists($options{amount})) {
  46     $amount = $options{amount};
  47   }else{
  48     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
  49   }
  50   if ($amount <= 0) {
  51     warn(sprintf("Customer balance %.2f - in transit amount %.2f is <= 0.\n",
  52         $self->balance,
  53         $self->in_transit_payments
  54     ));
  55     return;
  56   }
  57
  58   #my $invnum = delete $options{invnum};
  59   my $invnum = $options{invnum};
  60
  61   #pay fields should all come from either cust_payby or options, not both
  62   #  in theory, could just pass payby, and use it to select cust_payby,
  63   #  but nothing currently needs that, so not implementing it now
  64   die "Incomplete payment details"
  65     if  ($options{payby} || $options{payinfo} || $options{paydate} || $options{payname})
  66     && !($options{payby} && $options{payinfo} && $options{paydate} && $options{payname});
  67
  68   #false laziness with Billing_Realtime
  69   my @cust_payby = $self->cust_payby('CARD','CHEK');
  70
  71   # batch can't try out every one like realtime, just use first one
  72   my $cust_payby = $cust_payby[0];
  73
  74   die "No customer payment info found"
  75     unless $options{payinfo} || $cust_payby;
  76
  77   my $payby = $options{payby} || $cust_payby->payby;
  78
  79   if ($options{'realtime'}) {
  80     return $self->realtime_bop( FS::payby->payby2bop($payby),
  81                                 $amount,
  82                                 %options,
  83                               );
  84   }
  85
  86   my $paycode= $options{paycode} || '';
  87   my $batch_type = "DEBIT";
  88   $batch_type = "CREDIT" if $paycode eq 'C';
  89
  90   my $oldAutoCommit = $FS::UID::AutoCommit;
  91   local $FS::UID::AutoCommit = 0;
  92   my $dbh = dbh;
  93
  94   #this needs to handle mysql as well as Pg, like svc_acct.pm
  95   #(make it into a common function if folks need to do batching with mysql)
  96   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
  97     or die "Cannot lock pay_batch: " . $dbh->errstr;
  98
  99   my %pay_batch = (
 100     'status' => 'O',
 101     'payby'  => FS::payby->payby2payment($payby),
 102     'type'   => $batch_type,
 103   );
 104   $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
 105
 106   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
 107
 108   unless ( $pay_batch ) {
 109     $pay_batch = new FS::pay_batch \%pay_batch;
 110     my $error = $pay_batch->insert;
 111     if ( $error ) {
 112       $dbh->rollback if $oldAutoCommit;
 113       die "error creating new batch: $error\n";
 114     }
 115   }
 116
 117   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
 118       'batchnum' => $pay_batch->batchnum,
 119       'custnum'  => $self->custnum,
 120   } );
 121
 122   foreach (qw( address1 address2 city state zip country latitude longitude
 123                payby payinfo paydate payname paycode paytype ))
 124   {
 125     $options{$_} = '' unless exists($options{$_});
 126   }
 127
 128   my $loc = $self->bill_location;
 129
 130   my $cust_pay_batch = new FS::cust_pay_batch ( {
 131     'batchnum' => $pay_batch->batchnum,
 132     'invnum'   => $invnum || 0,                    # is there a better value?
 133                                                    # this field should be
 134                                                    # removed...
 135                                                    # cust_bill_pay_batch now
 136     'custnum'  => $self->custnum,
 137     'last'     => $self->getfield('last'),
 138     'first'    => $self->getfield('first'),
 139     'address1' => $options{address1} || $loc->address1,
 140     'address2' => $options{address2} || $loc->address2,
 141     'city'     => $options{city}     || $loc->city,
 142     'state'    => $options{state}    || $loc->state,
 143     'zip'      => $options{zip}      || $loc->zip,
 144     'country'  => $options{country}  || $loc->country,
 145     'payby'    => $options{payby}    || $cust_payby->payby,
 146     'payinfo'  => $options{payinfo}  || $cust_payby->payinfo,
 147     'paymask'  => ( $options{payinfo}
 148                       ? FS::payinfo_Mixin->mask_payinfo( $options{payby},
 149                                                          $options{payinfo} )
 150                       : $cust_payby->paymask
 151                   ),
 152     'exp'      => $options{paydate}  || $cust_payby->paydate,
 153     'payname'  => $options{payname}  || $cust_payby->payname,
 154     'paytype'  => $options{paytype}  || $cust_payby->paytype,
 155     'amount'   => $amount,                         # consolidating
 156     'paycode'  => $options{paycode}  || '',
 157   } );
 158
 159   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
 160     if $old_cust_pay_batch;
 161
 162   my $error;
 163   if ($old_cust_pay_batch) {
 164     $error = $cust_pay_batch->replace($old_cust_pay_batch)
 165   } else {
 166     $error = $cust_pay_batch->insert;
 167   }
 168
 169   if ( $error ) {
 170     $dbh->rollback if $oldAutoCommit;
 171     #die $error;
 172     return $error; # e.g. "Illegal zip" ala RT#75998
 173   }
 174
 175   if ($options{'processing-fee'} > 0) {
 176     my $pf_cust_pkg;
 177     my $processing_fee_text = 'Payment Processing Fee';
 178
 179     unless ( $invnum ) { # probably from a payment screen
 180       # do we have any open invoices? pick earliest
 181       # uses the fact that cust_main->cust_bill sorts by date ascending
 182       my @open = $self->open_cust_bill;
 183       $invnum = $open[0]->invnum if scalar(@open);
 184     }
 185
 186     unless ( $invnum ) {  # still nothing? pick last closed invoice
 187       # again uses fact that cust_main->cust_bill sorts by date ascending
 188       my @closed = $self->cust_bill;
 189       $invnum = $closed[$#closed]->invnum if scalar(@closed);
 190     }
 191
 192     unless ( $invnum ) {
 193       # XXX: unlikely case - pre-paying before any invoices generated
 194       # what it should do is create a new invoice and pick it
 195       warn '\PROCESS FEE AND NO INVOICES PICKED TO APPLY IT!';
 196       return '';
 197     }
 198
 199     my $pf_change_error = $self->charge({
 200             'amount'  => $options{'processing-fee'},
 201             'pkg'   => $processing_fee_text,
 202             'setuptax'  => 'Y',
 203             'cust_pkg_ref' => \$pf_cust_pkg,
 204     });
 205
 206     if($pf_change_error) {
 207       warn 'Unable to add payment processing fee';
 208       return '';
 209     }
 210
 211     $pf_cust_pkg->setup(time);
 212     my $pf_error = $pf_cust_pkg->replace;
 213     if($pf_error) {
 214       warn 'Unable to set setup time on cust_pkg for processing fee';
 215       # but keep going...
 216     }
 217
 218     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $invnum });
 219     unless ( $cust_bill ) {
 220       warn "race condition + invoice deletion just happened";
 221       return '';
 222     }
 223
 224     my $grand_pf_error =
 225       $cust_bill->add_cc_surcharge($pf_cust_pkg->pkgnum,$options{'processing-fee'});
 226
 227     warn "cannot add Processing fee to invoice #$invnum: $grand_pf_error"
 228       if $grand_pf_error;
 229   }
 230
 231   my $unapplied =   $self->total_unapplied_credits
 232                   + $self->total_unapplied_payments
 233                   + $self->in_transit_payments;
 234   foreach my $cust_bill ($self->open_cust_bill) {
 235     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
 236     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
 237       'invnum' => $cust_bill->invnum,
 238       'paybatchnum' => $cust_pay_batch->paybatchnum,
 239       'amount' => $cust_bill->owed,
 240       '_date' => time,
 241     };
 242     if ($unapplied >= $cust_bill_pay_batch->amount){
 243       $unapplied -= $cust_bill_pay_batch->amount;
 244       next;
 245     }else{
 246       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
 247                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
 248     }
 249     $error = $cust_bill_pay_batch->insert;
 250     if ( $error ) {
 251       $dbh->rollback if $oldAutoCommit;
 252       die $error;
 253     }
 254   }
 255
 256   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 257   '';
 258 }
 259
 260 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
 261
 262 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
 263
 264 Optionally, a list or hashref of additional arguments to the qsearch call can
 265 be passed.
 266
 267 =cut
 268
 269 sub cust_pay_batch {
 270   my $self = shift;
 271   my $opt = ref($_[0]) ? shift : { @_ };
 272
 273   #return $self->num_cust_statement unless wantarray || keys %$opt;
 274
 275   $opt->{'table'} = 'cust_pay_batch';
 276   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
 277   $opt->{'hashref'}{'custnum'} = $self->custnum;
 278   $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
 279
 280   map { $_ } #behavior of sort undefined in scalar context
 281     sort { $a->paybatchnum <=> $b->paybatchnum }
 282       qsearch($opt);
 283 }
 284
 285 =item in_transit_payments
 286
 287 Returns the total of requests for payments for this customer pending in
 288 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
 289
 290 =cut
 291
 292 sub in_transit_payments {
 293   my $self = shift;
 294   my $in_transit_payments = 0;
 295   foreach my $pay_batch ( qsearch('pay_batch', {
 296     'status' => 'I',
 297   } ) ) {
 298     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
 299       'batchnum' => $pay_batch->batchnum,
 300       'custnum' => $self->custnum,
 301       'status'  => '',
 302     } ) ) {
 303       $in_transit_payments += $cust_pay_batch->amount;
 304     }
 305   }
 306   sprintf( "%.2f", $in_transit_payments );
 307 }
 308
 309 1;