1 package FS::cust_credit;
4 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::Record );
5 use vars qw( $conf $unsuspendauto $me $DEBUG
6 $otaker_upgrade_kludge $ignore_empty_reasonnum
9 use FS::UID qw( dbh getotaker );
10 use FS::Misc qw(send_email);
11 use FS::Record qw( qsearch qsearchs dbdef );
16 use FS::cust_credit_bill;
22 $me = '[ FS::cust_credit ]';
25 $otaker_upgrade_kludge = 0;
26 $ignore_empty_reasonnum = 0;
28 #ask FS::UID to run this stuff for us later
29 $FS::UID::callback{'FS::cust_credit'} = sub {
32 $unsuspendauto = $conf->exists('unsuspendauto');
36 our %reasontype_map = ( 'referral_credit_type' => 'Referral Credit',
37 'cancel_credit_type' => 'Cancellation Credit',
38 'signup_credit_type' => 'Self-Service Credit',
43 FS::cust_credit - Object methods for cust_credit records
49 $record = new FS::cust_credit \%hash;
50 $record = new FS::cust_credit { 'column' => 'value' };
52 $error = $record->insert;
54 $error = $new_record->replace($old_record);
56 $error = $record->delete;
58 $error = $record->check;
62 An FS::cust_credit object represents a credit; the equivalent of a negative
63 B<cust_bill> record (see L<FS::cust_bill>). FS::cust_credit inherits from
64 FS::Record. The following fields are currently supported:
70 Primary key (assigned automatically for new credits)
74 Customer (see L<FS::cust_main>)
82 Specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
83 L<Time::Local> and L<Date::Parse> for conversion functions.
87 Order taker (see L<FS::access_user>)
95 Reason (see L<FS::reason>)
103 Books closed flag, empty or `Y'
107 Desired pkgnum when using experimental package balances.
117 Creates a new credit. To add the credit to the database, see L<"insert">.
121 sub table { 'cust_credit'; }
122 sub cust_linked { $_[0]->cust_main_custnum; }
123 sub cust_unlinked_msg {
125 "WARNING: can't find cust_main.custnum ". $self->custnum.
126 ' (cust_credit.crednum '. $self->crednum. ')';
131 Adds this credit to the database ("Posts" the credit). If there is an error,
132 returns the error, otherwise returns false.
137 my ($self, %options) = @_;
139 local $SIG{HUP} = 'IGNORE';
140 local $SIG{INT} = 'IGNORE';
141 local $SIG{QUIT} = 'IGNORE';
142 local $SIG{TERM} = 'IGNORE';
143 local $SIG{TSTP} = 'IGNORE';
144 local $SIG{PIPE} = 'IGNORE';
146 my $oldAutoCommit = $FS::UID::AutoCommit;
147 local $FS::UID::AutoCommit = 0;
150 my $cust_main = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
151 my $old_balance = $cust_main->balance;
153 unless ($self->reasonnum) {
154 my $result = $self->reason( $self->getfield('reason'),
155 exists($options{ 'reason_type' })
156 ? ('reason_type' => $options{ 'reason_type' })
160 $dbh->rollback if $oldAutoCommit;
161 return "failed to set reason for $me"; #: ". $dbh->errstr;
165 $self->setfield('reason', '');
167 my $error = $self->SUPER::insert;
169 $dbh->rollback if $oldAutoCommit;
170 return "error inserting $self: $error";
173 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
175 #false laziness w/ cust_pay::insert
176 if ( $unsuspendauto && $old_balance && $cust_main->balance <= 0 ) {
177 my @errors = $cust_main->unsuspend;
179 # side-fx with nested transactions? upstack rolls back?
180 warn "WARNING:Errors unsuspending customer ". $cust_main->custnum. ": ".
186 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
194 Unless the closed flag is set, deletes this credit and all associated
195 applications (see L<FS::cust_credit_bill>). In most cases, you want to use
196 the void method instead to leave a record of the deleted credit.
200 # very similar to FS::cust_pay::delete
203 return "Can't delete closed credit" if $self->closed =~ /^Y/i;
205 local $SIG{HUP} = 'IGNORE';
206 local $SIG{INT} = 'IGNORE';
207 local $SIG{QUIT} = 'IGNORE';
208 local $SIG{TERM} = 'IGNORE';
209 local $SIG{TSTP} = 'IGNORE';
210 local $SIG{PIPE} = 'IGNORE';
212 my $oldAutoCommit = $FS::UID::AutoCommit;
213 local $FS::UID::AutoCommit = 0;
216 foreach my $cust_credit_bill ( $self->cust_credit_bill ) {
217 my $error = $cust_credit_bill->delete;
219 $dbh->rollback if $oldAutoCommit;
224 foreach my $cust_credit_refund ( $self->cust_credit_refund ) {
225 my $error = $cust_credit_refund->delete;
227 $dbh->rollback if $oldAutoCommit;
232 my $error = $self->SUPER::delete(@_);
234 $dbh->rollback if $oldAutoCommit;
238 if ( $conf->config('deletecredits') ne '' ) {
240 my $cust_main = $self->cust_main;
242 my $error = send_email(
243 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
244 #invoice_from??? well as good as any
245 'to' => $conf->config('deletecredits'),
246 'subject' => 'FREESIDE NOTIFICATION: Credit deleted',
248 "This is an automatic message from your Freeside installation\n",
249 "informing you that the following credit has been deleted:\n",
251 'crednum: '. $self->crednum. "\n",
252 'custnum: '. $self->custnum.
253 " (". $cust_main->last. ", ". $cust_main->first. ")\n",
254 'amount: $'. sprintf("%.2f", $self->amount). "\n",
255 'date: '. time2str("%a %b %e %T %Y", $self->_date). "\n",
256 'reason: '. $self->reason. "\n",
261 $dbh->rollback if $oldAutoCommit;
262 return "can't send credit deletion notification: $error";
267 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
273 =item replace [ OLD_RECORD ]
275 You can, but probably shouldn't modify credits...
277 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
278 supplied, replaces this record. If there is an error, returns the error,
279 otherwise returns false.
285 return "Can't modify closed credit" if $self->closed =~ /^Y/i;
286 $self->SUPER::replace(@_);
291 Checks all fields to make sure this is a valid credit. If there is an error,
292 returns the error, otherwise returns false. Called by the insert and replace
300 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
303 $self->ut_numbern('crednum')
304 || $self->ut_number('custnum')
305 || $self->ut_numbern('_date')
306 || $self->ut_money('amount')
307 || $self->ut_alphan('otaker')
308 || $self->ut_textn('reason')
309 || $self->ut_textn('addlinfo')
310 || $self->ut_enum('closed', [ '', 'Y' ])
311 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
312 || $self->ut_foreign_keyn('eventnum', 'cust_event', 'eventnum')
314 return $error if $error;
316 my $method = $ignore_empty_reasonnum ? 'ut_foreign_keyn' : 'ut_foreign_key';
317 $error = $self->$method('reasonnum', 'reason', 'reasonnum');
318 return $error if $error;
320 return "amount must be > 0 " if $self->amount <= 0;
322 return "amount must be greater or equal to amount applied"
323 if $self->unapplied < 0 && ! $otaker_upgrade_kludge;
325 return "Unknown customer"
326 unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
328 $self->_date(time) unless $self->_date;
333 =item cust_credit_refund
335 Returns all refund applications (see L<FS::cust_credit_refund>) for this credit.
339 sub cust_credit_refund {
341 map { $_ } #return $self->num_cust_credit_refund unless wantarray;
342 sort { $a->_date <=> $b->_date }
343 qsearch( 'cust_credit_refund', { 'crednum' => $self->crednum } )
347 =item cust_credit_bill
349 Returns all application to invoices (see L<FS::cust_credit_bill>) for this
354 sub cust_credit_bill {
356 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
357 sort { $a->_date <=> $b->_date }
358 qsearch( 'cust_credit_bill', { 'crednum' => $self->crednum } )
364 Returns the amount of this credit that is still unapplied/outstanding;
365 amount minus all refund applications (see L<FS::cust_credit_refund>) and
366 applications to invoices (see L<FS::cust_credit_bill>).
372 my $amount = $self->amount;
373 $amount -= $_->amount foreach ( $self->cust_credit_refund );
374 $amount -= $_->amount foreach ( $self->cust_credit_bill );
375 sprintf( "%.2f", $amount );
380 Deprecated name for the unapplied method.
386 #carp "cust_credit->credited deprecated; use ->unapplied";
387 $self->unapplied(@_);
392 Returns the customer (see L<FS::cust_main>) for this credit.
398 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
404 Returns the text of the associated reason (see L<FS::reason>) for this credit.
409 my ($self, $value, %options) = @_;
412 my $typenum = $options{'reason_type'};
414 my $oldAutoCommit = $FS::UID::AutoCommit; # this should already be in
415 local $FS::UID::AutoCommit = 0; # a transaction if it matters
417 if ( defined( $value ) ) {
418 my $hashref = { 'reason' => $value };
419 $hashref->{'reason_type'} = $typenum if $typenum;
420 my $addl_from = "LEFT JOIN reason_type ON ( reason_type = typenum ) ";
421 my $extra_sql = " AND reason_type.class='R'";
423 $reason = qsearchs( { 'table' => 'reason',
424 'hashref' => $hashref,
425 'addl_from' => $addl_from,
426 'extra_sql' => $extra_sql,
429 if (!$reason && $typenum) {
430 $reason = new FS::reason( { 'reason_type' => $typenum,
434 my $error = $reason->insert;
436 warn "error inserting reason: $error\n";
441 $self->reasonnum($reason ? $reason->reasonnum : '') ;
442 warn "$me reason used in set mode with non-existant reason -- clearing"
445 $reason = qsearchs( 'reason', { 'reasonnum' => $self->reasonnum } );
447 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
449 ( $reason ? $reason->reason : '' ).
450 ( $self->addlinfo ? ' '.$self->addlinfo : '' );
455 # Used by FS::Upgrade to migrate to a new database.
457 sub _upgrade_data { # class method
458 my ($class, %opts) = @_;
460 warn "$me upgrading $class\n" if $DEBUG;
462 if (defined dbdef->table($class->table)->column('reason')) {
464 warn "$me Checking for unmigrated reasons\n" if $DEBUG;
466 my @cust_credits = qsearch({ 'table' => $class->table,
468 'extra_sql' => 'WHERE reason IS NOT NULL',
471 if (scalar(grep { $_->getfield('reason') =~ /\S/ } @cust_credits)) {
472 warn "$me Found unmigrated reasons\n" if $DEBUG;
473 my $hashref = { 'class' => 'R', 'type' => 'Legacy' };
474 my $reason_type = qsearchs( 'reason_type', $hashref );
475 unless ($reason_type) {
476 $reason_type = new FS::reason_type( $hashref );
477 my $error = $reason_type->insert();
478 die "$class had error inserting FS::reason_type into database: $error\n"
482 $hashref = { 'reason_type' => $reason_type->typenum,
485 my $noreason = qsearchs( 'reason', $hashref );
487 $hashref->{'disabled'} = 'Y';
488 $noreason = new FS::reason( $hashref );
489 my $error = $noreason->insert();
490 die "can't insert legacy reason '(none)' into database: $error\n"
494 foreach my $cust_credit ( @cust_credits ) {
495 my $reason = $cust_credit->getfield('reason');
496 warn "Contemplating reason $reason\n" if $DEBUG > 1;
497 if ($reason =~ /\S/) {
498 $cust_credit->reason($reason, 'reason_type' => $reason_type->typenum)
499 or die "can't insert legacy reason $reason into database\n";
501 $cust_credit->reasonnum($noreason->reasonnum);
504 $cust_credit->setfield('reason', '');
505 my $error = $cust_credit->replace;
507 warn "*** WARNING: error replacing reason in $class ".
508 $cust_credit->crednum. ": $error ***\n"
513 warn "$me Ensuring existance of auto reasons\n" if $DEBUG;
515 foreach ( keys %reasontype_map ) {
516 unless ($conf->config($_)) { # hmmmm
517 # warn "$me Found $_ reason type lacking\n" if $DEBUG;
518 # my $hashref = { 'class' => 'R', 'type' => $reasontype_map{$_} };
519 my $hashref = { 'class' => 'R', 'type' => 'Legacy' };
520 my $reason_type = qsearchs( 'reason_type', $hashref );
521 unless ($reason_type) {
522 $reason_type = new FS::reason_type( $hashref );
523 my $error = $reason_type->insert();
524 die "$class had error inserting FS::reason_type into database: $error\n"
527 $conf->set($_, $reason_type->typenum);
531 warn "$me Ensuring commission packages have a reason type\n" if $DEBUG;
533 my $hashref = { 'class' => 'R', 'type' => 'Legacy' };
534 my $reason_type = qsearchs( 'reason_type', $hashref );
535 unless ($reason_type) {
536 $reason_type = new FS::reason_type( $hashref );
537 my $error = $reason_type->insert();
538 die "$class had error inserting FS::reason_type into database: $error\n"
542 my @plans = qw( flat_comission flat_comission_cust flat_comission_pkg );
543 foreach my $plan ( @plans ) {
544 foreach my $pkg ( qsearch('part_pkg', { 'plan' => $plan } ) ) {
545 unless ($pkg->option('reason_type', 1) ) {
546 my $plandata = $pkg->plandata.
547 "reason_type=". $reason_type->typenum. "\n";
548 $pkg->plandata($plandata);
550 $pkg->replace( undef,
551 'pkg_svc' => { map { $_->svcpart => $_->quantity }
554 'primary_svc' => $pkg->svcpart,
556 die "failed setting reason_type option: $error"
563 local($otaker_upgrade_kludge) = 1;
564 local($ignore_empty_reasonnum) = 1;
565 $class->_upgrade_otaker(%opts);
577 Returns an SQL fragment to retreive the unapplied amount.
582 my ($class, $start, $end) = @_;
584 my $bill_start = $start ? "AND cust_credit_bill._date <= $start" : '';
585 my $bill_end = $end ? "AND cust_credit_bill._date > $end" : '';
586 my $refund_start = $start ? "AND cust_credit_refund._date <= $start" : '';
587 my $refund_end = $end ? "AND cust_credit_refund._date > $end" : '';
591 ( SELECT SUM(amount) FROM cust_credit_refund
592 WHERE cust_credit.crednum = cust_credit_refund.crednum
593 $refund_start $refund_end )
597 ( SELECT SUM(amount) FROM cust_credit_bill
598 WHERE cust_credit.crednum = cust_credit_bill.crednum
599 $bill_start $bill_end )
608 Deprecated name for the unapplied_sql method.
615 #carp "cust_credit->credited_sql deprecated; use ->unapplied_sql";
617 #$class->unapplied_sql(@_);
621 =item credit_lineitems
625 my $error = FS::cust_credit->credit_lineitems(
627 #the lineitems to credit
628 'billpkgnums' => \@billpkgnums,
629 'setuprecurs' => \@setuprecurs,
630 'amounts' => \@amounts,
633 'newreasonnum' => scalar($cgi->param('newreasonnum')),
634 'newreasonnum_type' => scalar($cgi->param('newreasonnumT')),
635 map { $_ => scalar($cgi->param($_)) }
636 #fields('cust_credit')
637 qw( custnum _date amount reason reasonnum addlinfo ), #pkgnum eventnum
643 #maybe i should just be an insert with extra args instead of a class method
644 use FS::cust_bill_pkg;
645 sub credit_lineitems {
646 my( $class, %arg ) = @_;
647 my $curuser = $FS::CurrentUser::CurrentUser;
649 #some false laziness w/misc/xmlhttp-cust_bill_pkg-calculate_taxes.html
651 my $cust_main = qsearchs({
652 'table' => 'cust_main',
653 'hashref' => { 'custnum' => $arg{custnum} },
654 'extra_sql' => ' AND '. $curuser->agentnums_sql,
655 }) or return 'unknown customer';
658 local $SIG{HUP} = 'IGNORE';
659 local $SIG{INT} = 'IGNORE';
660 local $SIG{QUIT} = 'IGNORE';
661 local $SIG{TERM} = 'IGNORE';
662 local $SIG{TSTP} = 'IGNORE';
663 local $SIG{PIPE} = 'IGNORE';
665 my $oldAutoCommit = $FS::UID::AutoCommit;
666 local $FS::UID::AutoCommit = 0;
669 #my @cust_bill_pkg = qsearch({
670 # 'select' => 'cust_bill_pkg.*',
671 # 'table' => 'cust_bill_pkg',
672 # 'addl_from' => ' LEFT JOIN cust_bill USING (invnum) '.
673 # ' LEFT JOIN cust_main USING (custnum) ',
674 # 'extra_sql' => ' WHERE custnum = $custnum AND billpkgnum IN ('.
675 # join( ',', @{$arg{billpkgnums}} ). ')',
676 # 'order_by' => 'ORDER BY invnum ASC, billpkgnum ASC',
680 if ($arg{reasonnum} == -1) {
682 $error = 'Enter a new reason (or select an existing one)'
683 unless $arg{newreasonnum} !~ /^\s*$/;
684 my $reason = new FS::reason {
685 'reason' => $arg{newreasonnum},
686 'reason_type' => $arg{newreasonnum_type},
688 $error ||= $reason->insert;
690 $dbh->rollback if $oldAutoCommit;
691 return "Error inserting reason: $error";
693 $arg{reasonnum} = $reason->reasonnum;
696 my $cust_credit = new FS::cust_credit ( {
697 map { $_ => $arg{$_} }
698 #fields('cust_credit')
699 qw( custnum _date amount reason reasonnum addlinfo ), #pkgnum eventnum
701 $error = $cust_credit->insert;
703 $dbh->rollback if $oldAutoCommit;
704 return "Error inserting credit: $error";
708 # keys in all of these are invoice numbers
709 my %taxlisthash = ();
710 my %cust_credit_bill = ();
711 my %cust_bill_pkg = ();
712 my %cust_credit_bill_pkg = ();
713 foreach my $billpkgnum ( @{$arg{billpkgnums}} ) {
714 my $setuprecur = shift @{$arg{setuprecurs}};
715 my $amount = shift @{$arg{amounts}};
717 my $cust_bill_pkg = qsearchs({
718 'table' => 'cust_bill_pkg',
719 'hashref' => { 'billpkgnum' => $billpkgnum },
720 'addl_from' => 'LEFT JOIN cust_bill USING (invnum)',
721 'extra_sql' => 'AND custnum = '. $cust_main->custnum,
722 }) or die "unknown billpkgnum $billpkgnum";
724 my $invnum = $cust_bill_pkg->invnum;
726 if ( $setuprecur eq 'setup' ) {
727 $cust_bill_pkg->setup($amount);
728 $cust_bill_pkg->recur(0);
729 $cust_bill_pkg->unitrecur(0);
730 $cust_bill_pkg->type('');
732 $setuprecur = 'recur'; #in case its a usage classnum?
733 $cust_bill_pkg->recur($amount);
734 $cust_bill_pkg->setup(0);
735 $cust_bill_pkg->unitsetup(0);
738 push @{$cust_bill_pkg{$invnum}}, $cust_bill_pkg;
740 my %unapplied_payments; # billpaynum => amount
741 #unapply any payments applied to this line item (other credits too?)
742 foreach my $cust_bill_pay_pkg ( $cust_bill_pkg->cust_bill_pay_pkg($setuprecur) ) {
743 $error = $cust_bill_pay_pkg->delete;
745 $dbh->rollback if $oldAutoCommit;
746 return "Error unapplying payment: $error";
748 $unapplied_payments{$cust_bill_pay_pkg->billpaynum}
749 += $cust_bill_pay_pkg->amount;
751 # also unapply that amount from the invoice so it doesn't screw up
752 # application of the credit
753 foreach my $billpaynum (keys %unapplied_payments) {
754 my $cust_bill_pay = FS::cust_bill_pay->by_key($billpaynum)
755 or die "broken payment application $billpaynum";
756 $cust_bill_pay->set('amount',
758 $cust_bill_pay->get('amount') - $unapplied_payments{$billpaynum})
760 if ( $cust_bill_pay->amount >= 0.005 ) {
761 $error = $cust_bill_pay->replace;
763 $error = $cust_bill_pay->delete;
766 $dbh->rollback if $oldAutoCommit;
767 return "Error unapplying payment: $error";
771 #$subtotal += $amount;
772 $cust_credit_bill{$invnum} += $amount;
773 push @{ $cust_credit_bill_pkg{$invnum} },
774 new FS::cust_credit_bill_pkg {
775 'billpkgnum' => $cust_bill_pkg->billpkgnum,
776 'amount' => sprintf('%.2f',$amount),
777 'setuprecur' => $setuprecur,
778 'sdate' => $cust_bill_pkg->sdate,
779 'edate' => $cust_bill_pkg->edate,
782 $taxlisthash{$invnum} ||= {};
783 my $part_pkg = $cust_bill_pkg->part_pkg;
784 $cust_main->_handle_taxes( $part_pkg,
785 $taxlisthash{$invnum},
787 $cust_bill_pkg->cust_pkg,
788 $cust_bill_pkg->cust_bill->_date,
789 $cust_bill_pkg->cust_pkg->pkgpart,
794 # now loop through %cust_credit_bill and insert those
797 # (hack to prevent cust_credit_bill_pkg insertion)
798 local($FS::cust_bill_ApplicationCommon::skip_apply_to_lineitems_hack) = 1;
800 foreach my $invnum ( sort { $a <=> $b } keys %cust_credit_bill ) {
804 if ( @{ $cust_bill_pkg{$invnum} } ) {
806 my $listref_or_error =
807 $cust_main->calculate_taxes(
808 $cust_bill_pkg{$invnum},
809 $taxlisthash{$invnum},
810 $cust_bill_pkg{$invnum}->[0]->cust_bill->_date
813 unless ( ref( $listref_or_error ) ) {
814 $dbh->rollback if $oldAutoCommit;
815 return "Error calculating taxes: $listref_or_error";
818 # so, loop through the taxlines, apply just that amount to the tax line
819 # item (save for later insert) & add to $
823 foreach my $taxline ( @$listref_or_error ) {
825 my $amount = $taxline->setup;
827 #find equivalent tax line items on the existing invoice
828 my $tax_cust_bill_pkg = qsearchs('cust_bill_pkg', {
830 'pkgnum' => 0, #$taxline->invnum
831 'itemdesc' => $taxline->desc,
833 if (!$tax_cust_bill_pkg) {
834 # Very debatable. We expected the credit to include tax and
835 # the tax is not on the invoice. Perhaps we should just bail
837 #die "missing tax line item for invnum $invnum, description ".
838 # $taxline->desc."\n";
839 $cust_credit->set('amount',
841 $cust_credit->get('amount') - $amount)
843 my $error = $cust_credit->replace;
844 die "error correcting credit for missing tax line: $error\n"
850 # The existing tax_Xlocation records may not have the same pkgnum as
851 # the line item we're crediting. If there's another line item on
852 # this invoice with the same taxnum (tax table line) as this tax,
853 # then they may have its pkgnum instead. Under 2.3 there is no
854 # way to exactly find the taxes associated with a taxable item.
855 # Even if the record DOES have the same pkgnum, it may include taxes
856 # from _other_ line items, and we only want to credit the amount
857 # that's due to the selected line item.
859 # Index the tax_Xlocation records by calculate_taxes "tax identifier".
862 ( $tax_cust_bill_pkg->cust_bill_pkg_tax_Xlocation )
864 my $taxid = $old_loc->taxtype . ' ' . $old_loc->taxnum;
865 warn "DUPLICATE TAX BREAKDOWN RECORD inv#$invnum $taxid\n"
866 if defined($xlocation_map{$taxid});
868 $xlocation_map{$taxid} = $old_loc;
871 #now loop over the calculated taxes
873 ( @{ $taxline->get('cust_bill_pkg_tax_location') },
874 @{ $taxline->get('cust_bill_pkg_tax_rate_location') } )
876 my $taxid = $new_loc->taxtype . ' ' . $new_loc->taxnum;
878 my $old_loc = $xlocation_map{$taxid};
880 # then apply the amount of $new_loc to it
881 $amount -= $new_loc->amount;
883 $cust_credit_bill{$invnum} += $new_loc->amount;
884 push @{ $cust_credit_bill_pkg{$invnum} },
885 new FS::cust_credit_bill_pkg {
886 'billpkgnum' => $tax_cust_bill_pkg->billpkgnum,
887 'amount' => $new_loc->amount,
888 'setuprecur' => 'setup',
889 'billpkgtaxlocationnum' => $old_loc->billpkgtaxlocationnum,
890 'billpkgtaxratelocationnum' => $old_loc->billpkgtaxratelocationnum,
893 # do nothing, and apply the leftover amount nonspecifically
895 } #foreach my $new_loc
898 #$taxtotal += $amount;
900 # [ $taxline->itemdesc. ' (default)', sprintf('%.2f', $amount), '', '' ];
902 $cust_credit_bill{$invnum} += $amount;
903 push @{ $cust_credit_bill_pkg{$invnum} },
904 new FS::cust_credit_bill_pkg {
905 'billpkgnum' => $tax_cust_bill_pkg->billpkgnum,
907 'setuprecur' => 'setup',
913 } # if @{ $cust_bill_pkg{$invnum} }
915 #insert cust_credit_bill
917 my $cust_credit_bill = new FS::cust_credit_bill {
918 'crednum' => $cust_credit->crednum,
920 'amount' => sprintf('%.2f', $cust_credit_bill{$invnum}),
922 $error = $cust_credit_bill->insert;
924 $dbh->rollback if $oldAutoCommit;
925 return "Error applying credit of $cust_credit_bill{$invnum} ".
926 " to invoice $invnum: $error";
929 #and then insert cust_credit_bill_pkg for each cust_bill_pkg
930 foreach my $cust_credit_bill_pkg ( @{$cust_credit_bill_pkg{$invnum}} ) {
931 $cust_credit_bill_pkg->creditbillnum( $cust_credit_bill->creditbillnum );
932 $error = $cust_credit_bill_pkg->insert;
934 $dbh->rollback if $oldAutoCommit;
935 return "Error applying credit to line item: $error";
941 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
950 The delete method. The replace method.
952 B<credited> and B<credited_sql> are now called B<unapplied> and
953 B<unapplied_sql>. The old method names should start to give warnings.
957 L<FS::Record>, L<FS::cust_credit_refund>, L<FS::cust_refund>,
958 L<FS::cust_credit_bill> L<FS::cust_bill>, schema.html from the base