# Invoices

Invoices for bookings

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

## The invoice object

| Attribute | Type | Description |
| --- | --- | --- |
| `id` | `uuid` | Unique identifier. |
| `booking_id` | `uuid \| null` | Identifier of the related booking. References [`bookings.id`](https://www.bookingmood.com/be-BY/api-reference/bookings.md). |
| `organization_id` | `uuid` | Identifier of the organization this invoice is defined in. References [`organizations.id`](https://www.bookingmood.com/be-BY/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. |
| `attachment` | `text \| null` | URL of a custom attachment. |
| `fts` | `tsvector` | Read-only: set by the database. |
| `reference` | `text` | Reference of the invoice. |

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "booking_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-10-30T23:18:45.588Z",
  "updated_at": "2026-10-30T23:18:45.588Z",
  "attachment": "",
  "reference": "ABC123"
}
```

### Related resources

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

| Embed | Type | Description |
| --- | --- | --- |
| `bookings!booking_id(*)` | `object \| null` | The [booking](https://www.bookingmood.com/be-BY/api-reference/bookings.md) referenced by `booking_id`. |
| `organizations(*)` | `object \| null` | The [organization](https://www.bookingmood.com/be-BY/api-reference/organizations.md) referenced by `organization_id`. |
| `line_items(*)` | `array` | The [line items](https://www.bookingmood.com/be-BY/api-reference/line_items.md) referencing this invoice through `line_items.invoice_id`. |
| `payments(*)` | `array` | The [payments](https://www.bookingmood.com/be-BY/api-reference/payments.md) referencing this invoice through `payments.invoice_id`. |
| `refunds(*)` | `array` | The [refunds](https://www.bookingmood.com/be-BY/api-reference/refunds.md) referencing this invoice through `refunds.invoice_id`. |

## List invoices

`GET /v1/invoices`

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

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

Responses:

- `200`: A list of invoices 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 invoices

`POST /v1/invoices`

Insert one invoice or an array of invoices. The body is a `Partial` invoice 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/invoices" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "reference": "ABC123"
  }'
```

Responses:

- `201`: The newly created invoices 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 invoices

`DELETE /v1/invoices`

Filter on any attribute with `column=operator.value` (see [filtering](https://www.bookingmood.com/be-BY/api-reference/filtering.md)). Without filters, this request deletes all invoices 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/invoices?id=eq.00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

Responses:

- `200`: The deleted invoices 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 invoices

`PATCH /v1/invoices`

Filter on any attribute with `column=operator.value` (see [filtering](https://www.bookingmood.com/be-BY/api-reference/filtering.md)). Without filters, this request updates all invoices 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/invoices?id=eq.00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "ABC123"
  }'
```

Responses:

- `200`: The updated invoices 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/be-BY/api-reference.md) for more on errors. The full API is described by the OpenAPI spec at https://api.bookingmood.com/v1/openapi.json.