Difference between revisions of "Freeside:3:Documentation:Developer/FS/cust main credit limit"

Latest revision as of 13:33, 27 June 2014

NAME

FS::cust_main_credit_limit - Object methods for cust_main_credit_limit records

SYNOPSIS

 use FS::cust_main_credit_limit;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_main_credit_limit object represents a specific incident where a customer exceeds their credit limit. FS::cust_main_credit_limit inherits from FS::Record. The following fields are currently supported:

creditlimitnum

primary key

custnum

Customer (see FS::cust_main)

_date

Ppecified as a UNIX timestamp; see "time" in perlfunc. Also see Time::Local and Date::Parse for conversion functions.

amount

Amount of credit of the incident

credit_limit

Appliable customer or default credit_limit at the time of the incident

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

SEE ALSO

FS::Record