NAME

FS::cust_credit - Object methods for cust_credit records

SYNOPSIS

  use FS::cust_credit;

  $record = new FS::cust_credit \%hash;
  $record = new FS::cust_credit { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

DESCRIPTION

An FS::cust_credit object represents a credit; the equivalent of a negative cust_bill record (see the FS::cust_bill manpage). FS::cust_credit inherits from FS::Record. The following fields are currently supported:

crednum - primary key (assigned automatically for new credits)
custnum - customer (see the FS::cust_main manpage)
amount - amount of the credit
_date - specified as a UNIX timestamp; see perlfunc/``time''. Also see the Time::Local manpage and the Date::Parse manpage for conversion functions.
otaker - order taker (assigned automatically, see the FS::UID manpage)
reason - text

METHODS

new HASHREF: Creates a new credit. To add the credit to the database, see insert.
insert: Adds this credit to the database (``Posts'' the credit). If there is an error, returns the error, otherwise returns false.
delete: Currently unimplemented.
replace OLD_RECORD: Credits may not be modified; there would then be no record the credit was ever posted.
check: Checks all fields to make sure this is a valid credit. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
cust_refund: Returns all refunds (see the FS::cust_refund manpage) for this credit.
credited: Returns the amount of this credit that is still outstanding; which is amount minus all refunds (see the FS::cust_refund manpage).

VERSION

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

BUGS