1 package FS::cust_pay_refund;
4 use vars qw( @ISA ); #$conf );
5 use FS::Record qw( qsearchs ); # qsearch );
10 @ISA = qw( FS::Record );
12 #ask FS::UID to run this stuff for us later
13 #FS::UID->install_callback( sub {
14 # $conf = new FS::Conf;
19 FS::cust_pay_refund - Object methods for cust_pay_refund records
23 use FS::cust_pay_refund;
25 $record = new FS::cust_pay_refund \%hash;
26 $record = new FS::cust_pay_refund { 'column' => 'value' };
28 $error = $record->insert;
30 $error = $new_record->replace($old_record);
32 $error = $record->delete;
34 $error = $record->check;
38 An FS::cust_pay_refund object represents application of a refund (see
39 L<FS::cust_refund>) to an payment (see L<FS::cust_pay>). FS::cust_pay_refund
40 inherits from FS::Record. The following fields are currently supported:
44 =item payrefundnum - primary key
46 =item paynum - credit being applied
48 =item refundnum - invoice to which credit is applied (see L<FS::cust_bill>)
50 =item amount - amount of the credit applied
52 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
53 L<Time::Local> and L<Date::Parse> for conversion functions.
63 Creates a new cust_pay_refund. To add the cust_pay_refund to the database,
68 sub table { 'cust_pay_refund'; }
72 Adds this cust_pay_refund to the database. If there is an error, returns the
73 error, otherwise returns false.
79 return "Can't apply refund to closed payment"
80 if $self->cust_pay->closed =~ /^Y/i;
81 return "Can't apply payment to closed refund"
82 if $self->cust_refund->closed =~ /^Y/i;
83 $self->SUPER::insert(@_);
92 return "Can't remove refund from closed payment"
93 if $self->cust_pay->closed =~ /^Y/i;
94 return "Can't remove payment from closed refund"
95 if $self->cust_refund->closed =~ /^Y/i;
96 $self->SUPER::delete(@_);
99 =item replace OLD_RECORD
101 Application of refunds to payments may not be modified.
106 return "Can't modify application of a refund to payment!"
111 Checks all fields to make sure this is a valid refund application to a payment.
112 If there is an error, returns the error, otherwise returns false. Called by
113 the insert and replace methods.
121 $self->ut_numbern('payrefundnum')
122 || $self->ut_number('paynum')
123 || $self->ut_number('refundnum')
124 || $self->ut_numbern('_date')
125 || $self->ut_money('amount')
127 return $error if $error;
129 return "amount must be > 0" if $self->amount <= 0;
131 return "Unknown payment"
132 unless my $cust_pay =
133 qsearchs( 'cust_pay', { 'paynum' => $self->paynum } );
135 return "Unknown refund"
136 unless my $cust_refund =
137 qsearchs( 'cust_refund', { 'refundnum' => $self->refundnum } );
139 $self->_date(time) unless $self->_date;
141 return 'Cannot apply ($'. $self->amount. ') more than'.
142 ' remaining value of refund ($'. $cust_refund->unapplied. ')'
143 unless $self->amount <= $cust_refund->unapplied;
145 return "Cannot apply more than remaining value of payment"
146 unless $self->amount <= $cust_pay->unapplied;
153 Returns the payment (see L<FS::cust_pay>)
159 qsearchs( 'cust_pay', { 'paynum' => $self->paynum } );
164 Returns the refund (see L<FS::cust_refund>)
170 qsearchs( 'cust_refund', { 'refundnum' => $self->refundnum } );
181 L<FS::Record>, L<FS::cust_refund>, L<FS::cust_bill>, L<FS::cust_credit>,
182 schema.html from the base documentation.