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

Latest revision as of 05:31, 10 February 2015

NAME

FS::cust_bill_pkg_discount - Object methods for cust_bill_pkg_discount records

SYNOPSIS

 use FS::cust_bill_pkg_discount;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_bill_pkg_discount object represents the slice of a customer discount applied to a specific line item. FS::cust_bill_pkg_discount inherits from FS::Record. The following fields are currently supported:

billpkgdiscountnum

primary key

billpkgnum

Line item (see FS::cust_bill_pkg)

pkgdiscountnum

Customer discount (see FS::cust_pkg_discount)

amount

Amount discounted from the line itme.

months

Number of months of discount this represents.

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.

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_pkg

Returns the associated line item (see FS::cust_bill_pkg).

cust_pkg_discount

Returns the associated customer discount (see FS::cust_pkg_discount).

description

Returns a string describing the discount (for use on an invoice).

BUGS

SEE ALSO

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