Difference between revisions of "Freeside:3:Documentation:Developer/FS/cust bill ApplicationCommon"

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
m (Edit via perl MediaWiki framework (1.13))
Line 1: Line 1:
==NAME==
 
FS::cust_bill_ApplicationCommon - Base class for bill application classes
 
  
==SYNOPSIS==
 
use FS::cust_bill_ApplicationCommon;
 
 
@ISA = qw( FS::cust_bill_ApplicationCommon );
 
 
sub _app_source_name { 'payment'; } sub _app_source_table { 'cust_pay'; } sub _app_lineitem_breakdown_table { 'cust_bill_pay_pkg'; }
 
 
==DESCRIPTION==
 
FS::cust_bill_ApplicationCommon is intended as a base class for classes which represent application of things to invoices, currently payments (see [[Freeside:3:Documentation:Developer/FS/cust bill pay|FS::cust_bill_pay]]) or credits (see [[Freeside:3:Documentation:Developer/FS/cust credit bill|FS::cust_credit_bill]]).
 
 
==METHODS==
 
; insert; delete; apply_to_lineitems
 
:Auto-applies this invoice application to specific line items, if possible.
 
; lineitem_applications
 
:Returns all the specific line item applications for this invoice application.
 
; cust_bill
 
:Returns the invoice (see [[Freeside:3:Documentation:Developer/FS/cust bill|FS::cust_bill]])
 
; applied_to_invoice
 
:Returns a string representing the invoice (see [[Freeside:3:Documentation:Developer/FS/cust bill|FS::cust_bill]]), for example: "applied to Invoice #54 (3/20/2008)"
 
 
:Intended for back-end context, with regard to translation and date formatting.
 
; _app_source_object; _date_pretty
 
:Returns a string with the application date, for example: "3/20/2008"
 
; lineitem_breakdown_table
 
==BUGS==
 
==SEE ALSO==
 
[[Freeside:3:Documentation:Developer/FS/cust bill pay|FS::cust_bill_pay]] and [[Freeside:3:Documentation:Developer/FS/cust bill pay pkg|FS::cust_bill_pay_pkg]], [[Freeside:3:Documentation:Developer/FS/cust credit bill|FS::cust_credit_bill]] and [[Freeside:3:Documentation:Developer/FS/cust credit bill pkg|FS::cust_credit_bill_pkg]]
 

Revision as of 05:26, 10 February 2015