Freeside:4:Documentation:Developer/FS/cust bill pkg void

From Freeside
< Freeside:4:Documentation:Developer‎ | FS
Revision as of 07:19, 18 November 2015 by Jeremyd (talk | contribs) (Edit via perl MediaWiki framework (1.13))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

NAME

FS::cust_bill_pkg_void - Object methods for cust_bill_pkg_void records

SYNOPSIS

 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;

DESCRIPTION

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:

billpkgnum
primary key
invnum
invnum
pkgnum
pkgnum
pkgpart_override
pkgpart_override
setup
setup
recur
recur
sdate
sdate
edate
edate
itemdesc
itemdesc
itemcomment
itemcomment
section
section
freq
freq
quantity
quantity
unitsetup
unitsetup
unitrecur
unitrecur
hidden
hidden
reason
freeform string (deprecated)
reasonnum
reason for voiding the payment (see FS::reson)

METHODS

new HASHREF
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.
insert
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
reason
Returns the text of the associated void reason (see FS::reason) for this.
unvoid
"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
Delete this record from the database.
replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
check
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.
cust_bill
Returns the voided invoice (see FS::cust_bill_void) for this voided line item.

BUGS

SEE ALSO

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