Skip to main content

TaxRate

TaxRate

A TaxRate defines the rate of tax to apply to a ProductVariant based on three factors:

  1. the ProductVariant's TaxCategory
  2. the applicable Zone ("applicable" being defined by the configured TaxZoneStrategy)
  3. the CustomerGroup of the current Customer
Signature
class TaxRate extends VendureEntity implements HasCustomFields {
constructor(input?: DeepPartial<TaxRate>)
@Column() name: string;
@Column() enabled: boolean;
@Column({ type: 'decimal', precision: 5, scale: 2, transformer: new DecimalTransformer() }) value: number;
@Index()
@ManyToOne(type => TaxCategory, taxCategory => taxCategory.taxRates)
category: TaxCategory;
@Index()
@ManyToOne(type => Zone, zone => zone.taxRates)
zone: Zone;
@Index()
@ManyToOne(type => CustomerGroup, customerGroup => customerGroup.taxRates, { nullable: true })
customerGroup?: CustomerGroup;
@Column(type => CustomTaxRateFields)
customFields: CustomTaxRateFields;
taxComponentOf(grossPrice: number) => number;
netPriceOf(grossPrice: number) => number;
taxPayableOn(netPrice: number) => number;
grossPriceOf(netPrice: number) => number;
apply(price: number) => TaxLine;
test(zone: Zone, taxCategory: TaxCategory) => boolean;
}
  • Implements: HasCustomFields

constructor

method
(input?: DeepPartial<TaxRate>) => TaxRate

name

property
string

enabled

property
boolean

value

property
number

category

property

zone

property

customerGroup

customFields

property
CustomTaxRateFields

taxComponentOf

method
(grossPrice: number) => number

netPriceOf

method
(grossPrice: number) => number

taxPayableOn

method
(netPrice: number) => number

grossPriceOf

method
(netPrice: number) => number

apply

method
(price: number) => TaxLine

test

method
(zone: Zone, taxCategory: TaxCategory) => boolean