Initial revision

[freeside.git] / htdocs / docs / man / cust_refund.txt

diff --git a/htdocs/docs/man/cust_refund.txt b/htdocs/docs/man/cust_refund.txt
new file mode 100644 (file)
index 0000000..392a0b5
--- /dev/null
+++ b/htdocs/docs/man/cust_refund.txt
@@ -0,0 +1,66 @@
+NAME
+    FS::cust_refund - Object method for cust_refund objects
+
+SYNOPSIS
+      use FS::cust_refund;
+
+      $record = create FS::cust_refund \%hash;
+      $record = create 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 the FS::cust_credit manpage)
+    refund - Amount of the refund
+    _date - specified as a UNIX timestamp; see the section on "time" in the perlfunc manpage.  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)
+METHODS
+    create HASHREF
+        Creates a new refund. To add the refund to the database, see
+        the section on "insert".
+
+    insert
+        Adds this refund to the database, and updates the credit
+        (see the FS::cust_credit manpage).
+
+    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.
+
+BUGS
+    It doesn't properly override FS::Record yet.
+
+    Delete and replace methods.
+
+SEE ALSO
+    the FS::Record manpage, the FS::cust_credit manpage, schema.html
+    from the base documentation.
+
+HISTORY
+    ivan@sisd.com 98-mar-18
+
+    ->create had wrong tablename ivan@sisd.com 98-jun-16 (finish
+    me!)
+
+    pod and finish up ivan@sisd.com 98-sep-21
+