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...
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(@_);
625 The delete method. The replace method.
627 B<credited> and B<credited_sql> are now called B<unapplied> and
628 B<unapplied_sql>. The old method names should start to give warnings.
632 L<FS::Record>, L<FS::cust_credit_refund>, L<FS::cust_refund>,
633 L<FS::cust_credit_bill> L<FS::cust_bill>, schema.html from the base