X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fcust_bill.pm;h=8480ceadc3f5c854efe1fafb5195505bcfa5d2ec;hb=4dba303c1989638060b9c76941f5e72fd35c4dd5;hp=568f272aaa4403e2204e2d41e425d44f483a70d0;hpb=3a95cc316da367ffd248ba29ac594f3efbc9db61;p=freeside.git diff --git a/FS/FS/cust_bill.pm b/FS/FS/cust_bill.pm index 568f272aa..8480ceadc 100644 --- a/FS/FS/cust_bill.pm +++ b/FS/FS/cust_bill.pm @@ -1,7 +1,7 @@ package FS::cust_bill; use strict; -use vars qw( @ISA $conf $invoice_template ); +use vars qw( @ISA $conf $invoice_template $money_char ); use vars qw( $invoice_lines @buf ); #yuck use Date::Format; use Text::Template; @@ -16,7 +16,11 @@ use FS::cust_pkg; #ask FS::UID to run this stuff for us later $FS::UID::callback{'FS::cust_bill'} = sub { + $conf = new FS::Conf; + + $money_char = $conf->config('money_char') || '$'; + my @invoice_template = $conf->config('invoice_template') or die "cannot load config file invoice_template"; $invoice_lines = 0; @@ -65,8 +69,10 @@ FS::cust_bill - Object methods for cust_bill records =head1 DESCRIPTION -An FS::cust_bill object represents an invoice. FS::cust_bill inherits from -FS::Record. The following fields are currently supported: +An FS::cust_bill object represents an invoice; a declaration that a customer +owes you money. The specific charges are itemized as B records +(see L). FS::cust_bill inherits from FS::Record. The +following fields are currently supported: =over 4 @@ -79,9 +85,6 @@ L and L for conversion functions. =item charged - amount of this invoice -=item owed - amount still outstanding on this invoice, which is charged minus -all payments (see L). - =item printed - how many times this invoice has been printed automatically (see L). @@ -106,21 +109,6 @@ sub table { 'cust_bill'; } Adds this invoice to the database ("Posts" the invoice). If there is an error, returns the error, otherwise returns false. -When adding new invoices, owed must be charged (or null, in which case it is -automatically set to charged). - -=cut - -sub insert { - my $self = shift; - - $self->owed( $self->charged ) if $self->owed eq ''; - return "owed != charged!" - unless $self->owed == $self->charged; - - $self->SUPER::insert; -} - =item delete Currently unimplemented. I don't remove invoices because there would then be @@ -137,9 +125,8 @@ sub delete { Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false. -Only owed and printed may be changed. Owed is normally updated by creating and -inserting a payment (see L). Printed is normally updated by -calling the collect method of a customer object (see L). +Only printed may be changed. printed is normally updated by calling the +collect method of a customer object (see L). =cut @@ -149,7 +136,6 @@ sub replace { #return "Can't change _date!" unless $old->_date eq $new->_date; return "Can't change _date!" unless $old->_date == $new->_date; return "Can't change charged!" unless $old->charged == $new->charged; - return "(New) owed can't be > (new) charged!" if $new->owed > $new->charged; $new->SUPER::replace($old); } @@ -170,7 +156,6 @@ sub check { || $self->ut_number('custnum') || $self->ut_numbern('_date') || $self->ut_money('charged') - || $self->ut_money('owed') || $self->ut_numbern('printed') ; return $error if $error; @@ -246,6 +231,20 @@ sub cust_pay { ; } +=item owed + +Returns the amount owed (still outstanding) on this invoice, which is charged +minus all payments (see L). + +=cut + +sub owed { + my $self = shift; + my $balance = $self->charged; + $balance -= $_->paid foreach ( $self->cust_pay ); + $balance; +} + =item print_text [TIME]; Returns an text invoice, as a list of lines. @@ -281,12 +280,13 @@ sub print_text { push @buf, [ "Previous Balance, Invoice #". $_->invnum. " (". time2str("%x",$_->_date). ")", - '$'. sprintf("%10.2f",$_->owed) + $money_char. sprintf("%10.2f",$_->owed) ]; } if (@pr_cust_bill) { push @buf,['','-----------']; - push @buf,['Total Previous Balance','$' . sprintf("%10.2f",$pr_total ) ]; + push @buf,[ 'Total Previous Balance', + $money_char. sprintf("%10.2f",$pr_total ) ]; push @buf,['','']; } @@ -300,7 +300,7 @@ sub print_text { my($pkg)=$part_pkg->pkg; if ( $_->setup != 0 ) { - push @buf, [ "$pkg Setup",'$' . sprintf("%10.2f",$_->setup) ]; + push @buf, [ "$pkg Setup", $money_char. sprintf("%10.2f",$_->setup) ]; push @buf, map { [ " ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels; } @@ -309,33 +309,33 @@ sub print_text { push @buf, [ "$pkg (" . time2str("%x",$_->sdate) . " - " . time2str("%x",$_->edate) . ")", - '$' . sprintf("%10.2f",$_->recur) + $money_char. sprintf("%10.2f",$_->recur) ]; push @buf, map { [ " ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels; } } else { #pkgnum Tax - push @buf,["Tax",'$' . sprintf("%10.2f",$_->setup) ] + push @buf,["Tax", $money_char. sprintf("%10.2f",$_->setup) ] if $_->setup != 0; } } push @buf,['','-----------']; push @buf,['Total New Charges', - '$' . sprintf("%10.2f",$self->charged) ]; + $money_char. sprintf("%10.2f",$self->charged) ]; push @buf,['','']; push @buf,['','-----------']; push @buf,['Total Charges', - '$' . sprintf("%10.2f",$self->charged + $pr_total) ]; + $money_char. sprintf("%10.2f",$self->charged + $pr_total) ]; push @buf,['','']; #credits foreach ( @cr_cust_credit ) { push @buf,[ "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")", - '$' . sprintf("%10.2f",$_->credited) + $money_char. sprintf("%10.2f",$_->credited) ]; } @@ -343,13 +343,13 @@ sub print_text { foreach ( $self->cust_pay ) { push @buf,[ "Payment received ". time2str("%x",$_->_date ), - '$' . sprintf("%10.2f",$_->paid ) + $money_char. sprintf("%10.2f",$_->paid ) ]; } #balance due push @buf,['','-----------']; - push @buf,['Balance Due','$' . + push @buf,['Balance Due', $money_char. sprintf("%10.2f",$self->owed + $pr_total - $cr_total ) ]; #setup template variables @@ -424,7 +424,7 @@ sub print_text { =head1 VERSION -$Id: cust_bill.pm,v 1.4 2000-12-03 15:14:00 ivan Exp $ +$Id: cust_bill.pm,v 1.7 2001-04-09 23:05:15 ivan Exp $ =head1 BUGS