fix tax report for more complex situations with counties and taxclasses, make taxable...
[freeside.git] / httemplate / search / cust_bill_pkg.cgi
index cc0f975..89901ac 100644 (file)
-<%
+<% include( 'elements/search.html',
+                 'title'       => 'Line items',
+                 'name'        => 'line items',
+                 'query'       => $query,
+                 'count_query' => $count_query,
+                 'count_addl'  => [ $money_char. '%.2f total', ],
+                 'header'      => [
+                   '#',
+                   'Description',
+                   'Setup charge',
+                   'Recurring charge',
+                   'Invoice',
+                   'Date',
+                   FS::UI::Web::cust_header(),
+                 ],
+                 'fields'      => [
+                   'billpkgnum',
+                   sub { $_[0]->pkgnum > 0
+                           ? $_[0]->get('pkg')
+                           : $_[0]->get('itemdesc')
+                       },
+                   #strikethrough or "N/A ($amount)" or something these when
+                   # they're not applicable to pkg_tax search
+                   sub { sprintf($money_char.'%.2f', shift->setup ) },
+                   sub { sprintf($money_char.'%.2f', shift->recur ) },
+                   'invnum',
+                   sub { time2str('%b %d %Y', shift->_date ) },
+                   \&FS::UI::Web::cust_fields,
+                 ],
+                 'links'       => [
+                   '',
+                   '',
+                   '',
+                   '',
+                   $ilink,
+                   $ilink,
+                   ( map { $_ ne 'Cust. Status' ? $clink : '' }
+                         FS::UI::Web::cust_header()
+                   ),
+                 ],
+                 'align' => 'rlrrrc'.FS::UI::Web::cust_aligns(),
+                 'color' => [ 
+                              '',
+                              '',
+                              '',
+                              '',
+                              '',
+                              '',
+                              FS::UI::Web::cust_colors(),
+                            ],
+                 'style' => [ 
+                              '',
+                              '',
+                              '',
+                              '',
+                              '',
+                              '',
+                              FS::UI::Web::cust_styles(),
+                            ],
+           )
+%>
+<%init>
 
-my($beginning, $ending) = FS::UI::Web::parse_beginning_ending($cgi);
+die "access denied"
+  unless $FS::CurrentUser::CurrentUser->access_right('Financial reports');
 
-my $join_cust = "
-    JOIN cust_bill USING ( invnum ) 
-    LEFT JOIN cust_main USING ( custnum )
-";
+my $conf = new FS::Conf;
+
+#here is the agent virtualization
+my $agentnums_sql =
+  $FS::CurrentUser::CurrentUser->agentnums_sql( 'table' => 'cust_main' );
 
-my $join_pkg = "
-    LEFT JOIN cust_pkg USING ( pkgnum )
-    LEFT JOIN part_pkg USING ( pkgpart )
-";
+my @where = ( $agentnums_sql );
+
+my($beginning, $ending) = FS::UI::Web::parse_beginning_ending($cgi);
+push @where, "_date >= $beginning",
+             "_date <= $ending";
 
-my $where = "
-  WHERE _date >= $beginning AND _date <= $ending
-    AND payby != 'COMP'
-";
+push @where , " payby != 'COMP' "
+  unless $cgi->param('include_comp_cust');
 
 if ( $cgi->param('agentnum') =~ /^(\d+)$/ ) {
-  $where .= " AND agentnum = $1 ";
+  push @where, "cust_main.agentnum = $1";
 }
 
