diff options
Diffstat (limited to 'htdocs/docs/man/FS/cust_bill.html')
| -rw-r--r-- | htdocs/docs/man/FS/cust_bill.html | 273 |
1 files changed, 125 insertions, 148 deletions
diff --git a/htdocs/docs/man/FS/cust_bill.html b/htdocs/docs/man/FS/cust_bill.html index e09bae5e2..a59542c76 100644 --- a/htdocs/docs/man/FS/cust_bill.html +++ b/htdocs/docs/man/FS/cust_bill.html @@ -1,183 +1,160 @@ <HTML> <HEAD> <TITLE>FS::cust_bill - Object methods for cust_bill records</TITLE> -<LINK REV="made" HREF="mailto:none"> +<LINK REV="made" HREF="mailto:perl@packages.debian.org"> </HEAD> <BODY> +<A NAME="__index__"></A> <!-- INDEX BEGIN --> <UL> - <LI><A HREF="#NAME">NAME</A> - <LI><A HREF="#SYNOPSIS">SYNOPSIS</A> - <LI><A HREF="#DESCRIPTION">DESCRIPTION</A> - <LI><A HREF="#METHODS">METHODS</A> - <LI><A HREF="#VERSION">VERSION</A> - <LI><A HREF="#BUGS">BUGS</A> - <LI><A HREF="#SEE_ALSO">SEE ALSO</A> + <LI><A HREF="#name">NAME</A></LI> + <LI><A HREF="#synopsis">SYNOPSIS</A></LI> + <LI><A HREF="#description">DESCRIPTION</A></LI> + <LI><A HREF="#methods">METHODS</A></LI> + <LI><A HREF="#version">VERSION</A></LI> + <LI><A HREF="#bugs">BUGS</A></LI> + <LI><A HREF="#see also">SEE ALSO</A></LI> </UL> <!-- INDEX END --> <HR> <P> -<H1><A NAME="NAME">NAME</A></H1> -<P> -FS::cust_bill - Object methods for cust_bill records - +<H1><A NAME="name">NAME</A></H1> +<P>FS::cust_bill - Object methods for cust_bill records</P> <P> <HR> -<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1> -<P> -<PRE> use FS::cust_bill; -</PRE> -<P> -<PRE> $record = new FS::cust_bill \%hash; - $record = new FS::cust_bill { 'column' => 'value' }; -</PRE> -<P> -<PRE> $error = $record->insert; -</PRE> -<P> -<PRE> $error = $new_record->replace($old_record); -</PRE> -<P> -<PRE> $error = $record->delete; -</PRE> -<P> -<PRE> $error = $record->check; -</PRE> -<P> -<PRE> ( $total_previous_balance, @previous_cust_bill ) = $record->previous; -</PRE> -<P> -<PRE> @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg; -</PRE> -<P> -<PRE> ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit; -</PRE> -<P> -<PRE> @cust_pay_objects = $cust_bill->cust_pay; -</PRE> -<P> -<PRE> @lines = $cust_bill->print_text; - @lines = $cust_bill->print_text $time; -</PRE> +<H1><A NAME="synopsis">SYNOPSIS</A></H1> +<PRE> + use FS::cust_bill;</PRE> +<PRE> + $record = new FS::cust_bill \%hash; + $record = new FS::cust_bill { 'column' => 'value' };</PRE> +<PRE> + $error = $record->insert;</PRE> +<PRE> + $error = $new_record->replace($old_record);</PRE> +<PRE> + $error = $record->delete;</PRE> +<PRE> + $error = $record->check;</PRE> +<PRE> + ( $total_previous_balance, @previous_cust_bill ) = $record->previous;</PRE> +<PRE> + @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;</PRE> +<PRE> + ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;</PRE> +<PRE> + @cust_pay_objects = $cust_bill->cust_pay;</PRE> +<PRE> + @lines = $cust_bill->print_text; + @lines = $cust_bill->print_text $time;</PRE> <P> <HR> -<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1> -<P> -An FS::cust_bill object represents an invoice. FS::cust_bill inherits from -FS::Record. The following fields are currently supported: - +<H1><A NAME="description">DESCRIPTION</A></H1> +<P>An FS::cust_bill object represents an invoice; a declaration that a customer +owes you money. The specific charges are itemized as <STRONG>cust_bill_pkg</STRONG> records +(see <A HREF=".././FS/cust_bill_pkg.html">the FS::cust_bill_pkg manpage</A>). FS::cust_bill inherits from FS::Record. The +following fields are currently supported:</P> <DL> -<DT><STRONG><A NAME="item_invnum">invnum - primary key (assigned automatically for new invoices)</A></STRONG><DD> -<DT><STRONG><A NAME="item_custnum">custnum - customer (see FS::cust_main)</A></STRONG><DD> -<DT><STRONG><A NAME="item__date">_date - specified as a UNIX timestamp; see perlfunc/"time". Also see -Time::Local and Date::Parse for conversion functions.</A></STRONG><DD> -<DT><STRONG><A NAME="item_charged">charged - amount of this invoice</A></STRONG><DD> -<DT><STRONG><A NAME="item_owed">owed - amount still outstanding on this invoice, which is charged minus -all payments (see FS::cust_pay).</A></STRONG><DD> -<DT><STRONG><A NAME="item_printed">printed - how many times this invoice has been printed automatically -(see FS::cust_main/"collect").</A></STRONG><DD> +<DT><STRONG><A NAME="item_key">invnum - primary key (assigned automatically for new invoices)</A></STRONG><BR> +<DD> +<DT><STRONG><A NAME="item_customer">custnum - customer (see <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>)</A></STRONG><BR> +<DD> +<DT><STRONG><A NAME="item__date_%2D_specified_as_a_UNIX_timestamp%3B_see_per">_date - specified as a UNIX timestamp; see <EM>perlfunc/``time''</EM>. Also see +<A HREF="../Time/Local.html">the Time::Local manpage</A> and <A HREF="../Date/Parse.html">the Date::Parse manpage</A> for conversion functions.</A></STRONG><BR> +<DD> +<DT><STRONG><A NAME="item_charged_%2D_amount_of_this_invoice">charged - amount of this invoice</A></STRONG><BR> +<DD> +<DT><STRONG><A NAME="item_automatically">printed - how many times this invoice has been printed automatically +(see <A HREF=".././FS/cust_main.html#collect">collect in the FS::cust_main manpage</A>).</A></STRONG><BR> +<DD> </DL> <P> <HR> -<H1><A NAME="METHODS">METHODS</A></H1> +<H1><A NAME="methods">METHODS</A></H1> <DL> -<DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD> -<P> -Creates a new invoice. To add the invoice to the database, see <A HREF="#insert">insert</A>. Invoices are normally created by calling the bill method of a customer -object (see <A HREF="../FS/cust_main.html">FS::cust_main</A>). - -<DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD> -<P> -Adds this invoice to the database (``Posts'' the invoice). If there is an -error, returns the error, otherwise returns false. - -<P> -When adding new invoices, owed must be charged (or null, in which case it -is automatically set to charged). - -<DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD> -<P> -Currently unimplemented. I don't remove invoices because there would then -be no record you ever posted this invoice (which is bad, no?) - -<DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD> -<P> -Replaces the OLD_RECORD with this one in the database. If there is an -error, returns the error, otherwise returns false. - -<P> -Only owed and printed may be changed. Owed is normally updated by creating -and inserting a payment (see <A HREF="../FS/cust_pay.html">FS::cust_pay</A>). Printed is normally updated by calling the collect method of a customer -object (see <A HREF="../FS/cust_main.html">FS::cust_main</A>). - -<DT><STRONG><A NAME="item_check">check</A></STRONG><DD> -<P> -Checks all fields to make sure this is a valid invoice. If there is an -error, returns the error, otherwise returns false. Called by the insert and -replace methods. - -<DT><STRONG><A NAME="item_previous">previous</A></STRONG><DD> -<P> -Returns a list consisting of the total previous balance for this customer, -followed by the previous outstanding invoices (as FS::cust_bill objects -also). - -<DT><STRONG><A NAME="item_cust_bill_pkg">cust_bill_pkg</A></STRONG><DD> -<P> -Returns the line items (see <A HREF="../FS/cust_bill_pkg.html">FS::cust_bill_pkg</A>) for this invoice. - -<DT><STRONG><A NAME="item_cust_credit">cust_credit</A></STRONG><DD> -<P> +<DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR> +<DD> +Creates a new invoice. To add the invoice to the database, see <A HREF="#insert">insert</A>. +Invoices are normally created by calling the bill method of a customer object +(see <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>). +<P></P> +<DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR> +<DD> +Adds this invoice to the database (``Posts'' the invoice). If there is an error, +returns the error, otherwise returns false. +<P></P> +<DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR> +<DD> +Currently unimplemented. I don't remove invoices because there would then be +no record you ever posted this invoice (which is bad, no?) +<P></P> +<DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR> +<DD> +Replaces the OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. +<P>Only printed may be changed. printed is normally updated by calling the +collect method of a customer object (see <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>).</P> +<P></P> +<DT><STRONG><A NAME="item_check">check</A></STRONG><BR> +<DD> +Checks all fields to make sure this is a valid invoice. If there is an error, +returns the error, otherwise returns false. Called by the insert and replace +methods. +<P></P> +<DT><STRONG><A NAME="item_previous">previous</A></STRONG><BR> +<DD> +Returns a list consisting of the total previous balance for this customer, +followed by the previous outstanding invoices (as FS::cust_bill objects also). +<P></P> +<DT><STRONG><A NAME="item_cust_bill_pkg">cust_bill_pkg</A></STRONG><BR> +<DD> +Returns the line items (see <A HREF=".././FS/cust_bill_pkg.html">the FS::cust_bill_pkg manpage</A>) for this invoice. +<P></P> +<DT><STRONG><A NAME="item_cust_credit">cust_credit</A></STRONG><BR> +<DD> Returns a list consisting of the total previous credited (see -<A HREF="../FS/cust_credit.html">FS::cust_credit</A>) for this customer, followed by the previous outstanding credits -(FS::cust_credit objects). - -<DT><STRONG><A NAME="item_cust_pay">cust_pay</A></STRONG><DD> -<P> -Returns all payments (see <A HREF="../FS/cust_pay.html">FS::cust_pay</A>) for this invoice. - -<DT><STRONG><A NAME="item_print_text">print_text [TIME];</A></STRONG><DD> -<P> -Returns an ASCII invoice, as a list of lines. - -<P> -TIME an optional value used to control the printing of overdue messages. -The default is now. It isn't the date of the invoice; that's the `_date' -field. It is specified as a UNIX timestamp; see <EM>perlfunc</EM>. Also see -<A HREF="../Time/Local.html">Time::Local</A> and <A HREF="../Date/Parse.html">Date::Parse</A> for conversion functions. - -</DL> +<A HREF=".././FS/cust_credit.html">the FS::cust_credit manpage</A>) for this customer, followed by the previous outstanding +credits (FS::cust_credit objects). +<P></P> +<DT><STRONG><A NAME="item_cust_pay">cust_pay</A></STRONG><BR> +<DD> +Returns all payments (see <A HREF=".././FS/cust_pay.html">the FS::cust_pay manpage</A>) for this invoice. +<P></P> +<DT><STRONG><A NAME="item_owed">owed</A></STRONG><BR> +<DD> +Returns the amount owed (still outstanding) on this invoice, which is charged +minus all payments (see <A HREF=".././FS/cust_pay.html">the FS::cust_pay manpage</A>). +<P></P> +<DT><STRONG><A NAME="item_print_text_%5BTIME%5D%3B">print_text [TIME];</A></STRONG><BR> +<DD> +Returns an text invoice, as a list of lines. +<P>TIME an optional value used to control the printing of overdue messages. The +default is now. It isn't the date of the invoice; that's the `_date' field. +It is specified as a UNIX timestamp; see <EM>perlfunc/``time''</EM>. Also see +<A HREF="../Time/Local.html">the Time::Local manpage</A> and <A HREF="../Date/Parse.html">the Date::Parse manpage</A> for conversion functions.</P> +<P></P></DL> <P> <HR> -<H1><A NAME="VERSION">VERSION</A></H1> -<P> -$Id: cust_bill.html,v 1.2 2000-03-03 18:22:42 ivan Exp $ - +<H1><A NAME="version">VERSION</A></H1> +<P>$Id: cust_bill.html,v 1.3 2001-04-23 12:40:31 ivan Exp $</P> <P> <HR> -<H1><A NAME="BUGS">BUGS</A></H1> -<P> -The delete method. - -<P> -print_text formatting (and some logic :/) is in source, but needs to be -slurped in from a file. Also number of lines ($=). - -<P> -missing print_ps for a nice postscript copy (maybe HylaFAX-cover-page-style -or something similar so the look can be completely customized?) - +<H1><A NAME="bugs">BUGS</A></H1> +<P>The delete method.</P> +<P>print_text formatting (and some logic :/) is in source, but needs to be +slurped in from a file. Also number of lines ($=).</P> +<P>missing print_ps for a nice postscript copy (maybe HylaFAX-cover-page-style +or something similar so the look can be completely customized?)</P> <P> <HR> -<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1> -<P> -<A HREF="../FS/Record.html">FS::Record</A>, <A HREF="../FS/cust_main.html">FS::cust_main</A>, <A HREF="../FS/cust_pay.html">FS::cust_pay</A>, <A HREF="../FS/cust_bill_pkg.html">FS::cust_bill_pkg</A>, -<A HREF="../FS/cust_credit.html">FS::cust_credit</A>, schema.html from the base documentation. +<H1><A NAME="see also">SEE ALSO</A></H1> +<P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>, <A HREF=".././FS/cust_pay.html">the FS::cust_pay manpage</A>, <A HREF=".././FS/cust_bill_pkg.html">the FS::cust_bill_pkg manpage</A>, +<A HREF=".././FS/cust_credit.html">the FS::cust_credit manpage</A>, schema.html from the base documentation.</P> </BODY> |