htdocs/docs/man/FS/cust_credit.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::cust_credit - Object methods for cust_credit records</TITLE>
   4 <LINK REV="made" HREF="mailto:none">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <!-- INDEX BEGIN -->
  10
  11 <UL>
  12
  13         <LI><A HREF="#NAME">NAME</A>
  14         <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
  15         <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
  16         <LI><A HREF="#METHODS">METHODS</A>
  17         <LI><A HREF="#VERSION">VERSION</A>
  18         <LI><A HREF="#BUGS">BUGS</A>
  19         <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
  20 </UL>
  21 <!-- INDEX END -->
  22
  23 <HR>
  24 <P>
  25 <H1><A NAME="NAME">NAME</A></H1>
  26 <P>
  27 FS::cust_credit - Object methods for cust_credit records
  28
  29 <P>
  30 <HR>
  31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
  32 <P>
  33 <PRE>  use FS::cust_credit;
  34 </PRE>
  35 <P>
  36 <PRE>  $record = new FS::cust_credit \%hash;
  37   $record = new FS::cust_credit { 'column' =&gt; 'value' };
  38 </PRE>
  39 <P>
  40 <PRE>  $error = $record-&gt;insert;
  41 </PRE>
  42 <P>
  43 <PRE>  $error = $new_record-&gt;replace($old_record);
  44 </PRE>
  45 <P>
  46 <PRE>  $error = $record-&gt;delete;
  47 </PRE>
  48 <P>
  49 <PRE>  $error = $record-&gt;check;
  50 </PRE>
  51 <P>
  52 <HR>
  53 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
  54 <P>
  55 An FS::cust_credit object represents a credit. FS::cust_credit inherits
  56 from FS::Record. The following fields are currently supported:
  57
  58 <DL>
  59 <DT><STRONG><A NAME="item_crednum">crednum - primary key (assigned automatically for new credits)</A></STRONG><DD>
  60 <DT><STRONG><A NAME="item_custnum">custnum - customer (see FS::cust_main)</A></STRONG><DD>
  61 <DT><STRONG><A NAME="item_amount">amount - amount of the credit</A></STRONG><DD>
  62 <DT><STRONG><A NAME="item_credited">credited - how much of this credit that is still outstanding, which is
  63 amount minus all refunds (see FS::cust_refund).</A></STRONG><DD>
  64 <DT><STRONG><A NAME="item__date">_date - specified as a UNIX timestamp; see perlfunc/&quot;time&quot;.  Also see
  65 Time::Local and Date::Parse for conversion functions.</A></STRONG><DD>
  66 <DT><STRONG><A NAME="item_otaker">otaker - order taker (assigned automatically, see FS::UID)</A></STRONG><DD>
  67 <DT><STRONG><A NAME="item_reason">reason - text</A></STRONG><DD>
  68 </DL>
  69 <P>
  70 <HR>
  71 <H1><A NAME="METHODS">METHODS</A></H1>
  72 <DL>
  73 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
  74 <P>
  75 Creates a new credit. To add the credit to the database, see <A HREF="#insert">insert</A>.
  76
  77 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
  78 <P>
  79 Adds this credit to the database (``Posts'' the credit). If there is an
  80 error, returns the error, otherwise returns false.
  81
  82 <P>
  83 When adding new invoices, credited must be amount (or null, in which case
  84 it is automatically set to amount).
  85
  86 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
  87 <P>
  88 Currently unimplemented.
  89
  90 <DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
  91 <P>
  92 Replaces the OLD_RECORD with this one in the database. If there is an
  93 error, returns the error, otherwise returns false.
  94
  95 <P>
  96 Only credited may be changed. Credited is normally updated by creating and
  97 inserting a refund (see <A HREF="../FS/cust_refund.html">FS::cust_refund</A>).
  98
  99 <DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
 100 <P>
 101 Checks all fields to make sure this is a valid credit. If there is an
 102 error, returns the error, otherwise returns false. Called by the insert and
 103 replace methods.
 104
 105 </DL>
 106 <P>
 107 <HR>
 108 <H1><A NAME="VERSION">VERSION</A></H1>
 109 <P>
 110 $Id: cust_credit.html,v 1.2 2000-03-03 18:22:42 ivan Exp $
 111
 112 <P>
 113 <HR>
 114 <H1><A NAME="BUGS">BUGS</A></H1>
 115 <P>
 116 The delete method.
 117
 118 <P>
 119 <HR>
 120 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
 121 <P>
 122 <A HREF="../FS/Record.html">FS::Record</A>, <A HREF="../FS/cust_refund.html">FS::cust_refund</A>, <A HREF="../FS/cust_bill.html">FS::cust_bill</A>, schema.html from the base documentation.
 123
 124 </BODY>
 125
 126 </HTML>