1 package FS::cust_bill_pkg;
4 use vars qw( @ISA $DEBUG );
5 use FS::Record qw( qsearch qsearchs dbdef dbh );
6 use FS::cust_main_Mixin;
10 use FS::cust_bill_pkg_detail;
11 use FS::cust_bill_pkg_display;
12 use FS::cust_bill_pay_pkg;
13 use FS::cust_credit_bill_pkg;
14 use FS::cust_tax_exempt_pkg;
16 @ISA = qw( FS::cust_main_Mixin FS::Record );
22 FS::cust_bill_pkg - Object methods for cust_bill_pkg records
26 use FS::cust_bill_pkg;
28 $record = new FS::cust_bill_pkg \%hash;
29 $record = new FS::cust_bill_pkg { 'column' => 'value' };
31 $error = $record->insert;
33 $error = $record->check;
37 An FS::cust_bill_pkg object represents an invoice line item.
38 FS::cust_bill_pkg inherits from FS::Record. The following fields are currently
43 =item billpkgnum - primary key
45 =item invnum - invoice (see L<FS::cust_bill>)
47 =item pkgnum - package (see L<FS::cust_pkg>) or 0 for the special virtual sales tax package, or -1 for the virtual line item (itemdesc is used for the line)
49 =item pkgpart_override - optional package definition (see L<FS::part_pkg>) override
50 =item setup - setup fee
52 =item recur - recurring fee
54 =item sdate - starting date of recurring fee
56 =item edate - ending date of recurring fee
58 =item itemdesc - Line item description (overrides normal package description)
60 =item quantity - If not set, defaults to 1
62 =item unitsetup - If not set, defaults to setup
64 =item unitrecur - If not set, defaults to recur
68 sdate and edate are specified as UNIX timestamps; see L<perlfunc/"time">. Also
69 see L<Time::Local> and L<Date::Parse> for conversion functions.
77 Creates a new line item. To add the line item to the database, see
78 L<"insert">. Line items are normally created by calling the bill method of a
79 customer object (see L<FS::cust_main>).
83 sub table { 'cust_bill_pkg'; }
87 Adds this line item to the database. If there is an error, returns the error,
88 otherwise returns false.
95 local $SIG{HUP} = 'IGNORE';
96 local $SIG{INT} = 'IGNORE';
97 local $SIG{QUIT} = 'IGNORE';
98 local $SIG{TERM} = 'IGNORE';
99 local $SIG{TSTP} = 'IGNORE';
100 local $SIG{PIPE} = 'IGNORE';
102 my $oldAutoCommit = $FS::UID::AutoCommit;
103 local $FS::UID::AutoCommit = 0;
106 my $error = $self->SUPER::insert;
108 $dbh->rollback if $oldAutoCommit;
112 if ( defined dbdef->table('cust_bill_pkg_detail') && $self->get('details') ) {
113 foreach my $detail ( @{$self->get('details')} ) {
114 my $cust_bill_pkg_detail = new FS::cust_bill_pkg_detail {
115 'billpkgnum' => $self->billpkgnum,
116 'format' => (ref($detail) ? $detail->[0] : '' ),
117 'detail' => (ref($detail) ? $detail->[1] : $detail ),
118 'amount' => (ref($detail) ? $detail->[2] : '' ),
119 'classnum' => (ref($detail) ? $detail->[3] : '' ),
121 $error = $cust_bill_pkg_detail->insert;
123 $dbh->rollback if $oldAutoCommit;
129 if ( defined dbdef->table('cust_bill_pkg_display') && $self->get('display') ){
130 foreach my $cust_bill_pkg_display ( @{ $self->get('display') } ) {
131 $cust_bill_pkg_display->billpkgnum($self->billpkgnum);
132 $error = $cust_bill_pkg_display->insert;
134 $dbh->rollback if $oldAutoCommit;
140 if ( $self->_cust_tax_exempt_pkg ) {
141 foreach my $cust_tax_exempt_pkg ( @{$self->_cust_tax_exempt_pkg} ) {
142 $cust_tax_exempt_pkg->billpkgnum($self->billpkgnum);
143 $error = $cust_tax_exempt_pkg->insert;
145 $dbh->rollback if $oldAutoCommit;
151 my $tax_location = $self->get('cust_bill_pkg_tax_location');
152 if ( $tax_location ) {
153 foreach my $cust_bill_pkg_tax_location ( @$tax_location ) {
154 $cust_bill_pkg_tax_location->billpkgnum($self->billpkgnum);
155 warn $cust_bill_pkg_tax_location;
156 $error = $cust_bill_pkg_tax_location->insert;
159 $dbh->rollback if $oldAutoCommit;
165 my $tax_rate_location = $self->get('cust_bill_pkg_tax_rate_location');
166 if ( $tax_rate_location ) {
167 foreach my $cust_bill_pkg_tax_rate_location ( @$tax_rate_location ) {
168 $cust_bill_pkg_tax_rate_location->billpkgnum($self->billpkgnum);
169 $error = $cust_bill_pkg_tax_rate_location->insert;
172 $dbh->rollback if $oldAutoCommit;
178 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
185 Currently unimplemented. I don't remove line items because there would then be
186 no record the items ever existed (which is bad, no?)
191 return "Can't delete cust_bill_pkg records!";
194 #alas, bin/follow-tax-rename
196 #=item replace OLD_RECORD
198 #Currently unimplemented. This would be even more of an accounting nightmare
199 #than deleteing the items. Just don't do it.
204 # return "Can't modify cust_bill_pkg records!";
209 Checks all fields to make sure this is a valid line item. If there is an
210 error, returns the error, otherwise returns false. Called by the insert
219 $self->ut_numbern('billpkgnum')
220 || $self->ut_snumber('pkgnum')
221 || $self->ut_number('invnum')
222 || $self->ut_money('setup')
223 || $self->ut_money('recur')
224 || $self->ut_numbern('sdate')
225 || $self->ut_numbern('edate')
226 || $self->ut_textn('itemdesc')
228 return $error if $error;
230 #if ( $self->pkgnum != 0 ) { #allow unchecked pkgnum 0 for tax! (add to part_pkg?)
231 if ( $self->pkgnum > 0 ) { #allow -1 for non-pkg line items and 0 for tax (add to part_pkg?)
232 return "Unknown pkgnum ". $self->pkgnum
233 unless qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
236 return "Unknown invnum"
237 unless qsearchs( 'cust_bill' ,{ 'invnum' => $self->invnum } );
244 Returns the package (see L<FS::cust_pkg>) for this invoice line item.
250 qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
255 Returns the package definition for this invoice line item.
261 if ( $self->pkgpart_override ) {
262 qsearchs('part_pkg', { 'pkgpart' => $self->pkgpart_override } );
264 $self->cust_pkg->part_pkg;
270 Returns the invoice (see L<FS::cust_bill>) for this invoice line item.
276 qsearchs( 'cust_bill', { 'invnum' => $self->invnum } );
279 =item previous_cust_bill_pkg
281 Returns the previous cust_bill_pkg for this package, if any.
285 sub previous_cust_bill_pkg {
288 'table' => 'cust_bill_pkg',
289 'hashref' => { 'pkgnum' => $self->pkgnum,
290 'sdate' => { op=>'<', value=>$self->sdate },
292 'order_by' => 'ORDER BY sdate DESC LIMIT 1',
296 =item details [ OPTION => VALUE ... ]
298 Returns an array of detail information for the invoice line item.
300 Currently available options are: I<format> I<escape_function>
302 If I<format> is set to html or latex then the array members are improved
303 for tabular appearance in those environments if possible.
305 If I<escape_function> is set then the array members are processed by this
306 function before being returned.
311 my ( $self, %opt ) = @_;
312 my $format = $opt{format} || '';
313 my $escape_function = $opt{escape_function} || sub { shift };
314 return () unless defined dbdef->table('cust_bill_pkg_detail');
316 eval "use Text::CSV_XS;";
318 my $csv = new Text::CSV_XS;
320 my $format_sub = sub { my $detail = shift;
321 $csv->parse($detail) or return "can't parse $detail";
322 join(' - ', map { &$escape_function($_) }
327 $format_sub = sub { my $detail = shift;
328 $csv->parse($detail) or return "can't parse $detail";
329 join('</TD><TD>', map { &$escape_function($_) }
333 if $format eq 'html';
335 $format_sub = sub { my $detail = shift;
336 $csv->parse($detail) or return "can't parse $detail";
337 #join(' & ', map { '\small{'. &$escape_function($_). '}' }
341 foreach ($csv->fields) {
342 $result .= ' & ' if $column > 1;
343 if ($column > 6) { # KLUDGE ALERT!
344 $result .= '\multicolumn{1}{l}{\scriptsize{'.
345 &$escape_function($_). '}}';
347 $result .= '\scriptsize{'. &$escape_function($_). '}';
353 if $format eq 'latex';
355 $format_sub = $opt{format_function} if $opt{format_function};
357 map { ( $_->format eq 'C'
358 ? &{$format_sub}( $_->detail )
359 : &{$escape_function}( $_->detail )
362 qsearch ({ 'table' => 'cust_bill_pkg_detail',
363 'hashref' => { 'billpkgnum' => $self->billpkgnum },
364 'order_by' => 'ORDER BY detailnum',
366 #qsearch ( 'cust_bill_pkg_detail', { 'lineitemnum' => $self->lineitemnum });
371 Returns a description for this line item. For typical line items, this is the
372 I<pkg> field of the corresponding B<FS::part_pkg> object (see L<FS::part_pkg>).
373 For one-shot line items and named taxes, it is the I<itemdesc> field of this
374 line item, and for generic taxes, simply returns "Tax".
381 if ( $self->pkgnum > 0 ) {
382 $self->itemdesc || $self->part_pkg->pkg;
384 $self->itemdesc || 'Tax';
390 Returns the amount owed (still outstanding) on this line item's setup fee,
391 which is the amount of the line item minus all payment applications (see
392 L<FS::cust_bill_pay_pkg> and credit applications (see
393 L<FS::cust_credit_bill_pkg>).
399 $self->owed('setup', @_);
404 Returns the amount owed (still outstanding) on this line item's recurring fee,
405 which is the amount of the line item minus all payment applications (see
406 L<FS::cust_bill_pay_pkg> and credit applications (see
407 L<FS::cust_credit_bill_pkg>).
413 $self->owed('recur', @_);
416 # modeled after cust_bill::owed...
418 my( $self, $field ) = @_;
419 my $balance = $self->$field();
420 $balance -= $_->amount foreach ( $self->cust_bill_pay_pkg($field) );
421 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) );
422 $balance = sprintf( '%.2f', $balance );
423 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
427 sub cust_bill_pay_pkg {
428 my( $self, $field ) = @_;
429 qsearch( 'cust_bill_pay_pkg', { 'billpkgnum' => $self->billpkgnum,
430 'setuprecur' => $field,
435 sub cust_credit_bill_pkg {
436 my( $self, $field ) = @_;
437 qsearch( 'cust_credit_bill_pkg', { 'billpkgnum' => $self->billpkgnum,
438 'setuprecur' => $field,
445 Returns the number of billing units (for tax purposes) represented by this,
452 $self->pkgnum ? $self->part_pkg->calc_units($self->cust_pkg) : 0; # 1?
460 my( $self, $value ) = @_;
461 if ( defined($value) ) {
462 $self->setfield('quantity', $value);
464 $self->getfield('quantity') || 1;
472 my( $self, $value ) = @_;
473 if ( defined($value) ) {
474 $self->setfield('unitsetup', $value);
476 $self->getfield('unitsetup') eq ''
477 ? $self->getfield('setup')
478 : $self->getfield('unitsetup');
486 my( $self, $value ) = @_;
487 if ( defined($value) ) {
488 $self->setfield('unitrecur', $value);
490 $self->getfield('unitrecur') eq ''
491 ? $self->getfield('recur')
492 : $self->getfield('unitrecur');
497 Returns a list of cust_bill_pkg objects each with no more than a single class
498 (including setup or recur) of charge.
504 # XXX this goes away with cust_bill_pkg refactor
506 my $cust_bill_pkg = new FS::cust_bill_pkg { $self->hash };
507 my %cust_bill_pkg = ();
509 $cust_bill_pkg{setup} = $cust_bill_pkg if $cust_bill_pkg->setup;
510 $cust_bill_pkg{recur} = $cust_bill_pkg if $cust_bill_pkg->recur;
513 #split setup and recur
514 if ($cust_bill_pkg->setup && $cust_bill_pkg->recur) {
515 my $cust_bill_pkg_recur = new FS::cust_bill_pkg { $cust_bill_pkg->hash };
516 $cust_bill_pkg->set('details', []);
517 $cust_bill_pkg->recur(0);
518 $cust_bill_pkg->unitrecur(0);
519 $cust_bill_pkg->type('');
520 $cust_bill_pkg_recur->setup(0);
521 $cust_bill_pkg_recur->unitsetup(0);
522 $cust_bill_pkg{recur} = $cust_bill_pkg_recur;
526 #split usage from recur
527 my $usage = sprintf( "%.2f", $cust_bill_pkg{recur}->usage );
528 warn "usage is $usage\n" if $DEBUG;
530 my $cust_bill_pkg_usage =
531 new FS::cust_bill_pkg { $cust_bill_pkg{recur}->hash };
532 $cust_bill_pkg_usage->recur( $usage );
533 $cust_bill_pkg_usage->type( 'U' );
534 my $recur = sprintf( "%.2f", $cust_bill_pkg{recur}->recur - $usage );
535 $cust_bill_pkg{recur}->recur( $recur );
536 $cust_bill_pkg{recur}->type( '' );
537 $cust_bill_pkg{recur}->set('details', []);
538 $cust_bill_pkg{''} = $cust_bill_pkg_usage;
541 #subdivide usage by usage_class
542 if (exists($cust_bill_pkg{''})) {
543 foreach my $class (grep { $_ } $self->usage_classes) {
544 my $usage = sprintf( "%.2f", $cust_bill_pkg{''}->usage($class) );
545 my $cust_bill_pkg_usage =
546 new FS::cust_bill_pkg { $cust_bill_pkg{''}->hash };
547 $cust_bill_pkg_usage->recur( $usage );
548 $cust_bill_pkg_usage->set('details', []);
549 my $classless = sprintf( "%.2f", $cust_bill_pkg{''}->recur - $usage );
550 $cust_bill_pkg{''}->recur( $classless );
551 $cust_bill_pkg{$class} = $cust_bill_pkg_usage;
553 delete $cust_bill_pkg{''} unless $cust_bill_pkg{''}->recur;
556 # # sort setup,recur,'', and the rest numeric && return
557 # my @result = map { $cust_bill_pkg{$_} }
558 # sort { my $ad = ($a=~/^\d+$/); my $bd = ($b=~/^\d+$/);
559 # ( $ad cmp $bd ) || ( $ad ? $a<=>$b : $b cmp $a )
561 # keys %cust_bill_pkg;
570 Returns the amount of the charge associated with usage class CLASSNUM if
571 CLASSNUM is defined. Otherwise returns the total charge associated with
577 my( $self, $classnum ) = @_;
581 if ( $self->get('details') ) {
585 grep { ref($_) && ( defined($classnum) ? $_->[3] eq $classnum : 1 ) }
586 @{ $self->get('details') };
590 my $hashref = { 'billpkgnum' => $self->billpkgnum };
591 $hashref->{ 'classnum' } = $classnum if defined($classnum);
592 @values = map { $_->amount } qsearch('cust_bill_pkg_detail', $hashref);
596 foreach ( @values ) {
604 Returns a list of usage classnums associated with this invoice line's
612 if ( $self->get('details') ) {
615 foreach my $detail ( grep { ref($_) } @{$self->get('details')} ) {
616 $seen{ $detail->[3] } = 1;
623 qsearch({ table => 'cust_bill_pkg_detail',
624 hashref => { billpkgnum => $self->billpkgnum },
625 select => 'DISTINCT classnum',
632 =item cust_bill_pkg_display [ type => TYPE ]
634 Returns an array of display information for the invoice line item optionally
639 sub cust_bill_pkg_display {
640 my ( $self, %opt ) = @_;
643 new FS::cust_bill_pkg_display { billpkgnum =>$self->billpkgnum };
645 return ( $default ) unless defined dbdef->table('cust_bill_pkg_display');#hmmm
647 my $type = $opt{type} if exists $opt{type};
650 if ( scalar( $self->get('display') ) ) {
651 @result = grep { defined($type) ? ($type eq $_->type) : 1 }
652 @{ $self->get('display') };
654 my $hashref = { 'billpkgnum' => $self->billpkgnum };
655 $hashref->{type} = $type if defined($type);
657 @result = qsearch ({ 'table' => 'cust_bill_pkg_display',
658 'hashref' => { 'billpkgnum' => $self->billpkgnum },
659 'order_by' => 'ORDER BY billpkgdisplaynum',
663 push @result, $default unless ( scalar(@result) || $type );
669 # reserving this name for my friends FS::{tax_rate|cust_main_county}::taxline
670 # and FS::cust_main::bill
672 sub _cust_tax_exempt_pkg {
675 $self->{Hash}->{_cust_tax_exempt_pkg} or
676 $self->{Hash}->{_cust_tax_exempt_pkg} = [];
685 setup and recur shouldn't be separate fields. There should be one "amount"
686 field and a flag to tell you if it is a setup/one-time fee or a recurring fee.
688 A line item with both should really be two separate records (preserving
689 sdate and edate for setup fees for recurring packages - that information may
690 be valuable later). Invoice generation (cust_main::bill), invoice printing
691 (cust_bill), tax reports (report_tax.cgi) and line item reports
692 (cust_bill_pkg.cgi) would need to be updated.
694 owed_setup and owed_recur could then be repaced by just owed, and
695 cust_bill::open_cust_bill_pkg and
696 cust_bill_ApplicationCommon::apply_to_lineitems could be simplified.
700 L<FS::Record>, L<FS::cust_bill>, L<FS::cust_pkg>, L<FS::cust_main>, schema.html
701 from the base documentation.