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
170
171
172
173
174
175
176
177
178
179
|
package FS::cust_credit_refund;
use strict;
use vars qw( @ISA );
use FS::Record qw( qsearch qsearchs dbh );
#use FS::UID qw(getotaker);
use FS::cust_credit;
use FS::cust_refund;
@ISA = qw( FS::Record );
=head1 NAME
FS::cust_credit_refund - Object methods for cust_bill_pay records
=head1 SYNOPSIS
use FS::cust_credit_refund;
$record = new FS::cust_credit_refund \%hash;
$record = new FS::cust_credit_refund { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::cust_credit_refund represents the application of a refund to a specific
credit. FS::cust_credit_refund inherits from FS::Record. The following fields
are currently supported:
=over 4
=item creditrefundnum - primary key (assigned automatically)
=item crednum - Credit (see L<FS::cust_credit>)
=item refundnum - Refund (see L<FS::cust_refund>)
=item amount - Amount of the refund to apply to the specific credit.
=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 record. To add the record to the database, see L<"insert">.
=cut
sub table { 'cust_credit_refund'; }
=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;
my $error = $self->SUPER::insert;
return $error if $error;
'';
}
=item delete
Currently unimplemented (accounting reasons).
=cut
sub delete {
return "Can't (yet?) delete cust_credit_refund records!";
}
=item replace OLD_RECORD
Currently unimplemented (accounting reasons).
=cut
sub replace {
return "Can't (yet?) modify cust_credit_refund records!";
}
=item check
Checks all fields to make sure this is a valid refund application. If there is
an error, returns the error, otherwise returns false. Called by the insert
method.
=cut
sub check {
my $self = shift;
my $error =
$self->ut_numbern('creditrefundnum')
|| $self->ut_number('crednum')
|| $self->ut_number('refundnum')
|| $self->ut_money('amount')
|| $self->ut_numbern('_date')
;
return $error if $error;
return "amount must be > 0" if $self->amount <= 0;
return "unknown cust_credit.crednum: ". $self->crednum
unless my $cust_credit =
qsearchs( 'cust_credit', { 'crednum' => $self->crednum } );
return "Unknown refund"
unless my $cust_refund =
qsearchs( 'cust_refund', { 'refundnum' => $self->refundnum } );
$self->_date(time) unless $self->_date;
return "Cannot apply more than remaining value of credit"
unless $self->amount <= $cust_credit->credited;
return "Cannot apply more than remaining value of refund"
unless $self->amount <= $cust_refund->unapplied;
$self->SUPER::check;
}
=item cust_refund
Returns the refund (see L<FS::cust_refund>)
=cut
sub cust_refund {
my $self = shift;
qsearchs( 'cust_refund', { 'refundnum' => $self->refundnum } );
}
=item cust_credit
Returns the credit (see L<FS::cust_credit>)
=cut
sub cust_credit {
my $self = shift;
qsearchs( 'cust_credit', { 'crednum' => $self->crednum } );
}
=back
=head1 BUGS
Delete and replace methods.
the checks for over-applied refunds could be better done like the ones in
cust_bill_credit
=head1 SEE ALSO
L<FS::cust_credit>, L<FS::cust_refund>, L<FS::Record>, schema.html from the
base documentation.
=cut
1;
|
