Difference between revisions of "Freeside:3:Documentation:Developer/FS/quotation"

Revision as of 14:38, 27 June 2014

NAME

FS::quotation - Object methods for quotation records

SYNOPSIS

 use FS::quotation;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::quotation object represents a quotation. FS::quotation inherits from FS::Record. The following fields are currently supported:

quotationnum

primary key

prospectnum

prospectnum

custnum

custnum

_date

_date

disabled

disabled

usernum

usernum

METHODS

new HASHREF

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

prospect_main; cust_main; cust_bill_pkg; total_setup; total_recur [ FREQ ]; enable_previous

CLASS METHODS

search_sql_where HASHREF

Class method which returns an SQL WHERE fragment to search for parameters specified in HASHREF. Valid parameters are

_date

List reference of start date, end date, as UNIX timestamps.

invnum_min

; invnum_max:; agentnum:; charged

List reference of charged limits (exclusive).

owed

List reference of charged limits (exclusive).

open

flag, return open invoices only

net

flag, return net invoices only

days

; newest_percust

Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.

BUGS

SEE ALSO

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