Difference between revisions of "Freeside:3:Documentation:Developer/FS/quotation pkg discount"
From Freeside
m (Edit via perl MediaWiki framework (1.13)) |
m (Edit via perl MediaWiki framework (1.13)) |
||
| Line 45: | Line 45: | ||
:Checks all fields to make sure this is a valid quotation package discount. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. | :Checks all fields to make sure this is a valid quotation package discount. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. | ||
| − | |||
| − | |||
; description | ; description | ||
:Returns a string describing the discount (for use on the quotation). | :Returns a string describing the discount (for use on the quotation). | ||
| Line 59: | Line 57: | ||
; Around line 121: | ; Around line 121: | ||
:'=item' outside of any '=over' | :'=item' outside of any '=over' | ||
| − | ; Around line | + | ; Around line 153: |
:You forgot a '=back' before '=head1' | :You forgot a '=back' before '=head1' | ||
Revision as of 08:23, 2 March 2015
NAME
FS::quotation_pkg_discount - Object methods for quotation_pkg_discount records
SYNOPSIS
use FS::quotation_pkg_discount;
$record = new FS::quotation_pkg_discount \%hash;
$record = new FS::quotation_pkg_discount { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
DESCRIPTION
An FS::quotation_pkg_discount object represents a quotation package discount. FS::quotation_pkg_discount inherits from FS::Record. The following fields are currently supported:
- quotationpkgdiscountnum
- primary key
- quotationpkgnum
- quotationpkgnum of the FS::quotation_pkg record that this discount is for.
- discountnum
- discountnum (FS::discount)
- setup_amount
- Amount that will be discounted from setup fees, per package quantity.
- recur_amount
- Amount that will be discounted from recurring fees in the first billing cycle, per package quantity.
METHODS
- new HASHREF
- Creates a new quotation package discount. To add the quotation package discount 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 quotation package discount. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
- description
- Returns a string describing the discount (for use on the quotation).
BUGS
SEE ALSO
FS::Record, schema.html from the base documentation.
POD ERRORS
Hey! The above document had some coding errors, which are explained below:
- Around line 121:
- '=item' outside of any '=over'
- Around line 153:
- You forgot a '=back' before '=head1'
