% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>
FS::cust_pay_void - Object methods for cust_pay_void objects
use FS::cust_pay_void;
$record = new FS::cust_pay_void \%hash;
$record = new FS::cust_pay_void { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
An FS::cust_pay_void object represents a voided payment. The following fields are currently supported:
primary key (assigned automatically for new payments)
customer (see FS::cust_main)
Amount of this payment
specified as a UNIX timestamp; see "time" in perlfunc. Also see Time::Local and Date::Parse for conversion functions.
order taker (see FS::access_user)
Payment Type (See FS::payinfo_Mixin for valid values)
card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
Credit card type, if appropriate.
text field for tracking card processing
books closed flag, empty or `Y'
Desired pkgnum when using experimental package balances.
Creates a new payment. To add the payment to the databse, see "insert".
Adds this voided payment to the database.
"Un-void"s this payment: Deletes the voided payment from the database and adds back a normal payment.
Deletes this voided payment. You probably don't want to use this directly; see the unvoid method to add the original payment back.
You can, but probably shouldn't modify voided payments...
Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not supplied, replaces this record. If there is an error, returns the error, otherwise returns false.
Checks all fields to make sure this is a valid voided payment. If there is an error, returns the error, otherwise returns false. Called by the insert method.
Returns the parent customer object (see FS::cust_main).
Returns the voiding employee object (see FS::access_user).
Returns the text of the associated void reason (see FS::reason) for this.
Delete and replace methods.
FS::cust_pay, FS::Record, schema.html from the base documentation.