From: Ivan Kohler
Date: Mon, 25 Apr 2016 16:58:14 +0000 (-0700)
Subject: Merge branch 'master' of git.freeside.biz:/home/git/freeside
X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=commitdiff_plain;h=46fe3dbcb3ca97d1f3c70d49351846cf0ab6461d;hp=cc4caa54e9974ea3d6ac7cf55cf45863d2a8905e
Merge branch 'master' of git.freeside.biz:/home/git/freeside
---
diff --git a/FS/FS/API.pm b/FS/FS/API.pm
index 32400f7c3..9d0ef2515 100644
--- a/FS/FS/API.pm
+++ b/FS/FS/API.pm
@@ -8,6 +8,7 @@ use FS::cust_location;
use FS::cust_pay;
use FS::cust_credit;
use FS::cust_refund;
+use FS::cust_pkg;
=head1 NAME
@@ -556,6 +557,87 @@ sub location_info {
return \%return;
}
+=item change_package_location
+
+Updates package location. Takes a list of keys and values
+as paramters with the following keys:
+
+pkgnum
+
+secret
+
+locationnum - pass this, or the following keys (don't pass both)
+
+locationname
+
+address1
+
+address2
+
+city
+
+county
+
+state
+
+zip
+
+addr_clean
+
+country
+
+censustract
+
+censusyear
+
+location_type
+
+location_number
+
+location_kind
+
+incorporated
+
+On error, returns a hashref with an 'error' key.
+On success, returns a hashref with 'pkgnum' and 'locationnum' keys,
+containing the new values.
+
+=cut
+
+sub change_package_location {
+ my $class = shift;
+ my %opt = @_;
+ return _shared_secret_error() unless _check_shared_secret($opt{'secret'});
+
+ my $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $opt{'pkgnum'} })
+ or return { 'error' => 'Unknown pkgnum' };
+
+ my %changeopt;
+
+ foreach my $field ( qw(
+ locationnum
+ locationname
+ address1
+ address2
+ city
+ county
+ state
+ zip
+ addr_clean
+ country
+ censustract
+ censusyear
+ location_type
+ location_number
+ location_kind
+ incorporated
+ )) {
+ $changeopt{$field} = $opt{$field} if $opt{$field};
+ }
+
+ $cust_pkg->API_change(%changeopt);
+}
+
=item bill_now OPTION => VALUE, ...
Bills a single customer now, in the same fashion as the "Bill now" link in the
diff --git a/FS/FS/ClientAPI/MyAccount.pm b/FS/FS/ClientAPI/MyAccount.pm
index d6fa8652c..ed7e35317 100644
--- a/FS/FS/ClientAPI/MyAccount.pm
+++ b/FS/FS/ClientAPI/MyAccount.pm
@@ -3605,11 +3605,6 @@ sub adjust_ticket_priority {
my($context, $session, $custnum) = _custoragent_session_custnum($p);
return { 'error' => $session } if $context eq 'error';
- # temporary instrumentation for RT#39536
- local $DEBUG = 1;
- local $FS::TicketSystem::RT_Internal::DEBUG = 1;
- warn "[adjust_ticket_priority]\n" . Dumper($p->{'values'}) . "\n\n";
-
# warn "$me adjust_ticket_priority: initializing ticket system\n" if $DEBUG;
# FS::TicketSystem->init;
my $ss_priority = FS::TicketSystem->selfservice_priority;
diff --git a/FS/FS/ClientAPI/Signup.pm b/FS/FS/ClientAPI/Signup.pm
index df9ee88e5..5010ec97d 100644
--- a/FS/FS/ClientAPI/Signup.pm
+++ b/FS/FS/ClientAPI/Signup.pm
@@ -7,7 +7,7 @@ use Data::Dumper;
use Tie::RefHash;
use Digest::SHA qw(sha512_hex);
use FS::Conf;
-use FS::Record qw(qsearch qsearchs dbdef);
+use FS::Record qw(qsearch qsearchs dbdef dbh);
use FS::CGI qw(popurl);
use FS::Msgcat qw(gettext);
use FS::Misc qw(card_types);
@@ -31,6 +31,25 @@ use FS::cust_payby;
$DEBUG = 1;
$me = '[FS::ClientAPI::Signup]';
+=head1 NAME
+
+FS::ClientAPI::Signup - Front-end API for signing up customers
+
+=head1 DESCRIPTION
+
+This module provides the ClientAPI functions for talking to a signup
+server. The signup server is open to the public, i.e. does not require a
+login. The back-end Freeside server creates customers, orders packages and
+services, and processes initial payments.
+
+=head1 METHODS
+
+=over 4
+
+=cut
+
+# document the rest of this as we work on it
+
sub clear_cache {
warn "$me clear_cache called\n" if $DEBUG;
my $cache = new FS::ClientAPI_SessionCache( {
@@ -499,21 +518,8 @@ sub new_customer {
#possibly some validation will be needed
}
- my $agentnum;
- if ( exists $packet->{'session_id'} ) {
- my $cache = new FS::ClientAPI_SessionCache( {
- 'namespace' => 'FS::ClientAPI::Agent',
- } );
- my $session = $cache->get($packet->{'session_id'});
- if ( $session ) {
- $agentnum = $session->{'agentnum'};
- } else {
- return { 'error' => "Can't resume session" }; #better error message
- }
- } else {
- $agentnum = $packet->{agentnum}
- || $conf->config('signup_server-default_agentnum');
- }
+ my $agentnum = get_agentnum($packet);
+ return $agentnum if ref($agentnum);
my ($bill_hash, $ship_hash);
foreach my $f (FS::cust_main->location_fields) {
@@ -924,21 +930,8 @@ sub new_customer_minimal {
#possibly some validation will be needed
}
- my $agentnum;
- if ( exists $packet->{'session_id'} ) {
- my $cache = new FS::ClientAPI_SessionCache( {
- 'namespace' => 'FS::ClientAPI::Agent',
- } );
- my $session = $cache->get($packet->{'session_id'});
- if ( $session ) {
- $agentnum = $session->{'agentnum'};
- } else {
- return { 'error' => "Can't resume session" }; #better error message
- }
- } else {
- $agentnum = $packet->{agentnum}
- || $conf->config('signup_server-default_agentnum');
- }
+ my $agentnum = get_agentnum($packet);
+ return $agentnum if ref($agentnum);
#shares some stuff with htdocs/edit/process/cust_main.cgi... take any
# common that are still here and library them.
@@ -1220,4 +1213,186 @@ sub capture_payment {
}
+=item get_agentnum PACKET
+
+Given a PACKET from the signup server, looks up the agentnum to use for signing
+up a customer. This will use 'session_id' if the agent is authenticated,
+otherwise 'agentnum', otherwise the 'signup_server-default_agentnum' config. If
+the agent can't be found, returns an error packet.
+
+=cut
+
+sub get_agentnum {
+ my $packet = shift;
+ my $conf = new FS::Conf;
+ my $agentnum;
+ if ( exists $packet->{'session_id'} ) {
+ my $cache = new FS::ClientAPI_SessionCache( {
+ 'namespace' => 'FS::ClientAPI::Agent',
+ } );
+ my $session = $cache->get($packet->{'session_id'});
+ if ( $session ) {
+ $agentnum = $session->{'agentnum'};
+ } else {
+ return { 'error' => "Can't resume session" }; #better error message
+ }
+ } else {
+ $agentnum = $packet->{agentnum}
+ || $conf->config('signup_server-default_agentnum');
+ }
+ if ( $agentnum and FS::agent->count('agentnum = ?', $agentnum) ) {
+ return $agentnum;
+ }
+ return { 'error' => 'Signup is not configured' };
+}
+
+=item new_prospect PACKET
+
+Creates a new L entry. PACKET must contain:
+
+- either agentnum or session_id; if not, signup_server-default_agentnum will
+be used and must not be empty
+
+- either refnum or referral_title; if not, signup_server-default_refnum will
+be used and must not be empty
+
+- last and first (names), and optionally company and title
+
+- address1, city, state, country, zip, and optionally address2
+
+- emailaddress
+
+and can also contain:
+
+- one or more of phone_daytime, phone_night, phone_mobile, and phone_fax
+
+- a 'comment' (will be attached to the contact)
+
+State and country will be normalized to Freeside state/country codes if
+necessary.
+
+=cut
+
+sub new_prospect {
+
+ my $packet = shift;
+ warn "$me new_prospect called\n".Dumper($packet) if $DEBUG;
+
+ my $oldAutoCommit = $FS::UID::AutoCommit;
+ local $FS::UID::AutoCommit = 0;
+ my $dbh = dbh;
+ my $conf = FS::Conf->new;
+
+ my $error;
+
+ my $agentnum = get_agentnum($packet);
+ return $agentnum if ref $agentnum;
+ my $refnum;
+ if ( my $title = $packet->{referral_title} ) {
+ my $part_referral = qsearchs('part_referral', {
+ 'agentnum' => $agentnum,
+ 'title' => $title,
+ });
+ $part_referral ||= qsearchs('part_referral', {
+ 'agentnum' => '',
+ 'title' => $title,
+ });
+ if (!$part_referral) {
+ return { error => "Unknown referral type: '$title'" };
+ }
+ $refnum = $part_referral->refnum;
+ } elsif ( $packet->{refnum} ) {
+ $refnum = $packet->{refnum};
+ }
+ $refnum ||= $conf->config('signup_server-default_refnum');
+ return { error => "Signup referral type is not configured" } if !$refnum;
+
+ my $prospect = FS::prospect_main->new({
+ 'agentnum' => $agentnum,
+ 'refnum' => $refnum,
+ 'company' => $packet->{company},
+ });
+
+ my $location = FS::cust_location->new;
+ foreach ( qw(address1 address2 city county zip ) ) {
+ $location->set($_, $packet->{$_});
+ }
+ # normalize country and state if they're not already ISO codes
+ # easier than doing it on the client side--we already have the tables here
+ my $country = $packet->{country};
+ my $state = $packet->{state};
+ if (length($country) > 2) {
+ # it likes title case
+ $country = join(' ', map ucfirst, split(/\s+/, $country));
+ my $lsc = Locale::SubCountry->new($country);
+ if ($lsc) {
+ $country = uc($lsc->country_code);
+
+ if ($lsc->has_sub_countries) {
+ if ( $lsc->full_name($state) eq 'unknown' ) {
+ # then we were probably given a full name, so resolve it
+ $state = $lsc->code($state);
+ if ( $state eq 'unknown' ) {
+ # doesn't resolve as a full name either, return an error
+ $error = "Unknown state: ".$packet->{state};
+ } else {
+ $state = uc($state);
+ }
+ }
+ } # else state doesn't matter
+ } else {
+ # couldn't find the country in LSC
+ $error = "Unknown country: $country";
+ }
+ }
+ $location->set('country', $country);
+ $location->set('state', $state);
+ $prospect->set('cust_location', $location);
+
+ $error ||= $prospect->insert; # also does location
+ return { error => $error } if $error;
+
+ my $contact = FS::contact->new({
+ prospectnum => $prospect->prospectnum,
+ locationnum => $location->locationnum,
+ invoice_dest => 'Y',
+ });
+ # use emailaddress pseudo-field behavior here
+ foreach (qw(last first title emailaddress comment)) {
+ $contact->set($_, $packet->{$_});
+ }
+ $error = $contact->insert;
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return { error => $error };
+ }
+
+ foreach my $phone_type (qsearch('phone_type', {})) {
+ my $key = 'phone_' . lc($phone_type->typename);
+ my $phonenum = $packet->{$key};
+ if ( $phonenum ) {
+ # just to not have to supply country code from the other end
+ my $number = Number::Phone->new($location->country, $phonenum);
+ if (!$number) {
+ $error = 'invalid phone number';
+ } else {
+ my $phone = FS::contact_phone->new({
+ contactnum => $contact->contactnum,
+ phonenum => $phonenum,
+ countrycode => $number->country_code,
+ phonetypenum => $phone_type->phonetypenum,
+ });
+ $error = $phone->insert;
+ }
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return { error => $phone_type->typename . ' phone: ' . $error };
+ }
+ }
+ } # foreach $phone_type
+
+ $dbh->commit if $oldAutoCommit;
+ return { prospectnum => $prospect->prospectnum };
+}
+
1;
diff --git a/FS/FS/ClientAPI_XMLRPC.pm b/FS/FS/ClientAPI_XMLRPC.pm
index 2dea80129..622f3df05 100644
--- a/FS/FS/ClientAPI_XMLRPC.pm
+++ b/FS/FS/ClientAPI_XMLRPC.pm
@@ -192,6 +192,7 @@ sub ss2clientapi {
'new_customer_minimal' => 'Signup/new_customer_minimal',
'capture_payment' => 'Signup/capture_payment',
'clear_signup_cache' => 'Signup/clear_cache',
+ 'new_prospect' => 'Signup/new_prospect',
'new_agent' => 'Agent/new_agent',
'agent_login' => 'Agent/agent_login',
'agent_logout' => 'Agent/agent_logout',
diff --git a/FS/FS/Conf.pm b/FS/FS/Conf.pm
index d0b1180cb..745315816 100644
--- a/FS/FS/Conf.pm
+++ b/FS/FS/Conf.pm
@@ -1389,7 +1389,7 @@ and customer address. Include units.',
{
'key' => 'invoice_latexextracouponspace',
'section' => 'invoicing',
- 'description' => 'Optional LaTeX invoice textheight space to reserve for a tear off coupon. Include units. Default is 3.6cm',
+ 'description' => 'Optional LaTeX invoice textheight space to reserve for a tear off coupon. Include units. Default is 2.7 inches.',
'type' => 'text',
'per_agent' => 1,
'validate' => sub { shift =~
@@ -1401,7 +1401,7 @@ and customer address. Include units.',
{
'key' => 'invoice_latexcouponfootsep',
'section' => 'invoicing',
- 'description' => 'Optional LaTeX invoice separation between tear off coupon and footer. Include units.',
+ 'description' => 'Optional LaTeX invoice separation between bottom of coupon address and footer. Include units. Default is 0.2 inches.',
'type' => 'text',
'per_agent' => 1,
'validate' => sub { shift =~
@@ -1413,7 +1413,7 @@ and customer address. Include units.',
{
'key' => 'invoice_latexcouponamountenclosedsep',
'section' => 'invoicing',
- 'description' => 'Optional LaTeX invoice separation between total due and amount enclosed line. Include units.',
+ 'description' => 'Optional LaTeX invoice separation between total due and amount enclosed line. Include units. Default is 2.25 em.',
'type' => 'text',
'per_agent' => 1,
'validate' => sub { shift =~
@@ -1424,7 +1424,7 @@ and customer address. Include units.',
{
'key' => 'invoice_latexcoupontoaddresssep',
'section' => 'invoicing',
- 'description' => 'Optional LaTeX invoice separation between invoice data and the to address (usually invoice_latexreturnaddress). Include units.',
+ 'description' => 'Optional LaTeX invoice separation between invoice data and the address (usually invoice_latexreturnaddress). Include units. Default is 1 inch.',
'type' => 'text',
'per_agent' => 1,
'validate' => sub { shift =~
@@ -1972,7 +1972,7 @@ and customer address. Include units.',
'description' => 'Enables the automatic unsuspension of suspended packages when a customer\'s balance due is at or below the specified amount after a payment or credit',
'type' => 'select',
'select_enum' => [
- '', 'Zero', 'Latest invoice charges'
+ '', 'Zero', 'Latest invoice charges', 'Charges not past due'
],
},
@@ -5306,7 +5306,7 @@ and customer address. Include units.',
my @part_export =
map { qsearch( 'part_export', {exporttype => $_ } ) }
keys %{FS::part_export::export_info('cust_main')};
- map { $_->exportnum => $_->exporttype.' to '.$_->machine } @part_export;
+ map { $_->exportnum => $_->exportname } @part_export;
},
'option_sub' => sub {
require FS::Record;
@@ -5315,7 +5315,7 @@ and customer address. Include units.',
'part_export', { 'exportnum' => shift }
);
$part_export
- ? $part_export->exporttype.' to '.$part_export->machine
+ ? $part_export->exportname
: '';
},
},
@@ -5324,7 +5324,7 @@ and customer address. Include units.',
{
'key' => 'cust_location-exports',
'section' => '',
- 'description' => 'Export(s) to call on cust_location insert, modification and deletion.',
+ 'description' => 'Export(s) to call on cust_location insert or modification',
'type' => 'select-sub',
'multiple' => 1,
'options_sub' => sub {
@@ -5333,7 +5333,7 @@ and customer address. Include units.',
my @part_export =
map { qsearch( 'part_export', {exporttype => $_ } ) }
keys %{FS::part_export::export_info('cust_location')};
- map { $_->exportnum => $_->exporttype.' to '.$_->machine } @part_export;
+ map { $_->exportnum => $_->exportname } @part_export;
},
'option_sub' => sub {
require FS::Record;
@@ -5342,7 +5342,7 @@ and customer address. Include units.',
'part_export', { 'exportnum' => shift }
);
$part_export
- ? $part_export->exporttype.' to '.$part_export->machine
+ ? $part_export->exportname
: '';
},
},
diff --git a/FS/FS/Mason.pm b/FS/FS/Mason.pm
index aa9d3bebf..7b4db9932 100644
--- a/FS/FS/Mason.pm
+++ b/FS/FS/Mason.pm
@@ -146,7 +146,8 @@ if ( -e $addl_handler_use_file ) {
use FS::Report::Table;
use FS::Report::Table::Monthly;
use FS::Report::Table::Daily;
- use FS::Report::Tax;
+ use FS::Report::Tax::ByName;
+ use FS::Report::Tax::All;
use FS::TicketSystem;
use FS::NetworkMonitoringSystem;
use FS::Tron qw( tron_lint );
diff --git a/FS/FS/Report/Tax.pm b/FS/FS/Report/Tax.pm
deleted file mode 100644
index f1f6be38e..000000000
--- a/FS/FS/Report/Tax.pm
+++ /dev/null
@@ -1,675 +0,0 @@
-package FS::Report::Tax;
-
-use strict;
-use vars qw($DEBUG);
-use FS::Record qw(dbh qsearch qsearchs group_concat_sql);
-use Date::Format qw( time2str );
-
-use Data::Dumper;
-
-$DEBUG = 0;
-
-=item report_internal OPTIONS
-
-Constructor. Generates a tax report using the internal tax rate system
-(L).
-
-Required parameters:
-
-- beginning, ending: the date range as Unix timestamps.
-- taxname: the name of the tax (corresponds to C).
-- country: the country code.
-
-Optional parameters:
-- agentnum: limit to this agentnum.num.
-- breakdown: hashref of the fields to group by. Keys can be 'city', 'district',
- 'pkgclass', or 'taxclass'; values should be true.
-- debug: sets the debug level. 1 will warn the data collected for the report;
- 2 will also warn all of the SQL statements.
-
-=cut
-
-sub report_internal {
- my $class = shift;
- my %opt = @_;
-
- $DEBUG ||= $opt{debug};
-
- my $conf = new FS::Conf;
-
- my($beginning, $ending) = @opt{'beginning', 'ending'};
-
- my ($taxname, $country, %breakdown);
-
- # taxname can contain arbitrary punctuation; escape it properly and
- # include $taxname unquoted elsewhere
- $taxname = dbh->quote($opt{'taxname'});
-
- if ( $opt{country} =~ /^(\w\w)$/ ) {
- $country = $1;
- } else {
- die "country required";
- }
-
- # %breakdown: short name => field identifier
- # null classnum should remain null, not be converted to zero
- %breakdown = (
- 'taxclass' => 'cust_main_county.taxclass',
- 'pkgclass' => 'COALESCE(part_fee.classnum,part_pkg.classnum)',
- 'city' => 'cust_main_county.city',
- 'district' => 'cust_main_county.district',
- 'state' => 'cust_main_county.state',
- 'county' => 'cust_main_county.county',
- );
- foreach (qw(taxclass pkgclass city district)) {
- delete $breakdown{$_} unless $opt{breakdown}->{$_};
- }
-
- my $join_cust = ' JOIN cust_bill USING ( invnum )
- LEFT JOIN cust_main USING ( custnum ) ';
-
- my $join_cust_pkg = $join_cust.
- ' LEFT JOIN cust_pkg USING ( pkgnum )
- LEFT JOIN part_pkg USING ( pkgpart )
- LEFT JOIN part_fee USING ( feepart ) ';
-
- my $from_join_cust_pkg = " FROM cust_bill_pkg $join_cust_pkg ";
-
- # all queries MUST be linked to both cust_bill and cust_main_county
-
- # Either or both of these can be used to link cust_bill_pkg to
- # cust_main_county. This one links a taxed line item (billpkgnum) to a tax rate
- # (taxnum), and gives the amount of tax charged on that line item under that
- # rate (as tax_amount).
- my $pkg_tax = "SELECT SUM(amount) as tax_amount, taxnum, ".
- "taxable_billpkgnum AS billpkgnum ".
- "FROM cust_bill_pkg_tax_location JOIN cust_bill_pkg USING (billpkgnum) ".
- "GROUP BY taxable_billpkgnum, taxnum";
-
- # This one links a tax-exempted line item (billpkgnum) to a tax rate
- # (taxnum), and gives the amount of the tax exemption. EXEMPT_WHERE must
- # be replaced with an expression to further limit the tax exemptions
- # that will be included, or "TRUE" to not limit them.
- #
- # Note that tax exemptions with non-null creditbillpkgnum are always
- # excluded. Those are "negative exemptions" created by crediting a sale
- # that had received an exemption.
- my $pkg_tax_exempt = "SELECT SUM(amount) AS exempt_charged, billpkgnum, taxnum ".
- "FROM cust_tax_exempt_pkg WHERE
- ( EXEMPT_WHERE )
- AND cust_tax_exempt_pkg.creditbillpkgnum IS NULL
- GROUP BY billpkgnum, taxnum";
-
- my $where = "WHERE cust_bill._date >= $beginning AND cust_bill._date <= $ending ".
- "AND COALESCE(cust_main_county.taxname,'Tax') = $taxname ".
- "AND cust_main_county.country = '$country'";
- # SELECT/GROUP clauses for first-level queries
- my $select = "SELECT ";
- my $group = "GROUP BY ";
- foreach (qw(pkgclass taxclass state county city district)) {
- if ( $breakdown{$_} ) {
- $select .= "$breakdown{$_} AS $_, ";
- $group .= "$breakdown{$_}, ";
- } else {
- $select .= "NULL AS $_, ";
- }
- }
- $select .= group_concat_sql('DISTINCT(cust_main_county.taxnum)', ',') .
- ' AS taxnums, ';
- $group =~ s/, $//;
-
- # SELECT/GROUP clauses for second-level (totals) queries
- # breakdown by package class only, if anything
- my $select_all = "SELECT NULL AS pkgclass, ";
- my $group_all = "";
- if ( $breakdown{pkgclass} ) {
- $select_all = "SELECT $breakdown{pkgclass} AS pkgclass, ";
- $group_all = "GROUP BY $breakdown{pkgclass}";
- }
- $select_all .= group_concat_sql('DISTINCT(cust_main_county.taxnum)', ',') .
- ' AS taxnums, ';
-
- my $agentnum;
- if ( $opt{agentnum} and $opt{agentnum} =~ /^(\d+)$/ ) {
- $agentnum = $1;
- my $agent = qsearchs('agent', { 'agentnum' => $agentnum } );
- die "agent not found" unless $agent;
- $where .= " AND cust_main.agentnum = $agentnum";
- }
-
- my $nottax =
- '(cust_bill_pkg.pkgnum != 0 OR cust_bill_pkg.feepart IS NOT NULL)';
-
- # one query for each column of the report
- # plus separate queries for the totals row
- my (%sql, %all_sql);
-
- # SALES QUERIES (taxable sales, all types of exempt sales)
- # -------------
-
- # general form
- my $exempt = "$select SUM(exempt_charged)
- FROM cust_main_county
- JOIN ($pkg_tax_exempt) AS pkg_tax_exempt
- USING (taxnum)
- JOIN cust_bill_pkg USING (billpkgnum)
- $join_cust_pkg $where AND $nottax
- $group";
-
- my $all_exempt = "$select_all SUM(exempt_charged)
- FROM cust_main_county
- JOIN ($pkg_tax_exempt) AS pkg_tax_exempt
- USING (taxnum)
- JOIN cust_bill_pkg USING (billpkgnum)
- $join_cust_pkg $where AND $nottax
- $group_all";
-
- # sales to tax-exempt customers
- $sql{exempt_cust} = $exempt;
- $sql{exempt_cust} =~ s/EXEMPT_WHERE/exempt_cust = 'Y' OR exempt_cust_taxname = 'Y'/;
- $all_sql{exempt_cust} = $all_exempt;
- $all_sql{exempt_cust} =~ s/EXEMPT_WHERE/exempt_cust = 'Y' OR exempt_cust_taxname = 'Y'/;
-
- # sales of tax-exempt packages
- $sql{exempt_pkg} = $exempt;
- $sql{exempt_pkg} =~ s/EXEMPT_WHERE/exempt_setup = 'Y' OR exempt_recur = 'Y'/;
- $all_sql{exempt_pkg} = $all_exempt;
- $all_sql{exempt_pkg} =~ s/EXEMPT_WHERE/exempt_setup = 'Y' OR exempt_recur = 'Y'/;
-
- # monthly per-customer exemptions
- $sql{exempt_monthly} = $exempt;
- $sql{exempt_monthly} =~ s/EXEMPT_WHERE/exempt_monthly = 'Y'/;
- $all_sql{exempt_monthly} = $all_exempt;
- $all_sql{exempt_monthly} =~ s/EXEMPT_WHERE/exempt_monthly = 'Y'/;
-
- # credits applied to taxable sales
- # Note that negative exemptions (from exempt sales being credited) are NOT
- # counted when calculating the exempt amount. (See above.) Therefore we need
- # to NOT include any credits against exempt sales in this amount, either.
- # These two subqueries implement that. They have joins to cust_credit_bill
- # and cust_bill so that credits can be filtered by application date if
- # requested.
-
- # Each row here is the sum of credits applied to a line item.
- my $sales_credit =
- "SELECT billpkgnum, SUM(cust_credit_bill_pkg.amount) AS credited
- FROM cust_credit_bill_pkg
- JOIN cust_credit_bill USING (creditbillnum)
- JOIN cust_bill USING (invnum)
- WHERE cust_bill._date >= $beginning AND cust_bill._date <= $ending
- GROUP BY billpkgnum
- ";
-
- # Each row here is the sum of negative exemptions applied to a combination
- # of line item and tax definition.
- my $exempt_credit =
- "SELECT cust_credit_bill_pkg.billpkgnum, taxnum,
- 0 - SUM(cust_tax_exempt_pkg.amount) AS exempt_credited
- FROM cust_credit_bill_pkg
- LEFT JOIN cust_tax_exempt_pkg USING (creditbillpkgnum)
- JOIN cust_credit_bill USING (creditbillnum)
- JOIN cust_bill USING (invnum)
- WHERE cust_bill._date >= $beginning AND cust_bill._date <= $ending
- GROUP BY cust_credit_bill_pkg.billpkgnum, taxnum
- ";
-
- if ( $opt{credit_date} eq 'cust_credit_bill' ) {
- $sales_credit =~ s/cust_bill._date/cust_credit_bill._date/g;
- $exempt_credit =~ s/cust_bill._date/cust_credit_bill._date/g;
- }
-
- $sql{sales_credited} = "$select
- SUM(COALESCE(credited, 0) - COALESCE(exempt_credited, 0))
- FROM cust_main_county
- JOIN ($pkg_tax) AS pkg_tax USING (taxnum)
- JOIN cust_bill_pkg USING (billpkgnum)
- LEFT JOIN ($sales_credit) AS sales_credit USING (billpkgnum)
- LEFT JOIN ($exempt_credit) AS exempt_credit USING (billpkgnum, taxnum)
- $join_cust_pkg $where AND $nottax
- $group
- ";
-
- $all_sql{sales_credited} = "$select_all
- SUM(COALESCE(credited, 0) - COALESCE(exempt_credited, 0))
- FROM cust_main_county
- JOIN ($pkg_tax) AS pkg_tax USING (taxnum)
- JOIN cust_bill_pkg USING (billpkgnum)
- LEFT JOIN ($sales_credit) AS sales_credit USING (billpkgnum)
- LEFT JOIN ($exempt_credit) AS exempt_credit USING (billpkgnum, taxnum)
- $join_cust_pkg $where AND $nottax
- $group_all
- ";
-
- # also include the exempt-sales credit amount, for the credit report
- $sql{exempt_credited} = "$select
- SUM(COALESCE(exempt_credited, 0))
- FROM cust_main_county
- LEFT JOIN ($exempt_credit) AS exempt_credit USING (taxnum)
- JOIN cust_bill_pkg USING (billpkgnum)
- $join_cust_pkg $where AND $nottax
- $group
- ";
-
- $all_sql{exempt_credited} = "$select_all
- SUM(COALESCE(exempt_credited, 0))
- FROM cust_main_county
- LEFT JOIN ($exempt_credit) AS exempt_credit USING (taxnum)
- JOIN cust_bill_pkg USING (billpkgnum)
- $join_cust_pkg $where AND $nottax
- $group_all
- ";
-
- # taxable sales
- $sql{taxable} = "$select
- SUM(cust_bill_pkg.setup + cust_bill_pkg.recur
- - COALESCE(exempt_charged, 0)
- - COALESCE(credited, 0)
- + COALESCE(exempt_credited, 0)
- )
- FROM cust_main_county
- JOIN ($pkg_tax) AS pkg_tax USING (taxnum)
- JOIN cust_bill_pkg USING (billpkgnum)
- LEFT JOIN ($pkg_tax_exempt) AS pkg_tax_exempt USING (billpkgnum, taxnum)
- LEFT JOIN ($sales_credit) AS sales_credit USING (billpkgnum)
- LEFT JOIN ($exempt_credit) AS exempt_credit USING (billpkgnum, taxnum)
- $join_cust_pkg $where AND $nottax
- $group";
-
- $all_sql{taxable} = "$select_all
- SUM(cust_bill_pkg.setup + cust_bill_pkg.recur
- - COALESCE(exempt_charged, 0)
- - COALESCE(credited, 0)
- + COALESCE(exempt_credited, 0)
- )
- FROM cust_main_county
- JOIN ($pkg_tax) AS pkg_tax USING (taxnum)
- JOIN cust_bill_pkg USING (billpkgnum)
- LEFT JOIN ($pkg_tax_exempt) AS pkg_tax_exempt USING (billpkgnum, taxnum)
- LEFT JOIN ($sales_credit) AS sales_credit USING (billpkgnum)
- LEFT JOIN ($exempt_credit) AS exempt_credit USING (billpkgnum, taxnum)
- $join_cust_pkg $where AND $nottax
- $group_all";
-
- $sql{taxable} =~ s/EXEMPT_WHERE/TRUE/; # unrestricted
- $all_sql{taxable} =~ s/EXEMPT_WHERE/TRUE/;
-
- # estimated tax (taxable * rate)
- $sql{estimated} = "$select
- SUM(cust_main_county.tax / 100 *
- (cust_bill_pkg.setup + cust_bill_pkg.recur
- - COALESCE(exempt_charged, 0)
- - COALESCE(credited, 0)
- + COALESCE(exempt_credited, 0)
- )
- )
- FROM cust_main_county
- JOIN ($pkg_tax) AS pkg_tax USING (taxnum)
- JOIN cust_bill_pkg USING (billpkgnum)
- LEFT JOIN ($pkg_tax_exempt) AS pkg_tax_exempt USING (billpkgnum, taxnum)
- LEFT JOIN ($sales_credit) AS sales_credit USING (billpkgnum)
- LEFT JOIN ($exempt_credit) AS exempt_credit USING (billpkgnum, taxnum)
- $join_cust_pkg $where AND $nottax
- $group";
-
- $all_sql{estimated} = "$select_all
- SUM(cust_main_county.tax / 100 *
- (cust_bill_pkg.setup + cust_bill_pkg.recur
- - COALESCE(exempt_charged, 0)
- - COALESCE(credited, 0)
- + COALESCE(exempt_credited, 0)
- )
- )
- FROM cust_main_county
- JOIN ($pkg_tax) AS pkg_tax USING (taxnum)
- JOIN cust_bill_pkg USING (billpkgnum)
- LEFT JOIN ($pkg_tax_exempt) AS pkg_tax_exempt USING (billpkgnum, taxnum)
- LEFT JOIN ($sales_credit) AS sales_credit USING (billpkgnum)
- LEFT JOIN ($exempt_credit) AS exempt_credit USING (billpkgnum, taxnum)
- $join_cust_pkg $where AND $nottax
- $group_all";
-
- $sql{estimated} =~ s/EXEMPT_WHERE/TRUE/; # unrestricted
- $all_sql{estimated} =~ s/EXEMPT_WHERE/TRUE/;
-
- # there isn't one for 'sales', because we calculate sales by adding up
- # the taxable and exempt columns.
-
- # TAX QUERIES (billed tax, credited tax, collected tax)
- # -----------
-
- # sum of billed tax:
- # join cust_bill_pkg to cust_main_county via cust_bill_pkg_tax_location
- my $taxfrom = " FROM cust_bill_pkg
- $join_cust
- LEFT JOIN cust_bill_pkg_tax_location USING ( billpkgnum )
- LEFT JOIN cust_main_county USING ( taxnum )";
-
- if ( $breakdown{pkgclass} ) {
- # If we're not grouping by package class, this is unnecessary, and
- # probably really expensive.
- # Remember that fees also have package classes.
- $taxfrom .= "
- LEFT JOIN cust_bill_pkg AS taxable
- ON (cust_bill_pkg_tax_location.taxable_billpkgnum = taxable.billpkgnum)
- LEFT JOIN cust_pkg ON (taxable.pkgnum = cust_pkg.pkgnum)
- LEFT JOIN part_pkg USING (pkgpart)
- LEFT JOIN part_fee ON (taxable.feepart = part_fee.feepart) ";
- }
-
- my $istax = "cust_bill_pkg.pkgnum = 0 and cust_bill_pkg.feepart is null";
-
- $sql{tax} = "$select COALESCE(SUM(cust_bill_pkg_tax_location.amount),0)
- $taxfrom
- $where AND $istax
- $group";
-
- $all_sql{tax} = "$select_all COALESCE(SUM(cust_bill_pkg_tax_location.amount),0)
- $taxfrom
- $where AND $istax
- $group_all";
-
- # sum of credits applied against billed tax
- # ($creditfrom includes join of taxable item to part_pkg/part_fee if
- # with_pkgclass is on)
- my $creditfrom = $taxfrom .
- ' JOIN cust_credit_bill_pkg USING (billpkgtaxlocationnum)' .
- ' JOIN cust_credit_bill USING (creditbillnum)';
- my $creditwhere = $where .
- ' AND billpkgtaxratelocationnum IS NULL';
-
- # if the credit_date option is set to application date, change
- # $creditwhere accordingly
- if ( $opt{credit_date} eq 'cust_credit_bill' ) {
- $creditwhere =~ s/cust_bill._date/cust_credit_bill._date/g;
- }
-
- $sql{tax_credited} = "$select COALESCE(SUM(cust_credit_bill_pkg.amount),0)
- $creditfrom
- $creditwhere AND $istax
- $group";
-
- $all_sql{tax_credited} = "$select_all COALESCE(SUM(cust_credit_bill_pkg.amount),0)
- $creditfrom
- $creditwhere AND $istax
- $group_all";
-
- # sum of tax paid
- # this suffers from the same ambiguity as anything else that applies
- # received payments to specific packages, but in reality the discrepancy
- # should be minimal since people either pay their bill or don't.
- # the join is on billpkgtaxlocationnum to avoid cross-producting.
-
- my $paidfrom = $taxfrom .
- ' JOIN cust_bill_pay_pkg'.
- ' ON (cust_bill_pay_pkg.billpkgtaxlocationnum ='.
- ' cust_bill_pkg_tax_location.billpkgtaxlocationnum)';
-
- $sql{tax_paid} = "$select COALESCE(SUM(cust_bill_pay_pkg.amount),0)
- $paidfrom
- $where AND $istax
- $group";
-
- $all_sql{tax_paid} = "$select_all COALESCE(SUM(cust_bill_pay_pkg.amount),0)
- $paidfrom
- $where AND $istax
- $group_all";
-
- my %data;
- my %total;
- # note that we use keys(%sql) here and keys(%all_sql) later. nothing
- # obligates us to use the same set of variables for the total query
- # as for the individual category queries
- foreach my $k (keys(%sql)) {
- my $stmt = $sql{$k};
- warn "\n".uc($k).":\n".$stmt."\n" if $DEBUG > 1;
- my $sth = dbh->prepare($stmt);
- # eight columns: pkgclass, taxclass, state, county, city, district
- # taxnums (comma separated), value
- $sth->execute
- or die "failed to execute $k query: ".$sth->errstr;
- while ( my $row = $sth->fetchrow_arrayref ) {
- my $bin = $data
- {$row->[0]} # pkgclass
- {$row->[1] # taxclass
- || ($breakdown{taxclass} ? 'Unclassified' : '')}
- {$row->[2]} # state
- {$row->[3] ? $row->[3] . ' County' : ''} # county
- {$row->[4]} # city
- {$row->[5]} # district
- ||= [];
- push @$bin, [ $k, $row->[6], $row->[7] ];
- }
- }
- warn "DATA:\n".Dumper(\%data) if $DEBUG;
-
- foreach my $k (keys %all_sql) {
- warn "\nTOTAL ".uc($k).":\n".$all_sql{$k}."\n" if $DEBUG;
- my $sth = dbh->prepare($all_sql{$k});
- # three columns: pkgclass, taxnums (comma separated), value
- $sth->execute
- or die "failed to execute $k totals query: ".$sth->errstr;
- while ( my $row = $sth->fetchrow_arrayref ) {
- my $bin = $total{$row->[0]} ||= [];
- push @$bin, [ $k, $row->[1], $row->[2] ];
- }
- }
- warn "TOTALS:\n".Dumper(\%total) if $DEBUG > 1;
-
- # $data{$pkgclass}{$taxclass}{$state}{$county}{$city}{$district} = [
- # [ 'taxable', taxnums, amount ],
- # [ 'exempt_cust', taxnums, amount ],
- # ...
- # ]
- # non-requested grouping levels simply collapse into key = ''
-
- # the much-maligned "out of taxable region"...
- # find sales that are not linked to any tax with this name
- # but are still inside the date range/agent criteria.
- #
- # This doesn't use $select_all/$group_all because we want a single number,
- # not a breakdown by pkgclass. Unless someone needs that eventually,
- # in which case we'll turn it into an %all_sql query.
-
- my $outside_where =
- "WHERE cust_bill._date >= $beginning AND cust_bill._date <= $ending";
- if ( $agentnum ) {
- $outside_where .= " AND cust_main.agentnum = $agentnum";
- }
- $outside_where .= "
- AND NOT EXISTS(
- SELECT 1 FROM cust_tax_exempt_pkg
- JOIN cust_main_county USING (taxnum)
- WHERE cust_tax_exempt_pkg.billpkgnum = cust_bill_pkg.billpkgnum
- AND COALESCE(cust_main_county.taxname,'Tax') = $taxname
- AND cust_tax_exempt_pkg.creditbillpkgnum IS NULL
- )
- AND NOT EXISTS(
- SELECT 1 FROM cust_bill_pkg_tax_location
- JOIN cust_main_county USING (taxnum)
- WHERE cust_bill_pkg_tax_location.taxable_billpkgnum = cust_bill_pkg.billpkgnum
- AND COALESCE(cust_main_county.taxname,'Tax') = $taxname
- )";
- my $sql_outside = "SELECT SUM(cust_bill_pkg.setup + cust_bill_pkg.recur)
- FROM cust_bill_pkg
- $join_cust_pkg
- $outside_where
- AND $nottax
- ";
- warn "\nOUT_SALES:\n$sql_outside\n" if $DEBUG;
- my $out_sales = FS::Record->scalar_sql($sql_outside);
-
- # and out-of-region credit applications, also (excluding those applied
- # to out-of-region sales _or taxes_)
- if ( $opt{credit_date} eq 'cust_credit_bill' ) {
- $outside_where =~ s/cust_bill._date/cust_credit_bill._date/g;
- }
-
- $sql_outside = "SELECT SUM(cust_credit_bill_pkg.amount)
- FROM cust_credit_bill_pkg
- JOIN cust_bill_pkg USING (billpkgnum)
- $join_cust_pkg
- JOIN cust_credit_bill USING (creditbillnum)
- $outside_where
- AND NOT EXISTS(
- SELECT 1 FROM cust_bill_pkg_tax_location
- JOIN cust_main_county USING (taxnum)
- WHERE cust_bill_pkg_tax_location.billpkgnum = cust_bill_pkg.billpkgnum
- AND COALESCE(cust_main_county.taxname,'Tax') = $taxname
- )
- ";
- warn "\nOUT_CREDIT:\n$sql_outside\n" if $DEBUG;
- my $out_credit = FS::Record->scalar_sql($sql_outside);
-
- my %taxrates;
- foreach my $tax (
- qsearch('cust_main_county', {
- country => $country,
- tax => { op => '>', value => 0 }
- }) )
- {
- $taxrates{$tax->taxnum} = $tax->tax;
- }
-
- # return the data
- bless {
- 'opt' => \%opt,
- 'data' => \%data,
- 'total' => \%total,
- 'taxrates' => \%taxrates,
- 'out_sales' => $out_sales,
- 'out_credit' => $out_credit,
- }, $class;
-}
-
-sub opt {
- my $self = shift;
- $self->{opt};
-}
-
-sub data {
- my $self = shift;
- $self->{data};
-}
-
-# sub fetchall_array...
-
-sub table {
- my $self = shift;
- my @columns = (qw(pkgclass taxclass state county city district));
- # taxnums, field headings, and amounts
- my @rows;
- my %row_template;
-
- # de-treeify this thing
- my $descend;
- $descend = sub {
- my ($tree, $level) = @_;
- if ( ref($tree) eq 'HASH' ) {
- foreach my $k ( sort {
- -1*($b eq '') # sort '' to the end
- or ($a eq '') # sort '' to the end
- or ($a <=> $b) # sort numbers as numbers
- or ($a cmp $b) # sort alphabetics as alphabetics
- } keys %$tree )
- {
- $row_template{ $columns[$level] } = $k;
- &{ $descend }($tree->{$k}, $level + 1);
- if ( $level == 0 ) {
- # then insert the total row for the pkgclass
- $row_template{'total'} = 1; # flag it as a total
- &{ $descend }($self->{total}->{$k}, 1);
- $row_template{'total'} = 0;
- }
- }
- } elsif ( ref($tree) eq 'ARRAY' ) {
- # then we've reached the bottom; elements of this array are arrayrefs
- # of [ field, taxnums, amount ].
- # start with the inherited location-element fields
- my %this_row = %row_template;
- my %taxnums;
- foreach my $x (@$tree) {
- # accumulate taxnums
- foreach (split(',', $x->[1])) {
- $taxnums{$_} = 1;
- }
- # and money values
- $this_row{ $x->[0] } = $x->[2];
- }
- # store combined taxnums
- $this_row{taxnums} = join(',', sort { $a cmp $b } keys %taxnums);
- # and calculate row totals
- $this_row{sales} = sprintf('%.2f',
- $this_row{taxable} +
- $this_row{sales_credited} +
- $this_row{exempt_cust} +
- $this_row{exempt_pkg} +
- $this_row{exempt_monthly}
- );
- $this_row{credits} = sprintf('%.2f',
- $this_row{sales_credited} +
- $this_row{exempt_credited} +
- $this_row{tax_credited}
- );
- # and give it a label
- if ( $this_row{total} ) {
- $this_row{label} = 'Total';
- } else {
- $this_row{label} = join(', ', grep $_,
- $this_row{taxclass},
- $this_row{state},
- $this_row{county}, # already has ' County' suffix
- $this_row{city},
- $this_row{district}
- );
- }
- # and indicate the tax rate, if any
- my $rate;
- foreach (keys %taxnums) {
- $rate ||= $self->{taxrates}->{$_};
- if ( $rate != $self->{taxrates}->{$_} ) {
- $rate = 'variable';
- last;
- }
- }
- if ( $rate eq 'variable' ) {
- $this_row{rate} = 'variable';
- } elsif ( $rate > 0 ) {
- $this_row{rate} = sprintf('%.2f', $rate);
- }
- push @rows, \%this_row;
- }
- };
-
- &{ $descend }($self->{data}, 0);
-
- warn "TABLE:\n".Dumper(\@rows) if $self->{opt}->{debug};
- return @rows;
-}
-
-sub taxrates {
- my $self = shift;
- $self->{taxrates}
-}
-
-sub title {
- my $self = shift;
- my $string = '';
- if ( $self->{opt}->{agentnum} ) {
- my $agent = qsearchs('agent', { agentnum => $self->{opt}->{agentnum} });
- $string .= $agent->agent . ' ';
- }
- $string .= 'Tax Report: '; # XXX localization
- if ( $self->{opt}->{beginning} ) {
- $string .= time2str('%h %o %Y ', $self->{opt}->{beginning});
- }
- $string .= 'through ';
- if ( $self->{opt}->{ending} and $self->{opt}->{ending} < 4294967295 ) {
- $string .= time2str('%h %o %Y', $self->{opt}->{ending});
- } else {
- $string .= 'now';
- }
- $string .= ' - ' . $self->{opt}->{taxname};
- return $string;
-}
-
-1;
diff --git a/FS/FS/Report/Tax/All.pm b/FS/FS/Report/Tax/All.pm
new file mode 100644
index 000000000..26dbf5f0f
--- /dev/null
+++ b/FS/FS/Report/Tax/All.pm
@@ -0,0 +1,110 @@
+package FS::Report::Tax::All;
+
+use strict;
+use vars qw($DEBUG);
+use FS::Record qw(dbh qsearch qsearchs group_concat_sql);
+use FS::Report::Tax::ByName;
+use Date::Format qw( time2str );
+
+use Data::Dumper;
+
+$DEBUG = 0;
+
+=item report OPTIONS
+
+Constructor. Generates a tax report using the internal tax rate system,
+showing all taxes, broken down by tax name and country.
+
+Required parameters:
+- beginning, ending: the date range as Unix timestamps.
+
+Optional parameters:
+- debug: sets the debug level. 1 will warn the data collected for the report;
+2 will also warn all of the SQL statements.
+
+=cut
+
+# because there's not yet a "DBIx::DBSchema::View"...
+
+sub report {
+ my $class = shift;
+ my %opt = @_;
+
+ $DEBUG ||= $opt{debug};
+
+ my($beginning, $ending) = @opt{'beginning', 'ending'};
+
+ # figure out which reports we need to run
+ my @taxname_and_country = qsearch({
+ table => 'cust_main_county',
+ select => 'country, taxname',
+ hashref => {
+ tax => { op => '>', value => '0' }
+ },
+ order_by => 'GROUP BY country, taxname ORDER BY country, taxname',
+ });
+ my @table;
+ foreach (@taxname_and_country) {
+ my $taxname = $_->taxname || 'Tax';
+ my $country = $_->country;
+ my $report = FS::Report::Tax::ByName->report(
+ %opt,
+ taxname => $taxname,
+ country => $country,
+ total_only => 1,
+ );
+ # will have only one total row (should be only one row at all)
+ my ($total_row) = grep { $_->{total} } $report->table;
+ $total_row->{total} = 0; # but in this context it's a detail row
+ $total_row->{taxname} = $taxname;
+ $total_row->{country} = $country;
+ $total_row->{label} = "$country - $taxname";
+ push @table, $total_row;
+ }
+ my $self = bless {
+ 'opt' => \%opt,
+ 'table' => \@table,
+ }, $class;
+
+ $self;
+}
+
+sub opt {
+ my $self = shift;
+ $self->{opt};
+}
+
+sub data {
+ my $self = shift;
+ $self->{data};
+}
+
+# sub fetchall_array...
+
+sub table {
+ my $self = shift;
+ @{ $self->{table} };
+}
+
+sub title {
+ my $self = shift;
+ my $string = '';
+ if ( $self->{opt}->{agentnum} ) {
+ my $agent = qsearchs('agent', { agentnum => $self->{opt}->{agentnum} });
+ $string .= $agent->agent . ' ';
+ }
+ $string .= 'Tax Report: '; # XXX localization
+ if ( $self->{opt}->{beginning} ) {
+ $string .= time2str('%h %o %Y ', $self->{opt}->{beginning});
+ }
+ $string .= 'through ';
+ if ( $self->{opt}->{ending} and $self->{opt}->{ending} < 4294967295 ) {
+ $string .= time2str('%h %o %Y', $self->{opt}->{ending});
+ } else {
+ $string .= 'now';
+ }
+ $string .= ' - all taxes';
+ return $string;
+}
+
+1;
diff --git a/FS/FS/Report/Tax/ByName.pm b/FS/FS/Report/Tax/ByName.pm
new file mode 100644
index 000000000..88695b909
--- /dev/null
+++ b/FS/FS/Report/Tax/ByName.pm
@@ -0,0 +1,678 @@
+package FS::Report::Tax::ByName;
+
+use strict;
+use vars qw($DEBUG);
+use FS::Record qw(dbh qsearch qsearchs group_concat_sql);
+use Date::Format qw( time2str );
+
+use Data::Dumper;
+
+$DEBUG = 0;
+
+=item report OPTIONS
+
+Constructor. Generates a tax report using the internal tax rate system
+(L), showing all taxes with a specified tax name,
+broken down by state/county. Optionally, the taxes can be broken down further
+by city/district, tax class, or package class.
+
+Required parameters:
+
+- beginning, ending: the date range as Unix timestamps.
+- taxname: the name of the tax (corresponds to C).
+- country: the country code.
+
+Optional parameters:
+- agentnum: limit to this agentnum.num.
+- breakdown: hashref of the fields to group by. Keys can be 'city',
+'district', 'pkgclass', or 'taxclass'; values should be true.
+- total_only: don't run the tax group queries, only the totals queries.
+Returns one row, except in the unlikely event you're using breakdown by
+package class.
+- debug: sets the debug level. 1 will warn the data collected for the report;
+2 will also warn all of the SQL statements.
+
+=cut
+
+sub report {
+ my $class = shift;
+ my %opt = @_;
+
+ $DEBUG ||= $opt{debug};
+
+ my($beginning, $ending) = @opt{'beginning', 'ending'};
+
+ my ($taxname, $country, %breakdown);
+
+ # taxname can contain arbitrary punctuation; escape it properly and
+ # include $taxname unquoted elsewhere
+ $taxname = dbh->quote($opt{'taxname'});
+
+ if ( $opt{country} =~ /^(\w\w)$/ ) {
+ $country = $1;
+ } else {
+ die "country required";
+ }
+
+ # %breakdown: short name => field identifier
+ # null classnum should remain null, not be converted to zero
+ %breakdown = (
+ 'taxclass' => 'cust_main_county.taxclass',
+ 'pkgclass' => 'COALESCE(part_fee.classnum,part_pkg.classnum)',
+ 'city' => 'cust_main_county.city',
+ 'district' => 'cust_main_county.district',
+ 'state' => 'cust_main_county.state',
+ 'county' => 'cust_main_county.county',
+ );
+ foreach (qw(taxclass pkgclass city district)) {
+ delete $breakdown{$_} unless $opt{breakdown}->{$_};
+ }
+
+ my $join_cust = ' JOIN cust_bill USING ( invnum )
+ LEFT JOIN cust_main USING ( custnum ) ';
+
+ my $join_cust_pkg = $join_cust.
+ ' LEFT JOIN cust_pkg USING ( pkgnum )
+ LEFT JOIN part_pkg USING ( pkgpart )
+ LEFT JOIN part_fee USING ( feepart ) ';
+
+ my $from_join_cust_pkg = " FROM cust_bill_pkg $join_cust_pkg ";
+
+ # all queries MUST be linked to both cust_bill and cust_main_county
+
+ # Either or both of these can be used to link cust_bill_pkg to
+ # cust_main_county. This one links a taxed line item (billpkgnum) to a tax rate
+ # (taxnum), and gives the amount of tax charged on that line item under that
+ # rate (as tax_amount).
+ my $pkg_tax = "SELECT SUM(amount) as tax_amount, taxnum, ".
+ "taxable_billpkgnum AS billpkgnum ".
+ "FROM cust_bill_pkg_tax_location JOIN cust_bill_pkg USING (billpkgnum) ".
+ "GROUP BY taxable_billpkgnum, taxnum";
+
+ # This one links a tax-exempted line item (billpkgnum) to a tax rate
+ # (taxnum), and gives the amount of the tax exemption. EXEMPT_WHERE must
+ # be replaced with an expression to further limit the tax exemptions
+ # that will be included, or "TRUE" to not limit them.
+ #
+ # Note that tax exemptions with non-null creditbillpkgnum are always
+ # excluded. Those are "negative exemptions" created by crediting a sale
+ # that had received an exemption.
+ my $pkg_tax_exempt = "SELECT SUM(amount) AS exempt_charged, billpkgnum, taxnum ".
+ "FROM cust_tax_exempt_pkg WHERE
+ ( EXEMPT_WHERE )
+ AND cust_tax_exempt_pkg.creditbillpkgnum IS NULL
+ GROUP BY billpkgnum, taxnum";
+
+ my $where = "WHERE cust_bill._date >= $beginning AND cust_bill._date <= $ending ".
+ "AND COALESCE(cust_main_county.taxname,'Tax') = $taxname ".
+ "AND cust_main_county.country = '$country'";
+ # SELECT/GROUP clauses for first-level queries
+ my $select = "SELECT ";
+ my $group = "GROUP BY ";
+ foreach (qw(pkgclass taxclass state county city district)) {
+ if ( $breakdown{$_} ) {
+ $select .= "$breakdown{$_} AS $_, ";
+ $group .= "$breakdown{$_}, ";
+ } else {
+ $select .= "NULL AS $_, ";
+ }
+ }
+ $select .= group_concat_sql('DISTINCT(cust_main_county.taxnum)', ',') .
+ ' AS taxnums, ';
+ $group =~ s/, $//;
+
+ # SELECT/GROUP clauses for second-level (totals) queries
+ # breakdown by package class only, if anything
+ my $select_all = "SELECT NULL AS pkgclass, ";
+ my $group_all = "";
+ if ( $breakdown{pkgclass} ) {
+ $select_all = "SELECT $breakdown{pkgclass} AS pkgclass, ";
+ $group_all = "GROUP BY $breakdown{pkgclass}";
+ }
+ $select_all .= group_concat_sql('DISTINCT(cust_main_county.taxnum)', ',') .
+ ' AS taxnums, ';
+
+ my $agentnum;
+ if ( $opt{agentnum} and $opt{agentnum} =~ /^(\d+)$/ ) {
+ $agentnum = $1;
+ my $agent = qsearchs('agent', { 'agentnum' => $agentnum } );
+ die "agent not found" unless $agent;
+ $where .= " AND cust_main.agentnum = $agentnum";
+ }
+
+ my $nottax =
+ '(cust_bill_pkg.pkgnum != 0 OR cust_bill_pkg.feepart IS NOT NULL)';
+
+ # one query for each column of the report
+ # plus separate queries for the totals row
+ my (%sql, %all_sql);
+
+ # SALES QUERIES (taxable sales, all types of exempt sales)
+ # -------------
+
+ # general form
+ my $exempt = "$select SUM(exempt_charged)
+ FROM cust_main_county
+ JOIN ($pkg_tax_exempt) AS pkg_tax_exempt
+ USING (taxnum)
+ JOIN cust_bill_pkg USING (billpkgnum)
+ $join_cust_pkg $where AND $nottax
+ $group";
+
+ my $all_exempt = "$select_all SUM(exempt_charged)
+ FROM cust_main_county
+ JOIN ($pkg_tax_exempt) AS pkg_tax_exempt
+ USING (taxnum)
+ JOIN cust_bill_pkg USING (billpkgnum)
+ $join_cust_pkg $where AND $nottax
+ $group_all";
+
+ # sales to tax-exempt customers
+ $sql{exempt_cust} = $exempt;
+ $sql{exempt_cust} =~ s/EXEMPT_WHERE/exempt_cust = 'Y' OR exempt_cust_taxname = 'Y'/;
+ $all_sql{exempt_cust} = $all_exempt;
+ $all_sql{exempt_cust} =~ s/EXEMPT_WHERE/exempt_cust = 'Y' OR exempt_cust_taxname = 'Y'/;
+
+ # sales of tax-exempt packages
+ $sql{exempt_pkg} = $exempt;
+ $sql{exempt_pkg} =~ s/EXEMPT_WHERE/exempt_setup = 'Y' OR exempt_recur = 'Y'/;
+ $all_sql{exempt_pkg} = $all_exempt;
+ $all_sql{exempt_pkg} =~ s/EXEMPT_WHERE/exempt_setup = 'Y' OR exempt_recur = 'Y'/;
+
+ # monthly per-customer exemptions
+ $sql{exempt_monthly} = $exempt;
+ $sql{exempt_monthly} =~ s/EXEMPT_WHERE/exempt_monthly = 'Y'/;
+ $all_sql{exempt_monthly} = $all_exempt;
+ $all_sql{exempt_monthly} =~ s/EXEMPT_WHERE/exempt_monthly = 'Y'/;
+
+ # credits applied to taxable sales
+ # Note that negative exemptions (from exempt sales being credited) are NOT
+ # counted when calculating the exempt amount. (See above.) Therefore we need
+ # to NOT include any credits against exempt sales in this amount, either.
+ # These two subqueries implement that. They have joins to cust_credit_bill
+ # and cust_bill so that credits can be filtered by application date if
+ # requested.
+
+ # Each row here is the sum of credits applied to a line item.
+ my $sales_credit =
+ "SELECT billpkgnum, SUM(cust_credit_bill_pkg.amount) AS credited
+ FROM cust_credit_bill_pkg
+ JOIN cust_credit_bill USING (creditbillnum)
+ JOIN cust_bill USING (invnum)
+ WHERE cust_bill._date >= $beginning AND cust_bill._date <= $ending
+ GROUP BY billpkgnum
+ ";
+
+ # Each row here is the sum of negative exemptions applied to a combination
+ # of line item and tax definition.
+ my $exempt_credit =
+ "SELECT cust_credit_bill_pkg.billpkgnum, taxnum,
+ 0 - SUM(cust_tax_exempt_pkg.amount) AS exempt_credited
+ FROM cust_credit_bill_pkg
+ LEFT JOIN cust_tax_exempt_pkg USING (creditbillpkgnum)
+ JOIN cust_credit_bill USING (creditbillnum)
+ JOIN cust_bill USING (invnum)
+ WHERE cust_bill._date >= $beginning AND cust_bill._date <= $ending
+ GROUP BY cust_credit_bill_pkg.billpkgnum, taxnum
+ ";
+
+ if ( $opt{credit_date} eq 'cust_credit_bill' ) {
+ $sales_credit =~ s/cust_bill._date/cust_credit_bill._date/g;
+ $exempt_credit =~ s/cust_bill._date/cust_credit_bill._date/g;
+ }
+
+ $sql{sales_credited} = "$select
+ SUM(COALESCE(credited, 0) - COALESCE(exempt_credited, 0))
+ FROM cust_main_county
+ JOIN ($pkg_tax) AS pkg_tax USING (taxnum)
+ JOIN cust_bill_pkg USING (billpkgnum)
+ LEFT JOIN ($sales_credit) AS sales_credit USING (billpkgnum)
+ LEFT JOIN ($exempt_credit) AS exempt_credit USING (billpkgnum, taxnum)
+ $join_cust_pkg $where AND $nottax
+ $group
+ ";
+
+ $all_sql{sales_credited} = "$select_all
+ SUM(COALESCE(credited, 0) - COALESCE(exempt_credited, 0))
+ FROM cust_main_county
+ JOIN ($pkg_tax) AS pkg_tax USING (taxnum)
+ JOIN cust_bill_pkg USING (billpkgnum)
+ LEFT JOIN ($sales_credit) AS sales_credit USING (billpkgnum)
+ LEFT JOIN ($exempt_credit) AS exempt_credit USING (billpkgnum, taxnum)
+ $join_cust_pkg $where AND $nottax
+ $group_all
+ ";
+
+ # also include the exempt-sales credit amount, for the credit report
+ $sql{exempt_credited} = "$select
+ SUM(COALESCE(exempt_credited, 0))
+ FROM cust_main_county
+ LEFT JOIN ($exempt_credit) AS exempt_credit USING (taxnum)
+ JOIN cust_bill_pkg USING (billpkgnum)
+ $join_cust_pkg $where AND $nottax
+ $group
+ ";
+
+ $all_sql{exempt_credited} = "$select_all
+ SUM(COALESCE(exempt_credited, 0))
+ FROM cust_main_county
+ LEFT JOIN ($exempt_credit) AS exempt_credit USING (taxnum)
+ JOIN cust_bill_pkg USING (billpkgnum)
+ $join_cust_pkg $where AND $nottax
+ $group_all
+ ";
+
+ # taxable sales
+ $sql{taxable} = "$select
+ SUM(cust_bill_pkg.setup + cust_bill_pkg.recur
+ - COALESCE(exempt_charged, 0)
+ - COALESCE(credited, 0)
+ + COALESCE(exempt_credited, 0)
+ )
+ FROM cust_main_county
+ JOIN ($pkg_tax) AS pkg_tax USING (taxnum)
+ JOIN cust_bill_pkg USING (billpkgnum)
+ LEFT JOIN ($pkg_tax_exempt) AS pkg_tax_exempt USING (billpkgnum, taxnum)
+ LEFT JOIN ($sales_credit) AS sales_credit USING (billpkgnum)
+ LEFT JOIN ($exempt_credit) AS exempt_credit USING (billpkgnum, taxnum)
+ $join_cust_pkg $where AND $nottax
+ $group";
+
+ $all_sql{taxable} = "$select_all
+ SUM(cust_bill_pkg.setup + cust_bill_pkg.recur
+ - COALESCE(exempt_charged, 0)
+ - COALESCE(credited, 0)
+ + COALESCE(exempt_credited, 0)
+ )
+ FROM cust_main_county
+ JOIN ($pkg_tax) AS pkg_tax USING (taxnum)
+ JOIN cust_bill_pkg USING (billpkgnum)
+ LEFT JOIN ($pkg_tax_exempt) AS pkg_tax_exempt USING (billpkgnum, taxnum)
+ LEFT JOIN ($sales_credit) AS sales_credit USING (billpkgnum)
+ LEFT JOIN ($exempt_credit) AS exempt_credit USING (billpkgnum, taxnum)
+ $join_cust_pkg $where AND $nottax
+ $group_all";
+
+ $sql{taxable} =~ s/EXEMPT_WHERE/TRUE/; # unrestricted
+ $all_sql{taxable} =~ s/EXEMPT_WHERE/TRUE/;
+
+ # estimated tax (taxable * rate)
+ $sql{estimated} = "$select
+ SUM(cust_main_county.tax / 100 *
+ (cust_bill_pkg.setup + cust_bill_pkg.recur
+ - COALESCE(exempt_charged, 0)
+ - COALESCE(credited, 0)
+ + COALESCE(exempt_credited, 0)
+ )
+ )
+ FROM cust_main_county
+ JOIN ($pkg_tax) AS pkg_tax USING (taxnum)
+ JOIN cust_bill_pkg USING (billpkgnum)
+ LEFT JOIN ($pkg_tax_exempt) AS pkg_tax_exempt USING (billpkgnum, taxnum)
+ LEFT JOIN ($sales_credit) AS sales_credit USING (billpkgnum)
+ LEFT JOIN ($exempt_credit) AS exempt_credit USING (billpkgnum, taxnum)
+ $join_cust_pkg $where AND $nottax
+ $group";
+
+ $all_sql{estimated} = "$select_all
+ SUM(cust_main_county.tax / 100 *
+ (cust_bill_pkg.setup + cust_bill_pkg.recur
+ - COALESCE(exempt_charged, 0)
+ - COALESCE(credited, 0)
+ + COALESCE(exempt_credited, 0)
+ )
+ )
+ FROM cust_main_county
+ JOIN ($pkg_tax) AS pkg_tax USING (taxnum)
+ JOIN cust_bill_pkg USING (billpkgnum)
+ LEFT JOIN ($pkg_tax_exempt) AS pkg_tax_exempt USING (billpkgnum, taxnum)
+ LEFT JOIN ($sales_credit) AS sales_credit USING (billpkgnum)
+ LEFT JOIN ($exempt_credit) AS exempt_credit USING (billpkgnum, taxnum)
+ $join_cust_pkg $where AND $nottax
+ $group_all";
+
+ $sql{estimated} =~ s/EXEMPT_WHERE/TRUE/; # unrestricted
+ $all_sql{estimated} =~ s/EXEMPT_WHERE/TRUE/;
+
+ # there isn't one for 'sales', because we calculate sales by adding up
+ # the taxable and exempt columns.
+
+ # TAX QUERIES (billed tax, credited tax, collected tax)
+ # -----------
+
+ # sum of billed tax:
+ # join cust_bill_pkg to cust_main_county via cust_bill_pkg_tax_location
+ my $taxfrom = " FROM cust_bill_pkg
+ $join_cust
+ LEFT JOIN cust_bill_pkg_tax_location USING ( billpkgnum )
+ LEFT JOIN cust_main_county USING ( taxnum )";
+
+ if ( $breakdown{pkgclass} ) {
+ # If we're not grouping by package class, this is unnecessary, and
+ # probably really expensive.
+ # Remember that fees also have package classes.
+ $taxfrom .= "
+ LEFT JOIN cust_bill_pkg AS taxable
+ ON (cust_bill_pkg_tax_location.taxable_billpkgnum = taxable.billpkgnum)
+ LEFT JOIN cust_pkg ON (taxable.pkgnum = cust_pkg.pkgnum)
+ LEFT JOIN part_pkg USING (pkgpart)
+ LEFT JOIN part_fee ON (taxable.feepart = part_fee.feepart) ";
+ }
+
+ my $istax = "cust_bill_pkg.pkgnum = 0 and cust_bill_pkg.feepart is null";
+
+ $sql{tax} = "$select COALESCE(SUM(cust_bill_pkg_tax_location.amount),0)
+ $taxfrom
+ $where AND $istax
+ $group";
+
+ $all_sql{tax} = "$select_all COALESCE(SUM(cust_bill_pkg_tax_location.amount),0)
+ $taxfrom
+ $where AND $istax
+ $group_all";
+
+ # sum of credits applied against billed tax
+ # ($creditfrom includes join of taxable item to part_pkg/part_fee if
+ # with_pkgclass is on)
+ my $creditfrom = $taxfrom .
+ ' JOIN cust_credit_bill_pkg USING (billpkgtaxlocationnum)' .
+ ' JOIN cust_credit_bill USING (creditbillnum)';
+ my $creditwhere = $where .
+ ' AND billpkgtaxratelocationnum IS NULL';
+
+ # if the credit_date option is set to application date, change
+ # $creditwhere accordingly
+ if ( $opt{credit_date} eq 'cust_credit_bill' ) {
+ $creditwhere =~ s/cust_bill._date/cust_credit_bill._date/g;
+ }
+
+ $sql{tax_credited} = "$select COALESCE(SUM(cust_credit_bill_pkg.amount),0)
+ $creditfrom
+ $creditwhere AND $istax
+ $group";
+
+ $all_sql{tax_credited} = "$select_all COALESCE(SUM(cust_credit_bill_pkg.amount),0)
+ $creditfrom
+ $creditwhere AND $istax
+ $group_all";
+
+ # sum of tax paid
+ # this suffers from the same ambiguity as anything else that applies
+ # received payments to specific packages, but in reality the discrepancy
+ # should be minimal since people either pay their bill or don't.
+ # the join is on billpkgtaxlocationnum to avoid cross-producting.
+
+ my $paidfrom = $taxfrom .
+ ' JOIN cust_bill_pay_pkg'.
+ ' ON (cust_bill_pay_pkg.billpkgtaxlocationnum ='.
+ ' cust_bill_pkg_tax_location.billpkgtaxlocationnum)';
+
+ $sql{tax_paid} = "$select COALESCE(SUM(cust_bill_pay_pkg.amount),0)
+ $paidfrom
+ $where AND $istax
+ $group";
+
+ $all_sql{tax_paid} = "$select_all COALESCE(SUM(cust_bill_pay_pkg.amount),0)
+ $paidfrom
+ $where AND $istax
+ $group_all";
+
+ my %data;
+ my %total;
+ # note that we use keys(%sql) here and keys(%all_sql) later. nothing
+ # obligates us to use the same set of variables for the total query
+ # as for the individual category queries
+ foreach my $k (keys(%sql)) {
+ my $stmt = $sql{$k};
+ warn "\n".uc($k).":\n".$stmt."\n" if $DEBUG > 1;
+ my $sth = dbh->prepare($stmt);
+ # eight columns: pkgclass, taxclass, state, county, city, district
+ # taxnums (comma separated), value
+ $sth->execute
+ or die "failed to execute $k query: ".$sth->errstr;
+ while ( my $row = $sth->fetchrow_arrayref ) {
+ my $bin = $data
+ {$row->[0]} # pkgclass
+ {$row->[1] # taxclass
+ || ($breakdown{taxclass} ? 'Unclassified' : '')}
+ {$row->[2]} # state
+ {$row->[3] ? $row->[3] . ' County' : ''} # county
+ {$row->[4]} # city
+ {$row->[5]} # district
+ ||= [];
+ push @$bin, [ $k, $row->[6], $row->[7] ];
+ }
+ }
+ warn "DATA:\n".Dumper(\%data) if $DEBUG;
+
+ foreach my $k (keys %all_sql) {
+ warn "\nTOTAL ".uc($k).":\n".$all_sql{$k}."\n" if $DEBUG;
+ my $sth = dbh->prepare($all_sql{$k});
+ # three columns: pkgclass, taxnums (comma separated), value
+ $sth->execute
+ or die "failed to execute $k totals query: ".$sth->errstr;
+ while ( my $row = $sth->fetchrow_arrayref ) {
+ my $bin = $total{$row->[0]} ||= [];
+ push @$bin, [ $k, $row->[1], $row->[2] ];
+ }
+ }
+ warn "TOTALS:\n".Dumper(\%total) if $DEBUG > 1;
+
+ # $data{$pkgclass}{$taxclass}{$state}{$county}{$city}{$district} = [
+ # [ 'taxable', taxnums, amount ],
+ # [ 'exempt_cust', taxnums, amount ],
+ # ...
+ # ]
+ # non-requested grouping levels simply collapse into key = ''
+
+ # the much-maligned "out of taxable region"...
+ # find sales that are not linked to any tax with this name
+ # but are still inside the date range/agent criteria.
+ #
+ # This doesn't use $select_all/$group_all because we want a single number,
+ # not a breakdown by pkgclass. Unless someone needs that eventually,
+ # in which case we'll turn it into an %all_sql query.
+
+ my $outside_where =
+ "WHERE cust_bill._date >= $beginning AND cust_bill._date <= $ending";
+ if ( $agentnum ) {
+ $outside_where .= " AND cust_main.agentnum = $agentnum";
+ }
+ $outside_where .= "
+ AND NOT EXISTS(
+ SELECT 1 FROM cust_tax_exempt_pkg
+ JOIN cust_main_county USING (taxnum)
+ WHERE cust_tax_exempt_pkg.billpkgnum = cust_bill_pkg.billpkgnum
+ AND COALESCE(cust_main_county.taxname,'Tax') = $taxname
+ AND cust_tax_exempt_pkg.creditbillpkgnum IS NULL
+ )
+ AND NOT EXISTS(
+ SELECT 1 FROM cust_bill_pkg_tax_location
+ JOIN cust_main_county USING (taxnum)
+ WHERE cust_bill_pkg_tax_location.taxable_billpkgnum = cust_bill_pkg.billpkgnum
+ AND COALESCE(cust_main_county.taxname,'Tax') = $taxname
+ )";
+ my $sql_outside = "SELECT SUM(cust_bill_pkg.setup + cust_bill_pkg.recur)
+ FROM cust_bill_pkg
+ $join_cust_pkg
+ $outside_where
+ AND $nottax
+ ";
+ warn "\nOUT_SALES:\n$sql_outside\n" if $DEBUG;
+ my $out_sales = FS::Record->scalar_sql($sql_outside);
+
+ # and out-of-region credit applications, also (excluding those applied
+ # to out-of-region sales _or taxes_)
+ if ( $opt{credit_date} eq 'cust_credit_bill' ) {
+ $outside_where =~ s/cust_bill._date/cust_credit_bill._date/g;
+ }
+
+ $sql_outside = "SELECT SUM(cust_credit_bill_pkg.amount)
+ FROM cust_credit_bill_pkg
+ JOIN cust_bill_pkg USING (billpkgnum)
+ $join_cust_pkg
+ JOIN cust_credit_bill USING (creditbillnum)
+ $outside_where
+ AND NOT EXISTS(
+ SELECT 1 FROM cust_bill_pkg_tax_location
+ JOIN cust_main_county USING (taxnum)
+ WHERE cust_bill_pkg_tax_location.billpkgnum = cust_bill_pkg.billpkgnum
+ AND COALESCE(cust_main_county.taxname,'Tax') = $taxname
+ )
+ ";
+ warn "\nOUT_CREDIT:\n$sql_outside\n" if $DEBUG;
+ my $out_credit = FS::Record->scalar_sql($sql_outside);
+
+ my %taxrates;
+ foreach my $tax (
+ qsearch('cust_main_county', {
+ country => $country,
+ tax => { op => '>', value => 0 }
+ }) )
+ {
+ $taxrates{$tax->taxnum} = $tax->tax;
+ }
+
+ # return the data
+ bless {
+ 'opt' => \%opt,
+ 'data' => \%data,
+ 'total' => \%total,
+ 'taxrates' => \%taxrates,
+ 'out_sales' => $out_sales,
+ 'out_credit' => $out_credit,
+ }, $class;
+}
+
+sub opt {
+ my $self = shift;
+ $self->{opt};
+}
+
+sub data {
+ my $self = shift;
+ $self->{data};
+}
+
+# sub fetchall_array...
+
+sub table {
+ my $self = shift;
+ my @columns = (qw(pkgclass taxclass state county city district));
+ # taxnums, field headings, and amounts
+ my @rows;
+ my %row_template;
+
+ # de-treeify this thing
+ my $descend;
+ $descend = sub {
+ my ($tree, $level) = @_;
+ if ( ref($tree) eq 'HASH' ) {
+ foreach my $k ( sort {
+ -1*($b eq '') # sort '' to the end
+ or ($a eq '') # sort '' to the end
+ or ($a <=> $b) # sort numbers as numbers
+ or ($a cmp $b) # sort alphabetics as alphabetics
+ } keys %$tree )
+ {
+ $row_template{ $columns[$level] } = $k;
+ &{ $descend }($tree->{$k}, $level + 1);
+ if ( $level == 0 ) {
+ # then insert the total row for the pkgclass
+ $row_template{'total'} = 1; # flag it as a total
+ &{ $descend }($self->{total}->{$k}, 1);
+ $row_template{'total'} = 0;
+ }
+ }
+ } elsif ( ref($tree) eq 'ARRAY' ) {
+ # then we've reached the bottom; elements of this array are arrayrefs
+ # of [ field, taxnums, amount ].
+ # start with the inherited location-element fields
+ my %this_row = %row_template;
+ my %taxnums;
+ foreach my $x (@$tree) {
+ # accumulate taxnums
+ foreach (split(',', $x->[1])) {
+ $taxnums{$_} = 1;
+ }
+ # and money values
+ $this_row{ $x->[0] } = $x->[2];
+ }
+ # store combined taxnums
+ $this_row{taxnums} = join(',', sort { $a cmp $b } keys %taxnums);
+ # and calculate row totals
+ $this_row{sales} = sprintf('%.2f',
+ $this_row{taxable} +
+ $this_row{sales_credited} +
+ $this_row{exempt_cust} +
+ $this_row{exempt_pkg} +
+ $this_row{exempt_monthly}
+ );
+ $this_row{credits} = sprintf('%.2f',
+ $this_row{sales_credited} +
+ $this_row{exempt_credited} +
+ $this_row{tax_credited}
+ );
+ # and give it a label
+ if ( $this_row{total} ) {
+ $this_row{label} = 'Total';
+ } else {
+ $this_row{label} = join(', ', grep $_,
+ $this_row{taxclass},
+ $this_row{state},
+ $this_row{county}, # already has ' County' suffix
+ $this_row{city},
+ $this_row{district}
+ );
+ }
+ # and indicate the tax rate, if any
+ my $rate;
+ foreach (keys %taxnums) {
+ $rate ||= $self->{taxrates}->{$_};
+ if ( $rate != $self->{taxrates}->{$_} ) {
+ $rate = 'variable';
+ last;
+ }
+ }
+ if ( $rate eq 'variable' ) {
+ $this_row{rate} = 'variable';
+ } elsif ( $rate > 0 ) {
+ $this_row{rate} = sprintf('%.2f', $rate);
+ }
+ push @rows, \%this_row;
+ }
+ };
+
+ &{ $descend }($self->{data}, 0);
+
+ warn "TABLE:\n".Dumper(\@rows) if $self->{opt}->{debug};
+ return @rows;
+}
+
+sub taxrates {
+ my $self = shift;
+ $self->{taxrates}
+}
+
+sub title {
+ my $self = shift;
+ my $string = '';
+ if ( $self->{opt}->{agentnum} ) {
+ my $agent = qsearchs('agent', { agentnum => $self->{opt}->{agentnum} });
+ $string .= $agent->agent . ' ';
+ }
+ $string .= 'Tax Report: '; # XXX localization
+ if ( $self->{opt}->{beginning} ) {
+ $string .= time2str('%h %o %Y ', $self->{opt}->{beginning});
+ }
+ $string .= 'through ';
+ if ( $self->{opt}->{ending} and $self->{opt}->{ending} < 4294967295 ) {
+ $string .= time2str('%h %o %Y', $self->{opt}->{ending});
+ } else {
+ $string .= 'now';
+ }
+ $string .= ' - ' . $self->{opt}->{taxname};
+ return $string;
+}
+
+1;
diff --git a/FS/FS/Schema.pm b/FS/FS/Schema.pm
index 2cb942524..d94f963a6 100644
--- a/FS/FS/Schema.pm
+++ b/FS/FS/Schema.pm
@@ -923,12 +923,13 @@ sub tables_hashref {
'_date', @date_type, '', '',
'status', 'varchar', '', $char_d, '', '',
'statustext', 'text', 'NULL', '', '', '',
+ 'no_action', 'char', 'NULL', 1, '', '',
],
'primary_key' => 'eventnum',
#no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
'unique' => [],
'index' => [ ['eventpart'], ['tablenum'], ['status'],
- ['statustext'], ['_date'],
+ ['statustext'], ['_date'], ['no_action'],
],
'foreign_keys' => [
{ columns => [ 'eventpart' ],
@@ -3590,10 +3591,11 @@ sub tables_hashref {
'refnum', 'serial', '', '', '', '',
'referral', 'varchar', '', $char_d, '', '',
'disabled', 'char', 'NULL', 1, '', '',
- 'agentnum', 'int', 'NULL', '', '', '',
+ 'agentnum', 'int', 'NULL', '', '', '',
+ 'title', 'varchar', 'NULL', $char_d, '', '',
],
'primary_key' => 'refnum',
- 'unique' => [],
+ 'unique' => [ ['agentnum', 'title'] ],
'index' => [ ['disabled'], ['agentnum'], ],
'foreign_keys' => [
{ columns => [ 'agentnum' ],
diff --git a/FS/FS/TicketSystem/RT_Internal.pm b/FS/FS/TicketSystem/RT_Internal.pm
index 6b2d3544c..1c4513e6d 100644
--- a/FS/FS/TicketSystem/RT_Internal.pm
+++ b/FS/FS/TicketSystem/RT_Internal.pm
@@ -468,9 +468,6 @@ sub get_ticket_object {
}
my $Tickets = RT::Tickets->new($session->{CurrentUser});
$Tickets->FromSQL($query);
- if ( $DEBUG ) { # temporary for RT#39536
- warn "[get_ticket_object] " . $Tickets->BuildSelectQuery . "\n\n";
- }
return $Tickets->First;
}
diff --git a/FS/FS/cust_event.pm b/FS/FS/cust_event.pm
index 1d8af1e6e..3edfaefde 100644
--- a/FS/FS/cust_event.pm
+++ b/FS/FS/cust_event.pm
@@ -54,6 +54,13 @@ L and L for conversion functions.
=item statustext - additional status detail (i.e. error or progress message)
+=item no_action - 'Y' if the event action wasn't performed. Some actions
+contain an internal check to see if the action is going to be impossible (for
+example, emailing a notice to a customer who has no email address), and if so,
+won't attempt the action. It shouldn't be reported as a failure because
+there's no need to retry it. However, the action should set no_action = 'Y'
+so that there's a record.
+
=back
=head1 METHODS
@@ -141,6 +148,7 @@ sub check {
|| $self->ut_number('_date')
|| $self->ut_enum('status', [qw( new locked done failed initial)])
|| $self->ut_anything('statustext')
+ || $self->ut_flag('no_action')
;
return $error if $error;
@@ -372,11 +380,46 @@ sub search_sql_where {
push @search, "cust_event._date <= $1";
}
- if ( $param->{'failed'} ) {
- push @search, "statustext != ''",
- "statustext IS NOT NULL",
- "statustext != 'N/A'";
- }
+ #if ( $param->{'failed'} ) {
+ # push @search, "statustext != ''",
+ # "statustext IS NOT NULL",
+ # "statustext != 'N/A'";
+ #}
+ # huh?
+
+ if ( $param->{'event_status'} ) {
+
+ my @status;
+ my ($done_Y, $done_N);
+ foreach (@{ $param->{'event_status'} }) {
+ if ($_ eq 'done_Y') {
+ $done_Y = 1;
+ } elsif ( $_ eq 'done_N' ) {
+ $done_N = 1;
+ } else {
+ push @status, $_;
+ }
+ }
+ if ( $done_Y or $done_N ) {
+ push @status, 'done';
+ }
+ if ( @status ) {
+ push @search, "cust_event.status IN(" .
+ join(',', map "'$_'", @status) .
+ ')';
+ }
+
+ if ( $done_Y and not $done_N ) {
+ push @search, "cust_event.no_action IS NULL";
+ } elsif ( $done_N and not $done_Y ) {
+ push @search, "cust_event.no_action = 'Y'";
+ } # else they're both true, so don't add a constraint, or both false,
+ # and it doesn't matter.
+
+ } # event_status
+
+ # always hide initialization
+ push @search, 'cust_event.status != \'initial\'';
if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
push @search, "cust_main.custnum = '$1'";
diff --git a/FS/FS/cust_location.pm b/FS/FS/cust_location.pm
index 2b8a5c88d..f38e8efcd 100644
--- a/FS/FS/cust_location.pm
+++ b/FS/FS/cust_location.pm
@@ -249,20 +249,22 @@ sub insert {
# cust_location exports
#my $export_args = $options{'export_args'} || [];
- my @part_export =
- map qsearch( 'part_export', {exportnum=>$_} ),
- $conf->config('cust_location-exports'); #, $agentnum
-
- foreach my $part_export ( @part_export ) {
- my $error = $part_export->export_insert($self); #, @$export_args);
- if ( $error ) {
- $dbh->rollback if $oldAutoCommit;
- return "exporting to ". $part_export->exporttype.
- " (transaction rolled back): $error";
+ # don't export custnum_pending cases, let follow-up replace handle that
+ if ($self->custnum || $self->prospectnum) {
+ my @part_export =
+ map qsearch( 'part_export', {exportnum=>$_} ),
+ $conf->config('cust_location-exports'); #, $agentnum
+
+ foreach my $part_export ( @part_export ) {
+ my $error = $part_export->export_insert($self); #, @$export_args);
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return "exporting to ". $part_export->exporttype.
+ " (transaction rolled back): $error";
+ }
}
}
-
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
'';
}
@@ -311,20 +313,22 @@ sub replace {
# cust_location exports
#my $export_args = $options{'export_args'} || [];
- my @part_export =
- map qsearch( 'part_export', {exportnum=>$_} ),
- $conf->config('cust_location-exports'); #, $agentnum
-
- foreach my $part_export ( @part_export ) {
- my $error = $part_export->export_replace($self, $old); #, @$export_args);
- if ( $error ) {
- $dbh->rollback if $oldAutoCommit;
- return "exporting to ". $part_export->exporttype.
- " (transaction rolled back): $error";
+ # don't export custnum_pending cases, let follow-up replace handle that
+ if ($self->custnum || $self->prospectnum) {
+ my @part_export =
+ map qsearch( 'part_export', {exportnum=>$_} ),
+ $conf->config('cust_location-exports'); #, $agentnum
+
+ foreach my $part_export ( @part_export ) {
+ my $error = $part_export->export_replace($self, $old); #, @$export_args);
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return "exporting to ". $part_export->exporttype.
+ " (transaction rolled back): $error";
+ }
}
}
-
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
'';
}
@@ -724,7 +728,7 @@ sub label_prefix {
$prefix;
}
-=item county_state_county
+=item county_state_country
Returns a string consisting of just the county, state and country.
diff --git a/FS/FS/cust_main_Mixin.pm b/FS/FS/cust_main_Mixin.pm
index 9a2a9d7b1..bbba8c5f7 100644
--- a/FS/FS/cust_main_Mixin.pm
+++ b/FS/FS/cust_main_Mixin.pm
@@ -669,11 +669,25 @@ sub unsuspend_balance {
my $maxbalance;
if ($setting eq 'Zero') {
$maxbalance = 0;
+
+ # kind of a pain to load/check all cust_bill instead of just open ones,
+ # but if for some reason payment gets applied to later bills before
+ # earlier ones, we still want to consider the later ones as allowable balance
} elsif ($setting eq 'Latest invoice charges') {
my @cust_bill = $cust_main->cust_bill();
my $cust_bill = $cust_bill[-1]; #always want the most recent one
- return unless $cust_bill;
- $maxbalance = $cust_bill->charged || 0;
+ if ($cust_bill) {
+ $maxbalance = $cust_bill->charged || 0;
+ } else {
+ $maxbalance = 0;
+ }
+ } elsif ($setting eq 'Charges not past due') {
+ my $now = time;
+ $maxbalance = 0;
+ foreach my $cust_bill ($cust_main->cust_bill()) {
+ next unless $now <= ($cust_bill->due_date || $cust_bill->_date);
+ $maxbalance += $cust_bill->charged || 0;
+ }
} elsif (length($setting)) {
warn "Unrecognized unsuspend_balance setting $setting";
return;
diff --git a/FS/FS/cust_pkg.pm b/FS/FS/cust_pkg.pm
index 1bd18e015..1cc82357e 100644
--- a/FS/FS/cust_pkg.pm
+++ b/FS/FS/cust_pkg.pm
@@ -442,6 +442,21 @@ sub insert {
my $conf = new FS::Conf;
+ if ($self->locationnum) {
+ my @part_export =
+ map qsearch( 'part_export', {exportnum=>$_} ),
+ $conf->config('cust_location-exports'); #, $agentnum
+
+ foreach my $part_export ( @part_export ) {
+ my $error = $part_export->export_pkg_location($self); #, @$export_args);
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return "exporting to ". $part_export->exporttype.
+ " (transaction rolled back): $error";
+ }
+ }
+ }
+
if ( ! $import && $conf->config('ticket_system') && $options{ticket_subject} ) {
#this init stuff is still inefficient, but at least its limited to
@@ -696,6 +711,24 @@ sub replace {
}
}
+ # also run exports if removing locationnum?
+ # doesn't seem to happen, and we don't export blank locationnum on insert...
+ if ($new->locationnum and ($new->locationnum != $old->locationnum)) {
+ my $conf = new FS::Conf;
+ my @part_export =
+ map qsearch( 'part_export', {exportnum=>$_} ),
+ $conf->config('cust_location-exports'); #, $agentnum
+
+ foreach my $part_export ( @part_export ) {
+ my $error = $part_export->export_pkg_location($new); #, @$export_args);
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return "exporting to ". $part_export->exporttype.
+ " (transaction rolled back): $error";
+ }
+ }
+ }
+
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
'';
@@ -2132,7 +2165,7 @@ sub change {
my $time = time;
- $hash{'setup'} = $time if $self->setup;
+ $hash{'setup'} = $time if $self->get('setup');
$hash{'change_date'} = $time;
$hash{"change_$_"} = $self->$_()
@@ -2153,16 +2186,18 @@ sub change {
my $unused_credit = 0;
my $keep_dates = $opt->{'keep_dates'};
- # Special case. If the pkgpart is changing, and the customer is
- # going to be credited for remaining time, don't keep setup, bill,
- # or last_bill dates, and DO pass the flag to cancel() to credit
- # the customer.
+ # Special case. If the pkgpart is changing, and the customer is going to be
+ # credited for remaining time, don't keep setup, bill, or last_bill dates,
+ # and DO pass the flag to cancel() to credit the customer. If the old
+ # package had a setup date, set the new package's setup to the package
+ # change date so that it has the same status as before.
if ( $opt->{'pkgpart'}
and $opt->{'pkgpart'} != $self->pkgpart
and $self->part_pkg->option('unused_credit_change', 1) ) {
$unused_credit = 1;
$keep_dates = 0;
- $hash{$_} = '' foreach qw(setup bill last_bill);
+ $hash{'last_bill'} = '';
+ $hash{'bill'} = '';
}
if ( $keep_dates ) {
diff --git a/FS/FS/cust_pkg/API.pm b/FS/FS/cust_pkg/API.pm
index f87eed345..837cf40cc 100644
--- a/FS/FS/cust_pkg/API.pm
+++ b/FS/FS/cust_pkg/API.pm
@@ -10,4 +10,66 @@ sub API_getinfo {
}
+# currently only handles location change...
+# eventually have it handle all sorts of package changes
+sub API_change {
+ my $self = shift;
+ my %opt = @_;
+
+ return { 'error' => 'Cannot change canceled package' }
+ if $self->get('cancel');
+
+ my %changeopt;
+
+ # update location--accepts raw fields OR location
+ my %location_hash;
+ foreach my $field ( qw(
+ locationname
+ address1
+ address2
+ city
+ county
+ state
+ zip
+ addr_clean
+ country
+ censustract
+ censusyear
+ location_type
+ location_number
+ location_kind
+ incorporated
+ ) ) {
+ $location_hash{$field} = $opt{$field} if $opt{$field};
+ }
+ return { 'error' => 'Cannot pass both locationnum and location fields' }
+ if $opt{'locationnum'} && %location_hash;
+
+ if (%location_hash) {
+ my $cust_location = FS::cust_location->new({
+ 'custnum' => $self->custnum,
+ %location_hash,
+ });
+ $changeopt{'cust_location'} = $cust_location;
+ } elsif ($opt{'locationnum'}) {
+ $changeopt{'locationnum'} = $opt{'locationnum'};
+ }
+
+ # not quite "nothing changed" because passed changes might be identical to current record,
+ # we don't currently check for that, don't want to imply that we do...but maybe we should?
+ return { 'error' => 'No changes passed to method' }
+ unless $changeopt{'cust_location'} || $changeopt{'locationnum'};
+
+ $changeopt{'keep_dates'} = 1;
+
+ my $pkg_or_error = $self->change( \%changeopt );
+ my $error = ref($pkg_or_error) ? '' : $pkg_or_error;
+
+ return { 'error' => $error } if $error;
+
+ # return all fields? we don't yet expose them through FS::API
+ return { map { $_ => $pkg_or_error->get($_) } qw( pkgnum locationnum ) };
+
+}
+
1;
diff --git a/FS/FS/part_event/Action/cust_bill_email.pm b/FS/FS/part_event/Action/cust_bill_email.pm
index 3331a4cb6..80bcaa1a7 100644
--- a/FS/FS/part_event/Action/cust_bill_email.pm
+++ b/FS/FS/part_event/Action/cust_bill_email.pm
@@ -20,12 +20,18 @@ sub option_fields {
sub default_weight { 51; }
sub do_action {
- my( $self, $cust_bill ) = @_;
+ my( $self, $cust_bill, $cust_event ) = @_;
my $cust_main = $cust_bill->cust_main;
$cust_bill->set('mode' => $self->option('modenum'));
- $cust_bill->email unless $cust_main->invoice_noemail;
+ if ( $cust_main->invoice_noemail ) {
+ # what about if the customer has no email dest?
+ $cust_event->set('no_action', 'Y');
+ return "customer has invoice_noemail flag";
+ } else {
+ $cust_bill->email;
+ }
}
1;
diff --git a/FS/FS/part_event/Action/cust_bill_print.pm b/FS/FS/part_event/Action/cust_bill_print.pm
index b94e882ff..e6a27a34e 100644
--- a/FS/FS/part_event/Action/cust_bill_print.pm
+++ b/FS/FS/part_event/Action/cust_bill_print.pm
@@ -24,14 +24,22 @@ sub option_fields {
sub default_weight { 51; }
sub do_action {
- my( $self, $cust_bill ) = @_;
+ my( $self, $cust_bill, $cust_event ) = @_;
#my $cust_main = $self->cust_main($cust_bill);
my $cust_main = $cust_bill->cust_main;
$cust_bill->set('mode' => $self->option('modenum'));
- $cust_bill->print unless $self->option('skip_nopost')
- && ! grep { $_ eq 'POST' } $cust_main->invoicing_list;
+ if ( $self->option('skip_nopost')
+ && ! grep { $_ eq 'POST' } $cust_main->invoicing_list
+ ) {
+ # then skip customers
+ $cust_event->set('no_action', 'Y');
+ return "customer doesn't receive postal invoices"; # as statustext
+
+ } else {
+ $cust_bill->print;
+ }
}
1;
diff --git a/FS/FS/part_export/bandwidth_com.pm b/FS/FS/part_export/bandwidth_com.pm
index 4fbc2de21..6d868e640 100644
--- a/FS/FS/part_export/bandwidth_com.pm
+++ b/FS/FS/part_export/bandwidth_com.pm
@@ -56,6 +56,16 @@ with this IP address exists, one will be created.
If you are operating a central SIP gateway to receive traffic for all (or
a subset of) customers, you should configure a phone service with a fixed
value, or a list of fixed values, for the sip_server field.
-%# no action links, the service is canceled
+%# no action links except unprovision, the service is canceled
+% if ( $curuser->access_right('Unprovision customer service') && ! $opt{no_links} ) {
+
+
+ ( <% $svc_unprovision_link %> )
+
+
+% }
<%init>
my %opt = @_;
@@ -29,4 +36,9 @@ my $part_svc = $opt{'part_svc'} || $cust_svc->part_svc;
my $cust_pkg = $opt{'cust_pkg'} || $cust_svc->cust_pkg;
my $svc_x = $cust_svc->svc_x;
+my $svc_unprovision_link =
+ qq!!.emt('Unprovision').'';
+
%init>
diff --git a/httemplate/misc/tax-fetch_and_import.cgi b/httemplate/misc/tax-fetch_and_import.cgi
index 33a6c9b01..970d47c32 100644
--- a/httemplate/misc/tax-fetch_and_import.cgi
+++ b/httemplate/misc/tax-fetch_and_import.cgi
@@ -29,8 +29,9 @@ Import a tax data update.