From ea0d3938b57a079ce4aa6db0cae316e3ac6da654 Mon Sep 17 00:00:00 2001 From: ivan Date: Tue, 29 Jan 2002 17:46:41 +0000 Subject: these are all auto-generated by the installation; don't check them into CVS (probably should generate them for a release tarball though) --- httemplate/docs/man/FS/cust_credit.html | 132 -------------------------------- 1 file changed, 132 deletions(-) delete mode 100644 httemplate/docs/man/FS/cust_credit.html (limited to 'httemplate/docs/man/FS/cust_credit.html') diff --git a/httemplate/docs/man/FS/cust_credit.html b/httemplate/docs/man/FS/cust_credit.html deleted file mode 100644 index f30241371..000000000 --- a/httemplate/docs/man/FS/cust_credit.html +++ /dev/null @@ -1,132 +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
-: -
closed - books closed flag, empty or `Y'
-: -

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
-

-Depreciated. See the cust_credit_refund method. -

#Returns all refunds (see the FS::cust_refund manpage) for this credit.

cust_credit_refund
-

-Returns all refund applications (see the FS::cust_credit_refund manpage) for this credit. -

cust_credit_bill
-

-Returns all application to invoices (see the FS::cust_credit_bill manpage) for this -credit. -

credited
-

-Returns the amount of this credit that is still outstanding; which is -amount minus all refund applications (see the FS::cust_credit_refund manpage) and -applications to invoices (see the FS::cust_credit_bill manpage). -

VERSION

$Id: cust_credit.html,v 1.3 2002-01-29 17:42:46 ivan Exp $

BUGS