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
|
package FS::cust_event_fee;
use strict;
use base qw( FS::Record );
use FS::Record qw( qsearch qsearchs );
=head1 NAME
FS::cust_event_fee - Object methods for cust_event_fee records
=head1 SYNOPSIS
use FS::cust_event_fee;
$record = new FS::cust_event_fee \%hash;
$record = new FS::cust_event_fee { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::cust_event_fee object links a billing event that charged a fee
(an L<FS::cust_event>) to the resulting invoice line item (an
L<FS::cust_bill_pkg> object). FS::cust_event_fee inherits from FS::Record.
The following fields are currently supported:
=over 4
=item eventfeenum - primary key
=item eventnum - key of the cust_event record that required the fee to be
created. This is a unique column; there's no reason for a single event
instance to create more than one fee.
=item billpkgnum - key of the cust_bill_pkg record representing the fee
on an invoice. This is also a unique column but can be NULL to indicate
a fee that hasn't been billed yet. In that case it will be billed the next
time billing runs for the customer.
=item feepart - key of the fee definition (L<FS::part_fee>).
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new event-fee link. To add the record to the database,
see L<"insert">.
=cut
sub table { 'cust_event_fee'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=item delete
Delete this record from the database.
=item replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=item check
Checks all fields to make sure this is a valid example. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
# the check method should currently be supplied - FS::Record contains some
# data checking routines
sub check {
my $self = shift;
my $error =
$self->ut_numbern('eventfeenum')
|| $self->ut_foreign_key('eventnum', 'cust_event', 'eventnum')
|| $self->ut_foreign_keyn('billpkgnum', 'cust_bill_pkg', 'billpkgnum')
|| $self->ut_foreign_key('feepart', 'part_fee', 'feepart')
;
return $error if $error;
$self->SUPER::check;
}
=back
=head1 CLASS METHODS
=over 4
=item by_cust CUSTNUM[, PARAMS]
Finds all cust_event_fee records belonging to the customer CUSTNUM. Currently
fee events can be cust_main or cust_bill events; this will return both.
PARAMS can be additional params to pass to qsearch; this really only works
for 'hashref' and 'order_by'.
=cut
sub by_cust {
my $class = shift;
my $custnum = shift or return;
my %params = @_;
$custnum =~ /^\d+$/ or die "bad custnum $custnum";
# silliness
my $where = ($params{hashref} && keys (%{ $params{hashref} }))
? 'AND'
: 'WHERE';
qsearch({
table => 'cust_event_fee',
addl_from => 'JOIN cust_event USING (eventnum) ' .
'JOIN part_event USING (eventpart) ',
extra_sql => "$where eventtable = 'cust_main' ".
"AND cust_event.tablenum = $custnum",
%params
}),
qsearch({
table => 'cust_event_fee',
addl_from => 'JOIN cust_event USING (eventnum) ' .
'JOIN part_event USING (eventpart) ' .
'JOIN cust_bill ON (cust_event.tablenum = cust_bill.invnum)',
extra_sql => "$where eventtable = 'cust_bill' ".
"AND cust_bill.custnum = $custnum",
%params
})
}
=head1 BUGS
=head1 SEE ALSO
L<FS::cust_event>, L<FS::part_fee>, L<FS::Record>
=cut
1;
|
