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 my $cust_tax_adjustment = $self->get('cust_tax_adjustment');
179 if ( $cust_tax_adjustment ) {
180 $cust_tax_adjustment->billpkgnum($self->billpkgnum);
181 $error = $cust_tax_adjustment->replace;
184 $dbh->rollback if $oldAutoCommit;
189 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
196 Currently unimplemented. I don't remove line items because there would then be
197 no record the items ever existed (which is bad, no?)
202 return "Can't delete cust_bill_pkg records!";
205 #alas, bin/follow-tax-rename
207 #=item replace OLD_RECORD
209 #Currently unimplemented. This would be even more of an accounting nightmare
210 #than deleteing the items. Just don't do it.
215 # return "Can't modify cust_bill_pkg records!";
220 Checks all fields to make sure this is a valid line item. If there is an
221 error, returns the error, otherwise returns false. Called by the insert
230 $self->ut_numbern('billpkgnum')
231 || $self->ut_snumber('pkgnum')
232 || $self->ut_number('invnum')
233 || $self->ut_money('setup')
234 || $self->ut_money('recur')
235 || $self->ut_numbern('sdate')
236 || $self->ut_numbern('edate')
237 || $self->ut_textn('itemdesc')
238 || $self->ut_textn('itemcomment')
240 return $error if $error;
242 #if ( $self->pkgnum != 0 ) { #allow unchecked pkgnum 0 for tax! (add to part_pkg?)
243 if ( $self->pkgnum > 0 ) { #allow -1 for non-pkg line items and 0 for tax (add to part_pkg?)
244 return "Unknown pkgnum ". $self->pkgnum
245 unless qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
248 return "Unknown invnum"
249 unless qsearchs( 'cust_bill' ,{ 'invnum' => $self->invnum } );
256 Returns the package (see L<FS::cust_pkg>) for this invoice line item.
262 qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
267 Returns the package definition for this invoice line item.
273 if ( $self->pkgpart_override ) {
274 qsearchs('part_pkg', { 'pkgpart' => $self->pkgpart_override } );
276 $self->cust_pkg->part_pkg;
282 Returns the invoice (see L<FS::cust_bill>) for this invoice line item.
288 qsearchs( 'cust_bill', { 'invnum' => $self->invnum } );
291 =item previous_cust_bill_pkg
293 Returns the previous cust_bill_pkg for this package, if any.
297 sub previous_cust_bill_pkg {
300 'table' => 'cust_bill_pkg',
301 'hashref' => { 'pkgnum' => $self->pkgnum,
302 'sdate' => { op=>'<', value=>$self->sdate },
304 'order_by' => 'ORDER BY sdate DESC LIMIT 1',
308 =item details [ OPTION => VALUE ... ]
310 Returns an array of detail information for the invoice line item.
312 Currently available options are: I<format> I<escape_function>
314 If I<format> is set to html or latex then the array members are improved
315 for tabular appearance in those environments if possible.
317 If I<escape_function> is set then the array members are processed by this
318 function before being returned.
323 my ( $self, %opt ) = @_;
324 my $format = $opt{format} || '';
325 my $escape_function = $opt{escape_function} || sub { shift };
326 return () unless defined dbdef->table('cust_bill_pkg_detail');
328 eval "use Text::CSV_XS;";
330 my $csv = new Text::CSV_XS;
332 my $format_sub = sub { my $detail = shift;
333 $csv->parse($detail) or return "can't parse $detail";
334 join(' - ', map { &$escape_function($_) }
339 $format_sub = sub { my $detail = shift;
340 $csv->parse($detail) or return "can't parse $detail";
341 join('</TD><TD>', map { &$escape_function($_) }
345 if $format eq 'html';
347 $format_sub = sub { my $detail = shift;
348 $csv->parse($detail) or return "can't parse $detail";
349 #join(' & ', map { '\small{'. &$escape_function($_). '}' }
353 foreach ($csv->fields) {
354 $result .= ' & ' if $column > 1;
355 if ($column > 6) { # KLUDGE ALERT!
356 $result .= '\multicolumn{1}{l}{\scriptsize{'.
357 &$escape_function($_). '}}';
359 $result .= '\scriptsize{'. &$escape_function($_). '}';
365 if $format eq 'latex';
367 $format_sub = $opt{format_function} if $opt{format_function};
369 map { ( $_->format eq 'C'
370 ? &{$format_sub}( $_->detail )
371 : &{$escape_function}( $_->detail )
374 qsearch ({ 'table' => 'cust_bill_pkg_detail',
375 'hashref' => { 'billpkgnum' => $self->billpkgnum },
376 'order_by' => 'ORDER BY detailnum',
378 #qsearch ( 'cust_bill_pkg_detail', { 'lineitemnum' => $self->lineitemnum });
383 Returns a description for this line item. For typical line items, this is the
384 I<pkg> field of the corresponding B<FS::part_pkg> object (see L<FS::part_pkg>).
385 For one-shot line items and named taxes, it is the I<itemdesc> field of this
386 line item, and for generic taxes, simply returns "Tax".
393 if ( $self->pkgnum > 0 ) {
394 $self->itemdesc || $self->part_pkg->pkg;
396 my $desc = $self->itemdesc || 'Tax';
397 $desc .= ' '. $self->itemcomment if $self->itemcomment =~ /\S/;
404 Returns the amount owed (still outstanding) on this line item's setup 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('setup', @_);
418 Returns the amount owed (still outstanding) on this line item's recurring fee,
419 which is the amount of the line item minus all payment applications (see
420 L<FS::cust_bill_pay_pkg> and credit applications (see
421 L<FS::cust_credit_bill_pkg>).
427 $self->owed('recur', @_);
430 # modeled after cust_bill::owed...
432 my( $self, $field ) = @_;
433 my $balance = $self->$field();
434 $balance -= $_->amount foreach ( $self->cust_bill_pay_pkg($field) );
435 $balance -= $_->amount foreach ( $self->cust_credit_bill_pkg($field) );
436 $balance = sprintf( '%.2f', $balance );
437 $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
441 sub cust_bill_pay_pkg {
442 my( $self, $field ) = @_;
443 qsearch( 'cust_bill_pay_pkg', { 'billpkgnum' => $self->billpkgnum,
444 'setuprecur' => $field,
449 sub cust_credit_bill_pkg {
450 my( $self, $field ) = @_;
451 qsearch( 'cust_credit_bill_pkg', { 'billpkgnum' => $self->billpkgnum,
452 'setuprecur' => $field,
459 Returns the number of billing units (for tax purposes) represented by this,
466 $self->pkgnum ? $self->part_pkg->calc_units($self->cust_pkg) : 0; # 1?
474 my( $self, $value ) = @_;
475 if ( defined($value) ) {
476 $self->setfield('quantity', $value);
478 $self->getfield('quantity') || 1;
486 my( $self, $value ) = @_;
487 if ( defined($value) ) {
488 $self->setfield('unitsetup', $value);
490 $self->getfield('unitsetup') eq ''
491 ? $self->getfield('setup')
492 : $self->getfield('unitsetup');
500 my( $self, $value ) = @_;
501 if ( defined($value) ) {
502 $self->setfield('unitrecur', $value);
504 $self->getfield('unitrecur') eq ''
505 ? $self->getfield('recur')
506 : $self->getfield('unitrecur');
511 Returns a list of cust_bill_pkg objects each with no more than a single class
512 (including setup or recur) of charge.
518 # XXX this goes away with cust_bill_pkg refactor
520 my $cust_bill_pkg = new FS::cust_bill_pkg { $self->hash };
521 my %cust_bill_pkg = ();
523 $cust_bill_pkg{setup} = $cust_bill_pkg if $cust_bill_pkg->setup;
524 $cust_bill_pkg{recur} = $cust_bill_pkg if $cust_bill_pkg->recur;
527 #split setup and recur
528 if ($cust_bill_pkg->setup && $cust_bill_pkg->recur) {
529 my $cust_bill_pkg_recur = new FS::cust_bill_pkg { $cust_bill_pkg->hash };
530 $cust_bill_pkg->set('details', []);
531 $cust_bill_pkg->recur(0);
532 $cust_bill_pkg->unitrecur(0);
533 $cust_bill_pkg->type('');
534 $cust_bill_pkg_recur->setup(0);
535 $cust_bill_pkg_recur->unitsetup(0);
536 $cust_bill_pkg{recur} = $cust_bill_pkg_recur;
540 #split usage from recur
541 my $usage = sprintf( "%.2f", $cust_bill_pkg{recur}->usage );
542 warn "usage is $usage\n" if $DEBUG;
544 my $cust_bill_pkg_usage =
545 new FS::cust_bill_pkg { $cust_bill_pkg{recur}->hash };
546 $cust_bill_pkg_usage->recur( $usage );
547 $cust_bill_pkg_usage->type( 'U' );
548 my $recur = sprintf( "%.2f", $cust_bill_pkg{recur}->recur - $usage );
549 $cust_bill_pkg{recur}->recur( $recur );
550 $cust_bill_pkg{recur}->type( '' );
551 $cust_bill_pkg{recur}->set('details', []);
552 $cust_bill_pkg{''} = $cust_bill_pkg_usage;
555 #subdivide usage by usage_class
556 if (exists($cust_bill_pkg{''})) {
557 foreach my $class (grep { $_ } $self->usage_classes) {
558 my $usage = sprintf( "%.2f", $cust_bill_pkg{''}->usage($class) );
559 my $cust_bill_pkg_usage =
560 new FS::cust_bill_pkg { $cust_bill_pkg{''}->hash };
561 $cust_bill_pkg_usage->recur( $usage );
562 $cust_bill_pkg_usage->set('details', []);
563 my $classless = sprintf( "%.2f", $cust_bill_pkg{''}->recur - $usage );
564 $cust_bill_pkg{''}->recur( $classless );
565 $cust_bill_pkg{$class} = $cust_bill_pkg_usage;
567 delete $cust_bill_pkg{''} unless $cust_bill_pkg{''}->recur;
570 # # sort setup,recur,'', and the rest numeric && return
571 # my @result = map { $cust_bill_pkg{$_} }
572 # sort { my $ad = ($a=~/^\d+$/); my $bd = ($b=~/^\d+$/);
573 # ( $ad cmp $bd ) || ( $ad ? $a<=>$b : $b cmp $a )
575 # keys %cust_bill_pkg;
584 Returns the amount of the charge associated with usage class CLASSNUM if
585 CLASSNUM is defined. Otherwise returns the total charge associated with
591 my( $self, $classnum ) = @_;
595 if ( $self->get('details') ) {
599 grep { ref($_) && ( defined($classnum) ? $_->[3] eq $classnum : 1 ) }
600 @{ $self->get('details') };
604 my $hashref = { 'billpkgnum' => $self->billpkgnum };
605 $hashref->{ 'classnum' } = $classnum if defined($classnum);
606 @values = map { $_->amount } qsearch('cust_bill_pkg_detail', $hashref);
610 foreach ( @values ) {
618 Returns a list of usage classnums associated with this invoice line's
626 if ( $self->get('details') ) {
629 foreach my $detail ( grep { ref($_) } @{$self->get('details')} ) {
630 $seen{ $detail->[3] } = 1;
637 qsearch({ table => 'cust_bill_pkg_detail',
638 hashref => { billpkgnum => $self->billpkgnum },
639 select => 'DISTINCT classnum',
646 =item cust_bill_pkg_display [ type => TYPE ]
648 Returns an array of display information for the invoice line item optionally
653 sub cust_bill_pkg_display {
654 my ( $self, %opt ) = @_;
657 new FS::cust_bill_pkg_display { billpkgnum =>$self->billpkgnum };
659 return ( $default ) unless defined dbdef->table('cust_bill_pkg_display');#hmmm
661 my $type = $opt{type} if exists $opt{type};
664 if ( scalar( $self->get('display') ) ) {
665 @result = grep { defined($type) ? ($type eq $_->type) : 1 }
666 @{ $self->get('display') };
668 my $hashref = { 'billpkgnum' => $self->billpkgnum };
669 $hashref->{type} = $type if defined($type);
671 @result = qsearch ({ 'table' => 'cust_bill_pkg_display',
672 'hashref' => { 'billpkgnum' => $self->billpkgnum },
673 'order_by' => 'ORDER BY billpkgdisplaynum',
677 push @result, $default unless ( scalar(@result) || $type );
683 # reserving this name for my friends FS::{tax_rate|cust_main_county}::taxline
684 # and FS::cust_main::bill
686 sub _cust_tax_exempt_pkg {
689 $self->{Hash}->{_cust_tax_exempt_pkg} or
690 $self->{Hash}->{_cust_tax_exempt_pkg} = [];
699 setup and recur shouldn't be separate fields. There should be one "amount"
700 field and a flag to tell you if it is a setup/one-time fee or a recurring fee.
702 A line item with both should really be two separate records (preserving
703 sdate and edate for setup fees for recurring packages - that information may
704 be valuable later). Invoice generation (cust_main::bill), invoice printing
705 (cust_bill), tax reports (report_tax.cgi) and line item reports
706 (cust_bill_pkg.cgi) would need to be updated.
708 owed_setup and owed_recur could then be repaced by just owed, and
709 cust_bill::open_cust_bill_pkg and
710 cust_bill_ApplicationCommon::apply_to_lineitems could be simplified.
714 L<FS::Record>, L<FS::cust_bill>, L<FS::cust_pkg>, L<FS::cust_main>, schema.html
715 from the base documentation.