1 package FS::cust_main::Billing_Batch;
5 use FS::Record qw( qsearch qsearchs dbh );
7 use FS::cust_pay_batch;
9 install_callback FS::UID sub {
11 #yes, need it for stuff below (prolly should be cached)
14 =item batch_card OPTION => VALUE...
16 Adds a payment for this invoice to the pending credit card batch (see
17 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
18 runs the payment using a realtime gateway.
22 B<amount>: the amount to be paid; defaults to the customer's balance minus
23 any payments in transit.
25 B<payby>: the payment method; defaults to cust_main.payby
27 B<realtime>: runs this as a realtime payment instead of adding it to a
30 B<invnum>: sets cust_pay_batch.invnum.
32 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
33 the billing address for the payment; defaults to the customer's billing
36 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
37 date, and name; defaults to those fields in cust_main.
42 my ($self, %options) = @_;
45 if (exists($options{amount})) {
46 $amount = $options{amount};
48 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
50 return '' unless $amount > 0;
52 my $invnum = delete $options{invnum};
53 my $payby = $options{payby} || $self->payby; #still dubious
55 if ($options{'realtime'}) {
56 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
62 my $oldAutoCommit = $FS::UID::AutoCommit;
63 local $FS::UID::AutoCommit = 0;
66 #this needs to handle mysql as well as Pg, like svc_acct.pm
67 #(make it into a common function if folks need to do batching with mysql)
68 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
69 or return "Cannot lock pay_batch: " . $dbh->errstr;
73 'payby' => FS::payby->payby2payment($payby),
75 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
77 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
79 unless ( $pay_batch ) {
80 $pay_batch = new FS::pay_batch \%pay_batch;
81 my $error = $pay_batch->insert;
83 $dbh->rollback if $oldAutoCommit;
84 die "error creating new batch: $error\n";
88 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
89 'batchnum' => $pay_batch->batchnum,
90 'custnum' => $self->custnum,
93 foreach (qw( address1 address2 city state zip country latitude longitude
94 payby payinfo paydate payname ))
96 $options{$_} = '' unless exists($options{$_});
99 my $loc = $self->bill_location;
101 my $cust_pay_batch = new FS::cust_pay_batch ( {
102 'batchnum' => $pay_batch->batchnum,
103 'invnum' => $invnum || 0, # is there a better value?
104 # this field should be
106 # cust_bill_pay_batch now
107 'custnum' => $self->custnum,
108 'last' => $self->getfield('last'),
109 'first' => $self->getfield('first'),
110 'address1' => $options{address1} || $loc->address1,
111 'address2' => $options{address2} || $loc->address2,
112 'city' => $options{city} || $loc->city,
113 'state' => $options{state} || $loc->state,
114 'zip' => $options{zip} || $loc->zip,
115 'country' => $options{country} || $loc->country,
116 'payby' => $options{payby} || $self->payby,
117 'payinfo' => $options{payinfo} || $self->payinfo,
118 'exp' => $options{paydate} || $self->paydate,
119 'payname' => $options{payname} || $self->payname,
120 'amount' => $amount, # consolidating
123 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
124 if $old_cust_pay_batch;
127 if ($old_cust_pay_batch) {
128 $error = $cust_pay_batch->replace($old_cust_pay_batch)
130 $error = $cust_pay_batch->insert;
134 $dbh->rollback if $oldAutoCommit;
138 my $unapplied = $self->total_unapplied_credits
139 + $self->total_unapplied_payments
140 + $self->in_transit_payments;
141 foreach my $cust_bill ($self->open_cust_bill) {
142 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
143 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
144 'invnum' => $cust_bill->invnum,
145 'paybatchnum' => $cust_pay_batch->paybatchnum,
146 'amount' => $cust_bill->owed,
149 if ($unapplied >= $cust_bill_pay_batch->amount){
150 $unapplied -= $cust_bill_pay_batch->amount;
153 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
154 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
156 $error = $cust_bill_pay_batch->insert;
158 $dbh->rollback if $oldAutoCommit;
163 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
167 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
169 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
171 Optionally, a list or hashref of additional arguments to the qsearch call can
178 my $opt = ref($_[0]) ? shift : { @_ };
180 #return $self->num_cust_statement unless wantarray || keys %$opt;
182 $opt->{'table'} = 'cust_pay_batch';
183 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
184 $opt->{'hashref'}{'custnum'} = $self->custnum;
185 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
187 map { $_ } #behavior of sort undefined in scalar context
188 sort { $a->paybatchnum <=> $b->paybatchnum }
192 =item in_transit_payments
194 Returns the total of requests for payments for this customer pending in
195 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
199 sub in_transit_payments {
201 my $in_transit_payments = 0;
202 foreach my $pay_batch ( qsearch('pay_batch', {
205 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
206 'batchnum' => $pay_batch->batchnum,
207 'custnum' => $self->custnum,
209 $in_transit_payments += $cust_pay_batch->amount;
212 sprintf( "%.2f", $in_transit_payments );