X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcust_credit_bill_pkg.pm;h=080a83aaab94681c5e89fae783a2e220e181b87e;hp=8b01cd21ac9104189b323ccc655a573173709b6a;hb=ff27c3f36240aee48ed50153dd5d8fe3ac3f2443;hpb=40a7b3dc653e099f7bd0bd762b649b04c4432db2

diff --git a/FS/FS/cust_credit_bill_pkg.pm b/FS/FS/cust_credit_bill_pkg.pm
index 8b01cd21a..080a83aaa 100644
--- a/FS/FS/cust_credit_bill_pkg.pm
+++ b/FS/FS/cust_credit_bill_pkg.pm
@@ -1,15 +1,11 @@
 package FS::cust_credit_bill_pkg;
+use base qw( FS::cust_main_Mixin FS::Record );
 
 use strict;
-use vars qw( @ISA );
-use FS::Record qw( qsearchs ); # qsearch );
-use FS::cust_main_Mixin;
-use FS::cust_credit_bill;
-use FS::cust_bill_pkg;
+use FS::Record qw( qsearch qsearchs dbh );
 use FS::cust_bill_pkg_tax_location;
 use FS::cust_bill_pkg_tax_rate_location;
-
-@ISA = qw( FS::cust_main_Mixin FS::Record );
+use FS::cust_tax_exempt_pkg;
 
 =head1 NAME
 
@@ -82,7 +78,130 @@ otherwise returns false.
 
 =cut
 
-# the insert method can be inherited from FS::Record
+sub insert {
+  my $self = shift;
+
+  local $SIG{HUP} = 'IGNORE';
+  local $SIG{INT} = 'IGNORE';
+  local $SIG{QUIT} = 'IGNORE';
+  local $SIG{TERM} = 'IGNORE';
+  local $SIG{TSTP} = 'IGNORE';
+  local $SIG{PIPE} = 'IGNORE';
+
+  my $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
+
+  my $error = $self->SUPER::insert;
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+
+  my $cust_bill_pkg = $self->cust_bill_pkg;
+  #'payable' is the amount charged (either setup or recur)
+  # minus any credit applications, including this one
+  my $payable = $cust_bill_pkg->payable($self->setuprecur);
+  my $part_pkg = $cust_bill_pkg->part_pkg;
+  my $freq = $cust_bill_pkg->freq;
+  unless ($freq) {
+    $freq = $part_pkg ? ($part_pkg->freq || 1) : 1;#fallback.. assumes unchanged
+  }
+  my $taxable_per_month = sprintf("%.2f", $payable / $freq );
+  my $credit_per_month = sprintf("%.2f", $self->amount / $freq ); #pennies?
+
+  if ($taxable_per_month >= 0) {  #panic if its subzero?
+    my $groupby = join(',',
+      qw(taxnum taxtype year month exempt_monthly exempt_cust 
+         exempt_cust_taxname exempt_setup exempt_recur));
+    my $sum = 'SUM(amount)';
+    my @exemptions = qsearch(
+      {
+        'select'    => "$groupby, $sum AS amount",
+        'table'     => 'cust_tax_exempt_pkg',
+        'hashref'   => { billpkgnum => $self->billpkgnum },
+        'extra_sql' => "GROUP BY $groupby HAVING $sum > 0",
+      }
+    ); 
+    # each $exemption is now the sum of all monthly exemptions applied to 
+    # this line item for a particular taxnum and month.
+    foreach my $exemption ( @exemptions ) {
+      my $amount = 0;
+      if ( $exemption->exempt_monthly ) {
+        # finite exemptions
+        # $taxable_per_month is AFTER inserting the credit application, so 
+        # if it's still larger than the exemption, we don't need to adjust
+        next if $taxable_per_month >= $exemption->amount;
+        # the amount of 'excess' exemption already in place (above the 
+        # remaining charged amount).  We'll de-exempt that much, or the 
+        # amount of the new credit, whichever is smaller.
+        $amount = $exemption->amount - $taxable_per_month;
+        # $amount is the amount of 'excess' exemption already existing 
+        # (above the remaining taxable charge amount).  We'll "de-exempt"
+        # that much, or the amount of the new credit, whichever is smaller.
+        if ($amount > $credit_per_month) {
+               "cust_bill_pkg ". $self->billpkgnum. "  Reducing.\n";
+          $amount = $credit_per_month;
+        }
+      } elsif ( $exemption->exempt_setup or $exemption->exempt_recur ) {
+        # package defined exemptions: may be setup only, recur only, or both
+        my $method = 'exempt_'.$self->setuprecur;
+        if ( $exemption->$method ) {
+          # then it's exempt from the portion of the charge that this 
+          # credit is being applied to
+          $amount = $self->amount;
+        }
+      } else {
+        # other types of exemptions: always equal to the amount of
+        # the charge
+        $amount = $self->amount;
+      }
+      next if $amount == 0;
+
+      # create a negative exemption
+      my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg {
+         $exemption->hash, # for exempt_ flags, taxnum, month/year
+        'billpkgnum'       => $self->billpkgnum,
+        'creditbillpkgnum' => $self->creditbillpkgnum,
+        'amount'           => sprintf('%.2f', 0-$amount),
+      };
+
+      if ( $cust_tax_exempt_pkg->cust_main_county ) {
+
+        my $error = $cust_tax_exempt_pkg->insert;
+        if ( $error ) {
+          $dbh->rollback if $oldAutoCommit;
+          return "error inserting cust_tax_exempt_pkg: $error";
+        }
+
+      }
+
+    } #foreach $exemption
+  }
+
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+ '';
+
+}
+
+#helper functions for above
+sub _is_taxable {
+  my $self = shift;
+  my $part_pkg = $self->cust_bill_pkg->part_pkg;
+
+  return 0 unless $part_pkg; #XXX fails for tax on tax
+
+  my $method = $self->setuprecur. 'tax';
+  return 0 if $part_pkg->$method =~ /^Y$/i;
+
+  if ($self->billpkgtaxlocationnum) {
+    my $location_object = $self->cust_bill_pkg_tax_Xlocation;
+    my $tax_object = $location_object->cust_main_county;
+    return 0 if $tax_object && $self->tax_object->$method =~ /^Y$/i;
+  } #elsif ($self->billpkgtaxratelocationnum) { ... }
+
+  1;
+}
 
 =item delete
 
