Difference between revisions of "Freeside:3:Documentation:Developer/FS/bill batch"
From Freeside
m (Edit via perl MediaWiki framework (1.13)) |
m (Edit via perl MediaWiki framework (1.13)) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 34: | Line 34: | ||
Hey! '''The above document had some coding errors, which are explained below:''' | Hey! '''The above document had some coding errors, which are explained below:''' | ||
| − | ; Around line | + | ; Around line 142: |
:'=item' outside of any '=over' | :'=item' outside of any '=over' | ||
Latest revision as of 09:56, 10 April 2015
NAME
FS::bill_batch - Object methods for bill_batch records
SYNOPSIS
use FS::bill_batch; $open_batch = FS::bill_batch->get_open_batch; my $pdf = $open_batch->print_pdf; $error = $open_batch->close;
DESCRIPTION
An FS::bill_batch object represents a batch of invoices. FS::bill_batch inherits from FS::Record. The following fields are currently supported:
- batchnum - primary key; agentnum - empty for global batches or agent (see FS::agent); status - either 'O' (open) or 'R' (resolved/closed).; pdf - blob field for temporarily storing the invoice as a PDF.
METHODS
- print_pdf
- Typeset the entire batch as a PDF file. Returns the PDF as a string.
- close
- Set the status of the batch to 'R' (resolved).
- agent
- Returns the agent (see FS::agent) for this invoice batch.
SUBROUTINES
- process_print_pdf
BUGS
SEE ALSO
FS::Record, schema.html from the base documentation.
POD ERRORS
Hey! The above document had some coding errors, which are explained below:
- Around line 142:
- '=item' outside of any '=over'
