X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcust_credit.pm;h=f63d86f9919365a3e38bd061ec990cb039cdffe2;hp=ba279a26c2d74be3828b2e8d9edec8ea2ec95b75;hb=817c1ce0e1cbcfd1f684222c66f46dd13b2d6dd7;hpb=c6782ab85ea83e0c78d85b8975985aac9d467f9d diff --git a/FS/FS/cust_credit.pm b/FS/FS/cust_credit.pm index ba279a26c..f63d86f99 100644 --- a/FS/FS/cust_credit.pm +++ b/FS/FS/cust_credit.pm @@ -1,17 +1,17 @@ package FS::cust_credit; +use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::reason_Mixin + FS::Record ); use strict; -use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::Record ); 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::UID qw( dbh ); use FS::Misc qw(send_email); use FS::Record qw( qsearch qsearchs dbdef ); use FS::CurrentUser; -use FS::cust_main; use FS::cust_pkg; use FS::cust_refund; use FS::cust_credit_bill; @@ -19,6 +19,11 @@ 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::cust_bill_pkg; +use FS::upgrade_journal; $me = '[ FS::cust_credit ]'; $DEBUG = 0; @@ -120,18 +125,34 @@ 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; } +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 +=item insert [ OPTION => VALUE ... ] Adds this credit to the database ("Posts" the credit). If there is an error, returns the error, otherwise returns false. +Ooptions are passed as a list of keys and values. Available options: + +=over 4 + +=item reason_type + +L type for newly-inserted reason + +=item cust_credit_source_bill_pkg + +An arrayref of +L objects. +They will have their crednum set and will be inserted along with this credit. + +=back + =cut sub insert { @@ -151,16 +172,23 @@ 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) { + if (!$self->reasonnum) { + my $reason_text = $self->get('reason') + or return "reason text or existing reason required"; + my $reason_type = $options{'reason_type'} + or return "reason type required"; + + local $@; + my $reason = FS::reason->new_or_existing( + reason => $reason_text, + type => $reason_type, + class => 'R', + ); + if ($@) { $dbh->rollback if $oldAutoCommit; - return "failed to set reason for $me"; #: ". $dbh->errstr; + return "failed to set credit reason: $@"; } + $self->set('reasonnum', $reason->reasonnum); } $self->setfield('reason', ''); @@ -171,6 +199,17 @@ sub insert { return "error inserting $self: $error"; } + if ( $options{'cust_credit_source_bill_pkg'} ) { + foreach my $ccsbr ( @{ $options{'cust_credit_source_bill_pkg'} } ) { + $ccsbr->crednum( $self->crednum ); + $error = $ccsbr->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting $ccsbr: $error"; + } + } + } + $dbh->commit or die $dbh->errstr if $oldAutoCommit; #false laziness w/ cust_pay::insert @@ -201,6 +240,8 @@ the void method instead to leave a record of the deleted credit. # 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'; @@ -236,12 +277,12 @@ sub delete { return $error; } - if ( $conf->config('deletecredits') ne '' ) { + if ( !$opt{void} and $conf->config('deletecredits') ne '' ) { my $cust_main = $self->cust_main; my $error = send_email( - 'from' => $conf->config('invoice_from', $self->cust_main->agentnum), + 'from' => $conf->invoice_from_full($self->cust_main->agentnum), #invoice_from??? well as good as any 'to' => $conf->config('deletecredits'), 'subject' => 'FREESIDE NOTIFICATION: Credit deleted', @@ -311,6 +352,9 @@ sub check { || $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; @@ -331,6 +375,58 @@ sub check { $self->SUPER::check; } +=item void [ REASON ] + +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 void { + my $self = shift; + my $reason = shift; + + unless (ref($reason) || !$reason) { + $reason = FS::reason->new_or_existing( + 'class' => 'X', + 'type' => 'Void credit', + 'reason' => $reason + ); + } + + 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_reasonnum', $reason->reasonnum); + 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 Returns all refund applications (see L) for this credit. @@ -394,63 +490,6 @@ Returns the customer (see L) for this credit. =cut -sub cust_main { - my $self = shift; - qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); -} - - -=item reason - -Returns the text of the associated reason (see L) for this credit. - -=cut - -sub reason { - my ($self, $value, %options) = @_; - my $dbh = dbh; - my $reason; - my $typenum = $options{'reason_type'}; - - my $oldAutoCommit = $FS::UID::AutoCommit; # this should already be in - local $FS::UID::AutoCommit = 0; # a transaction if it matters - - if ( defined( $value ) ) { - my $hashref = { 'reason' => $value }; - $hashref->{'reason_type'} = $typenum if $typenum; - my $addl_from = "LEFT JOIN reason_type ON ( reason_type = typenum ) "; - my $extra_sql = " AND reason_type.class='R'"; - - $reason = qsearchs( { 'table' => 'reason', - 'hashref' => $hashref, - 'addl_from' => $addl_from, - 'extra_sql' => $extra_sql, - } ); - - if (!$reason && $typenum) { - $reason = new FS::reason( { 'reason_type' => $typenum, - 'reason' => $value, - 'disabled' => 'Y', - } ); - my $error = $reason->insert; - if ( $error ) { - warn "error inserting reason: $error\n"; - $reason = undef; - } - } - - $self->reasonnum($reason ? $reason->reasonnum : '') ; - warn "$me reason used in set mode with non-existant reason -- clearing" - unless $reason; - } - $reason = qsearchs( 'reason', { 'reasonnum' => $self->reasonnum } ); - - $dbh->commit or die $dbh->errstr if $oldAutoCommit; - - ( $reason ? $reason->reason : '' ). - ( $self->addlinfo ? ' '.$self->addlinfo : '' ); -} - # _upgrade_data # # Used by FS::Upgrade to migrate to a new database. @@ -460,56 +499,9 @@ sub _upgrade_data { # class method warn "$me upgrading $class\n" if $DEBUG; - if (defined dbdef->table($class->table)->column('reason')) { - - warn "$me Checking for unmigrated reasons\n" if $DEBUG; - - my @cust_credits = qsearch({ 'table' => $class->table, - 'hashref' => {}, - 'extra_sql' => 'WHERE reason IS NOT NULL', - }); - - if (scalar(grep { $_->getfield('reason') =~ /\S/ } @cust_credits)) { - warn "$me Found unmigrated reasons\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; - } - - $hashref = { 'reason_type' => $reason_type->typenum, - 'reason' => '(none)' - }; - my $noreason = qsearchs( 'reason', $hashref ); - unless ($noreason) { - $hashref->{'disabled'} = 'Y'; - $noreason = new FS::reason( $hashref ); - my $error = $noreason->insert(); - die "can't insert legacy reason '(none)' into database: $error\n" - if $error; - } - - foreach my $cust_credit ( @cust_credits ) { - my $reason = $cust_credit->getfield('reason'); - warn "Contemplating reason $reason\n" if $DEBUG > 1; - if ($reason =~ /\S/) { - $cust_credit->reason($reason, 'reason_type' => $reason_type->typenum) - or die "can't insert legacy reason $reason into database\n"; - }else{ - $cust_credit->reasonnum($noreason->reasonnum); - } - - $cust_credit->setfield('reason', ''); - my $error = $cust_credit->replace; + $class->_upgrade_reasonnum(%opts); - warn "*** WARNING: error replacing reason in $class ". - $cust_credit->crednum. ": $error ***\n" - if $error; - } - } + if (defined dbdef->table($class->table)->column('reason')) { warn "$me Ensuring existance of auto reasons\n" if $DEBUG; @@ -565,6 +557,100 @@ sub _upgrade_data { # class method local($ignore_empty_reasonnum) = 1; $class->_upgrade_otaker(%opts); + if ( !FS::upgrade_journal->is_done('cust_credit__tax_link') + and !$conf->config('tax_data_vendor') ) { + # 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 @@ -632,18 +718,15 @@ Example: '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 + qw( custnum _date amount 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; @@ -679,26 +762,11 @@ sub credit_lineitems { #}); 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 + qw( custnum _date amount reasonnum addlinfo ), #pkgnum eventnum } ); $error = $cust_credit->insert; if ( $error ) { @@ -769,14 +837,10 @@ sub credit_lineitems { # recalculate taxes with new amounts $taxlisthash{$invnum} ||= {}; - my $part_pkg = $cust_bill_pkg->part_pkg; - $cust_main->_handle_taxes( $part_pkg, - $taxlisthash{$invnum}, - $cust_bill_pkg, - $cust_bill_pkg->cust_pkg, - $cust_bill_pkg->cust_bill->_date, #invoice time - $cust_bill_pkg->cust_pkg->pkgpart, - ); + if ( $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart ) { + $cust_main->_handle_taxes( $taxlisthash{$invnum}, $cust_bill_pkg ); + } # otherwise the item itself is a tax, and assume the caller knows + # what they're doing } ### @@ -788,16 +852,16 @@ sub credit_lineitems { foreach my $invnum ( sort { $a <=> $b } keys %cust_credit_bill ) { - my $arrayref_or_error = - $cust_main->calculate_taxes( + local $@; + my $arrayref_or_error = eval { $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 ) ) { + if ( $@ ) { $dbh->rollback if $oldAutoCommit; - return "Error calculating taxes: $arrayref_or_error"; + return "Error calculating taxes: $@"; } my %tax_links; # {tax billpkgnum}{nontax billpkgnum} @@ -847,7 +911,7 @@ sub credit_lineitems { { # the existing tax_Xlocation object my $old_loc = - $tax_links{$tax_item->billpkgnum}{$new_loc->taxable_billpkgnum}; + $tax_links{$tax_item->billpkgnum}{$new_loc->taxable_cust_bill_pkg->billpkgnum}; next if !$old_loc; # apply the leftover amount nonspecifically @@ -872,12 +936,12 @@ sub credit_lineitems { # 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) { + 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' => $amount, + 'amount' => sprintf('%.2f', $amount), 'setuprecur' => 'setup', }; @@ -962,6 +1026,58 @@ sub credit_lineitems { =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 + =head1 BUGS The delete method. The replace method.