1 package FS::cust_tax_exempt_pkg;
5 use FS::Record qw( qsearch qsearchs );
6 use FS::cust_main_Mixin;
8 use FS::cust_main_county;
9 use FS::cust_credit_bill_pkg;
11 @ISA = qw( FS::cust_main_Mixin FS::Record );
15 FS::cust_tax_exempt_pkg - Object methods for cust_tax_exempt_pkg records
19 use FS::cust_tax_exempt_pkg;
21 $record = new FS::cust_tax_exempt_pkg \%hash;
22 $record = new FS::cust_tax_exempt_pkg { 'column' => 'value' };
24 $error = $record->insert;
26 $error = $new_record->replace($old_record);
28 $error = $record->delete;
30 $error = $record->check;
34 An FS::cust_tax_exempt_pkg object represents a record of a customer tax
35 exemption. Currently this is only used for "texas tax". FS::cust_tax_exempt
36 inherits from FS::Record. The following fields are currently supported:
40 =item exemptpkgnum - primary key
42 =item billpkgnum - invoice line item (see L<FS::cust_bill_pkg>)
44 =item taxnum - tax rate (see L<FS::cust_main_county>)
60 Creates a new exemption record. To add the examption record to the database,
63 Note that this stores the hash reference, not a distinct copy of the hash it
64 points to. You can ask the object for a copy with the I<hash> method.
68 # the new method can be inherited from FS::Record, if a table method is defined
70 sub table { 'cust_tax_exempt_pkg'; }
74 Adds this record to the database. If there is an error, returns the error,
75 otherwise returns false.
79 # the insert method can be inherited from FS::Record
83 Delete this record from the database.
87 # the delete method can be inherited from FS::Record
89 =item replace OLD_RECORD
91 Replaces the OLD_RECORD with this one in the database. If there is an error,
92 returns the error, otherwise returns false.
96 # the replace method can be inherited from FS::Record
100 Checks all fields to make sure this is a valid exemption record. If there is
101 an error, returns the error, otherwise returns false. Called by the insert
106 # the check method should currently be supplied - FS::Record contains some
107 # data checking routines
112 $self->ut_numbern('exemptnum')
113 # || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
114 || $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum')
115 || $self->ut_foreign_key('taxnum', 'cust_main_county', 'taxnum')
116 || $self->ut_foreign_keyn('creditbillpkgnum',
117 'cust_credit_bill_pkg',
119 || $self->ut_number('year') #check better
120 || $self->ut_number('month') #check better
121 || $self->ut_money('amount')
122 || $self->SUPER::check
126 =item cust_main_county
128 Returns the associated tax definition if it still exists in the database.
129 Otherwise returns false.
133 sub cust_main_county {
135 qsearchs( 'cust_main_county', { 'taxnum', $self->taxnum } );
142 Texas tax is still a royal pain in the ass.
146 L<FS::cust_main_county>, L<FS::cust_bill_pkg>, L<FS::Record>, schema.html from
147 the base documentation.