-<HTML>
-<HEAD>
-<TITLE>FS::cust_credit - Object methods for cust_credit records</TITLE>
-<LINK REV="made" HREF="mailto:perl@packages.debian.org">
-</HEAD>
-
-<BODY>
-
-<A NAME="__index__"></A>
-<!-- INDEX BEGIN -->
-
-<UL>
-
- <LI><A HREF="#name">NAME</A></LI>
- <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
- <LI><A HREF="#description">DESCRIPTION</A></LI>
- <LI><A HREF="#methods">METHODS</A></LI>
- <LI><A HREF="#version">VERSION</A></LI>
- <LI><A HREF="#bugs">BUGS</A></LI>
- <LI><A HREF="#see also">SEE ALSO</A></LI>
-</UL>
-<!-- INDEX END -->
-
-<HR>
-<P>
-<H1><A NAME="name">NAME</A></H1>
-<P>FS::cust_credit - Object methods for cust_credit records</P>
-<P>
-<HR>
-<H1><A NAME="synopsis">SYNOPSIS</A></H1>
-<PRE>
- use FS::cust_credit;</PRE>
-<PRE>
- $record = new FS::cust_credit \%hash;
- $record = new FS::cust_credit { 'column' => 'value' };</PRE>
-<PRE>
- $error = $record->insert;</PRE>
-<PRE>
- $error = $new_record->replace($old_record);</PRE>
-<PRE>
- $error = $record->delete;</PRE>
-<PRE>
- $error = $record->check;</PRE>
-<P>
-<HR>
-<H1><A NAME="description">DESCRIPTION</A></H1>
-<P>An FS::cust_credit object represents a credit; the equivalent of a negative
-<STRONG>cust_bill</STRONG> record (see <A HREF=".././FS/cust_bill.html">the FS::cust_bill manpage</A>). FS::cust_credit inherits from
-FS::Record. The following fields are currently supported:</P>
-<DL>
-<DT><STRONG><A NAME="item_key">crednum - primary key (assigned automatically for new credits)</A></STRONG><BR>
-<DD>
-<DT><STRONG><A NAME="item_customer">custnum - customer (see <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>)</A></STRONG><BR>
-<DD>
-<DT><STRONG><A NAME="item_amount_%2D_amount_of_the_credit">amount - amount of the credit</A></STRONG><BR>
-<DD>
-<DT><STRONG><A NAME="item__date_%2D_specified_as_a_UNIX_timestamp%3B_see_per">_date - specified as a UNIX timestamp; see <EM>perlfunc/``time''</EM>. Also see
-<A HREF="../Time/Local.html">the Time::Local manpage</A> and <A HREF="../Date/Parse.html">the Date::Parse manpage</A> for conversion functions.</A></STRONG><BR>
-<DD>
-<DT><STRONG><A NAME="item_taker">otaker - order taker (assigned automatically, see <A HREF=".././FS/UID.html">the FS::UID manpage</A>)</A></STRONG><BR>
-<DD>
-<DT><STRONG><A NAME="item_reason_%2D_text">reason - text</A></STRONG><BR>
-<DD>
-</DL>
-<P>
-<HR>
-<H1><A NAME="methods">METHODS</A></H1>
-<DL>
-<DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
-<DD>
-Creates a new credit. To add the credit to the database, see <A HREF="#insert">insert</A>.
-<P></P>
-<DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
-<DD>
-Adds this credit to the database (``Posts'' the credit). If there is an error,
-returns the error, otherwise returns false.
-<P></P>
-<DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
-<DD>
-Currently unimplemented.
-<P></P>
-<DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
-<DD>
-Credits may not be modified; there would then be no record the credit was ever
-posted.
-<P></P>
-<DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
-<DD>
-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.
-<P></P>
-<DT><STRONG><A NAME="item_cust_refund">cust_refund</A></STRONG><BR>
-<DD>
-Returns all refunds (see <A HREF=".././FS/cust_refund.html">the FS::cust_refund manpage</A>) for this credit.
-<P></P>
-<DT><STRONG><A NAME="item_credited">credited</A></STRONG><BR>
-<DD>
-Returns the amount of this credit that is still outstanding; which is
-amount minus all refunds (see <A HREF=".././FS/cust_refund.html">the FS::cust_refund manpage</A>).
-<P></P></DL>
-<P>
-<HR>
-<H1><A NAME="version">VERSION</A></H1>
-<P>$Id: cust_credit.html,v 1.3 2001-04-23 12:40:31 ivan Exp $</P>
-<P>
-<HR>
-<H1><A NAME="bugs">BUGS</A></H1>
-<P>The delete method.</P>
-<P>
-<HR>
-<H1><A NAME="see also">SEE ALSO</A></H1>
-<P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/cust_refund.html">the FS::cust_refund manpage</A>, <A HREF=".././FS/cust_bill.html">the FS::cust_bill manpage</A>, schema.html from the base
-documentation.</P>
-
-</BODY>
-
-</HTML>
projects / freeside.git / blobdiff