1 package FS::bill_batch;
2 use base qw(FS::Record);
5 use vars qw( $me $DEBUG );
9 $me = '[ FS::bill_batch ]';
12 sub table { 'bill_batch' }
14 sub nohistory_fields { 'pdf' }
18 FS::bill_batch - Object methods for bill_batch records
24 $open_batch = FS::bill_batch->get_open_batch;
26 my $pdf = $open_batch->print_pdf;
28 $error = $open_batch->close;
32 An FS::bill_batch object represents a batch of invoices. FS::bill_batch
33 inherits from FS::Record. The following fields are currently supported:
37 =item batchnum - primary key
39 =item agentnum - empty for global batches or agent (see L<FS::agent>)
41 =item status - either 'O' (open) or 'R' (resolved/closed).
43 =item pdf - blob field for temporarily storing the invoice as a PDF.
53 Typeset the entire batch as a PDF file. Returns the PDF as a string.
60 $job->update_statustext(0) if $job;
61 my @cust_bill_batch = sort { $a->invnum <=> $b->invnum }
62 $self->cust_bill_batch;
63 return "No invoices in batch ".$self->batchnum.'.' if !@cust_bill_batch;
65 my $conf = FS::Conf->new;
66 my $duplex = $conf->exists('invoice_print_pdf-duplex');
70 foreach my $cust_bill_batch (@cust_bill_batch) {
72 $cust_bill_batch->cust_bill->print_pdf({$cust_bill_batch->options});
73 die 'Failed creating PDF from invoice '.$cust_bill_batch->invnum.'\n'
77 $pdf_out->appendPDF(CAM::PDF->new($part));
79 $pdf_out = CAM::PDF->new($part);
82 my $n = $pdf_out->numPages;
84 # then insert a blank page so we end on an even number
85 $pdf_out->duplicatePage($n, 1);
91 my $error = $job->update_statustext(int(100 * $num/scalar(@cust_bill_batch)));
95 $job->update_statustext(100, 'Combining invoices') if $job;
97 return $pdf_out->toPDF;
102 Set the status of the batch to 'R' (resolved).
109 return $self->replace;
116 $self->ut_numbern('batchnum')
117 || $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
118 || $self->ut_enum('status', [ 'O', 'R' ] )
120 return $error if $error;
127 Returns the agent (see L<FS::agent>) for this invoice batch.
133 =item process_print_pdf
139 sub process_print_pdf {
142 warn Dumper($param) if $DEBUG;
143 die "no batchnum specified!\n" if ! exists($param->{batchnum});
144 my $batch = FS::bill_batch->by_key($param->{batchnum});
145 die "batch '$param->{batchnum}' not found!\n" if !$batch;
147 if ( $param->{'close'} ) {
148 my $error = $batch->close;
149 die $error if $error;
152 my $pdf = $batch->print_pdf($job);
154 my $error = $batch->replace;
155 die $error if $error;
164 L<FS::Record>, schema.html from the base documentation.