package FS::cust_credit; use strict; use vars qw( @ISA $conf $unsuspendauto ); use FS::UID qw( dbh getotaker ); use FS::Record qw( qsearch qsearchs ); use FS::cust_main; use FS::cust_refund; use FS::cust_credit_bill; @ISA = qw( FS::Record ); #ask FS::UID to run this stuff for us later $FS::UID::callback{'FS::cust_credit'} = sub { $conf = new FS::Conf; $unsuspendauto = $conf->exists('unsuspendauto'); }; =head1 NAME FS::cust_credit - Object methods for cust_credit records =head1 SYNOPSIS use FS::cust_credit; $record = new FS::cust_credit \%hash; $record = new FS::cust_credit { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check; =head1 DESCRIPTION An FS::cust_credit object represents a credit; the equivalent of a negative B record (see L). FS::cust_credit inherits from FS::Record. The following fields are currently supported: =over 4 =item crednum - primary key (assigned automatically for new credits) =item custnum - customer (see L) =item amount - amount of the credit =item _date - specified as a UNIX timestamp; see L. Also see L and L for conversion functions. =item otaker - order taker (assigned automatically, see L) =item reason - text =item closed - books closed flag, empty or `Y' =back =head1 METHODS =over 4 =item new HASHREF Creates a new credit. To add the credit to the database, see L<"insert">. =cut sub table { 'cust_credit'; } =item insert Adds this credit to the database ("Posts" the credit). If there is an error, returns the error, otherwise returns false. =cut sub insert { 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 $cust_main = qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); my $old_balance = $cust_main->balance; my $error = $self->SUPER::insert; if ( $error ) { $dbh->rollback if $oldAutoCommit; return "error inserting $self: $error"; } #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 $dbh->commit or die $dbh->errstr if $oldAutoCommit; ''; } =item delete Currently unimplemented. =cut sub delete { my $self = shift; return "Can't delete closed credit" if $self->closed =~ /^Y/i; $self->SUPER::delete(@_); } =item replace OLD_RECORD Credits may not be modified; there would then be no record the credit was ever posted. =cut sub replace { return "Can't modify credit!" } =item check Checks all fields to make sure this is a valid credit. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. =cut sub check { my $self = shift; my $error = $self->ut_numbern('crednum') || $self->ut_number('custnum') || $self->ut_numbern('_date') || $self->ut_money('amount') || $self->ut_textn('reason') || $self->ut_enum('closed', [ '', 'Y' ]) ; return $error if $error; return "amount must be > 0 " if $self->amount <= 0; return "Unknown customer" unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); $self->_date(time) unless $self->_date; $self->otaker(getotaker); ''; #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.16 2002-06-04 14:35:52 ivan Exp $ =head1 BUGS The delete method. =head1 SEE ALSO L, L, L, L L, schema.html from the base documentation. =cut 1;