[freeside-commits] freeside/FS/FS Schema.pm, 1.182, 1.183 cust_bill_pkg.pm, 1.47, 1.48 cust_bill_pkg_tax_location.pm, 1.4, 1.5 cust_credit_bill_pkg.pm, 1.5, 1.6 cust_tax_exempt_pkg.pm, 1.3, 1.4
Jeff Finucane,420,,
jeff at wavetail.420.am
Mon Dec 21 06:44:11 PST 2009
Update of /home/cvs/cvsroot/freeside/FS/FS
In directory wavetail.420.am:/tmp/cvs-serv22247/FS/FS
Modified Files:
Schema.pm cust_bill_pkg.pm cust_bill_pkg_tax_location.pm
cust_credit_bill_pkg.pm cust_tax_exempt_pkg.pm
Log Message:
manage tax exemptions (texas-tax) on credit application RT953
Index: cust_tax_exempt_pkg.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/cust_tax_exempt_pkg.pm,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- cust_tax_exempt_pkg.pm 18 Feb 2006 02:11:44 -0000 1.3
+++ cust_tax_exempt_pkg.pm 21 Dec 2009 14:44:09 -0000 1.4
@@ -6,6 +6,7 @@
use FS::cust_main_Mixin;
use FS::cust_bill_pkg;
use FS::cust_main_county;
+use FS::cust_credit_bill_pkg;
@ISA = qw( FS::cust_main_Mixin FS::Record );
@@ -112,6 +113,9 @@
# || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
|| $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum')
|| $self->ut_foreign_key('taxnum', 'cust_main_county', 'taxnum')
+ || $self->ut_foreign_keyn('creditbillpkgnum',
+ 'cust_credit_bill_pkg',
+ 'creditbillpkgnum')
|| $self->ut_number('year') #check better
|| $self->ut_number('month') #check better
|| $self->ut_money('amount')
@@ -119,6 +123,18 @@
;
}
+=item cust_main_county
+
+Returns the associated tax definition if it still exists in the database.
+Otherwise returns false.
+
+=cut
+
+sub cust_main_county {
+ my $self = shift;
+ qsearchs( 'cust_main_county', { 'taxnum', $self->taxnum } );
+}
+
=back
=head1 BUGS
Index: cust_credit_bill_pkg.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/cust_credit_bill_pkg.pm,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- cust_credit_bill_pkg.pm 12 Dec 2009 23:53:32 -0000 1.5
+++ cust_credit_bill_pkg.pm 21 Dec 2009 14:44:09 -0000 1.6
@@ -2,12 +2,13 @@
use strict;
use vars qw( @ISA );
-use FS::Record qw( qsearchs ); # qsearch );
+use FS::Record qw( qsearch qsearchs dbh );
use FS::cust_main_Mixin;
use FS::cust_credit_bill;
use FS::cust_bill_pkg;
use FS::cust_bill_pkg_tax_location;
use FS::cust_bill_pkg_tax_rate_location;
+use FS::cust_tax_exempt_pkg;
@ISA = qw( FS::cust_main_Mixin FS::Record );
@@ -82,7 +83,88 @@
=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 $payable = $self->cust_bill_pkg->payable($self->setuprecur);
+ my $taxable = $self->_is_taxable ? $payable : 0;
+ my $part_pkg = $self->cust_bill_pkg->part_pkg;
+ my $freq = $part_pkg ? $part_pkg->freq || 1 : 1;# assume unchanged
+ my $taxable_per_month = sprintf("%.2f", $taxable / $freq );
+ my $credit_per_month = sprintf("%.2f", $self->amount / $freq ); #pennies?
+
+ if ($taxable_per_month >= 0) { #panic if its subzero?
+ my $groupby = 'taxnum,year,month';
+ 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",
+ }
+ );
+ foreach my $exemption ( @exemptions ) {
+ next if $taxable_per_month >= $exemption->amount;
+ my $amount = $exemption->amount - $taxable_per_month;
+ if ($amount > $credit_per_month) {
+ "cust_bill_pkg ". $self->billpkgnum. " Reducing.\n";
+ $amount = $credit_per_month;
+ }
+ my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg {
+ 'billpkgnum' => $self->billpkgnum,
+ 'creditbillpkgnum' => $self->creditbillpkgnum,
+ 'amount' => 0-$amount,
+ map { $_ => $exemption->$_ } split(',', $groupby)
+ };
+ my $error = $cust_tax_exempt_pkg->insert;
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return "error inserting cust_tax_exempt_pkg: $error";
+ }
+ }
+ }
+
+ $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 +172,89 @@
=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 $original_cust_bill_pkg = $self->cust_bill_pkg;
+ my $cust_bill = $original_cust_bill_pkg->cust_bill;
+
+ my %hash = $original_cust_bill_pkg->hash;
+ delete $hash{$_} for qw( billpkgnum setup recur );
+ $hash{$self->setuprecur} = $self->amount;
+ my $cust_bill_pkg = new FS::cust_bill_pkg { %hash };
+
+ use Data::Dumper;
+ my @exemptions = qsearch( 'cust_tax_exempt_pkg',
+ { creditbillpkgnum => $self->creditbillpkgnum }
+ );
+ my %seen = ();
+ my @generated_exemptions = ();
+ my @unseen_exemptions = ();
+ foreach my $exemption ( @exemptions ) {
+ my $error = $exemption->delete;
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return "error deleting cust_tax_exempt_pkg: $error";
+ }
+
+ next if $seen{$exemption->taxnum};
+ $seen{$exemption->taxnum} = 1;
+ push @unseen_exemptions, $exemption;
+ }
+
+ foreach my $exemption ( @unseen_exemptions ) {
+ my $tax_object = $exemption->cust_main_county;
+ unless ($tax_object) {
+ $dbh->rollback if $oldAutoCommit;
+ return "can't find exempted tax";
+ }
+
+ my $hashref_or_error =
+ $tax_object->taxline( [ $cust_bill_pkg ],
+ 'custnum' => $cust_bill->custnum,
+ 'invoice_time' => $cust_bill->_date,
+ );
+ unless (ref($hashref_or_error)) {
+ $dbh->rollback if $oldAutoCommit;
+ return "error calculating taxes: $hashref_or_error";
+ }
+
+ push @generated_exemptions, @{ $cust_bill_pkg->_cust_tax_exempt_pkg || [] };
+ }
+
+ foreach my $taxnum ( keys %seen ) {
+ my $sum = 0;
+ $sum += $_->amount for grep {$_->taxnum == $taxnum} @exemptions;
+ $sum -= $_->amount for grep {$_->taxnum == $taxnum} @generated_exemptions;
+ $sum = sprintf("%.2f", $sum);
+ unless ($sum eq '0.00' || $sum eq '-0.00') {
+ $dbh->rollback if $oldAutoCommit;
+ return "Can't unapply credit without charging tax";
+ }
+ }
+
+ my $error = $self->SUPER::delete(@_);
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return $error;
+ }
+
+ $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+
+ '';
+
+}
=item replace OLD_RECORD
@@ -140,6 +304,29 @@
qsearchs('cust_credit_bill', { 'creditbillnum' => $self->creditbillnum } );
}
+sub cust_bill_pkg {
+ my $self = shift;
+ qsearchs('cust_bill_pkg', { 'billpkgnum' => $self->billpkgnum } );
+}
+
+sub cust_bill_pkg_tax_Xlocation {
+ my $self = shift;
+ if ($self->billpkg_tax_locationnum) {
+ return qsearchs(
+ 'cust_bill_pkg_tax_location',
+ { 'billpkgtaxlocationnum' => $self->billpkgtaxlocationnum },
+ );
+
+ } elsif ($self->billpkg_tax_rate_locationnum) {
+ return qsearchs(
+ 'cust_bill_pkg_tax_rate_location',
+ { 'billpkgtaxratelocationnum' => $self->billpkgtaxratelocationnum },
+ );
+ } else {
+ return undef;
+ }
+}
+
=back
=head1 BUGS
@@ -147,6 +334,14 @@
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 assumes that the frequency of the package associated with the
+associated line item remains unchanged during the lifetime of the system.
+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.
Index: cust_bill_pkg.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/cust_bill_pkg.pm,v
retrieving revision 1.47
retrieving revision 1.48
diff -u -d -r1.47 -r1.48
--- cust_bill_pkg.pm 20 Nov 2009 17:33:39 -0000 1.47
+++ cust_bill_pkg.pm 21 Dec 2009 14:44:09 -0000 1.48
@@ -529,6 +529,16 @@
$balance;
}
+#modeled after owed
+sub payable {
+ my( $self, $field ) = @_;
+ my $balance = $self->$field();
+ $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) );
+ $balance = sprintf( '%.2f', $balance );
+ $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
+ $balance;
+}
+
sub cust_bill_pay_pkg {
my( $self, $field ) = @_;
qsearch( 'cust_bill_pay_pkg', { 'billpkgnum' => $self->billpkgnum,
Index: cust_bill_pkg_tax_location.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/cust_bill_pkg_tax_location.pm,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- cust_bill_pkg_tax_location.pm 18 Dec 2009 18:20:35 -0000 1.4
+++ cust_bill_pkg_tax_location.pm 21 Dec 2009 14:44:09 -0000 1.5
@@ -8,6 +8,7 @@
use FS::cust_location;
use FS::cust_bill_pay_pkg;
use FS::cust_credit_bill_pkg;
+use FS::cust_main_county;
=head1 NAME
@@ -199,10 +200,21 @@
);
}
+sub cust_main_county {
+ my $self = shift;
+ my $result;
+ if ( $self->taxtype eq 'FS::cust_main_county' ) {
+ $result = qsearchs( 'cust_main_county', { 'taxnum' => $self->taxnum } );
+ }
+}
+
=back
=head1 BUGS
+The presense of FS::cust_main_county::delete makes the cust_main_county method
+unreliable
+
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
Index: Schema.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/Schema.pm,v
retrieving revision 1.182
retrieving revision 1.183
diff -u -d -r1.182 -r1.183
--- Schema.pm 8 Dec 2009 06:21:30 -0000 1.182
+++ Schema.pm 21 Dec 2009 14:44:09 -0000 1.183
@@ -1804,13 +1804,15 @@
'taxnum', 'int', '', '', '', '',
'year', 'int', '', '', '', '',
'month', 'int', '', '', '', '',
+ 'creditbillpkgnum', 'int', 'NULL', '', '', '',
'amount', @money_type, '', '',
],
'primary_key' => 'exemptpkgnum',
'unique' => [],
'index' => [ [ 'taxnum', 'year', 'month' ],
[ 'billpkgnum' ],
- [ 'taxnum' ]
+ [ 'taxnum' ],
+ [ 'creditbillpkgnum' ],
],
},
More information about the freeside-commits
mailing list