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)
custnum - customer (see the FS::cust_main 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, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
paybatch - text field for tracking card processing
closed - books closed flag, empty or `Y'

METHODS

new HASHREF

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

insert

Adds this payment to the database.

For backwards-compatibility and convenience, if the additional field invnum is defined, an FS::cust_bill_pay record for the full amount of the payment will be created. In this case, custnum is optional.

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.

cust_bill_pay

Returns all applications to invoices (see the FS::cust_bill_pay manpage) for this payment.

unapplied

Returns the amount of this payment that is still unapplied; which is paid minus all payment applications (see the FS::cust_bill_pay manpage).

VERSION

$Id: cust_pay.html,v 1.2 2002-01-29 16:33:15 ivan Exp $

BUGS