X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcust_refund.pm;h=b9f48db5c03b68c853202d236d8d13621b56ec5a;hp=65254aef4bf8b0068419b87c1c37c4cfd071c772;hb=157e8bdba110b7aac022bd2c2f7b377d3c5b2f85;hpb=6cd87c0d3b5280446301c647fa5f1ec5a593fa3f diff --git a/FS/FS/cust_refund.pm b/FS/FS/cust_refund.pm index 65254aef4..b9f48db5c 100644 --- a/FS/FS/cust_refund.pm +++ b/FS/FS/cust_refund.pm @@ -3,9 +3,12 @@ package FS::cust_refund; use strict; use vars qw( @ISA ); use Business::CreditCard; -use FS::Record qw( qsearchs ); +use FS::Record qw( qsearch qsearchs dbh ); use FS::UID qw(getotaker); use FS::cust_credit; +use FS::cust_credit_refund; +use FS::cust_pay_refund; +use FS::cust_main; @ISA = qw( FS::Record ); @@ -30,26 +33,32 @@ FS::cust_refund - Object method for cust_refund objects =head1 DESCRIPTION -An FS::cust_refund represents a refund. FS::cust_refund inherits from -FS::Record. The following fields are currently supported: +An FS::cust_refund represents a refund: the transfer of money to a customer; +equivalent to a negative payment (see L). FS::cust_refund +inherits from FS::Record. The following fields are currently supported: =over 4 =item refundnum - primary key (assigned automatically for new refunds) -=item crednum - Credit (see L) +=item custnum - customer (see L) =item refund - Amount of the refund =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, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username) +=item paybatch - text field for tracking card processing + =item otaker - order taker (assigned automatically, see L) +=item closed - books closed flag, empty or `Y' + =back =head1 METHODS @@ -66,26 +75,19 @@ sub table { 'cust_refund'; } =item insert -Adds this refund to the database, and updates the credit (see -L). +Adds this refund to the database. + +For backwards-compatibility and convenience, if the additional field crednum is +defined, an FS::cust_credit_refund record for the full amount of the refund +will be created. Or (this time for convenience and consistancy), if the +additional field paynum is defined, an FS::cust_pay_refund record for the full +amount of the refund will be created. In both cases, custnum is optional. =cut sub insert { my $self = shift; - my $error; - - $error=$self->check; - return $error if $error; - - my $old_cust_credit = - qsearchs( 'cust_credit', { 'crednum' => $self->crednum } ); - return "Unknown crednum" unless $old_cust_credit; - my %hash = $old_cust_credit->hash; - $hash{credited} = sprintf("%.2f", $hash{credited} - $self->refund ); - my($new_cust_credit) = new FS::cust_credit ( \%hash ); - local $SIG{HUP} = 'IGNORE'; local $SIG{INT} = 'IGNORE'; local $SIG{QUIT} = 'IGNORE'; @@ -93,10 +95,67 @@ sub insert { local $SIG{TSTP} = 'IGNORE'; local $SIG{PIPE} = 'IGNORE'; - $error = $new_cust_credit->replace($old_cust_credit); - return "Error modifying cust_credit: $error" if $error; + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + if ( $self->crednum ) { + my $cust_credit = qsearchs('cust_credit', { 'crednum' => $self->crednum } ) + or do { + $dbh->rollback if $oldAutoCommit; + return "Unknown cust_credit.crednum: ". $self->crednum; + }; + $self->custnum($cust_credit->custnum); + } elsif ( $self->paynum ) { + my $cust_pay = qsearchs('cust_pay', { 'paynum' => $self->paynum } ) + or do { + $dbh->rollback if $oldAutoCommit; + return "Unknown cust_pay.paynum: ". $self->paynum; + }; + $self->custnum($cust_pay->custnum); + } + + my $error = $self->check; + return $error if $error; + + $error = $self->SUPER::insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + if ( $self->crednum ) { + my $cust_credit_refund = new FS::cust_credit_refund { + 'crednum' => $self->crednum, + 'refundnum' => $self->refundnum, + 'amount' => $self->refund, + '_date' => $self->_date, + }; + $error = $cust_credit_refund->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + #$self->custnum($cust_credit_refund->cust_credit->custnum); + } elsif ( $self->paynum ) { + my $cust_pay_refund = new FS::cust_pay_refund { + 'paynum' => $self->paynum, + 'refundnum' => $self->refundnum, + 'amount' => $self->refund, + '_date' => $self->_date, + }; + $error = $cust_pay_refund->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + + ''; - $self->SUPER::insert; } =item delete @@ -106,7 +165,9 @@ Currently unimplemented (accounting reasons). =cut sub delete { - return "Can't (yet?) delete cust_refund records!"; + my $self = shift; + return "Can't delete closed refund" if $self->closed =~ /^Y/i; + $self->SUPER::delete(@_); } =item replace OLD_RECORD @@ -129,24 +190,32 @@ returns the error, otherwise returns false. Called by the insert method. sub check { my $self = shift; - my $error; - - $error = - $self->ut_number('refundnum') - || $self->ut_number('crednum') - || $self->ut_money('amount') + my $error = + $self->ut_numbern('refundnum') + || $self->ut_numbern('custnum') + || $self->ut_money('refund') || $self->ut_numbern('_date') + || $self->ut_textn('paybatch') + || $self->ut_enum('closed', [ '', 'Y' ]) ; return $error if $error; + return "refund must be > 0 " if $self->refund <= 0; + $self->_date(time) unless $self->_date; - $self->payby =~ /^(CARD|BILL|COMP)$/ or return "Illegal payby"; + return "unknown cust_main.custnum: ". $self->custnum + unless $self->crednum + || qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); + + $self->payby =~ /^(CARD|CHEK|LECB|BILL|COMP)$/ or return "Illegal payby"; $self->payby($1); + #false laziness with cust_pay::check if ( $self->payby eq 'CARD' ) { my $payinfo = $self->payinfo; - $self->payinfo($payinfo =~ s/\D//g); + $payinfo =~ s/\D//g; + $self->payinfo($payinfo); if ( $self->payinfo ) { $self->payinfo =~ /^(\d{13,16})$/ or return "Illegal (mistyped?) credit card number (payinfo)"; @@ -164,18 +233,76 @@ sub check { $self->otaker(getotaker); - ''; #no error + $self->SUPER::check; } -=back +=item cust_credit_refund -=head1 VERSION +Returns all applications to credits (see L) for this +refund. + +=cut -$Id: cust_refund.pm,v 1.1 1999-08-04 09:03:53 ivan Exp $ +sub cust_credit_refund { + my $self = shift; + sort { $a->_date <=> $b->_date } + qsearch( 'cust_credit_refund', { 'refundnum' => $self->refundnum } ) + ; +} + +=item cust_pay_refund + +Returns all applications to payments (see L) for this +refund. + +=cut + +sub cust_pay_refund { + my $self = shift; + sort { $a->_date <=> $b->_date } + qsearch( 'cust_pay_refund', { 'refundnum' => $self->refundnum } ) + ; +} + +=item unapplied + +Returns the amount of this refund that is still unapplied; which is +amount minus all credit applications (see L) and +payment applications (see L). + +=cut + +sub unapplied { + my $self = shift; + my $amount = $self->refund; + $amount -= $_->amount foreach ( $self->cust_credit_refund ); + $amount -= $_->amount foreach ( $self->cust_pay_refund ); + sprintf("%.2f", $amount ); +} + + + +=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_pay.pm =head1 SEE ALSO