Tax Categories

Taxi & Private Hire › Products › Pricing › Tax Categories

Generally available

Operator-defined tax classifications (standard, reduced, zero, exempt, and so on) that tag chargeable price elements. The category itself carries no rate — rates are resolved separately — and each charge line records the category that applied at the time, so historical receipts reproduce correctly even after tax rules change.

Example request

POST /client/{clientId}/taxcategory ▷ Try it

{
  "code": "<string>",
  "name": "<string>",
  "description": "<string>"
}

Example shape, derived from the TaxCategory fields — indicative, not the authoritative schema (that arrives with the API reference).

Endpoints

Method	Path
POST	/client/{clientId}/taxcategory · primary	▷ Try it
GET	/client/{clientId}/taxcategory/{taxCategoryId}	▷ Try it
POST	/client/{clientId}/taxcategory/{taxCategoryId}	▷ Try it

Full request/response schemas and an interactive explorer will live in the API reference (coming soon).

Related

• Tariffs
• Tenant Capabilities
• Trip Charges

Fields

Field	Type	Description
code	string	Short operator-defined identifier (STANDARD / REDUCED / ZERO / EXEMPT by convention; not enforced). Unique per client via UNIQ_TAX_CATEGORY_CODE — each tenant owns its own taxonomy. Snapshotted onto TripChargeItem.taxCategoryId at write time so historical receipts stay reproducible after tax rule changes.
name	string	Human-readable label shown in the operator UI ("Standard Rate", "Reduced — Tourism"). Paired with `code`; queryable via `queryFields()`.
description	string	Free-text notes about the category — typically the regulatory basis ("VAT exempt per s.39, VAT Act 2010"). Operator-only audit context; not consumed by the tax-rate resolver.
clientId	bigint	Tenant scope. Every tenant-aware entity carries this; `ClientFilter` enforces row-level isolation on read; the multi-tenancy routing layer (`/client/{clientId}`) sets it at create time. Surfaced only under `admin` / `tripLog` groups — never to end users.
internalKey	string	Optional client-supplied external reference / idempotency key. When present, lets external systems correlate platform-side records back to their own source-of-truth ids. Not persisted to a column — populated by the request handler when the caller sets it.
__objectType	string	Discriminator string (entity class short-name) emitted alongside the id in serialized output. Resolved at read time by `getObjectType()`; lets the FE dispatch entity-specific rendering without inspecting the URL.
id	bigint	Snowflake-style primary key (unsigned BIGINT). Generated by `IdFactory` at create time; surfaced to the FE / API as a `G`-prefixed string and stripped back to plain bigint server-side before Doctrine lookup.
createdDate	integer	Unix timestamp the row was first persisted. Set in the entity's PrePersist hook; never rewritten on subsequent updates.
updatedDate	integer	Unix timestamp the row was last touched. Bumped on every commit that hits the Doctrine UoW for this entity; drives FE invalidation + the listing change cursor.
passiveUpdatedDate	int	Read-through alias for `updatedDate` exposed under different serializer groups. Lets the FE distinguish "real edit" from "background touch" projections without changing the underlying column.
listingUpdatedDate	int	Listing-projection timestamp surfaced only under the `listMode` group. Driven by `TripCache` and other listing-shape refreshers separately from `updatedDate` so a listing rebuild doesn't trigger detail-page invalidation.