X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fcust_bill_pkg.pm;h=96f09c91578d198a52099117e2a543a6bdad6bda;hb=539b6216a17a5423431d430022c4e0f9581a9d2f;hp=e92c05dc7b6a1f56968ead5fe42c1d66bc27bc5d;hpb=988ec48fea05902eb7ea22e43a44e86a36eee06a;p=freeside.git diff --git a/FS/FS/cust_bill_pkg.pm b/FS/FS/cust_bill_pkg.pm index e92c05dc7..96f09c915 100644 --- a/FS/FS/cust_bill_pkg.pm +++ b/FS/FS/cust_bill_pkg.pm @@ -1,18 +1,22 @@ package FS::cust_bill_pkg; use strict; -use vars qw( @ISA ); +use vars qw( @ISA $DEBUG ); 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_pkg_display; use FS::cust_bill_pay_pkg; use FS::cust_credit_bill_pkg; +use FS::cust_tax_exempt_pkg; @ISA = qw( FS::cust_main_Mixin FS::Record ); +$DEBUG = 0; + =head1 NAME FS::cust_bill_pkg - Object methods for cust_bill_pkg records @@ -26,10 +30,6 @@ FS::cust_bill_pkg - Object methods for cust_bill_pkg records $error = $record->insert; - $error = $new_record->replace($old_record); - - $error = $record->delete; - $error = $record->check; =head1 DESCRIPTION @@ -55,7 +55,7 @@ supported: =item edate - ending date of recurring fee -=item itemdesc - Line item description (currentlty used only when pkgnum is 0 or -1) +=item itemdesc - Line item description (overrides normal package description) =item quantity - If not set, defaults to 1 @@ -63,6 +63,8 @@ supported: =item unitrecur - If not set, defaults to recur +=item hidden - If set to Y, indicates data should not appear as separate line item on invoice + =back sdate and edate are specified as UNIX timestamps; see L. Also @@ -109,22 +111,81 @@ sub insert { return $error; } - unless ( defined dbdef->table('cust_bill_pkg_detail') && $self->get('details') ) { - $dbh->commit or die $dbh->errstr if $oldAutoCommit; - return ''; + if ( $self->get('details') ) { + foreach my $detail ( @{$self->get('details')} ) { + my $cust_bill_pkg_detail = new FS::cust_bill_pkg_detail { + 'billpkgnum' => $self->billpkgnum, + 'format' => (ref($detail) ? $detail->[0] : '' ), + 'detail' => (ref($detail) ? $detail->[1] : $detail ), + 'amount' => (ref($detail) ? $detail->[2] : '' ), + 'classnum' => (ref($detail) ? $detail->[3] : '' ), + 'phonenum' => (ref($detail) ? $detail->[4] : '' ), + }; + $error = $cust_bill_pkg_detail->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting cust_bill_pkg_detail: $error"; + } + } } - foreach my $detail ( @{$self->get('details')} ) { - my $cust_bill_pkg_detail = new FS::cust_bill_pkg_detail { - 'pkgnum' => $self->pkgnum, - 'invnum' => $self->invnum, - 'format' => (ref($detail) ? $detail->[0] : '' ), - 'detail' => (ref($detail) ? $detail->[1] : $detail ), - }; - $error = $cust_bill_pkg_detail->insert; + if ( $self->get('display') ) { + foreach my $cust_bill_pkg_display ( @{ $self->get('display') } ) { + $cust_bill_pkg_display->billpkgnum($self->billpkgnum); + $error = $cust_bill_pkg_display->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting cust_bill_pkg_display: $error"; + } + } + } + + if ( $self->_cust_tax_exempt_pkg ) { + foreach my $cust_tax_exempt_pkg ( @{$self->_cust_tax_exempt_pkg} ) { + $cust_tax_exempt_pkg->billpkgnum($self->billpkgnum); + $error = $cust_tax_exempt_pkg->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting cust_tax_exempt_pkg: $error"; + } + } + } + + my $tax_location = $self->get('cust_bill_pkg_tax_location'); + if ( $tax_location ) { + foreach my $cust_bill_pkg_tax_location ( @$tax_location ) { + $cust_bill_pkg_tax_location->billpkgnum($self->billpkgnum); + warn $cust_bill_pkg_tax_location; + $error = $cust_bill_pkg_tax_location->insert; + warn $error; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting cust_bill_pkg_tax_location: $error"; + } + } + } + + my $tax_rate_location = $self->get('cust_bill_pkg_tax_rate_location'); + if ( $tax_rate_location ) { + foreach my $cust_bill_pkg_tax_rate_location ( @$tax_rate_location ) { + $cust_bill_pkg_tax_rate_location->billpkgnum($self->billpkgnum); + $error = $cust_bill_pkg_tax_rate_location->insert; + warn $error; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting cust_bill_pkg_tax_rate_location: $error"; + } + } + } + + my $cust_tax_adjustment = $self->get('cust_tax_adjustment'); + if ( $cust_tax_adjustment ) { + $cust_tax_adjustment->billpkgnum($self->billpkgnum); + $error = $cust_tax_adjustment->replace; + warn $error; if ( $error ) { $dbh->rollback if $oldAutoCommit; - return $error; + return "error replacing cust_tax_adjustment: $error"; } } @@ -144,16 +205,18 @@ sub delete { return "Can't delete cust_bill_pkg records!"; } -=item replace OLD_RECORD - -Currently unimplemented. This would be even more of an accounting nightmare -than deleteing the items. Just don't do it. - -=cut - -sub replace { - return "Can't modify cust_bill_pkg records!"; -} +#alas, bin/follow-tax-rename +# +#=item replace OLD_RECORD +# +#Currently unimplemented. This would be even more of an accounting nightmare +#than deleteing the items. Just don't do it. +# +#=cut +# +#sub replace { +# return "Can't modify cust_bill_pkg records!"; +#} =item check @@ -175,6 +238,8 @@ sub check { || $self->ut_numbern('sdate') || $self->ut_numbern('edate') || $self->ut_textn('itemdesc') + || $self->ut_textn('itemcomment') + || $self->ut_enum('hidden', [ '', 'Y' ]) ; return $error if $error; @@ -227,6 +292,24 @@ sub cust_bill { qsearchs( 'cust_bill', { 'invnum' => $self->invnum } ); } +=item previous_cust_bill_pkg + +Returns the previous cust_bill_pkg for this package, if any. + +=cut + +sub previous_cust_bill_pkg { + my $self = shift; + return unless $self->sdate; + qsearchs({ + 'table' => 'cust_bill_pkg', + 'hashref' => { 'pkgnum' => $self->pkgnum, + 'sdate' => { op=>'<', value=>$self->sdate }, + }, + 'order_by' => 'ORDER BY sdate DESC LIMIT 1', + }); +} + =item details [ OPTION => VALUE ... ] Returns an array of detail information for the invoice line item. @@ -275,10 +358,10 @@ sub details { foreach ($csv->fields) { $result .= ' & ' if $column > 1; if ($column > 6) { # KLUDGE ALERT! - $result .= '\multicolumn{1}{l}{\small{'. + $result .= '\multicolumn{1}{l}{\scriptsize{'. &$escape_function($_). '}}'; }else{ - $result .= '\small{'. &$escape_function($_). '}'; + $result .= '\scriptsize{'. &$escape_function($_). '}'; } $column++; } @@ -286,15 +369,15 @@ sub details { } if $format eq 'latex'; + $format_sub = $opt{format_function} if $opt{format_function}; + map { ( $_->format eq 'C' - ? &{$format_sub}( $_->detail ) + ? &{$format_sub}( $_->detail, $_ ) : &{$escape_function}( $_->detail ) ) } qsearch ({ 'table' => 'cust_bill_pkg_detail', - 'hashref' => { 'pkgnum' => $self->pkgnum, - 'invnum' => $self->invnum, - }, + 'hashref' => { 'billpkgnum' => $self->billpkgnum }, 'order_by' => 'ORDER BY detailnum', }); #qsearch ( 'cust_bill_pkg_detail', { 'lineitemnum' => $self->lineitemnum }); @@ -313,9 +396,11 @@ sub desc { my $self = shift; if ( $self->pkgnum > 0 ) { - $self->part_pkg->pkg; + $self->itemdesc || $self->part_pkg->pkg; } else { - $self->itemdesc || 'Tax'; + my $desc = $self->itemdesc || 'Tax'; + $desc .= ' '. $self->itemcomment if $self->itemcomment =~ /\S/; + $desc; } } @@ -383,7 +468,7 @@ line item. sub units { my $self = shift; - $self->part_pkg->calc_units($self->cust_pkg); + $self->pkgnum ? $self->part_pkg->calc_units($self->cust_pkg) : 0; # 1? } =item quantity @@ -426,6 +511,192 @@ sub unitrecur { : $self->getfield('unitrecur'); } +=item disintegrate + +Returns a list of cust_bill_pkg objects each with no more than a single class +(including setup or recur) of charge. + +=cut + +sub disintegrate { + my $self = shift; + # XXX this goes away with cust_bill_pkg refactor + + my $cust_bill_pkg = new FS::cust_bill_pkg { $self->hash }; + my %cust_bill_pkg = (); + + $cust_bill_pkg{setup} = $cust_bill_pkg if $cust_bill_pkg->setup; + $cust_bill_pkg{recur} = $cust_bill_pkg if $cust_bill_pkg->recur; + + + #split setup and recur + if ($cust_bill_pkg->setup && $cust_bill_pkg->recur) { + my $cust_bill_pkg_recur = new FS::cust_bill_pkg { $cust_bill_pkg->hash }; + $cust_bill_pkg->set('details', []); + $cust_bill_pkg->recur(0); + $cust_bill_pkg->unitrecur(0); + $cust_bill_pkg->type(''); + $cust_bill_pkg_recur->setup(0); + $cust_bill_pkg_recur->unitsetup(0); + $cust_bill_pkg{recur} = $cust_bill_pkg_recur; + + } + + #split usage from recur + my $usage = sprintf( "%.2f", $cust_bill_pkg{recur}->usage ); + warn "usage is $usage\n" if $DEBUG; + if ($usage) { + my $cust_bill_pkg_usage = + new FS::cust_bill_pkg { $cust_bill_pkg{recur}->hash }; + $cust_bill_pkg_usage->recur( $usage ); + $cust_bill_pkg_usage->type( 'U' ); + my $recur = sprintf( "%.2f", $cust_bill_pkg{recur}->recur - $usage ); + $cust_bill_pkg{recur}->recur( $recur ); + $cust_bill_pkg{recur}->type( '' ); + $cust_bill_pkg{recur}->set('details', []); + $cust_bill_pkg{''} = $cust_bill_pkg_usage; + } + + #subdivide usage by usage_class + if (exists($cust_bill_pkg{''})) { + foreach my $class (grep { $_ } $self->usage_classes) { + my $usage = sprintf( "%.2f", $cust_bill_pkg{''}->usage($class) ); + my $cust_bill_pkg_usage = + new FS::cust_bill_pkg { $cust_bill_pkg{''}->hash }; + $cust_bill_pkg_usage->recur( $usage ); + $cust_bill_pkg_usage->set('details', []); + my $classless = sprintf( "%.2f", $cust_bill_pkg{''}->recur - $usage ); + $cust_bill_pkg{''}->recur( $classless ); + $cust_bill_pkg{$class} = $cust_bill_pkg_usage; + } + delete $cust_bill_pkg{''} unless $cust_bill_pkg{''}->recur; + } + +# # sort setup,recur,'', and the rest numeric && return +# my @result = map { $cust_bill_pkg{$_} } +# sort { my $ad = ($a=~/^\d+$/); my $bd = ($b=~/^\d+$/); +# ( $ad cmp $bd ) || ( $ad ? $a<=>$b : $b cmp $a ) +# } +# keys %cust_bill_pkg; +# +# return (@result); + + %cust_bill_pkg; +} + +=item usage CLASSNUM + +Returns the amount of the charge associated with usage class CLASSNUM if +CLASSNUM is defined. Otherwise returns the total charge associated with +usage. + +=cut + +sub usage { + my( $self, $classnum ) = @_; + my $sum = 0; + my @values = (); + + if ( $self->get('details') ) { + + @values = + map { $_->[2] } + grep { ref($_) && ( defined($classnum) ? $_->[3] eq $classnum : 1 ) } + @{ $self->get('details') }; + + }else{ + + my $hashref = { 'billpkgnum' => $self->billpkgnum }; + $hashref->{ 'classnum' } = $classnum if defined($classnum); + @values = map { $_->amount } qsearch('cust_bill_pkg_detail', $hashref); + + } + + foreach ( @values ) { + $sum += $_ if $_; + } + $sum; +} + +=item usage_classes + +Returns a list of usage classnums associated with this invoice line's +details. + +=cut + +sub usage_classes { + my( $self ) = @_; + + if ( $self->get('details') ) { + + my %seen = (); + foreach my $detail ( grep { ref($_) } @{$self->get('details')} ) { + $seen{ $detail->[3] } = 1; + } + keys %seen; + + }else{ + + map { $_->classnum } + qsearch({ table => 'cust_bill_pkg_detail', + hashref => { billpkgnum => $self->billpkgnum }, + select => 'DISTINCT classnum', + }); + + } + +} + +=item cust_bill_pkg_display [ type => TYPE ] + +Returns an array of display information for the invoice line item optionally +limited to 'TYPE'. + +=cut + +sub cust_bill_pkg_display { + my ( $self, %opt ) = @_; + + my $default = + new FS::cust_bill_pkg_display { billpkgnum =>$self->billpkgnum }; + + return ( $default ) unless defined dbdef->table('cust_bill_pkg_display');#hmmm + + my $type = $opt{type} if exists $opt{type}; + my @result; + + if ( scalar( $self->get('display') ) ) { + @result = grep { defined($type) ? ($type eq $_->type) : 1 } + @{ $self->get('display') }; + }else{ + my $hashref = { 'billpkgnum' => $self->billpkgnum }; + $hashref->{type} = $type if defined($type); + + @result = qsearch ({ 'table' => 'cust_bill_pkg_display', + 'hashref' => { 'billpkgnum' => $self->billpkgnum }, + 'order_by' => 'ORDER BY billpkgdisplaynum', + }); + } + + push @result, $default unless ( scalar(@result) || $type ); + + @result; + +} + +# reserving this name for my friends FS::{tax_rate|cust_main_county}::taxline +# and FS::cust_main::bill + +sub _cust_tax_exempt_pkg { + my ( $self ) = @_; + + $self->{Hash}->{_cust_tax_exempt_pkg} or + $self->{Hash}->{_cust_tax_exempt_pkg} = []; + +} + + =back =head1 BUGS