1 package FS::cust_bill_pkg_tax_location;
4 use base qw( FS::Record );
5 use FS::Record qw( qsearch qsearchs );
9 use FS::cust_bill_pay_pkg;
10 use FS::cust_credit_bill_pkg;
11 use FS::cust_main_county;
15 FS::cust_bill_pkg_tax_location - Object methods for cust_bill_pkg_tax_location records
19 use FS::cust_bill_pkg_tax_location;
21 $record = new FS::cust_bill_pkg_tax_location \%hash;
22 $record = new FS::cust_bill_pkg_tax_location { '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_bill_pkg_tax_location object represents an record of taxation
35 based on package location. FS::cust_bill_pkg_tax_location inherits from
36 FS::Record. The following fields are currently supported:
40 =item billpkgtaxlocationnum
77 Creates a new record. To add the record to the database, see L<"insert">.
79 Note that this stores the hash reference, not a distinct copy of the hash it
80 points to. You can ask the object for a copy with the I<hash> method.
84 sub table { 'cust_bill_pkg_tax_location'; }
88 Adds this record to the database. If there is an error, returns the error,
89 otherwise returns false.
93 Delete this record from the database.
95 =item replace OLD_RECORD
97 Replaces the OLD_RECORD with this one in the database. If there is an error,
98 returns the error, otherwise returns false.
102 Checks all fields to make sure this is a valid record. If there is
103 an error, returns the error, otherwise returns false. Called by the insert
108 # the check method should currently be supplied - FS::Record contains some
109 # data checking routines
115 $self->ut_numbern('billpkgtaxlocationnum')
116 || $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum' )
117 || $self->ut_number('taxnum') #cust_bill_pkg/tax_rate key, based on taxtype
118 || $self->ut_enum('taxtype', [ qw( FS::cust_main_county FS::tax_rate ) ] )
119 || $self->ut_foreign_key('pkgnum', 'cust_pkg', 'pkgnum' )
120 || $self->ut_foreign_key('locationnum', 'cust_location', 'locationnum' )
121 || $self->ut_money('amount')
123 return $error if $error;
130 Returns the associated cust_bill_pkg object
136 qsearchs( 'cust_bill_pkg', { 'billpkgnum' => $self->billpkgnum } );
141 Returns the associated cust_location object
147 qsearchs( 'cust_location', { 'locationnum' => $self->locationnum } );
152 Returns a description for this tax line item constituent. Currently this
153 is the desc of the associated line item followed by the state/county/city
154 for the location in parentheses.
160 my $cust_location = $self->cust_location;
161 my $location = join('/', grep { $_ } # leave in?
162 map { $cust_location->$_ }
163 qw( state county city ) # country?
165 my $cust_bill_pkg_desc = $self->billpkgnum
166 ? $self->cust_bill_pkg->desc
167 : $self->cust_bill_pkg_desc;
168 "$cust_bill_pkg_desc ($location)";
173 Returns the amount owed (still outstanding) on this tax line item which is
174 the amount of this record minus all payment applications and credit
181 my $balance = $self->amount;
182 $balance -= $_->amount foreach ( $self->cust_bill_pay_pkg('setup') );
183 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg('setup') );
184 $balance = sprintf( '%.2f', $balance );
185 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
189 sub cust_bill_pay_pkg {
191 qsearch( 'cust_bill_pay_pkg',
192 { map { $_ => $self->$_ } qw( billpkgtaxlocationnum billpkgnum ) }
196 sub cust_credit_bill_pkg {
198 qsearch( 'cust_credit_bill_pkg',
199 { map { $_ => $self->$_ } qw( billpkgtaxlocationnum billpkgnum ) }
203 sub cust_main_county {
206 if ( $self->taxtype eq 'FS::cust_main_county' ) {
207 $result = qsearchs( 'cust_main_county', { 'taxnum' => $self->taxnum } );
215 The presense of FS::cust_main_county::delete makes the cust_main_county method
220 L<FS::Record>, schema.html from the base documentation.