4 use vars qw( @ISA $DEBUG $me $conf @encrypted_fields
5 $unsuspendauto $ignore_noapply
8 use Business::CreditCard;
10 use FS::UID qw( getotaker );
11 use FS::Misc qw( send_email );
12 use FS::Record qw( dbh qsearch qsearchs );
14 use FS::cust_main_Mixin;
15 use FS::payinfo_transaction_Mixin;
17 use FS::cust_bill_pay;
18 use FS::cust_pay_refund;
20 use FS::cust_pay_void;
22 @ISA = qw( FS::payinfo_transaction_Mixin FS::cust_main_Mixin FS::Record );
26 $me = '[FS::cust_pay]';
30 #ask FS::UID to run this stuff for us later
31 FS::UID->install_callback( sub {
33 $unsuspendauto = $conf->exists('unsuspendauto');
36 @encrypted_fields = ('payinfo');
40 FS::cust_pay - Object methods for cust_pay objects
46 $record = new FS::cust_pay \%hash;
47 $record = new FS::cust_pay { 'column' => 'value' };
49 $error = $record->insert;
51 $error = $new_record->replace($old_record);
53 $error = $record->delete;
55 $error = $record->check;
59 An FS::cust_pay object represents a payment; the transfer of money from a
60 customer. FS::cust_pay inherits from FS::Record. The following fields are
65 =item paynum - primary key (assigned automatically for new payments)
67 =item custnum - customer (see L<FS::cust_main>)
69 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
70 L<Time::Local> and L<Date::Parse> for conversion functions.
72 =item paid - Amount of this payment
74 =item otaker - order taker (assigned automatically, see L<FS::UID>)
76 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
78 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
80 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
82 =item paybatch - text field for tracking card processing or other batch grouping
84 =item payunique - Optional unique identifer to prevent duplicate transactions.
86 =item closed - books closed flag, empty or `Y'
96 Creates a new payment. To add the payment to the databse, see L<"insert">.
100 sub table { 'cust_pay'; }
101 sub cust_linked { $_[0]->cust_main_custnum; }
102 sub cust_unlinked_msg {
104 "WARNING: can't find cust_main.custnum ". $self->custnum.
105 ' (cust_pay.paynum '. $self->paynum. ')';
110 Adds this payment to the database.
112 For backwards-compatibility and convenience, if the additional field invnum
113 is defined, an FS::cust_bill_pay record for the full amount of the payment
114 will be created. In this case, custnum is optional. An hash of optional
115 arguments may be passed. Currently "manual" is supported. If true, a
116 payment receipt is sent instead of a statement when 'payment_receipt_email'
117 configuration option is set.
122 my ($self, %options) = @_;
124 local $SIG{HUP} = 'IGNORE';
125 local $SIG{INT} = 'IGNORE';
126 local $SIG{QUIT} = 'IGNORE';
127 local $SIG{TERM} = 'IGNORE';
128 local $SIG{TSTP} = 'IGNORE';
129 local $SIG{PIPE} = 'IGNORE';
131 my $oldAutoCommit = $FS::UID::AutoCommit;
132 local $FS::UID::AutoCommit = 0;
136 if ( $self->invnum ) {
137 $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } )
139 $dbh->rollback if $oldAutoCommit;
140 return "Unknown cust_bill.invnum: ". $self->invnum;
142 $self->custnum($cust_bill->custnum );
146 my $error = $self->check;
147 return $error if $error;
149 my $cust_main = $self->cust_main;
150 my $old_balance = $cust_main->balance;
152 $error = $self->SUPER::insert;
154 $dbh->rollback if $oldAutoCommit;
155 return "error inserting $self: $error";
158 if ( $self->invnum ) {
159 my $cust_bill_pay = new FS::cust_bill_pay {
160 'invnum' => $self->invnum,
161 'paynum' => $self->paynum,
162 'amount' => $self->paid,
163 '_date' => $self->_date,
165 $error = $cust_bill_pay->insert;
167 if ( $ignore_noapply ) {
168 warn "warning: error inserting $cust_bill_pay: $error ".
169 "(ignore_noapply flag set; inserting cust_pay record anyway)\n";
171 $dbh->rollback if $oldAutoCommit;
172 return "error inserting $cust_bill_pay: $error";
177 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
179 #false laziness w/ cust_credit::insert
180 if ( $unsuspendauto && $old_balance && $cust_main->balance <= 0 ) {
181 my @errors = $cust_main->unsuspend;
183 # side-fx with nested transactions? upstack rolls back?
184 warn "WARNING:Errors unsuspending customer ". $cust_main->custnum. ": ".
190 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
192 #my $cust_main = $self->cust_main;
193 if ( $conf->exists('payment_receipt_email')
194 && grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list
197 $cust_bill ||= ($cust_main->cust_bill)[-1]; #rather inefficient though?
200 if ( ( exists($options{'manual'}) && $options{'manual'} )
201 || ! $conf->exists('invoice_html_statement')
205 my $receipt_template = new Text::Template (
207 SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ],
209 warn "can't create payment receipt template: $Text::Template::ERROR";
213 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
214 $cust_main->invoicing_list;
216 my $payby = $self->payby;
217 my $payinfo = $self->payinfo;
218 $payby =~ s/^BILL$/Check/ if $payinfo;
219 $payinfo = $self->paymask if $payby eq 'CARD' || $payby eq 'CHEK';
220 $payby =~ s/^CHEK$/Electronic check/;
223 'from' => $conf->config('invoice_from'), #??? well as good as any
224 'to' => \@invoicing_list,
225 'subject' => 'Payment receipt',
226 'body' => [ $receipt_template->fill_in( HASH => {
227 'date' => time2str("%a %B %o, %Y", $self->_date),
228 'name' => $cust_main->name,
229 'paynum' => $self->paynum,
230 'paid' => sprintf("%.2f", $self->paid),
231 'payby' => ucfirst(lc($payby)),
232 'payinfo' => $payinfo,
233 'balance' => $cust_main->balance,
239 my $queue = new FS::queue {
240 'paynum' => $self->paynum,
241 'job' => 'FS::cust_bill::queueable_email',
243 $error = $queue->insert(
244 'invnum' => $cust_bill->invnum,
245 'template' => 'statement',
251 warn "can't send payment receipt/statement: $error";
260 =item void [ REASON ]
262 Voids this payment: deletes the payment and all associated applications and
263 adds a record of the voided payment to the FS::cust_pay_void table.
270 local $SIG{HUP} = 'IGNORE';
271 local $SIG{INT} = 'IGNORE';
272 local $SIG{QUIT} = 'IGNORE';
273 local $SIG{TERM} = 'IGNORE';
274 local $SIG{TSTP} = 'IGNORE';
275 local $SIG{PIPE} = 'IGNORE';
277 my $oldAutoCommit = $FS::UID::AutoCommit;
278 local $FS::UID::AutoCommit = 0;
281 my $cust_pay_void = new FS::cust_pay_void ( {
282 map { $_ => $self->get($_) } $self->fields
284 $cust_pay_void->reason(shift) if scalar(@_);
285 my $error = $cust_pay_void->insert;
287 $dbh->rollback if $oldAutoCommit;
291 $error = $self->delete;
293 $dbh->rollback if $oldAutoCommit;
297 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
305 Unless the closed flag is set, deletes this payment and all associated
306 applications (see L<FS::cust_bill_pay> and L<FS::cust_pay_refund>). In most
307 cases, you want to use the void method instead to leave a record of the
312 # very similar to FS::cust_credit::delete
315 return "Can't delete closed payment" if $self->closed =~ /^Y/i;
317 local $SIG{HUP} = 'IGNORE';
318 local $SIG{INT} = 'IGNORE';
319 local $SIG{QUIT} = 'IGNORE';
320 local $SIG{TERM} = 'IGNORE';
321 local $SIG{TSTP} = 'IGNORE';
322 local $SIG{PIPE} = 'IGNORE';
324 my $oldAutoCommit = $FS::UID::AutoCommit;
325 local $FS::UID::AutoCommit = 0;
328 foreach my $app ( $self->cust_bill_pay, $self->cust_pay_refund ) {
329 my $error = $app->delete;
331 $dbh->rollback if $oldAutoCommit;
336 my $error = $self->SUPER::delete(@_);
338 $dbh->rollback if $oldAutoCommit;
342 if ( $conf->exists('deletepayments')
343 && $conf->config('deletepayments') ne '' ) {
345 my $cust_main = $self->cust_main;
347 my $error = send_email(
348 'from' => $conf->config('invoice_from'), #??? well as good as any
349 'to' => $conf->config('deletepayments'),
350 'subject' => 'FREESIDE NOTIFICATION: Payment deleted',
352 "This is an automatic message from your Freeside installation\n",
353 "informing you that the following payment has been deleted:\n",
355 'paynum: '. $self->paynum. "\n",
356 'custnum: '. $self->custnum.
357 " (". $cust_main->last. ", ". $cust_main->first. ")\n",
358 'paid: $'. sprintf("%.2f", $self->paid). "\n",
359 'date: '. time2str("%a %b %e %T %Y", $self->_date). "\n",
360 'payby: '. $self->payby. "\n",
361 'payinfo: '. $self->paymask. "\n",
362 'paybatch: '. $self->paybatch. "\n",
367 $dbh->rollback if $oldAutoCommit;
368 return "can't send payment deletion notification: $error";
373 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
379 =item replace OLD_RECORD
381 You can, but probably shouldn't modify payments...
386 #return "Can't modify payment!"
388 return "Can't modify closed payment" if $self->closed =~ /^Y/i;
389 $self->SUPER::replace(@_);
394 Checks all fields to make sure this is a valid payment. If there is an error,
395 returns the error, otherwise returns false. Called by the insert method.
402 $self->otaker(getotaker) unless ($self->otaker);
405 $self->ut_numbern('paynum')
406 || $self->ut_numbern('custnum')
407 || $self->ut_numbern('_date')
408 || $self->ut_money('paid')
409 || $self->ut_alpha('otaker')
410 || $self->ut_textn('paybatch')
411 || $self->ut_textn('payunique')
412 || $self->ut_enum('closed', [ '', 'Y' ])
413 || $self->payinfo_check()
415 return $error if $error;
417 return "paid must be > 0 " if $self->paid <= 0;
419 return "unknown cust_main.custnum: ". $self->custnum
421 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
423 $self->_date(time) unless $self->_date;
425 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it
426 # # UNIQUE index should catch this too, without race conditions, but this
427 # # should give a better error message the other 99.9% of the time...
428 # if ( length($self->payunique)
429 # && qsearchs('cust_pay', { 'payunique' => $self->payunique } ) ) {
430 # #well, it *could* be a better error message
431 # return "duplicate transaction".
432 # " - a payment with unique identifer ". $self->payunique.
439 =item batch_insert CUST_PAY_OBJECT, ...
441 Class method which inserts multiple payments. Takes a list of FS::cust_pay
442 objects. Returns a list, each element representing the status of inserting the
443 corresponding payment - empty. If there is an error inserting any payment, the
444 entire transaction is rolled back, i.e. all payments are inserted or none are.
448 my @errors = FS::cust_pay->batch_insert(@cust_pay);
449 my $num_errors = scalar(grep $_, @errors);
450 if ( $num_errors == 0 ) {
451 #success; all payments were inserted
453 #failure; no payments were inserted.
459 my $self = shift; #class method
461 local $SIG{HUP} = 'IGNORE';
462 local $SIG{INT} = 'IGNORE';
463 local $SIG{QUIT} = 'IGNORE';
464 local $SIG{TERM} = 'IGNORE';
465 local $SIG{TSTP} = 'IGNORE';
466 local $SIG{PIPE} = 'IGNORE';
468 my $oldAutoCommit = $FS::UID::AutoCommit;
469 local $FS::UID::AutoCommit = 0;
475 my $error = $_->insert( 'manual' => 1 );
479 $_->cust_main->apply_payments;
485 $dbh->rollback if $oldAutoCommit;
487 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
496 Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
503 sort { $a->_date <=> $b->_date
504 || $a->invnum <=> $b->invnum }
505 qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
509 =item cust_pay_refund
511 Returns all applications of refunds (see L<FS::cust_pay_refund>) to this
516 sub cust_pay_refund {
518 sort { $a->_date <=> $b->_date }
519 qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } )
526 Returns the amount of this payment that is still unapplied; which is
527 paid minus all payment applications (see L<FS::cust_bill_pay>) and refund
528 applications (see L<FS::cust_pay_refund>).
534 my $amount = $self->paid;
535 $amount -= $_->amount foreach ( $self->cust_bill_pay );
536 $amount -= $_->amount foreach ( $self->cust_pay_refund );
537 sprintf("%.2f", $amount );
542 Returns the amount of this payment that has not been refuned; which is
543 paid minus all refund applications (see L<FS::cust_pay_refund>).
549 my $amount = $self->paid;
550 $amount -= $_->amount foreach ( $self->cust_pay_refund );
551 sprintf("%.2f", $amount );
556 Returns the "paid" field.
573 Returns an SQL fragment to retreive the unapplied amount.
582 ( SELECT SUM(amount) FROM cust_bill_pay
583 WHERE cust_pay.paynum = cust_bill_pay.paynum )
587 ( SELECT SUM(amount) FROM cust_pay_refund
588 WHERE cust_pay.paynum = cust_pay_refund.paynum )
597 # Used by FS::Upgrade to migrate to a new database.
601 sub _upgrade_data { #class method
602 my ($class, %opts) = @_;
604 warn "$me upgrading $class\n" if $DEBUG;
606 #not the most efficient, but hey, it only has to run once
608 my $where = "WHERE ( otaker IS NULL OR otaker = '' OR otaker = 'ivan' ) ".
609 " AND 0 < ( SELECT COUNT(*) FROM cust_main ".
610 " WHERE cust_main.custnum = cust_pay.custnum ) ";
612 my $count_sql = "SELECT COUNT(*) FROM cust_pay $where";
614 my $sth = dbh->prepare($count_sql) or die dbh->errstr;
615 $sth->execute or die $sth->errstr;
616 my $total = $sth->fetchrow_arrayref->[0];
617 #warn "$total cust_pay records to update\n"
619 local($DEBUG) = 2 if $total > 1000; #could be a while, force progress info
624 my @cust_pay = qsearch( {
625 'table' => 'cust_pay',
627 'extra_sql' => $where,
628 'order_by' => 'ORDER BY paynum',
631 foreach my $cust_pay (@cust_pay) {
633 my $h_cust_pay = $cust_pay->h_search('insert');
635 next if $cust_pay->otaker eq $h_cust_pay->history_user;
636 $cust_pay->otaker($h_cust_pay->history_user);
638 $cust_pay->otaker('legacy');
641 delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge
642 my $error = $cust_pay->replace;
645 warn " *** WARNING: Error updating order taker for payment paynum ".
646 $cust_pay->paynun. ": $error\n";
650 $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it
653 if ( $DEBUG > 1 && $lastprog + 30 < time ) {
654 warn "$me $count/$total (". sprintf('%.2f',100*$count/$total). '%)'. "\n";
668 =item batch_import HASHREF
670 Inserts new payments.
677 my $fh = $param->{filehandle};
678 my $agentnum = $param->{agentnum};
679 my $format = $param->{'format'};
680 my $paybatch = $param->{'paybatch'};
682 # here is the agent virtualization
683 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
687 if ( $format eq 'simple' ) {
688 @fields = qw( custnum agent_custid paid payinfo );
690 } elsif ( $format eq 'extended' ) {
691 die "unimplemented\n";
695 die "unknown format $format";
698 eval "use Text::CSV_XS;";
701 my $csv = new Text::CSV_XS;
705 local $SIG{HUP} = 'IGNORE';
706 local $SIG{INT} = 'IGNORE';
707 local $SIG{QUIT} = 'IGNORE';
708 local $SIG{TERM} = 'IGNORE';
709 local $SIG{TSTP} = 'IGNORE';
710 local $SIG{PIPE} = 'IGNORE';
712 my $oldAutoCommit = $FS::UID::AutoCommit;
713 local $FS::UID::AutoCommit = 0;
717 while ( defined($line=<$fh>) ) {
719 $csv->parse($line) or do {
720 $dbh->rollback if $oldAutoCommit;
721 return "can't parse: ". $csv->error_input();
724 my @columns = $csv->fields();
728 paybatch => $paybatch,
732 foreach my $field ( @fields ) {
734 if ( $field eq 'agent_custid'
736 && $columns[0] =~ /\S+/ )
739 my $agent_custid = $columns[0];
740 my %hash = ( 'agent_custid' => $agent_custid,
741 'agentnum' => $agentnum,
744 if ( $cust_pay{'custnum'} !~ /^\s*$/ ) {
745 $dbh->rollback if $oldAutoCommit;
746 return "can't specify custnum with agent_custid $agent_custid";
749 $cust_main = qsearchs({
750 'table' => 'cust_main',
752 'extra_sql' => $extra_sql,
755 unless ( $cust_main ) {
756 $dbh->rollback if $oldAutoCommit;
757 return "can't find customer with agent_custid $agent_custid";
761 $columns[0] = $cust_main->custnum;
764 $cust_pay{$field} = shift @columns;
767 my $cust_pay = new FS::cust_pay( \%cust_pay );
768 my $error = $cust_pay->insert;
771 $dbh->rollback if $oldAutoCommit;
772 return "can't insert payment for $line: $error";
775 if ( $format eq 'simple' ) {
776 # include agentnum for less surprise?
777 $cust_main = qsearchs({
778 'table' => 'cust_main',
779 'hashref' => { 'custnum' => $cust_pay->custnum },
780 'extra_sql' => $extra_sql,
784 unless ( $cust_main ) {
785 $dbh->rollback if $oldAutoCommit;
786 return "can't find customer to which payments apply at line: $line";
789 $error = $cust_main->apply_payments_and_credits;
791 $dbh->rollback if $oldAutoCommit;
792 return "can't apply payments to customer for $line: $error";
800 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
802 return "Empty file!" unless $imported;
812 Delete and replace methods.
816 L<FS::cust_pay_pending>, L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>,
817 schema.html from the base documentation.