1 package FS::cust_credit;
2 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::reason_Mixin
6 use vars qw( $conf $me $DEBUG
7 $otaker_upgrade_kludge $ignore_empty_reasonnum
9 use List::Util qw( min );
11 use FS::UID qw( dbh );
12 use FS::Record qw( qsearch qsearchs dbdef );
16 use FS::cust_credit_bill;
23 use FS::cust_credit_void;
24 use FS::cust_bill_pkg;
25 use FS::upgrade_journal;
27 $me = '[ FS::cust_credit ]';
30 $otaker_upgrade_kludge = 0;
31 $ignore_empty_reasonnum = 0;
33 #ask FS::UID to run this stuff for us later
34 $FS::UID::callback{'FS::cust_credit'} = sub {
40 our %reasontype_map = ( 'referral_credit_type' => 'Referral Credit',
41 'cancel_credit_type' => 'Cancellation Credit',
46 FS::cust_credit - Object methods for cust_credit records
52 $record = new FS::cust_credit \%hash;
53 $record = new FS::cust_credit { 'column' => 'value' };
55 $error = $record->insert;
57 $error = $new_record->replace($old_record);
59 $error = $record->delete;
61 $error = $record->check;
65 An FS::cust_credit object represents a credit; the equivalent of a negative
66 B<cust_bill> record (see L<FS::cust_bill>). FS::cust_credit inherits from
67 FS::Record. The following fields are currently supported:
73 Primary key (assigned automatically for new credits)
77 Customer (see L<FS::cust_main>)
85 Specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
86 L<Time::Local> and L<Date::Parse> for conversion functions.
90 Order taker (see L<FS::access_user>)
98 Reason (see L<FS::reason>)
106 Books closed flag, empty or `Y'
110 Desired pkgnum when using experimental package balances.
120 Creates a new credit. To add the credit to the database, see L<"insert">.
124 sub table { 'cust_credit'; }
125 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
126 sub cust_unlinked_msg {
128 "WARNING: can't find cust_main.custnum ". $self->custnum.
129 ' (cust_credit.crednum '. $self->crednum. ')';
132 =item insert [ OPTION => VALUE ... ]
134 Adds this credit to the database ("Posts" the credit). If there is an error,
135 returns the error, otherwise returns false.
137 Ooptions are passed as a list of keys and values. Available options:
143 L<FS::reason_type> Reason type for newly-inserted reason
145 =item cust_credit_source_bill_pkg
148 L<FS::cust_credit_source_bill_pkg> objects.
149 They will have their crednum set and will be inserted along with this credit.
156 my ($self, %options) = @_;
158 local $SIG{HUP} = 'IGNORE';
159 local $SIG{INT} = 'IGNORE';
160 local $SIG{QUIT} = 'IGNORE';
161 local $SIG{TERM} = 'IGNORE';
162 local $SIG{TSTP} = 'IGNORE';
163 local $SIG{PIPE} = 'IGNORE';
165 my $oldAutoCommit = $FS::UID::AutoCommit;
166 local $FS::UID::AutoCommit = 0;
169 my $cust_main = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
170 unless ( $cust_main ) {
171 $dbh->rollback if $oldAutoCommit;
172 return "Unknown custnum ". $self->custnum;
174 my $old_balance = $cust_main->balance;
176 if (!$self->reasonnum) {
177 my $reason_text = $self->get('reason')
178 or return "reason text or existing reason required";
179 my $reason_type = $options{'reason_type'}
180 or return "reason type required";
183 my $reason = FS::reason->new_or_existing(
184 reason => $reason_text,
185 type => $reason_type,
189 $dbh->rollback if $oldAutoCommit;
190 return "failed to set credit reason: $@";
192 $self->set('reasonnum', $reason->reasonnum);
195 $self->setfield('reason', '');
197 my $error = $self->SUPER::insert;
199 $dbh->rollback if $oldAutoCommit;
200 return "error inserting $self: $error";
203 if ( $options{'cust_credit_source_bill_pkg'} ) {
204 foreach my $ccsbr ( @{ $options{'cust_credit_source_bill_pkg'} } ) {
205 $ccsbr->crednum( $self->crednum );
206 $error = $ccsbr->insert;
208 $dbh->rollback if $oldAutoCommit;
209 return "error inserting $ccsbr: $error";
214 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
216 # possibly trigger package unsuspend, doesn't abort transaction on failure
217 $self->unsuspend_balance if $old_balance;
219 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
227 Unless the closed flag is set, deletes this credit and all associated
228 applications (see L<FS::cust_credit_bill>). In most cases, you want to use
229 the void method instead to leave a record of the deleted credit.
233 # very similar to FS::cust_pay::delete
238 return "Can't delete closed credit" if $self->closed =~ /^Y/i;
240 local $SIG{HUP} = 'IGNORE';
241 local $SIG{INT} = 'IGNORE';
242 local $SIG{QUIT} = 'IGNORE';
243 local $SIG{TERM} = 'IGNORE';
244 local $SIG{TSTP} = 'IGNORE';
245 local $SIG{PIPE} = 'IGNORE';
247 my $oldAutoCommit = $FS::UID::AutoCommit;
248 local $FS::UID::AutoCommit = 0;
251 foreach my $cust_credit_bill ( $self->cust_credit_bill ) {
252 my $error = $cust_credit_bill->delete;
254 $dbh->rollback if $oldAutoCommit;
259 foreach my $cust_credit_refund ( $self->cust_credit_refund ) {
260 my $error = $cust_credit_refund->delete;
262 $dbh->rollback if $oldAutoCommit;
267 my $error = $self->SUPER::delete(@_);
269 $dbh->rollback if $oldAutoCommit;
273 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
279 =item replace [ OLD_RECORD ]
281 You can, but probably shouldn't modify credits...
283 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
284 supplied, replaces this record. If there is an error, returns the error,
285 otherwise returns false.
291 return "Can't modify closed credit" if $self->closed =~ /^Y/i;
292 $self->SUPER::replace(@_);
297 Checks all fields to make sure this is a valid credit. If there is an error,
298 returns the error, otherwise returns false. Called by the insert and replace
306 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
309 $self->ut_numbern('crednum')
310 || $self->ut_number('custnum')
311 || $self->ut_numbern('_date')
312 || $self->ut_money('amount')
313 || $self->ut_alphan('otaker')
314 || $self->ut_textn('reason')
315 || $self->ut_textn('addlinfo')
316 || $self->ut_enum('closed', [ '', 'Y' ])
317 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
318 || $self->ut_foreign_keyn('eventnum', 'cust_event', 'eventnum')
319 || $self->ut_foreign_keyn('commission_agentnum', 'agent', 'agentnum')
320 || $self->ut_foreign_keyn('commission_salesnum', 'sales', 'salesnum')
321 || $self->ut_foreign_keyn('commission_pkgnum', 'cust_pkg', 'pkgnum')
322 || $self->ut_foreign_keyn('commission_invnum', 'cust_bill', 'invnum')
324 return $error if $error;
326 my $method = $ignore_empty_reasonnum ? 'ut_foreign_keyn' : 'ut_foreign_key';
327 $error = $self->$method('reasonnum', 'reason', 'reasonnum');
328 return $error if $error;
330 return "amount must be > 0 " if $self->amount <= 0;
332 return "amount must be greater or equal to amount applied"
333 if $self->unapplied < 0 && ! $otaker_upgrade_kludge;
335 return "Unknown customer"
336 unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
338 $self->_date(time) unless $self->_date;
343 =item void [ REASON ]
345 Voids this credit: deletes the credit and all associated applications and
346 adds a record of the voided credit to the cust_credit_void table.
354 unless (ref($reason) || !$reason) {
355 $reason = FS::reason->new_or_existing(
357 'type' => 'Void credit',
362 local $SIG{HUP} = 'IGNORE';
363 local $SIG{INT} = 'IGNORE';
364 local $SIG{QUIT} = 'IGNORE';
365 local $SIG{TERM} = 'IGNORE';
366 local $SIG{TSTP} = 'IGNORE';
367 local $SIG{PIPE} = 'IGNORE';
369 my $oldAutoCommit = $FS::UID::AutoCommit;
370 local $FS::UID::AutoCommit = 0;
373 my $cust_credit_void = new FS::cust_credit_void ( {
374 map { $_ => $self->get($_) } $self->fields
376 $cust_credit_void->set('void_reasonnum', $reason->reasonnum) if $reason;
377 my $error = $cust_credit_void->insert;
379 $dbh->rollback if $oldAutoCommit;
383 $error = $self->delete();
385 $dbh->rollback if $oldAutoCommit;
389 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
395 =item cust_credit_refund
397 Returns all refund applications (see L<FS::cust_credit_refund>) for this credit.
401 sub cust_credit_refund {
403 map { $_ } #return $self->num_cust_credit_refund unless wantarray;
404 sort { $a->_date <=> $b->_date }
405 qsearch( 'cust_credit_refund', { 'crednum' => $self->crednum } )
409 =item cust_credit_bill
411 Returns all application to invoices (see L<FS::cust_credit_bill>) for this
416 sub cust_credit_bill {
418 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
419 sort { $a->_date <=> $b->_date }
420 qsearch( 'cust_credit_bill', { 'crednum' => $self->crednum } )
426 Returns the amount of this credit that is still unapplied/outstanding;
427 amount minus all refund applications (see L<FS::cust_credit_refund>) and
428 applications to invoices (see L<FS::cust_credit_bill>).
434 my $amount = $self->amount;
435 $amount -= $_->amount foreach ( $self->cust_credit_refund );
436 $amount -= $_->amount foreach ( $self->cust_credit_bill );
437 sprintf( "%.2f", $amount );
442 Deprecated name for the unapplied method.
448 #carp "cust_credit->credited deprecated; use ->unapplied";
449 $self->unapplied(@_);
454 Returns the customer (see L<FS::cust_main>) for this credit.
460 # Used by FS::Upgrade to migrate to a new database.
462 sub _upgrade_data { # class method
463 my ($class, %opts) = @_;
465 warn "$me upgrading $class\n" if $DEBUG;
467 $class->_upgrade_reasonnum(%opts);
469 if (defined dbdef->table($class->table)->column('reason')) {
471 warn "$me Ensuring existance of auto reasons\n" if $DEBUG;
473 foreach ( keys %reasontype_map ) {
474 unless ($conf->config($_)) { # hmmmm
475 # warn "$me Found $_ reason type lacking\n" if $DEBUG;
476 # my $hashref = { 'class' => 'R', 'type' => $reasontype_map{$_} };
477 my $hashref = { 'class' => 'R', 'type' => 'Legacy' };
478 my $reason_type = qsearchs( 'reason_type', $hashref );
479 unless ($reason_type) {
480 $reason_type = new FS::reason_type( $hashref );
481 my $error = $reason_type->insert();
482 die "$class had error inserting FS::reason_type into database: $error\n"
485 $conf->set($_, $reason_type->typenum);
489 warn "$me Ensuring commission packages have a reason type\n" if $DEBUG;
491 my $hashref = { 'class' => 'R', 'type' => 'Legacy' };
492 my $reason_type = qsearchs( 'reason_type', $hashref );
493 unless ($reason_type) {
494 $reason_type = new FS::reason_type( $hashref );
495 my $error = $reason_type->insert();
496 die "$class had error inserting FS::reason_type into database: $error\n"
500 my @plans = qw( flat_comission flat_comission_cust flat_comission_pkg );
501 foreach my $plan ( @plans ) {
502 foreach my $pkg ( qsearch('part_pkg', { 'plan' => $plan } ) ) {
503 unless ($pkg->option('reason_type', 1) ) {
504 my $plandata = $pkg->plandata.
505 "reason_type=". $reason_type->typenum. "\n";
506 $pkg->plandata($plandata);
508 $pkg->replace( undef,
509 'pkg_svc' => { map { $_->svcpart => $_->quantity }
512 'primary_svc' => $pkg->svcpart,
514 die "failed setting reason_type option: $error"
521 local($otaker_upgrade_kludge) = 1;
522 local($ignore_empty_reasonnum) = 1;
523 $class->_upgrade_otaker(%opts);
525 if ( !FS::upgrade_journal->is_done('cust_credit__tax_link')
526 and !$conf->config('tax_data_vendor') ) {
527 # RT#25458: fix credit line item applications that should refer to a
528 # specific tax allocation
529 my @cust_credit_bill_pkg = qsearch({
530 table => 'cust_credit_bill_pkg',
531 select => 'cust_credit_bill_pkg.*',
532 addl_from => ' LEFT JOIN cust_bill_pkg USING (billpkgnum)',
534 'WHERE cust_credit_bill_pkg.billpkgtaxlocationnum IS NULL '.
535 'AND cust_bill_pkg.pkgnum = 0', # is a tax
539 foreach (@cust_credit_bill_pkg) {
540 my $billpkgnum = $_->billpkgnum;
541 $tax_items{$billpkgnum} ||= FS::cust_bill_pkg->by_key($billpkgnum);
542 $credits{$billpkgnum} ||= [];
543 push @{ $credits{$billpkgnum} }, $_;
545 TAX_ITEM: foreach my $tax_item (values %tax_items) {
546 my $billpkgnum = $tax_item->billpkgnum;
547 # get all pkg/location/taxrate allocations of this tax line item
548 my @allocations = sort {$b->amount <=> $a->amount}
549 qsearch('cust_bill_pkg_tax_location', {
550 billpkgnum => $billpkgnum
552 # and these are all credit applications to it
553 my @credits = sort {$b->amount <=> $a->amount}
554 @{ $credits{$billpkgnum} };
555 my $c = shift @credits;
556 my $a = shift @allocations; # we will NOT modify these
558 if ( abs($c->amount - $a->amount) < 0.005 ) {
559 # by far the most common case: the tax line item is for a single
560 # tax, so we just fill in the billpkgtaxlocationnum
561 $c->set('billpkgtaxlocationnum', $a->billpkgtaxlocationnum);
562 my $error = $c->replace;
564 warn "error fixing credit application to tax item #$billpkgnum:\n$error\n";
568 $a = shift @allocations;
569 } elsif ( $c->amount > $a->amount ) {
570 # fairly common: the tax line contains tax for multiple packages
571 # (or multiple taxes) but the credit isn't divided up
572 my $new_link = FS::cust_credit_bill_pkg->new({
573 creditbillnum => $c->creditbillnum,
574 billpkgnum => $c->billpkgnum,
575 billpkgtaxlocationnum => $a->billpkgtaxlocationnum,
576 amount => $a->amount,
577 setuprecur => 'setup',
579 my $error = $new_link->insert;
581 warn "error fixing credit application to tax item #$billpkgnum:\n$error\n";
584 $c->set(amount => sprintf('%.2f', $c->amount - $a->amount));
585 $a = shift @allocations;
586 } elsif ( $c->amount < 0.005 ) {
587 # also fairly common; we can delete these with no harm
588 my $error = $c->delete;
589 warn "error removing zero-amount credit application (probably harmless):\n$error\n" if $error;
591 } elsif ( $c->amount < $a->amount ) {
592 # should never happen, but if it does, handle it gracefully
593 $c->set('billpkgtaxlocationnum', $a->billpkgtaxlocationnum);
594 my $error = $c->replace;
596 warn "error fixing credit application to tax item #$billpkgnum:\n$error\n";
599 $a->set(amount => $a->amount - $c->amount);
604 if ( $c->amount < 0.005 ) {
605 my $error = $c->delete;
606 warn "error removing zero-amount credit application (probably harmless):\n$error\n" if $error;
607 } elsif ( $c->modified ) {
608 # then we've allocated part of it, so reduce the nonspecific
609 # application by that much
610 my $error = $c->replace;
611 warn "error fixing credit application to tax item #$billpkgnum:\n$error\n" if $error;
613 # else there are probably no allocations, i.e. this is a pre-3.x
614 # record that was never migrated over, so leave it alone
616 } # foreach $tax_item
617 FS::upgrade_journal->set_done('cust_credit__tax_link');
629 Returns an SQL fragment to retreive the unapplied amount.
634 my ($class, $start, $end) = @_;
636 my $bill_start = $start ? "AND cust_credit_bill._date <= $start" : '';
637 my $bill_end = $end ? "AND cust_credit_bill._date > $end" : '';
638 my $refund_start = $start ? "AND cust_credit_refund._date <= $start" : '';
639 my $refund_end = $end ? "AND cust_credit_refund._date > $end" : '';
643 ( SELECT SUM(amount) FROM cust_credit_refund
644 WHERE cust_credit.crednum = cust_credit_refund.crednum
645 $refund_start $refund_end )
649 ( SELECT SUM(amount) FROM cust_credit_bill
650 WHERE cust_credit.crednum = cust_credit_bill.crednum
651 $bill_start $bill_end )
660 Deprecated name for the unapplied_sql method.
667 #carp "cust_credit->credited_sql deprecated; use ->unapplied_sql";
669 #$class->unapplied_sql(@_);
673 =item calculate_tax_adjustment PARAMS
675 Calculate the amount of tax that needs to be credited as part of a lineitem
680 - billpkgnums: arrayref identifying the line items to credit
681 - setuprecurs: arrayref of 'setup' or 'recur', indicating which part of
682 the lineitem charge is being credited
683 - amounts: arrayref of the amounts to credit on each line item
684 - custnum: the customer all of these invoices belong to, for error checking
686 Returns a hash containing:
687 - subtotal: the total non-tax amount to be credited (the sum of the 'amounts')
688 - taxtotal: the total tax amount to be credited
689 - taxlines: an arrayref of hashrefs for each tax line to be credited, each with:
690 - table: "cust_bill_pkg_tax_location" or "cust_bill_pkg_tax_rate_location"
691 - num: the key within that table
692 - credit: the credit amount to apply to that line
696 sub calculate_tax_adjustment {
697 my ($class, %arg) = @_;
704 my (%cust_bill_pkg, %cust_bill);
706 for (my $i = 0; ; $i++) {
707 my $billpkgnum = $arg{billpkgnums}[$i]
709 my $setuprecur = $arg{setuprecurs}[$i];
710 my $amount = $arg{amounts}[$i];
711 next if $amount == 0;
712 $subtotal += $amount;
713 my $cust_bill_pkg = $cust_bill_pkg{$billpkgnum}
714 ||= FS::cust_bill_pkg->by_key($billpkgnum)
715 or die "lineitem #$billpkgnum not found\n";
717 my $invnum = $cust_bill_pkg->invnum;
718 $cust_bill{ $invnum } ||= FS::cust_bill->by_key($invnum);
719 $cust_bill{ $invnum}->custnum == $arg{custnum}
720 or die "lineitem #$billpkgnum not found\n";
722 # tax_Xlocation records don't distinguish setup and recur, so calculate
723 # the fraction of setup+recur (after deducting credits) that's setup. This
724 # will also be the fraction of tax (after deducting credits) that's tax on
727 $setup = $cust_bill_pkg->get('setup') || 0;
729 $setup -= $cust_bill_pkg->credited('', '', setuprecur => 'setup') || 0;
731 $recur = $cust_bill_pkg->get('recur') || 0;
733 $recur -= $cust_bill_pkg->credited('', '', setuprecur => 'recur') || 0;
735 # Skip line items that have been completely credited.
736 next if ($setup + $recur) == 0;
737 my $setup_ratio = $setup / ($setup + $recur);
739 # Calculate the fraction of tax to credit: it's the fraction of this
740 # charge (either setup or recur) that's being credited.
741 my $charged = ($setuprecur eq 'setup') ? $setup : $recur;
742 next if $charged == 0; # shouldn't happen, but still...
744 if ($charged < $amount) {
745 $error = "invoice #$invnum: tried to credit $amount, but only $charged was charged";
748 my $credit_ratio = $amount / $charged;
750 # gather taxes that apply to the selected item
752 qw(cust_bill_pkg_tax_location cust_bill_pkg_tax_rate_location)
754 foreach my $tax_link (
755 qsearch($table, { taxable_billpkgnum => $billpkgnum })
757 my $tax_amount = $tax_link->amount;
758 # deduct existing credits applied to the tax, for the same reason as
760 foreach ($tax_link->cust_credit_bill_pkg) {
761 $tax_amount -= $_->amount;
763 # split tax amount based on setuprecur
764 # (this method ensures that, if you credit both setup and recur tax,
765 # it always equals the entire tax despite any rounding)
766 my $setup_tax = sprintf('%.2f', $tax_amount * $setup_ratio);
767 if ( $setuprecur eq 'setup' ) {
768 $tax_amount = $setup_tax;
770 $tax_amount = $tax_amount - $setup_tax;
772 my $tax_credit = sprintf('%.2f', $tax_amount * $credit_ratio);
773 my $pkey = $tax_link->get($tax_link->primary_key);
777 credit => $tax_credit,
779 $taxtotal += $tax_credit;
781 } #foreach cust_bill_pkg_tax_(rate_)?location
783 } # foreach $billpkgnum
786 subtotal => sprintf('%.2f', $subtotal),
787 taxtotal => sprintf('%.2f', $taxtotal),
788 taxlines => \@taxlines,
792 =item credit_lineitems OPTIONS
794 Creates a credit to a group of line items, with a specified amount applied
795 to each. This will also calculate the tax adjustments for those amounts and
796 credit the appropriate tax line items.
800 my $error = FS::cust_credit->credit_lineitems(
802 #the lineitems to credit
803 'billpkgnums' => \@billpkgnums,
804 'setuprecurs' => \@setuprecurs,
805 'amounts' => \@amounts,
806 'apply' => 1, #0 leaves the credit unapplied
807 'set_source' => 1, #creates credit source records for the line items
810 map { $_ => scalar($cgi->param($_)) }
811 #fields('cust_credit')
812 qw( custnum _date amount reasonnum addlinfo ), #pkgnum eventnum
816 C<billpkgnums>, C<setuprecurs>, C<amounts> are required and are parallel
817 arrays. Each one indicates an amount of credit to be applied to either the
818 setup or recur portion of a (non-tax) line item.
820 C<custnum>, C<_date>, C<reasonnum>, and C<addlinfo> will be set on the
821 credit before it's inserted.
823 C<amount> is the total amount. If unspecified, the credit will be the sum
824 of the per-line-item amounts and their tax adjustments.
828 #maybe i should just be an insert with extra args instead of a class method
829 sub credit_lineitems {
830 my( $class, %arg ) = @_;
831 my $curuser = $FS::CurrentUser::CurrentUser;
833 #some false laziness w/misc/xmlhttp-cust_bill_pkg-calculate_taxes.html
835 my $cust_main = qsearchs({
836 'table' => 'cust_main',
837 'hashref' => { 'custnum' => $arg{custnum} },
838 'extra_sql' => ' AND '. $curuser->agentnums_sql,
839 }) or return 'unknown customer';
842 local $SIG{HUP} = 'IGNORE';
843 local $SIG{INT} = 'IGNORE';
844 local $SIG{QUIT} = 'IGNORE';
845 local $SIG{TERM} = 'IGNORE';
846 local $SIG{TSTP} = 'IGNORE';
847 local $SIG{PIPE} = 'IGNORE';
849 my $oldAutoCommit = $FS::UID::AutoCommit;
850 local $FS::UID::AutoCommit = 0;
853 #my @cust_bill_pkg = qsearch({
854 # 'select' => 'cust_bill_pkg.*',
855 # 'table' => 'cust_bill_pkg',
856 # 'addl_from' => ' LEFT JOIN cust_bill USING (invnum) '.
857 # ' LEFT JOIN cust_main USING (custnum) ',
858 # 'extra_sql' => ' WHERE custnum = $custnum AND billpkgnum IN ('.
859 # join( ',', @{$arg{billpkgnums}} ). ')',
860 # 'order_by' => 'ORDER BY invnum ASC, billpkgnum ASC',
865 # first, determine the tax adjustments
866 my %tax_adjust = $class->calculate_tax_adjustment(%arg);
867 # and determine the amount automatically if it wasn't specified
868 if ( !exists( $arg{amount} ) ) {
869 $arg{amount} = sprintf('%.2f', $tax_adjust{subtotal} + $tax_adjust{taxtotal});
872 my $set_source = $arg{set_source};
875 my $cust_credit = new FS::cust_credit ( {
876 map { $_ => $arg{$_} }
877 #fields('cust_credit')
878 qw( custnum _date amount reason reasonnum addlinfo ), #pkgnum eventnum
880 $error = $cust_credit->insert;
882 $dbh->rollback if $oldAutoCommit;
883 return "Error inserting credit: $error";
886 unless ( $arg{'apply'} ) {
887 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
892 # keys in all of these are invoice numbers
893 my %cust_credit_bill = ();
894 my %cust_bill_pkg = ();
895 my %cust_credit_bill_pkg = ();
896 my %unapplied_payments = (); #invoice numbers, and then billpaynums
899 # little private function to unapply payments from a cust_bill_pkg until
900 # there's a specified amount of unpaid balance on it.
901 # it's a separate sub because we do it for both tax and nontax items. it's
902 # private because it needs access to some local data structures.
903 my $unapply_sub = sub {
904 my ($cust_bill_pkg, $setuprecur, $need_to_unapply) = @_;
906 my $invnum = $cust_bill_pkg->invnum;
908 $need_to_unapply -= $cust_bill_pkg->owed($setuprecur);
909 return if $need_to_unapply < 0.005;
912 # then unapply payments one at a time (partially if need be) until the
913 # unpaid balance = the credit amount.
914 foreach my $cust_bill_pay_pkg (
915 $cust_bill_pkg->cust_bill_pay_pkg($setuprecur)
917 my $this_amount = $cust_bill_pay_pkg->amount;
918 if ( $this_amount > $need_to_unapply ) {
919 # unapply the needed amount
920 $cust_bill_pay_pkg->set('amount',
921 sprintf('%.2f', $this_amount - $need_to_unapply));
922 $error = $cust_bill_pay_pkg->replace;
923 $unapplied_payments{$invnum}{$cust_bill_pay_pkg->billpaynum} += $need_to_unapply;
924 last; # and we're done
928 $error = $cust_bill_pay_pkg->delete;
929 $unapplied_payments{$invnum}{$cust_bill_pay_pkg->billpaynum} += $this_amount;
931 $need_to_unapply -= $this_amount;
934 } # foreach $cust_bill_pay_pkg
936 # return an error if we somehow still have leftover $need_to_unapply?
942 foreach my $billpkgnum ( @{$arg{billpkgnums}} ) {
943 my $setuprecur = shift @{$arg{setuprecurs}};
944 my $amount = shift @{$arg{amounts}};
946 my $cust_bill_pkg = qsearchs({
947 'table' => 'cust_bill_pkg',
948 'hashref' => { 'billpkgnum' => $billpkgnum },
949 'addl_from' => 'LEFT JOIN cust_bill USING (invnum)',
950 'extra_sql' => 'AND custnum = '. $cust_main->custnum,
951 }) or die "unknown billpkgnum $billpkgnum";
953 my $invnum = $cust_bill_pkg->invnum;
955 push @{$cust_bill_pkg{$invnum}}, $cust_bill_pkg;
957 $cust_credit_bill{$invnum} += $amount;
958 push @{ $cust_credit_bill_pkg{$invnum} },
959 new FS::cust_credit_bill_pkg {
960 'billpkgnum' => $billpkgnum,
961 'amount' => sprintf('%.2f',$amount),
962 'setuprecur' => $setuprecur,
963 'sdate' => $cust_bill_pkg->sdate,
964 'edate' => $cust_bill_pkg->edate,
967 # unapply payments if necessary
968 $error = &{$unapply_sub}($cust_bill_pkg, $setuprecur, $amount);
971 $currency{$invnum} ||= $cust_bill_pkg->cust_bill->currency;
972 my $source = FS::cust_credit_source_bill_pkg->new({
973 'crednum' => $cust_credit->crednum,
974 'billpkgnum' => $billpkgnum,
976 'currency' => $currency{invnum},
978 $error ||= $source->insert;
982 $dbh->rollback if $oldAutoCommit;
983 return "Error unapplying payment: $error";
987 # do the same for taxes
988 foreach my $tax_credit ( @{ $tax_adjust{taxlines} } ) {
989 my $table = $tax_credit->{table};
990 my $tax_link = "FS::$table"->by_key( $tax_credit->{num} )
991 or die "tried to credit $table #$tax_credit->{num} but it doesn't exist";
993 my $billpkgnum = $tax_link->billpkgnum;
994 my $cust_bill_pkg = qsearchs({
995 'table' => 'cust_bill_pkg',
996 'hashref' => { 'billpkgnum' => $billpkgnum },
997 'addl_from' => 'LEFT JOIN cust_bill USING (invnum)',
998 'extra_sql' => 'AND custnum = '. $cust_main->custnum,
999 }) or die "unknown billpkgnum $billpkgnum";
1001 my $invnum = $cust_bill_pkg->invnum;
1002 push @{$cust_bill_pkg{$invnum}}, $cust_bill_pkg;
1004 my $amount = $tax_credit->{credit};
1005 $cust_credit_bill{$invnum} += $amount;
1007 # create a credit application record to the tax line item, earmarked
1008 # to the specific cust_bill_pkg_Xlocation
1009 push @{ $cust_credit_bill_pkg{$invnum} },
1010 new FS::cust_credit_bill_pkg {
1011 'billpkgnum' => $billpkgnum,
1012 'amount' => sprintf('%.2f', $amount),
1013 'setuprecur' => 'setup',
1014 $tax_link->primary_key, $tax_credit->{num}
1017 $error = &{$unapply_sub}($cust_bill_pkg, 'setup', $amount);
1019 # I guess it's correct to do this for taxes also?
1020 if ( $set_source ) {
1021 $currency{$invnum} ||= $cust_bill_pkg->cust_bill->currency;
1022 my $source = FS::cust_credit_source_bill_pkg->new({
1023 'crednum' => $cust_credit->crednum,
1024 'billpkgnum' => $billpkgnum,
1025 'amount' => $amount,
1026 'currency' => $currency{invnum},
1028 $error ||= $source->insert;
1032 $dbh->rollback if $oldAutoCommit;
1033 return "Error unapplying payment: $error";
1038 # now loop through %cust_credit_bill and insert those
1041 # (hack to prevent cust_credit_bill_pkg insertion)
1042 local($FS::cust_bill_ApplicationCommon::skip_apply_to_lineitems_hack) = 1;
1044 foreach my $invnum ( sort { $a <=> $b } keys %cust_credit_bill ) {
1046 # if we unapplied any payments from line items, also unapply that
1047 # amount from the invoice
1048 foreach my $billpaynum (keys %{$unapplied_payments{$invnum}}) {
1049 my $cust_bill_pay = FS::cust_bill_pay->by_key($billpaynum)
1050 or die "broken payment application $billpaynum";
1051 my @subapps = $cust_bill_pay->lineitem_applications;
1052 $error = $cust_bill_pay->delete; # can't replace
1054 my $new_cust_bill_pay = FS::cust_bill_pay->new({
1055 $cust_bill_pay->hash,
1057 amount => sprintf('%.2f',
1058 $cust_bill_pay->amount
1059 - $unapplied_payments{$invnum}{$billpaynum}),
1062 if ( $new_cust_bill_pay->amount > 0 ) {
1063 $error ||= $new_cust_bill_pay->insert;
1064 # Also reapply it to everything it was applied to before.
1065 # Note that we've already deleted cust_bill_pay_pkg records for the
1066 # items we're crediting, so they aren't on this list.
1067 foreach my $cust_bill_pay_pkg (@subapps) {
1068 $cust_bill_pay_pkg->billpaypkgnum('');
1069 $cust_bill_pay_pkg->billpaynum($new_cust_bill_pay->billpaynum);
1070 $error ||= $cust_bill_pay_pkg->insert;
1074 $dbh->rollback if $oldAutoCommit;
1075 return "Error unapplying payment: $error";
1078 #insert cust_credit_bill
1080 my $cust_credit_bill = new FS::cust_credit_bill {
1081 'crednum' => $cust_credit->crednum,
1082 'invnum' => $invnum,
1083 'amount' => sprintf('%.2f', $cust_credit_bill{$invnum}),
1085 $error = $cust_credit_bill->insert;
1087 $dbh->rollback if $oldAutoCommit;
1088 return "Error applying credit of $cust_credit_bill{$invnum} ".
1089 " to invoice $invnum: $error";
1092 #and then insert cust_credit_bill_pkg for each cust_bill_pkg
1093 foreach my $cust_credit_bill_pkg ( @{$cust_credit_bill_pkg{$invnum}} ) {
1094 $cust_credit_bill_pkg->creditbillnum( $cust_credit_bill->creditbillnum );
1095 $error = $cust_credit_bill_pkg->insert;
1097 $dbh->rollback if $oldAutoCommit;
1098 return "Error applying credit to line item: $error";
1104 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1109 ### refund_to_unapply/unapply_refund false laziness with FS::cust_pay
1111 =item refund_to_unapply
1113 Returns L<FS::cust_credit_refund> objects that will be deleted by L</unapply_refund>
1114 (all currently applied refunds that aren't closed.)
1115 Returns empty list if credit itself is closed.
1119 sub refund_to_unapply {
1121 return () if $self->closed;
1123 'table' => 'cust_credit_refund',
1124 'hashref' => { 'crednum' => $self->crednum },
1125 'addl_from' => 'LEFT JOIN cust_refund USING (refundnum)',
1126 'extra_sql' => "AND cust_refund.closed IS NULL AND cust_refund.source_paynum IS NULL",
1130 =item unapply_refund
1132 Deletes all objects returned by L</refund_to_unapply>.
1136 sub unapply_refund {
1139 local $SIG{HUP} = 'IGNORE';
1140 local $SIG{INT} = 'IGNORE';
1141 local $SIG{QUIT} = 'IGNORE';
1142 local $SIG{TERM} = 'IGNORE';
1143 local $SIG{TSTP} = 'IGNORE';
1144 local $SIG{PIPE} = 'IGNORE';
1146 my $oldAutoCommit = $FS::UID::AutoCommit;
1147 local $FS::UID::AutoCommit = 0;
1149 foreach my $cust_credit_refund ($self->refund_to_unapply) {
1150 my $error = $cust_credit_refund->delete;
1152 dbh->rollback if $oldAutoCommit;
1157 dbh->commit or die dbh->errstr if $oldAutoCommit;
1167 =item process_batch_import
1171 use List::Util qw( min );
1173 use FS::cust_credit_bill;
1174 sub process_batch_import {
1177 # some false laziness with FS::cust_pay::process_batch_import
1180 my $custnum = $hash{'custnum'};
1181 my $agent_custid = $hash{'agent_custid'};
1182 # translate agent_custid into regular custnum
1183 if ($custnum && $agent_custid) {
1184 die "can't specify both custnum and agent_custid\n";
1185 } elsif ($agent_custid) {
1186 # here is the agent virtualization
1187 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
1189 $search{'agent_custid'} = $agent_custid
1191 $search{'custnum'} = $custnum
1193 my $cust_main = qsearchs({
1194 'table' => 'cust_main',
1195 'hashref' => \%search,
1196 'extra_sql' => $extra_sql,
1198 die "can't find customer with" .
1199 ($custnum ? " custnum $custnum" : '') .
1200 ($agent_custid ? " agent_custid $agent_custid" : '') . "\n"
1202 die "mismatched customer number\n"
1203 if $custnum && ($custnum ne $cust_main->custnum);
1204 $custnum = $cust_main->custnum;
1206 $hash{'custnum'} = $custnum;
1207 delete($hash{'agent_custid'});
1211 my $opt = { 'table' => 'cust_credit',
1212 'params' => [ '_date', 'credbatch' ],
1213 'formats' => { 'simple' =>
1214 [ 'custnum', 'amount', 'reasonnum', 'invnum', 'agent_custid' ],
1217 'format_hash_callbacks' => { 'simple' => $hashcb },
1218 'postinsert_callback' => sub {
1219 my $cust_credit = shift; #my ($cust_credit, $param ) = @_;
1221 if ( $cust_credit->invnum ) {
1223 my $cust_bill = qsearchs('cust_bill', { invnum=>$cust_credit->invnum } );
1224 my $amount = min( $cust_credit->credited, $cust_bill->owed );
1226 my $cust_credit_bill = new FS::cust_credit_bill ( {
1227 'crednum' => $cust_credit->crednum,
1228 'invnum' => $cust_bill->invnum,
1229 'amount' => $amount,
1231 my $error = $cust_credit_bill->insert;
1232 return '' unless $error;
1236 #apply_payments_and_credits ?
1237 $cust_credit->cust_main->apply_credits;
1244 FS::Record::process_batch_import( $job, $opt, @_ );
1252 The delete method. The replace method.
1254 B<credited> and B<credited_sql> are now called B<unapplied> and
1255 B<unapplied_sql>. The old method names should start to give warnings.
1259 L<FS::Record>, L<FS::cust_credit_refund>, L<FS::cust_refund>,
1260 L<FS::cust_credit_bill> L<FS::cust_bill>, schema.html from the base