PUT
Set tax dependencies
Company space For: Manager, Accountant · Permission: taxes.update Conditions
  • Built-in taxes cannot be changed.
  • dependencies must be present (an empty list removes all links); each tax_id must be listed once and exist in the profile.
  • Each dependency must be an active tax of the same profile and the same application scope as the tax.
  • The resulting graph of the profile must be valid: no cycle, a valid inclusion chain, and effective assignments must not depend on an inactive tax.
  • The change is refused when it would make a stored price impossible to calculate.
What else happens
  • Replaces all dependency links of the tax with the list sent.
  • Changes how totals are computed for every price and order that uses the tax.
Part of Set up VAT and the other taxes.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tax
string
required

Identifier of the tax (27-character KSUID string), within the current company's fiscal profile.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, country_code, fiscal_status, kind, is_builtin, name, code, amount_type, rate, fixed_amount, default_stockable_price_inclusion_policy, default_order_calculation_base, application_scope, is_active, dependencies, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Body

application/json
dependencies
object[]
required

Complete list of the taxes this tax depends on. It replaces the existing links; an empty list removes them all.

Response

Resource (only with response=resource).

id

Identifier of the tax (27-character KSUID string).

country_code

Country of the fiscal profile the tax belongs to (the company's country).

fiscal_status

Fiscal status of the profile the tax belongs to.

kind

vat: the system VAT node of the profile. standard: any other tax.

is_builtin
boolean

True for taxes created by the system; they cannot be changed or deleted.

name

Name of the tax.

code

Unique code of the tax within its fiscal profile.

amount_type

percentage: the tax is a rate applied on a base. fixed: the tax is a fixed amount.

rate

Rate of a percentage tax, up to 6 decimals, sent as a decimal string; null for a fixed tax and for the VAT node, whose rates are VAT rates.

fixed_amount
integer | null

Amount of a fixed tax, in minor units (divide by 10 to the power currency_exponent); null for a percentage tax.

default_stockable_price_inclusion_policy

For item-scope taxes: whether prices include the tax by default (inclusive) or add it on top (exclusive). Null for order-scope taxes.

default_order_calculation_base

For order-scope taxes: the order amount the tax is computed on (items_net_total, items_tax_total or items_gross_total). Null for item-scope taxes.

application_scope

stockable: applied to item prices. order: applied to the whole order.

is_active
boolean

Whether the tax can still be used; an inactive tax is not applied to new assignments.

dependencies
any[]

Taxes this tax is calculated on top of: a list of tax_id and operator (add or substract). Present when the dependency links are loaded.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).