FS/FS/cust_credit_refund.pm

   1 package FS::cust_credit_refund;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use FS::Record qw( qsearch qsearchs dbh );
   6 #use FS::UID qw(getotaker);
   7 use FS::cust_credit;
   8 use FS::cust_refund;
   9
  10 @ISA = qw( FS::Record );
  11
  12 =head1 NAME
  13
  14 FS::cust_credit_refund - Object methods for cust_bill_pay records
  15
  16 =head1 SYNOPSIS
  17
  18   use FS::cust_credit_refund;
  19
  20   $record = new FS::cust_credit_refund \%hash;
  21   $record = new FS::cust_credit_refund { 'column' => 'value' };
  22
  23   $error = $record->insert;
  24
  25   $error = $new_record->replace($old_record);
  26
  27   $error = $record->delete;
  28
  29   $error = $record->check;
  30
  31 =head1 DESCRIPTION
  32
  33 An FS::cust_credit_refund represents the application of a refund to a specific
  34 credit.  FS::cust_credit_refund inherits from FS::Record.  The following fields
  35 are currently supported:
  36
  37 =over 4
  38
  39 =item creditrefundnum - primary key (assigned automatically)
  40
  41 =item crednum - Credit (see L<FS::cust_credit>)
  42
  43 =item refundnum - Refund (see L<FS::cust_refund>)
  44
  45 =item amount - Amount of the refund to apply to the specific credit.
  46
  47 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
  48 L<Time::Local> and L<Date::Parse> for conversion functions.
  49
  50 =back
  51
  52 =head1 METHODS
  53
  54 =over 4
  55
  56 =item new HASHREF
  57
  58 Creates a new record.  To add the record to the database, see L<"insert">.
  59
  60 =cut
  61
  62 sub table { 'cust_credit_refund'; }
  63
  64 =item insert
  65
  66 Adds this record to the database.  If there is an error, returns the error,
  67 otherwise returns false.
  68
  69 =cut
  70
  71 sub insert {
  72   my $self = shift;
  73   my $error = $self->SUPER::insert;
  74   return $error if $error;
  75
  76   '';
  77 }
  78
  79 =item delete
  80
  81 Currently unimplemented (accounting reasons).
  82
  83 =cut
  84
  85 sub delete {
  86   return "Can't (yet?) delete cust_credit_refund records!";
  87 }
  88
  89 =item replace OLD_RECORD
  90
  91 Currently unimplemented (accounting reasons).
  92
  93 =cut
  94
  95 sub replace {
  96    return "Can't (yet?) modify cust_credit_refund records!";
  97 }
  98
  99 =item check
 100
 101 Checks all fields to make sure this is a valid refund application.  If there is
 102 an error, returns the error, otherwise returns false.  Called by the insert
 103 method.
 104
 105 =cut
 106
 107 sub check {
 108   my $self = shift;
 109
 110   my $error =
 111     $self->ut_numbern('creditrefundnum')
 112     || $self->ut_number('crednum')
 113     || $self->ut_number('refundnum')
 114     || $self->ut_money('amount')
 115     || $self->ut_numbern('_date')
 116   ;
 117   return $error if $error;
 118
 119   return "amount must be > 0" if $self->amount <= 0;
 120
 121   return "unknown cust_credit.crednum: ". $self->crednum
 122     unless my $cust_credit =
 123       qsearchs( 'cust_credit', { 'crednum' => $self->crednum } );
 124
 125   return "Unknown refund"
 126     unless my $cust_refund =
 127       qsearchs( 'cust_refund', { 'refundnum' => $self->refundnum } );
 128
 129   $self->_date(time) unless $self->_date;
 130
 131   return "Cannot apply more than remaining value of credit"
 132     unless $self->amount <= $cust_credit->credited;
 133
 134   return "Cannot apply more than remaining value of refund"
 135     unless $self->amount <= $cust_refund->unapplied;
 136
 137   $self->SUPER::check;
 138 }
 139
 140 =item cust_refund
 141
 142 Returns the refund (see L<FS::cust_refund>)
 143
 144 =cut
 145
 146 sub cust_refund {
 147   my $self = shift;
 148   qsearchs( 'cust_refund', { 'refundnum' => $self->refundnum } );
 149 }
 150
 151 =item cust_credit
 152
 153 Returns the credit (see L<FS::cust_credit>)
 154
 155 =cut
 156
 157 sub cust_credit {
 158   my $self = shift;
 159   qsearchs( 'cust_credit', { 'crednum' => $self->crednum } );
 160 }
 161
 162 =back
 163
 164 =head1 BUGS
 165
 166 Delete and replace methods.
 167
 168 the checks for over-applied refunds could be better done like the ones in
 169 cust_bill_credit
 170
 171 =head1 SEE ALSO
 172
 173 L<FS::cust_credit>, L<FS::cust_refund>, L<FS::Record>, schema.html from the
 174 base documentation.
 175
 176 =cut
 177
 178 1;
 179