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);
51 return '' unless $amount > 0;
53 my $invnum = delete $options{invnum};
54 my $payby = $options{payby} || $self->payby; #still dubious
56 if ($options{'realtime'}) {
57 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
63 my $oldAutoCommit = $FS::UID::AutoCommit;
64 local $FS::UID::AutoCommit = 0;
67 #this needs to handle mysql as well as Pg, like svc_acct.pm
68 #(make it into a common function if folks need to do batching with mysql)
69 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
70 or return "Cannot lock pay_batch: " . $dbh->errstr;
74 'payby' => FS::payby->payby2payment($payby),
76 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
78 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
80 unless ( $pay_batch ) {
81 $pay_batch = new FS::pay_batch \%pay_batch;
82 my $error = $pay_batch->insert;
84 $dbh->rollback if $oldAutoCommit;
85 die "error creating new batch: $error\n";
89 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
90 'batchnum' => $pay_batch->batchnum,
91 'custnum' => $self->custnum,
94 foreach (qw( address1 address2 city state zip country latitude longitude
95 payby payinfo paydate payname ))
97 $options{$_} = '' unless exists($options{$_});
100 my $loc = $self->bill_location;
102 my $cust_pay_batch = new FS::cust_pay_batch ( {
103 'batchnum' => $pay_batch->batchnum,
104 'invnum' => $invnum || 0, # is there a better value?
105 # this field should be
107 # cust_bill_pay_batch now
108 'custnum' => $self->custnum,
109 'last' => $self->getfield('last'),
110 'first' => $self->getfield('first'),
111 'address1' => $options{address1} || $loc->address1,
112 'address2' => $options{address2} || $loc->address2,
113 'city' => $options{city} || $loc->city,
114 'state' => $options{state} || $loc->state,
115 'zip' => $options{zip} || $loc->zip,
116 'country' => $options{country} || $loc->country,
117 'payby' => $options{payby} || $self->payby,
118 'payinfo' => $options{payinfo} || $self->payinfo,
119 'exp' => $options{paydate} || $self->paydate,
120 'payname' => $options{payname} || $self->payname,
121 'amount' => $amount, # consolidating
124 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
125 if $old_cust_pay_batch;
128 if ($old_cust_pay_batch) {
129 $error = $cust_pay_batch->replace($old_cust_pay_batch)
131 $error = $cust_pay_batch->insert;
135 $dbh->rollback if $oldAutoCommit;
139 my $unapplied = $self->total_unapplied_credits
140 + $self->total_unapplied_payments
141 + $self->in_transit_payments;
142 foreach my $cust_bill ($self->open_cust_bill) {
143 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
144 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
145 'invnum' => $cust_bill->invnum,
146 'paybatchnum' => $cust_pay_batch->paybatchnum,
147 'amount' => $cust_bill->owed,
150 if ($unapplied >= $cust_bill_pay_batch->amount){
151 $unapplied -= $cust_bill_pay_batch->amount;
154 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
155 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
157 $error = $cust_bill_pay_batch->insert;
159 $dbh->rollback if $oldAutoCommit;
164 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
168 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
170 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
172 Optionally, a list or hashref of additional arguments to the qsearch call can
179 my $opt = ref($_[0]) ? shift : { @_ };
181 #return $self->num_cust_statement unless wantarray || keys %$opt;
183 $opt->{'table'} = 'cust_pay_batch';
184 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
185 $opt->{'hashref'}{'custnum'} = $self->custnum;
186 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
188 map { $_ } #behavior of sort undefined in scalar context
189 sort { $a->paybatchnum <=> $b->paybatchnum }
193 =item in_transit_payments
195 Returns the total of requests for payments for this customer pending in
196 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
200 sub in_transit_payments {
202 my $in_transit_payments = 0;
203 foreach my $pay_batch ( qsearch('pay_batch', {
206 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
207 'batchnum' => $pay_batch->batchnum,
208 'custnum' => $self->custnum,
210 $in_transit_payments += $cust_pay_batch->amount;
213 sprintf( "%.2f", $in_transit_payments );