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;
8 use FS::cust_bill_pkg_display;
9 use FS::cust_bill_pkg_discount;
10 use FS::cust_bill_pkg;
11 use FS::cust_bill_pkg_fee;
12 use FS::cust_bill_pkg_tax_location;
13 use FS::cust_bill_pkg_tax_rate_location;
14 use FS::cust_tax_exempt_pkg;
18 FS::cust_bill_pkg_void - Object methods for cust_bill_pkg_void records
22 use FS::cust_bill_pkg_void;
24 $record = new FS::cust_bill_pkg_void \%hash;
25 $record = new FS::cust_bill_pkg_void { 'column' => 'value' };
27 $error = $record->insert;
29 $error = $new_record->replace($old_record);
31 $error = $record->delete;
33 $error = $record->check;
37 An FS::cust_bill_pkg_void object represents a voided invoice line item.
38 FS::cust_bill_pkg_void inherits from FS::Record. The following fields are
55 =item pkgpart_override
116 Creates a new record. To add the record to the database, see L<"insert">.
118 Note that this stores the hash reference, not a distinct copy of the hash it
119 points to. You can ask the object for a copy with the I<hash> method.
123 sub table { 'cust_bill_pkg_void'; }
125 sub detail_table { 'cust_bill_pkg_detail_void'; }
126 sub display_table { 'cust_bill_pkg_display_void'; }
127 sub discount_table { 'cust_bill_pkg_discount_void'; }
128 #sub tax_location_table { 'cust_bill_pkg_tax_location'; }
129 #sub tax_rate_location_table { 'cust_bill_pkg_tax_rate_location'; }
130 #sub tax_exempt_pkg_table { 'cust_tax_exempt_pkg'; }
134 Adds this record to the database. If there is an error, returns the error,
135 otherwise returns false.
139 "Un-void"s this line item: Deletes the voided line item from the database and
140 adds back a normal line item (and related tables).
147 local $SIG{HUP} = 'IGNORE';
148 local $SIG{INT} = 'IGNORE';
149 local $SIG{QUIT} = 'IGNORE';
150 local $SIG{TERM} = 'IGNORE';
151 local $SIG{TSTP} = 'IGNORE';
152 local $SIG{PIPE} = 'IGNORE';
154 my $oldAutoCommit = $FS::UID::AutoCommit;
155 local $FS::UID::AutoCommit = 0;
158 my $cust_bill_pkg = new FS::cust_bill_pkg ( {
159 map { $_ => $self->get($_) } fields('cust_bill_pkg')
161 my $error = $cust_bill_pkg->insert;
163 $dbh->rollback if $oldAutoCommit;
167 foreach my $table (qw(
169 cust_bill_pkg_display
170 cust_bill_pkg_discount
171 cust_bill_pkg_tax_location
172 cust_bill_pkg_tax_rate_location
178 qsearch($table.'_void', { billpkgnum=>$self->billpkgnum })
181 my $class = 'FS::'.$table;
182 my $unvoid = $class->new( {
183 map { $_ => $voided->get($_) } fields($table)
185 my $error = $unvoid->insert || $voided->delete;
187 $dbh->rollback if $oldAutoCommit;
195 $error = $self->delete;
197 $dbh->rollback if $oldAutoCommit;
201 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
209 Delete this record from the database.
211 =item replace OLD_RECORD
213 Replaces the OLD_RECORD with this one in the database. If there is an error,
214 returns the error, otherwise returns false.
218 Checks all fields to make sure this is a valid record. If there is
219 an error, returns the error, otherwise returns false. Called by the insert
228 $self->ut_number('billpkgnum')
229 || $self->ut_snumber('pkgnum')
230 || $self->ut_number('invnum') #cust_bill or cust_bill_void, if we ever support line item voiding
231 || $self->ut_numbern('pkgpart_override')
232 || $self->ut_money('setup')
233 || $self->ut_money('recur')
234 || $self->ut_numbern('sdate')
235 || $self->ut_numbern('edate')
236 || $self->ut_textn('itemdesc')
237 || $self->ut_textn('itemcomment')
238 || $self->ut_textn('section')
239 || $self->ut_textn('freq')
240 || $self->ut_numbern('quantity')
241 || $self->ut_moneyn('unitsetup')
242 || $self->ut_moneyn('unitrecur')
243 || $self->ut_enum('hidden', [ '', 'Y' ])
244 || $self->ut_numbern('feepart')
246 return $error if $error;
253 Returns the voided invoice (see L<FS::cust_bill_void>) for this voided line
260 #cust_bill or cust_bill_void, if we ever support line item voiding
261 qsearchs( 'cust_bill_void', { 'invnum' => $self->invnum } );
264 sub cust_bill_pkg_fee {
266 qsearch( 'cust_bill_pkg_fee_void', { 'billpkgnum' => $self->billpkgnum } );
275 L<FS::Record>, schema.html from the base documentation.