NAME

FS::cust_refund - Object method for cust_refund objects


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;


DESCRIPTION

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)
crednum - Credit (see the FS::cust_credit 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)
otaker - order taker (assigned automatically, see the FS::UID manpage)


METHODS

new HASHREF
Creates a new refund. To add the refund to the database, see insert.

insert
Adds this refund to the database, and updates the credit (see the FS::cust_credit manpage).

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.


VERSION

$Id: cust_refund.html,v 1.3 2001-04-23 12:40:31 ivan Exp $


BUGS

Delete and replace methods.


SEE ALSO

the FS::Record manpage, the FS::cust_credit manpage, schema.html from the base documentation.