Skip to content

Latest commit

 

History

History
72 lines (41 loc) · 2.07 KB

tax-category.md

File metadata and controls

72 lines (41 loc) · 2.07 KB
title isDefaultIndex generated
TaxCategory
false
true

import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';

TaxCategory

A TaxCategory defines what type of taxes to apply to a ProductVariant.

class TaxCategory extends VendureEntity implements HasCustomFields {
    constructor(input?: DeepPartial<TaxCategory>)
    @Column() name: string;
    @Column({ default: false }) isDefault: boolean;
    @Column(type => CustomTaxCategoryFields)
    customFields: CustomTaxCategoryFields;
    @OneToMany(type => ProductVariant, productVariant => productVariant.taxCategory)
    productVariants: ProductVariant[];
    @OneToMany(type => TaxRate, taxRate => taxRate.category)
    taxRates: TaxRate[];
}

constructor

<MemberInfo kind="method" type={(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>&#62;) => TaxCategory} />

name

<MemberInfo kind="property" type={string} />

isDefault

<MemberInfo kind="property" type={boolean} />

customFields

<MemberInfo kind="property" type={CustomTaxCategoryFields} />

productVariants

<MemberInfo kind="property" type={<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>[]} />

taxRates

<MemberInfo kind="property" type={<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>[]} />