Query Incomes & Expenses

get

https://api.hostex.io/v3/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 Params

start_date

date

required

Start of the action time range, inclusive. Format YYYY-MM-DD.

end_date

date

required

End of the action time range, inclusive. Format YYYY-MM-DD. The range from start_date to end_date cannot exceed 366 days.

offset

integer

Defaults to 0

The starting point from which to begin returning results.

limit

integer

Defaults to 20

The maximum number of results to return. The maximum value is 100.

property_id

integer

Filter entries linked to the given property id (either directly recorded against the property, or indirectly through a reservation on this property).

stay_code

string

Filter entries linked to the given stay (the stay_code returned by GET /reservations).

direction

string

enum

Filter by direction: income for money received, expense for money spent.

Allowed:

item_id

integer

Filter by item id (the categorization of the entry). For income entries the id refers to GET /income_items; for expense entries it refers to GET /expense_items.

payment_method_id

integer

Filter by payment method id. For income entries the id refers to GET /income_methods; for expense entries it refers to GET /expense_methods.

currency

string

Filter by currency code. See Supported Currencies for more information.

keyword

string

Substring match on the entry note.

Response

200A list of transaction entries with their details.