Skip to main content

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
}
Expand ▼

Fields​

TaxConfiguration.id ● ID! non-null scalar miscellaneous​

The ID of the object.

TaxConfiguration.privateMetadata ● [MetadataItem!]! non-null object miscellaneous​

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

TaxConfiguration.privateMetafield ● String scalar miscellaneous​

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

Tip: Use GraphQL aliases to fetch multiple keys.

TaxConfiguration.privateMetafield.key ● String! non-null scalar miscellaneous​

TaxConfiguration.privateMetafields ● Metadata scalar miscellaneous​

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

TaxConfiguration.privateMetafields.keys ● [String!] list scalar miscellaneous​

TaxConfiguration.metadata ● [MetadataItem!]! non-null object miscellaneous​

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

TaxConfiguration.metafield ● String scalar miscellaneous​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

TaxConfiguration.metafield.key ● String! non-null scalar miscellaneous​

TaxConfiguration.metafields ● Metadata scalar miscellaneous​

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

TaxConfiguration.metafields.keys ● [String!] list scalar miscellaneous​

TaxConfiguration.channel ● Channel! non-null object channels​

A channel to which the tax configuration applies to.

TaxConfiguration.chargeTaxes ● Boolean! non-null scalar miscellaneous​

Determines whether taxes are charged in the given channel.

TaxConfiguration.taxCalculationStrategy ● TaxCalculationStrategy enum taxes​

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.

TaxConfiguration.displayGrossPrices ● Boolean! non-null scalar miscellaneous​

Determines whether displayed prices should include taxes.

TaxConfiguration.pricesEnteredWithTax ● Boolean! non-null scalar miscellaneous​

Determines whether prices are entered with the tax included.

TaxConfiguration.countries ● [TaxConfigurationPerCountry!]! non-null object taxes​

List of country-specific exceptions in tax configuration.

TaxConfiguration.taxAppId ● String scalar miscellaneous​

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

Interfaces​

Node interface miscellaneous​

An object with an ID

ObjectWithMetadata interface miscellaneous​

Returned By​

taxConfiguration query

Member Of​

Channel object ● TaxConfigurationCountableEdge object ● TaxConfigurationUpdate object