X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fcust_pay.pm;h=8f790a61a6db18e190ff6ef6d0ca64221dcfe590;hb=b03df92e48df653460cb8b6034a06dd1de6f4095;hp=b1c35d76fc5223ebd92a6acaca0150eaa2393150;hpb=cdd5aa1d86cd5b266e02bed58570c97c2d7698ba;p=freeside.git diff --git a/FS/FS/cust_pay.pm b/FS/FS/cust_pay.pm index b1c35d76f..8f790a61a 100644 --- a/FS/FS/cust_pay.pm +++ b/FS/FS/cust_pay.pm @@ -1,14 +1,24 @@ package FS::cust_pay; use strict; -use vars qw( @ISA ); +use vars qw( @ISA $conf $unsuspendauto ); use Business::CreditCard; -use FS::Record qw( dbh ); +use FS::UID qw( dbh ); +use FS::Record qw( dbh qsearch qsearchs dbh ); use FS::cust_bill; use FS::cust_bill_pay; +use FS::cust_main; @ISA = qw( FS::Record ); +#ask FS::UID to run this stuff for us later +$FS::UID::callback{'FS::cust_pay'} = sub { + + $conf = new FS::Conf; + $unsuspendauto = $conf->exists('unsuspendauto'); + +}; + =head1 NAME FS::cust_pay - Object methods for cust_pay objects @@ -38,6 +48,8 @@ currently supported: =item paynum - primary key (assigned automatically for new payments) +=item custnum - customer (see L) + =item paid - Amount of this payment =item _date - specified as a UNIX timestamp; see L. Also see @@ -45,7 +57,7 @@ L and L for conversion functions. =item payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free) -=item payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username) +=item payinfo - card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively =item paybatch - text field for tracking card processing @@ -69,7 +81,7 @@ Adds this payment to the database. For backwards-compatibility and convenience, if the additional field invnum is defined, an FS::cust_bill_pay record for the full amount of the payment -will be created. +will be created. In this case, custnum is optional. =cut @@ -87,13 +99,25 @@ sub insert { local $FS::UID::AutoCommit = 0; my $dbh = dbh; + if ( $self->invnum ) { + my $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } ) + or do { + $dbh->rollback if $oldAutoCommit; + return "Unknown cust_bill.invnum: ". $self->invnum; + }; + $self->custnum($cust_bill->custnum ); + } + + my $cust_main = qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); + my $old_balance = $cust_main->balance; + my $error = $self->check; return $error if $error; $error = $self->SUPER::insert; if ( $error ) { $dbh->rollback if $oldAutoCommit; - return $error; + return "error inserting $self: $error"; } if ( $self->invnum ) { @@ -106,14 +130,75 @@ sub insert { $error = $cust_bill_pay->insert; if ( $error ) { $dbh->rollback if $oldAutoCommit; + return "error inserting $cust_bill_pay: $error"; + } + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + + #false laziness w/ cust_credit::insert + if ( $unsuspendauto && $old_balance && $cust_main->balance <= 0 ) { + my @errors = $cust_main->unsuspend; + #return + # side-fx with nested transactions? upstack rolls back? + warn "WARNING:Errors unsuspending customer ". $cust_main->custnum. ": ". + join(' / ', @errors) + if @errors; + } + #eslaf + + ''; + +} + +sub upgrade_replace { #1.3.x->1.4.x + my $self = shift; + + local $SIG{HUP} = 'IGNORE'; + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; + + my $oldAutoCommit = $FS::UID::AutoCommit; + 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; + } + + $error = $new->SUPER::replace($self); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; } $dbh->commit or die $dbh->errstr if $oldAutoCommit; ''; + } =item delete @@ -148,17 +233,25 @@ sub check { my $error = $self->ut_numbern('paynum') + || $self->ut_numbern('custnum') || $self->ut_money('paid') || $self->ut_numbern('_date') || $self->ut_textn('paybatch') ; return $error if $error; + return "paid must be > 0 " if $self->paid <= 0; + + return "unknown cust_main.custnum: ". $self->custnum + unless $self->invnum + || qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); + $self->_date(time) unless $self->_date; $self->payby =~ /^(CARD|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; @@ -182,11 +275,39 @@ sub check { } +=item cust_bill_pay + +Returns all applications to invoices (see L) for this +payment. + +=cut + +sub cust_bill_pay { + my $self = shift; + sort { $a->_date <=> $b->_date } + qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } ) + ; +} + +=item unapplied + +Returns the amount of this payment that is still unapplied; which is +paid minus all payment applications (see L). + +=cut + +sub unapplied { + my $self = shift; + my $amount = $self->paid; + $amount -= $_->amount foreach ( $self->cust_bill_pay ); + sprintf("%.2f", $amount ); +} + =back =head1 VERSION -$Id: cust_pay.pm,v 1.4 2001-09-01 20:11:07 ivan Exp $ +$Id: cust_pay.pm,v 1.13 2002-01-24 16:58:47 ivan Exp $ =head1 BUGS