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

Revision as of 13:35, 27 June 2014

NAME

FS::invoice_conf - Object methods for invoice_conf records

SYNOPSIS

 use FS::invoice_conf;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::invoice_conf object represents a set of localized invoice configuration values. FS::invoice_conf inherits from FS::Record and FS::Conf, and supports the FS::Conf interface. The following fields are supported:

confnum - primary key; modenum - FS::invoice_mode foreign key; locale - locale string (see FS::Locales); notice_name - the title to display on the invoice; subject - subject line of the email; htmlnotes - "notes" section (HTML); htmlfooter - footer (HTML); htmlsummary - summary header, for invoices in summary format (HTML); htmlreturnaddress - return address (HTML); latexnotes - "notes" section (LaTeX); latexfooter - footer (LaTeX); latexsummary - summary header, for invoices in summary format (LaTeX); latexreturnaddress - return address (LaTeX); latexsmallfooter - footer for pages after the first (LaTeX); with_latexcoupon - 'Y' to print the payment coupon (LaTeX); lpr - command to print the invoice (passed on stdin as a PDF)

METHODS

new HASHREF

Creates a new invoice configuration. To add it to the database, see "insert".

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.

SEE ALSO

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