Cash Reservation Query

query_reserves

Version

Available in v2.2.9 and later.

Parameters

Field	Type	Description
account	Account	Account

Result

Field	Type	Description
is_success	bool	Whether the request succeeded
data	ReserveCashSummary	Account-wide pre-collected cash summary
message	string	Error message when is_success is false

Pre-collected cash summary: ReserveCashSummary fields

Return type : Object

Field	Type	Description
branch_no	string	Branch code
account	string	Account
currency	string	Currency: TWD
reserved_amount	int	Pre-collected amount (TWD)
returned_amount	int	Returned amount (TWD)
ordered_amount	int	Amount used by orders (TWD)

Request example

sdk.stock.query_reserves(account)

Response example

Result {
    is_success: True,
    message: None,
    data : ReserveCashSummary {
        branch_no: "20207",          # Branch code (string)
        account: "9801163",          # Account (string)
        currency: "TWD",             # currency (string)
        reserved_amount: 9960200,    # pre-collected amount (int)
        returned_amount: 0,          # returned amount (int)
        ordered_amount: 0,           # amount used by orders (int)
}}