X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fcust_main_county.pm;h=91c61b266e6b72e0ba21d4f7eb535071af2dcdd2;hb=a76eba49dd827c1afefa62d96fa796ff39bb904d;hp=e4d9c8041531c9dfc3d909e43be5ba5ad9f3fb23;hpb=e8fb3448ac1b9dae5410f88cf70eb36cd822c247;p=freeside.git diff --git a/FS/FS/cust_main_county.pm b/FS/FS/cust_main_county.pm index e4d9c8041..91c61b266 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 @@ -132,6 +136,7 @@ sub check { || $self->ut_textn('taxname') || $self->ut_enum('setuptax', [ '', 'Y' ] ) || $self->ut_enum('recurtax', [ '', 'Y' ] ) + || $self->ut_textn('source') || $self->SUPER::check ; @@ -241,9 +246,6 @@ will in turn have a "taxable_cust_bill_pkg" pseudo-field linking it to one of the taxable items. All of these links must be resolved as the objects are inserted. -In addition to calculating the tax for the line items, this will calculate -any appropriate tax exemptions and attach them to the line items. - Options may include 'custnum' and 'invoice_time' in case the cust_bill_pkg objects belong to an invoice that hasn't been inserted yet. @@ -257,6 +259,10 @@ tax exemption limit if there is one. sub taxline { my( $self, $taxables, %opt ) = @_; + $taxables = [ $taxables ] unless ref($taxables) eq 'ARRAY'; + # remove any charge class identifiers; they're not supported here + @$taxables = grep { ref $_ } @$taxables; + return 'taxline called with no line items' unless @$taxables; local $SIG{HUP} = 'IGNORE'; @@ -274,28 +280,17 @@ sub taxline { my $taxable_cents = 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'}; my $cust_main = FS::cust_main->by_key($custnum) if $custnum > 0; - if (!$cust_main) { - # better way to handle this? should we just assume that it's taxable? - die "unable to calculate taxes for an unknown customer\n"; - } - - # set a flag if the customer is tax-exempt - my $exempt_cust; - my $conf = FS::Conf->new; - if ( $conf->exists('cust_class-tax_exempt') ) { - my $cust_class = $cust_main->cust_class; - $exempt_cust = $cust_class->tax if $cust_class; - } else { - $exempt_cust = $cust_main->tax; - } - - # set a flag if the customer is exempt from this tax here - my $exempt_cust_taxname = $cust_main->tax_exemption($self->taxname) - if $self->taxname; + # (to avoid complications with estimated tax on quotations, assume it's + # taxable if there is no customer) + #if (!$cust_main) { + #die "unable to calculate taxes for an unknown customer\n"; + #} # Gather any exemptions that are already attached to these cust_bill_pkgs # so that we can deduct them from the customer's monthly limit. @@ -313,73 +308,29 @@ sub taxline { my @tax_location; foreach my $cust_bill_pkg (@$taxables) { - - my $cust_pkg = $cust_bill_pkg->cust_pkg; - my $part_pkg = $cust_bill_pkg->part_pkg; - my $part_fee = $cust_bill_pkg->part_fee; - - my $locationnum = $cust_pkg - ? $cust_pkg->locationnum - : $cust_main->bill_locationnum; - - my @new_exemptions; - my $taxable_charged = $cust_bill_pkg->setup + $cust_bill_pkg->recur - or next; # don't create zero-amount exemptions - - # XXX the following procedure should probably be in cust_bill_pkg - - if ( $exempt_cust ) { - - push @new_exemptions, FS::cust_tax_exempt_pkg->new({ - amount => $taxable_charged, - exempt_cust => 'Y', - }); - $taxable_charged = 0; - - } elsif ( $exempt_cust_taxname ) { - - push @new_exemptions, FS::cust_tax_exempt_pkg->new({ - amount => $taxable_charged, - exempt_cust_taxname => 'Y', - }); - $taxable_charged = 0; - + # careful... may be a cust_bill_pkg or a quotation_pkg + + my $taxable_charged = $cust_bill_pkg->setup + $cust_bill_pkg->recur; + foreach ( grep { $_->taxnum == $self->taxnum } + @{ $cust_bill_pkg->cust_tax_exempt_pkg } + ) { + # deal with exemptions that have been set on this line item, and + # pertain to this tax def + $taxable_charged -= $_->amount; } - my $setup_exempt = ( ($part_fee and not $part_fee->taxable) - or ($part_pkg and $part_pkg->setuptax) - or $self->setuptax ); - - if ( $setup_exempt - 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; - - } + # can't determine the tax_locationnum directly for fees; they're not + # yet linked to an invoice + my $locationnum = $cust_bill_pkg->tax_locationnum + || $cust_main->ship_locationnum; - my $recur_exempt = ( ($part_fee and not $part_fee->taxable) - or ($part_pkg and $part_pkg->recurtax) - or $self->recurtax ); + ### Monthly capped exemptions ### + if ( $self->exempt_amount && $self->exempt_amount > 0 + and $taxable_charged > 0 + and $cust_main ) { - if ( $recur_exempt - and $cust_bill_pkg->recur > 0 - and $taxable_charged > 0 ) { + # XXX monthly exemptions currently don't work on quotations - push @new_exemptions, FS::cust_tax_exempt_pkg->new({ - amount => $cust_bill_pkg->recur, - exempt_recur => 'Y' - }); - $taxable_charged -= $cust_bill_pkg->recur; - - } - - if ( $self->exempt_amount && $self->exempt_amount > 0 - and $taxable_charged > 0 ) { # If the billing period extends across multiple calendar months, # there may be several months of exemption available. my $sdate = $cust_bill_pkg->sdate || $invoice_time; @@ -476,13 +427,21 @@ sub taxline { : $remaining_exemption; $addl = $taxable_charged if $addl > $taxable_charged; - push @new_exemptions, FS::cust_tax_exempt_pkg->new({ + my $new_exemption = + FS::cust_tax_exempt_pkg->new({ amount => sprintf('%.2f', $addl), exempt_monthly => 'Y', year => $year, month => $mon, + taxnum => $self->taxnum, + taxtype => ref($self) }); $taxable_charged -= $addl; + + # create a record of it + push @{ $cust_bill_pkg->cust_tax_exempt_pkg }, $new_exemption; + # and allow it to be counted against the limit for other packages + push @existing_exemptions, $new_exemption; } # if they're using multiple months of exemption for a multi-month # package, then record the exemptions in separate months @@ -493,18 +452,21 @@ sub taxline { } } - } # if exempt_amount - - $_->taxnum($self->taxnum) foreach @new_exemptions; - - # attach them to the line item - push @{ $cust_bill_pkg->cust_tax_exempt_pkg }, @new_exemptions; - push @existing_exemptions, @new_exemptions; + } # if exempt_amount and $cust_main $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), @@ -519,12 +481,19 @@ sub taxline { $taxable_cents += $taxable_charged; $tax_cents += $this_tax_cents; } #foreach $cust_bill_pkg - - # now round and distribute + + # calculate tax and rounding error for the whole group 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); + + # 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"; } @@ -666,6 +635,31 @@ END } +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'; + 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); + } + ''; +} + =back =head1 BUGS