X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fcust_bill_pkg.pm;h=150f965f5f5cab1548165c7b2aa0789328442975;hb=f650e4347d8bd6df75f6d0c8439c80c40575ed43;hp=15750b255c22e5e89f099b161a389535e9f8d323;hpb=a056cbfc08fa8491aa3c995d7053ed4574b18c50;p=freeside.git diff --git a/FS/FS/cust_bill_pkg.pm b/FS/FS/cust_bill_pkg.pm index 15750b255..150f965f5 100644 --- a/FS/FS/cust_bill_pkg.pm +++ b/FS/FS/cust_bill_pkg.pm @@ -8,10 +8,10 @@ use List::Util qw( sum min ); use Text::CSV_XS; use FS::Record qw( qsearch qsearchs dbh ); use FS::cust_pkg; -use FS::cust_bill; use FS::cust_bill_pkg_detail; use FS::cust_bill_pkg_display; use FS::cust_bill_pkg_discount; +use FS::cust_bill_pkg_fee; use FS::cust_bill_pay_pkg; use FS::cust_credit_bill_pkg; use FS::cust_tax_exempt_pkg; @@ -26,6 +26,8 @@ use FS::cust_bill_pkg_tax_location_void; use FS::cust_bill_pkg_tax_rate_location_void; use FS::cust_tax_exempt_pkg_void; +use FS::Cursor; + $DEBUG = 0; $me = '[FS::cust_bill_pkg]'; @@ -47,8 +49,8 @@ FS::cust_bill_pkg - Object methods for cust_bill_pkg records =head1 DESCRIPTION An FS::cust_bill_pkg object represents an invoice line item. -FS::cust_bill_pkg inherits from FS::Record. The following fields are currently -supported: +FS::cust_bill_pkg inherits from FS::Record. The following fields are +currently supported: =over 4 @@ -201,16 +203,49 @@ sub insert { my $tax_location = $self->get('cust_bill_pkg_tax_location'); if ( $tax_location ) { - foreach my $cust_bill_pkg_tax_location ( @$tax_location ) { - $cust_bill_pkg_tax_location->billpkgnum($self->billpkgnum); - $error = $cust_bill_pkg_tax_location->insert; - if ( $error ) { - $dbh->rollback if $oldAutoCommit; - return "error inserting cust_bill_pkg_tax_location: $error"; + foreach my $link ( @$tax_location ) { + next if $link->billpkgtaxlocationnum; # don't try to double-insert + # This cust_bill_pkg can be linked on either side (i.e. it can be the + # tax or the taxed item). If the other side is already inserted, + # then set billpkgnum to ours, and insert the link. Otherwise, + # set billpkgnum to ours and pass the link off to the cust_bill_pkg + # on the other side, to be inserted later. + + my $tax_cust_bill_pkg = $link->get('tax_cust_bill_pkg'); + if ( $tax_cust_bill_pkg && $tax_cust_bill_pkg->billpkgnum ) { + $link->set('billpkgnum', $tax_cust_bill_pkg->billpkgnum); + # break circular links when doing this + $link->set('tax_cust_bill_pkg', ''); } - } + my $taxable_cust_bill_pkg = $link->get('taxable_cust_bill_pkg'); + if ( $taxable_cust_bill_pkg && $taxable_cust_bill_pkg->billpkgnum ) { + $link->set('taxable_billpkgnum', $taxable_cust_bill_pkg->billpkgnum); + # XXX if we ever do tax-on-tax for these, this will have to change + # since pkgnum will be zero + $link->set('pkgnum', $taxable_cust_bill_pkg->pkgnum); + $link->set('locationnum', $taxable_cust_bill_pkg->tax_locationnum); + $link->set('taxable_cust_bill_pkg', ''); + } + + if ( $link->billpkgnum and $link->taxable_billpkgnum ) { + $error = $link->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting cust_bill_pkg_tax_location: $error"; + } + } else { # handoff + my $other; + $other = $link->billpkgnum ? $link->get('taxable_cust_bill_pkg') + : $link->get('tax_cust_bill_pkg'); + my $link_array = $other->get('cust_bill_pkg_tax_location') || []; + push @$link_array, $link; + $other->set('cust_bill_pkg_tax_location' => $link_array); + } + } #foreach my $link } + # someday you will be as awesome as cust_bill_pkg_tax_location... + # but not today my $tax_rate_location = $self->get('cust_bill_pkg_tax_rate_location'); if ( $tax_rate_location ) { foreach my $cust_bill_pkg_tax_rate_location ( @$tax_rate_location ) { @@ -223,6 +258,52 @@ sub insert { } } + my $fee_links = $self->get('cust_bill_pkg_fee'); + if ( $fee_links ) { + foreach my $link ( @$fee_links ) { + # very similar to cust_bill_pkg_tax_location, for obvious reasons + next if $link->billpkgfeenum; # don't try to double-insert + + my $target = $link->get('cust_bill_pkg'); # the line item of the fee + my $base = $link->get('base_cust_bill_pkg'); # line item it was based on + + if ( $target and $target->billpkgnum ) { + $link->set('billpkgnum', $target->billpkgnum); + # base_invnum => null indicates that the fee is based on its own + # invoice + $link->set('base_invnum', $target->invnum) unless $link->base_invnum; + $link->set('cust_bill_pkg', ''); + } + + if ( $base and $base->billpkgnum ) { + $link->set('base_billpkgnum', $base->billpkgnum); + $link->set('base_cust_bill_pkg', ''); + } elsif ( $base ) { + # it's based on a line item that's not yet inserted + my $link_array = $base->get('cust_bill_pkg_fee') || []; + push @$link_array, $link; + $base->set('cust_bill_pkg_fee' => $link_array); + next; # don't insert the link yet + } + + $error = $link->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting cust_bill_pkg_fee: $error"; + } + } # foreach my $link + } + + my $cust_event_fee = $self->get('cust_event_fee'); + if ( $cust_event_fee ) { + $cust_event_fee->set('billpkgnum' => $self->billpkgnum); + $error = $cust_event_fee->replace; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error updating cust_event_fee: $error"; + } + } + my $cust_tax_adjustment = $self->get('cust_tax_adjustment'); if ( $cust_tax_adjustment ) { $cust_tax_adjustment->billpkgnum($self->billpkgnum); @@ -400,7 +481,13 @@ sub check { || $self->ut_snumber('pkgnum') || $self->ut_number('invnum') || $self->ut_money('setup') + || $self->ut_moneyn('unitsetup') + || $self->ut_currencyn('setup_billed_currency') + || $self->ut_moneyn('setup_billed_amount') || $self->ut_money('recur') + || $self->ut_moneyn('unitrecur') + || $self->ut_currencyn('recur_billed_currency') + || $self->ut_moneyn('recur_billed_amount') || $self->ut_numbern('sdate') || $self->ut_numbern('edate') || $self->ut_textn('itemdesc') @@ -471,11 +558,19 @@ sub regularize_details { Returns the invoice (see L) for this invoice line item. +=item cust_main + +Returns the customer (L object) for this line item. + =cut -sub cust_bill { +sub cust_main { + # required for cust_main_Mixin equivalence + # and use cust_bill instead of cust_pkg because this might not have a + # cust_pkg my $self = shift; - qsearchs( 'cust_bill', { 'invnum' => $self->invnum } ); + my $cust_bill = $self->cust_bill or return ''; + $cust_bill->cust_main; } =item previous_cust_bill_pkg @@ -581,9 +676,10 @@ appropriate FS::cust_bill_pkg_display objects. Options are passed as a list of name/value pairs. Options are: -part_pkg: FS::part_pkg object from the +part_pkg: FS::part_pkg object from this line item's package. -real_pkgpart: if this line item comes from a bundled package, the pkgpart of the owning package. Otherwise the same as the part_pkg's pkgpart above. +real_pkgpart: if this line item comes from a bundled package, the pkgpart +of the owning package. Otherwise the same as the part_pkg's pkgpart above. =cut @@ -594,13 +690,19 @@ sub set_display { my $conf = new FS::Conf; + # whether to break this down into setup/recur/usage my $separate = $conf->exists('separate_usage'); + my $usage_mandate = $part_pkg->option('usage_mandate', 'Hush!') || $cust_pkg->part_pkg->option('usage_mandate', 'Hush!'); # or use the category from $opt{'part_pkg'} if its not bundled? my $categoryname = $cust_pkg->part_pkg->categoryname; + # if we don't have to separate setup/recur/usage, or put this in a + # package-specific section, or display a usage summary, then don't + # even create one of these. The item will just display in the unnamed + # section as a single line plus details. return $self->set('display', []) unless $separate || $categoryname || $usage_mandate; @@ -608,34 +710,46 @@ sub set_display { my %hash = ( 'section' => $categoryname ); + # whether to put usage details in a separate section, and if so, which one my $usage_section = $part_pkg->option('usage_section', 'Hush!') || $cust_pkg->part_pkg->option('usage_section', 'Hush!'); + # whether to show a usage summary line (total usage charges, no details) my $summary = $part_pkg->option('summarize_usage', 'Hush!') || $cust_pkg->part_pkg->option('summarize_usage', 'Hush!'); if ( $separate ) { + # create lines for setup and (non-usage) recur, in the main section push @display, new FS::cust_bill_pkg_display { type => 'S', %hash }; push @display, new FS::cust_bill_pkg_display { type => 'R', %hash }; } else { + # display everything in a single line push @display, new FS::cust_bill_pkg_display { type => '', %hash, + # and if usage_mandate is enabled, hide details + # (this only works on multisection invoices...) ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ), }; } if ($separate && $usage_section && $summary) { + # create a line for the usage summary in the main section push @display, new FS::cust_bill_pkg_display { type => 'U', summary => 'Y', %hash, }; } + if ($usage_mandate || ($usage_section && $summary) ) { $hash{post_total} = 'Y'; } if ($separate || $usage_mandate) { + # show call details for this line item in the usage section. + # if usage_mandate is on, this will display below the section subtotal. + # this also happens if usage is in a separate section and there's a + # summary in the main section, though I'm not sure why. $hash{section} = $usage_section if $usage_section; push @display, new FS::cust_bill_pkg_display { type => 'U', %hash }; } @@ -646,8 +760,9 @@ sub set_display { =item disintegrate -Returns a list of cust_bill_pkg objects each with no more than a single class -(including setup or recur) of charge. +Returns a hash: keys are "setup", "recur" or usage classnum, values are +FS::cust_bill_pkg objects, each with no more than a single class (setup or +recur) of charge. =cut @@ -824,6 +939,68 @@ sub _X_show_zero { $self->cust_pkg->_X_show_zero($what); } +=item credited [ BEFORE, AFTER, OPTIONS ] + +Returns the sum of credits applied to this item. Arguments are the same as +owed_sql/paid_sql/credited_sql. + +=cut + +sub credited { + my $self = shift; + $self->scalar_sql('SELECT '. $self->credited_sql(@_).' FROM cust_bill_pkg WHERE billpkgnum = ?', $self->billpkgnum); +} + +=item tax_locationnum + +Returns the L number that this line item is in for tax +purposes. For package sales, it's the package tax location; for fees, +it's the customer's default service location. + +=cut + +sub tax_locationnum { + my $self = shift; + if ( $self->pkgnum ) { # normal sales + return $self->cust_pkg->tax_locationnum; + } elsif ( $self->feepart ) { # fees + return $self->cust_bill->cust_main->ship_locationnum; + } else { # taxes + return ''; + } +} + +sub tax_location { + my $self = shift; + if ( $self->pkgnum ) { # normal sales + return $self->cust_pkg->tax_location; + } elsif ( $self->feepart ) { # fees + return $self->cust_bill->cust_main->ship_location; + } else { # taxes + return; + } +} + +=item part_X + +Returns the L or L object that defines this +charge. If called on a tax line, returns nothing. + +=cut + +sub part_X { + my $self = shift; + if ( $self->pkgpart_override ) { + return FS::part_pkg->by_key($self->pkgpart_override); + } elsif ( $self->pkgnum ) { + return $self->cust_pkg->part_pkg; + } elsif ( $self->feepart ) { + return $self->part_fee; + } else { + return; + } +} + =back =head1 CLASS METHODS @@ -847,9 +1024,10 @@ sub usage_sql { $usage_sql } # this makes owed_sql, etc. much more concise sub charged_sql { my ($class, $start, $end, %opt) = @_; + my $setuprecur = $opt{setuprecur} || ''; my $charged = - $opt{setuprecur} =~ /^s/ ? 'cust_bill_pkg.setup' : - $opt{setuprecur} =~ /^r/ ? 'cust_bill_pkg.recur' : + $setuprecur =~ /^s/ ? 'cust_bill_pkg.setup' : + $setuprecur =~ /^r/ ? 'cust_bill_pkg.recur' : 'cust_bill_pkg.setup + cust_bill_pkg.recur'; if ($opt{no_usage} and $charged =~ /recur/) { @@ -883,16 +1061,16 @@ Returns an SQL expression for the sum of payments applied to this item. sub paid_sql { my ($class, $start, $end, %opt) = @_; - my $s = $start ? "AND cust_bill_pay._date <= $start" : ''; - my $e = $end ? "AND cust_bill_pay._date > $end" : ''; - my $setuprecur = - $opt{setuprecur} =~ /^s/ ? 'setup' : - $opt{setuprecur} =~ /^r/ ? 'recur' : - ''; + my $s = $start ? "AND cust_pay._date <= $start" : ''; + my $e = $end ? "AND cust_pay._date > $end" : ''; + my $setuprecur = $opt{setuprecur} || ''; + $setuprecur = 'setup' if $setuprecur =~ /^s/; + $setuprecur = 'recur' if $setuprecur =~ /^r/; $setuprecur &&= "AND setuprecur = '$setuprecur'"; my $paid = "( SELECT COALESCE(SUM(cust_bill_pay_pkg.amount),0) FROM cust_bill_pay_pkg JOIN cust_bill_pay USING (billpaynum) + JOIN cust_pay USING (paynum) WHERE cust_bill_pay_pkg.billpkgnum = cust_bill_pkg.billpkgnum $s $e $setuprecur )"; @@ -911,16 +1089,16 @@ sub paid_sql { sub credited_sql { my ($class, $start, $end, %opt) = @_; - my $s = $start ? "AND cust_credit_bill._date <= $start" : ''; - my $e = $end ? "AND cust_credit_bill._date > $end" : ''; - my $setuprecur = - $opt{setuprecur} =~ /^s/ ? 'setup' : - $opt{setuprecur} =~ /^r/ ? 'recur' : - ''; + my $s = $start ? "AND cust_credit._date <= $start" : ''; + my $e = $end ? "AND cust_credit._date > $end" : ''; + my $setuprecur = $opt{setuprecur} || ''; + $setuprecur = 'setup' if $setuprecur =~ /^s/; + $setuprecur = 'recur' if $setuprecur =~ /^r/; $setuprecur &&= "AND setuprecur = '$setuprecur'"; my $credited = "( SELECT COALESCE(SUM(cust_credit_bill_pkg.amount),0) FROM cust_credit_bill_pkg JOIN cust_credit_bill USING (creditbillnum) + JOIN cust_credit USING (crednum) WHERE cust_credit_bill_pkg.billpkgnum = cust_bill_pkg.billpkgnum $s $e $setuprecur )"; @@ -982,8 +1160,14 @@ sub upgrade_tax_location { ' WHERE cust_bill_pkg.invnum = cust_bill.invnum'. ' AND exempt_monthly IS NULL'; - my @invnums = map { $_->invnum } qsearch({ - select => 'cust_bill.invnum', + my %all_tax_names = ( + '' => 1, + 'Tax' => 1, + map { $_->taxname => 1 } + qsearch('h_cust_main_county', { taxname => { op => '!=', value => '' }}) + ); + + my $search = FS::Cursor->new({ table => 'cust_bill', hashref => {}, extra_sql => "WHERE NOT EXISTS($sub_has_tax_link) ". @@ -991,11 +1175,12 @@ sub upgrade_tax_location { $date_where, }); - print "Processing ".scalar(@invnums)." invoices...\n"; +#print "Processing ".scalar(@invnums)." invoices...\n"; my $committed; INVOICE: - foreach my $invnum (@invnums) { + while (my $cust_bill = $search->fetch) { + my $invnum = $cust_bill->invnum; $committed = 0; print STDERR "Invoice #$invnum\n"; my $pre = ''; @@ -1019,7 +1204,7 @@ sub upgrade_tax_location { # invoice date-of-insertion. (Not necessarily the invoice date.) my $date = $h_cust_bill->history_date; my $h_cust_main = qsearchs('h_cust_main', - { custnum => $custnum }, + { custnum => $custnum }, FS::h_cust_main->sql_h_searchs($date) ); if (!$h_cust_main ) { @@ -1031,18 +1216,24 @@ sub upgrade_tax_location { # This is a historical customer record, so it has a historical address. # If there's no cust_location matching this custnum and address (there # probably isn't), create one. - $pre = 'ship_' if $use_ship and length($h_cust_main->get('ship_last')); - my %hash = map { $_ => $h_cust_main->get($pre.$_) } - FS::cust_main->location_fields; - # not really needed for this, and often result in duplicate locations - delete @hash{qw(censustract censusyear latitude longitude coord_auto)}; - - $hash{custnum} = $h_cust_main->custnum; - my $tax_loc = qsearchs('cust_location', \%hash) # unlikely - || FS::cust_location->new({ %hash }); - if ( !$tax_loc->locationnum ) { - $tax_loc->disabled('Y'); - my $error = $tax_loc->insert; + my $tax_loc; + if ( $h_cust_main->bill_locationnum ) { + # the location has already been upgraded + if ($use_ship) { + $tax_loc = $h_cust_main->ship_location; + } else { + $tax_loc = $h_cust_main->bill_location; + } + } else { + $pre = 'ship_' if $use_ship and length($h_cust_main->get('ship_last')); + my %hash = map { $_ => $h_cust_main->get($pre.$_) } + FS::cust_main->location_fields; + # not really needed for this, and often result in duplicate locations + delete @hash{qw(censustract censusyear latitude longitude coord_auto)}; + + $hash{custnum} = $h_cust_main->custnum; + $tax_loc = FS::cust_location->new(\%hash); + my $error = $tax_loc->find_or_insert || $tax_loc->disable_if_unused; if ( $error ) { warn "couldn't create historical location record for cust#". $h_cust_main->custnum.": $error\n"; @@ -1051,13 +1242,6 @@ sub upgrade_tax_location { } my $exempt_cust = 1 if $h_cust_main->tax; - # Get any per-customer taxname exemptions that were in effect. - my %exempt_cust_taxname = map { - $_->taxname => 1 - } qsearch('h_cust_main_exemption', { 'custnum' => $custnum }, - FS::h_cust_main_exemption->sql_h_searchs($date) - ); - # classify line items my @tax_items; my %nontax_items; # taxclass => array of cust_bill_pkg @@ -1107,14 +1291,29 @@ sub upgrade_tax_location { push @{ $nontax_items{$taxclass} }, $item; } } + printf("%d tax items: \$%.2f\n", scalar(@tax_items), map {$_->setup} @tax_items) if @tax_items; + # Get any per-customer taxname exemptions that were in effect. + my %exempt_cust_taxname; + foreach (keys %all_tax_names) { + my $h_exemption = qsearchs('h_cust_main_exemption', { + 'custnum' => $custnum, + 'taxname' => $_, + }, + FS::h_cust_main_exemption->sql_h_searchs($date, $date) + ); + if ($h_exemption) { + $exempt_cust_taxname{ $_ } = 1; + } + } + # Use a variation on the procedure in # FS::cust_main::Billing::_handle_taxes to identify taxes that apply # to this bill. my @loc_keys = qw( district city county state country ); - my %taxhash = map { $_ => $h_cust_main->get($pre.$_) } @loc_keys; + my %taxhash = map { $_ => $tax_loc->get($pre.$_) } @loc_keys; my %taxdef_by_name; # by name, and then by taxclass my %est_tax; # by name, and then by taxclass my %taxable_items; # by taxnum, and then an array @@ -1232,8 +1431,7 @@ sub upgrade_tax_location { if ( !exists( $taxdef_by_name{$taxname} ) ) { # then we didn't find any applicable taxes with this name - warn "no definition found for tax item '$taxname'.\n". - '('.join(' ', @hash{qw(country state county city district)}).")\n"; + warn "no definition found for tax item '$taxname', custnum $custnum\n"; # possibly all of these should be "next TAX_ITEM", but whole invoices # are transaction protected and we can go back and retry them. next INVOICE; @@ -1278,9 +1476,10 @@ sub upgrade_tax_location { ); $cents_remaining -= $part; push @tax_links, { - taxnum => $taxdef->taxnum, - pkgnum => $nontax->pkgnum, - cents => $part, + taxnum => $taxdef->taxnum, + pkgnum => $nontax->pkgnum, + billpkgnum => $nontax->billpkgnum, + cents => $part, }; } #foreach $nontax } #foreach $taxclass @@ -1288,7 +1487,9 @@ sub upgrade_tax_location { my $i = 0; my $nlinks = scalar(@tax_links); if ( $nlinks ) { - while (int($cents_remaining) > 0) { + # ensure that it really is an integer + $cents_remaining = sprintf('%.0f', $cents_remaining); + while ($cents_remaining > 0) { $tax_links[$i % $nlinks]->{cents} += 1; $cents_remaining--; $i++; @@ -1323,6 +1524,7 @@ sub upgrade_tax_location { taxnum => $_->{taxnum}, pkgnum => $_->{pkgnum}, amount => sprintf('%.2f', $_->{cents} / 100), + taxable_billpkgnum => $_->{billpkgnum}, }); my $error = $link->insert; if ( $error ) { @@ -1408,9 +1610,20 @@ sub _upgrade_data { }); # call it kind of like a class method, not that it matters much $job->insert($class, 's' => str2time('2012-01-01')); + # if there's a customer location upgrade queued also, wait for it to + # finish + my $location_job = qsearchs('queue', { + job => 'FS::cust_main::Location::process_upgrade_location' + }); + if ( $location_job ) { + $job->depend_insert($location_job->jobnum); + } # Then mark the upgrade as done, so that we don't queue the job twice # and somehow run two of them concurrently. FS::upgrade_journal->set_done($upgrade); + # This upgrade now does the job of assigning taxable_billpkgnums to + # cust_bill_pkg_tax_location, so set that task done also. + FS::upgrade_journal->set_done('tax_location_taxable_billpkgnum'); } =back