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<payby>: the payment method; defaults to cust_main.payby
28 B<realtime>: runs this as a realtime payment instead of adding it to a
31 B<invnum>: sets cust_pay_batch.invnum.
33 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
34 the billing address for the payment; defaults to the customer's billing
37 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
38 date, and name; defaults to those fields in cust_main.
43 my ($self, %options) = @_;
46 if (exists($options{amount})) {
47 $amount = $options{amount};
49 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
52 warn(sprintf("Customer balance %.2f - in transit amount %.2f is <= 0.\n",
54 $self->in_transit_payments
59 my $invnum = delete $options{invnum};
61 #false laziness with Billing_Realtime
62 my @cust_payby = qsearch({
63 'table' => 'cust_payby',
64 'hashref' => { 'custnum' => $self->custnum, },
65 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
66 'order_by' => 'ORDER BY weight ASC',
69 # batch can't try out every one like realtime, just use first one
70 my $cust_payby = $cust_payby[0] || $self; # somewhat dubious
72 my $payby = $options{payby} || $cust_payby->payby;
74 if ($options{'realtime'}) {
75 return $self->realtime_bop( FS::payby->payby2bop($payby),
81 my $oldAutoCommit = $FS::UID::AutoCommit;
82 local $FS::UID::AutoCommit = 0;
85 #this needs to handle mysql as well as Pg, like svc_acct.pm
86 #(make it into a common function if folks need to do batching with mysql)
87 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
88 or return "Cannot lock pay_batch: " . $dbh->errstr;
92 'payby' => FS::payby->payby2payment($payby),
94 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
96 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
98 unless ( $pay_batch ) {
99 $pay_batch = new FS::pay_batch \%pay_batch;
100 my $error = $pay_batch->insert;
102 $dbh->rollback if $oldAutoCommit;
103 die "error creating new batch: $error\n";
107 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
108 'batchnum' => $pay_batch->batchnum,
109 'custnum' => $self->custnum,
112 foreach (qw( address1 address2 city state zip country latitude longitude
113 payby payinfo paydate payname ))
115 $options{$_} = '' unless exists($options{$_});
118 my $loc = $self->bill_location;
120 my $cust_pay_batch = new FS::cust_pay_batch ( {
121 'batchnum' => $pay_batch->batchnum,
122 'invnum' => $invnum || 0, # is there a better value?
123 # this field should be
125 # cust_bill_pay_batch now
126 'custnum' => $self->custnum,
127 'last' => $self->getfield('last'),
128 'first' => $self->getfield('first'),
129 'address1' => $options{address1} || $loc->address1,
130 'address2' => $options{address2} || $loc->address2,
131 'city' => $options{city} || $loc->city,
132 'state' => $options{state} || $loc->state,
133 'zip' => $options{zip} || $loc->zip,
134 'country' => $options{country} || $loc->country,
135 'payby' => $options{payby} || $cust_payby->payby,
136 'payinfo' => $options{payinfo} || $cust_payby->payinfo,
137 'exp' => $options{paydate} || $cust_payby->paydate,
138 'payname' => $options{payname} || $cust_payby->payname,
139 'amount' => $amount, # consolidating
142 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
143 if $old_cust_pay_batch;
146 if ($old_cust_pay_batch) {
147 $error = $cust_pay_batch->replace($old_cust_pay_batch)
149 $error = $cust_pay_batch->insert;
153 $dbh->rollback if $oldAutoCommit;
157 my $unapplied = $self->total_unapplied_credits
158 + $self->total_unapplied_payments
159 + $self->in_transit_payments;
160 foreach my $cust_bill ($self->open_cust_bill) {
161 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
162 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
163 'invnum' => $cust_bill->invnum,
164 'paybatchnum' => $cust_pay_batch->paybatchnum,
165 'amount' => $cust_bill->owed,
168 if ($unapplied >= $cust_bill_pay_batch->amount){
169 $unapplied -= $cust_bill_pay_batch->amount;
172 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
173 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
175 $error = $cust_bill_pay_batch->insert;
177 $dbh->rollback if $oldAutoCommit;
182 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
186 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
188 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
190 Optionally, a list or hashref of additional arguments to the qsearch call can
197 my $opt = ref($_[0]) ? shift : { @_ };
199 #return $self->num_cust_statement unless wantarray || keys %$opt;
201 $opt->{'table'} = 'cust_pay_batch';
202 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
203 $opt->{'hashref'}{'custnum'} = $self->custnum;
204 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
206 map { $_ } #behavior of sort undefined in scalar context
207 sort { $a->paybatchnum <=> $b->paybatchnum }
211 =item in_transit_payments
213 Returns the total of requests for payments for this customer pending in
214 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
218 sub in_transit_payments {
220 my $in_transit_payments = 0;
221 foreach my $pay_batch ( qsearch('pay_batch', {
224 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
225 'batchnum' => $pay_batch->batchnum,
226 'custnum' => $self->custnum,
229 $in_transit_payments += $cust_pay_batch->amount;
232 sprintf( "%.2f", $in_transit_payments );