X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fcust_bill_pkg.pm;h=5d60311cfd53e20e51535904a6ee2ff675a86ab4;hb=dc3217c61d6a62a8e599d8804e05ba45b3224c7e;hp=d718b05fd8ed2226bb9c3a82bb188d85b588b979;hpb=386ec52836abbe32ce2fbf575e851a75f6e112f8;p=freeside.git diff --git a/FS/FS/cust_bill_pkg.pm b/FS/FS/cust_bill_pkg.pm index d718b05fd..5d60311cf 100644 --- a/FS/FS/cust_bill_pkg.pm +++ b/FS/FS/cust_bill_pkg.pm @@ -5,8 +5,11 @@ use vars qw( @ISA ); use FS::Record qw( qsearch qsearchs dbdef dbh ); use FS::cust_main_Mixin; use FS::cust_pkg; +use FS::part_pkg; use FS::cust_bill; use FS::cust_bill_pkg_detail; +use FS::cust_bill_pay_pkg; +use FS::cust_credit_bill_pkg; @ISA = qw( FS::cust_main_Mixin FS::Record ); @@ -43,6 +46,7 @@ supported: =item pkgnum - package (see L) or 0 for the special virtual sales tax package, or -1 for the virtual line item (itemdesc is used for the line) +=item pkgpart_override - optional package definition (see L) override =item setup - setup fee =item recur - recurring fee @@ -108,7 +112,8 @@ sub insert { my $cust_bill_pkg_detail = new FS::cust_bill_pkg_detail { 'pkgnum' => $self->pkgnum, 'invnum' => $self->invnum, - 'detail' => $detail, + 'format' => (ref($detail) ? $detail->[0] : '' ), + 'detail' => (ref($detail) ? $detail->[1] : $detail ), }; $error = $cust_bill_pkg_detail->insert; if ( $error ) { @@ -190,18 +195,88 @@ sub cust_pkg { qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } ); } -=item details +=item part_pkg + +Returns the package definition for this invoice line item. + +=cut + +sub part_pkg { + my $self = shift; + if ( $self->pkgpart_override ) { + qsearchs('part_pkg', { 'pkgpart' => $self->pkgpart_override } ); + } else { + $self->cust_pkg->part_pkg; + } +} + +=item cust_bill + +Returns the invoice (see L) for this invoice line item. + +=cut + +sub cust_bill { + my $self = shift; + qsearchs( 'cust_bill', { 'invnum' => $self->invnum } ); +} + +=item details [ OPTION => VALUE ... ] Returns an array of detail information for the invoice line item. +Currently available options are: I I + +If I is set to html or latex then the array members are improved +for tabular appearance in those environments if possible. + +If I is set then the array members are processed by this +function before being returned. + =cut sub details { - my $self = shift; + my ( $self, %opt ) = @_; + my $format = $opt{format} || ''; + my $escape_function = $opt{escape_function} || sub { shift }; return () unless defined dbdef->table('cust_bill_pkg_detail'); - map { $_->detail } - qsearch ( 'cust_bill_pkg_detail', { 'pkgnum' => $self->pkgnum, - 'invnum' => $self->invnum, } ); + + eval "use Text::CSV_XS;"; + die $@ if $@; + my $csv = new Text::CSV_XS; + + my $format_sub = sub { my $detail = shift; + $csv->parse($detail) or return "can't parse $detail"; + join(' - ', map { &$escape_function($_) } + $csv->fields + ); + }; + + $format_sub = sub { my $detail = shift; + $csv->parse($detail) or return "can't parse $detail"; + join('', map { &$escape_function($_) } + $csv->fields + ); + } + if $format eq 'html'; + + $format_sub = sub { my $detail = shift; + $csv->parse($detail) or return "can't parse $detail"; + join(' & ', map { &$escape_function($_) } $csv->fields ); + } + if $format eq 'latex'; + + map { ( $_->format eq 'C' + ? &{$format_sub}( $_->detail ) + : &{$escape_function}( $_->detail ) + ) + } + qsearch ({ 'table' => 'cust_bill_pkg_detail', + 'hashref' => { 'pkgnum' => $self->pkgnum, + 'invnum' => $self->invnum, + }, + 'order_by' => 'ORDER BY detailnum', + }); #qsearch ( 'cust_bill_pkg_detail', { 'lineitemnum' => $self->lineitemnum }); } @@ -218,24 +293,96 @@ sub desc { my $self = shift; if ( $self->pkgnum > 0 ) { - $self->cust_pkg->part_pkg->pkg; + $self->part_pkg->pkg; } else { $self->itemdesc || 'Tax'; } } -=back +=item owed_setup -=head1 CLASS METHODS +Returns the amount owed (still outstanding) on this line item's setup fee, +which is the amount of the line item minus all payment applications (see +L and credit applications (see +L). -=over 4 +=cut -=item +sub owed_setup { + my $self = shift; + $self->owed('setup', @_); +} + +=item owed_recur + +Returns the amount owed (still outstanding) on this line item's recurring fee, +which is the amount of the line item minus all payment applications (see +L and credit applications (see +L). + +=cut + +sub owed_recur { + my $self = shift; + $self->owed('recur', @_); +} + +# modeled after cust_bill::owed... +sub owed { + my( $self, $field ) = @_; + my $balance = $self->$field(); + $balance -= $_->amount foreach ( $self->cust_bill_pay_pkg($field) ); + $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) ); + $balance = sprintf( '%.2f', $balance ); + $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp + $balance; +} + +sub cust_bill_pay_pkg { + my( $self, $field ) = @_; + qsearch( 'cust_bill_pay_pkg', { 'billpkgnum' => $self->billpkgnum, + 'setuprecur' => $field, + } + ); +} + +sub cust_credit_bill_pkg { + my( $self, $field ) = @_; + qsearch( 'cust_credit_bill_pkg', { 'billpkgnum' => $self->billpkgnum, + 'setuprecur' => $field, + } + ); +} + +=item units + +Returns the number of billing units (for tax purposes) represented by this, +line item. + +=cut + +sub units { + my $self = shift; + $self->part_pkg->calc_units($self->cust_pkg); +} =back =head1 BUGS +setup and recur shouldn't be separate fields. There should be one "amount" +field and a flag to tell you if it is a setup/one-time fee or a recurring fee. + +A line item with both should really be two separate records (preserving +sdate and edate for setup fees for recurring packages - that information may +be valuable later). Invoice generation (cust_main::bill), invoice printing +(cust_bill), tax reports (report_tax.cgi) and line item reports +(cust_bill_pkg.cgi) would need to be updated. + +owed_setup and owed_recur could then be repaced by just owed, and +cust_bill::open_cust_bill_pkg and +cust_bill_ApplicationCommon::apply_to_lineitems could be simplified. + =head1 SEE ALSO L, L, L, L, schema.html