1 package FS::cust_main::Billing_Batch;
5 use FS::Record qw( qsearch qsearchs dbh );
7 use FS::cust_pay_batch;
8 use FS::cust_bill_pay_batch;
10 install_callback FS::UID sub {
12 #yes, need it for stuff below (prolly should be cached)
15 =item batch_card OPTION => VALUE...
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.
23 B<amount>: the amount to be paid; defaults to the customer's balance minus
24 any payments in transit.
26 B<realtime>: runs this as a realtime payment instead of adding it to a
29 B<invnum>: sets cust_pay_batch.invnum.
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
35 B<payby>, B<payinfo>, B<paydate>, B<payname>: sets the payment method,
36 payment account, expiration date, and name; defaults to those fields
42 my ($self, %options) = @_;
45 if (exists($options{amount})) {
46 $amount = $options{amount};
48 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
51 warn(sprintf("Customer balance %.2f - in transit amount %.2f is <= 0.\n",
53 $self->in_transit_payments
58 #my $invnum = delete $options{invnum};
59 my $invnum = $options{invnum};
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});
68 #false laziness with Billing_Realtime
69 my @cust_payby = $self->cust_payby('CARD','CHEK');
71 # batch can't try out every one like realtime, just use first one
72 my $cust_payby = $cust_payby[0];
74 die "No customer payment info found"
75 unless $options{payinfo} || $cust_payby;
77 my $payby = $options{payby} || $cust_payby->payby;
79 if ($options{'realtime'}) {
80 return $self->realtime_bop( FS::payby->payby2bop($payby),
86 my $paycode= $options{paycode} || '';
87 my $batch_type = "DEBIT";
88 $batch_type = "CREDIT" if $paycode eq 'C';
90 my $oldAutoCommit = $FS::UID::AutoCommit;
91 local $FS::UID::AutoCommit = 0;
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;
101 'payby' => FS::payby->payby2payment($payby),
102 'type' => $batch_type,
104 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
106 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
108 unless ( $pay_batch ) {
109 $pay_batch = new FS::pay_batch \%pay_batch;
110 my $error = $pay_batch->insert;
112 $dbh->rollback if $oldAutoCommit;
113 die "error creating new batch: $error\n";
117 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
118 'batchnum' => $pay_batch->batchnum,
119 'custnum' => $self->custnum,
122 foreach (qw( address1 address2 city state zip country latitude longitude
123 payby payinfo paydate payname paycode paytype ))
125 $options{$_} = '' unless exists($options{$_});
128 my $loc = $self->bill_location;
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
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 'exp' => $options{paydate} || $cust_payby->paydate,
148 'payname' => $options{payname} || $cust_payby->payname,
149 'paytype' => $options{paytype} || $cust_payby->{'Hash'}->{'paytype'},
150 'amount' => $amount, # consolidating
151 'paycode' => $options{paycode} || '',
154 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
155 if $old_cust_pay_batch;
158 if ($old_cust_pay_batch) {
159 $error = $cust_pay_batch->replace($old_cust_pay_batch)
161 $error = $cust_pay_batch->insert;
165 $dbh->rollback if $oldAutoCommit;
167 return $error; # e.g. "Illegal zip" ala RT#75998
170 if ($options{'processing-fee'} > 0) {
172 my $processing_fee_text = 'Payment Processing Fee';
174 unless ( $invnum ) { # probably from a payment screen
175 # do we have any open invoices? pick earliest
176 # uses the fact that cust_main->cust_bill sorts by date ascending
177 my @open = $self->open_cust_bill;
178 $invnum = $open[0]->invnum if scalar(@open);
181 unless ( $invnum ) { # still nothing? pick last closed invoice
182 # again uses fact that cust_main->cust_bill sorts by date ascending
183 my @closed = $self->cust_bill;
184 $invnum = $closed[$#closed]->invnum if scalar(@closed);
188 # XXX: unlikely case - pre-paying before any invoices generated
189 # what it should do is create a new invoice and pick it
190 warn '\PROCESS FEE AND NO INVOICES PICKED TO APPLY IT!';
194 my $pf_change_error = $self->charge({
195 'amount' => $options{'processing-fee'},
196 'pkg' => $processing_fee_text,
198 'cust_pkg_ref' => \$pf_cust_pkg,
201 if($pf_change_error) {
202 warn 'Unable to add payment processing fee';
206 $pf_cust_pkg->setup(time);
207 my $pf_error = $pf_cust_pkg->replace;
209 warn 'Unable to set setup time on cust_pkg for processing fee';
213 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $invnum });
214 unless ( $cust_bill ) {
215 warn "race condition + invoice deletion just happened";
220 $cust_bill->add_cc_surcharge($pf_cust_pkg->pkgnum,$options{'processing-fee'});
222 warn "cannot add Processing fee to invoice #$invnum: $grand_pf_error"
226 my $unapplied = $self->total_unapplied_credits
227 + $self->total_unapplied_payments
228 + $self->in_transit_payments;
229 foreach my $cust_bill ($self->open_cust_bill) {
230 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
231 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
232 'invnum' => $cust_bill->invnum,
233 'paybatchnum' => $cust_pay_batch->paybatchnum,
234 'amount' => $cust_bill->owed,
237 if ($unapplied >= $cust_bill_pay_batch->amount){
238 $unapplied -= $cust_bill_pay_batch->amount;
241 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
242 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
244 $error = $cust_bill_pay_batch->insert;
246 $dbh->rollback if $oldAutoCommit;
251 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
255 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
257 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
259 Optionally, a list or hashref of additional arguments to the qsearch call can
266 my $opt = ref($_[0]) ? shift : { @_ };
268 #return $self->num_cust_statement unless wantarray || keys %$opt;
270 $opt->{'table'} = 'cust_pay_batch';
271 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
272 $opt->{'hashref'}{'custnum'} = $self->custnum;
273 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
275 map { $_ } #behavior of sort undefined in scalar context
276 sort { $a->paybatchnum <=> $b->paybatchnum }
280 =item in_transit_payments
282 Returns the total of requests for payments for this customer pending in
283 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
287 sub in_transit_payments {
289 my $in_transit_payments = 0;
290 foreach my $pay_batch ( qsearch('pay_batch', {
293 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
294 'batchnum' => $pay_batch->batchnum,
295 'custnum' => $self->custnum,
298 $in_transit_payments += $cust_pay_batch->amount;
301 sprintf( "%.2f", $in_transit_payments );