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

Latest revision as of 09:59, 10 April 2015

NAME

FS::cust_tax_exempt_pkg - Object methods for cust_tax_exempt_pkg records

SYNOPSIS

 use FS::cust_tax_exempt_pkg;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_tax_exempt_pkg object represents a record of a customer tax exemption. Whenever a package would be taxed (based on its location and taxclass), but some or all of it is exempt from taxation, an FS::cust_tax_exempt_pkg record is created.

FS::cust_tax_exempt inherits from FS::Record. The following fields are currently supported:

exemptpkgnum - primary key; billpkgnum - invoice line item (see FS::cust_bill_pkg) that was exempted from tax.; taxtype - the object class of the tax record ('FS::cust_main_county' or 'FS::tax_rate').; taxnum - tax rate (see FS::cust_main_county); year - the year in which the exemption occurred. NULL if this is a customer or package exemption rather than a monthly exemption.; month - the month in which the exemption occurred. NULL if this is a customer or package exemption.; amount - the amount of revenue exempted. For monthly exemptions this may be anything up to the monthly exemption limit defined in FS::cust_main_county for this tax. For customer exemptions it is always the full price of the line item. For package exemptions it may be the setup fee, the recurring fee, or the sum of those.; exempt_cust - flag indicating that the customer is tax-exempt (cust_main.tax = 'Y').; exempt_cust_taxname - flag indicating that the customer is exempt from the tax with this name (see FS::cust_main_exemption).; exempt_setup, exempt_recur: flag indicating that the package's setup or recurring fee is not taxable (part_pkg.setuptax and part_pkg.recurtax).; exempt_monthly: flag indicating that this is a monthly per-customer exemption (Texas tax).

METHODS

new HASHREF

Creates a new exemption record. To add the examption 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 exemption record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

cust_main_county; tax_rate

Returns the associated tax definition if it still exists in the database. Otherwise returns false.

BUGS

Texas tax is still a royal pain in the ass.

SEE ALSO

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

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 74:

Unterminated L<...> sequence