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_credit::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...
280 #return "Can't modify credit!"
282 return "Can't modify closed credit" if $self->closed =~ /^Y/i;
283 $self->SUPER::replace(@_);
288 Checks all fields to make sure this is a valid credit. If there is an error,
289 returns the error, otherwise returns false. Called by the insert and replace
297 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
300 $self->ut_numbern('crednum')
301 || $self->ut_number('custnum')
302 || $self->ut_numbern('_date')
303 || $self->ut_money('amount')
304 || $self->ut_alphan('otaker')
305 || $self->ut_textn('reason')
306 || $self->ut_textn('addlinfo')
307 || $self->ut_enum('closed', [ '', 'Y' ])
308 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
309 || $self->ut_foreign_keyn('eventnum', 'cust_event', 'eventnum')
311 return $error if $error;
313 my $method = $ignore_empty_reasonnum ? 'ut_foreign_keyn' : 'ut_foreign_key';
314 $error = $self->$method('reasonnum', 'reason', 'reasonnum');
315 return $error if $error;
317 return "amount must be > 0 " if $self->amount <= 0;
319 return "amount must be greater or equal to amount applied"
320 if $self->unapplied < 0 && ! $otaker_upgrade_kludge;
322 return "Unknown customer"
323 unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
325 $self->_date(time) unless $self->_date;
330 =item cust_credit_refund
332 Returns all refund applications (see L<FS::cust_credit_refund>) for this credit.
336 sub cust_credit_refund {
338 map { $_ } #return $self->num_cust_credit_refund unless wantarray;
339 sort { $a->_date <=> $b->_date }
340 qsearch( 'cust_credit_refund', { 'crednum' => $self->crednum } )
344 =item cust_credit_bill
346 Returns all application to invoices (see L<FS::cust_credit_bill>) for this
351 sub cust_credit_bill {
353 map { $_ } #return $self->num_cust_credit_bill unless wantarray;
354 sort { $a->_date <=> $b->_date }
355 qsearch( 'cust_credit_bill', { 'crednum' => $self->crednum } )
361 Returns the amount of this credit that is still unapplied/outstanding;
362 amount minus all refund applications (see L<FS::cust_credit_refund>) and
363 applications to invoices (see L<FS::cust_credit_bill>).
369 my $amount = $self->amount;
370 $amount -= $_->amount foreach ( $self->cust_credit_refund );
371 $amount -= $_->amount foreach ( $self->cust_credit_bill );
372 sprintf( "%.2f", $amount );
377 Deprecated name for the unapplied method.
383 #carp "cust_credit->credited deprecated; use ->unapplied";
384 $self->unapplied(@_);
389 Returns the customer (see L<FS::cust_main>) for this credit.
395 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
401 Returns the text of the associated reason (see L<FS::reason>) for this credit.
406 my ($self, $value, %options) = @_;
409 my $typenum = $options{'reason_type'};
411 my $oldAutoCommit = $FS::UID::AutoCommit; # this should already be in
412 local $FS::UID::AutoCommit = 0; # a transaction if it matters
414 if ( defined( $value ) ) {
415 my $hashref = { 'reason' => $value };
416 $hashref->{'reason_type'} = $typenum if $typenum;
417 my $addl_from = "LEFT JOIN reason_type ON ( reason_type = typenum ) ";
418 my $extra_sql = " AND reason_type.class='R'";
420 $reason = qsearchs( { 'table' => 'reason',
421 'hashref' => $hashref,
422 'addl_from' => $addl_from,
423 'extra_sql' => $extra_sql,
426 if (!$reason && $typenum) {
427 $reason = new FS::reason( { 'reason_type' => $typenum,
431 my $error = $reason->insert;
433 warn "error inserting reason: $error\n";
438 $self->reasonnum($reason ? $reason->reasonnum : '') ;
439 warn "$me reason used in set mode with non-existant reason -- clearing"
442 $reason = qsearchs( 'reason', { 'reasonnum' => $self->reasonnum } );
444 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
446 ( $reason ? $reason->reason : '' ).
447 ( $self->addlinfo ? ' '.$self->addlinfo : '' );
452 # Used by FS::Upgrade to migrate to a new database.
454 sub _upgrade_data { # class method
455 my ($class, %opts) = @_;
457 warn "$me upgrading $class\n" if $DEBUG;
459 if (defined dbdef->table($class->table)->column('reason')) {
461 warn "$me Checking for unmigrated reasons\n" if $DEBUG;
463 my @cust_credits = qsearch({ 'table' => $class->table,
465 'extra_sql' => 'WHERE reason IS NOT NULL',
468 if (scalar(grep { $_->getfield('reason') =~ /\S/ } @cust_credits)) {
469 warn "$me Found unmigrated reasons\n" if $DEBUG;
470 my $hashref = { 'class' => 'R', 'type' => 'Legacy' };
471 my $reason_type = qsearchs( 'reason_type', $hashref );
472 unless ($reason_type) {
473 $reason_type = new FS::reason_type( $hashref );
474 my $error = $reason_type->insert();
475 die "$class had error inserting FS::reason_type into database: $error\n"
479 $hashref = { 'reason_type' => $reason_type->typenum,
482 my $noreason = qsearchs( 'reason', $hashref );
484 $hashref->{'disabled'} = 'Y';
485 $noreason = new FS::reason( $hashref );
486 my $error = $noreason->insert();
487 die "can't insert legacy reason '(none)' into database: $error\n"
491 foreach my $cust_credit ( @cust_credits ) {
492 my $reason = $cust_credit->getfield('reason');
493 warn "Contemplating reason $reason\n" if $DEBUG > 1;
494 if ($reason =~ /\S/) {
495 $cust_credit->reason($reason, 'reason_type' => $reason_type->typenum)
496 or die "can't insert legacy reason $reason into database\n";
498 $cust_credit->reasonnum($noreason->reasonnum);
501 $cust_credit->setfield('reason', '');
502 my $error = $cust_credit->replace;
504 warn "*** WARNING: error replacing reason in $class ".
505 $cust_credit->crednum. ": $error ***\n"
510 warn "$me Ensuring existance of auto reasons\n" if $DEBUG;
512 foreach ( keys %reasontype_map ) {
513 unless ($conf->config($_)) { # hmmmm
514 # warn "$me Found $_ reason type lacking\n" if $DEBUG;
515 # my $hashref = { 'class' => 'R', 'type' => $reasontype_map{$_} };
516 my $hashref = { 'class' => 'R', 'type' => 'Legacy' };
517 my $reason_type = qsearchs( 'reason_type', $hashref );
518 unless ($reason_type) {
519 $reason_type = new FS::reason_type( $hashref );
520 my $error = $reason_type->insert();
521 die "$class had error inserting FS::reason_type into database: $error\n"
524 $conf->set($_, $reason_type->typenum);
528 warn "$me Ensuring commission packages have a reason type\n" if $DEBUG;
530 my $hashref = { 'class' => 'R', 'type' => 'Legacy' };
531 my $reason_type = qsearchs( 'reason_type', $hashref );
532 unless ($reason_type) {
533 $reason_type = new FS::reason_type( $hashref );
534 my $error = $reason_type->insert();
535 die "$class had error inserting FS::reason_type into database: $error\n"
539 my @plans = qw( flat_comission flat_comission_cust flat_comission_pkg );
540 foreach my $plan ( @plans ) {
541 foreach my $pkg ( qsearch('part_pkg', { 'plan' => $plan } ) ) {
542 unless ($pkg->option('reason_type', 1) ) {
543 my $plandata = $pkg->plandata.
544 "reason_type=". $reason_type->typenum. "\n";
545 $pkg->plandata($plandata);
547 $pkg->replace( undef,
548 'pkg_svc' => { map { $_->svcpart => $_->quantity }
551 'primary_svc' => $pkg->svcpart,
553 die "failed setting reason_type option: $error"
560 local($otaker_upgrade_kludge) = 1;
561 local($ignore_empty_reasonnum) = 1;
562 $class->_upgrade_otaker(%opts);
574 Returns an SQL fragment to retreive the unapplied amount.
579 my ($class, $start, $end) = @_;
581 my $bill_start = $start ? "AND cust_credit_bill._date <= $start" : '';
582 my $bill_end = $end ? "AND cust_credit_bill._date > $end" : '';
583 my $refund_start = $start ? "AND cust_credit_refund._date <= $start" : '';
584 my $refund_end = $end ? "AND cust_credit_refund._date > $end" : '';
588 ( SELECT SUM(amount) FROM cust_credit_refund
589 WHERE cust_credit.crednum = cust_credit_refund.crednum
590 $refund_start $refund_end )
594 ( SELECT SUM(amount) FROM cust_credit_bill
595 WHERE cust_credit.crednum = cust_credit_bill.crednum
596 $bill_start $bill_end )
605 Deprecated name for the unapplied_sql method.
612 #carp "cust_credit->credited_sql deprecated; use ->unapplied_sql";
614 #$class->unapplied_sql(@_);
622 The delete method. The replace method.
624 B<credited> and B<credited_sql> are now called B<unapplied> and
625 B<unapplied_sql>. The old method names should start to give warnings.
629 L<FS::Record>, L<FS::cust_credit_refund>, L<FS::cust_refund>,
630 L<FS::cust_credit_bill> L<FS::cust_bill>, schema.html from the base