GET
View a category's taxes
Company space For: Manager, Accountant · Permission: category_taxes.retrieve Conditions
  • Unlike the other category actions, this one does not need the company to hold the categories feature.
  • The caller’s company must have a resolvable fiscal profile (country and fiscal status); the answer reflects only that profile.
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:resource

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

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, title, is_taxable, vat_rate_id.

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: taxes.

Response

200 - application/json

Resource.

id

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

title

Display name of the category.

is_taxable
boolean | null

Whether items of the category are taxed in the current fiscal profile; null when the profile has no configuration for it.

vat_rate_id

Identifier of the VAT rate set for the current fiscal profile; null when none.

taxes
array

Additional taxes of the category in the current fiscal profile, in the order applied. Only returned when selected with ?include=taxes.