Difference between revisions of "Freeside:3:Documentation:Developer/FS/cust bill pkg display"

Latest revision as of 13:32, 27 June 2014

NAME

FS::cust_bill_pkg_display - Object methods for cust_bill_pkg_display records

SYNOPSIS

 use FS::cust_bill_pkg_display;

 $record = new FS::cust_bill_pkg_display \%hash;
 $record = new FS::cust_bill_pkg_display { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_bill_pkg_display object represents an instruction to display a line item in a specific invoice section. FS::cust_bill_pkg_display inherits from FS::Record and is many-to-one with FS::cust_bill_pkg (invoice line items).

The following fields are currently supported:

billpkgdisplaynum - primary key; billpkgnum - the line item number (FS::cust_bill_pkg foreign key); section - the section name where this item should be shown. Defaults to the package category name, if there is one.; post_total - 'Y' to have this item shown in a "late" section (below the invoice totals).; type - Which portion of the item's charges to show in the specified position. 'S' to show setup fees (including tax and one-time charge), 'R' to show the non-usage recurring charge, 'U' to show the usage charge, null to show all three as a single amount.; summary - 'Y' to show a usage summary of this line item. This has the following effects if type = 'U': - The description will always be "Usage charges" rather than the package name. - Service labels and usage details (CDRs) are hidden. - It will only display on multisection invoices.

METHODS

new HASHREF

Creates a new line item display object. 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.

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 line item display object. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

cust_bill_pkg

Returns the associated cust_bill_pkg (see FS::cust_bill_pkg) for this line item display object.

BUGS

SEE ALSO

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