Admin Settings: Tax Categories

Update a tax category

Code uniqueness excludes the current id. Re-syncs the tax_rates pivot to the supplied taxrates list.

put/settings/tax-categories/{id}

Request

Path parameters

idstring required

Settings tax category ID

Request body

codestring required
namestring required
descriptionstring required
taxratesinteger[] required

Example request

{
  "code": "reduced-rate",
  "name": "Reduced Rate",
  "description": "Reduced VAT for essentials",
  "taxrates": [
    1
  ]
}

Response

Tax category updated.

idinteger
codestring
namestring
descriptionstring
createdAtstring date-time nullable
updatedAtstring date-time nullable
messagestring
taxRatesstring[]

Example response

{
  "taxRates": [
    "https://example.com/"
  ]
}

Changes

No recorded changes to this operation across all 8 revisions of this API.