1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
package FS::cust_refund;
use strict;
use vars qw( @ISA );
use Business::CreditCard;
use FS::Record qw( dbh );
use FS::UID qw(getotaker);
use FS::cust_credit;
use FS::cust_credit_refund;
@ISA = qw( FS::Record );
=head1 NAME
FS::cust_refund - Object method for cust_refund objects
=head1 SYNOPSIS
use FS::cust_refund;
$record = new FS::cust_refund \%hash;
$record = new FS::cust_refund { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::cust_refund represents a refund: the transfer of money to a customer;
equivalent to a negative payment (see L<FS::cust_pay>). FS::cust_refund
inherits from FS::Record. The following fields are currently supported:
=over 4
=item refundnum - primary key (assigned automatically for new refunds)
=item refund - Amount of the refund
=item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
L<Time::Local> and L<Date::Parse> for conversion functions.
=item payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
=item payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
=item paybatch - text field for tracking card processing
=item otaker - order taker (assigned automatically, see L<FS::UID>)
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new refund. To add the refund to the database, see L<"insert">.
=cut
sub table { 'cust_refund'; }
=item insert
Adds this refund to the database.
For backwards-compatibility and convenience, if the additional field crednum is
defined, an FS::cust_credit_refund record for the full amount of the refund
will be created.
=cut
sub insert {
my $self = shift;
local $SIG{HUP} = 'IGNORE';
local $SIG{INT} = 'IGNORE';
local $SIG{QUIT} = 'IGNORE';
local $SIG{TERM} = 'IGNORE';
local $SIG{TSTP} = 'IGNORE';
local $SIG{PIPE} = 'IGNORE';
my $oldAutoCommit = $FS::UID::AutoCommit;
local $FS::UID::AutoCommit = 0;
my $dbh = dbh;
my $error = $self->check;
return $error if $error;
$error = $self->SUPER::insert;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
if ( $self->crednum ) {
my $cust_credit_refund = new FS::cust_credit_refund {
'cred' => $self->cred,
'refundnum' => $self->refundnum,
'amount' => $self->refund,
'_date' => $self->_date,
};
$error = $cust_bill_pay->insert;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
}
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
'';
}
=item delete
Currently unimplemented (accounting reasons).
=cut
sub delete {
return "Can't (yet?) delete cust_refund records!";
}
=item replace OLD_RECORD
Currently unimplemented (accounting reasons).
=cut
sub replace {
return "Can't (yet?) modify cust_refund records!";
}
=item check
Checks all fields to make sure this is a valid refund. If there is an error,
returns the error, otherwise returns false. Called by the insert method.
=cut
sub check {
my $self = shift;
my $error =
$self->ut_number('refundnum')
|| $self->ut_money('amount')
|| $self->ut_numbern('_date')
|| $self->ut_textn('paybatch')
;
return $error if $error;
$self->_date(time) unless $self->_date;
$self->payby =~ /^(CARD|BILL|COMP)$/ or return "Illegal payby";
$self->payby($1);
if ( $self->payby eq 'CARD' ) {
my $payinfo = $self->payinfo;
$self->payinfo($payinfo =~ s/\D//g);
if ( $self->payinfo ) {
$self->payinfo =~ /^(\d{13,16})$/
or return "Illegal (mistyped?) credit card number (payinfo)";
$self->payinfo($1);
validate($self->payinfo) or return "Illegal credit card number";
return "Unknown card type" if cardtype($self->payinfo) eq "Unknown";
} else {
$self->payinfo('N/A');
}
} else {
$error = $self->ut_textn('payinfo');
return $error if $error;
}
$self->otaker(getotaker);
''; #no error
}
=back
=head1 VERSION
$Id: cust_refund.pm,v 1.5 2001-09-02 01:27:11 ivan Exp $
=head1 BUGS
Delete and replace methods.
=head1 SEE ALSO
L<FS::Record>, L<FS::cust_credit>, schema.html from the base documentation.
=cut
1;
|