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

Latest revision as of 06:31, 10 February 2015

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 FS::cust_bill_pay) or credits (see 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 FS::cust_bill)

applied_to_invoice

Returns a string representing the invoice (see 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

FS::cust_bill_pay and FS::cust_bill_pay_pkg, FS::cust_credit_bill and FS::cust_credit_bill_pkg