X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2Fcust_credit.html;fp=htdocs%2Fdocs%2Fman%2FFS%2Fcust_credit.html;h=0000000000000000000000000000000000000000;hp=f08424561c9f46905684be8ae70959ae79967d6e;hb=1d758388ce3b17b8de1ae1d3a8ec39c1026baefc;hpb=e6cf4af2b9d3ffefebe1a3e358f0674f566b56bc diff --git a/htdocs/docs/man/FS/cust_credit.html b/htdocs/docs/man/FS/cust_credit.html deleted file mode 100644 index f08424561..000000000 --- a/htdocs/docs/man/FS/cust_credit.html +++ /dev/null @@ -1,118 +0,0 @@ - - -FS::cust_credit - Object methods for cust_credit records - - - - - - - - -

- - -

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