# Taxes

Reusable tax definitions

Endpoint: `https://api.bookingmood.com/v1/taxes`, supporting `GET`, `POST`, `DELETE`, `PATCH`. Authenticate with the header `Authorization: Bearer YOUR_API_KEY` (see [authentication](https://www.bookingmood.com/en-GB/api-reference/authentication.md)).

## The tax object

| Attribute | Type | Description |
| --- | --- | --- |
| `id` | `uuid` | Unique identifier. |
| `organization_id` | `uuid` | Identifier of the organization this tax is defined in. References [`organizations.id`](https://www.bookingmood.com/en-GB/api-reference/organizations.md). |
| `created_at` | `timestamp with time zone` | Creation timestamp. Read-only: set by the database. |
| `updated_at` | `timestamp with time zone` | Last modification timestamp. Read-only: set by the database. |
| `fts` | `tsvector \| null` | Full text search index. Read-only: set by the database. |
| `label` | `MultiLanguageString` | Localized label of the tax. |
| `percentage` | `real` | Percentage of the tax. |
| `type` | `TaxType` | Type of the tax: `on-top` or `included`. |

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-10-30T22:38:02.840Z",
  "updated_at": "2026-10-30T22:38:02.840Z",
  "label": {},
  "percentage": 0,
  "type": "on-top"
}
```

### Types

```typescript
type Language = 
  | "be-BY"
  | "bg-BG"
  | "cs-CZ"
  | "da-DK"
  | "de-DE"
  | "en-GB"
  | "en-NZ"
  | "en-US"
  | "es-ES"
  | "eu-ES"
  | "fr-FR"
  | "gr-EL"
  | "he-IL"
  | "hr-HR"
  | "hu-HU"
  | "it-IT"
  | "ja-JP"
  | "lt-LT"
  | "lv-LV"
  | "nl-NL"
  | "nn-NO"
  | "pl-PL"
  | "pt-BR"
  | "ro-RO"
  | "ru-RU"
  | "sk-SK"
  | "sl-SI"
  | "sr-Cyrl"
  | "sr-Latn"
  | "sv-SE"
  | "tr-TR"
  | "uk-UA";

type MultiLanguageString = {
  default: string;
} & Partial<Record<Language, string>>;

type TaxType = "on-top" | "included";
```

### Related resources

Embed related resources with the [`select` parameter](https://www.bookingmood.com/en-GB/api-reference/selecting.md), e.g. `select=*,organizations(*)`. Resources related through more than one column need the column as a hint, like `table!column(*)`.

| Embed | Type | Description |
| --- | --- | --- |
| `organizations(*)` | `object \| null` | The [organization](https://www.bookingmood.com/en-GB/api-reference/organizations.md) referenced by `organization_id`. |
| `line_item_taxes(*)` | `array` | The [line item taxes](https://www.bookingmood.com/en-GB/api-reference/line_item_taxes.md) referencing this tax through `line_item_taxes.tax_id`. |

## List taxes

`GET /v1/taxes`

Filter on any attribute with `column=operator.value` (see [filtering](https://www.bookingmood.com/en-GB/api-reference/filtering.md)). Choose columns and embed related resources with `select` (see [selecting](https://www.bookingmood.com/en-GB/api-reference/selecting.md)), and sort and paginate with `order`, `limit` and `offset` (see [sorting and pagination](https://www.bookingmood.com/en-GB/api-reference/sorting-pagination.md)).

```bash
curl -X GET "https://api.bookingmood.com/v1/taxes?select=*&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

Responses:

- `200`: A list of taxes with the selected columns. `206` when the list is a partial range.
- `400`: The request is malformed, for example an unknown column or an invalid filter.
- `401`: The API key is missing or invalid.

## Create taxes

`POST /v1/taxes`

Insert one tax or an array of taxes. The body is a `Partial` tax object, so columns with a default can be left out. Read-only attributes can't be written.

```bash
curl -X POST "https://api.bookingmood.com/v1/taxes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "label": {},
    "percentage": 0,
    "type": "on-top"
  }'
```

Responses:

- `201`: The newly created taxes with the selected columns.
- `400`: The request is malformed, for example an unknown column, an invalid filter or an invalid body.
- `401`: The API key is missing or invalid.
- `403`: The API key has no permission for this change, for example when writing rows of another organization.
- `409`: The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.

## Delete taxes

`DELETE /v1/taxes`

Filter on any attribute with `column=operator.value` (see [filtering](https://www.bookingmood.com/en-GB/api-reference/filtering.md)). Without filters, this request deletes all taxes you have access to. Always filter on at least one column, e.g. `id=eq.{id}`.

```bash
curl -X DELETE "https://api.bookingmood.com/v1/taxes?id=eq.00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

Responses:

- `200`: The deleted taxes with the selected columns. `204` without a body when sending the header `Prefer: return=minimal`.
- `400`: The request is malformed, for example an unknown column or an invalid filter.
- `401`: The API key is missing or invalid.
- `403`: The API key has no permission for this change, for example when writing rows of another organization.

## Update taxes

`PATCH /v1/taxes`

Filter on any attribute with `column=operator.value` (see [filtering](https://www.bookingmood.com/en-GB/api-reference/filtering.md)). Without filters, this request updates all taxes you have access to. Always filter on at least one column, e.g. `id=eq.{id}`. The body holds the attributes to change.

```bash
curl -X PATCH "https://api.bookingmood.com/v1/taxes?id=eq.00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label": {}
  }'
```

Responses:

- `200`: The updated taxes with the selected columns. `204` without a body when sending the header `Prefer: return=minimal`.
- `400`: The request is malformed, for example an unknown column, an invalid filter or an invalid body.
- `401`: The API key is missing or invalid.
- `403`: The API key has no permission for this change, for example when writing rows of another organization.
- `409`: The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.

Errors have a JSON body with a `code`, `message`, `details` and `hint`. See the [introduction](https://www.bookingmood.com/en-GB/api-reference.md) for more on errors. The full API is described by the OpenAPI spec at https://api.bookingmood.com/v1/openapi.json.