% 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_event - Object methods for cust_bill_event records
use FS::cust_bill_event;
$record = new FS::cust_bill_event \%hash;
$record = new FS::cust_bill_event { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
An FS::cust_bill_event object represents an complete invoice event. FS::cust_bill_event inherits from FS::Record. The following fields are currently supported:
Primary key
Invoice (see FS::cust_bill)
Event definition (see FS::part_bill_event)
Specified as a UNIX timestamp; see "time" in perlfunc. Also see Time::Local and Date::Parse for conversion functions.
Event status: done or failed
Additional status detail (i.e. error message)
Creates a new completed invoice event. To add the compelted invoice event 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.
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 completed invoice event. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Returns the invoice event definition (see FS::part_bill_event) for this completed invoice event.
Returns the invoice (see FS::cust_bill) for this completed invoice event.
Changes the status of this event from done to failed, allowing it to be retried.
Changes the statustext of this event to retriable, rendering it retriable (should retry be called).
Class method which returns an SQL WHERE fragment to search for parameters specified in HASHREF. Valid parameters are
An epoch date setting a lower bound for _date values
An epoch date setting a upper bound for _date values
Limits the search to failed events if true
Requires that the search be JOIN'd to part_bill_event # Bug?
Specifies the user for agent virtualization
Far too early in the morning.
FS::part_bill_event, FS::cust_bill, FS::Record, schema.html from the base documentation.