TaxConfiguration Object

Channel-specific tax configuration.

type TaxConfiguration implements Node & ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(key: String!): String
  privateMetafields(keys: [String!]): Metadata
  metadata: [MetadataItem!]!
  metafield(key: String!): String
  metafields(keys: [String!]): Metadata
  channel: Channel!
  chargeTaxes: Boolean!
  taxCalculationStrategy: TaxCalculationStrategy
  displayGrossPrices: Boolean!
  pricesEnteredWithTax: Boolean!
  countries: [TaxConfigurationPerCountry!]!
  taxAppId: String
  useWeightedTaxForShipping: Boolean
}

Fields

privateMetadata

privateMetadata · [MetadataItem!]!

List of private metadata items. Requires staff permissions to access.

privateMetafield

privateMetafield · String

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

privateMetafields

privateMetafields · Metadata

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

metadata

metadata · [MetadataItem!]!

List of public metadata items. Can be accessed without permissions.

metafield

metafield · String

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

metafields

metafields · Metadata

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

channel

channel · Channel!

A channel to which the tax configuration applies to.

chargeTaxes

chargeTaxes · Boolean!

Determines whether taxes are charged in the given channel.

taxCalculationStrategy

taxCalculationStrategy · TaxCalculationStrategy

The default strategy to use for tax calculation in the given channel. Taxes can be calculated either using user-defined flat rates or with a tax app. Empty value means that no method is selected and taxes are not calculated.

displayGrossPrices

displayGrossPrices · Boolean!

Determines whether displayed prices should include taxes.

pricesEnteredWithTax

pricesEnteredWithTax · Boolean!

Determines whether prices are entered with the tax included.

countries

countries · [TaxConfigurationPerCountry!]!

List of country-specific exceptions in tax configuration.

taxAppId

taxAppId · String

The tax app App.identifier that will be used to calculate the taxes for the given channel. Empty value for TAX_APP set as taxCalculationStrategy means that Saleor will iterate over all installed tax apps. If multiple tax apps exist with provided tax app id use the App with newest created date. Will become mandatory in 4.0 for TAX_APP taxCalculationStrategy.

Added in Saleor 3.19

useWeightedTaxForShipping

useWeightedTaxForShipping · Boolean

Determines whether to use weighted tax for shipping. When set to true, the tax rate for shipping will be calculated based on the weighted average of tax rates from the order or checkout lines.

Added in Saleor 3.21

Used by

Schema: Saleor 3.23.43. Download SDL.