package FS::cust_credit;
use strict;
-use vars qw( @ISA $conf $unsuspendauto $me $DEBUG );
+use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::Record );
+use vars qw( $conf $unsuspendauto $me $DEBUG
+ $otaker_upgrade_kludge $ignore_empty_reasonnum
+ );
use Date::Format;
use FS::UID qw( dbh getotaker );
use FS::Misc qw(send_email);
use FS::Record qw( qsearch qsearchs dbdef );
-use FS::cust_main_Mixin;
+use FS::CurrentUser;
use FS::cust_main;
+use FS::cust_pkg;
use FS::cust_refund;
use FS::cust_credit_bill;
use FS::part_pkg;
use FS::reason_type;
use FS::reason;
+use FS::cust_event;
-@ISA = qw( FS::cust_main_Mixin FS::Record );
$me = '[ FS::cust_credit ]';
$DEBUG = 0;
+$otaker_upgrade_kludge = 0;
+$ignore_empty_reasonnum = 0;
+
#ask FS::UID to run this stuff for us later
$FS::UID::callback{'FS::cust_credit'} = sub {
=over 4
-=item crednum - primary key (assigned automatically for new credits)
+=item crednum
+
+Primary key (assigned automatically for new credits)
+
+=item custnum
+
+Customer (see L<FS::cust_main>)
-=item custnum - customer (see L<FS::cust_main>)
+=item amount
-=item amount - amount of the credit
+Amount of the credit
-=item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
+=item _date
+
+Specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
L<Time::Local> and L<Date::Parse> for conversion functions.
-=item otaker - order taker (assigned automatically, see L<FS::UID>)
+=item usernum
+
+Order taker (see L<FS::access_user>)
+
+=item reason
-=item reason - text ( deprecated )
+Text ( deprecated )
-=item reasonum - int reason (see L<FS::reason>)
+=item reasonnum
-=item closed - books closed flag, empty or `Y'
+Reason (see L<FS::reason>)
+
+=item addlinfo
+
+Text
+
+=item closed
+
+Books closed flag, empty or `Y'
+
+=item pkgnum
+
+Desired pkgnum when using experimental package balances.
=back
);
unless($result) {
$dbh->rollback if $oldAutoCommit;
- return "failed to set reason for $me: ". $dbh->errstr;
+ return "failed to set reason for $me"; #: ". $dbh->errstr;
}
}
my $cust_main = $self->cust_main;
my $error = send_email(
- 'from' => $conf->config('invoice_from'), #??? well as good as any
+ 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
+ #invoice_from??? well as good as any
'to' => $conf->config('deletecredits'),
'subject' => 'FREESIDE NOTIFICATION: Credit deleted',
'body' => [
}
-=item replace OLD_RECORD
+=item replace [ OLD_RECORD ]
You can, but probably shouldn't modify credits...
+Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
+supplied, replaces this record. If there is an error, returns the error,
+otherwise returns false.
+
=cut
sub replace {
- #return "Can't modify credit!"
my $self = shift;
return "Can't modify closed credit" if $self->closed =~ /^Y/i;
$self->SUPER::replace(@_);
sub check {
my $self = shift;
+ $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
+
my $error =
$self->ut_numbern('crednum')
|| $self->ut_number('custnum')
|| $self->ut_numbern('_date')
|| $self->ut_money('amount')
+ || $self->ut_alphan('otaker')
|| $self->ut_textn('reason')
- || $self->ut_foreign_key('reasonnum', 'reason', 'reasonnum')
+ || $self->ut_textn('addlinfo')
|| $self->ut_enum('closed', [ '', 'Y' ])
+ || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
+ || $self->ut_foreign_keyn('eventnum', 'cust_event', 'eventnum')
;
return $error if $error;
+ my $method = $ignore_empty_reasonnum ? 'ut_foreign_keyn' : 'ut_foreign_key';
+ $error = $self->$method('reasonnum', 'reason', 'reasonnum');
+ return $error if $error;
+
return "amount must be > 0 " if $self->amount <= 0;
+ return "amount must be greater or equal to amount applied"
+ if $self->unapplied < 0 && ! $otaker_upgrade_kludge;
+
return "Unknown customer"
unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
$self->_date(time) unless $self->_date;
- $self->otaker(getotaker);
-
$self->SUPER::check;
}
-=item cust_refund
-
-Depreciated. See the cust_credit_refund method.
-
-#Returns all refunds (see L<FS::cust_refund>) 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<FS::cust_credit_refund>) for this credit.
sub cust_credit_refund {
my $self = shift;
+ map { $_ } #return $self->num_cust_credit_refund unless wantarray;
sort { $a->_date <=> $b->_date }
qsearch( 'cust_credit_refund', { 'crednum' => $self->crednum } )
;
sub cust_credit_bill {
my $self = shift;
+ map { $_ } #return $self->num_cust_credit_bill unless wantarray;
sort { $a->_date <=> $b->_date }
qsearch( 'cust_credit_bill', { 'crednum' => $self->crednum } )
;
}
-=item credited
+=item unapplied
-Returns the amount of this credit that is still outstanding; which is
+Returns the amount of this credit that is still unapplied/outstanding;
amount minus all refund applications (see L<FS::cust_credit_refund>) and
applications to invoices (see L<FS::cust_credit_bill>).
=cut
-sub credited {
+sub unapplied {
my $self = shift;
my $amount = $self->amount;
$amount -= $_->amount foreach ( $self->cust_credit_refund );
sprintf( "%.2f", $amount );
}
+=item credited
+
+Deprecated name for the unapplied method.
+
+=cut
+
+sub credited {
+ my $self = shift;
+ #carp "cust_credit->credited deprecated; use ->unapplied";
+ $self->unapplied(@_);
+}
+
=item cust_main
Returns the customer (see L<FS::cust_main>) for this credit.
if (!$reason && $typenum) {
$reason = new FS::reason( { 'reason_type' => $typenum,
'reason' => $value,
+ 'disabled' => 'Y',
} );
- $reason->insert and $reason = undef;
+ my $error = $reason->insert;
+ if ( $error ) {
+ warn "error inserting reason: $error\n";
+ $reason = undef;
+ }
}
$self->reasonnum($reason ? $reason->reasonnum : '') ;
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
- $reason ? $reason->reason : '';
+ ( $reason ? $reason->reason : '' ).
+ ( $self->addlinfo ? ' '.$self->addlinfo : '' );
}
# _upgrade_data
#
# Used by FS::Upgrade to migrate to a new database.
-#
-#
sub _upgrade_data { # class method
- my ($self, %opts) = @_;
+ my ($class, %opts) = @_;
- warn "$me upgrading $self\n" if $DEBUG;
+ warn "$me upgrading $class\n" if $DEBUG;
- if (defined dbdef->table($self->table)->column('reason')) {
+ if (defined dbdef->table($class->table)->column('reason')) {
warn "$me Checking for unmigrated reasons\n" if $DEBUG;
- my @cust_credits = qsearch({ 'table' => $self->table,
- 'hashref' => {},
- 'extrasql' => 'WHERE reason IS NOT NULL',
+ my @cust_credits = qsearch({ 'table' => $class->table,
+ 'hashref' => {},
+ 'extra_sql' => 'WHERE reason IS NOT NULL',
});
if (scalar(grep { $_->getfield('reason') =~ /\S/ } @cust_credits)) {
unless ($reason_type) {
$reason_type = new FS::reason_type( $hashref );
my $error = $reason_type->insert();
- die "$self had error inserting FS::reason_type into database: $error\n"
+ die "$class had error inserting FS::reason_type into database: $error\n"
if $error;
}
};
my $noreason = qsearchs( 'reason', $hashref );
unless ($noreason) {
+ $hashref->{'disabled'} = 'Y';
$noreason = new FS::reason( $hashref );
my $error = $noreason->insert();
die "can't insert legacy reason '(none)' into database: $error\n"
$cust_credit->setfield('reason', '');
my $error = $cust_credit->replace;
- warn "*** WARNING: error replacing reason in $self ".
- $self->crednum. ": $error ***\n"
+ warn "*** WARNING: error replacing reason in $class ".
+ $cust_credit->crednum. ": $error ***\n"
if $error;
}
}
unless ($reason_type) {
$reason_type = new FS::reason_type( $hashref );
my $error = $reason_type->insert();
- die "$self had error inserting FS::reason_type into database: $error\n"
+ die "$class had error inserting FS::reason_type into database: $error\n"
if $error;
}
- # or clause for 1.7.x
- $conf->set($_, $reason_type->typenum) or die "failed setting config";
+ $conf->set($_, $reason_type->typenum);
}
}
unless ($reason_type) {
$reason_type = new FS::reason_type( $hashref );
my $error = $reason_type->insert();
- die "$self had error inserting FS::reason_type into database: $error\n"
+ die "$class had error inserting FS::reason_type into database: $error\n"
if $error;
}
}
}
- '';
+ local($otaker_upgrade_kludge) = 1;
+ local($ignore_empty_reasonnum) = 1;
+ $class->_upgrade_otaker(%opts);
}
=over 4
-=item credited_sql
+=item unapplied_sql
Returns an SQL fragment to retreive the unapplied amount.
=cut
-sub credited_sql {
- #my $class = shift;
+sub unapplied_sql {
+ my ($class, $start, $end) = @_;
+
+ my $bill_start = $start ? "AND cust_credit_bill._date <= $start" : '';
+ my $bill_end = $end ? "AND cust_credit_bill._date > $end" : '';
+ my $refund_start = $start ? "AND cust_credit_refund._date <= $start" : '';
+ my $refund_end = $end ? "AND cust_credit_refund._date > $end" : '';
"amount
- COALESCE(
( SELECT SUM(amount) FROM cust_credit_refund
- WHERE cust_credit.crednum = cust_credit_refund.crednum )
+ WHERE cust_credit.crednum = cust_credit_refund.crednum
+ $refund_start $refund_end )
,0
)
- COALESCE(
( SELECT SUM(amount) FROM cust_credit_bill
- WHERE cust_credit.crednum = cust_credit_bill.crednum )
+ WHERE cust_credit.crednum = cust_credit_bill.crednum
+ $bill_start $bill_end )
,0
)
";
}
+=item credited_sql
+
+Deprecated name for the unapplied_sql method.
+
+=cut
+
+sub credited_sql {
+ #my $class = shift;
+
+ #carp "cust_credit->credited_sql deprecated; use ->unapplied_sql";
+
+ #$class->unapplied_sql(@_);
+ unapplied_sql();
+}
+
=back
=head1 BUGS
The delete method. The replace method.
-B<credited> and B<credited_sql> should probably be called B<unapplied> and
-B<unapplied_sql>.
+B<credited> and B<credited_sql> are now called B<unapplied> and
+B<unapplied_sql>. The old method names should start to give warnings.
=head1 SEE ALSO
projects / freeside.git / blobdiff