NAME

Interchange6::Schema::Result::Tax

DESCRIPTION

The taxes table contains taxes such as sales tax and VAT. Each tax has a unique tax_name but can contain multiple rows for each tax_name to allow for changes in tax rates over time. When there is more than one row for a single tax_name then the valid_from and valid_to periods may not overlap.

ACCESSORS

taxes_id

Primary key.

tax_name

Name of tax, e.g.: vat_full

description

Description of tax, e.g.: New York sales tax

percent

Percent rate of tax, e.g.: 19.9775

decimal_places

Number of decimal_places of precision required for tax cost and reporting.

Defaults to 2.

rounding

Default rounding is half round up to the number of decimal_places. To use floor or ceiling set rounding to 'f' or 'c' as appropriate. The rounding value is automatically converted to lower case and any invalid value passed in will cause an exception to be thrown.

Is nullable.

RELATIONS

state

Type: belongs_to

Related object: Interchange6::Schema::Result::State

country

Type: belongs_to

Related object: Interchange6::Schema::Result::Country

METHODS

calculate

Calculate tax

Arguments should be a hash ref of the following arguments:

price
Price of product either inclusive or exclusive of tax - required.
tax_included
Boolean indicating whether price is inclusive of tax or not. Defaults to 0 which means exclusive of tax.

Will throw an exception if the price us not numeric.

Usage example:

    my $tax = $taxrecord->caclulate({ price => 13.47, tax_included => 1 });

    # with percentage 18 our tax is 2.05

INHERITED METHODS

new

We overload the new method to set default values on certain rows at create time.

sqlt_deploy_hook

Called during table creation to add indexes on the following columns:

tax_name
valid_from
valid_to

validate

Validity checks that cannot be enforced using primary key, unique or other database methods using Interchange6::Schema::Component::Validation. The validity checks enforce the following rules:

Check country_iso_code is valid
If both valid_from and valid_to are defined then valid_to must be a later date than valid_from.
A single tax_name may appear more than once in the table to allow for changes in tax rates but valid_from/valid_to date ranges must not overlap.