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
|
package FS::cust_bill_pay;
use strict;
use vars qw( @ISA $conf );
use FS::Record qw( qsearch qsearchs dbh );
use FS::cust_bill;
use FS::cust_pay;
@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
FS::cust_bill_pay - Object methods for cust_bill_pay records
=head1 SYNOPSIS
use FS::cust_bill_pay;
$record = new FS::cust_bill_pay \%hash;
$record = new FS::cust_bill_pay { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=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:
=over 4
=item billpaynum - primary key (assigned automatically)
=item invnum - Invoice (see L<FS::cust_bill>)
=item paynum - Payment (see L<FS::cust_pay>)
=item amount - Amount of the payment to apply to the specific invoice.
=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_bill_pay'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=item delete
Deletes this payment application, unless the closed flag for the parent payment
(see L<FS::cust_pay>) is set.
=cut
sub delete {
my $self = shift;
return "Can't delete application for closed payment"
if $self->cust_pay->closed =~ /^Y/i;
$self->SUPER::delete(@_);
}
=item replace OLD_RECORD
Currently unimplemented (accounting reasons).
=cut
sub replace {
return "Can't (yet?) modify cust_bill_pay records!";
}
=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.
=cut
sub check {
my $self = shift;
my $error =
$self->ut_numbern('billpaynum')
|| $self->ut_number('invnum')
|| $self->ut_number('paynum')
|| $self->ut_money('amount')
|| $self->ut_numbern('_date')
;
return $error if $error;
return "amount must be > 0" if $self->amount <= 0;
return "Unknown invoice"
unless my $cust_bill =
qsearchs( 'cust_bill', { 'invnum' => $self->invnum } );
return "Unknown payment"
unless my $cust_pay =
qsearchs( 'cust_pay', { 'paynum' => $self->paynum } );
$self->_date(time) unless $self->_date;
return "Cannot apply more than remaining value of invoice"
unless $self->amount <= $cust_bill->owed;
return "Cannot apply more than remaining value of payment"
unless $self->amount <= $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 cust_bill
Returns the invoice (see L<FS::cust_bill>)
=cut
sub cust_bill {
my $self = shift;
qsearchs( 'cust_bill', { 'invnum' => $self->invnum } );
}
=back
=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
base documentation.
=cut
1;
|
