Difference between revisions of "Freeside:4:Documentation:Developer/FS/invoice mode"

Latest revision as of 07:24, 18 November 2015

NAME

FS::invoice_mode - Object methods for invoice_mode records

SYNOPSIS

 use FS::invoice_mode;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::invoice_mode object represents an invoice rendering style. FS::invoice_mode inherits from FS::Record. The following fields are currently supported:

modenum - primary key; agentnum - the agent who owns this invoice mode (can be null); modename - descriptive name for internal use

METHODS

new HASHREF

Creates a new invoice mode. To add the object 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.

invoice_conf [ LOCALE ]

Returns the FS::invoice_conf for this invoice mode, with the specified locale. If there isn't one with that locale, returns the one with null locale. If that doesn't exist, returns nothing.

agent

Returns the agent associated with this invoice mode, if any.

SEE ALSO

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