1 package FS::cust_bill_void;
2 use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin
3 FS::reason_Mixin FS::Record );
6 use vars qw( $me $DEBUG );
7 use FS::Record qw( qsearch qsearchs dbh fields );
8 use FS::cust_statement;
10 use FS::cust_bill_pkg_void;
13 $me = '[ FS::cust_bill_void ]';
18 FS::cust_bill_void - Object methods for cust_bill_void records
22 use FS::cust_bill_void;
24 $record = new FS::cust_bill_void \%hash;
25 $record = new FS::cust_bill_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_void object represents a voided invoice. FS::cust_bill_void
38 inherits from FS::Record. The following fields are currently supported:
62 =item previous_balance
92 freeform string (deprecated)
96 reason for voiding the payment (see L<FS::reson>)
111 Creates a new voided invoice. To add the voided invoice to the database, see L<"insert">.
113 Note that this stores the hash reference, not a distinct copy of the hash it
114 points to. You can ask the object for a copy with the I<hash> method.
118 sub table { 'cust_bill_void'; }
119 sub notice_name { 'VOIDED Invoice'; }
120 sub template_conf { 'invoice_'; }
124 Adds this record to the database. If there is an error, returns the error,
125 otherwise returns false.
131 "Un-void"s this invoice: Deletes the voided invoice from the database and adds
132 back a normal invoice (and related tables).
139 local $SIG{HUP} = 'IGNORE';
140 local $SIG{INT} = 'IGNORE';
141 local $SIG{QUIT} = 'IGNORE';
142 local $SIG{TERM} = 'IGNORE';
143 local $SIG{TSTP} = 'IGNORE';
144 local $SIG{PIPE} = 'IGNORE';
146 my $oldAutoCommit = $FS::UID::AutoCommit;
147 local $FS::UID::AutoCommit = 0;
150 my $cust_bill = new FS::cust_bill ( {
151 map { $_ => $self->get($_) } fields('cust_bill')
153 my $error = $cust_bill->insert;
155 $dbh->rollback if $oldAutoCommit;
159 foreach my $cust_bill_pkg_void ( $self->cust_bill_pkg ) {
160 my $error = $cust_bill_pkg_void->unvoid;
162 $dbh->rollback if $oldAutoCommit;
167 $error = $self->delete;
169 $dbh->rollback if $oldAutoCommit;
173 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
181 Delete this record from the database.
185 =item replace OLD_RECORD
187 Replaces the OLD_RECORD with this one in the database. If there is an error,
188 returns the error, otherwise returns false.
194 Checks all fields to make sure this is a valid voided invoice. If there is
195 an error, returns the error, otherwise returns false. Called by the insert
204 $self->ut_number('invnum')
205 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
206 || $self->ut_numbern('_date')
207 || $self->ut_money('charged')
208 || $self->ut_textn('invoice_terms')
209 || $self->ut_moneyn('previous_balance')
210 || $self->ut_moneyn('billing_balance')
211 || $self->ut_enum('closed', [ '', 'Y' ])
212 || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum')
213 || $self->ut_numbern('agent_invid')
214 || $self->ut_numbern('promised_date')
215 || $self->ut_numbern('void_date')
216 || $self->ut_textn('reason')
217 || $self->ut_numbern('void_usernum')
218 || $self->ut_foreign_keyn('reasonnum', 'reason', 'reasonnum')
220 return $error if $error;
222 $self->void_date(time) unless $self->void_date;
224 $self->void_usernum($FS::CurrentUser::CurrentUser->usernum)
225 unless $self->void_usernum;
232 Returns the displayed invoice number for this invoice: agent_invid if
233 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
239 my $conf = $self->conf;
240 if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
241 return $self->agent_invid;
243 return $self->invnum;
247 =item void_access_user
249 Returns the voiding employee object (see L<FS::access_user>).
253 sub void_access_user {
255 qsearchs('access_user', { 'usernum' => $self->void_usernum } );
264 Returns the text of the associated void reason (see L<FS::reason>) for this.
268 sub cust_bill_pkg { #actually cust_bill_pkg_void objects
270 qsearch('cust_bill_pkg_void', { invnum=>$self->invnum });
277 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
284 my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
285 $self->cust_bill_pkg;
287 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
290 =item search_sql_where HASHREF
292 Class method which returns an SQL WHERE fragment to search for parameters
293 specified in HASHREF. Accepts the following parameters for
294 L<FS::cust_bill::search_sql_where>: C<_date>, C<invnum_min>, C<invnum_max>,
295 C<agentnum>, C<custnum>, C<cust_classnum>, C<refnum>. Also
296 accepts the following:
302 Arrayref of start and end date to find invoices voided in a date range.
306 User identifier (L<FS::access_user> key) that voided the invoice.
312 sub search_sql_where {
313 my($class, $param) = @_;
315 my $cust_bill_param = {
316 map { $_ => $param->{$_} }
317 grep { exists($param->{$_}) }
318 qw( _date invnum_min invnum_max agentnum custnum cust_classnum
321 my $search_sql = FS::cust_bill->search_sql_where($cust_bill_param);
322 $search_sql =~ s/cust_bill/cust_bill_void/g;
323 my @search = ($search_sql);
325 if ( $param->{void_date} ) {
326 my($beginning, $ending) = @{$param->{void_date}};
327 push @search, "cust_bill_void.void_date >= $beginning",
328 "cust_bill_void.void_date < $ending";
331 if ( $param->{void_usernum} =~ /^(\d+)$/ ) {
333 push @search, "cust_bill_void.void_usernum = $1";
336 join(" AND ", @search);
340 =item enable_previous
344 sub enable_previous { 0 }
348 # Used by FS::Upgrade to migrate to a new database.
349 sub _upgrade_data { # class method
350 my ($class, %opts) = @_;
352 warn "$me upgrading $class\n" if $DEBUG;
354 $class->_upgrade_reasonnum(%opts);
363 L<FS::Record>, schema.html from the base documentation.