Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Tax

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:tax"

links

links: { fx:native_integrations: NativeIntegrations; fx:store: Backend.Rels.Store; fx:tax_item_categories: TaxItemCategories; self: Tax }

Type declaration

props

props: { apply_to_shipping: boolean; city: string; country: string; date_created: null | string; date_modified: null | string; exempt_all_customer_tax_ids: boolean; is_live: boolean; name: string; rate: number; region: string; service_provider: "" | "avalara"; type: "global" | "union" | "country" | "region" | "local"; use_origin_rates: boolean }

Type declaration

  • apply_to_shipping: boolean

    Set to true if the tax rate will also be applied to the shipping costs.

  • city: string

    The city which will be matched against the customer shipping city to determine if a local tax will be applied.

  • country: string

    The country which will be matched against the customer shipping country to determine if a country tax will be applied.

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • exempt_all_customer_tax_ids: boolean

    Set to true to exempt all customers with a tax id

  • is_live: boolean

    Set to true if the tax rate will be determined automatically by the postal code.

  • name: string

    The name of this tax which will be displayed to the customer.

  • rate: number

    The tax rate to be applied for this tax. For 10%, use 10.

  • region: string

    The region (also known as a state or province) which will be matched against the customer shipping region to determine if a regional tax will be applied.

  • service_provider: "" | "avalara"

    If using a live tax rate service provider, this value can be set to determine which provider you would like to use.

  • type: "global" | "union" | "country" | "region" | "local"

    The type of tax rate which determines when this tax will be applied.

  • use_origin_rates: boolean

    For a Union tax type, set to true to use the origin country tax rates.

Optional Readonly zooms

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc