package FS::cust_bill_pkg; use strict; use vars qw( @ISA ); use FS::Record qw( qsearch qsearchs dbdef dbh ); use FS::cust_pkg; use FS::cust_bill; use FS::cust_bill_pkg_detail; @ISA = qw( FS::Record ); =head1 NAME FS::cust_bill_pkg - Object methods for cust_bill_pkg records =head1 SYNOPSIS use FS::cust_bill_pkg; $record = new FS::cust_bill_pkg \%hash; $record = new FS::cust_bill_pkg { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check; =head1 DESCRIPTION An FS::cust_bill_pkg object represents an invoice line item. FS::cust_bill_pkg inherits from FS::Record. The following fields are currently supported: =over 4 =item invnum - invoice (see L) =item pkgnum - package (see L) or 0 for the special virtual sales tax package =item setup - setup fee =item recur - recurring fee =item sdate - starting date of recurring fee =item edate - ending date of recurring fee =item itemdesc - Line item description (currentlty used only when pkgnum is 0) =back sdate and edate are specified as UNIX timestamps; see L. Also see L and L for conversion functions. =head1 METHODS =over 4 =item new HASHREF Creates a new line item. To add the line item to the database, see L<"insert">. Line items are normally created by calling the bill method of a customer object (see L). =cut sub table { 'cust_bill_pkg'; } =item insert Adds this line item to the database. If there is an error, returns the error, otherwise returns false. =cut sub insert { my $self = shift; local $SIG{HUP} = 'IGNORE'; local $SIG{INT} = 'IGNORE'; local $SIG{QUIT} = 'IGNORE'; local $SIG{TERM} = 'IGNORE'; local $SIG{TSTP} = 'IGNORE'; local $SIG{PIPE} = 'IGNORE'; my $oldAutoCommit = $FS::UID::AutoCommit; local $FS::UID::AutoCommit = 0; my $dbh = dbh; my $error = $self->SUPER::insert; if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; } unless ( defined dbdef->table('cust_bill_pkg_detail') && $self->get('details') ) { $dbh->commit or die $dbh->errstr if $oldAutoCommit; return ''; } foreach my $detail ( @{$self->get('details')} ) { my $cust_bill_pkg_detail = new FS::cust_bill_pkg_detail { 'pkgnum' => $self->pkgnum, 'invnum' => $self->invnum, 'detail' => $detail, }; $error = $cust_bill_pkg_detail->insert; if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; } } $dbh->commit or die $dbh->errstr if $oldAutoCommit; ''; } =item delete Currently unimplemented. I don't remove line items because there would then be no record the items ever existed (which is bad, no?) =cut 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!"; } =item check Checks all fields to make sure this is a valid line item. If there is an error, returns the error, otherwise returns false. Called by the insert method. =cut sub check { my $self = shift; my $error = $self->ut_number('pkgnum') || $self->ut_number('invnum') || $self->ut_money('setup') || $self->ut_money('recur') || $self->ut_numbern('sdate') || $self->ut_numbern('edate') || $self->ut_textn('itemdesc') ; return $error if $error; if ( $self->pkgnum != 0 ) { #allow unchecked pkgnum 0 for tax! (add to part_pkg?) return "Unknown pkgnum ". $self->pkgnum unless qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } ); } return "Unknown invnum" unless qsearchs( 'cust_bill' ,{ 'invnum' => $self->invnum } ); $self->SUPER::check; } =item cust_pkg Returns the package (see L) for this invoice line item. =cut sub cust_pkg { my $self = shift; qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } ); } =item details Returns an array of detail information for the invoice line item. =cut sub details { my $self = shift; return () unless defined dbdef->table('cust_bill_pkg_detail'); map { $_->detail } qsearch ( 'cust_bill_pkg_detail', { 'pkgnum' => $self->pkgnum, 'invnum' => $self->invnum, } ); #qsearch ( 'cust_bill_pkg_detail', { 'lineitemnum' => $self->lineitemnum }); } =back =head1 BUGS =head1 SEE ALSO L, L, L, L, schema.html from the base documentation. =cut 1;