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

Latest revision as of 07:19, 18 November 2015

NAME

FS::cust_bill_pkg_tax_rate_location - Object methods for cust_bill_pkg_tax_rate_location records

SYNOPSIS

 use FS::cust_bill_pkg_tax_rate_location;

 $record = new FS::cust_bill_pkg_tax_rate_location \%hash;
 $record = new FS::cust_bill_pkg_tax_rate_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_rate_location object represents an record of taxation based on package location. FS::cust_bill_pkg_tax_rate_location inherits from FS::Record. The following fields are currently supported:

billpkgtaxratelocationnum

billpkgtaxratelocationnum

billpkgnum

billpkgnum

taxnum

taxnum

taxtype

taxtype

locationtaxid

locationtaxid

taxratelocationnum

taxratelocationnum

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

tax_rate_location

Returns the associated tax_rate_location object

taxname

Returns the tax name (the itemdesc).

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,locationtaxid 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

SEE ALSO

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