+if ( $cgi->param('classnum') =~ /^(\d+)$/ ) {
+  if ( $1 == 0 ) {
+    push @where, "classnum IS NULL";
+  } else {
+    push @where, "classnum = $1";
+  }
+}
+
+#sub _where {
+# my $table = shift;
+# my $prefix = @_ ? shift : '';
+# "
+#      (    cust_main_county.county  = $table.${prefix}.county
+#      OR ( cust_main_county.county IS NULL AND $table.${prefix}.county  =  '' )
+#      OR ( cust_main_county.county  =  ''  AND $table.${prefix}.county IS NULL)
+#      OR ( cust_main_county.county IS NULL AND $table.${prefix}.county IS NULL)
+#      )
+#  AND (    cust_main_county.state   = $table.${prefix}.state
+#      OR ( cust_main_county.state  IS NULL AND $table.${prefix}.state  =  ''  )
+#      OR ( cust_main_county.state   =  ''  AND $table.${prefix}.state IS NULL )
+#      OR ( cust_main_county.state  IS NULL AND $table.${prefix}.state IS NULL )
+#      )
+#  AND cust_main_county.country = $table.${prefix}.country
+# ";
+#
+#}
+
 if ( $cgi->param('out') ) {
 
-  $where .= "
-    AND 0 = (
-      SELECT COUNT(*) FROM cust_main_county
-      WHERE (    cust_main_county.county  = cust_main.county
-              OR ( cust_main_county.county IS NULL AND cust_main.county  =  '' )
-              OR ( cust_main_county.county  =  ''  AND cust_main.county IS NULL)
-              OR ( cust_main_county.county IS NULL AND cust_main.county IS NULL)
-            )
-        AND (    cust_main_county.state   = cust_main.state
-              OR ( cust_main_county.state  IS NULL AND cust_main.state  =  ''  )
-              OR ( cust_main_county.state   =  ''  AND cust_main.state IS NULL )
-              OR ( cust_main_county.state  IS NULL AND cust_main.state IS NULL )
-            )
-        AND cust_main_county.country = cust_main.country
-        AND cust_main_county.tax > 0
-    )
+  my ( $loc_sql, @param ) = FS::cust_pkg->location_sql( 'ornull' => 1 );
+  while ( $loc_sql =~ /\?/ ) { #easier to do our own substitution
+    $loc_sql =~ s/\?/'cust_main_county.'.shift(@param)/e;
+  }
+
+  $loc_sql =~ s/cust_pkg\.locationnum/cust_bill_pkg_tax_location.locationnum/g
+    if $cgi->param('istax');
+
+  push @where, "
+    0 = (
+          SELECT COUNT(*) FROM cust_main_county
+           WHERE cust_main_county.tax > 0
+             AND $loc_sql
+        )
   ";
 
+  #not linked to by anything, but useful for debugging "out of taxable region"
+  if ( grep $cgi->param($_), qw( county state country ) ) {
+
+    my %ph = map { $_ => dbh->quote( $cgi->param($_) ) }
+                 qw( county state country );
+
+    my ( $loc_sql, @param ) = FS::cust_pkg->location_sql;
+    while ( $loc_sql =~ /\?/ ) { #easier to do our own substitution
+      $loc_sql =~ s/\?/$ph{shift(@param)}/e;
+    }
+
+    push @where, $loc_sql;
+
+  }
+
 } elsif ( $cgi->param('country' ) ) {
 
-  my $county  = dbh->quote( $cgi->param('county')  );
-  my $state   = dbh->quote( $cgi->param('state')   );
-  my $country = dbh->quote( $cgi->param('country') );
-  $where .= "
-    AND ( county  = $county OR $county = '' )
-    AND ( state   = $state  OR $state = '' )
-    AND   country = $country
-  ";
-  $where .= ' AND taxclass = '. dbh->quote( $cgi->param('taxclass') )
-    if $cgi->param('taxclass');
+  my %ph = map { $_ => dbh->quote( $cgi->param($_) ) }
+               qw( county state country );
 
-}
+  my ( $loc_sql, @param ) = FS::cust_pkg->location_sql;
+  while ( $loc_sql =~ /\?/ ) { #easier to do our own substitution
+    $loc_sql =~ s/\?/$ph{shift(@param)}/e;
+  }
 
-$where .= ' AND pkgnum != 0' if $cgi->param('nottax');
+  push @where, $loc_sql;
+   
+  if ( $cgi->param('istax') ) {
+    if ( $cgi->param('taxname') ) {
+      push @where, 'itemdesc = '. dbh->quote( $cgi->param('taxname') );
+    #} elsif ( $cgi->param('taxnameNULL') {
+    } else {
+      push @where, "( itemdesc IS NULL OR itemdesc = '' OR itemdesc = 'Tax' )";
+    }
+  } elsif ( $cgi->param('nottax') ) {
+    #what can we usefully do with "taxname" ????  look up a class???
+  } else {
+    #warn "neither nottax nor istax parameters specified";
+  }
 
-$where .= ' AND pkgnum = 0' if $cgi->param('istax');
+  push @where, ' taxclass = '. dbh->quote( $cgi->param('taxclass') )
+    if $cgi->param('taxclass')
+    && ! $cgi->param('istax'); #no part_pkg.taxclass in this case
+                               #(should we save a taxclass or a link to taxnum
+                               # in cust_bill_pkg or something like
+                               # cust_bill_pkg_tax_location?)
 
