X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fcust_main_county.pm;h=d5e9ec799c52302377bde09f25bfc15cdebfa0c6;hb=b5ce5f3e32b0f40a7c6a7da86a25ec772c8dbc71;hp=523a810d4f28daf55c43c2a95d1489834cab8461;hpb=e19085190e34fce90b15bd9ec0c8d98b4fc8cd9a;p=freeside.git diff --git a/FS/FS/cust_main_county.pm b/FS/FS/cust_main_county.pm index 523a810d4..d5e9ec799 100644 --- a/FS/FS/cust_main_county.pm +++ b/FS/FS/cust_main_county.pm @@ -11,6 +11,7 @@ use FS::cust_pkg; use FS::part_pkg; use FS::cust_tax_exempt; use FS::cust_tax_exempt_pkg; +use FS::upgrade_journal; @ISA = qw( FS::Record ); @EXPORT_OK = qw( regionselector ); @@ -78,6 +79,9 @@ currently supported: =item recurtax - if 'Y', this tax does not apply to recurring fees +=item source - the tax lookup method that created this tax record. For records +created manually, this will be null. + =back =head1 METHODS @@ -118,6 +122,9 @@ methods. sub check { my $self = shift; + $self->trim_whitespace(qw(district city county state country)); + $self->set('city', uc($self->get('city'))); # also county? + $self->exempt_amount(0) unless $self->exempt_amount; $self->ut_numbern('taxnum') @@ -132,6 +139,7 @@ sub check { || $self->ut_textn('taxname') || $self->ut_enum('setuptax', [ '', 'Y' ] ) || $self->ut_enum('recurtax', [ '', 'Y' ] ) + || $self->ut_textn('source') || $self->SUPER::check ; @@ -272,9 +280,11 @@ sub taxline { my $dbh = dbh; my $name = $self->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_bill = $taxables->[0]->cust_bill; my $custnum = $cust_bill ? $cust_bill->custnum : $opt{'custnum'}; my $invoice_time = $cust_bill ? $cust_bill->_date : $opt{'invoice_time'}; @@ -450,7 +460,16 @@ sub taxline { $taxable_charged = sprintf( "%.2f", $taxable_charged); next if $taxable_charged == 0; - my $this_tax_cents = int($taxable_charged * $self->tax); + my $this_tax_cents = $taxable_charged * $self->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 $location = FS::cust_bill_pkg_tax_location->new({ 'taxnum' => $self->taxnum, 'taxtype' => ref($self), @@ -462,15 +481,25 @@ sub taxline { }); push @tax_location, $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 * $self->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 * $self->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"; } @@ -612,6 +641,185 @@ END } +sub _merge_into { + # for internal use: takes another cust_main_county object, transfers + # all existing references to this record to that one, and deletes this + # one. + my $record = shift; + my $other = shift or die "record to merge into must be provided"; + my $new_taxnum = $other->taxnum; + my $old_taxnum = $record->taxnum; + if ($other->tax != $record->tax or + $other->exempt_amount != $record->exempt_amount) { + # don't assume these are the same. + warn "Found duplicate taxes (#$new_taxnum and #$old_taxnum) but they have different rates and can't be merged.\n"; + } else { + warn "Merging tax #$old_taxnum into #$new_taxnum\n"; + foreach my $table (qw( + cust_bill_pkg_tax_location + cust_bill_pkg_tax_location_void + cust_tax_exempt_pkg + cust_tax_exempt_pkg_void + )) { + foreach my $row (qsearch($table, { 'taxnum' => $old_taxnum })) { + $row->set('taxnum' => $new_taxnum); + my $error = $row->replace; + die $error if $error; + } + } + my $error = $record->delete; + die $error if $error; + } +} + +sub _upgrade_data { + my $class = shift; + # assume taxes in Washington with district numbers, and null name, or + # named 'sales tax', are looked up via the wa_sales method. mark them. + my $journal = 'cust_main_county__source_wa_sales_201611'; + if (!FS::upgrade_journal->is_done($journal)) { + my @taxes = qsearch({ + 'table' => 'cust_main_county', + 'extra_sql' => " WHERE tax > 0 AND country = 'US' AND state = 'WA'". + " AND district IS NOT NULL AND ( taxname IS NULL OR ". + " taxname ~* 'sales tax' )", + }); + if ( @taxes ) { + warn "Flagging Washington state sales taxes: ".scalar(@taxes)." records.\n"; + foreach (@taxes) { + $_->set('source', 'wa_sales'); + my $error = $_->replace; + die $error if $error; + } + } + FS::upgrade_journal->set_done($journal); + } + my @key_fields = (qw(city county state country district taxname taxclass)); + + # trim whitespace and convert to uppercase in the 'city' field. + foreach my $record (qsearch({ + table => 'cust_main_county', + extra_sql => " WHERE city LIKE ' %' OR city LIKE '% ' OR city != UPPER(city)", + })) { + # any with-trailing-space records probably duplicate other records + # from the same city, and if we just fix the record in place, we'll + # create an exact duplicate. + # so find the record this one would duplicate, and merge them. + $record->check; # trims whitespace + my %match = map { $_ => $record->get($_) } @key_fields; + my $other = qsearchs('cust_main_county', \%match); + if ($other) { + $record->_merge_into($other); + } else { + # else there is no record this one duplicates, so just fix it + my $error = $record->replace; + die $error if $error; + } + } # foreach $record + + # separate wa_sales taxes by tax class as needed + my $district_taxname = $conf->config('tax_district_taxname'); + $journal = 'cust_main_county__district_taxclass'; + if (!FS::upgrade_journal->is_done($journal) + and $conf->exists('enable_taxclasses')) { + eval "use FS::part_pkg_taxclass"; + my @taxes = qsearch({ + 'table' => 'cust_main_county', + 'extra_sql' => " WHERE tax > 0 AND country = 'US' AND state = 'WA'". + " AND district IS NOT NULL AND source = 'wa_sales'". + " AND taxclass IS NULL" + }); + my @classes = FS::part_pkg_taxclass->taxclass_names; + if ( @taxes ) { + warn "Separating WA sales taxes: ".scalar(@taxes)." records.\n"; + foreach my $oldtax (@taxes) { + my $error; + my $taxnum = $oldtax->taxnum; + warn "Separating tax #$taxnum into classes\n"; + foreach my $taxclass (@classes) { + # ensure that we end up with a single copy of the tax in this + # jurisdiction+class. there may already be one (or more) there. + # if so, they all represent the same tax; merge them together. + my %newtax_hash = ( + 'country' => 'US', + 'state' => 'WA', + 'city' => $oldtax->city, + 'district' => $oldtax->district, + 'taxclass' => $taxclass, + 'source' => 'wa_sales', + ); + my @taxes_in_class = qsearch('cust_main_county', { + %newtax_hash, + 'tax' => { op => '>', value => 0 }, + 'setuptax' => '', + 'recurtax' => '', + }); + my $newtax = shift @taxes_in_class; + if ($newtax) { + foreach (@taxes_in_class) { + # allow the merge, even if this somehow differs. + $_->set('tax', $newtax->tax); + $_->_merge_into($newtax); + } + } + $newtax ||= FS::cust_main_county->new(\%newtax_hash); + # copy properties from the pre-split tax + $newtax->set('tax', $oldtax->tax); + $newtax->set('setuptax', $oldtax->setuptax); + $newtax->set('recurtax', $oldtax->recurtax); + # and assign the defined tax name + $newtax->set('taxname', $district_taxname); + $error = ($newtax->taxnum ? $newtax->replace : $newtax->insert); + die "splitting taxnum ".$oldtax->taxnum.": $error\n" if $error; + } # foreach $taxclass + $oldtax->set('tax', 0); + $error = $oldtax->replace; + die "splitting taxnum ".$oldtax->taxnum.": $error\n" if $error; + } + } + FS::upgrade_journal->set_done($journal); + } + + # also ensure they all have the chosen taxname now + if ($district_taxname) { + my @taxes = qsearch('cust_main_county', { + 'source' => 'wa_sales', + 'taxname' => { op => '!=', value => $district_taxname } + }); + if (@taxes) { + warn "Renaming WA sales taxes: ".scalar(@taxes)." records.\n"; + foreach my $tax (@taxes) { + $tax->set('taxname', $district_taxname); + my $error = $tax->replace; + die "renaming taxnum ".$tax->taxnum.": $error\n" if $error; + } + } + } + + # remove duplicates (except disabled records) + my @duplicate_sets = qsearch({ + table => 'cust_main_county', + select => FS::Record::group_concat_sql('taxnum', ',') . ' AS taxnums, ' . + join(',', @key_fields), + extra_sql => ' WHERE tax > 0 + GROUP BY city, county, state, country, district, taxname, taxclass + HAVING COUNT(*) > 1' + }); + warn "Found ".scalar(@duplicate_sets)." set(s) of duplicate tax definitions\n" + if @duplicate_sets; + foreach my $set (@duplicate_sets) { + my @taxnums = split(',', $set->get('taxnums')); + my $first = FS::cust_main_county->by_key(shift @taxnums); + foreach my $taxnum (@taxnums) { + my $record = FS::cust_main_county->by_key($taxnum); + $record->_merge_into($first); + } + } + + + ''; +} + =back =head1 BUGS