@@ -90,7 +209,45 @@ Delete this record from the database.
 
 =cut
 
-# the delete method can be inherited from FS::Record
+sub delete {
+  my $self = shift;
+
+  local $SIG{HUP} = 'IGNORE';
+  local $SIG{INT} = 'IGNORE';
+  local $SIG{QUIT} = 'IGNORE';
+  local $SIG{TERM} = 'IGNORE';
+  local $SIG{TSTP} = 'IGNORE';
+  local $SIG{PIPE} = 'IGNORE';
+
+  my $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
+
+  my @negative_exemptions = qsearch('cust_tax_exempt_pkg', {
+      'creditbillpkgnum' => $self->creditbillpkgnum
+  });
+
+  # de-anti-exempt those negative exemptions
+  my $error;
+  foreach (@negative_exemptions) {
+    $error = $_->delete;
+    if ( $error ) {
+      $dbh->rollback if $oldAutoCommit;
+      return $error;
+    }
+  }
+
+  $error = $self->SUPER::delete(@_);
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+
+  '';
+
+}
 
 =item replace OLD_RECORD
 
@@ -135,9 +292,22 @@ sub check {
   $self->SUPER::check;
 }
 
-sub cust_credit_bill {
+sub cust_bill_pkg_tax_Xlocation {
   my $self = shift;
-  qsearchs('cust_credit_bill', { 'creditbillnum' => $self->creditbillnum } );
+  if ($self->billpkgtaxlocationnum) {
+    return qsearchs(
+      'cust_bill_pkg_tax_location',
+      { 'billpkgtaxlocationnum' => $self->billpkgtaxlocationnum },
+    );
+ 
+  } elsif ($self->billpkgtaxratelocationnum) {
+    return qsearchs(
+      'cust_bill_pkg_tax_rate_location',
+      { 'billpkgtaxratelocationnum' => $self->billpkgtaxratelocationnum },
+    );
+  } else {
+    return undef;
+  }
 }
 
 =back
@@ -147,6 +317,14 @@ sub cust_credit_bill {
 B<setuprecur> field is a kludge to compensate for cust_bill_pkg having separate
 setup and recur fields.  It should be removed once that's fixed.
 
+B<insert> method used to assume that the frequency of the package associated
+with the associated line item remained unchanged during the lifetime of the
+system.  That is still used as a fallback.  It may get the tax exemption
+adjustments wrong if package definitions change frequency.  The presense of
+delete methods in FS::cust_main_county and FS::tax_rate makes crediting of
+old "texas tax" unreliable in the presense of changing taxes.  Explicit tax
+credit requests?  Carry 'taxable' onto line items?
+
 =head1 SEE ALSO
 
 L<FS::Record>, schema.html from the base documentation.