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