FS/FS/cust_main_county.pm

   1 package FS::cust_main_county;
   2
   3 use strict;
   4 use vars qw( @ISA @EXPORT_OK $conf
   5              @cust_main_county %cust_main_county $countyflag ); # $cityflag );
   6 use Exporter;
   7 use FS::Record qw( qsearch qsearchs dbh );
   8 use FS::cust_bill_pkg;
   9 use FS::cust_bill;
  10 use FS::cust_pkg;
  11 use FS::part_pkg;
  12 use FS::cust_tax_exempt;
  13 use FS::cust_tax_exempt_pkg;
  14
  15 @ISA = qw( FS::Record );
  16 @EXPORT_OK = qw( regionselector );
  17
  18 @cust_main_county = ();
  19 $countyflag = '';
  20 #$cityflag = '';
  21
  22 #ask FS::UID to run this stuff for us later
  23 $FS::UID::callback{'FS::cust_main_county'} = sub {
  24   $conf = new FS::Conf;
  25 };
  26
  27 =head1 NAME
  28
  29 FS::cust_main_county - Object methods for cust_main_county objects
  30
  31 =head1 SYNOPSIS
  32
  33   use FS::cust_main_county;
  34
  35   $record = new FS::cust_main_county \%hash;
  36   $record = new FS::cust_main_county { 'column' => 'value' };
  37
  38   $error = $record->insert;
  39
  40   $error = $new_record->replace($old_record);
  41
  42   $error = $record->delete;
  43
  44   $error = $record->check;
  45
  46   ($county_html, $state_html, $country_html) =
  47     FS::cust_main_county::regionselector( $county, $state, $country );
  48
  49 =head1 DESCRIPTION
  50
  51 An FS::cust_main_county object represents a tax rate, defined by locale.
  52 FS::cust_main_county inherits from FS::Record.  The following fields are
  53 currently supported:
  54
  55 =over 4
  56
  57 =item taxnum - primary key (assigned automatically for new tax rates)
  58
  59 =item district - tax district (optional)
  60
  61 =item city
  62
  63 =item county
  64
  65 =item state
  66
  67 =item country
  68
  69 =item tax - percentage
  70
  71 =item taxclass
  72
  73 =item exempt_amount
  74
  75 =item taxname - if defined, printed on invoices instead of "Tax"
  76
  77 =item setuptax - if 'Y', this tax does not apply to setup fees
  78
  79 =item recurtax - if 'Y', this tax does not apply to recurring fees
  80
  81 =back
  82
  83 =head1 METHODS
  84
  85 =over 4
  86
  87 =item new HASHREF
  88
  89 Creates a new tax rate.  To add the tax rate to the database, see L<"insert">.
  90
  91 =cut
  92
  93 sub table { 'cust_main_county'; }
  94
  95 =item insert
  96
  97 Adds this tax rate to the database.  If there is an error, returns the error,
  98 otherwise returns false.
  99
 100 =item delete
 101
 102 Deletes this tax rate from the database.  If there is an error, returns the
 103 error, otherwise returns false.
 104
 105 =item replace OLD_RECORD
 106
 107 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 108 returns the error, otherwise returns false.
 109
 110 =item check
 111
 112 Checks all fields to make sure this is a valid tax rate.  If there is an error,
 113 returns the error, otherwise returns false.  Called by the insert and replace
 114 methods.
 115
 116 =cut
 117
 118 sub check {
 119   my $self = shift;
 120
 121   $self->exempt_amount(0) unless $self->exempt_amount;
 122
 123   $self->ut_numbern('taxnum')
 124     || $self->ut_alphan('district')
 125     || $self->ut_textn('city')
 126     || $self->ut_textn('county')
 127     || $self->ut_anything('state')
 128     || $self->ut_text('country')
 129     || $self->ut_float('tax')
 130     || $self->ut_textn('taxclass') # ...
 131     || $self->ut_money('exempt_amount')
 132     || $self->ut_textn('taxname')
 133     || $self->ut_enum('setuptax', [ '', 'Y' ] )
 134     || $self->ut_enum('recurtax', [ '', 'Y' ] )
 135     || $self->SUPER::check
 136     ;
 137
 138 }
 139
 140 =item label OPTIONS
 141
 142 Returns a label looking like "Anytown, Alameda County, CA, US".
 143
 144 If the taxname field is set, it will look like
 145 "CA Sales Tax (Anytown, Alameda County, CA, US)".
 146
 147 If the taxclass is set, then it will be
 148 "Anytown, Alameda County, CA, US (International)".
 149
 150 OPTIONS may contain "with_taxclass", "with_city", and "with_district" to show
 151 those fields.  It may also contain "out", in which case, if this region
 152 (district+city+county+state+country) contains no non-zero taxes, the label
 153 will read "Out of taxable region(s)".
 154
 155 =cut
 156
 157 sub label {
 158   my ($self, %opt) = @_;
 159   if ( $opt{'out'}
 160        and $self->tax == 0
 161        and !defined(qsearchs('cust_main_county', {
 162            'district' => $self->district,
 163            'city'     => $self->city,
 164            'county'   => $self->county,
 165            'state'    => $self->state,
 166            'country'  => $self->country,
 167            'tax'  => { op => '>', value => 0 },
 168         })) )
 169   {
 170     return 'Out of taxable region(s)';
 171   }
 172   my $label = $self->country;
 173   $label = $self->state.", $label" if $self->state;
 174   $label = $self->county." County, $label" if $self->county;
 175   if ($opt{with_city}) {
 176     $label = $self->city.", $label" if $self->city;
 177     if ($opt{with_district} and $self->district) {
 178       $label = $self->district . ", $label";
 179     }
 180   }
 181   # ugly labels when taxclass and taxname are both non-null...
 182   # but this is how the tax report does it
 183   if ($opt{with_taxclass}) {
 184     $label = "$label (".$self->taxclass.')' if $self->taxclass;
 185   }
 186   $label = $self->taxname." ($label)" if $self->taxname;
 187
 188   $label;
 189 }
 190
 191 =item sql_taxclass_sameregion
 192
 193 Returns an SQL WHERE fragment or the empty string to search for entries
 194 with different tax classes.
 195
 196 =cut
 197
 198 #hmm, description above could be better...
 199
 200 sub sql_taxclass_sameregion {
 201   my $self = shift;
 202
 203   my $same_query = 'SELECT DISTINCT taxclass FROM cust_main_county '.
 204                    ' WHERE taxnum != ? AND country = ?';
 205   my @same_param = ( 'taxnum', 'country' );
 206   foreach my $opt_field (qw( state county )) {
 207     if ( $self->$opt_field() ) {
 208       $same_query .= " AND $opt_field = ?";
 209       push @same_param, $opt_field;
 210     } else {
 211       $same_query .= " AND $opt_field IS NULL";
 212     }
 213   }
 214
 215   my @taxclasses = $self->_list_sql( \@same_param, $same_query );
 216
 217   return '' unless scalar(@taxclasses);
 218
 219   '( taxclass IS NULL OR ( '.  #only if !$self->taxclass ??
 220      join(' AND ', map { 'taxclass != '.dbh->quote($_) } @taxclasses ).
 221   ' ) ) ';
 222 }
 223
 224 sub _list_sql {
 225   my( $self, $param, $sql ) = @_;
 226   my $sth = dbh->prepare($sql) or die dbh->errstr;
 227   $sth->execute( map $self->$_(), @$param )
 228     or die "Unexpected error executing statement $sql: ". $sth->errstr;
 229   map $_->[0], @{ $sth->fetchall_arrayref };
 230 }
 231
 232 =item taxline TAXABLES_ARRAYREF, [ OPTION => VALUE ... ]
 233
 234 Takes an arrayref of L<FS::cust_bill_pkg> objects representing taxable
 235 line items, and returns a new L<FS::cust_bill_pkg> object representing
 236 the tax on them under this tax rate.
 237
 238 This will have a pseudo-field, "cust_bill_pkg_tax_location", containing
 239 an arrayref of L<FS::cust_bill_pkg_tax_location> objects.  Each of these
 240 will in turn have a "taxable_cust_bill_pkg" pseudo-field linking it to one
 241 of the taxable items.  All of these links must be resolved as the objects
 242 are inserted.
 243
 244 Options may include 'custnum' and 'invoice_time' in case the cust_bill_pkg
 245 objects belong to an invoice that hasn't been inserted yet.
 246
 247 Options may include 'exemptions', an arrayref of L<FS::cust_tax_exempt_pkg>
 248 objects belonging to the same customer, to be counted against the monthly
 249 tax exemption limit if there is one.
 250
 251 =cut
 252
 253 # XXX change tax_rate.pm to work like this
 254
 255 sub taxline {
 256   my( $self, $taxables, %opt ) = @_;
 257   $taxables = [ $taxables ] unless ref($taxables) eq 'ARRAY';
 258   # remove any charge class identifiers; they're not supported here
 259   @$taxables = grep { ref $_ } @$taxables;
 260
 261   return 'taxline called with no line items' unless @$taxables;
 262
 263   local $SIG{HUP} = 'IGNORE';
 264   local $SIG{INT} = 'IGNORE';
 265   local $SIG{QUIT} = 'IGNORE';
 266   local $SIG{TERM} = 'IGNORE';
 267   local $SIG{TSTP} = 'IGNORE';
 268   local $SIG{PIPE} = 'IGNORE';
 269
 270   my $oldAutoCommit = $FS::UID::AutoCommit;
 271   local $FS::UID::AutoCommit = 0;
 272   my $dbh = dbh;
 273
 274   my $name = $self->taxname || 'Tax';
 275   my $taxable_cents = 0;
 276   my $tax_cents = 0;
 277
 278   my $cust_bill = $taxables->[0]->cust_bill;
 279   my $custnum   = $cust_bill ? $cust_bill->custnum : $opt{'custnum'};
 280   my $invoice_time = $cust_bill ? $cust_bill->_date : $opt{'invoice_time'};
 281   my $cust_main = FS::cust_main->by_key($custnum) if $custnum > 0;
 282   # (to avoid complications with estimated tax on quotations, assume it's
 283   # taxable if there is no customer)
 284   #if (!$cust_main) {
 285     #die "unable to calculate taxes for an unknown customer\n";
 286   #}
 287
 288   # Gather any exemptions that are already attached to these cust_bill_pkgs
 289   # so that we can deduct them from the customer's monthly limit.
 290   my @existing_exemptions = @{ $opt{'exemptions'} };
 291   push @existing_exemptions, @{ $_->cust_tax_exempt_pkg }
 292     for @$taxables;
 293
 294   my $tax_item = FS::cust_bill_pkg->new({
 295       'pkgnum'    => 0,
 296       'recur'     => 0,
 297       'sdate'     => '',
 298       'edate'     => '',
 299       'itemdesc'  => $name,
 300   });
 301   my @tax_location;
 302
 303   foreach my $cust_bill_pkg (@$taxables) {
 304     # careful... may be a cust_bill_pkg or a quotation_pkg
 305
 306     my $taxable_charged = $cust_bill_pkg->setup + $cust_bill_pkg->recur;
 307     foreach ( grep { $_->taxnum == $self->taxnum }
 308               @{ $cust_bill_pkg->cust_tax_exempt_pkg }
 309     ) {
 310       # deal with exemptions that have been set on this line item, and
 311       # pertain to this tax def
 312       $taxable_charged -= $_->amount;
 313     }
 314
 315     # can't determine the tax_locationnum directly for fees; they're not
 316     # yet linked to an invoice
 317     my $locationnum = $cust_bill_pkg->tax_locationnum
 318                    || $cust_main->ship_locationnum;
 319
 320     ### Monthly capped exemptions ###
 321     if ( $self->exempt_amount && $self->exempt_amount > 0
 322       and $taxable_charged > 0
 323       and $cust_main ) {
 324
 325       # XXX monthly exemptions currently don't work on quotations
 326
 327       # If the billing period extends across multiple calendar months,
 328       # there may be several months of exemption available.
 329       my $sdate = $cust_bill_pkg->sdate || $invoice_time;
 330       my $start_month = (localtime($sdate))[4] + 1;
 331       my $start_year  = (localtime($sdate))[5] + 1900;
 332       my $edate = $cust_bill_pkg->edate || $invoice_time;
 333       my $end_month   = (localtime($edate))[4] + 1;
 334       my $end_year    = (localtime($edate))[5] + 1900;
 335
 336       # If the partial last month + partial first month <= one month,
 337       # don't use the exemption in the last month
 338       # (unless the last month is also the first month, e.g. one-time
 339       # charges)
 340       if ( (localtime($sdate))[3] >= (localtime($edate))[3]
 341            and ($start_month != $end_month or $start_year != $end_year)
 342       ) {
 343         $end_month--;
 344         if ( $end_month == 0 ) {
 345           $end_year--;
 346           $end_month = 12;
 347         }
 348       }
 349
 350       # number of months of exemption available
 351       my $freq = ($end_month - $start_month) +
 352                  ($end_year  - $start_year) * 12 +
 353                  1;
 354
 355       # divide equally among all of them
 356       my $permonth = sprintf('%.2f', $taxable_charged / $freq);
 357
 358       #call the whole thing off if this customer has any old
 359       #exemption records...
 360       my @cust_tax_exempt =
 361         qsearch( 'cust_tax_exempt' => { custnum=> $custnum } );
 362       if ( @cust_tax_exempt ) {
 363         $dbh->rollback if $oldAutoCommit;
 364         return
 365           'this customer still has old-style tax exemption records; '.
 366           'run bin/fs-migrate-cust_tax_exempt?';
 367       }
 368
 369       my ($mon, $year) = ($start_month, $start_year);
 370       while ($taxable_charged > 0.005 and
 371              ($year < $end_year or
 372                ($year == $end_year and $mon <= $end_month)
 373              )
 374       ) {
 375
 376         # find the sum of the exemption used by this customer, for this tax,
 377         # in this month
 378         my $sql = "
 379           SELECT SUM(amount)
 380             FROM cust_tax_exempt_pkg
 381               LEFT JOIN cust_bill_pkg USING ( billpkgnum )
 382               LEFT JOIN cust_bill     USING ( invnum     )
 383             WHERE custnum = ?
 384               AND taxnum  = ?
 385               AND year    = ?
 386               AND month   = ?
 387               AND exempt_monthly = 'Y'
 388         ";
 389         my $sth = dbh->prepare($sql) or do {
 390           $dbh->rollback if $oldAutoCommit;
 391           return "fatal: can't lookup existing exemption: ". dbh->errstr;
 392         };
 393         $sth->execute(
 394           $custnum,
 395           $self->taxnum,
 396           $year,
 397           $mon,
 398         ) or do {
 399           $dbh->rollback if $oldAutoCommit;
 400           return "fatal: can't lookup existing exemption: ". dbh->errstr;
 401         };
 402         my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
 403
 404         # add any exemption we're already using for another line item
 405         foreach ( grep { $_->taxnum == $self->taxnum &&
 406                          $_->exempt_monthly eq 'Y'   &&
 407                          $_->month  == $mon          &&
 408                          $_->year   == $year
 409                        } @existing_exemptions
 410                 )
 411         {
 412           $existing_exemption += $_->amount;
 413         }
 414
 415         my $remaining_exemption =
 416           $self->exempt_amount - $existing_exemption;
 417         if ( $remaining_exemption > 0 ) {
 418           my $addl = $remaining_exemption > $permonth
 419             ? $permonth
 420             : $remaining_exemption;
 421           $addl = $taxable_charged if $addl > $taxable_charged;
 422
 423           my $new_exemption =
 424             FS::cust_tax_exempt_pkg->new({
 425               amount          => sprintf('%.2f', $addl),
 426               exempt_monthly  => 'Y',
 427               year            => $year,
 428               month           => $mon,
 429               taxnum          => $self->taxnum,
 430               taxtype         => ref($self)
 431             });
 432           $taxable_charged -= $addl;
 433
 434           # create a record of it
 435           push @{ $cust_bill_pkg->cust_tax_exempt_pkg }, $new_exemption;
 436           # and allow it to be counted against the limit for other packages
 437           push @existing_exemptions, $new_exemption;
 438         }
 439         # if they're using multiple months of exemption for a multi-month
 440         # package, then record the exemptions in separate months
 441         $mon++;
 442         if ( $mon > 12 ) {
 443           $mon -= 12;
 444           $year++;
 445         }
 446
 447       }
 448     } # if exempt_amount and $cust_main
 449
 450     $taxable_charged = sprintf( "%.2f", $taxable_charged);
 451     next if $taxable_charged == 0;
 452
 453     my $this_tax_cents = int($taxable_charged * $self->tax);
 454     my $location = FS::cust_bill_pkg_tax_location->new({
 455         'taxnum'      => $self->taxnum,
 456         'taxtype'     => ref($self),
 457         'cents'       => $this_tax_cents,
 458         'pkgnum'      => $cust_bill_pkg->pkgnum,
 459         'locationnum' => $locationnum,
 460         'taxable_cust_bill_pkg' => $cust_bill_pkg,
 461         'tax_cust_bill_pkg'     => $tax_item,
 462     });
 463     push @tax_location, $location;
 464
 465     $taxable_cents += $taxable_charged;
 466     $tax_cents += $this_tax_cents;
 467   } #foreach $cust_bill_pkg
 468
 469   # now round and distribute
 470   my $extra_cents = sprintf('%.2f', $taxable_cents * $self->tax / 100) * 100
 471                     - $tax_cents;
 472   # make sure we have an integer
 473   $extra_cents = sprintf('%.0f', $extra_cents);
 474   if ( $extra_cents < 0 ) {
 475     die "nonsense extra_cents value $extra_cents";
 476   }
 477   $tax_cents += $extra_cents;
 478   my $i = 0;
 479   foreach (@tax_location) { # can never require more than a single pass, yes?
 480     my $cents = $_->get('cents');
 481     if ( $extra_cents > 0 ) {
 482       $cents++;
 483       $extra_cents--;
 484     }
 485     $_->set('amount', sprintf('%.2f', $cents/100));
 486   }
 487   $tax_item->set('setup' => sprintf('%.2f', $tax_cents / 100));
 488   $tax_item->set('cust_bill_pkg_tax_location', \@tax_location);
 489
 490   return $tax_item;
 491 }
 492
 493 =back
 494
 495 =head1 SUBROUTINES
 496
 497 =over 4
 498
 499 =item regionselector [ COUNTY STATE COUNTRY [ PREFIX [ ONCHANGE [ DISABLED ] ] ] ]
 500
 501 =cut
 502
 503 sub regionselector {
 504   my ( $selected_county, $selected_state, $selected_country,
 505        $prefix, $onchange, $disabled ) = @_;
 506
 507   $prefix = '' unless defined $prefix;
 508
 509   $countyflag = 0;
 510
 511 #  unless ( @cust_main_county ) { #cache
 512     @cust_main_county = qsearch('cust_main_county', {} );
 513     foreach my $c ( @cust_main_county ) {
 514       $countyflag=1 if $c->county;
 515       #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
 516       $cust_main_county{$c->country}{$c->state}{$c->county} = 1;
 517     }
 518 #  }
 519   $countyflag=1 if $selected_county;
 520
 521   my $script_html = <<END;
 522     <SCRIPT>
 523     function opt(what,value,text) {
 524       var optionName = new Option(text, value, false, false);
 525       var length = what.length;
 526       what.options[length] = optionName;
 527     }
 528     function ${prefix}country_changed(what) {
 529       country = what.options[what.selectedIndex].text;
 530       for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
 531           what.form.${prefix}state.options[i] = null;
 532 END
 533       #what.form.${prefix}state.options[0] = new Option('', '', false, true);
 534
 535   foreach my $country ( sort keys %cust_main_county ) {
 536     $script_html .= "\nif ( country == \"$country\" ) {\n";
 537     foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
 538       ( my $dstate = $state ) =~ s/[\n\r]//g;
 539       my $text = $dstate || '(n/a)';
 540       $script_html .= qq!opt(what.form.${prefix}state, "$dstate", "$text");\n!;
 541     }
 542     $script_html .= "}\n";
 543   }
 544
 545   $script_html .= <<END;
 546     }
 547     function ${prefix}state_changed(what) {
 548 END
 549
 550   if ( $countyflag ) {
 551     $script_html .= <<END;
 552       state = what.options[what.selectedIndex].text;
 553       country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
 554       for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
 555           what.form.${prefix}county.options[i] = null;
 556 END
 557
 558     foreach my $country ( sort keys %cust_main_county ) {
 559       $script_html .= "\nif ( country == \"$country\" ) {\n";
 560       foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
 561         $script_html .= "\nif ( state == \"$state\" ) {\n";
 562           #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
 563           foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
 564             my $text = $county || '(n/a)';
 565             $script_html .=
 566               qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
 567           }
 568         $script_html .= "}\n";
 569       }
 570       $script_html .= "}\n";
 571     }
 572   }
 573
 574   $script_html .= <<END;
 575     }
 576     </SCRIPT>
 577 END
 578
 579   my $county_html = $script_html;
 580   if ( $countyflag ) {
 581     $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$onchange" $disabled>!;
 582     $county_html .= '</SELECT>';
 583   } else {
 584     $county_html .=
 585       qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$selected_county">!;
 586   }
 587
 588   my $state_html = qq!<SELECT NAME="${prefix}state" !.
 589                    qq!onChange="${prefix}state_changed(this); $onchange" $disabled>!;
 590   foreach my $state ( sort keys %{ $cust_main_county{$selected_country} } ) {
 591     my $text = $state || '(n/a)';
 592     my $selected = $state eq $selected_state ? 'SELECTED' : '';
 593     $state_html .= qq(\n<OPTION $selected VALUE="$state">$text</OPTION>);
 594   }
 595   $state_html .= '</SELECT>';
 596
 597   $state_html .= '</SELECT>';
 598
 599   my $country_html = qq!<SELECT NAME="${prefix}country" !.
 600                      qq!onChange="${prefix}country_changed(this); $onchange" $disabled>!;
 601   my $countrydefault = $conf->config('countrydefault') || 'US';
 602   foreach my $country (
 603     sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
 604       keys %cust_main_county
 605   ) {
 606     my $selected = $country eq $selected_country ? ' SELECTED' : '';
 607     $country_html .= qq(\n<OPTION$selected VALUE="$country">$country</OPTION>");
 608   }
 609   $country_html .= '</SELECT>';
 610
 611   ($county_html, $state_html, $country_html);
 612
 613 }
 614
 615 =back
 616
 617 =head1 BUGS
 618
 619 regionselector?  putting web ui components in here?  they should probably live
 620 somewhere else...
 621
 622 =head1 SEE ALSO
 623
 624 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill>, schema.html from the base
 625 documentation.
 626
 627 =cut
 628
 629 1;
 630