4 use vars qw( @ISA $conf $invoice_template $money_char );
5 use vars qw( $invoice_lines @buf ); #yuck
8 use FS::Record qw( qsearch qsearchs );
10 use FS::cust_bill_pkg;
14 use FS::cust_credit_bill;
16 @ISA = qw( FS::Record );
18 #ask FS::UID to run this stuff for us later
19 $FS::UID::callback{'FS::cust_bill'} = sub {
23 $money_char = $conf->config('money_char') || '$';
25 my @invoice_template = $conf->config('invoice_template')
26 or die "cannot load config file invoice_template";
28 foreach ( grep /invoice_lines\(\d+\)/, @invoice_template ) { #kludgy
29 /invoice_lines\((\d+)\)/;
32 die "no invoice_lines() functions in template?" unless $invoice_lines;
33 $invoice_template = new Text::Template (
35 SOURCE => [ map "$_\n", @invoice_template ],
36 ) or die "can't create new Text::Template object: $Text::Template::ERROR";
37 $invoice_template->compile()
38 or die "can't compile template: $Text::Template::ERROR";
43 FS::cust_bill - Object methods for cust_bill records
49 $record = new FS::cust_bill \%hash;
50 $record = new FS::cust_bill { 'column' => 'value' };
52 $error = $record->insert;
54 $error = $new_record->replace($old_record);
56 $error = $record->delete;
58 $error = $record->check;
60 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
62 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
64 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
66 @cust_pay_objects = $cust_bill->cust_pay;
68 $tax_amount = $record->tax;
70 @lines = $cust_bill->print_text;
71 @lines = $cust_bill->print_text $time;
75 An FS::cust_bill object represents an invoice; a declaration that a customer
76 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
77 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
78 following fields are currently supported:
82 =item invnum - primary key (assigned automatically for new invoices)
84 =item custnum - customer (see L<FS::cust_main>)
86 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
87 L<Time::Local> and L<Date::Parse> for conversion functions.
89 =item charged - amount of this invoice
91 =item printed - how many times this invoice has been printed automatically
92 (see L<FS::cust_main/"collect">).
102 Creates a new invoice. To add the invoice to the database, see L<"insert">.
103 Invoices are normally created by calling the bill method of a customer object
104 (see L<FS::cust_main>).
108 sub table { 'cust_bill'; }
112 Adds this invoice to the database ("Posts" the invoice). If there is an error,
113 returns the error, otherwise returns false.
117 Currently unimplemented. I don't remove invoices because there would then be
118 no record you ever posted this invoice (which is bad, no?)
123 return "Can't remove invoice!"
126 =item replace OLD_RECORD
128 Replaces the OLD_RECORD with this one in the database. If there is an error,
129 returns the error, otherwise returns false.
131 Only printed may be changed. printed is normally updated by calling the
132 collect method of a customer object (see L<FS::cust_main>).
137 my( $new, $old ) = ( shift, shift );
138 return "Can't change custnum!" unless $old->custnum == $new->custnum;
139 #return "Can't change _date!" unless $old->_date eq $new->_date;
140 return "Can't change _date!" unless $old->_date == $new->_date;
141 return "Can't change charged!" unless $old->charged == $new->charged;
143 $new->SUPER::replace($old);
148 Checks all fields to make sure this is a valid invoice. If there is an error,
149 returns the error, otherwise returns false. Called by the insert and replace
158 $self->ut_numbern('invnum')
159 || $self->ut_number('custnum')
160 || $self->ut_numbern('_date')
161 || $self->ut_money('charged')
162 || $self->ut_numbern('printed')
164 return $error if $error;
166 return "Unknown customer"
167 unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
169 $self->_date(time) unless $self->_date;
171 $self->printed(0) if $self->printed eq '';
178 Returns a list consisting of the total previous balance for this customer,
179 followed by the previous outstanding invoices (as FS::cust_bill objects also).
186 my @cust_bill = sort { $a->_date <=> $b->_date }
187 grep { $_->owed != 0 && $_->_date < $self->_date }
188 qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
190 foreach ( @cust_bill ) { $total += $_->owed; }
196 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
202 qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum } );
207 Depreciated. See the cust_credited method.
209 #Returns a list consisting of the total previous credited (see
210 #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
211 #outstanding credits (FS::cust_credit objects).
217 croak "FS::cust_bill->cust_credit depreciated; see ".
218 "FS::cust_bill->cust_credit_bill";
221 #my @cust_credit = sort { $a->_date <=> $b->_date }
222 # grep { $_->credited != 0 && $_->_date < $self->_date }
223 # qsearch('cust_credit', { 'custnum' => $self->custnum } )
225 #foreach (@cust_credit) { $total += $_->credited; }
226 #$total, @cust_credit;
231 Depreciated. See the cust_bill_pay method.
233 #Returns all payments (see L<FS::cust_pay>) for this invoice.
239 croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
241 #sort { $a->_date <=> $b->_date }
242 # qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
248 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
254 sort { $a->_date <=> $b->date }
255 qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
260 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
266 sort { $a->_date <=> $b->_date }
267 qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
273 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
280 my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
282 foreach (@taxlines) { $total += $_->setup; }
288 Returns the amount owed (still outstanding) on this invoice, which is charged
289 minus all payment applications (see L<FS::cust_bill_pay>) and credit
290 applications (see L<FS::cust_credit_bill>).
296 my $balance = $self->charged;
297 $balance -= $_->amount foreach ( $self->cust_bill_pay );
298 $balance -= $_->amount foreach ( $self->cust_credited );
299 $balance = sprintf( "%.2f", $balance);
302 =item print_text [TIME];
304 Returns an text invoice, as a list of lines.
306 TIME an optional value used to control the printing of overdue messages. The
307 default is now. It isn't the date of the invoice; that's the `_date' field.
308 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
309 L<Time::Local> and L<Date::Parse> for conversion functions.
315 my( $self, $today ) = ( shift, shift );
317 # my $invnum = $self->invnum;
318 my $cust_main = qsearchs('cust_main', { 'custnum', $self->custnum } );
319 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
320 unless $cust_main->payname;
322 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
323 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
324 #my $balance_due = $self->owed + $pr_total - $cr_total;
325 my $balance_due = $self->owed + $pr_total;
328 #my($description,$amount);
332 foreach ( @pr_cust_bill ) {
334 "Previous Balance, Invoice #". $_->invnum.
335 " (". time2str("%x",$_->_date). ")",
336 $money_char. sprintf("%10.2f",$_->owed)
340 push @buf,['','-----------'];
341 push @buf,[ 'Total Previous Balance',
342 $money_char. sprintf("%10.2f",$pr_total ) ];
347 foreach ( $self->cust_bill_pkg ) {
351 my($cust_pkg)=qsearchs('cust_pkg', { 'pkgnum', $_->pkgnum } );
352 my($part_pkg)=qsearchs('part_pkg',{'pkgpart'=>$cust_pkg->pkgpart});
353 my($pkg)=$part_pkg->pkg;
355 if ( $_->setup != 0 ) {
356 push @buf, [ "$pkg Setup", $money_char. sprintf("%10.2f",$_->setup) ];
358 map { [ " ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
361 if ( $_->recur != 0 ) {
363 "$pkg (" . time2str("%x",$_->sdate) . " - " .
364 time2str("%x",$_->edate) . ")",
365 $money_char. sprintf("%10.2f",$_->recur)
368 map { [ " ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
372 push @buf,["Tax", $money_char. sprintf("%10.2f",$_->setup) ]
377 push @buf,['','-----------'];
378 push @buf,['Total New Charges',
379 $money_char. sprintf("%10.2f",$self->charged) ];
382 push @buf,['','-----------'];
383 push @buf,['Total Charges',
384 $money_char. sprintf("%10.2f",$self->charged + $pr_total) ];
388 foreach ( $self->cust_credited ) {
390 #something more elaborate if $_->amount ne $_->cust_credit->credited ?
393 "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")",
394 $money_char. sprintf("%10.2f",$_->amount)
397 #foreach ( @cr_cust_credit ) {
399 # "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
400 # $money_char. sprintf("%10.2f",$_->credited)
404 #get & print payments
405 foreach ( $self->cust_bill_pay ) {
407 #something more elaborate if $_->amount ne ->cust_pay->paid ?
410 "Payment received ". time2str("%x",$_->cust_pay->_date ),
411 $money_char. sprintf("%10.2f",$_->amount )
416 push @buf,['','-----------'];
417 push @buf,['Balance Due', $money_char.
418 sprintf("%10.2f", $balance_due ) ];
420 #setup template variables
422 package FS::cust_bill::_template; #!
423 use vars qw( $invnum $date $page $total_pages @address $overdue @buf );
425 $invnum = $self->invnum;
426 $date = $self->_date;
430 int( scalar(@FS::cust_bill::buf) / $FS::cust_bill::invoice_lines );
432 if scalar(@FS::cust_bill::buf) % $FS::cust_bill::invoice_lines;
435 #format address (variable for the template)
437 @address = ( '', '', '', '', '', '' );
438 package FS::cust_bill; #!
439 $FS::cust_bill::_template::address[$l++] =
441 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
442 ? " (P.O. #". $cust_main->payinfo. ")"
446 $FS::cust_bill::_template::address[$l++] = $cust_main->company
447 if $cust_main->company;
448 $FS::cust_bill::_template::address[$l++] = $cust_main->address1;
449 $FS::cust_bill::_template::address[$l++] = $cust_main->address2
450 if $cust_main->address2;
451 $FS::cust_bill::_template::address[$l++] =
452 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
453 $FS::cust_bill::_template::address[$l++] = $cust_main->country
454 unless $cust_main->country eq 'US';
456 #overdue? (variable for the template)
457 $FS::cust_bill::_template::overdue = (
459 && $today > $self->_date
460 # && $self->printed > 1
461 && $self->printed > 0
464 #and subroutine for the template
466 sub FS::cust_bill::_template::invoice_lines {
469 scalar(@buf) ? shift @buf : [ '', '' ];
474 $FS::cust_bill::_template::page = 1;
478 push @collect, split("\n",
479 $invoice_template->fill_in( PACKAGE => 'FS::cust_bill::_template' )
481 $FS::cust_bill::_template::page++;
484 map "$_\n", @collect;
492 $Id: cust_bill.pm,v 1.11 2001-09-03 22:07:38 ivan Exp $
498 print_text formatting (and some logic :/) is in source, but needs to be
499 slurped in from a file. Also number of lines ($=).
501 missing print_ps for a nice postscript copy (maybe HylaFAX-cover-page-style
502 or something similar so the look can be completely customized?)
506 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS:;cust_pay>,
507 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base