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
|
package FS::cust_tax_exempt_pkg;
use strict;
use vars qw( @ISA );
use FS::Record qw( qsearch qsearchs );
use FS::cust_main_Mixin;
use FS::cust_bill_pkg;
use FS::cust_main_county;
use FS::cust_credit_bill_pkg;
@ISA = qw( FS::cust_main_Mixin FS::Record );
=head1 NAME
FS::cust_tax_exempt_pkg - Object methods for cust_tax_exempt_pkg records
=head1 SYNOPSIS
use FS::cust_tax_exempt_pkg;
$record = new FS::cust_tax_exempt_pkg \%hash;
$record = new FS::cust_tax_exempt_pkg { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::cust_tax_exempt_pkg object represents a record of a customer tax
exemption. Currently this is only used for "texas tax". FS::cust_tax_exempt
inherits from FS::Record. The following fields are currently supported:
=over 4
=item exemptpkgnum - primary key
=item billpkgnum - invoice line item (see L<FS::cust_bill_pkg>)
=item taxnum - tax rate (see L<FS::cust_main_county>)
=item year
=item month
=item amount
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new exemption record. To add the examption 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
# the new method can be inherited from FS::Record, if a table method is defined
sub table { 'cust_tax_exempt_pkg'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=cut
# the insert method can be inherited from FS::Record
=item delete
Delete this record from the database.
=cut
# the delete method can be inherited from FS::Record
=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.
=cut
# the replace method can be inherited from FS::Record
=item check
Checks all fields to make sure this is a valid exemption 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;
$self->ut_numbern('exemptnum')
# || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
|| $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum')
|| $self->ut_foreign_key('taxnum', 'cust_main_county', 'taxnum')
|| $self->ut_foreign_keyn('creditbillpkgnum',
'cust_credit_bill_pkg',
'creditbillpkgnum')
|| $self->ut_number('year') #check better
|| $self->ut_number('month') #check better
|| $self->ut_money('amount')
|| $self->SUPER::check
;
}
=item cust_main_county
Returns the associated tax definition if it still exists in the database.
Otherwise returns false.
=cut
sub cust_main_county {
my $self = shift;
qsearchs( 'cust_main_county', { 'taxnum', $self->taxnum } );
}
=back
=head1 BUGS
Texas tax is still a royal pain in the ass.
=head1 SEE ALSO
L<FS::cust_main_county>, L<FS::cust_bill_pkg>, L<FS::Record>, schema.html from
the base documentation.
=cut
1;
|
