1 package FS::TaxEngine::internal;
4 use base 'FS::TaxEngine';
5 use FS::Record qw(dbh qsearch qsearchs);
9 FS::UID->install_callback(sub {
10 $conf = FS::Conf->new;
15 FS::TaxEngine::internal: the classic Freeside "internal tax engine".
16 Uses tax rates and localities defined in L<FS::cust_main_county>.
23 my ($self, $cust_bill_pkg) = @_;
25 my $part_item = $cust_bill_pkg->part_X;
26 my $location = $cust_bill_pkg->tax_location;
27 my $custnum = $self->{cust_main}->custnum;
29 push @{ $self->{items} }, $cust_bill_pkg;
31 my @loc_keys = qw( district city county state country );
32 my %taxhash = map { $_ => $location->get($_) } @loc_keys;
34 $taxhash{'taxclass'} = $part_item->taxclass;
36 my @taxes = (); # entries are cust_main_county objects
37 my %taxhash_elim = %taxhash;
38 my @elim = qw( district city county state );
41 #first try a match with taxclass
42 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
44 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
45 #then try a match without taxclass
46 my %no_taxclass = %taxhash_elim;
47 $no_taxclass{ 'taxclass' } = '';
48 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
51 $taxhash_elim{ shift(@elim) } = '';
52 } while ( !scalar(@taxes) && scalar(@elim) );
54 foreach my $tax (@taxes) {
55 my $taxnum = $tax->taxnum;
56 $self->{taxes}->{$taxnum} ||= [ $tax ];
57 $cust_bill_pkg->set_exemptions( $tax, 'custnum' => $custnum );
58 push @{ $self->{taxes}->{$taxnum} }, $cust_bill_pkg;
63 my ($self, %opt) = @_;
64 my $tax_object = $opt{tax};
65 my $taxables = $opt{sales};
66 my $taxnum = $tax_object->taxnum;
67 my $exemptions = $self->{exemptions}->{$taxnum} ||= [];
69 my $taxable_cents = 0;
72 my $round_per_line_item = $conf->exists('tax-round_per_line_item');
74 my $cust_main = $self->{cust_main};
75 my $custnum = $cust_main->custnum;
76 my $invoice_time = $self->{invoice_time};
78 # set a flag if the customer is tax-exempt
80 my $conf = FS::Conf->new;
81 if ( $conf->exists('cust_class-tax_exempt') ) {
82 my $cust_class = $cust_main->cust_class;
83 $exempt_cust = $cust_class->tax if $cust_class;
85 $exempt_cust = $cust_main->tax;
87 # set a flag if the customer is exempt from this tax here
88 my $exempt_cust_taxname = $cust_main->tax_exemption($tax_object->taxname)
89 if $tax_object->taxname;
91 # Gather any exemptions that are already attached to these cust_bill_pkgs
92 # so that we can deduct them from the customer's monthly limit.
93 my @existing_exemptions = @{ $exemptions };
94 push @existing_exemptions, @{ $_->cust_tax_exempt_pkg }
99 foreach my $cust_bill_pkg (@$taxables) {
101 my $cust_pkg = $cust_bill_pkg->cust_pkg;
102 my $part_pkg = $cust_bill_pkg->part_pkg;
104 my $taxable_charged = $cust_bill_pkg->setup + $cust_bill_pkg->recur
105 or next; # don't create zero-amount exemptions
107 # XXX the following procedure should probably be in cust_bill_pkg
109 if ( $exempt_cust ) {
111 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
112 amount => $taxable_charged,
115 $taxable_charged = 0;
117 } elsif ( $exempt_cust_taxname ) {
119 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
120 amount => $taxable_charged,
121 exempt_cust_taxname => 'Y',
123 $taxable_charged = 0;
127 if ( ($part_pkg->setuptax eq 'Y' or $tax_object->setuptax eq 'Y')
128 and $cust_bill_pkg->setup > 0 and $taxable_charged > 0 ) {
130 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
131 amount => $cust_bill_pkg->setup,
134 $taxable_charged -= $cust_bill_pkg->setup;
137 if ( ($part_pkg->recurtax eq 'Y' or $tax_object->recurtax eq 'Y')
138 and $cust_bill_pkg->recur > 0 and $taxable_charged > 0 ) {
140 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
141 amount => $cust_bill_pkg->recur,
144 $taxable_charged -= $cust_bill_pkg->recur;
148 if ( $tax_object->exempt_amount && $tax_object->exempt_amount > 0
149 and $taxable_charged > 0 ) {
150 # If the billing period extends across multiple calendar months,
151 # there may be several months of exemption available.
152 my $sdate = $cust_bill_pkg->sdate || $invoice_time;
153 my $start_month = (localtime($sdate))[4] + 1;
154 my $start_year = (localtime($sdate))[5] + 1900;
155 my $edate = $cust_bill_pkg->edate || $invoice_time;
156 my $end_month = (localtime($edate))[4] + 1;
157 my $end_year = (localtime($edate))[5] + 1900;
159 # If the partial last month + partial first month <= one month,
160 # don't use the exemption in the last month
161 # (unless the last month is also the first month, e.g. one-time
163 if ( (localtime($sdate))[3] >= (localtime($edate))[3]
164 and ($start_month != $end_month or $start_year != $end_year)
167 if ( $end_month == 0 ) {
173 # number of months of exemption available
174 my $freq = ($end_month - $start_month) +
175 ($end_year - $start_year) * 12 +
178 # divide equally among all of them
179 my $permonth = sprintf('%.2f', $taxable_charged / $freq);
181 #call the whole thing off if this customer has any old
182 #exemption records...
183 my @cust_tax_exempt =
184 qsearch( 'cust_tax_exempt' => { custnum=> $custnum } );
185 if ( @cust_tax_exempt ) {
187 'this customer still has old-style tax exemption records; '.
188 'run bin/fs-migrate-cust_tax_exempt?';
191 my ($mon, $year) = ($start_month, $start_year);
192 while ($taxable_charged > 0.005 and
193 ($year < $end_year or
194 ($year == $end_year and $mon <= $end_month)
198 # find the sum of the exemption used by this customer, for this tax,
202 FROM cust_tax_exempt_pkg
203 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
204 LEFT JOIN cust_bill USING ( invnum )
209 AND exempt_monthly = 'Y'
211 my $sth = dbh->prepare($sql) or
212 return "fatal: can't lookup existing exemption: ". dbh->errstr;
219 return "fatal: can't lookup existing exemption: ". dbh->errstr;
220 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
222 # add any exemption we're already using for another line item
223 foreach ( grep { $_->taxnum == $tax_object->taxnum &&
224 $_->exempt_monthly eq 'Y' &&
227 } @existing_exemptions
230 $existing_exemption += $_->amount;
233 my $remaining_exemption =
234 $tax_object->exempt_amount - $existing_exemption;
235 if ( $remaining_exemption > 0 ) {
236 my $addl = $remaining_exemption > $permonth
238 : $remaining_exemption;
239 $addl = $taxable_charged if $addl > $taxable_charged;
241 push @new_exemptions, FS::cust_tax_exempt_pkg->new({
242 amount => sprintf('%.2f', $addl),
243 exempt_monthly => 'Y',
248 $taxable_charged -= $addl;
250 # if they're using multiple months of exemption for a multi-month
251 # package, then record the exemptions in separate months
261 # attach them to the line item
262 foreach my $ex (@new_exemptions) {
264 $ex->set('taxnum', $taxnum);
266 if ( $cust_bill_pkg->billpkgnum ) {
267 # the exempted item is already inserted (it should be, these days) so
268 # insert the exemption record now:
269 $ex->set('billpkgnum', $cust_bill_pkg->billpkgnum);
270 my $error = $ex->insert;
271 return "inserting tax exemption record: $error" if $error;
274 # defer it until the item is inserted
275 push @{ $cust_bill_pkg->cust_tax_exempt_pkg }, $ex;
279 # and remember we've used the exemption
280 push @existing_exemptions, @new_exemptions;
282 $taxable_charged = sprintf( "%.2f", $taxable_charged);
283 next if $taxable_charged == 0;
285 my $this_tax_cents = $taxable_charged * $tax_object->tax;
286 if ( $round_per_line_item ) {
287 # Round the tax to the nearest cent for each line item, instead of
288 # across the whole invoice.
289 $this_tax_cents = sprintf('%.0f', $this_tax_cents);
291 # Otherwise truncate it so that rounding error is always positive.
292 $this_tax_cents = int($this_tax_cents);
295 my $location = FS::cust_bill_pkg_tax_location->new({
296 'taxnum' => $tax_object->taxnum,
297 'taxtype' => ref($tax_object),
298 'cents' => $this_tax_cents,
299 'pkgnum' => $cust_bill_pkg->pkgnum,
300 'locationnum' => $cust_bill_pkg->cust_pkg->tax_locationnum,
301 'taxable_cust_bill_pkg' => $cust_bill_pkg,
303 push @tax_links, $location;
305 $taxable_cents += $taxable_charged;
306 $tax_cents += $this_tax_cents;
307 } #foreach $cust_bill_pkg
309 # calculate tax and rounding error for the whole group
310 my $extra_cents = sprintf('%.2f', $taxable_cents * $tax_object->tax / 100)
312 # make sure we have an integer
313 $extra_cents = sprintf('%.0f', $extra_cents);
315 # if we're rounding per item, then ignore that and don't distribute any
317 if ( $round_per_line_item ) {
321 if ( $extra_cents < 0 ) {
322 die "nonsense extra_cents value $extra_cents";
324 $tax_cents += $extra_cents;
326 foreach (@tax_links) { # can never require more than a single pass, yes?
327 my $cents = $_->get('cents');
328 if ( $extra_cents > 0 ) {
332 $_->set('amount', sprintf('%.2f', $cents/100));
342 rate_table => 'cust_main_county',
343 link_table => 'cust_bill_pkg_tax_location',