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', $self->cust_main->agentnum),
224 #invoice_from??? well as good as any
225 'to' => \@invoicing_list,
226 'subject' => 'Payment receipt',
227 'body' => [ $receipt_template->fill_in( HASH => {
228 'date' => time2str("%a %B %o, %Y", $self->_date),
229 'name' => $cust_main->name,
230 'paynum' => $self->paynum,
231 'paid' => sprintf("%.2f", $self->paid),
232 'payby' => ucfirst(lc($payby)),
233 'payinfo' => $payinfo,
234 'balance' => $cust_main->balance,
235 'company_name' => $conf->config('company_name'),
241 my $queue = new FS::queue {
242 'paynum' => $self->paynum,
243 'job' => 'FS::cust_bill::queueable_email',
245 $error = $queue->insert(
246 'invnum' => $cust_bill->invnum,
247 'template' => 'statement',
253 warn "can't send payment receipt/statement: $error";
262 =item void [ REASON ]
264 Voids this payment: deletes the payment and all associated applications and
265 adds a record of the voided payment to the FS::cust_pay_void table.
272 local $SIG{HUP} = 'IGNORE';
273 local $SIG{INT} = 'IGNORE';
274 local $SIG{QUIT} = 'IGNORE';
275 local $SIG{TERM} = 'IGNORE';
276 local $SIG{TSTP} = 'IGNORE';
277 local $SIG{PIPE} = 'IGNORE';
279 my $oldAutoCommit = $FS::UID::AutoCommit;
280 local $FS::UID::AutoCommit = 0;
283 my $cust_pay_void = new FS::cust_pay_void ( {
284 map { $_ => $self->get($_) } $self->fields
286 $cust_pay_void->reason(shift) if scalar(@_);
287 my $error = $cust_pay_void->insert;
289 $dbh->rollback if $oldAutoCommit;
293 $error = $self->delete;
295 $dbh->rollback if $oldAutoCommit;
299 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
307 Unless the closed flag is set, deletes this payment and all associated
308 applications (see L<FS::cust_bill_pay> and L<FS::cust_pay_refund>). In most
309 cases, you want to use the void method instead to leave a record of the
314 # very similar to FS::cust_credit::delete
317 return "Can't delete closed payment" if $self->closed =~ /^Y/i;
319 local $SIG{HUP} = 'IGNORE';
320 local $SIG{INT} = 'IGNORE';
321 local $SIG{QUIT} = 'IGNORE';
322 local $SIG{TERM} = 'IGNORE';
323 local $SIG{TSTP} = 'IGNORE';
324 local $SIG{PIPE} = 'IGNORE';
326 my $oldAutoCommit = $FS::UID::AutoCommit;
327 local $FS::UID::AutoCommit = 0;
330 foreach my $app ( $self->cust_bill_pay, $self->cust_pay_refund ) {
331 my $error = $app->delete;
333 $dbh->rollback if $oldAutoCommit;
338 my $error = $self->SUPER::delete(@_);
340 $dbh->rollback if $oldAutoCommit;
344 if ( $conf->config('deletepayments') ne '' ) {
346 my $cust_main = $self->cust_main;
348 my $error = send_email(
349 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
350 #invoice_from??? well as good as any
351 'to' => $conf->config('deletepayments'),
352 'subject' => 'FREESIDE NOTIFICATION: Payment deleted',
354 "This is an automatic message from your Freeside installation\n",
355 "informing you that the following payment has been deleted:\n",
357 'paynum: '. $self->paynum. "\n",
358 'custnum: '. $self->custnum.
359 " (". $cust_main->last. ", ". $cust_main->first. ")\n",
360 'paid: $'. sprintf("%.2f", $self->paid). "\n",
361 'date: '. time2str("%a %b %e %T %Y", $self->_date). "\n",
362 'payby: '. $self->payby. "\n",
363 'payinfo: '. $self->paymask. "\n",
364 'paybatch: '. $self->paybatch. "\n",
369 $dbh->rollback if $oldAutoCommit;
370 return "can't send payment deletion notification: $error";
375 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
381 =item replace OLD_RECORD
383 You can, but probably shouldn't modify payments...
388 #return "Can't modify payment!"
390 return "Can't modify closed payment" if $self->closed =~ /^Y/i;
391 $self->SUPER::replace(@_);
396 Checks all fields to make sure this is a valid payment. If there is an error,
397 returns the error, otherwise returns false. Called by the insert method.
404 $self->otaker(getotaker) unless ($self->otaker);
407 $self->ut_numbern('paynum')
408 || $self->ut_numbern('custnum')
409 || $self->ut_numbern('_date')
410 || $self->ut_money('paid')
411 || $self->ut_alpha('otaker')
412 || $self->ut_textn('paybatch')
413 || $self->ut_textn('payunique')
414 || $self->ut_enum('closed', [ '', 'Y' ])
415 || $self->payinfo_check()
417 return $error if $error;
419 return "paid must be > 0 " if $self->paid <= 0;
421 return "unknown cust_main.custnum: ". $self->custnum
423 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
425 $self->_date(time) unless $self->_date;
427 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it
428 # # UNIQUE index should catch this too, without race conditions, but this
429 # # should give a better error message the other 99.9% of the time...
430 # if ( length($self->payunique)
431 # && qsearchs('cust_pay', { 'payunique' => $self->payunique } ) ) {
432 # #well, it *could* be a better error message
433 # return "duplicate transaction".
434 # " - a payment with unique identifer ". $self->payunique.
441 =item batch_insert CUST_PAY_OBJECT, ...
443 Class method which inserts multiple payments. Takes a list of FS::cust_pay
444 objects. Returns a list, each element representing the status of inserting the
445 corresponding payment - empty. If there is an error inserting any payment, the
446 entire transaction is rolled back, i.e. all payments are inserted or none are.
450 my @errors = FS::cust_pay->batch_insert(@cust_pay);
451 my $num_errors = scalar(grep $_, @errors);
452 if ( $num_errors == 0 ) {
453 #success; all payments were inserted
455 #failure; no payments were inserted.
461 my $self = shift; #class method
463 local $SIG{HUP} = 'IGNORE';
464 local $SIG{INT} = 'IGNORE';
465 local $SIG{QUIT} = 'IGNORE';
466 local $SIG{TERM} = 'IGNORE';
467 local $SIG{TSTP} = 'IGNORE';
468 local $SIG{PIPE} = 'IGNORE';
470 my $oldAutoCommit = $FS::UID::AutoCommit;
471 local $FS::UID::AutoCommit = 0;
477 my $error = $_->insert( 'manual' => 1 );
481 $_->cust_main->apply_payments;
487 $dbh->rollback if $oldAutoCommit;
489 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
498 Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
505 sort { $a->_date <=> $b->_date
506 || $a->invnum <=> $b->invnum }
507 qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
511 =item cust_pay_refund
513 Returns all applications of refunds (see L<FS::cust_pay_refund>) to this
518 sub cust_pay_refund {
520 sort { $a->_date <=> $b->_date }
521 qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } )
528 Returns the amount of this payment that is still unapplied; which is
529 paid minus all payment applications (see L<FS::cust_bill_pay>) and refund
530 applications (see L<FS::cust_pay_refund>).
536 my $amount = $self->paid;
537 $amount -= $_->amount foreach ( $self->cust_bill_pay );
538 $amount -= $_->amount foreach ( $self->cust_pay_refund );
539 sprintf("%.2f", $amount );
544 Returns the amount of this payment that has not been refuned; which is
545 paid minus all refund applications (see L<FS::cust_pay_refund>).
551 my $amount = $self->paid;
552 $amount -= $_->amount foreach ( $self->cust_pay_refund );
553 sprintf("%.2f", $amount );
558 Returns the "paid" field.
575 Returns an SQL fragment to retreive the unapplied amount.
584 ( SELECT SUM(amount) FROM cust_bill_pay
585 WHERE cust_pay.paynum = cust_bill_pay.paynum )
589 ( SELECT SUM(amount) FROM cust_pay_refund
590 WHERE cust_pay.paynum = cust_pay_refund.paynum )
599 # Used by FS::Upgrade to migrate to a new database.
603 sub _upgrade_data { #class method
604 my ($class, %opts) = @_;
606 warn "$me upgrading $class\n" if $DEBUG;
608 #not the most efficient, but hey, it only has to run once
610 my $where = "WHERE ( otaker IS NULL OR otaker = '' OR otaker = 'ivan' ) ".
611 " AND 0 < ( SELECT COUNT(*) FROM cust_main ".
612 " WHERE cust_main.custnum = cust_pay.custnum ) ";
614 my $count_sql = "SELECT COUNT(*) FROM cust_pay $where";
616 my $sth = dbh->prepare($count_sql) or die dbh->errstr;
617 $sth->execute or die $sth->errstr;
618 my $total = $sth->fetchrow_arrayref->[0];
619 #warn "$total cust_pay records to update\n"
621 local($DEBUG) = 2 if $total > 1000; #could be a while, force progress info
626 my @cust_pay = qsearch( {
627 'table' => 'cust_pay',
629 'extra_sql' => $where,
630 'order_by' => 'ORDER BY paynum',
633 foreach my $cust_pay (@cust_pay) {
635 my $h_cust_pay = $cust_pay->h_search('insert');
637 next if $cust_pay->otaker eq $h_cust_pay->history_user;
638 $cust_pay->otaker($h_cust_pay->history_user);
640 $cust_pay->otaker('legacy');
643 delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge
644 my $error = $cust_pay->replace;
647 warn " *** WARNING: Error updating order taker for payment paynum ".
648 $cust_pay->paynun. ": $error\n";
652 $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it
655 if ( $DEBUG > 1 && $lastprog + 30 < time ) {
656 warn "$me $count/$total (". sprintf('%.2f',100*$count/$total). '%)'. "\n";
670 =item batch_import HASHREF
672 Inserts new payments.
679 my $fh = $param->{filehandle};
680 my $agentnum = $param->{agentnum};
681 my $format = $param->{'format'};
682 my $paybatch = $param->{'paybatch'};
684 # here is the agent virtualization
685 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
689 if ( $format eq 'simple' ) {
690 @fields = qw( custnum agent_custid paid payinfo );
692 } elsif ( $format eq 'extended' ) {
693 die "unimplemented\n";
697 die "unknown format $format";
700 eval "use Text::CSV_XS;";
703 my $csv = new Text::CSV_XS;
707 local $SIG{HUP} = 'IGNORE';
708 local $SIG{INT} = 'IGNORE';
709 local $SIG{QUIT} = 'IGNORE';
710 local $SIG{TERM} = 'IGNORE';
711 local $SIG{TSTP} = 'IGNORE';
712 local $SIG{PIPE} = 'IGNORE';
714 my $oldAutoCommit = $FS::UID::AutoCommit;
715 local $FS::UID::AutoCommit = 0;
719 while ( defined($line=<$fh>) ) {
721 $csv->parse($line) or do {
722 $dbh->rollback if $oldAutoCommit;
723 return "can't parse: ". $csv->error_input();
726 my @columns = $csv->fields();
730 paybatch => $paybatch,
734 foreach my $field ( @fields ) {
736 if ( $field eq 'agent_custid'
738 && $columns[0] =~ /\S+/ )
741 my $agent_custid = $columns[0];
742 my %hash = ( 'agent_custid' => $agent_custid,
743 'agentnum' => $agentnum,
746 if ( $cust_pay{'custnum'} !~ /^\s*$/ ) {
747 $dbh->rollback if $oldAutoCommit;
748 return "can't specify custnum with agent_custid $agent_custid";
751 $cust_main = qsearchs({
752 'table' => 'cust_main',
754 'extra_sql' => $extra_sql,
757 unless ( $cust_main ) {
758 $dbh->rollback if $oldAutoCommit;
759 return "can't find customer with agent_custid $agent_custid";
763 $columns[0] = $cust_main->custnum;
766 $cust_pay{$field} = shift @columns;
769 my $cust_pay = new FS::cust_pay( \%cust_pay );
770 my $error = $cust_pay->insert;
773 $dbh->rollback if $oldAutoCommit;
774 return "can't insert payment for $line: $error";
777 if ( $format eq 'simple' ) {
778 # include agentnum for less surprise?
779 $cust_main = qsearchs({
780 'table' => 'cust_main',
781 'hashref' => { 'custnum' => $cust_pay->custnum },
782 'extra_sql' => $extra_sql,
786 unless ( $cust_main ) {
787 $dbh->rollback if $oldAutoCommit;
788 return "can't find customer to which payments apply at line: $line";
791 $error = $cust_main->apply_payments_and_credits;
793 $dbh->rollback if $oldAutoCommit;
794 return "can't apply payments to customer for $line: $error";
802 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
804 return "Empty file!" unless $imported;
814 Delete and replace methods.
818 L<FS::cust_pay_pending>, L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>,
819 schema.html from the base documentation.