API Reference

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
integer

Internal id of a specific transaction entry. When supplied, returns at most one matching entry under the current operator; start_date and end_date may then be omitted.

date

Start of the action time range, inclusive. Format YYYY-MM-DD. Interpreted in the operator's configured timezone. Required unless id is supplied.

date

End of the action time range, inclusive. Format YYYY-MM-DD. Interpreted in the operator's configured timezone. The range from start_date to end_date cannot exceed 366 days. Required unless id is supplied.

integer
Defaults to 0

The starting point from which to begin returning results.

integer
Defaults to 20

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

integer

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

string

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

string
enum

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

Allowed:
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.

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.

string

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

string

Substring match on the entry note.

Response

Updated 23 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 23 days ago