---
title: "Query Incomes & Expenses"
method: GET
path: "/transactions"
tags: ["Incomes & Expenses"]
---

# Query Incomes & Expenses

`GET /transactions`

Query income and expense entries (also known as `transactions`) recorded against the operator, properties or reservations.

The response provides each entry with its categorization (`item_id` / `item_name`) and payment method (`payment_method_id` / `payment_method_name`). The values of `item_id` and `payment_method_id` reference the dictionaries returned by `GET /income_items`, `GET /expense_items`, `GET /income_methods` and `GET /expense_methods` (which dictionary applies depends on `direction`).

## Query parameters

- `id` integer
- `start_date` string, date
- `end_date` string, date
- `offset` integer
- `limit` integer
- `property_id` integer
- `stay_code` string
- `direction` 'income' | 'expense'
- `item_id` integer
- `payment_method_id` integer
- `currency` string
- `keyword` string

## Response `200`

A list of transaction entries with their details.

- object
  - `request_id` string, required — Unique identifier for the request.
  - `error_code` integer, required — Numeric error code representing the status of the response. A value of `200` indicates success. <br> See the [Error Codes](/reference/error-manual#error-codes) section for more information.
  - `error_msg` string, required — Message detailing the status of the response.
  - `data` object, required
    - `transactions` object[], required — List of transaction entries.
      - `id` integer, required — Unique identifier of the transaction entry.
      - `direction` 'income' | 'expense', required — Whether the entry represents money received (`income`) or spent (`expense`).
      - `amount` number, required — Absolute amount of the entry, always non-negative; use `direction` to distinguish income from expense.
      - `currency` string, required — The currency code of the entry. See [Supported Currencies](/reference/supported-currencies) for more information.
      - `status` 'paid' | 'outstanding' — Payment status of the entry.
      - `action_at` string, nullable — When the action took place, in ISO 8601 (UTC).
      - `item_id` integer, nullable — The id of the item categorization. References `GET /income_items` when `direction` is `income`, or `GET /expense_items` when `direction` is `expense`.
      - `item_name` string, nullable — Human-readable name of the item, resolved against the item dictionary at the time of the request. May be a localized name for system-default items, or the operator's custom name.
      - `payment_method_id` integer, nullable — The id of the payment method. References `GET /income_methods` when `direction` is `income`, or `GET /expense_methods` when `direction` is `expense`.
      - `payment_method_name` string, nullable — Human-readable name of the payment method.
      - `note` string — Free-form note attached to the entry.
      - `operator_name` string — Display name of the user who created the entry, or `System` for entries created by automated processes.
      - `link_type` 'property' | 'reservation' | 'operator' — What the entry is linked to: `property` (a specific property), `reservation` (a specific stay), or `operator` (the operator account, not tied to any property or reservation).
      - `property_id` integer, nullable — Id of the related property, if any. For reservation-linked entries this resolves to the stay's property; for property-linked entries this is the property itself; null for operator-linked entries.
      - `property_title` string, nullable — Title of the related property.
      - `stay_code` string, nullable — The `stay_code` of the stay the entry is linked to. Null when not linked to a reservation.
      - `created_at` string, nullable — When the entry was created, in ISO 8601 (UTC).
      - `updated_at` string, nullable — When the entry was last updated, in ISO 8601 (UTC).
    - `total` integer, required — Total number of entries matching the filters.

---

[API](https://skmtc.net/hostex/apis/hostex-api.md) · [All operations](https://skmtc.net/hostex/apis/hostex-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hostex/hostex-api/revisions/a3fa555dee66/schema)
