1 package FS::cust_credit;
2 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::reason_Mixin
6 use vars qw( $conf $unsuspendauto $me $DEBUG
7 $otaker_upgrade_kludge $ignore_empty_reasonnum
9 use List::Util qw( min );
11 use FS::UID qw( dbh );
12 use FS::Misc qw(send_email);
13 use FS::Record qw( qsearch qsearchs dbdef );
17 use FS::cust_credit_bill;
24 use FS::cust_credit_void;
25 use FS::cust_bill_pkg;
26 use FS::upgrade_journal;
28 $me = '[ FS::cust_credit ]';
31 $otaker_upgrade_kludge = 0;
32 $ignore_empty_reasonnum = 0;
34 #ask FS::UID to run this stuff for us later
35 $FS::UID::callback{'FS::cust_credit'} = sub {
38 $unsuspendauto = $conf->exists('unsuspendauto');
42 our %reasontype_map = ( 'referral_credit_type' => 'Referral Credit',
43 'cancel_credit_type' => 'Cancellation Credit',
44 'signup_credit_type' => 'Self-Service Credit',
49 FS::cust_credit - Object methods for cust_credit records
55 $record = new FS::cust_credit \%hash;
56 $record = new FS::cust_credit { 'column' => 'value' };
58 $error = $record->insert;
60 $error = $new_record->replace($old_record);
62 $error = $record->delete;
64 $error = $record->check;
68 An FS::cust_credit object represents a credit; the equivalent of a negative
69 B<cust_bill> record (see L<FS::cust_bill>). FS::cust_credit inherits from
70 FS::Record. The following fields are currently supported:
76 Primary key (assigned automatically for new credits)
80 Customer (see L<FS::cust_main>)
88 Specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
89 L<Time::Local> and L<Date::Parse> for conversion functions.
93 Order taker (see L<FS::access_user>)
101 Reason (see L<FS::reason>)
109 Books closed flag, empty or `Y'
113 Desired pkgnum when using experimental package balances.
123 Creates a new credit. To add the credit to the database, see L<"insert">.
127 sub table { 'cust_credit'; }
128 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
129 sub cust_unlinked_msg {
131 "WARNING: can't find cust_main.custnum ". $self->custnum.
132 ' (cust_credit.crednum '. $self->crednum. ')';
135 =item insert [ OPTION => VALUE ... ]
137 Adds this credit to the database ("Posts" the credit). If there is an error,
138 returns the error, otherwise returns false.
140 Ooptions are passed as a list of keys and values. Available options:
146 L<FS::reason_type|Reason> type for newly-inserted reason
148 =item cust_credit_source_bill_pkg
151 L<FS::cust_credit_source_bill_pkg|FS::cust_credit_source_bilL_pkg> objects.
152 They will have their crednum set and will be inserted along with this credit.
159 my ($self, %options) = @_;
161 local $SIG{HUP} = 'IGNORE';
162 local $SIG{INT} = 'IGNORE';
163 local $SIG{QUIT} = 'IGNORE';
164 local $SIG{TERM} = 'IGNORE';
165 local $SIG{TSTP} = 'IGNORE';
166 local $SIG{PIPE} = 'IGNORE';
168 my $oldAutoCommit = $FS::UID::AutoCommit;
169 local $FS::UID::AutoCommit = 0;
172 my $cust_main = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
173 my $old_balance = $cust_main->balance;
175 if (!$self->reasonnum) {
176 my $reason_text = $self->get('reason')
177 or return "reason text or existing reason required";
178 my $reason_type = $options{'reason_type'}
179 or return "reason type required";
182 my $reason = FS::reason->new_or_existing(
183 reason => $reason_text,
184 type => $reason_type,
188 $dbh->rollback if $oldAutoCommit;
189 return "failed to set credit reason: $@";
191 $self->set('reasonnum', $reason->reasonnum);
194 $self->setfield('reason', '');
196 my $error = $self->SUPER::insert;
198 $dbh->rollback if $oldAutoCommit;
199 return "error inserting $self: $error";
202 if ( $options{'cust_credit_source_bill_pkg'} ) {
203 foreach my $ccsbr ( @{ $options{'cust_credit_source_bill_pkg'} } ) {
204 $ccsbr->crednum( $self->crednum );
205 $error = $ccsbr->insert;
207 $dbh->rollback if $oldAutoCommit;
208 return "error inserting $ccsbr: $error";
213 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
215 #false laziness w/ cust_pay::insert
216 if ( $unsuspendauto && $old_balance && $cust_main->balance <= 0 ) {
217 my @errors = $cust_main->unsuspend;
219 # side-fx with nested transactions? upstack rolls back?
220 warn "WARNING:Errors unsuspending customer ". $cust_main->custnum. ": ".
226 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
234 Unless the closed flag is set, deletes this credit and all associated
235 applications (see L<FS::cust_credit_bill>). In most cases, you want to use
236 the void method instead to leave a record of the deleted credit.
240 # very similar to FS::cust_pay::delete
245 return "Can't delete closed credit" if $self->closed =~ /^Y/i;
247 local $SIG{HUP} = 'IGNORE';
248 local $SIG{INT} = 'IGNORE';
249 local $SIG{QUIT} = 'IGNORE';
250 local $SIG{TERM} = 'IGNORE';
251 local $SIG{TSTP} = 'IGNORE';
252 local $SIG{PIPE} = 'IGNORE';
254 my $oldAutoCommit = $FS::UID::AutoCommit;
255 local $FS::UID::AutoCommit = 0;
258 foreach my $cust_credit_bill ( $self->cust_credit_bill ) {
259 my $error = $cust_credit_bill->delete;
261 $dbh->rollback if $oldAutoCommit;
266 foreach my $cust_credit_refund ( $self->cust_credit_refund ) {
267 my $error = $cust_credit_refund->delete;
269 $dbh->rollback if $oldAutoCommit;
274 my $error = $self->SUPER::delete(@_);
276 $dbh->rollback if $oldAutoCommit;
280 if ( !$opt{void} and $conf->config('deletecredits') ne '' ) {
282 my $cust_main = $self->cust_main;
284 my $error = send_email(
285 'from' => $conf->invoice_from_full($self->cust_main->agentnum),
286 #invoice_from??? well as good as any
287 'to' => $conf->config('deletecredits'),
288 'subject' => 'FREESIDE NOTIFICATION: Credit deleted',
290 "This is an automatic message from your Freeside installation\n",
291 "informing you that the following credit has been deleted:\n",
293 'crednum: '. $self->crednum. "\n",
294 'custnum: '. $self->custnum.
295 " (". $cust_main->last. ", ". $cust_main->first. ")\n",
296 'amount: $'. sprintf("%.2f", $self->amount). "\n",
297 'date: '. time2str("%a %b %e %T %Y", $self->_date). "\n",
298 'reason: '. $self->reason. "\n",
303 $dbh->rollback if $oldAutoCommit;
304 return "can't send credit deletion notification: $error";
309 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
315 =item replace [ OLD_RECORD ]
317 You can, but probably shouldn't modify credits...
319 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
320 supplied, replaces this record. If there is an error, returns the error,
321 otherwise returns false.
327 return "Can't modify closed credit" if $self->closed =~ /^Y/i;
328 $self->SUPER::replace(@_);
333 Checks all fields to make sure this is a valid credit. If there is an error,
334 returns the error, otherwise returns false. Called by the insert and replace
342 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
345 $self->ut_numbern('crednum')
346 || $self->ut_number('custnum')
347 || $self->ut_numbern('_date')
348 || $self->ut_money('amount')
349 || $self->ut_alphan('otaker')
350 || $self->ut_textn('reason')
351 || $self->ut_textn('addlinfo')
352 || $self->ut_enum('closed', [ '', 'Y' ])
353 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
354 || $self->ut_foreign_keyn('eventnum', 'cust_event', 'eventnum')
355 || $self->ut_foreign_keyn('commission_agentnum', 'agent', 'agentnum')
356 || $self->ut_foreign_keyn('commission_salesnum', 'sales', 'salesnum')
357 || $self->ut_foreign_keyn('commission_pkgnum', 'cust_pkg', 'pkgnum')
359 return $error if $error;
361 my $method = $ignore_empty_reasonnum ? 'ut_foreign_keyn' : 'ut_foreign_key';
362 $error = $self->$method('reasonnum', 'reason', 'reasonnum');
363 return $error if $error;
365 return "amount must be > 0 " if $self->amount <= 0;
367 return "amount must be greater or equal to amount applied"
368 if $self->unapplied < 0 && ! $otaker_upgrade_kludge;
370 return "Unknown customer"
371 unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
373 $self->_date(time) unless $self->_date;
378 =item void [ REASON ]
380 Voids this credit: deletes the credit and all associated applications and
381 adds a record of the voided credit to the cust_credit_void table.
389 unless (ref($reason) || !$reason) {
390 $reason = FS::reason->new_or_existing(
392 'type' => 'Void credit',
397 local $SIG{HUP} = 'IGNORE';
398 local $SIG{INT} = 'IGNORE';
399 local $SIG{QUIT} = 'IGNORE';
400 local $SIG{TERM} = 'IGNORE';
401 local $SIG{TSTP} = 'IGNORE';
402 local $SIG{PIPE} = 'IGNORE';
404 my $oldAutoCommit = $FS::UID::AutoCommit;
405 local $FS::UID::AutoCommit = 0;
408 my $cust_credit_void = new FS::cust_credit_void ( {
409 map { $_ => $self->get($_) } $self->fields
411 $cust_credit_void->set('void_reasonnum', $reason->reasonnum);
412 my $error = $cust_credit_void->insert;
414 $dbh->rollback if $oldAutoCommit;
418 $error = $self->delete(void => 1); # suppress deletecredits warning
420 $dbh->rollback if $oldAutoCommit;
424 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
430 =item cust_credit_refund
432 Returns all refund applications (see L<FS::cust_credit_refund>) for this credit.
436 sub cust_credit_refund {
438 map { $_ } #return $self->num_cust_credit_refund unless wantarray;
439 sort { $a->_date <=> $b->_date }
440 qsearch( 'cust_credit_refund', { 'crednum' => $self->crednum } )
444 =item cust_credit_bill
446 Returns all application to invoices (see L<FS::cust_credit_bill>) for this
451 sub cust_credit_bill {
453 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
454 sort { $a->_date <=> $b->_date }
455 qsearch( 'cust_credit_bill', { 'crednum' => $self->crednum } )
461 Returns the amount of this credit that is still unapplied/outstanding;
462 amount minus all refund applications (see L<FS::cust_credit_refund>) and
463 applications to invoices (see L<FS::cust_credit_bill>).
469 my $amount = $self->amount;
470 $amount -= $_->amount foreach ( $self->cust_credit_refund );
471 $amount -= $_->amount foreach ( $self->cust_credit_bill );
472 sprintf( "%.2f", $amount );
477 Deprecated name for the unapplied method.
483 #carp "cust_credit->credited deprecated; use ->unapplied";
484 $self->unapplied(@_);
489 Returns the customer (see L<FS::cust_main>) for this credit.
495 # Used by FS::Upgrade to migrate to a new database.
497 sub _upgrade_data { # class method
498 my ($class, %opts) = @_;
500 warn "$me upgrading $class\n" if $DEBUG;
502 $class->_upgrade_reasonnum(%opts);
504 if (defined dbdef->table($class->table)->column('reason')) {
506 warn "$me Ensuring existance of auto reasons\n" if $DEBUG;
508 foreach ( keys %reasontype_map ) {
509 unless ($conf->config($_)) { # hmmmm
510 # warn "$me Found $_ reason type lacking\n" if $DEBUG;
511 # my $hashref = { 'class' => 'R', 'type' => $reasontype_map{$_} };
512 my $hashref = { 'class' => 'R', 'type' => 'Legacy' };
513 my $reason_type = qsearchs( 'reason_type', $hashref );
514 unless ($reason_type) {
515 $reason_type = new FS::reason_type( $hashref );
516 my $error = $reason_type->insert();
517 die "$class had error inserting FS::reason_type into database: $error\n"
520 $conf->set($_, $reason_type->typenum);
524 warn "$me Ensuring commission packages have a reason type\n" if $DEBUG;
526 my $hashref = { 'class' => 'R', 'type' => 'Legacy' };
527 my $reason_type = qsearchs( 'reason_type', $hashref );
528 unless ($reason_type) {
529 $reason_type = new FS::reason_type( $hashref );
530 my $error = $reason_type->insert();
531 die "$class had error inserting FS::reason_type into database: $error\n"
535 my @plans = qw( flat_comission flat_comission_cust flat_comission_pkg );
536 foreach my $plan ( @plans ) {
537 foreach my $pkg ( qsearch('part_pkg', { 'plan' => $plan } ) ) {
538 unless ($pkg->option('reason_type', 1) ) {
539 my $plandata = $pkg->plandata.
540 "reason_type=". $reason_type->typenum. "\n";
541 $pkg->plandata($plandata);
543 $pkg->replace( undef,
544 'pkg_svc' => { map { $_->svcpart => $_->quantity }
547 'primary_svc' => $pkg->svcpart,
549 die "failed setting reason_type option: $error"
556 local($otaker_upgrade_kludge) = 1;
557 local($ignore_empty_reasonnum) = 1;
558 $class->_upgrade_otaker(%opts);
560 if ( !FS::upgrade_journal->is_done('cust_credit__tax_link')
561 and !$conf->exists('enable_taxproducts') ) {
562 # RT#25458: fix credit line item applications that should refer to a
563 # specific tax allocation
564 my @cust_credit_bill_pkg = qsearch({
565 table => 'cust_credit_bill_pkg',
566 select => 'cust_credit_bill_pkg.*',
567 addl_from => ' LEFT JOIN cust_bill_pkg USING (billpkgnum)',
569 'WHERE cust_credit_bill_pkg.billpkgtaxlocationnum IS NULL '.
570 'AND cust_bill_pkg.pkgnum = 0', # is a tax
574 foreach (@cust_credit_bill_pkg) {
575 my $billpkgnum = $_->billpkgnum;
576 $tax_items{$billpkgnum} ||= FS::cust_bill_pkg->by_key($billpkgnum);
577 $credits{$billpkgnum} ||= [];
578 push @{ $credits{$billpkgnum} }, $_;
580 TAX_ITEM: foreach my $tax_item (values %tax_items) {
581 my $billpkgnum = $tax_item->billpkgnum;
582 # get all pkg/location/taxrate allocations of this tax line item
583 my @allocations = sort {$b->amount <=> $a->amount}
584 qsearch('cust_bill_pkg_tax_location', {
585 billpkgnum => $billpkgnum
587 # and these are all credit applications to it
588 my @credits = sort {$b->amount <=> $a->amount}
589 @{ $credits{$billpkgnum} };
590 my $c = shift @credits;
591 my $a = shift @allocations; # we will NOT modify these
593 if ( abs($c->amount - $a->amount) < 0.005 ) {
594 # by far the most common case: the tax line item is for a single
595 # tax, so we just fill in the billpkgtaxlocationnum
596 $c->set('billpkgtaxlocationnum', $a->billpkgtaxlocationnum);
597 my $error = $c->replace;
599 warn "error fixing credit application to tax item #$billpkgnum:\n$error\n";
603 $a = shift @allocations;
604 } elsif ( $c->amount > $a->amount ) {
605 # fairly common: the tax line contains tax for multiple packages
606 # (or multiple taxes) but the credit isn't divided up
607 my $new_link = FS::cust_credit_bill_pkg->new({
608 creditbillnum => $c->creditbillnum,
609 billpkgnum => $c->billpkgnum,
610 billpkgtaxlocationnum => $a->billpkgtaxlocationnum,
611 amount => $a->amount,
612 setuprecur => 'setup',
614 my $error = $new_link->insert;
616 warn "error fixing credit application to tax item #$billpkgnum:\n$error\n";
619 $c->set(amount => sprintf('%.2f', $c->amount - $a->amount));
620 $a = shift @allocations;
621 } elsif ( $c->amount < 0.005 ) {
622 # also fairly common; we can delete these with no harm
623 my $error = $c->delete;
624 warn "error removing zero-amount credit application (probably harmless):\n$error\n" if $error;
626 } elsif ( $c->amount < $a->amount ) {
627 # should never happen, but if it does, handle it gracefully
628 $c->set('billpkgtaxlocationnum', $a->billpkgtaxlocationnum);
629 my $error = $c->replace;
631 warn "error fixing credit application to tax item #$billpkgnum:\n$error\n";
634 $a->set(amount => $a->amount - $c->amount);
639 if ( $c->amount < 0.005 ) {
640 my $error = $c->delete;
641 warn "error removing zero-amount credit application (probably harmless):\n$error\n" if $error;
642 } elsif ( $c->modified ) {
643 # then we've allocated part of it, so reduce the nonspecific
644 # application by that much
645 my $error = $c->replace;
646 warn "error fixing credit application to tax item #$billpkgnum:\n$error\n" if $error;
648 # else there are probably no allocations, i.e. this is a pre-3.x
649 # record that was never migrated over, so leave it alone
651 } # foreach $tax_item
652 FS::upgrade_journal->set_done('cust_credit__tax_link');
664 Returns an SQL fragment to retreive the unapplied amount.
669 my ($class, $start, $end) = @_;
671 my $bill_start = $start ? "AND cust_credit_bill._date <= $start" : '';
672 my $bill_end = $end ? "AND cust_credit_bill._date > $end" : '';
673 my $refund_start = $start ? "AND cust_credit_refund._date <= $start" : '';
674 my $refund_end = $end ? "AND cust_credit_refund._date > $end" : '';
678 ( SELECT SUM(amount) FROM cust_credit_refund
679 WHERE cust_credit.crednum = cust_credit_refund.crednum
680 $refund_start $refund_end )
684 ( SELECT SUM(amount) FROM cust_credit_bill
685 WHERE cust_credit.crednum = cust_credit_bill.crednum
686 $bill_start $bill_end )
695 Deprecated name for the unapplied_sql method.
702 #carp "cust_credit->credited_sql deprecated; use ->unapplied_sql";
704 #$class->unapplied_sql(@_);
708 =item credit_lineitems
712 my $error = FS::cust_credit->credit_lineitems(
714 #the lineitems to credit
715 'billpkgnums' => \@billpkgnums,
716 'setuprecurs' => \@setuprecurs,
717 'amounts' => \@amounts,
718 'apply' => 1, #0 leaves the credit unapplied
721 map { $_ => scalar($cgi->param($_)) }
722 #fields('cust_credit')
723 qw( custnum _date amount reasonnum addlinfo ), #pkgnum eventnum
729 #maybe i should just be an insert with extra args instead of a class method
730 sub credit_lineitems {
731 my( $class, %arg ) = @_;
732 my $curuser = $FS::CurrentUser::CurrentUser;
734 #some false laziness w/misc/xmlhttp-cust_bill_pkg-calculate_taxes.html
736 my $cust_main = qsearchs({
737 'table' => 'cust_main',
738 'hashref' => { 'custnum' => $arg{custnum} },
739 'extra_sql' => ' AND '. $curuser->agentnums_sql,
740 }) or return 'unknown customer';
743 local $SIG{HUP} = 'IGNORE';
744 local $SIG{INT} = 'IGNORE';
745 local $SIG{QUIT} = 'IGNORE';
746 local $SIG{TERM} = 'IGNORE';
747 local $SIG{TSTP} = 'IGNORE';
748 local $SIG{PIPE} = 'IGNORE';
750 my $oldAutoCommit = $FS::UID::AutoCommit;
751 local $FS::UID::AutoCommit = 0;
754 #my @cust_bill_pkg = qsearch({
755 # 'select' => 'cust_bill_pkg.*',
756 # 'table' => 'cust_bill_pkg',
757 # 'addl_from' => ' LEFT JOIN cust_bill USING (invnum) '.
758 # ' LEFT JOIN cust_main USING (custnum) ',
759 # 'extra_sql' => ' WHERE custnum = $custnum AND billpkgnum IN ('.
760 # join( ',', @{$arg{billpkgnums}} ). ')',
761 # 'order_by' => 'ORDER BY invnum ASC, billpkgnum ASC',
766 my $cust_credit = new FS::cust_credit ( {
767 map { $_ => $arg{$_} }
768 #fields('cust_credit')
769 qw( custnum _date amount reasonnum addlinfo ), #pkgnum eventnum
771 $error = $cust_credit->insert;
773 $dbh->rollback if $oldAutoCommit;
774 return "Error inserting credit: $error";
777 unless ( $arg{'apply'} ) {
778 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
783 # keys in all of these are invoice numbers
784 my %cust_credit_bill = ();
785 my %cust_bill_pkg = ();
786 my %cust_credit_bill_pkg = ();
787 my %taxlisthash = ();
788 my %unapplied_payments = (); #invoice numbers, and then billpaynums
789 foreach my $billpkgnum ( @{$arg{billpkgnums}} ) {
790 my $setuprecur = shift @{$arg{setuprecurs}};
791 my $amount = shift @{$arg{amounts}};
793 my $cust_bill_pkg = qsearchs({
794 'table' => 'cust_bill_pkg',
795 'hashref' => { 'billpkgnum' => $billpkgnum },
796 'addl_from' => 'LEFT JOIN cust_bill USING (invnum)',
797 'extra_sql' => 'AND custnum = '. $cust_main->custnum,
798 }) or die "unknown billpkgnum $billpkgnum";
800 my $invnum = $cust_bill_pkg->invnum;
802 if ( $setuprecur eq 'setup' ) {
803 $cust_bill_pkg->setup($amount);
804 $cust_bill_pkg->recur(0);
805 $cust_bill_pkg->unitrecur(0);
806 $cust_bill_pkg->type('');
808 $setuprecur = 'recur'; #in case its a usage classnum?
809 $cust_bill_pkg->recur($amount);
810 $cust_bill_pkg->setup(0);
811 $cust_bill_pkg->unitsetup(0);
814 push @{$cust_bill_pkg{$invnum}}, $cust_bill_pkg;
816 #unapply any payments applied to this line item (other credits too?)
817 foreach my $cust_bill_pay_pkg ( $cust_bill_pkg->cust_bill_pay_pkg($setuprecur) ) {
818 $error = $cust_bill_pay_pkg->delete;
820 $dbh->rollback if $oldAutoCommit;
821 return "Error unapplying payment: $error";
823 $unapplied_payments{$invnum}{$cust_bill_pay_pkg->billpaynum}
824 += $cust_bill_pay_pkg->amount;
827 #$subtotal += $amount;
828 $cust_credit_bill{$invnum} += $amount;
829 push @{ $cust_credit_bill_pkg{$invnum} },
830 new FS::cust_credit_bill_pkg {
831 'billpkgnum' => $cust_bill_pkg->billpkgnum,
832 'amount' => sprintf('%.2f',$amount),
833 'setuprecur' => $setuprecur,
834 'sdate' => $cust_bill_pkg->sdate,
835 'edate' => $cust_bill_pkg->edate,
838 # recalculate taxes with new amounts
839 $taxlisthash{$invnum} ||= {};
840 if ( $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart ) {
841 $cust_main->_handle_taxes( $taxlisthash{$invnum}, $cust_bill_pkg );
842 } # otherwise the item itself is a tax, and assume the caller knows
847 # now loop through %cust_credit_bill and insert those
850 # (hack to prevent cust_credit_bill_pkg insertion)
851 local($FS::cust_bill_ApplicationCommon::skip_apply_to_lineitems_hack) = 1;
853 foreach my $invnum ( sort { $a <=> $b } keys %cust_credit_bill ) {
855 my $arrayref_or_error =
856 $cust_main->calculate_taxes(
857 $cust_bill_pkg{$invnum}, # list of taxable items that we're crediting
858 $taxlisthash{$invnum}, # list of tax-item bindings
859 $cust_bill_pkg{$invnum}->[0]->cust_bill->_date, # invoice time
862 unless ( ref( $arrayref_or_error ) ) {
863 $dbh->rollback if $oldAutoCommit;
864 return "Error calculating taxes: $arrayref_or_error";
867 my %tax_links; # {tax billpkgnum}{nontax billpkgnum}
870 foreach my $cust_bill_pkg ( @{ $cust_bill_pkg{$invnum} } ) {
871 my $billpkgnum = $cust_bill_pkg->billpkgnum;
872 my %hash = ( 'taxable_billpkgnum' => $billpkgnum );
873 # gather up existing tax links (we need their billpkgtaxlocationnums)
874 my @tax_links = qsearch('cust_bill_pkg_tax_location', \%hash),
875 qsearch('cust_bill_pkg_tax_rate_location', \%hash);
877 foreach ( @tax_links ) {
878 $tax_links{$_->billpkgnum} ||= {};
879 $tax_links{$_->billpkgnum}{$_->taxable_billpkgnum} = $_;
883 foreach my $taxline ( @$arrayref_or_error ) {
885 my $amount = $taxline->setup;
887 # find equivalent tax line item on the existing invoice
888 my $tax_item = qsearchs('cust_bill_pkg', {
891 'itemdesc' => $taxline->desc,
894 # or should we just exit if this happens?
895 $cust_credit->set('amount',
896 sprintf('%.2f', $cust_credit->get('amount') - $amount)
898 my $error = $cust_credit->replace;
900 $dbh->rollback if $oldAutoCommit;
901 return "error correcting credit for missing tax line: $error";
905 # but in the new era, we no longer have the problem of uniquely
906 # identifying the tax_Xlocation record. The billpkgnums of the
907 # tax and the taxed item are known.
909 ( @{ $taxline->get('cust_bill_pkg_tax_location') },
910 @{ $taxline->get('cust_bill_pkg_tax_rate_location') } )
912 # the existing tax_Xlocation object
914 $tax_links{$tax_item->billpkgnum}{$new_loc->taxable_cust_bill_pkg->billpkgnum};
916 next if !$old_loc; # apply the leftover amount nonspecifically
918 #support partial credits: use $amount if smaller
919 # (so just distribute to the first location? perhaps should
921 my $loc_amount = min( $amount, $new_loc->amount);
923 $amount -= $loc_amount;
925 $cust_credit_bill{$invnum} += $loc_amount;
926 push @{ $cust_credit_bill_pkg{$invnum} },
927 new FS::cust_credit_bill_pkg {
928 'billpkgnum' => $tax_item->billpkgnum,
929 'amount' => $loc_amount,
930 'setuprecur' => 'setup',
931 'billpkgtaxlocationnum' => $old_loc->billpkgtaxlocationnum,
932 'billpkgtaxratelocationnum' => $old_loc->billpkgtaxratelocationnum,
935 } #foreach my $new_loc
937 # we still have to deal with the possibility that the tax links don't
938 # cover the whole amount of tax because of an incomplete upgrade...
939 if ($amount > 0.005) {
940 $cust_credit_bill{$invnum} += $amount;
941 push @{ $cust_credit_bill_pkg{$invnum} },
942 new FS::cust_credit_bill_pkg {
943 'billpkgnum' => $tax_item->billpkgnum,
944 'amount' => sprintf('%.2f', $amount),
945 'setuprecur' => 'setup',
950 #unapply any payments applied to the tax
951 foreach my $cust_bill_pay_pkg
952 ( $tax_item->cust_bill_pay_pkg('setup') )
954 $error = $cust_bill_pay_pkg->delete;
956 $dbh->rollback if $oldAutoCommit;
957 return "Error unapplying payment: $error";
959 $unapplied_payments{$invnum}{$cust_bill_pay_pkg->billpaynum}
960 += $cust_bill_pay_pkg->amount;
964 # if we unapplied any payments from line items, also unapply that
965 # amount from the invoice
966 foreach my $billpaynum (keys %{$unapplied_payments{$invnum}}) {
967 my $cust_bill_pay = FS::cust_bill_pay->by_key($billpaynum)
968 or die "broken payment application $billpaynum";
969 my @subapps = $cust_bill_pay->lineitem_applications;
970 $error = $cust_bill_pay->delete; # can't replace
972 my $new_cust_bill_pay = FS::cust_bill_pay->new({
973 $cust_bill_pay->hash,
975 amount => sprintf('%.2f',
976 $cust_bill_pay->amount
977 - $unapplied_payments{$invnum}{$billpaynum}),
980 if ( $new_cust_bill_pay->amount > 0 ) {
981 $error ||= $new_cust_bill_pay->insert;
982 # Also reapply it to everything it was applied to before.
983 # Note that we've already deleted cust_bill_pay_pkg records for the
984 # items we're crediting, so they aren't on this list.
985 foreach my $cust_bill_pay_pkg (@subapps) {
986 $cust_bill_pay_pkg->billpaypkgnum('');
987 $cust_bill_pay_pkg->billpaynum($new_cust_bill_pay->billpaynum);
988 $error ||= $cust_bill_pay_pkg->insert;
992 $dbh->rollback if $oldAutoCommit;
993 return "Error unapplying payment: $error";
996 #insert cust_credit_bill
998 my $cust_credit_bill = new FS::cust_credit_bill {
999 'crednum' => $cust_credit->crednum,
1000 'invnum' => $invnum,
1001 'amount' => sprintf('%.2f', $cust_credit_bill{$invnum}),
1003 $error = $cust_credit_bill->insert;
1005 $dbh->rollback if $oldAutoCommit;
1006 return "Error applying credit of $cust_credit_bill{$invnum} ".
1007 " to invoice $invnum: $error";
1010 #and then insert cust_credit_bill_pkg for each cust_bill_pkg
1011 foreach my $cust_credit_bill_pkg ( @{$cust_credit_bill_pkg{$invnum}} ) {
1012 $cust_credit_bill_pkg->creditbillnum( $cust_credit_bill->creditbillnum );
1013 $error = $cust_credit_bill_pkg->insert;
1015 $dbh->rollback if $oldAutoCommit;
1016 return "Error applying credit to line item: $error";
1022 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1033 =item process_batch_import
1037 use List::Util qw( min );
1039 use FS::cust_credit_bill;
1040 sub process_batch_import {
1043 my $opt = { 'table' => 'cust_credit',
1044 'params' => [ '_date', 'credbatch' ],
1045 'formats' => { 'simple' =>
1046 [ 'custnum', 'amount', 'reasonnum', 'invnum' ],
1049 'postinsert_callback' => sub {
1050 my $cust_credit = shift; #my ($cust_credit, $param ) = @_;
1052 if ( $cust_credit->invnum ) {
1054 my $cust_bill = qsearchs('cust_bill', { invnum=>$cust_credit->invnum } );
1055 my $amount = min( $cust_credit->credited, $cust_bill->owed );
1057 my $cust_credit_bill = new FS::cust_credit_bill ( {
1058 'crednum' => $cust_credit->crednum,
1059 'invnum' => $cust_bill->invnum,
1060 'amount' => $amount,
1062 my $error = $cust_credit_bill->insert;
1063 return '' unless $error;
1067 #apply_payments_and_credits ?
1068 $cust_credit->cust_main->apply_credits;
1075 FS::Record::process_batch_import( $job, $opt, @_ );
1083 The delete method. The replace method.
1085 B<credited> and B<credited_sql> are now called B<unapplied> and
1086 B<unapplied_sql>. The old method names should start to give warnings.
1090 L<FS::Record>, L<FS::cust_credit_refund>, L<FS::cust_refund>,
1091 L<FS::cust_credit_bill> L<FS::cust_bill>, schema.html from the base