cust_refund and cust_pay get custnums
[freeside.git] / FS / FS / cust_pay.pm
index 728981a..a70b7cb 100644 (file)
@@ -3,8 +3,10 @@ package FS::cust_pay;
 use strict;
 use vars qw( @ISA );
 use Business::CreditCard;
-use FS::Record qw( qsearchs );
+use FS::Record qw( dbh );
 use FS::cust_bill;
+use FS::cust_bill_pay;
+use FS::cust_main;
 
 @ISA = qw( FS::Record );
 
@@ -37,7 +39,7 @@ currently supported:
 
 =item paynum - primary key (assigned automatically for new payments)
 
-=item invnum - Invoice (see L<FS::cust_bill>)
+=item custnum - customer (see L<FS::cust_main>)
 
 =item paid - Amount of this payment
 
@@ -66,25 +68,17 @@ sub table { 'cust_pay'; }
 
 =item insert
 
-Adds this payment to the databse, and updates the invoice (see
-L<FS::cust_bill>).
+Adds this payment to the database.
+
+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.
 
 =cut
 
 sub insert {
   my $self = shift;
 
-  my $error;
-
-  $error = $self->check;
-  return $error if $error;
-
-  my $old_cust_bill = qsearchs( 'cust_bill', { 'invnum' => $self->invnum } );
-  return "Unknown invnum" unless $old_cust_bill;
-  my %hash = $old_cust_bill->hash;
-  $hash{'owed'} = sprintf("%.2f", $hash{owed} - $self->paid );
-  my $new_cust_bill = new FS::cust_bill ( \%hash );
-
   local $SIG{HUP} = 'IGNORE';
   local $SIG{INT} = 'IGNORE';
   local $SIG{QUIT} = 'IGNORE';
@@ -92,10 +86,38 @@ sub insert {
   local $SIG{TSTP} = 'IGNORE';
   local $SIG{PIPE} = 'IGNORE';
 
-  $error = $new_cust_bill->replace($old_cust_bill);
-  return "Error modifying cust_bill: $error" if $error;
+  my $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
+
+  my $error = $self->check;
+  return $error if $error;
+
+  if ( $self->invnum ) {
+    my $cust_bill_pay = new FS::cust_bill_pay {
+      'invnum' => $self->invnum,
+      'paynum' => $self->paynum,
+      'amount' => $self->paid,
+      '_date'  => $self->_date,
+    };
+    $error = $cust_bill_pay->insert;
+    if ( $error ) {
+      $dbh->rollback if $oldAutoCommit;
+      return $error;
+    }
+    $self->custnum($cust_bill_pay->cust_bill->custnum);
+  }
+
+  $error = $self->SUPER::insert;
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+
+  '';
 
-  $self->SUPER::insert;
 }
 
 =item delete
@@ -128,16 +150,19 @@ returns the error, otherwise returns false.  Called by the insert method.
 sub check {
   my $self = shift;
 
-  my $error;
-
-  $error =
+  my $error =
     $self->ut_numbern('paynum')
-    || $self->ut_number('invnum')
+    || $self->ut_number('custnum')
     || $self->ut_money('paid')
     || $self->ut_numbern('_date')
+    || $self->ut_textn('paybatch')
   ;
   return $error if $error;
 
+  return "unknown cust_main.custnum: ". $self->custnum
+    unless $self->invnum
+           || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
+
   $self->_date(time) unless $self->_date;
 
   $self->payby =~ /^(CARD|BILL|COMP)$/ or return "Illegal payby";
@@ -162,18 +187,43 @@ sub check {
     return $error if $error;
   }
 
-  $error = $self->ut_textn('paybatch');
-  return $error if $error;
-
   ''; #no error
 
 }
 
+=item cust_bill_pay
+
+Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
+payment.
+
+=cut
+
+sub cust_bill_pay {
+  my $self = shift;
+  sort { $a->_date <=> $b->_date }
+    qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
+  ;
+}
+
+=item unapplied
+
+Returns the amount of this payment that is still unapplied; which is
+paid minus all payment applications (see L<FS::cust_bill_pay>).
+
+=cut
+
+sub unapplied {
+  my $self = shift;
+  my $amount = $self->paid;
+  $amount -= $_->amount foreach ( $self->cust_bill_pay );
+  sprintf("%.2f", $amount );
+}
+
 =back
 
 =head1 VERSION
 
-$Id: cust_pay.pm,v 1.2 2001-02-11 17:17:39 ivan Exp $
+$Id: cust_pay.pm,v 1.5 2001-09-02 02:46:55 ivan Exp $
 
 =head1 BUGS
 
@@ -181,7 +231,8 @@ Delete and replace methods.
 
 =head1 SEE ALSO
 
-L<FS::Record>, L<FS::cust_bill>, schema.html from the base documentation.
+L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>, schema.html from the
+base documentation.
 
 =cut