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;
15 @ISA = qw( FS::Record );
17 #ask FS::UID to run this stuff for us later
18 $FS::UID::callback{'FS::cust_bill'} = sub {
22 $money_char = $conf->config('money_char') || '$';
24 my @invoice_template = $conf->config('invoice_template')
25 or die "cannot load config file invoice_template";
27 foreach ( grep /invoice_lines\(\d+\)/, @invoice_template ) { #kludgy
28 /invoice_lines\((\d+)\)/;
31 die "no invoice_lines() functions in template?" unless $invoice_lines;
32 $invoice_template = new Text::Template (
34 SOURCE => [ map "$_\n", @invoice_template ],
35 ) or die "can't create new Text::Template object: $Text::Template::ERROR";
36 $invoice_template->compile()
37 or die "can't compile template: $Text::Template::ERROR";
42 FS::cust_bill - Object methods for cust_bill records
48 $record = new FS::cust_bill \%hash;
49 $record = new FS::cust_bill { 'column' => 'value' };
51 $error = $record->insert;
53 $error = $new_record->replace($old_record);
55 $error = $record->delete;
57 $error = $record->check;
59 ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
61 @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
63 ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
65 @cust_pay_objects = $cust_bill->cust_pay;
67 @lines = $cust_bill->print_text;
68 @lines = $cust_bill->print_text $time;
72 An FS::cust_bill object represents an invoice; a declaration that a customer
73 owes you money. The specific charges are itemized as B<cust_bill_pkg> records
74 (see L<FS::cust_bill_pkg>). FS::cust_bill inherits from FS::Record. The
75 following fields are currently supported:
79 =item invnum - primary key (assigned automatically for new invoices)
81 =item custnum - customer (see L<FS::cust_main>)
83 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
84 L<Time::Local> and L<Date::Parse> for conversion functions.
86 =item charged - amount of this invoice
88 =item owed - amount still outstanding on this invoice, which is charged minus
89 all payments (see L<FS::cust_pay>).
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.
115 When adding new invoices, owed must be charged (or null, in which case it is
116 automatically set to charged).
123 $self->owed( $self->charged ) if $self->owed eq '';
124 return "owed != charged!"
125 unless $self->owed == $self->charged;
127 $self->SUPER::insert;
132 Currently unimplemented. I don't remove invoices because there would then be
133 no record you ever posted this invoice (which is bad, no?)
138 return "Can't remove invoice!"
141 =item replace OLD_RECORD
143 Replaces the OLD_RECORD with this one in the database. If there is an error,
144 returns the error, otherwise returns false.
146 Only owed and printed may be changed. Owed is normally updated by creating and
147 inserting a payment (see L<FS::cust_pay>). Printed is normally updated by
148 calling the collect method of a customer object (see L<FS::cust_main>).
153 my( $new, $old ) = ( shift, shift );
154 return "Can't change custnum!" unless $old->custnum == $new->custnum;
155 #return "Can't change _date!" unless $old->_date eq $new->_date;
156 return "Can't change _date!" unless $old->_date == $new->_date;
157 return "Can't change charged!" unless $old->charged == $new->charged;
158 return "(New) owed can't be > (new) charged!" if $new->owed > $new->charged;
160 $new->SUPER::replace($old);
165 Checks all fields to make sure this is a valid invoice. If there is an error,
166 returns the error, otherwise returns false. Called by the insert and replace
175 $self->ut_numbern('invnum')
176 || $self->ut_number('custnum')
177 || $self->ut_numbern('_date')
178 || $self->ut_money('charged')
179 || $self->ut_money('owed')
180 || $self->ut_numbern('printed')
182 return $error if $error;
184 return "Unknown customer"
185 unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
187 $self->_date(time) unless $self->_date;
189 $self->printed(0) if $self->printed eq '';
196 Returns a list consisting of the total previous balance for this customer,
197 followed by the previous outstanding invoices (as FS::cust_bill objects also).
204 my @cust_bill = sort { $a->_date <=> $b->_date }
205 grep { $_->owed != 0 && $_->_date < $self->_date }
206 qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
208 foreach ( @cust_bill ) { $total += $_->owed; }
214 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
220 qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum } );
225 Returns a list consisting of the total previous credited (see
226 L<FS::cust_credit>) for this customer, followed by the previous outstanding
227 credits (FS::cust_credit objects).
234 my @cust_credit = sort { $a->_date <=> $b->_date }
235 grep { $_->credited != 0 && $_->_date < $self->_date }
236 qsearch('cust_credit', { 'custnum' => $self->custnum } )
238 foreach (@cust_credit) { $total += $_->credited; }
239 $total, @cust_credit;
244 Returns all payments (see L<FS::cust_pay>) for this invoice.
250 sort { $a->_date <=> $b->_date }
251 qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
255 =item print_text [TIME];
257 Returns an text invoice, as a list of lines.
259 TIME an optional value used to control the printing of overdue messages. The
260 default is now. It isn't the date of the invoice; that's the `_date' field.
261 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
262 L<Time::Local> and L<Date::Parse> for conversion functions.
268 my( $self, $today ) = ( shift, shift );
270 # my $invnum = $self->invnum;
271 my $cust_main = qsearchs('cust_main', { 'custnum', $self->custnum } );
272 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
273 unless $cust_main->payname;
275 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
276 my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
277 my $balance_due = $self->owed + $pr_total - $cr_total;
282 #my($description,$amount);
286 foreach ( @pr_cust_bill ) {
288 "Previous Balance, Invoice #". $_->invnum.
289 " (". time2str("%x",$_->_date). ")",
290 $money_char. sprintf("%10.2f",$_->owed)
294 push @buf,['','-----------'];
295 push @buf,[ 'Total Previous Balance',
296 $money_char. sprintf("%10.2f",$pr_total ) ];
301 foreach ( $self->cust_bill_pkg ) {
305 my($cust_pkg)=qsearchs('cust_pkg', { 'pkgnum', $_->pkgnum } );
306 my($part_pkg)=qsearchs('part_pkg',{'pkgpart'=>$cust_pkg->pkgpart});
307 my($pkg)=$part_pkg->pkg;
309 if ( $_->setup != 0 ) {
310 push @buf, [ "$pkg Setup", $money_char. sprintf("%10.2f",$_->setup) ];
312 map { [ " ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
315 if ( $_->recur != 0 ) {
317 "$pkg (" . time2str("%x",$_->sdate) . " - " .
318 time2str("%x",$_->edate) . ")",
319 $money_char. sprintf("%10.2f",$_->recur)
322 map { [ " ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
326 push @buf,["Tax", $money_char. sprintf("%10.2f",$_->setup) ]
331 push @buf,['','-----------'];
332 push @buf,['Total New Charges',
333 $money_char. sprintf("%10.2f",$self->charged) ];
336 push @buf,['','-----------'];
337 push @buf,['Total Charges',
338 $money_char. sprintf("%10.2f",$self->charged + $pr_total) ];
342 foreach ( @cr_cust_credit ) {
344 "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
345 $money_char. sprintf("%10.2f",$_->credited)
349 #get & print payments
350 foreach ( $self->cust_pay ) {
352 "Payment received ". time2str("%x",$_->_date ),
353 $money_char. sprintf("%10.2f",$_->paid )
358 push @buf,['','-----------'];
359 push @buf,['Balance Due', $money_char.
360 sprintf("%10.2f",$self->owed + $pr_total - $cr_total ) ];
362 #setup template variables
364 package FS::cust_bill::_template; #!
365 use vars qw( $invnum $date $page $total_pages @address $overdue @buf );
367 $invnum = $self->invnum;
368 $date = $self->_date;
372 int( scalar(@FS::cust_bill::buf) / $FS::cust_bill::invoice_lines );
374 if scalar(@FS::cust_bill::buf) % $FS::cust_bill::invoice_lines;
377 #format address (variable for the template)
379 @address = ( '', '', '', '', '', '' );
380 package FS::cust_bill; #!
381 $FS::cust_bill::_template::address[$l++] =
383 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
384 ? " (P.O. #". $cust_main->payinfo. ")"
388 $FS::cust_bill::_template::address[$l++] = $cust_main->company
389 if $cust_main->company;
390 $FS::cust_bill::_template::address[$l++] = $cust_main->address1;
391 $FS::cust_bill::_template::address[$l++] = $cust_main->address2
392 if $cust_main->address2;
393 $FS::cust_bill::_template::address[$l++] =
394 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
395 $FS::cust_bill::_template::address[$l++] = $cust_main->country
396 unless $cust_main->country eq 'US';
398 #overdue? (variable for the template)
399 $FS::cust_bill::_template::overdue = (
401 && $today > $self->_date
402 # && $self->printed > 1
403 && $self->printed > 0
406 #and subroutine for the template
408 sub FS::cust_bill::_template::invoice_lines {
411 scalar(@buf) ? shift @buf : [ '', '' ];
416 $FS::cust_bill::_template::page = 1;
420 push @collect, split("\n",
421 $invoice_template->fill_in( PACKAGE => 'FS::cust_bill::_template' )
423 $FS::cust_bill::_template::page++;
426 map "$_\n", @collect;
434 $Id: cust_bill.pm,v 1.6 2001-03-30 17:33:52 ivan Exp $
440 print_text formatting (and some logic :/) is in source, but needs to be
441 slurped in from a file. Also number of lines ($=).
443 missing print_ps for a nice postscript copy (maybe HylaFAX-cover-page-style
444 or something similar so the look can be completely customized?)
448 L<FS::Record>, L<FS::cust_main>, L<FS::cust_pay>, L<FS::cust_bill_pkg>,
449 L<FS::cust_credit>, schema.html from the base documentation.