summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Wells <mark@freeside.biz>2014-07-27 17:42:21 -0700
committerMark Wells <mark@freeside.biz>2014-07-27 17:42:30 -0700
commitf786ebaff8b6704e4e180428aaaa9afeaea7ecb9 (patch)
treea17afe574ef48ebd9329a8bcbb9a2da5241a689d
parent0af8be13cbde45885b5b3ed2c2e09a2065ba6e2b (diff)
internal doc updates, #30003
-rw-r--r--FS/FS/Schema.pm1
-rw-r--r--FS/FS/cust_bill.pm20
-rw-r--r--FS/FS/cust_main.pm8
3 files changed, 16 insertions, 13 deletions
diff --git a/FS/FS/Schema.pm b/FS/FS/Schema.pm
index 7cf4c7294..473532180 100644
--- a/FS/FS/Schema.pm
+++ b/FS/FS/Schema.pm
@@ -570,6 +570,7 @@ sub tables_hashref {
'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
#customer balance info at invoice generation time
+ #(deprecated)
'previous_balance', @money_typen, '', '', #eventually not nullable
'billing_balance', @money_typen, '', '', #eventually not nullable
diff --git a/FS/FS/cust_bill.pm b/FS/FS/cust_bill.pm
index f36ff3b07..7f1290fcf 100644
--- a/FS/FS/cust_bill.pm
+++ b/FS/FS/cust_bill.pm
@@ -100,23 +100,19 @@ L<Time::Local> and L<Date::Parse> for conversion functions.
=back
-Customer info at invoice generation time
+Deprecated fields
=over 4
-=item billing_balance - the customer's balance at the time the invoice was
-generated (not including charges on this invoice)
+=item billing_balance - the customer's balance immediately before generating
+this invoice. DEPRECATED. Use the L<FS::cust_main/balance_date> method
+to determine the customer's balance at a specific time.
-=item previous_balance - the billing_balance of this customer's previous
-invoice plus the charges on that invoice
+=item previous_balance - the customer's balance immediately after generating
+the invoice before this one. DEPRECATED.
-=back
-
-Deprecated
-
-=over 4
-
-=item printed - deprecated
+=item printed - formerly used to track the number of times an invoice had
+been printed; no longer used.
=back
diff --git a/FS/FS/cust_main.pm b/FS/FS/cust_main.pm
index fbf6e75f9..9a83099de 100644
--- a/FS/FS/cust_main.pm
+++ b/FS/FS/cust_main.pm
@@ -2839,7 +2839,7 @@ UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
L<Date::Parse> for conversion functions. The empty string can be passed
to disable that time constraint completely.
-Available options are:
+Accepts the same options as L<balance_date_sql>:
=over 4
@@ -2847,6 +2847,12 @@ Available options are:
set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
+=item cutoff
+
+An absolute cutoff time. Payments, credits, and refunds I<applied> after this
+time will be ignored. Note that START_TIME and END_TIME only limit the date
+range for invoices and I<unapplied> payments, credits, and refunds.
+
=back
=cut