FS/FS/part_pkg_taxrate.pm

   1 package FS::part_pkg_taxrate;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use Date::Parse;
   6 use FS::UID qw(dbh);
   7 use FS::Record qw( qsearch qsearchs );
   8 use FS::part_pkg_taxproduct;
   9
  10 @ISA = qw(FS::Record);
  11
  12 =head1 NAME
  13
  14 FS::part_pkg_taxrate - Object methods for part_pkg_taxrate records
  15
  16 =head1 SYNOPSIS
  17
  18   use FS::part_pkg_taxrate;
  19
  20   $record = new FS::part_pkg_taxrate \%hash;
  21   $record = new FS::part_pkg_taxrate { 'column' => 'value' };
  22
  23   $error = $record->insert;
  24
  25   $error = $new_record->replace($old_record);
  26
  27   $error = $record->delete;
  28
  29   $error = $record->check;
  30
  31 =head1 DESCRIPTION
  32
  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
  35 currently supported:
  36
  37 =over 4
  38
  39 =item pkgtaxratenum
  40
  41 Primary key
  42
  43 =item data_vendor
  44
  45 Tax data vendor
  46
  47 =item geocode
  48
  49 Tax vendor location code
  50
  51 =item taxproductnum
  52
  53 Class of package for tax purposes, Index into FS::part_pkg_taxproduct
  54
  55 =item city
  56
  57 city
  58
  59 =item county
  60
  61 county
  62
  63 =item state
  64
  65 state
  66
  67 =item local
  68
  69 local
  70
  71 =item country
  72
  73 country
  74
  75 =item taxclassnum
  76
  77 Class of tax index into FS::tax_taxclass and FS::tax_rate
  78
  79 =item taxclassnumtaxed
  80
  81 Class of tax taxed by this entry.
  82
  83 =item taxable
  84
  85 taxable
  86
  87 =item effdate
  88
  89 effdate
  90
  91 =back
  92
  93 =head1 METHODS
  94
  95 =over 4
  96
  97 =item new HASHREF
  98
  99 Creates a new customer (location), package, tax rate mapping.  To add the
 100 mapping to the database, see L<"insert">.
 101
 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.
 104
 105 =cut
 106
 107 sub table { 'part_pkg_taxrate'; }
 108
 109 =item insert
 110
 111 Adds this record to the database.  If there is an error, returns the error,
 112 otherwise returns false.
 113
 114 =cut
 115
 116 =item delete
 117
 118 Delete this record from the database.
 119
 120 =cut
 121
 122 =item replace OLD_RECORD
 123
 124 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 125 returns the error, otherwise returns false.
 126
 127 =cut
 128
 129 =item check
 130
 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
 133 and replace methods.
 134
 135 =cut
 136
 137 sub check {
 138   my $self = shift;
 139
 140   my $error =
 141     $self->ut_numbern('pkgtaxratenum')
 142     || $self->ut_textn('data_vendor')
 143     || $self->ut_textn('geocode')
 144     || $self->
 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_numbern('effective_date')
 154     || $self->ut_enum('taxable', [ 'Y', '' ])
 155   ;
 156   return $error if $error;
 157
 158   $self->SUPER::check;
 159 }
 160
 161 =item batch_import
 162
 163 Loads part_pkg_taxrate records from an external CSV file.  If there is
 164 an error, returns the error, otherwise returns false.
 165
 166 =cut
 167
 168 sub batch_import {
 169   my $param = shift;
 170
 171   my $fh = $param->{filehandle};
 172   my $format = $param->{'format'};
 173
 174   my @fields;
 175   my $hook;
 176   if ( $format eq 'cch' ) {
 177     @fields = qw( city county state local geocode group groupdesc item
 178                   itemdesc provider customer taxtypetaxed taxcattaxed
 179                   taxable taxtype taxcat effdate rectype );
 180
 181     $hook = sub {
 182       my $hash = shift;
 183
 184       unless ( $hash->{'rectype'} eq 'R' or $hash->{'rectype'} eq 'T' ) {
 185         delete($hash->{$_}) for (keys %$hash);
 186         return;
 187       }
 188
 189       my %providers = ( '00' => 'Regulated LEC',
 190                         '01' => 'Regulated IXC',
 191                         '02' => 'Unregulated LEC',
 192                         '03' => 'Unregulated IXC',
 193                         '04' => 'ISP',
 194                         '05' => 'Wireless',
 195                       );
 196
 197       my %customers = ( '00' => 'Residential',
 198                         '01' => 'Commercial',
 199                         '02' => 'Industrial',
 200                         '09' => 'Lifeline',
 201                         '10' => 'Senior Citizen',
 202                       );
 203
 204       my $taxproduct =
 205         join(':', map{ $hash->{$_} } qw(group item provider customer ) );
 206
 207       my %part_pkg_taxproduct = ( 'data_vendor' => 'cch',
 208                                   'taxproduct' => $taxproduct,
 209                                 );
 210
 211       my $part_pkg_taxproduct = qsearchs( 'part_pkg_taxproduct',
 212                                           { %part_pkg_taxproduct }
 213                                         );
 214
 215       unless ($part_pkg_taxproduct) {
 216         $part_pkg_taxproduct{'description'} =
 217           join(' : ', (map{ $hash->{$_} } qw(groupdesc itemdesc)),
 218                       $providers{$hash->{'provider'}},
 219                       $customers{$hash->{'customer'}},
 220               );
 221         $part_pkg_taxproduct = new FS::part_pkg_taxproduct \%part_pkg_taxproduct;
 222         my $error = $part_pkg_taxproduct->insert;
 223         return "Error inserting tax product (part_pkg_taxproduct): $error"
 224           if $error;
 225
 226       }
 227       $hash->{'taxproductnum'} = $part_pkg_taxproduct->taxproductnum;
 228
 229       delete($hash->{$_})
 230         for qw(group groupdesc item itemdesc provider customer rectype );
 231
 232       my %map = ( 'taxclassnum'      => [ 'taxtype', 'taxcat' ],
 233                   'taxclassnumtaxed' => [ 'taxtypetaxed', 'taxcattaxed' ],
 234                 );
 235
 236       for my $item (keys %map) {
 237         my $tax_class =
 238           qsearchs( 'tax_class',
 239                     { data_vendor => 'cch',
 240                       'taxclass' => join(':', map($hash->{$_}, @{$map{$item}})),
 241                     }
 242                   );
 243         $hash->{$item} = $tax_class->taxclassnum
 244           if $tax_class;
 245
 246         delete($hash->{$_}) foreach @{$map{$item}};
 247       }
 248
 249       $hash->{'effdate'} = str2time($hash->{'effdate'});
 250
 251       $hash->{'effdate'} = str2time($hash->{'effdate'});
 252       $hash->{'country'} = 'US'; # CA is available
 253
 254       delete($hash->{'taxable'}) if ($hash->{'taxable'} eq 'N');
 255
 256       '';
 257     };
 258
 259   } elsif ( $format eq 'extended' ) {
 260     die "unimplemented\n";
 261     @fields = qw( );
 262     $hook = sub {};
 263   } else {
 264     die "unknown format $format";
 265   }
 266
 267   eval "use Text::CSV_XS;";
 268   die $@ if $@;
 269
 270   my $csv = new Text::CSV_XS;
 271
 272   my $imported = 0;
 273
 274   local $SIG{HUP} = 'IGNORE';
 275   local $SIG{INT} = 'IGNORE';
 276   local $SIG{QUIT} = 'IGNORE';
 277   local $SIG{TERM} = 'IGNORE';
 278   local $SIG{TSTP} = 'IGNORE';
 279   local $SIG{PIPE} = 'IGNORE';
 280
 281   my $oldAutoCommit = $FS::UID::AutoCommit;
 282   local $FS::UID::AutoCommit = 0;
 283   my $dbh = dbh;
 284
 285   my $line;
 286   while ( defined($line=<$fh>) ) {
 287     $csv->parse($line) or do {
 288       $dbh->rollback if $oldAutoCommit;
 289       return "can't parse: ". $csv->error_input();
 290     };
 291
 292     my @columns = $csv->fields();
 293
 294     my %part_pkg_taxrate = ( 'data_vendor' => $format );
 295     foreach my $field ( @fields ) {
 296       $part_pkg_taxrate{$field} = shift @columns;
 297     }
 298     my $error = &{$hook}(\%part_pkg_taxrate);
 299     if ( $error ) {
 300       $dbh->rollback if $oldAutoCommit;
 301       return $error;
 302     }
 303     next unless scalar(keys %part_pkg_taxrate);
 304
 305
 306     my $part_pkg_taxrate = new FS::part_pkg_taxrate( \%part_pkg_taxrate );
 307     $error = $part_pkg_taxrate->insert;
 308
 309     if ( $error ) {
 310       $dbh->rollback if $oldAutoCommit;
 311       return "can't insert part_pkg_taxrate for $line: $error";
 312     }
 313
 314     $imported++;
 315   }
 316
 317   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 318
 319   return "Empty file!" unless $imported;
 320
 321   ''; #no error
 322
 323 }
 324
 325 =back
 326
 327 =head1 BUGS
 328
 329 =head1 SEE ALSO
 330
 331 L<FS::Record>, schema.html from the base documentation.
 332
 333 =cut
 334
 335 1;
 336
 337