Difference between revisions of "Freeside:3:Documentation:Developer/FS/cust pkg reason fee"

Latest revision as of 09:59, 10 April 2015

NAME

FS::cust_pkg_reason_fee - Object methods for cust_pkg_reason_fee records

SYNOPSIS

 use FS::cust_pkg_reason_fee;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_pkg_reason_fee object links a package status change that charged a fee (an FS::cust_pkg_reason object) to the resulting invoice line item. FS::cust_pkg_reason_fee inherits from FS::Record and FS::FeeOrigin_Mixin. The following fields are currently supported:

pkgreasonfeenum - primary key; pkgreasonnum - key of the cust_pkg_reason object that triggered the fee.; billpkgnum - key of the cust_bill_pkg record representing the fee on an invoice. This can be NULL if the fee is scheduled but hasn't been billed yet.; feepart - key of the fee definition (FS::part_fee).; nextbill - 'Y' if the fee should be charged on the customer's next bill, rather than causing a bill to be produced immediately.

METHODS

new HASHREF

Creates a new record. To add the record to the database, see "insert".

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

CLASS METHODS

_by_cust CUSTNUM[, PARAMS]

See "by cust" in FS/FeeOrigin Mixin|FS::FeeOrigin_Mixin#by_cust|"by_cust" in FS::FeeOrigin_Mixin.

METHODS

cust_pkg

Returns the package that triggered the fee.

SEE ALSO

FS::FeeOrigin_Mixin, FS::cust_pkg_reason, part_fee

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 151:

You forgot a '=back' before '=head1'