> For the complete documentation index, see [llms.txt](https://docs.podplay.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.podplay.app/api/venues/taxes.md).

# Taxes

Tax configurations and rates for different venues and regions.

## GET /taxes/categories

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Taxes","description":"Tax configurations and rates for different venues and regions."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TaxCategoryCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TaxCategoryDto"}},"_total":{"type":"number"},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_pagination","_links"]},"TaxCategoryDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"isDefault":{"type":"boolean"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"createdDate":{"format":"date-time","type":"string","readOnly":true},"updatedDate":{"format":"date-time","type":"string","readOnly":true},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","taxes","region","createdDate","updatedDate","createdBy","updatedBy","errors","_links"]},"TaxDto":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"amount":{"type":"number","readOnly":true,"description":"Amount (in $) corresponding to this tax item"},"percentage":{"type":"number","readOnly":true,"description":"Tax percentage that was applied to a subtotal amount, used to display the tax rate. eg: {TaxName}: 9%"}},"required":["name","amount","percentage"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/taxes/categories":{"get":{"operationId":"TaxesController_find","parameters":[{"name":"regionId","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"areaId","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"ipp","required":false,"in":"query","schema":{"type":"number"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `TaxCategoryCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxCategoryCollectionDto"}}}},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["Taxes"]}}}}
```

## POST /taxes/categories

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Taxes","description":"Tax configurations and rates for different venues and regions."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TaxCategoryDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"isDefault":{"type":"boolean"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"createdDate":{"format":"date-time","type":"string","readOnly":true},"updatedDate":{"format":"date-time","type":"string","readOnly":true},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","taxes","region","createdDate","updatedDate","createdBy","updatedBy","errors","_links"]},"TaxDto":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"amount":{"type":"number","readOnly":true,"description":"Amount (in $) corresponding to this tax item"},"percentage":{"type":"number","readOnly":true,"description":"Tax percentage that was applied to a subtotal amount, used to display the tax rate. eg: {TaxName}: 9%"}},"required":["name","amount","percentage"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/taxes/categories":{"post":{"operationId":"TaxesController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxCategoryDto"}}}},"responses":{"201":{"description":"Returns a `TaxCategory`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxCategoryDto"}}}},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"422":{"description":"Returns an `ErrorDto` in case of validation errors or failures.<br/><br>Possible error codes are:<br>`T0001`: Region is required.<br>`T0002`: Region does not exist.<br>`T0003`: Area does not exist.<br>`T0004`: Tax category already exists.<br>`T0005`: Area does not belong to the given region.<br>`T0006`: Region cannot be changed.<br>`T0007`: Area cannot be changed."}},"tags":["Taxes"]}}}}
```

## GET /taxes/categories/{taxCategoryId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Taxes","description":"Tax configurations and rates for different venues and regions."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TaxCategoryDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"isDefault":{"type":"boolean"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"createdDate":{"format":"date-time","type":"string","readOnly":true},"updatedDate":{"format":"date-time","type":"string","readOnly":true},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","taxes","region","createdDate","updatedDate","createdBy","updatedBy","errors","_links"]},"TaxDto":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"amount":{"type":"number","readOnly":true,"description":"Amount (in $) corresponding to this tax item"},"percentage":{"type":"number","readOnly":true,"description":"Tax percentage that was applied to a subtotal amount, used to display the tax rate. eg: {TaxName}: 9%"}},"required":["name","amount","percentage"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/taxes/categories/{taxCategoryId}":{"get":{"operationId":"TaxesController_findById","parameters":[{"name":"taxCategoryId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `TaxCategory`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxCategoryDto"}}}},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"404":{"description":"TaxCategory not found"}},"tags":["Taxes"]}}}}
```

## DELETE /taxes/categories/{taxCategoryId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Taxes","description":"Tax configurations and rates for different venues and regions."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TaxCategoryDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"isDefault":{"type":"boolean"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"createdDate":{"format":"date-time","type":"string","readOnly":true},"updatedDate":{"format":"date-time","type":"string","readOnly":true},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","taxes","region","createdDate","updatedDate","createdBy","updatedBy","errors","_links"]},"TaxDto":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"amount":{"type":"number","readOnly":true,"description":"Amount (in $) corresponding to this tax item"},"percentage":{"type":"number","readOnly":true,"description":"Tax percentage that was applied to a subtotal amount, used to display the tax rate. eg: {TaxName}: 9%"}},"required":["name","amount","percentage"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/taxes/categories/{taxCategoryId}":{"delete":{"operationId":"TaxesController_delete","parameters":[{"name":"taxCategoryId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `TaxCategory`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxCategoryDto"}}}},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"404":{"description":"TaxCategory not found"}},"tags":["Taxes"]}}}}
```

## PATCH /taxes/categories/{taxCategoryId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Taxes","description":"Tax configurations and rates for different venues and regions."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TaxCategoryDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"isDefault":{"type":"boolean"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/TaxDto"}},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"createdDate":{"format":"date-time","type":"string","readOnly":true},"updatedDate":{"format":"date-time","type":"string","readOnly":true},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","taxes","region","createdDate","updatedDate","createdBy","updatedBy","errors","_links"]},"TaxDto":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"amount":{"type":"number","readOnly":true,"description":"Amount (in $) corresponding to this tax item"},"percentage":{"type":"number","readOnly":true,"description":"Tax percentage that was applied to a subtotal amount, used to display the tax rate. eg: {TaxName}: 9%"}},"required":["name","amount","percentage"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/taxes/categories/{taxCategoryId}":{"patch":{"operationId":"TaxesController_update","parameters":[{"name":"taxCategoryId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxCategoryDto"}}}},"responses":{"200":{"description":"Returns a `TaxCategory`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxCategoryDto"}}}},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"404":{"description":"TaxCategory not found"},"422":{"description":"Returns an `ErrorDto` in case of validation errors or failures.<br/><br>Possible error codes are:<br>`T0001`: Region is required.<br>`T0002`: Region does not exist.<br>`T0003`: Area does not exist.<br>`T0004`: Tax category already exists.<br>`T0005`: Area does not belong to the given region.<br>`T0006`: Region cannot be changed.<br>`T0007`: Area cannot be changed."}},"tags":["Taxes"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.podplay.app/api/venues/taxes.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.