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=f08424561c9f46905684be8ae70959ae79967d6e;hp=d23fcd7d34a360f87bee65f44a85006b25ec80b5;hb=f3235d39d083518d47f21cd5585e5f9a13070763;hpb=ece31063b782031e21ba1f57476afab555af5363
diff --git a/htdocs/docs/man/FS/cust_credit.html b/htdocs/docs/man/FS/cust_credit.html
index d23fcd7d3..f08424561 100644
--- a/htdocs/docs/man/FS/cust_credit.html
+++ b/htdocs/docs/man/FS/cust_credit.html
@@ -1,125 +1,117 @@
FS::cust_credit - Object methods for cust_credit records
-
-
-
-FS::cust_credit - Object methods for cust_credit records
-
+
+FS::cust_credit - Object methods for cust_credit records
-
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;
-
+
+
+ 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;
-An FS::cust_credit object represents a credit. FS::cust_credit inherits
-from FS::Record. The following fields are currently supported:
-
+
+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 FS::cust_main)
- amount - amount of the credit
- credited - how much of this credit that is still outstanding, which is
-amount minus all refunds (see FS::cust_refund).
- _date - specified as a UNIX timestamp; see perlfunc/"time". Also see
-Time::Local and Date::Parse for conversion functions.
- otaker - order taker (assigned automatically, see FS::UID)
- reason - text
+ 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
-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.
-
-
-When adding new invoices, credited must be amount (or null, in which case
-it is automatically set to amount).
-
-
delete
-
+
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
-
-Replaces the OLD_RECORD with this one in the database. If there is an
-error, returns the error, otherwise returns false.
-
-
-Only credited may be changed. Credited is normally updated by creating and
-inserting a refund (see FS::cust_refund ).
-
-
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.
-
-
+
+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 ).
+
-$Id: cust_credit.html,v 1.2 2000-03-03 18:22:42 ivan Exp $
-
+
+$Id: cust_credit.html,v 1.3 2001-04-23 12:40:31 ivan Exp $
-The delete method.
-
+
+The delete method.
-FS::Record , FS::cust_refund , FS::cust_bill , schema.html from the base documentation.
+
+the FS::Record manpage , the FS::cust_refund manpage , the FS::cust_bill manpage , schema.html from the base
+documentation.