1 package FS::cust_main_county;
2 use base qw( FS::Record );
5 use vars qw( @EXPORT_OK $conf
6 @cust_main_county %cust_main_county $countyflag ); # $cityflag );
8 use FS::Record qw( qsearch qsearchs dbh );
13 use FS::cust_tax_exempt;
14 use FS::cust_tax_exempt_pkg;
16 @EXPORT_OK = qw( regionselector );
18 @cust_main_county = ();
22 #ask FS::UID to run this stuff for us later
23 $FS::UID::callback{'FS::cust_main_county'} = sub {
29 FS::cust_main_county - Object methods for cust_main_county objects
33 use FS::cust_main_county;
35 $record = new FS::cust_main_county \%hash;
36 $record = new FS::cust_main_county { 'column' => 'value' };
38 $error = $record->insert;
40 $error = $new_record->replace($old_record);
42 $error = $record->delete;
44 $error = $record->check;
46 ($county_html, $state_html, $country_html) =
47 FS::cust_main_county::regionselector( $county, $state, $country );
51 An FS::cust_main_county object represents a tax rate, defined by locale.
52 FS::cust_main_county inherits from FS::Record. The following fields are
57 =item taxnum - primary key (assigned automatically for new tax rates)
59 =item district - tax district (optional)
69 =item tax - percentage
75 =item taxname - if defined, printed on invoices instead of "Tax"
77 =item setuptax - if 'Y', this tax does not apply to setup fees
79 =item recurtax - if 'Y', this tax does not apply to recurring fees
89 Creates a new tax rate. To add the tax rate to the database, see L<"insert">.
93 sub table { 'cust_main_county'; }
97 Adds this tax rate to the database. If there is an error, returns the error,
98 otherwise returns false.
102 Deletes this tax rate from the database. If there is an error, returns the
103 error, otherwise returns false.
105 =item replace OLD_RECORD
107 Replaces the OLD_RECORD with this one in the database. If there is an error,
108 returns the error, otherwise returns false.
112 Checks all fields to make sure this is a valid tax rate. If there is an error,
113 returns the error, otherwise returns false. Called by the insert and replace
121 $self->exempt_amount(0) unless $self->exempt_amount;
123 $self->ut_numbern('taxnum')
124 || $self->ut_alphan('district')
125 || $self->ut_textn('city')
126 || $self->ut_textn('county')
127 || $self->ut_anything('state')
128 || $self->ut_text('country')
129 || $self->ut_float('tax')
130 || $self->ut_textn('taxclass') # ...
131 || $self->ut_money('exempt_amount')
132 || $self->ut_textn('taxname')
133 || $self->ut_enum('setuptax', [ '', 'Y' ] )
134 || $self->ut_enum('recurtax', [ '', 'Y' ] )
135 || $self->SUPER::check
142 Returns a label looking like "Anytown, Alameda County, CA, US".
144 If the taxname field is set, it will look like
145 "CA Sales Tax (Anytown, Alameda County, CA, US)".
147 If the taxclass is set, then it will be
148 "Anytown, Alameda County, CA, US (International)".
150 OPTIONS may contain "with_taxclass", "with_city", and "with_district" to show
151 those fields. It may also contain "out", in which case, if this region
152 (district+city+county+state+country) contains no non-zero taxes, the label
153 will read "Out of taxable region(s)".
158 my ($self, %opt) = @_;
161 and !defined(qsearchs('cust_main_county', {
162 'district' => $self->district,
163 'city' => $self->city,
164 'county' => $self->county,
165 'state' => $self->state,
166 'country' => $self->country,
167 'tax' => { op => '>', value => 0 },
170 return 'Out of taxable region(s)';
172 my $label = $self->country;
173 $label = $self->state.", $label" if $self->state;
174 $label = $self->county." County, $label" if $self->county;
175 if ($opt{with_city}) {
176 $label = $self->city.", $label" if $self->city;
177 if ($opt{with_district} and $self->district) {
178 $label = $self->district . ", $label";
181 # ugly labels when taxclass and taxname are both non-null...
182 # but this is how the tax report does it
183 if ($opt{with_taxclass}) {
184 $label = "$label (".$self->taxclass.')' if $self->taxclass;
186 $label = $self->taxname." ($label)" if $self->taxname;
191 =item sql_taxclass_sameregion
193 Returns an SQL WHERE fragment or the empty string to search for entries
194 with different tax classes.
198 #hmm, description above could be better...
200 sub sql_taxclass_sameregion {
203 my $same_query = 'SELECT DISTINCT taxclass FROM cust_main_county '.
204 ' WHERE taxnum != ? AND country = ?';
205 my @same_param = ( 'taxnum', 'country' );
206 foreach my $opt_field (qw( state county )) {
207 if ( $self->$opt_field() ) {
208 $same_query .= " AND $opt_field = ?";
209 push @same_param, $opt_field;
211 $same_query .= " AND $opt_field IS NULL";
215 my @taxclasses = $self->_list_sql( \@same_param, $same_query );
217 return '' unless scalar(@taxclasses);
219 '( taxclass IS NULL OR ( '. #only if !$self->taxclass ??
220 join(' AND ', map { 'taxclass != '.dbh->quote($_) } @taxclasses ).
225 my( $self, $param, $sql ) = @_;
226 my $sth = dbh->prepare($sql) or die dbh->errstr;
227 $sth->execute( map $self->$_(), @$param )
228 or die "Unexpected error executing statement $sql: ". $sth->errstr;
229 map $_->[0], @{ $sth->fetchall_arrayref };
232 =item taxline TAXABLES_ARRAYREF, [ OPTION => VALUE ... ]
234 Takes an arrayref of L<FS::cust_bill_pkg> objects representing taxable
235 line items, and returns a new L<FS::cust_bill_pkg> object representing
236 the tax on them under this tax rate.
238 This will have a pseudo-field, "cust_bill_pkg_tax_location", containing
239 an arrayref of L<FS::cust_bill_pkg_tax_location> objects. Each of these
240 will in turn have a "taxable_cust_bill_pkg" pseudo-field linking it to one
241 of the taxable items. All of these links must be resolved as the objects
244 In addition to calculating the tax for the line items, this will calculate
245 any appropriate tax exemptions and attach them to the line items.
247 Options may include 'custnum' and 'invoice_time' in case the cust_bill_pkg
248 objects belong to an invoice that hasn't been inserted yet.
250 Options may include 'exemptions', an arrayref of L<FS::cust_tax_exempt_pkg>
251 objects belonging to the same customer, to be counted against the monthly
252 tax exemption limit if there is one.
256 # XXX change tax_rate.pm to work like this
259 my( $self, $taxables, %opt ) = @_;
260 return 'taxline called with no line items' unless @$taxables;
262 local $SIG{HUP} = 'IGNORE';
263 local $SIG{INT} = 'IGNORE';
264 local $SIG{QUIT} = 'IGNORE';
265 local $SIG{TERM} = 'IGNORE';
266 local $SIG{TSTP} = 'IGNORE';
267 local $SIG{PIPE} = 'IGNORE';
269 my $oldAutoCommit = $FS::UID::AutoCommit;
270 local $FS::UID::AutoCommit = 0;
273 my $name = $self->taxname || 'Tax';
274 my $taxable_cents = 0;
277 my $cust_bill = $taxables->[0]->cust_bill;
278 my $custnum = $cust_bill ? $cust_bill->custnum : $opt{'custnum'};
279 my $invoice_time = $cust_bill ? $cust_bill->_date : $opt{'invoice_time'};
280 my $cust_main = FS::cust_main->by_key($custnum) if $custnum > 0;
281 # (to avoid complications with estimated tax on quotations, assume it's
282 # taxable if there is no customer)
284 #die "unable to calculate taxes for an unknown customer\n";
287 # set a flag if the customer is tax-exempt
289 my $conf = FS::Conf->new;
290 if ( $conf->exists('cust_class-tax_exempt') ) {
291 my $cust_class = $cust_main->cust_class;
292 $exempt_cust = $cust_class->tax if $cust_class;
294 $exempt_cust = $cust_main->tax;
297 # set a flag if the customer is exempt from this tax here
298 my $exempt_cust_taxname = $cust_main->tax_exemption($self->taxname)
301 # Gather any exemptions that are already attached to these cust_bill_pkgs
302 # so that we can deduct them from the customer's monthly limit.
303 my @existing_exemptions = @{ $opt{'exemptions'} };
304 push @existing_exemptions, @{ $_->cust_tax_exempt_pkg }
307 my $tax_item = FS::cust_bill_pkg->new({
316 foreach my $cust_bill_pkg (@$taxables) {
317 # careful... may be a cust_bill_pkg or a quotation_pkg
319 my $cust_pkg = $cust_bill_pkg->cust_pkg;
320 my $part_pkg = $cust_bill_pkg->part_pkg;
321 my $part_fee = $cust_bill_pkg->part_fee;
323 my $locationnum = $cust_pkg
324 ? $cust_pkg->locationnum
325 : $cust_main->bill_locationnum;
328 my $taxable_charged = $cust_bill_pkg->setup + $cust_bill_pkg->recur
329 or next; # don't create zero-amount exemptions
331 # XXX the following procedure should probably be in cust_bill_pkg
333 if ( $exempt_cust ) {
335 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
336 amount => $taxable_charged,
339 $taxable_charged = 0;
341 } elsif ( $exempt_cust_taxname ) {
343 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
344 amount => $taxable_charged,
345 exempt_cust_taxname => 'Y',
347 $taxable_charged = 0;
351 my $setup_exempt = ( ($part_fee and not $part_fee->taxable)
352 or ($part_pkg and $part_pkg->setuptax)
353 or $self->setuptax );
356 and $cust_bill_pkg->setup > 0
357 and $taxable_charged > 0 ) {
359 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
360 amount => $cust_bill_pkg->setup,
363 $taxable_charged -= $cust_bill_pkg->setup;
367 my $recur_exempt = ( ($part_fee and not $part_fee->taxable)
368 or ($part_pkg and $part_pkg->recurtax)
369 or $self->recurtax );
372 and $cust_bill_pkg->recur > 0
373 and $taxable_charged > 0 ) {
375 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
376 amount => $cust_bill_pkg->recur,
379 $taxable_charged -= $cust_bill_pkg->recur;
383 if ( $self->exempt_amount && $self->exempt_amount > 0
384 and $taxable_charged > 0
387 # XXX monthly exemptions currently don't work on quotations
389 # If the billing period extends across multiple calendar months,
390 # there may be several months of exemption available.
391 my $sdate = $cust_bill_pkg->sdate || $invoice_time;
392 my $start_month = (localtime($sdate))[4] + 1;
393 my $start_year = (localtime($sdate))[5] + 1900;
394 my $edate = $cust_bill_pkg->edate || $invoice_time;
395 my $end_month = (localtime($edate))[4] + 1;
396 my $end_year = (localtime($edate))[5] + 1900;
398 # If the partial last month + partial first month <= one month,
399 # don't use the exemption in the last month
400 # (unless the last month is also the first month, e.g. one-time
402 if ( (localtime($sdate))[3] >= (localtime($edate))[3]
403 and ($start_month != $end_month or $start_year != $end_year)
406 if ( $end_month == 0 ) {
412 # number of months of exemption available
413 my $freq = ($end_month - $start_month) +
414 ($end_year - $start_year) * 12 +
417 # divide equally among all of them
418 my $permonth = sprintf('%.2f', $taxable_charged / $freq);
420 #call the whole thing off if this customer has any old
421 #exemption records...
422 my @cust_tax_exempt =
423 qsearch( 'cust_tax_exempt' => { custnum=> $custnum } );
424 if ( @cust_tax_exempt ) {
425 $dbh->rollback if $oldAutoCommit;
427 'this customer still has old-style tax exemption records; '.
428 'run bin/fs-migrate-cust_tax_exempt?';
431 my ($mon, $year) = ($start_month, $start_year);
432 while ($taxable_charged > 0.005 and
433 ($year < $end_year or
434 ($year == $end_year and $mon <= $end_month)
438 # find the sum of the exemption used by this customer, for this tax,
442 FROM cust_tax_exempt_pkg
443 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
444 LEFT JOIN cust_bill USING ( invnum )
449 AND exempt_monthly = 'Y'
451 my $sth = dbh->prepare($sql) or do {
452 $dbh->rollback if $oldAutoCommit;
453 return "fatal: can't lookup existing exemption: ". dbh->errstr;
461 $dbh->rollback if $oldAutoCommit;
462 return "fatal: can't lookup existing exemption: ". dbh->errstr;
464 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
466 # add any exemption we're already using for another line item
467 foreach ( grep { $_->taxnum == $self->taxnum &&
468 $_->exempt_monthly eq 'Y' &&
471 } @existing_exemptions
474 $existing_exemption += $_->amount;
477 my $remaining_exemption =
478 $self->exempt_amount - $existing_exemption;
479 if ( $remaining_exemption > 0 ) {
480 my $addl = $remaining_exemption > $permonth
482 : $remaining_exemption;
483 $addl = $taxable_charged if $addl > $taxable_charged;
485 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
486 amount => sprintf('%.2f', $addl),
487 exempt_monthly => 'Y',
491 $taxable_charged -= $addl;
493 # if they're using multiple months of exemption for a multi-month
494 # package, then record the exemptions in separate months
502 } # if exempt_amount and $cust_main
504 $_->taxnum($self->taxnum) foreach @new_exemptions;
506 # attach them to the line item
507 push @{ $cust_bill_pkg->cust_tax_exempt_pkg }, @new_exemptions;
508 push @existing_exemptions, @new_exemptions;
510 $taxable_charged = sprintf( "%.2f", $taxable_charged);
511 next if $taxable_charged == 0;
513 my $this_tax_cents = int($taxable_charged * $self->tax);
514 my $location = FS::cust_bill_pkg_tax_location->new({
515 'taxnum' => $self->taxnum,
516 'taxtype' => ref($self),
517 'cents' => $this_tax_cents,
518 'pkgnum' => $cust_bill_pkg->pkgnum,
519 'locationnum' => $locationnum,
520 'taxable_cust_bill_pkg' => $cust_bill_pkg,
521 'tax_cust_bill_pkg' => $tax_item,
523 push @tax_location, $location;
525 $taxable_cents += $taxable_charged;
526 $tax_cents += $this_tax_cents;
527 } #foreach $cust_bill_pkg
529 # now round and distribute
530 my $extra_cents = sprintf('%.2f', $taxable_cents * $self->tax / 100) * 100
532 # make sure we have an integer
533 $extra_cents = sprintf('%.0f', $extra_cents);
534 if ( $extra_cents < 0 ) {
535 die "nonsense extra_cents value $extra_cents";
537 $tax_cents += $extra_cents;
539 foreach (@tax_location) { # can never require more than a single pass, yes?
540 my $cents = $_->get('cents');
541 if ( $extra_cents > 0 ) {
545 $_->set('amount', sprintf('%.2f', $cents/100));
547 $tax_item->set('setup' => sprintf('%.2f', $tax_cents / 100));
548 $tax_item->set('cust_bill_pkg_tax_location', \@tax_location);
559 =item regionselector [ COUNTY STATE COUNTRY [ PREFIX [ ONCHANGE [ DISABLED ] ] ] ]
564 my ( $selected_county, $selected_state, $selected_country,
565 $prefix, $onchange, $disabled ) = @_;
567 $prefix = '' unless defined $prefix;
571 # unless ( @cust_main_county ) { #cache
572 @cust_main_county = qsearch('cust_main_county', {} );
573 foreach my $c ( @cust_main_county ) {
574 $countyflag=1 if $c->county;
575 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
576 $cust_main_county{$c->country}{$c->state}{$c->county} = 1;
579 $countyflag=1 if $selected_county;
581 my $script_html = <<END;
583 function opt(what,value,text) {
584 var optionName = new Option(text, value, false, false);
585 var length = what.length;
586 what.options[length] = optionName;
588 function ${prefix}country_changed(what) {
589 country = what.options[what.selectedIndex].text;
590 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
591 what.form.${prefix}state.options[i] = null;
593 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
595 foreach my $country ( sort keys %cust_main_county ) {
596 $script_html .= "\nif ( country == \"$country\" ) {\n";
597 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
598 ( my $dstate = $state ) =~ s/[\n\r]//g;
599 my $text = $dstate || '(n/a)';
600 $script_html .= qq!opt(what.form.${prefix}state, "$dstate", "$text");\n!;
602 $script_html .= "}\n";
605 $script_html .= <<END;
607 function ${prefix}state_changed(what) {
611 $script_html .= <<END;
612 state = what.options[what.selectedIndex].text;
613 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
614 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
615 what.form.${prefix}county.options[i] = null;
618 foreach my $country ( sort keys %cust_main_county ) {
619 $script_html .= "\nif ( country == \"$country\" ) {\n";
620 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
621 $script_html .= "\nif ( state == \"$state\" ) {\n";
622 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
623 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
624 my $text = $county || '(n/a)';
626 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
628 $script_html .= "}\n";
630 $script_html .= "}\n";
634 $script_html .= <<END;
639 my $county_html = $script_html;
641 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$onchange" $disabled>!;
642 $county_html .= '</SELECT>';
645 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$selected_county">!;
648 my $state_html = qq!<SELECT NAME="${prefix}state" !.
649 qq!onChange="${prefix}state_changed(this); $onchange" $disabled>!;
650 foreach my $state ( sort keys %{ $cust_main_county{$selected_country} } ) {
651 my $text = $state || '(n/a)';
652 my $selected = $state eq $selected_state ? 'SELECTED' : '';
653 $state_html .= qq(\n<OPTION $selected VALUE="$state">$text</OPTION>);
655 $state_html .= '</SELECT>';
657 $state_html .= '</SELECT>';
659 my $country_html = qq!<SELECT NAME="${prefix}country" !.
660 qq!onChange="${prefix}country_changed(this); $onchange" $disabled>!;
661 my $countrydefault = $conf->config('countrydefault') || 'US';
662 foreach my $country (
663 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
664 keys %cust_main_county
666 my $selected = $country eq $selected_country ? ' SELECTED' : '';
667 $country_html .= qq(\n<OPTION$selected VALUE="$country">$country</OPTION>");
669 $country_html .= '</SELECT>';
671 ($county_html, $state_html, $country_html);
679 regionselector? putting web ui components in here? they should probably live
684 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill>, schema.html from the base