package FS::cust_bill_pay;
+use base qw( FS::cust_main_Mixin FS::cust_bill_ApplicationCommon );
use strict;
-use vars qw( @ISA );
-use FS::Record qw( qsearch qsearchs dbh );
-use FS::cust_bill;
-use FS::cust_pay;
+use vars qw( $conf );
+use FS::UID;
-@ISA = qw( FS::Record );
+#ask FS::UID to run this stuff for us later
+FS::UID->install_callback( sub {
+ $conf = new FS::Conf;
+} );
=head1 NAME
=head1 DESCRIPTION
An FS::cust_bill_pay object represents the application of a payment to a
-specific invoice. FS::cust_bill_pay inherits from FS::Record. The following
-fields are currently supported:
+specific invoice. FS::cust_bill_pay inherits from
+FS::cust_bill_ApplicationCommon and FS::Record. The following fields are
+currently supported:
=over 4
sub table { 'cust_bill_pay'; }
+sub _app_source_name { 'payment'; }
+sub _app_source_table { 'cust_pay'; }
+sub _app_lineitem_breakdown_table { 'cust_bill_pay_pkg'; }
+sub _app_part_pkg_weight_column { 'pay_weight'; }
+
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
-=cut
-
-sub insert {
- 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 $error = $self->check;
- return $error if $error;
-
- $error = $self->SUPER::insert;
-
- my $cust_pay = qsearchs('cust_pay', { 'paynum' => $self->paynum } ) or do {
- $dbh->rollback if $oldAutoCommit;
- return "unknown cust_pay.paynum: ". $self->paynum;
- };
-
- my $pay_total = 0;
- $pay_total += $_ foreach map { $_->amount }
- qsearch('cust_bill_pay', { 'paynum' => $self->paynum } );
-
- if ( sprintf("%.2f", $pay_total) > sprintf("%.2f", $cust_pay->paid) ) {
- $dbh->rollback if $oldAutoCommit;
- return "total cust_bill_pay.amount $pay_total for paynum ". $self->paynum.
- " greater than cust_pay.paid ". $cust_pay->paid;
- }
-
- my $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } ) or do {
- $dbh->rollback if $oldAutoCommit;
- return "unknown cust_bill.invnum: ". $self->invnum;
- };
-
- my $bill_total = 0;
- $bill_total += $_ foreach map { $_->amount }
- qsearch('cust_bill_pay', { 'invnum' => $self->invnum } );
- $bill_total += $_ foreach map { $_->amount }
- qsearch('cust_credit_bill', { 'invnum' => $self->invnum } );
- if ( sprintf("%.2f", $bill_total) > sprintf("%.2f", $cust_bill->charged) ) {
- $dbh->rollback if $oldAutoCommit;
- return "total cust_bill_pay.amount and cust_credit_bill.amount $bill_total".
- " for invnum ". $self->invnum.
- " greater than cust_bill.charged ". $cust_bill->charged;
- }
-
- $dbh->commit or die $dbh->errstr if $oldAutoCommit;
-
- '';
-}
-
=item delete
-Currently unimplemented (accounting reasons).
+Deletes this payment application, unless the closed flag for the parent payment
+(see L<FS::cust_pay>) is set.
=cut
sub delete {
- return "Can't (yet?) delete cust_bill_pay records!";
+ my $self = shift;
+ return "Can't delete application for closed payment"
+ if $self->cust_pay && $self->cust_pay->closed =~ /^Y/i;
+ return "Can't delete application for closed invoice"
+ if $self->cust_bill && $self->cust_bill->closed =~ /^Y/i;
+ $self->SUPER::delete(@_);
}
=item replace OLD_RECORD
=cut
sub replace {
- return "Can't (yet?) modify cust_bill_pay records!";
+ return "Can't modify application of payment!";
}
=item check
-Checks all fields to make sure this is a valid payment. If there is an error,
-returns the error, otherwise returns false. Called by the insert method.
+Checks all fields to make sure this is a valid payment application. If there
+is an error, returns the error, otherwise returns false. Called by the insert
+method.
=cut
my $error =
$self->ut_numbern('billpaynum')
- || $self->ut_number('invnum')
- || $self->ut_number('paynum')
- || $self->ut_money('amount')
+ || $self->ut_foreign_key('paynum', 'cust_pay', 'paynum' )
+ || $self->ut_foreign_key('invnum', 'cust_bill', 'invnum' )
|| $self->ut_numbern('_date')
+ || $self->ut_money('amount')
+ || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
;
return $error if $error;
return "amount must be > 0" if $self->amount <= 0;
-
+
$self->_date(time) unless $self->_date;
- ''; #no error
+ return "Cannot apply more than remaining value of invoice"
+ unless $self->amount <= $self->cust_bill->owed;
+
+ return "Cannot apply more than remaining value of payment"
+ unless $self->amount <= $self->cust_pay->unapplied;
+
+ $self->SUPER::check;
}
=item cust_pay
Returns the payment (see L<FS::cust_pay>)
-=cut
-
-sub cust_pay {
- my $self = shift;
- qsearchs( 'cust_pay', { 'paynum' => $self->paynum } );
-}
+=item send_receipt HASHREF | OPTION => VALUE ...
-=item cust_bill
+Sends a payment receipt for the associated payment, against this specific
+invoice. If there is an error, returns the error, otherwise returns false.
-Returns the invoice (see L<FS::cust_bill>)
+See L<FS::cust_pay/send_receipt>.
=cut
-sub cust_bill {
+sub send_receipt {
my $self = shift;
- qsearchs( 'cust_bill', { 'invnum' => $self->invnum } );
+ my $opt = ref($_[0]) ? shift : { @_ };
+ $self->cust_pay->send_receipt(
+ 'cust_bill' => $self->cust_bill,
+ %$opt,
+ );
}
=back
-=head1 VERSION
-
-$Id: cust_bill_pay.pm,v 1.11 2002-01-24 16:58:47 ivan Exp $
-
=head1 BUGS
Delete and replace methods.
-the checks for over-applied payments could be better done like the ones in
-cust_bill_credit
-
=head1 SEE ALSO
L<FS::cust_pay>, L<FS::cust_bill>, L<FS::Record>, schema.html from the
projects / freeside.git / blobdiff