-$where .= " AND tax = 'Y'" if $cgi->param('cust_tax');
+  if ( $cgi->param('taxclassNULL') ) {
+
+    my %hash = ( 'country' => scalar($cgi->param('country')) );
+    foreach (qw( state county )) {
+      $hash{$_} = scalar($cgi->param($_)) if $cgi->param($_);
+    }
+    my $cust_main_county = qsearchs('cust_main_county', \%hash);
+    die "unknown base region for empty taxclass" unless $cust_main_county;
+
+    my $same_sql = $cust_main_county->sql_taxclass_sameregion;
+    push @where, $same_sql if $same_sql;
+
+  }
+
+}
+
+if ($cgi->param('itemdesc')) {
+  if ($cgi->param('itemdesc') eq 'Tax') {
+    push @where, "(itemdesc='Tax' OR itemdesc is null)";
+  }else{
+    push @where, 'itemdesc='. dbh->quote($cgi->param('itemdesc'));
+  }
+}
+push @where, 'cust_bill_pkg.pkgnum != 0' if $cgi->param('nottax');
+push @where, 'cust_bill_pkg.pkgnum  = 0' if $cgi->param('istax');
+
+push @where, " tax = 'Y' " if $cgi->param('cust_tax');
 
 my $count_query;
 if ( $cgi->param('pkg_tax') ) {
 
   $count_query =
-    "SELECT COUNT(*), SUM(
-                           ( CASE WHEN part_pkg.setuptax = 'Y'
-                                  THEN cust_bill_pkg.setup
-                                  ELSE 0
-                             END
-                           )
-                           +
-                           ( CASE WHEN part_pkg.recurtax = 'Y'
-                                  THEN cust_bill_pkg.recur
-                                  ELSE 0
-                             END
-                           )
-                         )
+    "SELECT COUNT(*),
+            SUM(
+                 ( CASE WHEN part_pkg.setuptax = 'Y'
+                        THEN cust_bill_pkg.setup
+                        ELSE 0
+                   END
+                 )
+                 +
+                 ( CASE WHEN part_pkg.recurtax = 'Y'
+                        THEN cust_bill_pkg.recur
+                        ELSE 0
+                   END
+                 )
+               )
     ";
 
