FS/FS/cust_refund.pm

   1 package FS::cust_refund;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use Business::CreditCard;
   6 use FS::Record qw( qsearchs );
   7 use FS::UID qw(getotaker);
   8 use FS::cust_credit;
   9
  10 @ISA = qw( FS::Record );
  11
  12 =head1 NAME
  13
  14 FS::cust_refund - Object method for cust_refund objects
  15
  16 =head1 SYNOPSIS
  17
  18   use FS::cust_refund;
  19
  20   $record = new FS::cust_refund \%hash;
  21   $record = new FS::cust_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_refund represents a refund: the transfer of money to a customer;
  34 equivalent to a negative payment (see L<FS::cust_pay>).  FS::cust_refund
  35 inherits from FS::Record.  The following fields are currently supported:
  36
  37 =over 4
  38
  39 =item refundnum - primary key (assigned automatically for new refunds)
  40
  41 =item crednum - Credit (see L<FS::cust_credit>)
  42
  43 =item refund - Amount of the refund
  44
  45 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
  46 L<Time::Local> and L<Date::Parse> for conversion functions.
  47
  48 =item payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
  49
  50 =item payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
  51
  52 =item otaker - order taker (assigned automatically, see L<FS::UID>)
  53
  54 =back
  55
  56 =head1 METHODS
  57
  58 =over 4
  59
  60 =item new HASHREF
  61
  62 Creates a new refund.  To add the refund to the database, see L<"insert">.
  63
  64 =cut
  65
  66 sub table { 'cust_refund'; }
  67
  68 =item insert
  69
  70 Adds this refund to the database, and updates the credit (see
  71 L<FS::cust_credit>).
  72
  73 =cut
  74
  75 sub insert {
  76   my $self = shift;
  77
  78   my $error = $self->check;
  79   return $error if $error;
  80
  81   my $old_cust_credit =
  82     qsearchs( 'cust_credit', { 'crednum' => $self->crednum } );
  83   return "Unknown crednum" unless $old_cust_credit;
  84
  85   $self->SUPER::insert;
  86 }
  87
  88 =item delete
  89
  90 Currently unimplemented (accounting reasons).
  91
  92 =cut
  93
  94 sub delete {
  95   return "Can't (yet?) delete cust_refund records!";
  96 }
  97
  98 =item replace OLD_RECORD
  99
 100 Currently unimplemented (accounting reasons).
 101
 102 =cut
 103
 104 sub replace {
 105    return "Can't (yet?) modify cust_refund records!";
 106 }
 107
 108 =item check
 109
 110 Checks all fields to make sure this is a valid refund.  If there is an error,
 111 returns the error, otherwise returns false.  Called by the insert method.
 112
 113 =cut
 114
 115 sub check {
 116   my $self = shift;
 117
 118   my $error;
 119
 120   $error =
 121     $self->ut_number('refundnum')
 122     || $self->ut_number('crednum')
 123     || $self->ut_money('amount')
 124     || $self->ut_numbern('_date')
 125   ;
 126   return $error if $error;
 127
 128   $self->_date(time) unless $self->_date;
 129
 130   $self->payby =~ /^(CARD|BILL|COMP)$/ or return "Illegal payby";
 131   $self->payby($1);
 132
 133   if ( $self->payby eq 'CARD' ) {
 134     my $payinfo = $self->payinfo;
 135     $self->payinfo($payinfo =~ s/\D//g);
 136     if ( $self->payinfo ) {
 137       $self->payinfo =~ /^(\d{13,16})$/
 138         or return "Illegal (mistyped?) credit card number (payinfo)";
 139       $self->payinfo($1);
 140       validate($self->payinfo) or return "Illegal credit card number";
 141       return "Unknown card type" if cardtype($self->payinfo) eq "Unknown";
 142     } else {
 143       $self->payinfo('N/A');
 144     }
 145
 146   } else {
 147     $error = $self->ut_textn('payinfo');
 148     return $error if $error;
 149   }
 150
 151   $self->otaker(getotaker);
 152
 153   ''; #no error
 154 }
 155
 156 =back
 157
 158 =head1 VERSION
 159
 160 $Id: cust_refund.pm,v 1.3 2001-04-09 23:05:15 ivan Exp $
 161
 162 =head1 BUGS
 163
 164 Delete and replace methods.
 165
 166 =head1 SEE ALSO
 167
 168 L<FS::Record>, L<FS::cust_credit>, schema.html from the base documentation.
 169
 170 =cut
 171
 172 1;
 173