X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcust_pay.pm;h=d901c7811e4076822b0a198807f968fd9ac3737f;hp=b96e29fbde57dd74b772f1edb9d7e45e563ed8fc;hb=2295d728ff0bf2b692c97eb23fe76e38036ee631;hpb=d89908c40c18df348f580852f906853184fabd3c diff --git a/FS/FS/cust_pay.pm b/FS/FS/cust_pay.pm index b96e29fbd..d901c7811 100644 --- a/FS/FS/cust_pay.pm +++ b/FS/FS/cust_pay.pm @@ -2,22 +2,24 @@ package FS::cust_pay; use strict; use vars qw( @ISA $conf $unsuspendauto ); +use Date::Format; use Business::CreditCard; -use FS::UID qw( dbh ); -use FS::Record qw( dbh qsearch qsearchs dbh ); +use Text::Template; +use FS::Record qw( dbh qsearch qsearchs ); +use FS::Misc qw(send_email); use FS::cust_bill; use FS::cust_bill_pay; +use FS::cust_pay_refund; use FS::cust_main; +use FS::cust_pay_void; @ISA = qw( FS::Record ); #ask FS::UID to run this stuff for us later -$FS::UID::callback{'FS::cust_pay'} = sub { - +FS::UID->install_callback( sub { $conf = new FS::Conf; $unsuspendauto = $conf->exists('unsuspendauto'); - -}; +} ); =head1 NAME @@ -55,12 +57,15 @@ currently supported: =item _date - specified as a UNIX timestamp; see L. Also see L and L for conversion functions. -=item payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free) +=item payby - `CARD' (credit cards), `CHEK' (electronic check/ACH), +`LECB' (phone bill billing), `BILL' (billing), or `COMP' (free) =item payinfo - card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively =item paybatch - text field for tracking card processing +=item closed - books closed flag, empty or `Y' + =back =head1 METHODS @@ -108,7 +113,7 @@ sub insert { $self->custnum($cust_bill->custnum ); } - my $cust_main = qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); + my $cust_main = $self->cust_main; my $old_balance = $cust_main->balance; my $error = $self->check; @@ -134,7 +139,16 @@ sub insert { } } - $dbh->commit or die $dbh->errstr if $oldAutoCommit; + if ( $self->paybatch =~ /^webui-/ ) { + my @cust_pay = qsearch('cust_pay', { + 'custnum' => $self->custnum, + 'paybatch' => $self->paybatch, + } ); + if ( scalar(@cust_pay) > 1 ) { + $dbh->rollback if $oldAutoCommit; + return "a payment with webui token ". $self->paybatch. " already exists"; + } + } #false laziness w/ cust_credit::insert if ( $unsuspendauto && $old_balance && $cust_main->balance <= 0 ) { @@ -147,11 +161,60 @@ sub insert { } #eslaf + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + + #my $cust_main = $self->cust_main; + if ( $conf->exists('payment_receipt_email') + && grep { $_ ne 'POST' } $cust_main->invoicing_list + ) { + + my $receipt_template = new Text::Template ( + TYPE => 'ARRAY', + SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ], + ) or do { + warn "can't create payment receipt template: $Text::Template::ERROR"; + return ''; + }; + + my @invoicing_list = grep { $_ ne 'POST' } $cust_main->invoicing_list; + + my $payby = $self->payby; + my $payinfo = $self->payinfo; + $payby =~ s/^BILL$/Check/ if $payinfo; + $payinfo = $self->payinfo_masked if $payby eq 'CARD'; + + my $error = send_email( + 'from' => $conf->config('invoice_from'), #??? well as good as any + 'to' => \@invoicing_list, + 'subject' => 'Payment receipt', + 'body' => [ $receipt_template->fill_in( HASH => { + 'date' => time2str("%a %B %o, %Y", $self->_date), + 'name' => $cust_main->name, + 'paynum' => $self->paynum, + 'paid' => sprintf("%.2f", $self->paid), + 'payby' => ucfirst(lc($payby)), + 'payinfo' => $payinfo, + 'balance' => $cust_main->balance, + } ) ], + ); + if ( $error ) { + warn "can't send payment receipt: $error"; + } + + } + ''; } -sub upgrade_replace { #1.3.x->1.4.x +=item void [ REASON ] + +Voids this payment: deletes the payment and all associated applications and +adds a record of the voided payment to the FS::cust_pay_void table. + +=cut + +sub void { my $self = shift; local $SIG{HUP} = 'IGNORE'; @@ -165,30 +228,17 @@ sub upgrade_replace { #1.3.x->1.4.x local $FS::UID::AutoCommit = 0; my $dbh = dbh; - my $error = $self->check; - return $error if $error; - - my %new = $self->hash; - my $new = FS::cust_pay->new(\%new); - - if ( $self->invnum ) { - my $cust_bill_pay = new FS::cust_bill_pay { - 'invnum' => $self->invnum, - 'paynum' => $self->paynum, - 'amount' => $self->paid, - '_date' => $self->_date, - }; - $error = $cust_bill_pay->insert; - if ( $error ) { - $dbh->rollback if $oldAutoCommit; - return $error; - } - $new->custnum($cust_bill_pay->cust_bill->custnum); - } else { - die; + my $cust_pay_void = new FS::cust_pay_void ( { + map { $_ => $self->get($_) } $self->fields + } ); + $cust_pay_void->reason(shift) if scalar(@_); + my $error = $cust_pay_void->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; } - $error = $new->SUPER::replace($self); + $error = $self->delete; if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; @@ -198,29 +248,85 @@ sub upgrade_replace { #1.3.x->1.4.x ''; - } =item delete -Currently unimplemented (accounting reasons). +Deletes this payment and all associated applications (see L), +unless the closed flag is set. In most cases, you want to use the void +method instead to leave a record of the deleted payment. =cut sub delete { - return "Can't (yet?) delete cust_pay records!"; -} + my $self = shift; + return "Can't delete closed payment" if $self->closed =~ /^Y/i; -=item replace OLD_RECORD + local $SIG{HUP} = 'IGNORE'; + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; -Currently unimplemented (accounting reasons). + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; -=cut + foreach my $app ( $self->cust_bill_pay, $self->cust_pay_refund ) { + my $error = $app->delete; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + my $error = $self->SUPER::delete(@_); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + if ( $conf->config('deletepayments') ne '' ) { + + my $cust_main = $self->cust_main; + + my $error = send_email( + 'from' => $conf->config('invoice_from'), #??? well as good as any + 'to' => $conf->config('deletepayments'), + 'subject' => 'FREESIDE NOTIFICATION: Payment deleted', + 'body' => [ + "This is an automatic message from your Freeside installation\n", + "informing you that the following payment has been deleted:\n", + "\n", + 'paynum: '. $self->paynum. "\n", + 'custnum: '. $self->custnum. + " (". $cust_main->last. ", ". $cust_main->first. ")\n", + 'paid: $'. sprintf("%.2f", $self->paid). "\n", + 'date: '. time2str("%a %b %e %T %Y", $self->_date). "\n", + 'payby: '. $self->payby. "\n", + 'payinfo: '. $self->payinfo. "\n", + 'paybatch: '. $self->paybatch. "\n", + ], + ); + + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "can't send payment deletion notification: $error"; + } + + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + + ''; -sub replace { - return "Can't (yet?) modify cust_pay records!"; } +=item replace OLD_RECORD + +You probably shouldn't modify payments... + =item check Checks all fields to make sure this is a valid payment. If there is an error, @@ -237,10 +343,11 @@ sub check { || $self->ut_money('paid') || $self->ut_numbern('_date') || $self->ut_textn('paybatch') + || $self->ut_enum('closed', [ '', 'Y' ]) ; return $error if $error; - return "paid must be > 0 " if $self->paid == 0; + return "paid must be > 0 " if $self->paid <= 0; return "unknown cust_main.custnum: ". $self->custnum unless $self->invnum @@ -248,9 +355,10 @@ sub check { $self->_date(time) unless $self->_date; - $self->payby =~ /^(CARD|BILL|COMP)$/ or return "Illegal payby"; + $self->payby =~ /^(CARD|CHEK|LECB|BILL|COMP)$/ or return "Illegal payby"; $self->payby($1); + #false laziness with cust_refund::check if ( $self->payby eq 'CARD' ) { my $payinfo = $self->payinfo; $payinfo =~ s/\D//g; @@ -270,8 +378,7 @@ sub check { return $error if $error; } - ''; #no error - + $self->SUPER::check; } =item cust_bill_pay @@ -283,15 +390,32 @@ payment. sub cust_bill_pay { my $self = shift; - sort { $a->_date <=> $b->_date } + sort { $a->_date <=> $b->_date + || $a->invnum <=> $b->invnum } qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } ) ; } +=item cust_pay_refund + +Returns all applications of refunds (see L) to this +payment. + +=cut + +sub cust_pay_refund { + my $self = shift; + sort { $a->_date <=> $b->_date } + qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } ) + ; +} + + =item unapplied Returns the amount of this payment that is still unapplied; which is -paid minus all payment applications (see L). +paid minus all payment applications (see L) and refund +applications (see L). =cut @@ -299,18 +423,55 @@ sub unapplied { my $self = shift; my $amount = $self->paid; $amount -= $_->amount foreach ( $self->cust_bill_pay ); + $amount -= $_->amount foreach ( $self->cust_pay_refund ); + sprintf("%.2f", $amount ); +} + +=item unrefunded + +Returns the amount of this payment that has not been refuned; which is +paid minus all refund applications (see L). + +=cut + +sub unrefunded { + my $self = shift; + my $amount = $self->paid; + $amount -= $_->amount foreach ( $self->cust_pay_refund ); sprintf("%.2f", $amount ); } -=back -=head1 VERSION +=item cust_main -$Id: cust_pay.pm,v 1.11 2002-01-22 15:57:33 ivan Exp $ +Returns the parent customer object (see L). + +=cut + +sub cust_main { + my $self = shift; + qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); +} + +=item payinfo_masked + +Returns a "masked" payinfo field with all but the last four characters replaced +by 'x'es. Useful for displaying credit cards. + +=cut + +sub payinfo_masked { + my $self = shift; + my $payinfo = $self->payinfo; + 'x'x(length($payinfo)-4). substr($payinfo,(length($payinfo)-4)); +} + +=back =head1 BUGS -Delete and replace methods. +Delete and replace methods. payinfo_masked false laziness with cust_main.pm +and cust_refund.pm =head1 SEE ALSO