1 package FS::cust_bill_pkg_tax_rate_location;
2 use base qw( FS::Record );
5 use FS::Record qw( qsearch qsearchs );
7 use FS::cust_bill_pay_pkg;
8 use FS::cust_credit_bill_pkg;
12 FS::cust_bill_pkg_tax_rate_location - Object methods for cust_bill_pkg_tax_rate_location records
16 use FS::cust_bill_pkg_tax_rate_location;
18 $record = new FS::cust_bill_pkg_tax_rate_location \%hash;
19 $record = new FS::cust_bill_pkg_tax_rate_location { 'column' => 'value' };
21 $error = $record->insert;
23 $error = $new_record->replace($old_record);
25 $error = $record->delete;
27 $error = $record->check;
31 An FS::cust_bill_pkg_tax_rate_location object represents an record of taxation
32 based on package location. FS::cust_bill_pkg_tax_rate_location inherits from
33 FS::Record. The following fields are currently supported:
37 =item billpkgtaxratelocationnum
39 billpkgtaxratelocationnum
57 =item taxratelocationnum
74 Creates a new record. To add the record to the database, see L<"insert">.
76 Note that this stores the hash reference, not a distinct copy of the hash it
77 points to. You can ask the object for a copy with the I<hash> method.
81 sub table { 'cust_bill_pkg_tax_rate_location'; }
85 Adds this record to the database. If there is an error, returns the error,
86 otherwise returns false.
90 Delete this record from the database.
92 =item replace OLD_RECORD
94 Replaces the OLD_RECORD with this one in the database. If there is an error,
95 returns the error, otherwise returns false.
99 Checks all fields to make sure this is a valid record. If there is
100 an error, returns the error, otherwise returns false. Called by the insert
105 # the check method should currently be supplied - FS::Record contains some
106 # data checking routines
112 $self->ut_numbern('billpkgtaxratelocationnum')
113 || $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum' )
114 || $self->ut_number('taxnum') #cust_bill_pkg/tax_rate key, based on taxtype
115 || $self->ut_enum('taxtype', [ qw( FS::cust_main_county FS::tax_rate ) ] )
116 || $self->ut_textn('locationtaxid')
117 || $self->ut_foreign_key('taxratelocationnum', 'tax_rate_location', 'taxratelocationnum' )
118 || $self->ut_money('amount')
120 return $error if $error;
127 Returns the associated cust_bill_pkg object
129 =item tax_rate_location
131 Returns the associated tax_rate_location object
135 Returns a description for this tax line item constituent. Currently this
136 is the desc of the associated line item followed by the
137 state,county,city,locationtaxid for the location in parentheses.
143 my $tax_rate_location = $self->tax_rate_location;
144 my $location = join(', ', grep { $_ }
145 map { $tax_rate_location->$_ }
146 qw( state county city )
148 $location .= ( $location && $self->locationtaxid ) ? ', ' : '';
149 $location .= $self->locationtaxid;
150 my $cust_bill_pkg_desc = $self->billpkgnum
151 ? $self->cust_bill_pkg->desc
152 : $self->cust_bill_pkg_desc;
153 "$cust_bill_pkg_desc ($location)";
160 Returns the amount owed (still outstanding) on this tax line item which is
161 the amount of this record minus all payment applications and credit
168 my $balance = $self->amount;
169 $balance -= $_->amount foreach ( $self->cust_bill_pay_pkg('setup') );
170 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg('setup') );
171 $balance = sprintf( '%.2f', $balance );
172 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
176 sub cust_bill_pay_pkg {
178 qsearch( 'cust_bill_pay_pkg', { map { $_ => $self->$_ }
179 qw( billpkgtaxratelocationnum billpkgnum )
184 sub cust_credit_bill_pkg {
186 qsearch( 'cust_credit_bill_pkg', { map { $_ => $self->$_ }
187 qw( billpkgtaxratelocationnum billpkgnum )
198 L<FS::Record>, schema.html from the base documentation.