Changes to add classified reasons for invoice void
[freeside.git] / FS / FS / cust_bill_void.pm
index bf147c0..04c69d4 100644 (file)
@@ -1,5 +1,6 @@
 package FS::cust_bill_void;
-use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin FS::Record );
+use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin
+             FS::reason_Mixin FS::Record );
 
 use strict;
 use FS::Record qw( qsearch qsearchs dbh fields );
@@ -82,9 +83,13 @@ promised_date
 
 void_date
 
-=item reason
+=item reason 
+
+freeform string (deprecated)
+
+=item reasonnum 
 
-reason
+reason for voiding the payment (see L<FS::reson>)
 
 =item void_usernum
 
@@ -108,7 +113,17 @@ points to.  You can ask the object for a copy with the I<hash> method.
 
 sub table { 'cust_bill_void'; }
 sub notice_name { 'VOIDED Invoice'; }
-#XXXsub template_conf { 'quotation_'; }
+sub template_conf { 'invoice_'; }
+
+sub has_sections {
+  my $self = shift;
+  my $agentnum = $self->cust_main->agentnum;
+  my $tc = $self->template_conf;
+
+  $self->conf->exists($tc.'sections', $agentnum) ||
+  $self->conf->exists($tc.'sections_by_location', $agentnum);
+}
+
 
 =item insert
 
@@ -206,6 +221,7 @@ sub check {
     || $self->ut_numbern('void_date')
     || $self->ut_textn('reason')
     || $self->ut_numbern('void_usernum')
+    || $self->ut_foreign_keyn('reasonnum', 'reason', 'reasonnum')
   ;
   return $error if $error;
 
@@ -249,6 +265,10 @@ sub void_access_user {
 
 =item cust_bill_pkg
 
+=item reason
+
+Returns the text of the associated void reason (see L<FS::reason>) for this.
+
 =cut
 
 sub cust_bill_pkg { #actually cust_bill_pkg_void objects
@@ -278,7 +298,7 @@ sub cust_pkg {
 Class method which returns an SQL WHERE fragment to search for parameters
 specified in HASHREF.  Accepts the following parameters for 
 L<FS::cust_bill::search_sql_where>: C<_date>, C<invnum_min>, C<invnum_max>,
-C<agentnum>, C<custnum>, C<cust_classnum>, C<refnum>, C<payby>.  Also 
+C<agentnum>, C<custnum>, C<cust_classnum>, C<refnum>.  Also 
 accepts the following:
 
 =over 4
@@ -302,7 +322,7 @@ sub search_sql_where {
     map { $_ => $param->{$_} }
     grep { exists($param->{$_}) }
     qw( _date invnum_min invnum_max agentnum custnum cust_classnum 
-        refnum payby )
+        refnum )
   };
   my $search_sql = FS::cust_bill->search_sql_where($cust_bill_param);
   $search_sql =~ s/cust_bill/cust_bill_void/g;