Difference between revisions of "Freeside:3:Documentation:Developer/FS/cust bill pkg tax location"

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
(No difference)

Revision as of 20:03, 27 June 2012

NAME

FS::cust_bill_pkg_tax_location - Object methods for cust_bill_pkg_tax_location records

SYNOPSIS

 use FS::cust_bill_pkg_tax_location;

 $record = new FS::cust_bill_pkg_tax_location \%hash;
 $record = new FS::cust_bill_pkg_tax_location { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_bill_pkg_tax_location object represents an record of taxation based on package location. FS::cust_bill_pkg_tax_location inherits from FS::Record. The following fields are currently supported:

billpkgtaxlocationnum
billpkgtaxlocationnum
billpkgnum
billpkgnum
taxnum
taxnum
taxtype
taxtype
pkgnum
pkgnum
locationnum
locationnum
amount
amount

METHODS

new HASHREF
Creates a new record. To add the record to the database, see "insert".
Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.
insert
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
delete
Delete this record from the database.
replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
check
Checks all fields to make sure this is a valid record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
cust_bill_pkg
Returns the associated cust_bill_pkg object
cust_location
Returns the associated cust_location object
desc
Returns a description for this tax line item constituent. Currently this is the desc of the associated line item followed by the state/county/city for the location in parentheses.
owed
Returns the amount owed (still outstanding) on this tax line item which is the amount of this record minus all payment applications and credit applications.

BUGS

The presense of FS::cust_main_county::delete makes the cust_main_county method unreliable

SEE ALSO

FS::Record, schema.html from the base documentation.