RT# 80488 Ensure WA distrct taxes are properly applied
[freeside.git] / FS / FS / TaxEngine / internal.pm
index 99535ad..d680af8 100644 (file)
@@ -3,6 +3,12 @@ package FS::TaxEngine::internal;
 use strict;
 use base 'FS::TaxEngine';
 use FS::Record qw(dbh qsearch qsearchs);
+use FS::Conf;
+use vars qw( $conf );
+
+FS::UID->install_callback(sub {
+    $conf = FS::Conf->new;
+});
 
 =head1 SUMMARY
 
@@ -17,23 +23,44 @@ sub add_sale {
   my ($self, $cust_bill_pkg) = @_;
 
   my $part_item = $cust_bill_pkg->part_X;
-  my $location = $cust_bill_pkg->tax_location;
+  my $location = $cust_bill_pkg->tax_location
+    or return;
   my $custnum = $self->{cust_main}->custnum;
 
   push @{ $self->{items} }, $cust_bill_pkg;
 
-  my @loc_keys = qw( district city county state country );
-  my %taxhash = map { $_ => $location->get($_) } @loc_keys;
+  my %taxhash = map { $_ => $location->get($_) }
+                qw( district county state country );
+  # city names in cust_main_county are uppercase
+  $taxhash{'city'} = uc($location->get('city'));
 
   $taxhash{'taxclass'} = $part_item->taxclass;
 
   my @taxes = (); # entries are cust_main_county objects
   my %taxhash_elim = %taxhash;
   my @elim = qw( district city county state );
+
+  # WA state district city names are not stable in the WA tax tables
+  # Allow districts to match with just a district id
+  if ( $taxhash{district} ) {
+    @taxes = qsearch( cust_main_county => {
+      district => $taxhash{district},
+      taxclass => $taxhash{taxclass},
+    });
+    if ( !scalar(@taxes) && $taxhash{taxclass} ) {
+      qsearch( cust_main_county => {
+        district => $taxhash{district},
+        taxclass => '',
+      });
+    }
+  }
+
   do {
 
     #first try a match with taxclass
-    @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
+    if ( !scalar(@taxes) ) {
+      @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
+    }
 
     if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
       #then try a match without taxclass
@@ -60,10 +87,11 @@ sub taxline {
   my $taxnum = $tax_object->taxnum;
   my $exemptions = $self->{exemptions}->{$taxnum} ||= [];
   
-  my $name = $tax_object->taxname || 'Tax';
-  my $taxable_cents = 0;
+  my $taxable_total = 0;
   my $tax_cents = 0;
 
+  my $round_per_line_item = $conf->exists('tax-round_per_line_item');
+
   my $cust_main = $self->{cust_main};
   my $custnum   = $cust_main->custnum;
   my $invoice_time = $self->{invoice_time};
@@ -87,23 +115,23 @@ sub taxline {
   push @existing_exemptions, @{ $_->cust_tax_exempt_pkg }
     foreach @$taxables;
 
-  my $tax_item = FS::cust_bill_pkg->new({
-      'pkgnum'    => 0,
-      'recur'     => 0,
-      'sdate'     => '',
-      'edate'     => '',
-      'itemdesc'  => $name,
-  });
-  my @tax_location;
+  my @tax_links;
 
   foreach my $cust_bill_pkg (@$taxables) {
 
-    my $cust_pkg  = $cust_bill_pkg->cust_pkg;
-    my $part_pkg  = $cust_bill_pkg->part_pkg;
     my @new_exemptions;
     my $taxable_charged = $cust_bill_pkg->setup + $cust_bill_pkg->recur
       or next; # don't create zero-amount exemptions
 
+    ## re-add the discounted amount if the tax needs to be charged pre discount
+    if ($tax_object->charge_prediscount) {
+      my $discount_amount = 0;
+      foreach my $discount (@{$cust_bill_pkg->discounts}) {
+        $discount_amount += $discount->amount;
+      }
+      $taxable_charged += $discount_amount;
+    }
+
     # XXX the following procedure should probably be in cust_bill_pkg
 
     if ( $exempt_cust ) {
@@ -123,25 +151,28 @@ sub taxline {
       $taxable_charged = 0;
 
     }
+    
+    if ( my $part_pkg = $cust_bill_pkg->part_pkg ) {
 
-    if ( ($part_pkg->setuptax eq 'Y' or $tax_object->setuptax eq 'Y')
-        and $cust_bill_pkg->setup > 0 and $taxable_charged > 0 ) {
+      if ( ($part_pkg->setuptax eq 'Y' or $tax_object->setuptax eq 'Y')
+          and $cust_bill_pkg->setup > 0 and $taxable_charged > 0 ) {
 
-      push @new_exemptions, FS::cust_tax_exempt_pkg->new({
-          amount => $cust_bill_pkg->setup,
-          exempt_setup => 'Y'
-      });
-      $taxable_charged -= $cust_bill_pkg->setup;
+        push @new_exemptions, FS::cust_tax_exempt_pkg->new({
+            amount => $cust_bill_pkg->setup,
+            exempt_setup => 'Y'
+        });
+        $taxable_charged -= $cust_bill_pkg->setup;
+      }
 
-    }
-    if ( ($part_pkg->recurtax eq 'Y' or $tax_object->recurtax eq 'Y')
-        and $cust_bill_pkg->recur > 0 and $taxable_charged > 0 ) {
+      if ( ($part_pkg->recurtax eq 'Y' or $tax_object->recurtax eq 'Y')
+          and $cust_bill_pkg->recur > 0 and $taxable_charged > 0 ) {
 
-      push @new_exemptions, FS::cust_tax_exempt_pkg->new({
-          amount => $cust_bill_pkg->recur,
-          exempt_recur => 'Y'
-      });
-       $taxable_charged -= $cust_bill_pkg->recur;
+        push @new_exemptions, FS::cust_tax_exempt_pkg->new({
+            amount => $cust_bill_pkg->recur,
+            exempt_recur => 'Y'
+        });
+        $taxable_charged -= $cust_bill_pkg->recur;
+      }
 
     }
 
@@ -244,6 +275,7 @@ sub taxline {
               year            => $year,
               month           => $mon,
             });
+
           $taxable_charged -= $addl;
         }
         # if they're using multiple months of exemption for a multi-month
@@ -257,42 +289,83 @@ sub taxline {
       }
     } # if exempt_amount
 
-    $_->taxnum($tax_object->taxnum) foreach @new_exemptions;
-
     # attach them to the line item
-    push @{ $cust_bill_pkg->cust_tax_exempt_pkg }, @new_exemptions;
+    foreach my $ex (@new_exemptions) {
+
+      $ex->set('taxnum', $taxnum);
+
+      if ( $cust_bill_pkg->billpkgnum ) {
+        # the exempted item is already inserted (it should be, these days) so
+        # insert the exemption record now:
+        $ex->set('billpkgnum', $cust_bill_pkg->billpkgnum);
+        my $error = $ex->insert;
+        return "inserting tax exemption record: $error" if $error;
+
+      } else {
+        # defer it until the item is inserted
+        push @{ $cust_bill_pkg->cust_tax_exempt_pkg }, $ex;
+      }
+    }
+
+    # and remember we've used the exemption
     push @existing_exemptions, @new_exemptions;
 
     $taxable_charged = sprintf( "%.2f", $taxable_charged);
     next if $taxable_charged == 0;
 
-    my $this_tax_cents = int($taxable_charged * $tax_object->tax);
+    my $this_tax_cents = $taxable_charged * $tax_object->tax;
+    if ( $round_per_line_item ) {
+      # Round the tax to the nearest cent for each line item, instead of
+      # across the whole invoice.
+      $this_tax_cents = sprintf('%.0f', $this_tax_cents);
+    } else {
+      # Otherwise truncate it so that rounding error is always positive.
+      $this_tax_cents = int($this_tax_cents);
+    }
+
+    my $locationnum;
+    if ( my $cust_pkg = $cust_bill_pkg->cust_pkg ) {
+      $locationnum = $cust_pkg->tax_locationnum;
+    } elsif ( $conf->exists('tax-ship_address') ) {
+      $locationnum = $cust_main->ship_locationnum;
+    } else {
+      $locationnum = $cust_main->bill_locationnum;
+    }
+
     my $location = FS::cust_bill_pkg_tax_location->new({
-        'taxnum'      => $tax_object->taxnum,
-        'taxtype'     => ref($tax_object),
-        'cents'       => $this_tax_cents,
-        'pkgnum'      => $cust_bill_pkg->pkgnum,
-        'locationnum' => $cust_bill_pkg->cust_pkg->tax_locationnum,
+        'taxnum'                => $tax_object->taxnum,
+        'taxtype'               => ref($tax_object),
+        'cents'                 => $this_tax_cents,
+        'pkgnum'                => $cust_bill_pkg->pkgnum,
+        'locationnum'           => $locationnum,
         'taxable_cust_bill_pkg' => $cust_bill_pkg,
-        'tax_cust_bill_pkg'     => $tax_item,
     });
-    push @tax_location, $location;
+    push @tax_links, $location;
 
-    $taxable_cents += $taxable_charged;
+    $taxable_total += $taxable_charged;
     $tax_cents += $this_tax_cents;
   } #foreach $cust_bill_pkg
 
-  # now round and distribute
-  my $extra_cents = sprintf('%.2f', $taxable_cents * $tax_object->tax / 100)
-                            * 100 - $tax_cents;
-  # make sure we have an integer
-  $extra_cents = sprintf('%.0f', $extra_cents);
+  # calculate tax and rounding error for the whole group: total taxable
+  # amount times tax rate (as cents per dollar), minus the tax already
+  # charged
+  # and force 0.5 to round up
+  my $extra_cents = sprintf('%.0f',
+    ($taxable_total * $tax_object->tax) - $tax_cents + 0.00000001
+  );
+
+  # if we're rounding per item, then ignore that and don't distribute any
+  # extra cents.
+  if ( $round_per_line_item ) {
+    $extra_cents = 0;
+  }
+
   if ( $extra_cents < 0 ) {
     die "nonsense extra_cents value $extra_cents";
   }
   $tax_cents += $extra_cents;
   my $i = 0;
-  foreach (@tax_location) { # can never require more than a single pass, yes?
+  foreach (@tax_links) { # can never require more than a single pass, yes?
     my $cents = $_->get('cents');
     if ( $extra_cents > 0 ) {
       $cents++;
@@ -300,10 +373,8 @@ sub taxline {
     }
     $_->set('amount', sprintf('%.2f', $cents/100));
   }
-  $tax_item->set('setup' => sprintf('%.2f', $tax_cents / 100));
-  $tax_item->set('cust_bill_pkg_tax_location', \@tax_location);
 
-  return $tax_item;
+  return @tax_links;
 }
 
 sub info {