1 package FS::part_pkg_taxrate;
7 use FS::Record qw( qsearch qsearchs );
8 use FS::part_pkg_taxproduct;
10 @ISA = qw(FS::Record);
14 FS::part_pkg_taxrate - Object methods for part_pkg_taxrate records
18 use FS::part_pkg_taxrate;
20 $record = new FS::part_pkg_taxrate \%hash;
21 $record = new FS::part_pkg_taxrate { 'column' => 'value' };
23 $error = $record->insert;
25 $error = $new_record->replace($old_record);
27 $error = $record->delete;
29 $error = $record->check;
33 An FS::part_pkg_taxrate object maps packages onto tax rates.
34 FS::part_pkg_taxrate inherits from FS::Record. The following fields are
49 Tax vendor location code
53 Class of package for tax purposes, Index into FS::part_pkg_taxproduct
77 Class of tax index into FS::tax_taxclass and FS::tax_rate
79 =item taxclassnumtaxed
81 Class of tax taxed by this entry.
99 Creates a new customer (location), package, tax rate mapping. To add the
100 mapping to the database, see L<"insert">.
102 Note that this stores the hash reference, not a distinct copy of the hash it
103 points to. You can ask the object for a copy with the I<hash> method.
107 sub table { 'part_pkg_taxrate'; }
111 Adds this record to the database. If there is an error, returns the error,
112 otherwise returns false.
118 Delete this record from the database.
122 =item replace OLD_RECORD
124 Replaces the OLD_RECORD with this one in the database. If there is an error,
125 returns the error, otherwise returns false.
131 Checks all fields to make sure this is a valid tax rate mapping. If there is
132 an error, returns the error, otherwise returns false. Called by the insert
141 $self->ut_numbern('pkgtaxratenum')
142 || $self->ut_textn('data_vendor')
143 || $self->ut_textn('geocode')
145 ut_foreign_key('taxproductnum', 'part_pkg_taxproduct', 'taxproductnum')
146 || $self->ut_textn('city')
147 || $self->ut_textn('county')
148 || $self->ut_textn('state')
149 || $self->ut_textn('local')
150 || $self->ut_text('country')
151 || $self->ut_foreign_keyn('taxclassnumtaxed', 'tax_class', 'taxclassnum')
152 || $self->ut_foreign_key('taxclassnum', 'tax_class', 'taxclassnum')
153 || $self->ut_snumbern('effdate')
154 || $self->ut_enum('taxable', [ 'Y', '' ])
156 return $error if $error;
163 Loads part_pkg_taxrate records from an external CSV file. If there is
164 an error, returns the error, otherwise returns false.
169 my ($param, $job) = @_;
171 my $fh = $param->{filehandle};
172 my $format = $param->{'format'};
179 my ( $count, $last, $min_sec ) = (0, time, 5); #progressbar
182 while ( defined($line=<$fh>) );
186 if ( $format eq 'cch' || $format eq 'cch-update' ) {
187 @fields = qw( city county state local geocode group groupdesc item
188 itemdesc provider customer taxtypetaxed taxcattaxed
189 taxable taxtype taxcat effdate rectype );
190 push @fields, 'actionflag' if $format eq 'cch-update';
192 $imported++ if $format eq 'cch-update'; #empty file ok
197 unless ( $hash->{'rectype'} eq 'R' or $hash->{'rectype'} eq 'T' ) {
198 delete($hash->{$_}) for (keys %$hash);
202 $hash->{'data_vendor'} = 'cch';
204 my %providers = ( '00' => 'Regulated LEC',
205 '01' => 'Regulated IXC',
206 '02' => 'Unregulated LEC',
207 '03' => 'Unregulated IXC',
212 my %customers = ( '00' => 'Residential',
213 '01' => 'Commercial',
214 '02' => 'Industrial',
216 '10' => 'Senior Citizen',
220 join(':', map{ $hash->{$_} } qw(group item provider customer ) );
222 my %part_pkg_taxproduct = ( 'data_vendor' => 'cch',
223 'taxproduct' => $taxproduct,
226 my $part_pkg_taxproduct = qsearchs( 'part_pkg_taxproduct',
227 { %part_pkg_taxproduct }
230 unless ($part_pkg_taxproduct) {
231 return "Can't find part_pkg_taxproduct for txmatrix deletion: ".
232 join(" ", map { "$_ => ". $hash->{$_} } @fields)
233 if $hash->{'actionflag'} eq 'D';
235 $part_pkg_taxproduct{'description'} =
236 join(' : ', (map{ $hash->{$_} } qw(groupdesc itemdesc)),
237 $providers{$hash->{'provider'}},
238 $customers{$hash->{'customer'}},
240 $part_pkg_taxproduct = new FS::part_pkg_taxproduct \%part_pkg_taxproduct;
241 my $error = $part_pkg_taxproduct->insert;
242 return "Error inserting tax product (part_pkg_taxproduct): $error"
246 $hash->{'taxproductnum'} = $part_pkg_taxproduct->taxproductnum;
249 for qw(group groupdesc item itemdesc provider customer rectype );
251 my %map = ( 'taxclassnum' => [ 'taxtype', 'taxcat' ],
252 'taxclassnumtaxed' => [ 'taxtypetaxed', 'taxcattaxed' ],
255 for my $item (keys %map) {
256 my $class = join(':', map($hash->{$_}, @{$map{$item}}));
258 qsearchs( 'tax_class',
259 { data_vendor => 'cch',
260 'taxclass' => $class,
263 $hash->{$item} = $tax_class->taxclassnum
266 return "Can't find tax class for txmatrix deletion: ".
267 join(" ", map { "$_ => ". $hash->{$_} } @fields)
268 if ($hash->{'actionflag'} eq 'D' && !$tax_class && $class ne ':');
270 delete($hash->{$_}) foreach @{$map{$item}};
273 $hash->{'effdate'} = str2time($hash->{'effdate'});
274 $hash->{'country'} = 'US'; # CA is available
276 delete($hash->{'taxable'}) if ($hash->{'taxable'} eq 'N');
278 if (exists($hash->{actionflag}) && $hash->{actionflag} eq 'D') {
279 delete($hash->{actionflag});
281 my $part_pkg_taxrate = qsearchs('part_pkg_taxrate', $hash);
282 return "Can't find part_pkg_taxrate to delete: ".
283 #join(" ", map { "$_ => ". $hash->{$_} } @fields)
284 join(" ", map { "$_ => *". $hash->{$_}. '*' } keys(%$hash) )
285 unless $part_pkg_taxrate;
287 my $error = $part_pkg_taxrate->delete;
288 return $error if $error;
290 delete($hash->{$_}) foreach (keys %$hash);
293 delete($hash->{actionflag});
298 } elsif ( $format eq 'extended' ) {
299 die "unimplemented\n";
303 die "unknown format $format";
306 eval "use Text::CSV_XS;";
309 my $csv = new Text::CSV_XS;
311 local $SIG{HUP} = 'IGNORE';
312 local $SIG{INT} = 'IGNORE';
313 local $SIG{QUIT} = 'IGNORE';
314 local $SIG{TERM} = 'IGNORE';
315 local $SIG{TSTP} = 'IGNORE';
316 local $SIG{PIPE} = 'IGNORE';
318 my $oldAutoCommit = $FS::UID::AutoCommit;
319 local $FS::UID::AutoCommit = 0;
322 while ( defined($line=<$fh>) ) {
323 $csv->parse($line) or do {
324 $dbh->rollback if $oldAutoCommit;
325 return "can't parse: ". $csv->error_input();
329 if ( $job ) { # progress bar
330 if ( time - $min_sec > $last ) {
331 my $error = $job->update_statustext(
332 int( 100 * $imported / $count )
334 die $error if $error;
339 my @columns = $csv->fields();
341 my %part_pkg_taxrate = ( 'data_vendor' => $format );
342 foreach my $field ( @fields ) {
343 $part_pkg_taxrate{$field} = shift @columns;
345 if ( scalar( @columns ) ) {
346 $dbh->rollback if $oldAutoCommit;
347 return "Unexpected trailing columns in line (wrong format?): $line";
350 my $error = &{$hook}(\%part_pkg_taxrate);
352 $dbh->rollback if $oldAutoCommit;
355 next unless scalar(keys %part_pkg_taxrate);
358 my $part_pkg_taxrate = new FS::part_pkg_taxrate( \%part_pkg_taxrate );
359 $error = $part_pkg_taxrate->insert;
362 $dbh->rollback if $oldAutoCommit;
363 return "can't insert part_pkg_taxrate for $line: $error";
369 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
371 return "Empty file!" unless $imported;
383 L<FS::Record>, schema.html from the base documentation.