Sign in

v1

latestOpenAPI 3.0.02026-07-26866217.8 KB
Incomes & Expenses

Create Transaction

Record a new income or expense entry. What the entry is linked to is inferred from the request:

  • provide stay_code to record an entry against a specific stay,
  • provide property_id to record an entry against a specific property,
  • provide neither to record an operator-level entry (not tied to any specific property or stay; only available to the master operator).

stay_code and property_id are mutually exclusive.

The direction field decides whether the entry is an income or an expense, which in turn determines which dictionaries are used for item_id (GET /income_items or GET /expense_items) and payment_method_id (GET /income_methods or GET /expense_methods). The amount is always provided as a positive number; the sign is derived from direction. The currency accompanies the amount and must be supplied unless stay_code is provided, in which case it is inherited from the reservation order and, if you do provide it, it must match the order's currency.

post/transactions

Request body

property_idinteger

The id of the property to record the entry against. Mutually exclusive with stay_code. Omit both to record an operator-level entry.

stay_codestring

The stay_code (returned by GET /reservations) of the stay to record the entry against. Mutually exclusive with property_id. Omit both to record an operator-level entry.

direction'income' | 'expense' required

Whether this entry represents money received (income) or money spent (expense).

amountnumber required

Absolute amount of the entry. Always provide a positive value; the sign is derived from direction.

currencystring

Currency code that accompanies amount. Required unless stay_code is provided; reservation-linked entries inherit the currency from the order and reject mismatching values. See Supported Currencies for more information.

item_idinteger required

The id of the item categorization. Must be a valid id from GET /income_items when direction=income, or from GET /expense_items when direction=expense.

payment_method_idinteger required

The id of the payment method. Must be a valid id from GET /income_methods when direction=income, or from GET /expense_methods when direction=expense.

action_atstring

When the action took place. Accepts ISO 8601 (YYYY-MM-DDTHH:MM:SSZ). Defaults to the current time. If set to a future time the entry is created with status outstanding; otherwise it is paid.

notestring

Free-form note (max 500 characters).

Response

The transaction entry has been successfully created.

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."
}