NAME

FS::cust_pay - Object methods for cust_pay objects


SYNOPSIS

  use FS::cust_pay;
  $record = new FS::cust_pay \%hash;
  $record = new FS::cust_pay { 'column' => 'value' };
  $error = $record->insert;
  $error = $new_record->replace($old_record);
  $error = $record->delete;
  $error = $record->check;


DESCRIPTION

An FS::cust_pay object represents a payment; the transfer of money from a customer. FS::cust_pay inherits from FS::Record. The following fields are currently supported:

paynum - primary key (assigned automatically for new payments)
invnum - Invoice (see the FS::cust_bill manpage)
paid - Amount of this payment
_date - specified as a UNIX timestamp; see perlfunc/``time''. Also see the Time::Local manpage and the Date::Parse manpage for conversion functions.
payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
paybatch - text field for tracking card processing


METHODS

new HASHREF
Creates a new payment. To add the payment to the databse, see insert.

insert
Adds this payment to the databse, and updates the invoice (see the FS::cust_bill manpage).

delete
Currently unimplemented (accounting reasons).

replace OLD_RECORD
Currently unimplemented (accounting reasons).

check
Checks all fields to make sure this is a valid payment. If there is an error, returns the error, otherwise returns false. Called by the insert method.


VERSION

$Id: cust_pay.html,v 1.3 2001-04-23 12:40:31 ivan Exp $


BUGS

Delete and replace methods.


SEE ALSO

the FS::Record manpage, the FS::cust_bill manpage, schema.html from the base documentation.