v1

latestOpenAPI 3.0.02026-07-26866217.8 KB

Incomes & Expenses

Query Incomes & Expenses

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).

get/transactions

Query parameters

idinteger

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.

start_datestring date

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

end_datestring 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.

offsetinteger

The starting point from which to begin returning results.

limitinteger

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

property_idinteger

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

stay_codestring

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

direction'income' | 'expense'

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

item_idinteger

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_idinteger

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

currencystring

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

keywordstring

Substring match on the entry note.

Response

A list of transaction entries with their details.

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}