X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcust_credit.pm;h=58bd475b177e234fcc5d6358a58f6b3fa8b61f49;hp=8ec255b95e77056540e9a7409382c7cc472e10a1;hb=e9e0cf0989259b94d9758eceff448666a2e5a5cc;hpb=87227cd405166484ca7b791b2bd3c8829ce8d969 diff --git a/FS/FS/cust_credit.pm b/FS/FS/cust_credit.pm index 8ec255b95..58bd475b1 100644 --- a/FS/FS/cust_credit.pm +++ b/FS/FS/cust_credit.pm @@ -1,16 +1,34 @@ package FS::cust_credit; +use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::reason_Mixin + FS::Record ); use strict; -use vars qw( @ISA $conf $unsuspendauto ); +use vars qw( $conf $unsuspendauto $me $DEBUG + $otaker_upgrade_kludge $ignore_empty_reasonnum + ); +use List::Util qw( min ); use Date::Format; -use FS::UID qw( dbh getotaker ); -use FS::Record qw( qsearch qsearchs ); +use FS::UID qw( dbh ); use FS::Misc qw(send_email); -use FS::cust_main; +use FS::Record qw( qsearch qsearchs dbdef ); +use FS::CurrentUser; +use FS::cust_pkg; use FS::cust_refund; use FS::cust_credit_bill; +use FS::part_pkg; +use FS::reason_type; +use FS::reason; +use FS::cust_event; +use FS::agent; +use FS::sales; +use FS::cust_credit_void; +use FS::upgrade_journal; -@ISA = qw( FS::Record ); +$me = '[ FS::cust_credit ]'; +$DEBUG = 0; + +$otaker_upgrade_kludge = 0; +$ignore_empty_reasonnum = 0; #ask FS::UID to run this stuff for us later $FS::UID::callback{'FS::cust_credit'} = sub { @@ -20,6 +38,11 @@ $FS::UID::callback{'FS::cust_credit'} = sub { }; +our %reasontype_map = ( 'referral_credit_type' => 'Referral Credit', + 'cancel_credit_type' => 'Cancellation Credit', + 'signup_credit_type' => 'Self-Service Credit', + ); + =head1 NAME FS::cust_credit - Object methods for cust_credit records @@ -47,20 +70,46 @@ FS::Record. The following fields are currently supported: =over 4 -=item crednum - primary key (assigned automatically for new credits) +=item crednum + +Primary key (assigned automatically for new credits) + +=item custnum -=item custnum - customer (see L) +Customer (see L) -=item amount - amount of the credit +=item amount -=item _date - specified as a UNIX timestamp; see L. Also see +Amount of the credit + +=item _date + +Specified as a UNIX timestamp; see L. Also see L and L for conversion functions. -=item otaker - order taker (assigned automatically, see L) +=item usernum + +Order taker (see L) + +=item reason + +Text ( deprecated ) + +=item reasonnum + +Reason (see L) + +=item addlinfo + +Text -=item reason - text +=item closed -=item closed - books closed flag, empty or `Y' +Books closed flag, empty or `Y' + +=item pkgnum + +Desired pkgnum when using experimental package balances. =back @@ -75,6 +124,12 @@ Creates a new credit. To add the credit to the database, see L<"insert">. =cut sub table { 'cust_credit'; } +sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum } +sub cust_unlinked_msg { + my $self = shift; + "WARNING: can't find cust_main.custnum ". $self->custnum. + ' (cust_credit.crednum '. $self->crednum. ')'; +} =item insert @@ -84,7 +139,7 @@ returns the error, otherwise returns false. =cut sub insert { - my $self = shift; + my ($self, %options) = @_; local $SIG{HUP} = 'IGNORE'; local $SIG{INT} = 'IGNORE'; @@ -100,13 +155,29 @@ sub insert { my $cust_main = qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); my $old_balance = $cust_main->balance; + unless ($self->reasonnum) { + my $result = $self->reason( $self->getfield('reason'), + exists($options{ 'reason_type' }) + ? ('reason_type' => $options{ 'reason_type' }) + : (), + ); + unless($result) { + $dbh->rollback if $oldAutoCommit; + return "failed to set reason for $me"; #: ". $dbh->errstr; + } + } + + $self->setfield('reason', ''); + my $error = $self->SUPER::insert; if ( $error ) { $dbh->rollback if $oldAutoCommit; return "error inserting $self: $error"; } - #false laziness w/ cust_credit::insert + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + + #false laziness w/ cust_pay::insert if ( $unsuspendauto && $old_balance && $cust_main->balance <= 0 ) { my @errors = $cust_main->unsuspend; #return @@ -125,12 +196,17 @@ sub insert { =item delete -Currently unimplemented. +Unless the closed flag is set, deletes this credit and all associated +applications (see L). In most cases, you want to use +the void method instead to leave a record of the deleted credit. =cut +# very similar to FS::cust_pay::delete sub delete { my $self = shift; + my %opt = @_; + return "Can't delete closed credit" if $self->closed =~ /^Y/i; local $SIG{HUP} = 'IGNORE'; @@ -152,18 +228,27 @@ sub delete { } } + foreach my $cust_credit_refund ( $self->cust_credit_refund ) { + my $error = $cust_credit_refund->delete; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + my $error = $self->SUPER::delete(@_); if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; } - if ( $conf->config('deletecredits') ne '' ) { + if ( !$opt{void} and $conf->config('deletecredits') ne '' ) { - my $cust_main = qsearchs('cust_main',{ 'custnum' => $self->custnum }); + my $cust_main = $self->cust_main; my $error = send_email( - 'from' => $conf->config('invoice_from'), #??? well as good as any + 'from' => $conf->config('invoice_from', $self->cust_main->agentnum), + #invoice_from??? well as good as any 'to' => $conf->config('deletecredits'), 'subject' => 'FREESIDE NOTIFICATION: Credit deleted', 'body' => [ @@ -192,15 +277,17 @@ sub delete { } -=item replace OLD_RECORD +=item replace [ OLD_RECORD ] -Credits may not be modified; there would then be no record the credit was ever -posted. +You can, but probably shouldn't modify credits... + +Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not +supplied, replaces this record. If there is an error, returns the error, +otherwise returns false. =cut sub replace { - #return "Can't modify credit!" my $self = shift; return "Can't modify closed credit" if $self->closed =~ /^Y/i; $self->SUPER::replace(@_); @@ -217,44 +304,87 @@ methods. sub check { my $self = shift; + $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum; + my $error = $self->ut_numbern('crednum') || $self->ut_number('custnum') || $self->ut_numbern('_date') || $self->ut_money('amount') + || $self->ut_alphan('otaker') || $self->ut_textn('reason') + || $self->ut_textn('addlinfo') || $self->ut_enum('closed', [ '', 'Y' ]) + || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum') + || $self->ut_foreign_keyn('eventnum', 'cust_event', 'eventnum') + || $self->ut_foreign_keyn('commission_agentnum', 'agent', 'agentnum') + || $self->ut_foreign_keyn('commission_salesnum', 'sales', 'salesnum') + || $self->ut_foreign_keyn('commission_pkgnum', 'cust_pkg', 'pkgnum') ; return $error if $error; + my $method = $ignore_empty_reasonnum ? 'ut_foreign_keyn' : 'ut_foreign_key'; + $error = $self->$method('reasonnum', 'reason', 'reasonnum'); + return $error if $error; + return "amount must be > 0 " if $self->amount <= 0; + return "amount must be greater or equal to amount applied" + if $self->unapplied < 0 && ! $otaker_upgrade_kludge; + return "Unknown customer" unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); $self->_date(time) unless $self->_date; - $self->otaker(getotaker); - $self->SUPER::check; } -=item cust_refund +=item void [ REASON ] -Depreciated. See the cust_credit_refund method. - -#Returns all refunds (see L) for this credit. +Voids this credit: deletes the credit and all associated applications and +adds a record of the voided credit to the cust_credit_void table. =cut -sub cust_refund { - use Carp; - croak "FS::cust_credit->cust_pay depreciated; see ". - "FS::cust_credit->cust_credit_refund"; - #my $self = shift; - #sort { $a->_date <=> $b->_date } - # qsearch( 'cust_refund', { 'crednum' => $self->crednum } ) - #; +# yes, false laziness with cust_pay and cust_bill +# but frankly I don't have time to fix it now + +sub void { + my $self = shift; + my $reason = shift; + + local $SIG{HUP} = 'IGNORE'; + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + my $cust_credit_void = new FS::cust_credit_void ( { + map { $_ => $self->get($_) } $self->fields + } ); + $cust_credit_void->set('void_reason', $reason); + my $error = $cust_credit_void->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + $error = $self->delete(void => 1); # suppress deletecredits warning + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + + ''; + } =item cust_credit_refund @@ -265,6 +395,7 @@ Returns all refund applications (see L) for this credit. sub cust_credit_refund { my $self = shift; + map { $_ } #return $self->num_cust_credit_refund unless wantarray; sort { $a->_date <=> $b->_date } qsearch( 'cust_credit_refund', { 'crednum' => $self->crednum } ) ; @@ -279,20 +410,21 @@ credit. sub cust_credit_bill { my $self = shift; + map { $_ } #return $self->num_cust_credit_bill unless wantarray; sort { $a->_date <=> $b->_date } qsearch( 'cust_credit_bill', { 'crednum' => $self->crednum } ) ; } -=item credited +=item unapplied -Returns the amount of this credit that is still outstanding; which is +Returns the amount of this credit that is still unapplied/outstanding; amount minus all refund applications (see L) and applications to invoices (see L). =cut -sub credited { +sub unapplied { my $self = shift; my $amount = $self->amount; $amount -= $_->amount foreach ( $self->cust_credit_refund ); @@ -300,17 +432,626 @@ sub credited { sprintf( "%.2f", $amount ); } +=item credited + +Deprecated name for the unapplied method. + +=cut + +sub credited { + my $self = shift; + #carp "cust_credit->credited deprecated; use ->unapplied"; + $self->unapplied(@_); +} + =item cust_main Returns the customer (see L) for this credit. =cut -sub cust_main { - my $self = shift; - qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); +# _upgrade_data +# +# Used by FS::Upgrade to migrate to a new database. + +sub _upgrade_data { # class method + my ($class, %opts) = @_; + + warn "$me upgrading $class\n" if $DEBUG; + + $class->_upgrade_reasonnum(%opts); + + if (defined dbdef->table($class->table)->column('reason')) { + + warn "$me Ensuring existance of auto reasons\n" if $DEBUG; + + foreach ( keys %reasontype_map ) { + unless ($conf->config($_)) { # hmmmm +# warn "$me Found $_ reason type lacking\n" if $DEBUG; +# my $hashref = { 'class' => 'R', 'type' => $reasontype_map{$_} }; + my $hashref = { 'class' => 'R', 'type' => 'Legacy' }; + my $reason_type = qsearchs( 'reason_type', $hashref ); + unless ($reason_type) { + $reason_type = new FS::reason_type( $hashref ); + my $error = $reason_type->insert(); + die "$class had error inserting FS::reason_type into database: $error\n" + if $error; + } + $conf->set($_, $reason_type->typenum); + } + } + + warn "$me Ensuring commission packages have a reason type\n" if $DEBUG; + + my $hashref = { 'class' => 'R', 'type' => 'Legacy' }; + my $reason_type = qsearchs( 'reason_type', $hashref ); + unless ($reason_type) { + $reason_type = new FS::reason_type( $hashref ); + my $error = $reason_type->insert(); + die "$class had error inserting FS::reason_type into database: $error\n" + if $error; + } + + my @plans = qw( flat_comission flat_comission_cust flat_comission_pkg ); + foreach my $plan ( @plans ) { + foreach my $pkg ( qsearch('part_pkg', { 'plan' => $plan } ) ) { + unless ($pkg->option('reason_type', 1) ) { + my $plandata = $pkg->plandata. + "reason_type=". $reason_type->typenum. "\n"; + $pkg->plandata($plandata); + my $error = + $pkg->replace( undef, + 'pkg_svc' => { map { $_->svcpart => $_->quantity } + $pkg->pkg_svc + }, + 'primary_svc' => $pkg->svcpart, + ); + die "failed setting reason_type option: $error" + if $error; + } + } + } + } + + local($otaker_upgrade_kludge) = 1; + local($ignore_empty_reasonnum) = 1; + $class->_upgrade_otaker(%opts); + + if ( !FS::upgrade_journal->is_done('cust_credit__tax_link') + and !$conf->exists('enable_taxproducts') ) { + # RT#25458: fix credit line item applications that should refer to a + # specific tax allocation + my @cust_credit_bill_pkg = qsearch({ + table => 'cust_credit_bill_pkg', + select => 'cust_credit_bill_pkg.*', + addl_from => ' LEFT JOIN cust_bill_pkg USING (billpkgnum)', + extra_sql => + 'WHERE cust_credit_bill_pkg.billpkgtaxlocationnum IS NULL '. + 'AND cust_bill_pkg.pkgnum = 0', # is a tax + }); + my %tax_items; + my %credits; + foreach (@cust_credit_bill_pkg) { + my $billpkgnum = $_->billpkgnum; + $tax_items{$billpkgnum} ||= FS::cust_bill_pkg->by_key($billpkgnum); + $credits{$billpkgnum} ||= []; + push @{ $credits{$billpkgnum} }, $_; + } + TAX_ITEM: foreach my $tax_item (values %tax_items) { + my $billpkgnum = $tax_item->billpkgnum; + # get all pkg/location/taxrate allocations of this tax line item + my @allocations = sort {$b->amount <=> $a->amount} + qsearch('cust_bill_pkg_tax_location', { + billpkgnum => $billpkgnum + }); + # and these are all credit applications to it + my @credits = sort {$b->amount <=> $a->amount} + @{ $credits{$billpkgnum} }; + my $c = shift @credits; + my $a = shift @allocations; # we will NOT modify these + while ($c and $a) { + if ( abs($c->amount - $a->amount) < 0.005 ) { + # by far the most common case: the tax line item is for a single + # tax, so we just fill in the billpkgtaxlocationnum + $c->set('billpkgtaxlocationnum', $a->billpkgtaxlocationnum); + my $error = $c->replace; + if ($error) { + warn "error fixing credit application to tax item #$billpkgnum:\n$error\n"; + next TAX_ITEM; + } + $c = shift @credits; + $a = shift @allocations; + } elsif ( $c->amount > $a->amount ) { + # fairly common: the tax line contains tax for multiple packages + # (or multiple taxes) but the credit isn't divided up + my $new_link = FS::cust_credit_bill_pkg->new({ + creditbillnum => $c->creditbillnum, + billpkgnum => $c->billpkgnum, + billpkgtaxlocationnum => $a->billpkgtaxlocationnum, + amount => $a->amount, + setuprecur => 'setup', + }); + my $error = $new_link->insert; + if ($error) { + warn "error fixing credit application to tax item #$billpkgnum:\n$error\n"; + next TAX_ITEM; + } + $c->set(amount => sprintf('%.2f', $c->amount - $a->amount)); + $a = shift @allocations; + } elsif ( $c->amount < 0.005 ) { + # also fairly common; we can delete these with no harm + my $error = $c->delete; + warn "error removing zero-amount credit application (probably harmless):\n$error\n" if $error; + $c = shift @credits; + } elsif ( $c->amount < $a->amount ) { + # should never happen, but if it does, handle it gracefully + $c->set('billpkgtaxlocationnum', $a->billpkgtaxlocationnum); + my $error = $c->replace; + if ($error) { + warn "error fixing credit application to tax item #$billpkgnum:\n$error\n"; + next TAX_ITEM; + } + $a->set(amount => $a->amount - $c->amount); + $c = shift @credits; + } + } # while $c and $a + if ( $c ) { + if ( $c->amount < 0.005 ) { + my $error = $c->delete; + warn "error removing zero-amount credit application (probably harmless):\n$error\n" if $error; + } elsif ( $c->modified ) { + # then we've allocated part of it, so reduce the nonspecific + # application by that much + my $error = $c->replace; + warn "error fixing credit application to tax item #$billpkgnum:\n$error\n" if $error; + } + # else there are probably no allocations, i.e. this is a pre-3.x + # record that was never migrated over, so leave it alone + } # if $c + } # foreach $tax_item + FS::upgrade_journal->set_done('cust_credit__tax_link'); + } } +=back + +=head1 CLASS METHODS + +=over 4 + +=item unapplied_sql + +Returns an SQL fragment to retreive the unapplied amount. + +=cut + +sub unapplied_sql { + my ($class, $start, $end) = @_; + + my $bill_start = $start ? "AND cust_credit_bill._date <= $start" : ''; + my $bill_end = $end ? "AND cust_credit_bill._date > $end" : ''; + my $refund_start = $start ? "AND cust_credit_refund._date <= $start" : ''; + my $refund_end = $end ? "AND cust_credit_refund._date > $end" : ''; + + "amount + - COALESCE( + ( SELECT SUM(amount) FROM cust_credit_refund + WHERE cust_credit.crednum = cust_credit_refund.crednum + $refund_start $refund_end ) + ,0 + ) + - COALESCE( + ( SELECT SUM(amount) FROM cust_credit_bill + WHERE cust_credit.crednum = cust_credit_bill.crednum + $bill_start $bill_end ) + ,0 + ) + "; + +} + +=item credited_sql + +Deprecated name for the unapplied_sql method. + +=cut + +sub credited_sql { + #my $class = shift; + + #carp "cust_credit->credited_sql deprecated; use ->unapplied_sql"; + + #$class->unapplied_sql(@_); + unapplied_sql(); +} + +=item credit_lineitems + +Example: + + my $error = FS::cust_credit->credit_lineitems( + + #the lineitems to credit + 'billpkgnums' => \@billpkgnums, + 'setuprecurs' => \@setuprecurs, + 'amounts' => \@amounts, + 'apply' => 1, #0 leaves the credit unapplied + + #the credit + 'newreasonnum' => scalar($cgi->param('newreasonnum')), + 'newreasonnum_type' => scalar($cgi->param('newreasonnumT')), + map { $_ => scalar($cgi->param($_)) } + #fields('cust_credit') + qw( custnum _date amount reason reasonnum addlinfo ), #pkgnum eventnum + + ); + +=cut + +#maybe i should just be an insert with extra args instead of a class method +use FS::cust_bill_pkg; +sub credit_lineitems { + my( $class, %arg ) = @_; + my $curuser = $FS::CurrentUser::CurrentUser; + + #some false laziness w/misc/xmlhttp-cust_bill_pkg-calculate_taxes.html + + my $cust_main = qsearchs({ + 'table' => 'cust_main', + 'hashref' => { 'custnum' => $arg{custnum} }, + 'extra_sql' => ' AND '. $curuser->agentnums_sql, + }) or return 'unknown customer'; + + + local $SIG{HUP} = 'IGNORE'; + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + #my @cust_bill_pkg = qsearch({ + # 'select' => 'cust_bill_pkg.*', + # 'table' => 'cust_bill_pkg', + # 'addl_from' => ' LEFT JOIN cust_bill USING (invnum) '. + # ' LEFT JOIN cust_main USING (custnum) ', + # 'extra_sql' => ' WHERE custnum = $custnum AND billpkgnum IN ('. + # join( ',', @{$arg{billpkgnums}} ). ')', + # 'order_by' => 'ORDER BY invnum ASC, billpkgnum ASC', + #}); + + my $error = ''; + if ($arg{reasonnum} == -1) { + + $error = 'Enter a new reason (or select an existing one)' + unless $arg{newreasonnum} !~ /^\s*$/; + my $reason = new FS::reason { + 'reason' => $arg{newreasonnum}, + 'reason_type' => $arg{newreasonnum_type}, + }; + $error ||= $reason->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "Error inserting reason: $error"; + } + $arg{reasonnum} = $reason->reasonnum; + } + + my $cust_credit = new FS::cust_credit ( { + map { $_ => $arg{$_} } + #fields('cust_credit') + qw( custnum _date amount reason reasonnum addlinfo ), #pkgnum eventnum + } ); + $error = $cust_credit->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "Error inserting credit: $error"; + } + + unless ( $arg{'apply'} ) { + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + return ''; + } + + #my $subtotal = 0; + # keys in all of these are invoice numbers + my %cust_credit_bill = (); + my %cust_bill_pkg = (); + my %cust_credit_bill_pkg = (); + my %taxlisthash = (); + my %unapplied_payments = (); #invoice numbers, and then billpaynums + foreach my $billpkgnum ( @{$arg{billpkgnums}} ) { + my $setuprecur = shift @{$arg{setuprecurs}}; + my $amount = shift @{$arg{amounts}}; + + my $cust_bill_pkg = qsearchs({ + 'table' => 'cust_bill_pkg', + 'hashref' => { 'billpkgnum' => $billpkgnum }, + 'addl_from' => 'LEFT JOIN cust_bill USING (invnum)', + 'extra_sql' => 'AND custnum = '. $cust_main->custnum, + }) or die "unknown billpkgnum $billpkgnum"; + + my $invnum = $cust_bill_pkg->invnum; + + if ( $setuprecur eq 'setup' ) { + $cust_bill_pkg->setup($amount); + $cust_bill_pkg->recur(0); + $cust_bill_pkg->unitrecur(0); + $cust_bill_pkg->type(''); + } else { + $setuprecur = 'recur'; #in case its a usage classnum? + $cust_bill_pkg->recur($amount); + $cust_bill_pkg->setup(0); + $cust_bill_pkg->unitsetup(0); + } + + push @{$cust_bill_pkg{$invnum}}, $cust_bill_pkg; + + #unapply any payments applied to this line item (other credits too?) + foreach my $cust_bill_pay_pkg ( $cust_bill_pkg->cust_bill_pay_pkg($setuprecur) ) { + $error = $cust_bill_pay_pkg->delete; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "Error unapplying payment: $error"; + } + $unapplied_payments{$invnum}{$cust_bill_pay_pkg->billpaynum} + += $cust_bill_pay_pkg->amount; + } + + #$subtotal += $amount; + $cust_credit_bill{$invnum} += $amount; + push @{ $cust_credit_bill_pkg{$invnum} }, + new FS::cust_credit_bill_pkg { + 'billpkgnum' => $cust_bill_pkg->billpkgnum, + 'amount' => sprintf('%.2f',$amount), + 'setuprecur' => $setuprecur, + 'sdate' => $cust_bill_pkg->sdate, + 'edate' => $cust_bill_pkg->edate, + }; + + # recalculate taxes with new amounts + $taxlisthash{$invnum} ||= {}; + my $part_pkg = $cust_bill_pkg->part_pkg + if $cust_bill_pkg->pkgpart_override; + $cust_main->_handle_taxes( $taxlisthash{$invnum}, $cust_bill_pkg ); + } + + ### + # now loop through %cust_credit_bill and insert those + ### + + # (hack to prevent cust_credit_bill_pkg insertion) + local($FS::cust_bill_ApplicationCommon::skip_apply_to_lineitems_hack) = 1; + + foreach my $invnum ( sort { $a <=> $b } keys %cust_credit_bill ) { + + my $arrayref_or_error = + $cust_main->calculate_taxes( + $cust_bill_pkg{$invnum}, # list of taxable items that we're crediting + $taxlisthash{$invnum}, # list of tax-item bindings + $cust_bill_pkg{$invnum}->[0]->cust_bill->_date, # invoice time + ); + + unless ( ref( $arrayref_or_error ) ) { + $dbh->rollback if $oldAutoCommit; + return "Error calculating taxes: $arrayref_or_error"; + } + + my %tax_links; # {tax billpkgnum}{nontax billpkgnum} + + #taxes + foreach my $cust_bill_pkg ( @{ $cust_bill_pkg{$invnum} } ) { + my $billpkgnum = $cust_bill_pkg->billpkgnum; + my %hash = ( 'taxable_billpkgnum' => $billpkgnum ); + # gather up existing tax links (we need their billpkgtaxlocationnums) + my @tax_links = qsearch('cust_bill_pkg_tax_location', \%hash), + qsearch('cust_bill_pkg_tax_rate_location', \%hash); + + foreach ( @tax_links ) { + $tax_links{$_->billpkgnum} ||= {}; + $tax_links{$_->billpkgnum}{$_->taxable_billpkgnum} = $_; + } + } + + foreach my $taxline ( @$arrayref_or_error ) { + + my $amount = $taxline->setup; + + # find equivalent tax line item on the existing invoice + my $tax_item = qsearchs('cust_bill_pkg', { + 'invnum' => $invnum, + 'pkgnum' => 0, + 'itemdesc' => $taxline->desc, + }); + if (!$tax_item) { + # or should we just exit if this happens? + $cust_credit->set('amount', + sprintf('%.2f', $cust_credit->get('amount') - $amount) + ); + my $error = $cust_credit->replace; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error correcting credit for missing tax line: $error"; + } + } + + # but in the new era, we no longer have the problem of uniquely + # identifying the tax_Xlocation record. The billpkgnums of the + # tax and the taxed item are known. + foreach my $new_loc + ( @{ $taxline->get('cust_bill_pkg_tax_location') }, + @{ $taxline->get('cust_bill_pkg_tax_rate_location') } ) + { + # the existing tax_Xlocation object + my $old_loc = + $tax_links{$tax_item->billpkgnum}{$new_loc->taxable_cust_bill_pkg->billpkgnum}; + + next if !$old_loc; # apply the leftover amount nonspecifically + + #support partial credits: use $amount if smaller + # (so just distribute to the first location? perhaps should + # do so evenly...) + my $loc_amount = min( $amount, $new_loc->amount); + + $amount -= $loc_amount; + + $cust_credit_bill{$invnum} += $loc_amount; + push @{ $cust_credit_bill_pkg{$invnum} }, + new FS::cust_credit_bill_pkg { + 'billpkgnum' => $tax_item->billpkgnum, + 'amount' => $loc_amount, + 'setuprecur' => 'setup', + 'billpkgtaxlocationnum' => $old_loc->billpkgtaxlocationnum, + 'billpkgtaxratelocationnum' => $old_loc->billpkgtaxratelocationnum, + }; + + } #foreach my $new_loc + + # we still have to deal with the possibility that the tax links don't + # cover the whole amount of tax because of an incomplete upgrade... + if ($amount > 0.005) { + $cust_credit_bill{$invnum} += $amount; + push @{ $cust_credit_bill_pkg{$invnum} }, + new FS::cust_credit_bill_pkg { + 'billpkgnum' => $tax_item->billpkgnum, + 'amount' => sprintf('%.2f', $amount), + 'setuprecur' => 'setup', + }; + + } # if $amount > 0 + + #unapply any payments applied to the tax + foreach my $cust_bill_pay_pkg + ( $tax_item->cust_bill_pay_pkg('setup') ) + { + $error = $cust_bill_pay_pkg->delete; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "Error unapplying payment: $error"; + } + $unapplied_payments{$invnum}{$cust_bill_pay_pkg->billpaynum} + += $cust_bill_pay_pkg->amount; + } + } #foreach $taxline + + # if we unapplied any payments from line items, also unapply that + # amount from the invoice + foreach my $billpaynum (keys %{$unapplied_payments{$invnum}}) { + my $cust_bill_pay = FS::cust_bill_pay->by_key($billpaynum) + or die "broken payment application $billpaynum"; + my @subapps = $cust_bill_pay->lineitem_applications; + $error = $cust_bill_pay->delete; # can't replace + + my $new_cust_bill_pay = FS::cust_bill_pay->new({ + $cust_bill_pay->hash, + billpaynum => '', + amount => sprintf('%.2f', + $cust_bill_pay->amount + - $unapplied_payments{$invnum}{$billpaynum}), + }); + + if ( $new_cust_bill_pay->amount > 0 ) { + $error ||= $new_cust_bill_pay->insert; + # Also reapply it to everything it was applied to before. + # Note that we've already deleted cust_bill_pay_pkg records for the + # items we're crediting, so they aren't on this list. + foreach my $cust_bill_pay_pkg (@subapps) { + $cust_bill_pay_pkg->billpaypkgnum(''); + $cust_bill_pay_pkg->billpaynum($new_cust_bill_pay->billpaynum); + $error ||= $cust_bill_pay_pkg->insert; + } + } + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "Error unapplying payment: $error"; + } + } + #insert cust_credit_bill + + my $cust_credit_bill = new FS::cust_credit_bill { + 'crednum' => $cust_credit->crednum, + 'invnum' => $invnum, + 'amount' => sprintf('%.2f', $cust_credit_bill{$invnum}), + }; + $error = $cust_credit_bill->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "Error applying credit of $cust_credit_bill{$invnum} ". + " to invoice $invnum: $error"; + } + + #and then insert cust_credit_bill_pkg for each cust_bill_pkg + foreach my $cust_credit_bill_pkg ( @{$cust_credit_bill_pkg{$invnum}} ) { + $cust_credit_bill_pkg->creditbillnum( $cust_credit_bill->creditbillnum ); + $error = $cust_credit_bill_pkg->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "Error applying credit to line item: $error"; + } + } + + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + ''; + +} + +=back + +=head1 SUBROUTINES + +=over 4 + +=item process_batch_import + +=cut + +use List::Util qw( min ); +use FS::cust_bill; +use FS::cust_credit_bill; +sub process_batch_import { + my $job = shift; + + my $opt = { 'table' => 'cust_credit', + 'params' => [ '_date', 'credbatch' ], + 'formats' => { 'simple' => + [ 'custnum', 'amount', 'reasonnum', 'invnum' ], + }, + 'default_csv' => 1, + 'postinsert_callback' => sub { + my $cust_credit = shift; #my ($cust_credit, $param ) = @_; + + if ( $cust_credit->invnum ) { + + my $cust_bill = qsearchs('cust_bill', { invnum=>$cust_credit->invnum } ); + my $amount = min( $cust_credit->credited, $cust_bill->owed ); + + my $cust_credit_bill = new FS::cust_credit_bill ( { + 'crednum' => $cust_credit->crednum, + 'invnum' => $cust_bill->invnum, + 'amount' => $amount, + } ); + my $error = $cust_credit_bill->insert; + return '' unless $error; + + } + + #apply_payments_and_credits ? + $cust_credit->cust_main->apply_credits; + + return ''; + + }, + }; + + FS::Record::process_batch_import( $job, $opt, @_ ); + +} =back @@ -318,6 +1059,9 @@ sub cust_main { The delete method. The replace method. +B and B are now called B and +B. The old method names should start to give warnings. + =head1 SEE ALSO L, L, L,