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

Revision as of 06:28, 24 March 2015

FS::bill_batch - Object methods for bill_batch records


 use FS::bill_batch;

 $open_batch = FS::bill_batch->get_open_batch;
 
 my $pdf = $open_batch->print_pdf;
 
 $error = $open_batch->close;

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.

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.

Hey! The above document had some coding errors, which are explained below:

@@ Line 34: / Line 34: @@
 Hey! '''The above document had some coding errors, which are explained below:'''
-; Around line 141&#58;
+; Around line 130&#58;
 :'=item' outside of any '=over'