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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
package FS::cust_bill_ApplicationCommon;
use strict;
use vars qw( @ISA $DEBUG );
use FS::Schema qw( dbdef );
use FS::Record qw( qsearch qsearchs dbh );
@ISA = qw( FS::Record );
$DEBUG = 1;
=head1 NAME
FS::cust_bill_ApplicationCommon - Base class for bill application classes
=head1 SYNOPSIS
use FS::cust_bill_ApplicationCommon;
@ISA = qw( FS::cust_bill_ApplicationCommon );
sub _app_source_name { 'payment'; }
sub _app_source_table { 'cust_pay'; }
sub _app_lineitem_breakdown_table { 'cust_bill_pay_pkg'; }
=head1 DESCRIPTION
FS::cust_bill_ApplicationCommon is intended as a base class for classes which
represent application of things to invoices, currently payments
(see L<FS::cust_bill_pay>) or credits (see L<FS::cust_credit_bill>).
=head1 METHODS
=item insert
=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->SUPER::insert(@_)
|| $self->apply_to_lineitems;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
'';
}
=item delete
=cut
sub delete {
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;
foreach my $app ( $self->lineitem_applications ) {
my $error = $app->delete;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
}
my $error = $self->SUPER::delete(@_);
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
'';
}
=item apply_to_lineitems
Auto-applies this invoice application to specific line items, if possible.
=cut
sub apply_to_lineitems {
my $self = shift;
my @apply = ();
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 @open = $self->cust_bill->open_cust_bill_pkg; #FOR UPDATE...?
warn scalar(@open). " open line items for invoice ".
$self->cust_bill->invnum. "\n"
if $DEBUG;
my $total = 0;
$total += $_->setup + $_->recur foreach @open;
$total = sprintf('%.2f', $total);
if ( $self->amount > $total ) {
dbh->rollback if $oldAutoCommit;
return "Can't apply a ". $self->_app_source_name. ' of $'. $self->amount.
" greater than the remaining owed on line items (\$$total)";
}
#easy cases:
# - one lineitem (a simple special case of:)
# - amount is for whole invoice (well, all of remaining lineitem links)
if ( $self->amount == $total ) {
#@apply = map { [ $_, $_->amount ]; } @open;
@apply = map { [ $_, $_->setup || $_->recur ]; } @open;
} else {
#slightly magic case:
# - amount exactly and uniquely matches a single open lineitem
# (you must be trying to pay or credit that item, then)
my @same = grep { $_->setup == $self->amount
|| $_->recur == $self->amount
}
@open;
@apply = map { [ $_, $self->amount ]; } @same
if scalar(@same) == 1;
}
#and the rest:
# - leave unapplied, for now
# - eventually, auto-apply? sequentially? pro-rated against total remaining?
# do the applicaiton(s)
my $table = $self->lineitem_breakdown_table;
my $source_key = dbdef->table($self->table)->primary_key;
foreach my $apply ( @apply ) {
my ( $cust_bill_pkg, $amount ) = @$apply;
my $application = "FS::$table"->new( {
$source_key => $self->$source_key(),
'billpkgnum' => $cust_bill_pkg->billpkgnum,
'amount' => $amount,
'setuprecur' => ( $cust_bill_pkg->setup > 0 ? 'setup' : 'recur' ),
});
my $error = $application->insert;
if ( $error ) {
dbh->rollbck if $oldAutoCommit;
return $error;
}
}
'';
}
=item lineitem_applications
Returns all the specific line item applications for this invoice application.
=cut
sub lineitem_applications {
my $self = shift;
my $primary_key = dbdef->table($self->table)->primary_key;
qsearchs({
'table' => $self->lineitem_breakdown_table,
'hashref' => { $primary_key => $self->$primary_key() },
});
}
=item cust_bill
Returns the invoice (see L<FS::cust_bill>)
=cut
sub cust_bill {
my $self = shift;
qsearchs( 'cust_bill', { 'invnum' => $self->invnum } );
}
=item lineitem_breakdown_table
=cut
sub lineitem_breakdown_table {
my $self = shift;
$self->_load_table($self->_app_lineitem_breakdown_table);
}
sub _load_table {
my( $self, $table ) = @_;
eval "use FS::$table";
die $@ if $@;
$table;
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::cust_bill_pay> and L<FS::cust_bill_pay_pkg>,
L<FS::cust_credit_bill> and L<FS::cust_credit_bill_pkg>
=cut
1;
|
