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
|
package FS::cust_bill_pkg_tax_rate_location;
use base qw( FS::Record );
use strict;
use FS::Record qw( qsearch qsearchs );
use FS::cust_pkg;
use FS::cust_bill_pay_pkg;
use FS::cust_credit_bill_pkg;
use FS::tax_rate;
=head1 NAME
FS::cust_bill_pkg_tax_rate_location - Object methods for cust_bill_pkg_tax_rate_location records
=head1 SYNOPSIS
use FS::cust_bill_pkg_tax_rate_location;
$record = new FS::cust_bill_pkg_tax_rate_location \%hash;
$record = new FS::cust_bill_pkg_tax_rate_location { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::cust_bill_pkg_tax_rate_location object represents an record of taxation
based on package location. FS::cust_bill_pkg_tax_rate_location inherits from
FS::Record. The following fields are currently supported:
=over 4
=item billpkgtaxratelocationnum
billpkgtaxratelocationnum
=item billpkgnum
billpkgnum
=item taxnum
taxnum
=item taxtype
taxtype
=item locationtaxid
locationtaxid
=item taxratelocationnum
taxratelocationnum
=item amount
amount
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new record. To add the record to the database, see L<"insert">.
Note that this stores the hash reference, not a distinct copy of the hash it
points to. You can ask the object for a copy with the I<hash> method.
=cut
sub table { 'cust_bill_pkg_tax_rate_location'; }
=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 record. 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('billpkgtaxratelocationnum')
|| $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum' )
|| $self->ut_number('taxnum') #cust_bill_pkg/tax_rate key, based on taxtype
|| $self->ut_enum('taxtype', [ qw( FS::cust_main_county FS::tax_rate ) ] )
|| $self->ut_textn('locationtaxid')
|| $self->ut_foreign_key('taxratelocationnum', 'tax_rate_location', 'taxratelocationnum' )
|| $self->ut_money('amount')
;
return $error if $error;
$self->SUPER::check;
}
=item cust_bill_pkg
Returns the associated cust_bill_pkg object
=item tax_rate_location
Returns the associated tax_rate_location object
=item taxname
Returns the tax name (the itemdesc).
=cut
sub taxname {
my $self = shift;
my $tax_rate = FS::tax_rate->by_key($self->taxnum)
or return '';
$tax_rate->taxname;
}
=item desc
Returns a description for this tax line item constituent. Currently this
is the desc of the associated line item followed by the
state,county,city,locationtaxid for the location in parentheses.
=cut
sub desc {
my $self = shift;
my $tax_rate_location = $self->tax_rate_location;
my $location = join(', ', grep { $_ }
map { $tax_rate_location->$_ }
qw( state county city )
);
$location .= ( $location && $self->locationtaxid ) ? ', ' : '';
$location .= $self->locationtaxid;
my $cust_bill_pkg_desc = $self->billpkgnum
? $self->cust_bill_pkg->desc
: $self->cust_bill_pkg_desc;
"$cust_bill_pkg_desc ($location)";
}
=item owed
Returns the amount owed (still outstanding) on this tax line item which is
the amount of this record minus all payment applications and credit
applications.
=cut
sub owed {
my $self = shift;
my $balance = $self->amount;
$balance -= $_->amount foreach ( $self->cust_bill_pay_pkg('setup') );
$balance -= $_->amount foreach ( $self->cust_credit_bill_pkg('setup') );
$balance = sprintf( '%.2f', $balance );
$balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
$balance;
}
sub cust_bill_pay_pkg {
my $self = shift;
qsearch( 'cust_bill_pay_pkg', { map { $_ => $self->$_ }
qw( billpkgtaxratelocationnum billpkgnum )
}
);
}
sub cust_credit_bill_pkg {
my $self = shift;
qsearch( 'cust_credit_bill_pkg', { map { $_ => $self->$_ }
qw( billpkgtaxratelocationnum billpkgnum )
}
);
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
