X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2Fprepay_credit.html;fp=htdocs%2Fdocs%2Fman%2FFS%2Fprepay_credit.html;h=699b1c16fb350373a3eeb60e4a44422242b87376;hp=0000000000000000000000000000000000000000;hb=35227000d6222f35ec49bc4226e94200b77abc4f;hpb=f3235d39d083518d47f21cd5585e5f9a13070763
diff --git a/htdocs/docs/man/FS/prepay_credit.html b/htdocs/docs/man/FS/prepay_credit.html
new file mode 100644
index 000000000..699b1c16f
--- /dev/null
+++ b/htdocs/docs/man/FS/prepay_credit.html
@@ -0,0 +1,118 @@
+
+
+FS::prepay_credit - Object methods for prepay_credit records
+
+
+FS::prepay_credit - Object methods for prepay_credit records
+
+
+ use FS::prepay_credit;
+
+ $record = new FS::prepay_credit \%hash;
+ $record = new FS::prepay_credit {
+ 'identifier' => '4198123455512121'
+ 'amount' => '19.95',
+ };
+
+ $error = $record->insert;
+
+ $error = $new_record->replace($old_record);
+
+ $error = $record->delete;
+
+ $error = $record->check;
+
+
An FS::table_name object represents an pre--paid credit, such as a pre-paid
+``calling card''. FS::prepay_credit inherits from FS::Record. The following
+fields are currently supported:
+
+field - description
+ identifier - identifier entered by the user to receive the credit
+ amount - amount of the credit
+
+
+
+new HASHREF
+Creates a new pre-paid credit. To add the example to the database, see
+insert .
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to. You can ask the object for a copy with the hash method.
+
+ insert
+Adds this record to the database. If there is an error, returns the error,
+otherwise returns false.
+
+ delete
+Delete this record from the database.
+
+ replace OLD_RECORD
+Replaces the OLD_RECORD with this one in the database. If there is an error,
+returns the error, otherwise returns false.
+
+ check
+Checks all fields to make sure this is a valid pre-paid credit. If there is
+an error, returns the error, otherwise returns false. Called by the insert
+and replace methods.
+
+
+
$Id: prepay_credit.html,v 1.1 2001-04-23 12:41:57 ivan Exp $
+
+
+
the FS::Record manpage , schema.html from the base documentation.
+
+
$Log: prepay_credit.html,v $
+
Revision 1.1 2001-04-23 12:41:57 ivan
+
new API documentation
+
+Revision 1.2 2000/02/02 20:22:18 ivan
+bugfix prepayment in signup server
+Revision 1.1 2000/01/31 05:22:23 ivan
+prepaid ``internet cards''
+
+
+
+