-  $where .= " AND (
-                       ( part_pkg.setuptax = 'Y' AND cust_bill_pkg.setup > 0 )
-                    OR ( part_pkg.recurtax = 'Y' AND cust_bill_pkg.recur > 0 )
-                  )
-              AND ( tax != 'Y' OR tax IS NULL )
-            ";
+  push @where, "(    ( part_pkg.setuptax = 'Y' AND cust_bill_pkg.setup > 0 )
+                  OR ( part_pkg.recurtax = 'Y' AND cust_bill_pkg.recur > 0 ) )",
+               "( tax != 'Y' OR tax IS NULL )";
+
+} elsif ( $cgi->param('taxable') ) {
+
+  my $setup_taxable = "(
+    CASE WHEN part_pkg.setuptax = 'Y'
+         THEN 0
+         ELSE cust_bill_pkg.setup
+    END
+  )";
+
+  my $recur_taxable = "(
+    CASE WHEN part_pkg.recurtax = 'Y'
+         THEN 0
+         ELSE cust_bill_pkg.recur
+    END
+  )";
+
+  my $exempt = "(
+    SELECT COALESCE( SUM(amount), 0 ) FROM cust_tax_exempt_pkg
+      WHERE cust_tax_exempt_pkg.billpkgnum = cust_bill_pkg.billpkgnum
+  )";
+
+  $count_query =
+    "SELECT COUNT(*), SUM( $setup_taxable + $recur_taxable - $exempt )";
+
+  push @where,
+    #not tax-exempt package (setup or recur)
+    "(
+          ( ( part_pkg.setuptax != 'Y' OR part_pkg.setuptax IS NULL )
+            AND cust_bill_pkg.setup > 0 )
+       OR
+          ( ( part_pkg.recurtax != 'Y' OR part_pkg.recurtax IS NULL )
+            AND cust_bill_pkg.recur > 0 )
+    )",
+    #not a tax_exempt customer
+    "( tax != 'Y' OR tax IS NULL )";
+    #not covered in full by a monthly tax exemption (texas tax)
+    "0 < ( $setup_taxable + $recur_taxable - $exempt )",
 
 } else {
 
@@ -94,20 +271,59 @@ if ( $cgi->param('pkg_tax') ) {
     "SELECT COUNT(*), SUM(cust_bill_pkg.setup + cust_bill_pkg.recur)";
 
 }
-$count_query .= " FROM cust_bill_pkg $join_cust  $join_pkg $where";
+
+my $where = ' WHERE '. join(' AND ', @where);
+
+my $join_cust =  '      JOIN cust_bill USING ( invnum ) 
+                   LEFT JOIN cust_main USING ( custnum ) ';
+
+
+my $join_pkg;
+if ( $cgi->param('nottax') ) {
+
+  $join_pkg =  ' LEFT JOIN cust_pkg USING ( pkgnum )
+                 LEFT JOIN part_pkg USING ( pkgpart ) ';
+  $join_pkg .= ' LEFT JOIN cust_location USING ( locationnum ) '
+    if $conf->exists('tax-pkg_address');
+
+} elsif ( $cgi->param('istax') ) {
+
+  #false laziness w/report_tax.cgi $taxfromwhere
+  if ( $conf->exists('tax-pkg_address') ) {
+    $join_pkg .= ' LEFT JOIN cust_bill_pkg_tax_location USING ( billpkgnum )
+                   LEFT JOIN cust_location              USING ( locationnum ) ';
+
+    #quelle kludge, false laziness w/report_tax.cgi
+    $where =~ s/cust_pkg\.locationnum/cust_bill_pkg_tax_location.locationnum/g; 
+  }
+
+} else { 
+
+  #die?
+  warn "neiether nottax nor istax parameters specified";
+  #same as before?
+  $join_pkg =  ' LEFT JOIN cust_pkg USING ( pkgnum )
+                 LEFT JOIN part_pkg USING ( pkgpart ) ';
+
+}
+
+$count_query .= " FROM cust_bill_pkg $join_cust $join_pkg $where";
+
+my @select = (
+               'cust_bill_pkg.*',
+               'cust_bill._date',
+             );
+push @select, 'part_pkg.pkg' unless $cgi->param('istax');
+push @select, 'cust_main.custnum',
+              FS::UI::Web::cust_sql_fields();
 
 my $query = {
   'table'     => 'cust_bill_pkg',
   'addl_from' => "$join_cust $join_pkg",
   'hashref'   => {},
-  'select'    => join(', ',
-                   'cust_bill_pkg.*',
-                   'cust_bill._date',
-                   'part_pkg.pkg',
-                   'cust_main.custnum',
-                   FS::UI::Web::cust_sql_fields(),
-                 ),
+  'select'    => join(', ', @select ),
   'extra_sql' => $where,
+  'order_by'  => 'ORDER BY _date, billpkgnum',
 };
 
 my $ilink = [ "${p}view/cust_bill.cgi?", 'invnum' ];
@@ -116,45 +332,4 @@ my $clink = [ "${p}view/cust_main.cgi?", 'custnum' ];
 my $conf = new FS::Conf;
 my $money_char = $conf->config('money_char') || '$';
 
-%><%= include( 'elements/search.html',
-                 'title'       => 'Line items',
-                 'name'        => 'line items',
-                 'query'       => $query,
-                 'count_query' => $count_query,
-                 'count_addl'  => [ $money_char. '%.2f total', ],
-                 'header'      => [
-                   '#',
-                   'Description',
-                   'Setup charge',
-                   'Recurring charge',
-                   'Invoice',
-                   'Date',
-                   FS::UI::Web::cust_header(),
-                 ],
-                 'fields'      => [
-                   'billpkgnum',
-                   sub { $_[0]->pkgnum > 0
-                           ? $_[0]->get('pkg')
-                           : $_[0]->get('itemdesc')
-                       },
-                   #strikethrough or "N/A ($amount)" or something these when
-                   # they're not applicable to pkg_tax search
-                   sub { sprintf($money_char.'%.2f', shift->setup ) },
-                   sub { sprintf($money_char.'%.2f', shift->recur ) },
-                   'invnum',
-                   sub { time2str('%b %d %Y', shift->_date ) },
-                   \&FS::UI::Web::cust_fields,
-                 ],
-                 'links'       => [
-                   '',
-                   '',
-                   '',
-                   '',
-                   $ilink,
-                   $ilink,
-                   ( map { $clink } FS::UI::Web::cust_header() ),
-                 ],
-                 'align' => 'rlrrrc',
-           )
-%>
-
+</%init>