summaryrefslogtreecommitdiff
path: root/FS
diff options
context:
space:
mode:
Diffstat (limited to 'FS')
-rw-r--r--FS/FS.pm2
-rw-r--r--FS/FS/Cron/bill.pm3
-rw-r--r--FS/FS/Schema.pm26
-rw-r--r--FS/FS/cust_main.pm12
-rw-r--r--FS/FS/cust_statement.pm251
-rw-r--r--FS/FS/part_event.pm6
-rw-r--r--FS/FS/part_event/Action/cust_statement.pm38
-rw-r--r--FS/FS/part_event/Action/cust_statement_send.pm26
-rw-r--r--FS/MANIFEST2
-rw-r--r--FS/t/cust_statement.t5
10 files changed, 361 insertions, 10 deletions
diff --git a/FS/FS.pm b/FS/FS.pm
index 09ef298e7..7ce97414c 100644
--- a/FS/FS.pm
+++ b/FS/FS.pm
@@ -242,6 +242,8 @@ L<FS::banned_pay> - Banned payment information class
L<FS::cust_bill> - Invoice class
+L<FS::cust_statement> - Informational statement class
+
L<FS::cust_bill_pkg> - Invoice line item class
L<FS::cust_bill_pkg_detail> - Invoice line item detail class
diff --git a/FS/FS/Cron/bill.pm b/FS/FS/Cron/bill.pm
index 1feba7948..2bdb12025 100644
--- a/FS/FS/Cron/bill.pm
+++ b/FS/FS/Cron/bill.pm
@@ -194,13 +194,14 @@ END
my $where = FS::part_event_condition->where_conditions_sql( $eventtable,
'time'=>$time,
);
+ my $where = "AND $where" if $where;
my $are_part_event =
"EXISTS ( SELECT 1 FROM part_event $join
WHERE check_freq = '$check_freq'
AND eventtable = '$eventtable'
AND ( disabled = '' OR disabled IS NULL )
- AND $where
+ $where
)
";
diff --git a/FS/FS/Schema.pm b/FS/FS/Schema.pm
index 877cf1442..9a7c4ce7a 100644
--- a/FS/FS/Schema.pm
+++ b/FS/FS/Schema.pm
@@ -390,16 +390,28 @@ sub tables_hashref {
'cust_bill' => {
'columns' => [
- 'invnum', 'serial', '', '', '', '',
- 'custnum', 'int', '', '', '', '',
- '_date', @date_type, '', '',
- 'charged', @money_type, '', '',
- 'printed', 'int', '', '', '', '',
- 'closed', 'char', 'NULL', 1, '', '',
+ 'invnum', 'serial', '', '', '', '',
+ 'custnum', 'int', '', '', '', '',
+ '_date', @date_type, '', '',
+ 'charged', @money_type, '', '',
+ 'printed', 'int', '', '', '', '',
+ 'closed', 'char', 'NULL', 1, '', '',
+ 'statementnum', 'int', 'NULL', '', '', '',
],
'primary_key' => 'invnum',
'unique' => [],
- 'index' => [ ['custnum'], ['_date'] ],
+ 'index' => [ ['custnum'], ['_date'], ['statementnum'], ],
+ },
+
+ 'cust_statement' => {
+ 'columns' => [
+ 'statementnum', 'serial', '', '', '', '',
+ 'custnum', 'int', '', '', '', '',
+ '_date', @date_type, '', '',
+ ],
+ 'primary_key' => 'statementnum',
+ 'unique' => [],
+ 'index' => [ ['custnum'], ['_date'], ],
},
'cust_bill_event' => {
diff --git a/FS/FS/cust_main.pm b/FS/FS/cust_main.pm
index b278e9b14..ca5a4e83f 100644
--- a/FS/FS/cust_main.pm
+++ b/FS/FS/cust_main.pm
@@ -7251,6 +7251,18 @@ sub open_cust_bill {
}
+=item cust_statements
+
+Returns all the statements (see L<FS::cust_statement>) for this customer.
+
+=cut
+
+sub cust_statement {
+ my $self = shift;
+ sort { $a->_date <=> $b->_date }
+ qsearch('cust_statement', { 'custnum' => $self->custnum, } )
+}
+
=item cust_credit
Returns all the credits (see L<FS::cust_credit>) for this customer.
diff --git a/FS/FS/cust_statement.pm b/FS/FS/cust_statement.pm
new file mode 100644
index 000000000..cd3e7cec8
--- /dev/null
+++ b/FS/FS/cust_statement.pm
@@ -0,0 +1,251 @@
+package FS::cust_statement;
+
+use strict;
+use base qw( FS::cust_bill );
+use FS::Record qw( dbh qsearch ); #qsearchs );
+use FS::cust_main;
+use FS::cust_bill;
+
+=head1 NAME
+
+FS::cust_statement - Object methods for cust_statement records
+
+=head1 SYNOPSIS
+
+ use FS::cust_statement;
+
+ $record = new FS::cust_statement \%hash;
+ $record = new FS::cust_statement { 'column' => 'value' };
+
+ $error = $record->insert;
+
+ $error = $new_record->replace($old_record);
+
+ $error = $record->delete;
+
+ $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::cust_statement object represents an informational statement which
+aggregates one or more invoices. FS::cust_statement inherits from
+FS::cust_bill.
+
+The following fields are currently supported:
+
+=over 4
+
+=item statementnum
+
+primary key
+
+=item custnum
+
+customer
+
+=item _date
+
+date
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new record. To add the record 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
+
+sub new { FS::Record::new(@_); }
+
+sub table { 'cust_statement'; }
+
+=item insert
+
+Adds this record to the database. If there is an error, returns the error,
+otherwise returns false.
+
+=cut
+
+sub insert {
+ my $self = shift;
+
+ local $SIG{HUP} = 'IGNORE';
+ local $SIG{INT} = 'IGNORE';
+ local $SIG{QUIT} = 'IGNORE';
+ local $SIG{TERM} = 'IGNORE';
+ local $SIG{TSTP} = 'IGNORE';
+ local $SIG{PIPE} = 'IGNORE';
+
+ my $oldAutoCommit = $FS::UID::AutoCommit;
+ local $FS::UID::AutoCommit = 0;
+ my $dbh = dbh;
+
+ FS::Record::insert($self);
+
+ foreach my $cust_bill (
+ qsearch({
+ 'table' => 'cust_bill',
+ 'hashref' => { 'custnum' => $self->custnum,
+ 'statementnum' => '',
+ },
+ 'extra_sql' => 'FOR UPDATE' ,
+ })
+ )
+ {
+ $cust_bill->statementnum( $self->statementnum );
+ my $error = $cust_bill->replace;
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return "Error associating invoice: $error";
+ }
+ }
+
+ $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+ ''; #no error
+
+}
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+sub delete { FS::Record::delete(@_); }
+
+=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
+
+sub replace { FS::Record::replace(@_); }
+
+sub replace_check { ''; }
+
+=item check
+
+Checks all fields to make sure this is a valid record. If there is
+an error, returns the error, otherwise returns false. Called by the insert
+and replace methods.
+
+=cut
+
+sub check {
+ my $self = shift;
+
+ my $error =
+ $self->ut_numbern('statementnum')
+ || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
+ || $self->ut_numbern('_date')
+ ;
+ return $error if $error;
+
+ $self->_date(time) unless $self->_date;
+
+ #don't want to call cust_bill, and Record just checks virtual fields
+ #$self->SUPER::check;
+ '';
+
+}
+
+=item cust_bill
+
+Returns the associated invoices (cust_bill records) for this statement.
+
+=cut
+
+sub cust_bill {
+ my $self = shift;
+ qsearch('cust_bill', { 'statementnum' => $self->statementnum } );
+}
+
+sub _aggregate {
+ my( $self, $method ) = ( shift, shift );
+
+ my @agg = ();
+
+ foreach my $cust_bill ( $self->cust_bill ) {
+ push @agg, $cust_bill->$method( @_ );
+ }
+
+ @agg;
+}
+
+=item cust_bill_pkg
+
+Returns the line items (see L<FS::cust_bill_pkg>) for all associated invoices.
+
+=item cust_bill_pkg_pkgnum PKGNUM
+
+Returns the line items (see L<FS::cust_bill_pkg>) for all associated invoices
+and specified pkgnum.
+
+=item cust_bill_pay
+
+Returns all payment applications (see L<FS::cust_bill_pay>) for all associated
+invoices.
+
+=item cust_credited
+
+Returns all applied credits (see L<FS::cust_credit_bill>) for all associated
+invoices.
+
+=item cust_bill_pay_pkgnum PKGNUM
+
+Returns all payment applications (see L<FS::cust_bill_pay>) for all associated
+invoices with matching pkgnum.
+
+=item cust_credited_pkgnum PKGNUM
+
+Returns all applied credits (see L<FS::cust_credit_bill>) for all associated
+invoices with matching pkgnum.
+
+=cut
+
+sub cust_bill_pay { shift->_aggregate('cust_bill_pay', @_); }
+sub cust_credited { shift->_aggregate('cust_credited', @_); }
+sub cust_bill_pay_pkgnum { shift->_aggregate('cust_bill_pay_pkgnum', @_); }
+sub cust_credited_pkgnum { shift->_aggregate('cust_credited_pkgnum', @_); }
+
+sub cust_bill_pkg { shift->_aggregate('cust_bill_pkg', @_); }
+sub cust_bill_pkg_pkgnum { shift->_aggregate('cust_bill_pkg_pkgnum', @_); }
+
+=item tax
+
+Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
+
+=cut
+
+sub tax {
+ my $self = shift;
+
+ my $total = 0;
+
+ foreach my $cust_bill ( $self->cust_bill ) {
+ $total += $cust_bill->tax;
+ }
+
+ $total;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::cust_bill>, L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+
diff --git a/FS/FS/part_event.pm b/FS/FS/part_event.pm
index 6f2c5366d..c98c3f87a 100644
--- a/FS/FS/part_event.pm
+++ b/FS/FS/part_event.pm
@@ -52,7 +52,7 @@ following fields are currently supported:
=item event - event name
-=item eventtable - table name against which this event is triggered; currently "cust_bill" (the traditional invoice events), "cust_main" (customer events) or "cust_pkg (package events)
+=item eventtable - table name against which this event is triggered; currently "cust_bill" (the traditional invoice events), "cust_main" (customer events) or "cust_pkg (package events) (or "cust_statement")
=item check_freq - how often events of this type are checked; currently "1d" (daily) and "1m" (monthly) are recognized. Note that the apprioriate freeside-daily and/or freeside-monthly cron job needs to be in place.
@@ -133,7 +133,7 @@ sub check {
my $error =
$self->ut_numbern('eventpart')
|| $self->ut_text('event')
- || $self->ut_enum('eventtable', [ 'cust_bill', 'cust_main', 'cust_pkg' ] )
+ || $self->ut_enum('eventtable', [ $self->eventtables ] )
|| $self->ut_enum('check_freq', [ '1d', '1m' ])
|| $self->ut_number('weight')
|| $self->ut_alpha('action')
@@ -273,6 +273,7 @@ sub eventtable_labels {
'cust_bill' => 'Invoice',
'cust_main' => 'Customer',
'cust_pay_batch' => 'Batch payment',
+ 'cust_statement' => 'Statement', #too general a name here? "Invoice group"?
;
\%hash
@@ -310,6 +311,7 @@ sub eventtable_pkey {
'cust_bill' => 'invnum',
'cust_pkg' => 'pkgnum',
'cust_pay_batch' => 'paybatchnum',
+ 'cust_statement' => 'statementnum',
};
}
diff --git a/FS/FS/part_event/Action/cust_statement.pm b/FS/FS/part_event/Action/cust_statement.pm
new file mode 100644
index 000000000..8d8f12770
--- /dev/null
+++ b/FS/FS/part_event/Action/cust_statement.pm
@@ -0,0 +1,38 @@
+package FS::part_event::Action::cust_statement;
+
+use strict;
+
+use base qw( FS::part_event::Action );
+
+use FS::cust_statement;
+
+sub description {
+ 'Group invoices into an informational statement.';
+}
+
+sub eventtable_hashref {
+ { 'cust_main' => 1, };
+ { 'cust_pkg' => 1, };
+}
+
+sub default_weight {
+ 90;
+}
+
+sub do_action {
+ my( $self, $cust_main ) = @_;
+
+ #my( $self, $object ) = @_;
+ #my $cust_main = $self->cust_main($object);
+
+ my $cust_statement = new FS::cust_statement {
+ 'custnum' => $cust_main->custnum
+ };
+ my $error = $cust_statement->insert;
+ die $error if $error;
+
+ '';
+
+}
+
+1;
diff --git a/FS/FS/part_event/Action/cust_statement_send.pm b/FS/FS/part_event/Action/cust_statement_send.pm
new file mode 100644
index 000000000..34f023e0c
--- /dev/null
+++ b/FS/FS/part_event/Action/cust_statement_send.pm
@@ -0,0 +1,26 @@
+package FS::part_event::Action::cust_statement_send;
+
+use strict;
+
+use base qw( FS::part_event::Action );
+
+sub description {
+ 'Send statement (email/print/fax)';
+}
+
+sub eventtable_hashref {
+ { 'cust_statement' => 1, };
+}
+
+sub default_weight {
+ 95;
+}
+
+sub do_action {
+ my( $self, $cust_statement ) = @_;
+
+ $cust_statement->send;
+
+}
+
+1;
diff --git a/FS/MANIFEST b/FS/MANIFEST
index 8082610d7..a45489700 100644
--- a/FS/MANIFEST
+++ b/FS/MANIFEST
@@ -449,3 +449,5 @@ FS/part_device.pm
t/part_device.t
FS/cdr_termination.pm
t/cdr_termination.t
+FS/cust_statement.pm
+t/cust_statement.t
diff --git a/FS/t/cust_statement.t b/FS/t/cust_statement.t
new file mode 100644
index 000000000..c57d94c40
--- /dev/null
+++ b/FS/t/cust_statement.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::cust_statement;
+$loaded=1;
+print "ok 1\n";
generated by cgit v1.2.1 (git 2.18.0) at 2025-01-12 04:10:00 +0000