FS::cust_refund - Object method for cust_refund objects
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;
An FS::cust_refund represents a refund: the transfer of money to a customer;
equivalent to a negative payment (see the FS::cust_pay manpage). FS::cust_refund
inherits from FS::Record. The following fields are currently supported:
- refundnum - primary key (assigned automatically for new refunds)
-
- custnum - customer (see the FS::cust_main manpage)
-
- refund - Amount of the refund
-
- _date - specified as a UNIX timestamp; see perlfunc/``time''. Also see
the Time::Local manpage and the Date::Parse manpage for conversion functions.
-
- payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
-
- payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
-
- paybatch - text field for tracking card processing
-
- otaker - order taker (assigned automatically, see the FS::UID manpage)
-
- closed - books closed flag, empty or `Y'
-
- new HASHREF
-
Creates a new refund. To add the refund to the database, see insert.
- 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. In this case, custnum is optional.
- delete
-
Currently unimplemented (accounting reasons).
- replace OLD_RECORD
-
Currently unimplemented (accounting reasons).
- 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.
$Id: cust_refund.html,v 1.3 2002-01-29 17:42:46 ivan Exp $
Delete and replace methods.
the FS::Record manpage, the FS::cust_credit manpage, schema.html from the base documentation.