1 package FS::bill_batch;
4 use vars qw( @ISA $me $DEBUG );
7 use FS::Record qw( qsearch qsearchs dbh );
9 use FS::cust_bill_batch;
11 @ISA = qw( FS::Record );
12 $me = '[ FS::bill_batch ]';
15 sub table { 'bill_batch' }
17 sub nohistory_fields { 'pdf' }
21 FS::bill_batch - Object methods for bill_batch records
27 $open_batch = FS::bill_batch->get_open_batch;
29 my $pdf = $open_batch->print_pdf;
31 $error = $open_batch->close;
35 An FS::bill_batch object represents a batch of invoices. FS::bill_batch
36 inherits from FS::Record. The following fields are currently supported:
40 =item batchnum - primary key
42 =item agentnum - empty for global batches or agent (see L<FS::agent>)
44 =item status - either 'O' (open) or 'R' (resolved/closed).
46 =item pdf - blob field for temporarily storing the invoice as a PDF.
56 Typeset the entire batch as a PDF file. Returns the PDF as a string.
63 $job->update_statustext(0) if $job;
64 my @invoices = sort { $a->invnum <=> $b->invnum }
65 qsearch('cust_bill_batch', { batchnum => $self->batchnum });
66 return "No invoices in batch ".$self->batchnum.'.' if !@invoices;
70 foreach my $invoice (@invoices) {
71 my $part = $invoice->cust_bill->print_pdf({$invoice->options});
72 die 'Failed creating PDF from invoice '.$invoice->invnum.'\n' if !$part;
75 $pdf_out->appendPDF(CAM::PDF->new($part));
78 $pdf_out = CAM::PDF->new($part);
83 my $error = $job->update_statustext(int(100 * $num/scalar(@invoices)));
87 $job->update_statustext(100, 'Combining invoices') if $job;
89 return $pdf_out->toPDF;
94 Set the status of the batch to 'R' (resolved).
101 return $self->replace;
108 $self->ut_numbern('batchnum')
109 || $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
110 || $self->ut_enum('status', [ 'O', 'R' ] )
112 return $error if $error;
119 Returns the agent (see L<FS::agent>) for this invoice batch.
125 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
132 =item process_print_pdf
140 sub process_print_pdf {
142 my $param = thaw(decode_base64(shift));
143 warn Dumper($param) if $DEBUG;
144 die "no batchnum specified!\n" if ! exists($param->{batchnum});
145 my $batch = FS::bill_batch->by_key($param->{batchnum});
146 die "batch '$param->{batchnum}' not found!\n" if !$batch;
148 if ( $param->{'close'} ) {
149 my $error = $batch->close;
150 die $error if $error;
153 my $pdf = $batch->print_pdf($job);
155 my $error = $batch->replace;
156 die $error if $error;
165 L<FS::Record>, schema.html from the base documentation.