PUT
Set a category's taxes
Company space For: Manager, Accountant · Permission: category_taxes.update Conditions
  • At least one of is_taxable, vat_rate_id or tax_ids must be sent, and no other field is accepted.
  • The vat_rate_id must be an active VAT rate of the organization’s tax profile (same country and fiscal status as the company).
  • Every tax in tax_ids must exist in the organization’s current profile, be active, have the item scope, not be of kind VAT, and appear only once.
  • When taxes are assigned, the profile must have exactly one active item-scope VAT tax and every tax reached through dependencies must be active, otherwise the call is refused.
  • The change is refused when it would make a stored price of an item in this category impossible to calculate, unless it was already impossible.
What else happens
  • Rewrites the category’s tax configuration (taxable flag and VAT rate) for the current fiscal profile when is_taxable or vat_rate_id is sent.
  • Replaces the whole list of additional taxes with tax_ids, keeping the order sent; an empty list removes them all.
  • Changes how stored prices of items that inherit from this category are taxed.
Part of Apply taxes to products and orders.

Authorizations

Authorization
string
header
required

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

Path Parameters

category
string
required

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

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
is_taxable
boolean

Whether the category is taxable in the company's current fiscal profile. When omitted, the stored value is kept (false when no configuration exists yet).

vat_rate_id
string | null

Identifier of an active VAT rate of the organization matching the company's country and fiscal status. Send null to clear it; when omitted, the stored value is kept.

Required string length: 27
tax_ids
string[]

Identifiers (27-character KSUID strings) of the additional taxes of the category, in the order they apply. The list replaces the stored one; an empty list removes all of them. Taxes must be active, of item scope, not of kind VAT, and listed once. At least one of is_taxable, vat_rate_id or tax_ids is required.

Required string length: 27

Response

Resource (only with response=resource).

data
TaxResource · object[]
required

Items of this page.