X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2Fcust_refund.html;fp=htdocs%2Fdocs%2Fman%2FFS%2Fcust_refund.html;h=8162c0b78eb4b2470ed473aca0414daa942bd57b;hp=6d6cded8aa490e878fcd4129027783b904aa76e8;hb=f3235d39d083518d47f21cd5585e5f9a13070763;hpb=ece31063b782031e21ba1f57476afab555af5363
diff --git a/htdocs/docs/man/FS/cust_refund.html b/htdocs/docs/man/FS/cust_refund.html
index 6d6cded8a..8162c0b78 100644
--- a/htdocs/docs/man/FS/cust_refund.html
+++ b/htdocs/docs/man/FS/cust_refund.html
@@ -1,115 +1,107 @@
FS::cust_refund - Object method for cust_refund objects
-
-
-
-FS::cust_refund - Object method for cust_refund objects
-
+
+FS::cust_refund - Object method for cust_refund objects
-
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;
-
+
+
+ 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;
-An FS::cust_refund represents a refund. FS::cust_refund inherits from
-FS::Record. The following fields are currently supported:
-
+
+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 FS::cust_credit)
- refund - Amount of the refund
- _date - specified as a UNIX timestamp; see perlfunc/"time". Also see
-Time::Local and Date::Parse 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 FS::UID)
+ 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 )
-new HASHREF
-
-Creates a new refund. To add the refund to the database, see insert .
-
-
insert
-
+
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
-FS::cust_credit ).
-
- delete
-
+the FS::cust_credit manpage ).
+
+ delete
Currently unimplemented (accounting reasons).
-
- replace OLD_RECORD
-
+
+ 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.
-
-
+
+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.
+
-$Id: cust_refund.html,v 1.2 2000-03-03 18:22:43 ivan Exp $
-
+
+$Id: cust_refund.html,v 1.3 2001-04-23 12:40:31 ivan Exp $
-Delete and replace methods.
-
+
+Delete and replace methods.
-FS::Record , FS::cust_credit , schema.html from the base documentation.
+
+the FS::Record manpage , the FS::cust_credit manpage , schema.html from the base documentation.