X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2Fcust_refund.html;fp=htdocs%2Fdocs%2Fman%2FFS%2Fcust_refund.html;h=f1d106c2f099b5b0af7b034a907f7b147de65974;hb=2c816f314a8f3cc46e72e31f34ed97b4e11d0449;hp=0000000000000000000000000000000000000000;hpb=c5c64b9b6225072e50e74106dc2ffc455cb6118d;p=freeside.git diff --git a/htdocs/docs/man/FS/cust_refund.html b/htdocs/docs/man/FS/cust_refund.html new file mode 100644 index 000000000..f1d106c2f --- /dev/null +++ b/htdocs/docs/man/FS/cust_refund.html @@ -0,0 +1,116 @@ + + +FS::cust_refund - Object method for cust_refund objects + + + + + + + +

+ + +

NAME

+FS::cust_refund - Object method for cust_refund objects + +

SYNOPSIS

  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;
+

DESCRIPTION

+An FS::cust_refund represents a refund. 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): +

METHODS

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: +
+Currently unimplemented (accounting reasons). + +
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. + +

VERSION

+$Id: cust_refund.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS