add legacy_cust_bill to hold legacy invoice content, RT#12981

6 files changed, 199 insertions, 0 deletions

diff --git a/FS/FS.pm b/FS/FS.pm
index 972a21afb..8645c56cb 100644
--- a/FS/FS.pm
+++ b/FS/FS.pm
@@ -332,6 +332,8 @@ L<FS::cust_bill_pkg> - Invoice line item class
 
 L<FS::cust_bill_pkg_detail> - Invoice line item detail class
 
+L<FS::legacy_cust_bill> - Legacy data invoice class
+
 L<FS::part_bill_event> - (Old) Invoice event definition class
 
 L<FS::cust_bill_event> - (Old) Completed invoice event class
diff --git a/FS/FS/Mason.pm b/FS/FS/Mason.pm
index 7305702a4..3d4fac4b9 100644
--- a/FS/FS/Mason.pm
+++ b/FS/FS/Mason.pm
@@ -290,6 +290,11 @@ if ( -e $addl_handler_use_file ) {
   use FS::cust_msg;
   use FS::radius_group;
   use FS::template_content;
+  use FS::dsl_device;
+  use FS::nas;
+  use FS::nas;
+  use FS::export_nas;
+  use FS::legacy_cust_bill;
   # Sammath Naur
 
   if ( $FS::Mason::addl_handler_use ) {
diff --git a/FS/FS/cust_main.pm b/FS/FS/cust_main.pm
index 0788e15de..f8e103eee 100644
--- a/FS/FS/cust_main.pm
+++ b/FS/FS/cust_main.pm
@@ -40,6 +40,7 @@ use FS::payby;
 use FS::cust_pkg;
 use FS::cust_svc;
 use FS::cust_bill;
+use FS::legacy_cust_bill;
 use FS::cust_pay;
 use FS::cust_pay_pending;
 use FS::cust_pay_void;
@@ -3575,6 +3576,25 @@ sub open_cust_bill {
 
 }
 
+=item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
+
+Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
+
+=cut
+
+sub legacy_cust_bill {
+  my $self = shift;
+
+  #return $self->num_legacy_cust_bill unless wantarray;
+
+  map { $_ } #behavior of sort undefined in scalar context
+    sort { $a->_date <=> $b->_date }
+      qsearch({ 'table'    => 'legacy_cust_bill',
+                'hashref'  => { 'custnum' => $self->custnum, },
+                'order_by' => 'ORDER BY _date ASC',
+             });
+}
+
 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
 
 Returns all the statements (see L<FS::cust_statement>) for this customer.
diff --git a/FS/FS/legacy_cust_bill.pm b/FS/FS/legacy_cust_bill.pm
new file mode 100644
index 000000000..b2bfeaaad
--- /dev/null
+++ b/FS/FS/legacy_cust_bill.pm
@@ -0,0 +1,165 @@
+package FS::legacy_cust_bill;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record qw( qsearch qsearchs );
+use FS::cust_main;
+
+=head1 NAME
+
+FS::legacy_cust_bill - Object methods for legacy_cust_bill records
+
+=head1 SYNOPSIS
+
+  use FS::legacy_cust_bill;
+
+  $record = new FS::legacy_cust_bill \%hash;
+  $record = new FS::legacy_cust_bill { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::legacy_cust_bill object represents an invoice from a previous billing
+system, about which full details are not availble.  Instead, the rendered
+content is stored in HTML or PDF format.  FS::legacy_cust_bill invoices are
+stored for informational and display purposes only; they have no effect upon
+customer balances.
+
+FS::legacy_cust_bill inherits from FS::Record.  The following fields are
+currently supported:
+
+=over 4
+
+=item legacyinvnum
+
+primary key
+
+=item legacyid
+
+Invoice number or identifier from previous system
+
+=item custnum
+
+Customer (see L<FS::cust_main)
+
+=item _date
+
+Date, as a UNIX timestamp
+
+=item charged
+
+Amount charged
+
+=item content_pdf
+
+PDF content
+
+=item content_html
+
+HTML content
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new legacy invoice.  To add the example to the database, see
+L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to.  You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+# the new method can be inherited from FS::Record, if a table method is defined
+
+sub table { 'legacy_cust_bill'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=cut
+
+# the insert method can be inherited from FS::Record
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+# the delete method can be inherited from FS::Record
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=cut
+
+# the replace method can be inherited from FS::Record
+
+=item check
+
+Checks all fields to make sure this is a valid legacy invoice.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and replace methods.
+
+=cut
+
+# the check method should currently be supplied - FS::Record contains some
+# data checking routines
+
+sub check {
+  my $self = shift;
+
+  my $error = 
+    $self->ut_numbern('legacyinvnum')
+    || $self->ut_textn('legacyid')
+    || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum')
+    || $self->ut_number('_date')
+    || $self->ut_money('charged')
+    || $self->ut_anything('content_pdf')
+    || $self->ut_anything('content_html')
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=item cust_main
+
+Returns the customer (see L<FS::cust_main>) for this invoice.
+
+=cut
+
+sub cust_main {
+  my $self = shift;
+  qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+
diff --git a/FS/MANIFEST b/FS/MANIFEST
index eeca1b27b..37f1a5896 100644
--- a/FS/MANIFEST
+++ b/FS/MANIFEST
@@ -614,3 +614,5 @@ FS/dsl_device.pm
 t/dsl_device.t
 FS/export_nas.pm
 t/export_nas.t
+FS/legacy_cust_bill.pm
+t/legacy_cust_bill.t
diff --git a/FS/t/legacy_cust_bill.t b/FS/t/legacy_cust_bill.t
new file mode 100644
index 000000000..2d42e5a97
--- /dev/null
+++ b/FS/t/legacy_cust_bill.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::legacy_cust_bill;
+$loaded=1;
+print "ok 1\n";