employee commission reporting, RT#6991
[freeside.git] / FS / FS / cust_credit.pm
index 70d7874..d0aa3a4 100644 (file)
@@ -8,11 +8,13 @@ use FS::Misc qw(send_email);
 use FS::Record qw( qsearch qsearchs dbdef );
 use FS::cust_main_Mixin;
 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 ]';
@@ -58,22 +60,46 @@ FS::Record.  The following fields are currently supported:
 
 =over 4
 
-=item crednum - primary key (assigned automatically for new credits)
+=item crednum
 
-=item custnum - customer (see L<FS::cust_main>)
+Primary key (assigned automatically for new credits)
 
-=item amount - amount of the credit
+=item custnum
 
-=item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
+Customer (see L<FS::cust_main>)
+
+=item amount
+
+Amount of the credit
+
+=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 otaker
+
+Order taker (assigned automatically, see L<FS::UID>)
+
+=item reason
+
+Text ( deprecated )
+
+=item reasonnum
+
+Reason (see L<FS::reason>)
+
+=item addlinfo
 
-=item reason - text ( deprecated )
+Text
 
-=item reasonum - int reason (see L<FS::reason>)
+=item closed
 
-=item closed - books closed flag, empty or `Y'
+Books closed flag, empty or `Y'
+
+=item pkgnum
+
+Desired pkgnum when using experimental package balances.
 
 =back
 
@@ -209,7 +235,8 @@ sub delete {
     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'    => [
@@ -272,7 +299,10 @@ sub check {
     || $self->ut_alpha('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;
 
@@ -286,24 +316,6 @@ sub check {
   $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.
@@ -414,14 +426,13 @@ sub reason {
 
   $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 ($class, %opts) = @_;