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

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
m (Edit via perl MediaWiki framework (1.13))
 
Line 1: Line 1:
 +
==NAME==
 +
FS::cust_bill_pkg_discount_void - Object methods for cust_bill_pkg_discount_void records
  
 +
==SYNOPSIS==
 +
<code>
 +
  use FS::cust_bill_pkg_discount_void;
 +
 +
  $record = new FS::cust_bill_pkg_discount_void \%hash;
 +
  $record = new FS::cust_bill_pkg_discount_void { 'column' => 'value' };
 +
 +
  $error = $record->insert;
 +
 +
  $error = $new_record->replace($old_record);
 +
 +
  $error = $record->delete;
 +
 +
  $error = $record->check;
 +
</code>
 +
==DESCRIPTION==
 +
An FS::cust_bill_pkg_discount_void object represents the slice of a customer discount applied to a specific voided line item. FS::cust_bill_pkg_discount_void inherits from FS::Record. The following fields are currently supported:
 +
 +
; billpkgdiscountnum
 +
:primary key
 +
; billpkgnum
 +
:billpkgnum
 +
; pkgdiscountnum
 +
:pkgdiscountnum
 +
; amount
 +
:amount
 +
; months
 +
:months
 +
 +
==METHODS==
 +
; new HASHREF
 +
:Creates a new example. To add the example to the database, see [[#insert|"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 example. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
 +
 +
==BUGS==
 +
==SEE ALSO==
 +
[[Freeside:3:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.

Latest revision as of 05:31, 10 February 2015

NAME

FS::cust_bill_pkg_discount_void - Object methods for cust_bill_pkg_discount_void records

SYNOPSIS

 use FS::cust_bill_pkg_discount_void;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

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

billpkgdiscountnum
primary key
billpkgnum
billpkgnum
pkgdiscountnum
pkgdiscountnum
amount
amount
months
months

METHODS

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

BUGS

SEE ALSO

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

Retrieved from "http://freeside.biz/mediawiki/index.php?title=Freeside:3:Documentation:Developer/FS/cust_bill_pkg_discount_void&oldid=8355"