From: ivan Date: Sun, 11 Feb 2001 17:17:39 +0000 (+0000) Subject: documentation updates from jason X-Git-Tag: freeside_1_3_0~39 X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=commitdiff_plain;h=13477c4eb15c3150938a2af8e90f01ad2d83b335 documentation updates from jason --- diff --git a/CREDITS b/CREDITS index cdfaedc87..163e4f1d0 100644 --- a/CREDITS +++ b/CREDITS @@ -63,11 +63,15 @@ other stuff I can't recall (sorry). Stephen Amadei contribued portability cleanups for the low-level DBI stuff. -Jason Spence contributed admin.html, autocapnames -javascript, bugfixes & other neat stuff I can't remember. +Jason Spence contributed admin.html and other +documentation, autocapnames javascript, bugfixes & other neat stuff I can't +remember. Brad Dameron contributed code to do configurable state and referral defaults. +Surf and Sip, Inc., generously sponsored a +long-requested feature - the session monitor and time-based prepaid cards. + Everything else is my (Ivan Kohler ) fault. diff --git a/FS/FS/cust_bill.pm b/FS/FS/cust_bill.pm index 568f272aa..454a60a8a 100644 --- a/FS/FS/cust_bill.pm +++ b/FS/FS/cust_bill.pm @@ -65,8 +65,10 @@ FS::cust_bill - Object methods for cust_bill records =head1 DESCRIPTION -An FS::cust_bill object represents an invoice. FS::cust_bill inherits from -FS::Record. The following fields are currently supported: +An FS::cust_bill object represents an invoice; a declaration that a customer +owes you money. The specific charges are itemized as B records +(see L). FS::cust_bill inherits from FS::Record. The +following fields are currently supported: =over 4 @@ -424,7 +426,7 @@ sub print_text { =head1 VERSION -$Id: cust_bill.pm,v 1.4 2000-12-03 15:14:00 ivan Exp $ +$Id: cust_bill.pm,v 1.5 2001-02-11 17:17:39 ivan Exp $ =head1 BUGS diff --git a/FS/FS/cust_credit.pm b/FS/FS/cust_credit.pm index de8c39d69..e86853799 100644 --- a/FS/FS/cust_credit.pm +++ b/FS/FS/cust_credit.pm @@ -29,7 +29,8 @@ FS::cust_credit - Object methods for cust_credit records =head1 DESCRIPTION -An FS::cust_credit object represents a credit. FS::cust_credit inherits from +An FS::cust_credit object represents a credit; the equivalent of a negative +B record (see L). FS::cust_credit inherits from FS::Record. The following fields are currently supported: =over 4 @@ -157,7 +158,7 @@ sub check { =head1 VERSION -$Id: cust_credit.pm,v 1.1 1999-08-04 09:03:53 ivan Exp $ +$Id: cust_credit.pm,v 1.2 2001-02-11 17:17:39 ivan Exp $ =head1 BUGS diff --git a/FS/FS/cust_pay.pm b/FS/FS/cust_pay.pm index e2b92982d..728981a9b 100644 --- a/FS/FS/cust_pay.pm +++ b/FS/FS/cust_pay.pm @@ -29,8 +29,9 @@ FS::cust_pay - Object methods for cust_pay objects =head1 DESCRIPTION -An FS::cust_pay object represents a payment. FS::cust_pay inherits from -FS::Record. The following fields are currently supported: +An FS::cust_pay object represents a payment; the transfer of money from a +customer. FS::cust_pay inherits from FS::Record. The following fields are +currently supported: =over 4 @@ -172,7 +173,7 @@ sub check { =head1 VERSION -$Id: cust_pay.pm,v 1.1 1999-08-04 09:03:53 ivan Exp $ +$Id: cust_pay.pm,v 1.2 2001-02-11 17:17:39 ivan Exp $ =head1 BUGS diff --git a/FS/FS/cust_refund.pm b/FS/FS/cust_refund.pm index 65254aef4..742c9bb8d 100644 --- a/FS/FS/cust_refund.pm +++ b/FS/FS/cust_refund.pm @@ -30,8 +30,9 @@ FS::cust_refund - Object method for cust_refund objects =head1 DESCRIPTION -An FS::cust_refund represents a refund. FS::cust_refund inherits from -FS::Record. The following fields are currently supported: +An FS::cust_refund represents a refund: the transfer of money to a customer; +equivalent to a negative payment (see L). FS::cust_refund +inherits from FS::Record. The following fields are currently supported: =over 4 @@ -171,7 +172,7 @@ sub check { =head1 VERSION -$Id: cust_refund.pm,v 1.1 1999-08-04 09:03:53 ivan Exp $ +$Id: cust_refund.pm,v 1.2 2001-02-11 17:17:39 ivan Exp $ =head1 BUGS diff --git a/htdocs/docs/schema.html b/htdocs/docs/schema.html index 474a3501a..c61781774 100644 --- a/htdocs/docs/schema.html +++ b/htdocs/docs/schema.html @@ -17,7 +17,7 @@
  • typenum - primary key
  • atype - name of this agent type -
  • cust_bill - Invoices +
  • cust_bill - Invoices. Declarations that a customer owes you money. The specific charges are itemized in cust_bill_pkg.
    • invnum - primary key
    • custnum - customer @@ -35,7 +35,7 @@
    • sdate - starting date
    • edate - ending date
    -
  • cust_credit - Credits +
  • cust_credit - Credits. The equivalent of a negative customer @@ -87,7 +87,7 @@
  • country
  • tax - % rate -
  • cust_pay - Payments +
  • cust_pay - Payments. Money being transferred from a customer.
    • paynum - primary key
    • invnum - invoice @@ -127,7 +127,7 @@
    • cancel - (past) cancellation date
    • otaker - order taker
    -
  • cust_refund - Refunds +
  • cust_refund - Refunds. The transfer of money to a customer; equivalent to a negative cust_pay record.
    • refundnum - primary key
    • crednum - credit