X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcust_credit.pm;h=1f792daa62a20d31d25a149893ab314f938ab1dc;hp=e868537994f715acc212b7c6e28771ee7f129d8a;hb=8c1f9804d9a02c0c054eededeb500c72a640249a;hpb=13477c4eb15c3150938a2af8e90f01ad2d83b335 diff --git a/FS/FS/cust_credit.pm b/FS/FS/cust_credit.pm index e86853799..1f792daa6 100644 --- a/FS/FS/cust_credit.pm +++ b/FS/FS/cust_credit.pm @@ -3,8 +3,10 @@ package FS::cust_credit; use strict; use vars qw( @ISA ); use FS::UID qw( getotaker ); -use FS::Record qw( qsearchs ); +use FS::Record qw( qsearch qsearchs ); use FS::cust_main; +use FS::cust_refund; +use FS::cust_credit_bill; @ISA = qw( FS::Record ); @@ -41,9 +43,6 @@ FS::Record. The following fields are currently supported: =item amount - amount of the credit -=item credited - how much of this credit that is still outstanding, which is -amount minus all refunds (see L). - =item _date - specified as a UNIX timestamp; see L. Also see L and L for conversion functions. @@ -70,26 +69,6 @@ sub table { 'cust_credit'; } Adds this credit to the database ("Posts" the credit). If there is an error, returns the error, otherwise returns false. -When adding new invoices, credited must be amount (or null, in which case it is -automatically set to amount). - -=cut - -sub insert { - my $self = shift; - - my $error; - return $error if $error = $self->ut_money('credited') - || $self->ut_money('amount'); - - $self->credited($self->amount) if $self->credited == 0 - || $self->credited eq ''; - return "credited != amount!" - unless $self->credited == $self->amount; - - $self->SUPER::insert; -} - =item delete Currently unimplemented. @@ -102,25 +81,13 @@ sub delete { =item replace OLD_RECORD -Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. - -Only credited may be changed. Credited is normally updated by creating and -inserting a refund (see L). +Credits may not be modified; there would then be no record the credit was ever +posted. =cut sub replace { - my ( $new, $old ) = ( shift, shift ); - - return "Can't change custnum!" unless $old->custnum == $new->custnum; - #return "Can't change date!" unless $old->_date eq $new->_date; - return "Can't change date!" unless $old->_date == $new->_date; - return "Can't change amount!" unless $old->amount == $new->amount; - return "(New) credited can't be > (new) amount!" - if $new->credited > $new->amount; - - $new->SUPER::replace($old); + return "Can't modify credit!" } =item check @@ -139,7 +106,6 @@ sub check { || $self->ut_number('custnum') || $self->ut_numbern('_date') || $self->ut_money('amount') - || $self->ut_money('credited') || $self->ut_textn('reason'); ; return $error if $error; @@ -154,11 +120,72 @@ sub check { ''; #no error } +=item cust_refund + +Depreciated. See the cust_credit_refund method. + +#Returns all refunds (see L) for this credit. + +=cut + +sub cust_refund { + use Carp; + croak "FS::cust_credit->cust_pay depreciated; see ". + "FS::cust_credit->cust_credit_refund"; + #my $self = shift; + #sort { $a->_date <=> $b->_date } + # qsearch( 'cust_refund', { 'crednum' => $self->crednum } ) + #; +} + +=item cust_credit_refund + +Returns all refund applications (see L) for this credit. + +=cut + +sub cust_credit_refund { + my $self = shift; + sort { $a->_date <=> $b->_date } + qsearch( 'cust_credit_refund', { 'crednum' => $self->crednum } ) + ; +} + +=item cust_credit_bill + +Returns all application to invoices (see L) for this +credit. + +=cut + +sub cust_credit_bill { + my $self = shift; + sort { $a->_date <=> $b->_date } + qsearch( 'cust_credit_bill', { 'crednum' => $self->crednum } ) + ; +} + +=item credited + +Returns the amount of this credit that is still outstanding; which is +amount minus all refund applications (see L) and +applications to invoices (see L). + +=cut + +sub credited { + my $self = shift; + my $amount = $self->amount; + $amount -= $_->amount foreach ( $self->cust_credit_refund ); + $amount -= $_->amount foreach ( $self->cust_credit_bill ); + sprintf( "%.2f", $amount ); +} + =back =head1 VERSION -$Id: cust_credit.pm,v 1.2 2001-02-11 17:17:39 ivan Exp $ +$Id: cust_credit.pm,v 1.11 2001-09-02 07:49:52 ivan Exp $ =head1 BUGS @@ -166,7 +193,8 @@ The delete method. =head1 SEE ALSO -L, L, L, schema.html from the base +L, L, L, +L L, schema.html from the base documentation. =cut