3 <TITLE>FS::cust_refund - Object method for cust_refund objects</TITLE>
4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
9 <A NAME="__index__"></A>
14 <LI><A HREF="#name">NAME</A></LI>
15 <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
16 <LI><A HREF="#description">DESCRIPTION</A></LI>
17 <LI><A HREF="#methods">METHODS</A></LI>
18 <LI><A HREF="#version">VERSION</A></LI>
19 <LI><A HREF="#bugs">BUGS</A></LI>
20 <LI><A HREF="#see also">SEE ALSO</A></LI>
26 <H1><A NAME="name">NAME</A></H1>
27 <P>FS::cust_refund - Object method for cust_refund objects</P>
30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
32 use FS::cust_refund;</PRE>
34 $record = new FS::cust_refund \%hash;
35 $record = new FS::cust_refund { 'column' => 'value' };</PRE>
37 $error = $record->insert;</PRE>
39 $error = $new_record->replace($old_record);</PRE>
41 $error = $record->delete;</PRE>
43 $error = $record->check;</PRE>
46 <H1><A NAME="description">DESCRIPTION</A></H1>
47 <P>An FS::cust_refund represents a refund: the transfer of money to a customer;
48 equivalent to a negative payment (see <A HREF=".././FS/cust_pay.html">the FS::cust_pay manpage</A>). FS::cust_refund
49 inherits from FS::Record. The following fields are currently supported:</P>
51 <DT><STRONG><A NAME="item_key">refundnum - primary key (assigned automatically for new refunds)</A></STRONG><BR>
53 <DT><STRONG><A NAME="item_customer">custnum - customer (see <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>)</A></STRONG><BR>
55 <DT><STRONG><A NAME="item_refund_%2D_Amount_of_the_refund">refund - Amount of the refund</A></STRONG><BR>
57 <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
58 <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>
60 <DT><STRONG><A NAME="item_payby_%2D_%60CARD%27_%28credit_cards%29%2C_%60BILL">payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)</A></STRONG><BR>
62 <DT><STRONG><A NAME="item_issuer">payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)</A></STRONG><BR>
64 <DT><STRONG><A NAME="item_paybatch_%2D_text_field_for_tracking_card_processi">paybatch - text field for tracking card processing</A></STRONG><BR>
66 <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>
68 <DT><STRONG><A NAME="item_closed_%2D_books_closed_flag%2C_empty_or_%60Y%27">closed - books closed flag, empty or `Y'</A></STRONG><BR>
73 <H1><A NAME="methods">METHODS</A></H1>
75 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
77 Creates a new refund. To add the refund to the database, see <A HREF="#insert">insert</A>.
79 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
81 Adds this refund to the database.
82 <P>For backwards-compatibility and convenience, if the additional field crednum is
83 defined, an FS::cust_credit_refund record for the full amount of the refund
84 will be created. In this case, custnum is optional.</P>
86 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
88 Currently unimplemented (accounting reasons).
90 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
92 Currently unimplemented (accounting reasons).
94 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
96 Checks all fields to make sure this is a valid refund. If there is an error,
97 returns the error, otherwise returns false. Called by the insert method.
101 <H1><A NAME="version">VERSION</A></H1>
102 <P>$Id: cust_refund.html,v 1.3 2002-01-29 17:42:46 ivan Exp $</P>
105 <H1><A NAME="bugs">BUGS</A></H1>
106 <P>Delete and replace methods.</P>
109 <H1><A NAME="see also">SEE ALSO</A></H1>
110 <P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/cust_credit.html">the FS::cust_credit manpage</A>, schema.html from the base documentation.</P>