customer merging, RT#10247
[freeside.git] / FS / FS / cust_pay.pm
index c55dd48..5eb1d66 100644 (file)
@@ -12,6 +12,7 @@ use Text::Template;
 use FS::UID qw( getotaker );
 use FS::Misc qw( send_email );
 use FS::Record qw( dbh qsearch qsearchs );
+use FS::CurrentUser;
 use FS::payby;
 use FS::cust_main_Mixin;
 use FS::payinfo_transaction_Mixin;
@@ -140,6 +141,10 @@ 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.  In this case, custnum is optional.
 
+If the additional field discount_term is defined then a prepayment discount
+is taken for that length of time.  It is an error for the customer to owe
+after this payment is made.
+
 A hash of optional arguments may be passed.  Currently "manual" is supported.
 If true, a payment receipt is sent instead of a statement when
 'payment_receipt_email' configuration option is set.
@@ -182,6 +187,51 @@ sub insert {
     return "error inserting cust_pay: $error";
   }
 
+  if ( my $credit_type = $conf->config('prepayment_discounts-credit_type') ) {
+    if ( my $months = $self->discount_term ) {
+      #hmmm... error handling
+      my ($credit, $savings, $total) = 
+        $cust_main->discount_term_values($months);
+      my $cust_credit = new FS::cust_credit {
+        'custnum' => $self->custnum,
+        'amount'  => $credit,
+        'reason'  => 'customer chose to prepay for discount',
+      };
+      $error = $cust_credit->insert('reason_type' => $credit_type);
+      if ( $error ) {
+        $dbh->rollback if $oldAutoCommit;
+        return "error inserting cust_pay: $error";
+      }
+      my @pkgs = $cust_main->_discount_pkgs_and_bill;
+      my $cust_bill = shift(@pkgs);
+      @pkgs = &FS::cust_main::Billing::_discountable_pkgs_at_term($months, @pkgs);
+      $_->bill($_->last_bill) foreach @pkgs;
+      $error = $cust_main->bill( 
+        'recurring_only' => 1,
+        'time'           => $cust_bill->invoice_date,
+        'no_usage_reset' => 1,
+        'pkg_list'       => \@pkgs,
+        'freq_override'   => $months,
+      );
+      if ( $error ) {
+        $dbh->rollback if $oldAutoCommit;
+        return "error inserting cust_pay: $error";
+      }
+      $error = $cust_main->apply_payments_and_credits;
+      if ( $error ) {
+        $dbh->rollback if $oldAutoCommit;
+        return "error inserting cust_pay: $error";
+      }
+      my $new_balance = $cust_main->balance;
+      if ($new_balance > 0) {
+        $dbh->rollback if $oldAutoCommit;
+        return "balance after prepay discount attempt: $new_balance";
+      }
+      
+    }
+
+  }
+
   if ( $self->invnum ) {
     my $cust_bill_pay = new FS::cust_bill_pay {
       'invnum' => $self->invnum,
@@ -351,14 +401,17 @@ sub delete {
 
 }
 
-=item replace OLD_RECORD
+=item replace [ OLD_RECORD ]
 
 You can, but probably shouldn't modify payments...
 
+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 payment!"
   my $self = shift;
   return "Can't modify closed payment" if $self->closed =~ /^Y/i;
   $self->SUPER::replace(@_);
@@ -374,7 +427,7 @@ returns the error, otherwise returns false.  Called by the insert method.
 sub check {
   my $self = shift;
 
-  $self->otaker(getotaker) unless ($self->otaker);
+  $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
 
   my $error =
     $self->ut_numbern('paynum')
@@ -387,6 +440,7 @@ sub check {
     || $self->ut_enum('closed', [ '', 'Y' ])
     || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
     || $self->payinfo_check()
+    || $self->ut_numbern('discount_term')
   ;
   return $error if $error;
 
@@ -398,6 +452,9 @@ sub check {
 
   $self->_date(time) unless $self->_date;
 
+  return "invalid discount_term"
+   if ($self->discount_term && $self->discount_term < 2);
+
 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it
 #  # UNIQUE index should catch this too, without race conditions, but this
 #  # should give a better error message the other 99.9% of the time...
@@ -446,76 +503,94 @@ sub send_receipt {
 
   my $conf = new FS::Conf;
 
-  return ''
-    unless $conf->exists('payment_receipt_email')
-        && grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list;
+  return '' unless $conf->exists('payment_receipt');
+
+  my @invoicing_list = $cust_main->invoicing_list_emailonly;
+  return '' unless @invoicing_list;
 
   $cust_bill ||= ($cust_main->cust_bill)[-1]; #rather inefficient though?
 
+  my $error = '';
+
   if (    ( exists($opt->{'manual'}) && $opt->{'manual'} )
        || ! $conf->exists('invoice_html_statement')
        || ! $cust_bill
-     ) {
-
-    my $receipt_template = new Text::Template (
-      TYPE   => 'ARRAY',
-      SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ],
-    ) or do {
-      warn "can't create payment receipt template: $Text::Template::ERROR";
-      return '';
-    };
+     )
+  {
+
+    if ( $conf->exists('payment_receipt_msgnum')
+         && $conf->config('payment_receipt_msgnum')
+       )
+    {
+      my $msg_template = 
+          FS::msg_template->by_key($conf->config('payment_receipt_msgnum'));
+      $error = $msg_template->send('cust_main'=> $cust_main, 'object'=> $self);
+
+    } elsif ( $conf->exists('payment_receipt_email') ) {
+
+      my $receipt_template = new Text::Template (
+        TYPE   => 'ARRAY',
+        SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ],
+      ) or do {
+        warn "can't create payment receipt template: $Text::Template::ERROR";
+        return '';
+      };
+
+      my $payby = $self->payby;
+      my $payinfo = $self->payinfo;
+      $payby =~ s/^BILL$/Check/ if $payinfo;
+      if ( $payby eq 'CARD' || $payby eq 'CHEK' ) {
+        $payinfo = $self->paymask
+      } else {
+        $payinfo = $self->decrypt($payinfo);
+      }
+      $payby =~ s/^CHEK$/Electronic check/;
+
+      my %fill_in = (
+        'date'         => time2str("%a %B %o, %Y", $self->_date),
+        'name'         => $cust_main->name,
+        'paynum'       => $self->paynum,
+        'paid'         => sprintf("%.2f", $self->paid),
+        'payby'        => ucfirst(lc($payby)),
+        'payinfo'      => $payinfo,
+        'balance'      => $cust_main->balance,
+        'company_name' => $conf->config('company_name', $cust_main->agentnum),
+      );
+
+      if ( $opt->{'cust_pkg'} ) {
+        $fill_in{'pkg'} = $opt->{'cust_pkg'}->part_pkg->pkg;
+        #setup date, other things?
+      }
 
-    my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
-                           $cust_main->invoicing_list;
+      $error = send_email(
+        'from'    => $conf->config('invoice_from', $cust_main->agentnum),
+                                   #invoice_from??? well as good as any
+        'to'      => \@invoicing_list,
+        'subject' => 'Payment receipt',
+        'body'    => [ $receipt_template->fill_in( HASH => \%fill_in ) ],
+      );
 
-    my $payby = $self->payby;
-    my $payinfo = $self->payinfo;
-    $payby =~ s/^BILL$/Check/ if $payinfo;
-    if ( $payby eq 'CARD' || $payby eq 'CHEK' ) {
-      $payinfo = $self->paymask
     } else {
-      $payinfo = $self->decrypt($payinfo);
-    }
-    $payby =~ s/^CHEK$/Electronic check/;
-
-    my %fill_in = (
-      'date'         => time2str("%a %B %o, %Y", $self->_date),
-      'name'         => $cust_main->name,
-      'paynum'       => $self->paynum,
-      'paid'         => sprintf("%.2f", $self->paid),
-      'payby'        => ucfirst(lc($payby)),
-      'payinfo'      => $payinfo,
-      'balance'      => $cust_main->balance,
-      'company_name' => $conf->config('company_name', $cust_main->agentnum),
-    );
 
-    if ( $opt->{'cust_pkg'} ) {
-      $fill_in{'pkg'} = $opt->{'cust_pkg'}->part_pkg->pkg;
-      #setup date, other things?
-    }
+      warn "payment_receipt is on, but no payment_receipt_msgnum or invoice_html_statement is configured\n";
 
-    send_email(
-      'from'    => $conf->config('invoice_from', $cust_main->agentnum),
-                                 #invoice_from??? well as good as any
-      'to'      => \@invoicing_list,
-      'subject' => 'Payment receipt',
-      'body'    => [ $receipt_template->fill_in( HASH => \%fill_in ) ],
-    );
+    }
 
-  } else {
+  } else { #not manual
 
     my $queue = new FS::queue {
        'paynum' => $self->paynum,
        'job'    => 'FS::cust_bill::queueable_email',
     };
 
-    $queue->insert(
+    $error = $queue->insert(
       'invnum'   => $cust_bill->invnum,
       'template' => 'statement',
     );
 
   }
-
+  
+    warn "send_receipt: $error\n" if $error;
 }
 
 =item cust_bill_pay
@@ -789,7 +864,9 @@ sub _upgrade_data {  #class method
   # otaker->usernum upgrade
   ###
 
+  delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge
   $class->_upgrade_otaker(%opts);
+  $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it
 
 }