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.

Body Params
integer

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

string

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.

string
enum
required

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

Allowed:
number
required

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

string

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.

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

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

string

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.

string

Free-form note (max 500 characters).

Response

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