htdocs/docs/man/FS/cust_refund.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::cust_refund - Object method for cust_refund objects</TITLE>
   4 <LINK REV="made" HREF="mailto:ivan@rootwood.sisd.com">
   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_refund - Object method for cust_refund objects
  28
  29 <P>
  30 <HR>
  31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
  32 <P>
  33 <PRE>  use FS::cust_refund;
  34 </PRE>
  35 <P>
  36 <PRE>  $record = new FS::cust_refund \%hash;
  37   $record = new FS::cust_refund { '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_refund represents a refund. FS::cust_refund inherits from
  56 FS::Record. The following fields are currently supported:
  57
  58 <DL>
  59 <DT><STRONG><A NAME="item_refundnum">refundnum - primary key (assigned automatically for new refunds)</A></STRONG><DD>
  60 <DT><STRONG><A NAME="item_crednum">crednum - Credit (see FS::cust_credit)</A></STRONG><DD>
  61 <DT><STRONG><A NAME="item_refund">refund - Amount of the refund</A></STRONG><DD>
  62 <DT><STRONG><A NAME="item__date">_date - specified as a UNIX timestamp; see perlfunc/&quot;time&quot;.  Also see
  63 Time::Local and Date::Parse for conversion functions.</A></STRONG><DD>
  64 <DT><STRONG><A NAME="item_payby">payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)</A></STRONG><DD>
  65 <DT><STRONG><A NAME="item_payinfo">payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)</A></STRONG><DD>
  66 <DT><STRONG><A NAME="item_otaker">otaker - order taker (assigned automatically, see FS::UID)</A></STRONG><DD>
  67 </DL>
  68 <P>
  69 <HR>
  70 <H1><A NAME="METHODS">METHODS</A></H1>
  71 <DL>
  72 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
  73 <P>
  74 Creates a new refund. To add the refund to the database, see <A HREF="#insert">insert</A>.
  75
  76 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
  77 <P>
  78 Adds this refund to the database, and updates the credit (see
  79 <A HREF="../FS/cust_credit.html">FS::cust_credit</A>).
  80
  81 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
  82 <P>
  83 Currently unimplemented (accounting reasons).
  84
  85 <DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
  86 <P>
  87 Currently unimplemented (accounting reasons).
  88
  89 <DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
  90 <P>
  91 Checks all fields to make sure this is a valid refund. If there is an
  92 error, returns the error, otherwise returns false. Called by the insert
  93 method.
  94
  95 </DL>
  96 <P>
  97 <HR>
  98 <H1><A NAME="VERSION">VERSION</A></H1>
  99 <P>
 100 $Id: cust_refund.html,v 1.1 1999-08-04 12:13:27 ivan Exp $
 101
 102 <P>
 103 <HR>
 104 <H1><A NAME="BUGS">BUGS</A></H1>
 105 <P>
 106 Delete and replace methods.
 107
 108 <P>
 109 <HR>
 110 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
 111 <P>
 112 <A HREF="../FS/Record.html">FS::Record</A>, <A HREF="../FS/cust_credit.html">FS::cust_credit</A>, schema.html from the base documentation.
 113
 114 </BODY>
 115
 116 </HTML>