% 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_bill_pkg_void - Object methods for cust_bill_pkg_void records
use FS::cust_bill_pkg_void;
$record = new FS::cust_bill_pkg_void \%hash;
$record = new FS::cust_bill_pkg_void { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
An FS::cust_bill_pkg_void object represents a voided invoice line item. FS::cust_bill_pkg_void inherits from FS::Record. The following fields are currently supported:
primary key
invnum
pkgnum
pkgpart_override
setup
recur
sdate
edate
itemdesc
itemcomment
section
freq
quantity
unitsetup
unitrecur
hidden
freeform string (deprecated)
reason for voiding the payment (see FS::reason)
Creates a new record. To add the record to the database, see "insert".
Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
Returns the text of the associated void reason (see FS::reason) for this.
"Un-void"s this line item: Deletes the voided line item from the database and adds back a normal line item (and related tables).
Delete this record from the database.
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
Checks all fields to make sure this is a valid record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Returns the voided invoice (see FS::cust_bill_void) for this voided line item.
FS::Record, schema.html from the base documentation.