1 package FS::cust_bill_pkg_void;
2 use base qw( FS::TemplateItem_Mixin FS::Record );
5 use FS::Record qw( qsearch qsearchs dbh fields );
6 use FS::cust_bill_void;
7 use FS::cust_bill_pkg_detail_void;
8 use FS::cust_bill_pkg_display_void;
9 use FS::cust_bill_pkg_discount_void;
10 use FS::cust_bill_pkg;
14 FS::cust_bill_pkg_void - Object methods for cust_bill_pkg_void records
18 use FS::cust_bill_pkg_void;
20 $record = new FS::cust_bill_pkg_void \%hash;
21 $record = new FS::cust_bill_pkg_void { 'column' => 'value' };
23 $error = $record->insert;
25 $error = $new_record->replace($old_record);
27 $error = $record->delete;
29 $error = $record->check;
33 An FS::cust_bill_pkg_void object represents a voided invoice line item.
34 FS::cust_bill_pkg_void inherits from FS::Record. The following fields are
51 =item pkgpart_override
112 Creates a new record. To add the record to the database, see L<"insert">.
114 Note that this stores the hash reference, not a distinct copy of the hash it
115 points to. You can ask the object for a copy with the I<hash> method.
119 sub table { 'cust_bill_pkg_void'; }
121 sub detail_table { 'cust_bill_pkg_detail_void'; }
122 sub display_table { 'cust_bill_pkg_display_void'; }
123 sub discount_table { 'cust_bill_pkg_discount_void'; }
124 #sub tax_location_table { 'cust_bill_pkg_tax_location'; }
125 #sub tax_rate_location_table { 'cust_bill_pkg_tax_rate_location'; }
126 #sub tax_exempt_pkg_table { 'cust_tax_exempt_pkg'; }
130 Adds this record to the database. If there is an error, returns the error,
131 otherwise returns false.
135 "Un-void"s this line item: Deletes the voided line item from the database and
136 adds back a normal line item (and related tables).
143 local $SIG{HUP} = 'IGNORE';
144 local $SIG{INT} = 'IGNORE';
145 local $SIG{QUIT} = 'IGNORE';
146 local $SIG{TERM} = 'IGNORE';
147 local $SIG{TSTP} = 'IGNORE';
148 local $SIG{PIPE} = 'IGNORE';
150 my $oldAutoCommit = $FS::UID::AutoCommit;
151 local $FS::UID::AutoCommit = 0;
154 my $cust_bill_pkg = new FS::cust_bill_pkg ( {
155 map { $_ => $self->get($_) } fields('cust_bill_pkg')
157 my $error = $cust_bill_pkg->insert;
159 $dbh->rollback if $oldAutoCommit;
163 foreach my $table (qw(
165 cust_bill_pkg_display
166 cust_bill_pkg_discount
167 cust_bill_pkg_tax_location
168 cust_bill_pkg_tax_rate_location
173 qsearch($table.'_void', { billpkgnum=>$self->billpkgnum })
176 my $class = 'FS::'.$table;
177 my $unvoid = $class->new( {
178 map { $_ => $voided->get($_) } fields($table)
180 my $error = $unvoid->insert || $voided->delete;
182 $dbh->rollback if $oldAutoCommit;
190 $error = $self->delete;
192 $dbh->rollback if $oldAutoCommit;
196 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
204 Delete this record from the database.
206 =item replace OLD_RECORD
208 Replaces the OLD_RECORD with this one in the database. If there is an error,
209 returns the error, otherwise returns false.
213 Checks all fields to make sure this is a valid record. If there is
214 an error, returns the error, otherwise returns false. Called by the insert
223 $self->ut_number('billpkgnum')
224 || $self->ut_snumber('pkgnum')
225 || $self->ut_number('invnum') #cust_bill or cust_bill_void, if we ever support line item voiding
226 || $self->ut_numbern('pkgpart_override')
227 || $self->ut_money('setup')
228 || $self->ut_money('recur')
229 || $self->ut_numbern('sdate')
230 || $self->ut_numbern('edate')
231 || $self->ut_textn('itemdesc')
232 || $self->ut_textn('itemcomment')
233 || $self->ut_textn('section')
234 || $self->ut_textn('freq')
235 || $self->ut_numbern('quantity')
236 || $self->ut_moneyn('unitsetup')
237 || $self->ut_moneyn('unitrecur')
238 || $self->ut_enum('hidden', [ '', 'Y' ])
240 return $error if $error;
247 Returns the voided invoice (see L<FS::cust_bill_void>) for this voided line
254 #cust_bill or cust_bill_void, if we ever support line item voiding
255 qsearchs( 'cust_bill_void', { 'invnum' => $self->invnum } );
264 L<FS::Record>, schema.html from the base documentation.