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 FS::Record qw( qsearch qsearchs dbh fields );
7 use FS::cust_statement;
9 use FS::cust_bill_pkg_void;
14 FS::cust_bill_void - Object methods for cust_bill_void records
18 use FS::cust_bill_void;
20 $record = new FS::cust_bill_void \%hash;
21 $record = new FS::cust_bill_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_void object represents a voided invoice. FS::cust_bill_void
34 inherits from FS::Record. The following fields are currently supported:
58 =item previous_balance
88 freeform string (deprecated)
92 reason for voiding the payment (see L<FS::reson>)
107 Creates a new voided invoice. To add the voided invoice to the database, see L<"insert">.
109 Note that this stores the hash reference, not a distinct copy of the hash it
110 points to. You can ask the object for a copy with the I<hash> method.
114 sub table { 'cust_bill_void'; }
115 sub notice_name { 'VOIDED Invoice'; }
116 sub template_conf { 'invoice_'; }
120 my $agentnum = $self->cust_main->agentnum;
121 my $tc = $self->template_conf;
123 $self->conf->exists($tc.'sections', $agentnum) ||
124 $self->conf->exists($tc.'sections_by_location', $agentnum);
130 Adds this record to the database. If there is an error, returns the error,
131 otherwise returns false.
137 "Un-void"s this invoice: Deletes the voided invoice from the database and adds
138 back a normal invoice (and related tables).
145 local $SIG{HUP} = 'IGNORE';
146 local $SIG{INT} = 'IGNORE';
147 local $SIG{QUIT} = 'IGNORE';
148 local $SIG{TERM} = 'IGNORE';
149 local $SIG{TSTP} = 'IGNORE';
150 local $SIG{PIPE} = 'IGNORE';
152 my $oldAutoCommit = $FS::UID::AutoCommit;
153 local $FS::UID::AutoCommit = 0;
156 my $cust_bill = new FS::cust_bill ( {
157 map { $_ => $self->get($_) } fields('cust_bill')
159 my $error = $cust_bill->insert;
161 $dbh->rollback if $oldAutoCommit;
165 foreach my $cust_bill_pkg_void ( $self->cust_bill_pkg ) {
166 my $error = $cust_bill_pkg_void->unvoid;
168 $dbh->rollback if $oldAutoCommit;
173 $error = $self->delete;
175 $dbh->rollback if $oldAutoCommit;
179 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
187 Delete this record from the database.
191 =item replace OLD_RECORD
193 Replaces the OLD_RECORD with this one in the database. If there is an error,
194 returns the error, otherwise returns false.
200 Checks all fields to make sure this is a valid voided invoice. If there is
201 an error, returns the error, otherwise returns false. Called by the insert
210 $self->ut_number('invnum')
211 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
212 || $self->ut_numbern('_date')
213 || $self->ut_money('charged')
214 || $self->ut_textn('invoice_terms')
215 || $self->ut_moneyn('previous_balance')
216 || $self->ut_moneyn('billing_balance')
217 || $self->ut_enum('closed', [ '', 'Y' ])
218 || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum')
219 || $self->ut_numbern('agent_invid')
220 || $self->ut_numbern('promised_date')
221 || $self->ut_numbern('void_date')
222 || $self->ut_textn('reason')
223 || $self->ut_numbern('void_usernum')
224 || $self->ut_foreign_keyn('reasonnum', 'reason', 'reasonnum')
226 return $error if $error;
228 $self->void_date(time) unless $self->void_date;
230 $self->void_usernum($FS::CurrentUser::CurrentUser->usernum)
231 unless $self->void_usernum;
238 Returns the displayed invoice number for this invoice: agent_invid if
239 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
245 my $conf = $self->conf;
246 if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
247 return $self->agent_invid;
249 return $self->invnum;
253 =item void_access_user
255 Returns the voiding employee object (see L<FS::access_user>).
259 sub void_access_user {
261 qsearchs('access_user', { 'usernum' => $self->void_usernum } );
270 Returns the text of the associated void reason (see L<FS::reason>) for this.
274 sub cust_bill_pkg { #actually cust_bill_pkg_void objects
276 qsearch('cust_bill_pkg_void', { invnum=>$self->invnum });
283 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
290 my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
291 $self->cust_bill_pkg;
293 grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
296 =item search_sql_where HASHREF
298 Class method which returns an SQL WHERE fragment to search for parameters
299 specified in HASHREF. Accepts the following parameters for
300 L<FS::cust_bill::search_sql_where>: C<_date>, C<invnum_min>, C<invnum_max>,
301 C<agentnum>, C<custnum>, C<cust_classnum>, C<refnum>. Also
302 accepts the following:
308 Arrayref of start and end date to find invoices voided in a date range.
312 User identifier (L<FS::access_user> key) that voided the invoice.
318 sub search_sql_where {
319 my($class, $param) = @_;
321 my $cust_bill_param = {
322 map { $_ => $param->{$_} }
323 grep { exists($param->{$_}) }
324 qw( _date invnum_min invnum_max agentnum custnum cust_classnum
327 my $search_sql = FS::cust_bill->search_sql_where($cust_bill_param);
328 $search_sql =~ s/cust_bill/cust_bill_void/g;
329 my @search = ($search_sql);
331 if ( $param->{void_date} ) {
332 my($beginning, $ending) = @{$param->{void_date}};
333 push @search, "cust_bill_void.void_date >= $beginning",
334 "cust_bill_void.void_date < $ending";
337 if ( $param->{void_usernum} =~ /^(\d+)$/ ) {
339 push @search, "cust_bill_void.void_usernum = $1";
342 join(" AND ", @search);
346 =item enable_previous
350 sub enable_previous { 0 }
358 L<FS::Record>, schema.html from the base documentation.