allow payment modification so we can import order_number info

[freeside.git] / FS / FS / cust_pay.pm

diff --git a/FS/FS/cust_pay.pm b/FS/FS/cust_pay.pm
index d592313..d901c78 100644 (file)
--- a/FS/FS/cust_pay.pm
+++ b/FS/FS/cust_pay.pm
@@ -5,13 +5,13 @@ use vars qw( @ISA $conf $unsuspendauto );
 use Date::Format;
 use Business::CreditCard;
 use Text::Template;
-use FS::UID qw( dbh );
-use FS::Record qw( dbh qsearch qsearchs dbh );
+use FS::Record qw( dbh qsearch qsearchs );
 use FS::Misc qw(send_email);
 use FS::cust_bill;
 use FS::cust_bill_pay;
 use FS::cust_pay_refund;
 use FS::cust_main;
+use FS::cust_pay_void;
 
 @ISA = qw( FS::Record );
 
@@ -178,20 +178,24 @@ sub insert {
 
     my @invoicing_list = grep { $_ ne 'POST' } $cust_main->invoicing_list;
 
+    my $payby = $self->payby;
+    my $payinfo = $self->payinfo;
+    $payby =~ s/^BILL$/Check/ if $payinfo;
+    $payinfo = $self->payinfo_masked if $payby eq 'CARD';
+
     my $error = send_email(
       'from'    => $conf->config('invoice_from'), #??? well as good as any
       'to'      => \@invoicing_list,
       'subject' => 'Payment receipt',
-      'body'    => $receipt_template->fill_in( HASH => {
-                     'date'    => str2time("%a %B %o, %Y", $self->_date),
-                     'paynum'  => $self->paynum,
-                     'paid'    => $self->paid,
-                     'payby'   => ucfirst(lc($self->payby)),
-                     'payinfo' => ( $self->payby eq 'CARD'
-                                      ? $self->payinfo_masked
-                                      : $self->payinfo        ),
-                     'balance' => $cust_main->balance,
-                   } ),
+      'body'    => [ $receipt_template->fill_in( HASH => {
+                       '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,
+                   } ) ],
     );
     if ( $error ) {
       warn "can't send payment receipt: $error";
@@ -203,10 +207,54 @@ sub insert {
 
 }
 
+=item void [ REASON ]
+
+Voids this payment: deletes the payment and all associated applications and
+adds a record of the voided payment to the FS::cust_pay_void table.
+
+=cut
+
+sub void {
+  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_pay_void = new FS::cust_pay_void ( {
+    map { $_ => $self->get($_) } $self->fields
+  } );
+  $cust_pay_void->reason(shift) if scalar(@_);
+  my $error = $cust_pay_void->insert;
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+
+  $error = $self->delete;
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+
+  '';
+
+}
+
 =item delete
 
 Deletes this payment and all associated applications (see L<FS::cust_bill_pay>),
-unless the closed flag is set.
+unless the closed flag is set.  In most cases, you want to use the void
+method instead to leave a record of the deleted payment.
 
 =cut
 
@@ -225,8 +273,8 @@ sub delete {
   local $FS::UID::AutoCommit = 0;
   my $dbh = dbh;
 
-  foreach my $cust_bill_pay ( $self->cust_bill_pay ) {
-    my $error = $cust_bill_pay->delete;
+  foreach my $app ( $self->cust_bill_pay, $self->cust_pay_refund ) {
+    my $error = $app->delete;
     if ( $error ) {
       $dbh->rollback if $oldAutoCommit;
       return $error;
@@ -277,13 +325,7 @@ sub delete {
 
 =item replace OLD_RECORD
 
-Currently unimplemented (accounting reasons).
-
-=cut
-
-sub replace {
-   return "Can't (yet?) modify cust_pay records!";
-}
+You probably shouldn't modify payments...
 
 =item check
 
@@ -348,7 +390,8 @@ payment.
 
 sub cust_bill_pay {
   my $self = shift;
-  sort { $a->_date <=> $b->_date }
+  sort {    $a->_date  <=> $b->_date
+         || $a->invnum <=> $b->invnum }
     qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
   ;
 }
@@ -384,6 +427,21 @@ sub unapplied {
   sprintf("%.2f", $amount );
 }
 
+=item unrefunded
+
+Returns the amount of this payment that has not been refuned; which is
+paid minus all  refund applications (see L<FS::cust_pay_refund>).
+
+=cut
+
+sub unrefunded {
+  my $self = shift;
+  my $amount = $self->paid;
+  $amount -= $_->amount foreach ( $self->cust_pay_refund );
+  sprintf("%.2f", $amount );
+}
+
+
 =item cust_main
 
 Returns the parent customer object (see L<FS::cust_main>).