FS/FS/cust_bill_pay.pm

   1 package FS::cust_bill_pay;
   2
   3 use strict;
   4 use vars qw( @ISA $conf );
   5 use FS::Record qw( qsearchs );
   6 use FS::cust_bill_ApplicationCommon;
   7 use FS::cust_bill;
   8 use FS::cust_pay;
   9
  10 @ISA = qw( FS::cust_bill_ApplicationCommon );
  11
  12 #ask FS::UID to run this stuff for us later
  13 FS::UID->install_callback( sub {
  14   $conf = new FS::Conf;
  15 } );
  16
  17 =head1 NAME
  18
  19 FS::cust_bill_pay - Object methods for cust_bill_pay records
  20
  21 =head1 SYNOPSIS
  22
  23   use FS::cust_bill_pay;
  24
  25   $record = new FS::cust_bill_pay \%hash;
  26   $record = new FS::cust_bill_pay { 'column' => 'value' };
  27
  28   $error = $record->insert;
  29
  30   $error = $new_record->replace($old_record);
  31
  32   $error = $record->delete;
  33
  34   $error = $record->check;
  35
  36 =head1 DESCRIPTION
  37
  38 An FS::cust_bill_pay object represents the application of a payment to a
  39 specific invoice.  FS::cust_bill_pay inherits from
  40 FS::cust_bill_ApplicationCommon and FS::Record.  The following fields are
  41 currently supported:
  42
  43 =over 4
  44
  45 =item billpaynum - primary key (assigned automatically)
  46
  47 =item invnum - Invoice (see L<FS::cust_bill>)
  48
  49 =item paynum - Payment (see L<FS::cust_pay>)
  50
  51 =item amount - Amount of the payment to apply to the specific invoice.
  52
  53 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
  54 L<Time::Local> and L<Date::Parse> for conversion functions.
  55
  56 =back
  57
  58 =head1 METHODS
  59
  60 =over 4
  61
  62 =item new HASHREF
  63
  64 Creates a new record.  To add the record to the database, see L<"insert">.
  65
  66 =cut
  67
  68 sub table { 'cust_bill_pay'; }
  69
  70 sub _app_source_name   { 'payment'; }
  71 sub _app_source_table { 'cust_pay'; }
  72 sub _app_lineitem_breakdown_table { 'cust_bill_pay_pkg'; }
  73
  74 =item insert
  75
  76 Adds this record to the database.  If there is an error, returns the error,
  77 otherwise returns false.
  78
  79 =item delete
  80
  81 Deletes this payment application, unless the closed flag for the parent payment
  82 (see L<FS::cust_pay>) is set.
  83
  84 =cut
  85
  86 sub delete {
  87   my $self = shift;
  88   return "Can't delete application for closed payment"
  89     if $self->cust_pay->closed =~ /^Y/i;
  90   return "Can't delete application for closed invoice"
  91     if $self->cust_bill->closed =~ /^Y/i;
  92   $self->SUPER::delete(@_);
  93 }
  94
  95 =item replace OLD_RECORD
  96
  97 Currently unimplemented (accounting reasons).
  98
  99 =cut
 100
 101 sub replace {
 102    return "Can't modify application of payment!";
 103 }
 104
 105 =item check
 106
 107 Checks all fields to make sure this is a valid payment application.  If there
 108 is an error, returns the error, otherwise returns false.  Called by the insert
 109 method.
 110
 111 =cut
 112
 113 sub check {
 114   my $self = shift;
 115
 116   my $error =
 117     $self->ut_numbern('billpaynum')
 118     || $self->ut_foreign_key('paynum', 'cust_pay', 'paynum' )
 119     || $self->ut_foreign_key('invnum', 'cust_bill', 'invnum' )
 120     || $self->ut_numbern('_date')
 121     || $self->ut_money('amount')
 122   ;
 123   return $error if $error;
 124
 125   return "amount must be > 0" if $self->amount <= 0;
 126
 127   $self->_date(time) unless $self->_date;
 128
 129   return "Cannot apply more than remaining value of invoice"
 130     unless $self->amount <= $self->cust_bill->owed;
 131
 132   return "Cannot apply more than remaining value of payment"
 133     unless $self->amount <= $self->cust_pay->unapplied;
 134
 135   $self->SUPER::check;
 136 }
 137
 138 =item cust_pay
 139
 140 Returns the payment (see L<FS::cust_pay>)
 141
 142 =cut
 143
 144 sub cust_pay {
 145   my $self = shift;
 146   qsearchs( 'cust_pay', { 'paynum' => $self->paynum } );
 147 }
 148
 149 =back
 150
 151 =head1 BUGS
 152
 153 Delete and replace methods.
 154
 155 =head1 SEE ALSO
 156
 157 L<FS::cust_pay>, L<FS::cust_bill>, L<FS::Record>, schema.html from the
 158 base documentation.
 159
 160 =cut
 161
 162 1;
 163