Freeside:4:Documentation:Developer/FS/cust credit source bill pkg

NAME

FS::cust_credit_source_bill_pkg - Object methods for cust_credit_source_bill_pkg records

SYNOPSIS

 use FS::cust_credit_source_bill_pkg;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_credit_source_bill_pkg object represents the record that a credit was triggered by a specific line item. FS::cust_credit_source_bill_pkg inherits from FS::Record. The following fields are currently supported:

creditsourcebillpkgnum

Primary key

crednum

Credit (see FS::cust_credit)

billpkgnum

Line item (see FS::cust_bill_pkg)

amount

Amount specific to this line item.

currency

Currency

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.

BUGS

Terminology/documentation surrounding credit "sources" vs. credit "applications" is hard to understand.

SEE ALSO

FS::cust_credit, FS::cust_bill_pkg, FS::Record