htdocs/docs/man/cust_pay.txt

   1 NAME
   2     FS::cust_pay - Object methods for cust_pay objects
   3
   4 SYNOPSIS
   5       use FS::cust_pay;
   6
   7       $record = new FS::cust_pay \%hash;
   8       $record = new FS::cust_pay { 'column' => 'value' };
   9
  10       $error = $record->insert;
  11
  12       $error = $new_record->replace($old_record);
  13
  14       $error = $record->delete;
  15
  16       $error = $record->check;
  17
  18 DESCRIPTION
  19     An FS::cust_pay object represents a payment. FS::cust_pay
  20     inherits from FS::Record. The following fields are currently
  21     supported:
  22
  23     paynum - primary key (assigned automatically for new payments)
  24     invnum - Invoice (see the FS::cust_bill manpage)
  25     paid - Amount of this payment
  26     _date - specified as a UNIX timestamp; see the section on "time" in the perlfunc manpage.  Also see
  27     the Time::Local manpage and the Date::Parse manpage for conversion functions.
  28     payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
  29     payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
  30     paybatch - text field for tracking card processing
  31 METHODS
  32     new HASHREF
  33         Creates a new payment. To add the payment to the databse,
  34         see the section on "insert".
  35
  36     insert
  37         Adds this payment to the databse, and updates the invoice
  38         (see the FS::cust_bill manpage).
  39
  40     delete
  41         Currently unimplemented (accounting reasons).
  42
  43     replace OLD_RECORD
  44         Currently unimplemented (accounting reasons).
  45
  46     check
  47         Checks all fields to make sure this is a valid payment. If
  48         there is an error, returns the error, otherwise returns
  49         false. Called by the insert method.
  50
  51 VERSION
  52     $Id: cust_pay.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
  53
  54 BUGS
  55     Delete and replace methods.
  56
  57 SEE ALSO
  58     the FS::Record manpage, the FS::cust_bill manpage, schema.html
  59     from the base documentation.
  60
  61 HISTORY
  62     ivan@voicenet.com 97-jul-1 - 25 - 29
  63
  64     new api ivan@sisd.com 98-mar-13
  65
  66     pod ivan@sisd.com 98-sep-21
  67
  68     $Log: cust_pay.txt,v $
  69     Revision 1.3  1999-04-08 13:39:32  ivan
  70     convert from pod for 1.2.0 release
  71  Revision 1.3 1999/01/25 12:26:11 ivan yet
  72     more mod_perl stuff
  73
  74     Revision 1.2 1998/12/29 11:59:43 ivan mostly properly OO, some
  75     work still to be done with svc_ stuff
  76