查询收支

get

https://api.myhostex.com/v3/transactions

查询针对房东账号、房间或订单记录的收入和费用条目（也称为 transactions）。

响应为每个条目提供其分类 (item_id / item_name) 和付款方式 (payment_method_id / payment_method_name)。 item_id 和 payment_method_id 的值引用 GET /income_items、GET /expense_items、GET /income_methods 和 GET /expense_methods 返回的字典（应用哪个字典取决于 direction）。

Query Params

integer

特定交易条目的内部ID。提供时，最多返回当前房东账号下的一个匹配条目；然后可以省略 start_date 和 end_date。

start_date

date

操作时间范围的开始，包括在内。格式为 YYYY-MM-DD。以房东账号配置的时区进行解释。除非提供 id，否则是必需的。

end_date

date

动作时间范围结束（含）。格式为 YYYY-MM-DD。以房东账号配置的时区进行解释。从 start_date 到 end_date 的范围不能超过 366 天。除非提供 id，否则是必需的。

offset

integer

Defaults to 0

开始返回结果的起点。

limit

integer

Defaults to 20

要返回的最大结果数。最大值为 100。

property_id

integer

过滤链接到给定房间 ID 的条目（直接根据房间记录，或通过此房间的订单间接记录）。

reservation_code

string

按关联订单过滤（GET /reservations 返回的 reservation_code）。收支一律记在整张订单上，所以多房订单会返回全部房间的分录。传任一房间的 stay_code 也可以，会归一到同一张订单。

stay_code

string

deprecated

reservation_code 的废弃别名，仅为向后兼容保留。任何入住单号都会被归一到它所属的订单，因此不会把结果收窄到单个房间。请改用 reservation_code；只要某一个房间的分录请用 property_id。

direction

string

enum

按方向过滤：income 表示收到的资金，expense 表示支出的资金。

Allowed:

item_id

integer

按项目 ID（条目的分类）过滤。对于收入条目，id 指的是 GET /income_items；对于费用条目，它指的是 GET /expense_items。

payment_method_id

integer

按付款方式 ID 过滤。对于收入条目，id 指的是 GET /income_methods；对于费用条目，它指的是 GET /expense_methods。

currency

string

按货币代码过滤。有关详细信息，请参阅 Supported Currencies。

keyword

string

条目 note 上的子字符串匹配。

Response

200交易条目列表及其详细信息。