Skip to content
Statement Query

Run Temporary Statement

Generate a temporary statement for a given customer asset account.

Request parameters

  • Required: aaid (customer asset account), begin_date (start date), end_date (end date), lang (language), refresh_data (whether to refresh data)
  • Optional: remark (remark)
  • See each field description for format, value range, and business meaning.

Business notes

Generates a temporary statement for aaid over the begin_date–end_date range, in the language given by lang. refresh_data controls whether the underlying data is refreshed before generation.

Result

On success the temporary statement is generated; refer to the 200 response for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/portfolio/statement/run_tmp_statement

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_clearing.clearing_gen_statement

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

aaidstringrequired

Selected via the type=member_query_aaid component.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

begin_datestringrequired

The form uses a dt range picker, which is split into begin_date and end_date before submission.

end_datestringrequired

This field is required.

langstringrequired

An enumerated field whose values come from the statement_language_key reference.

Allowed values: 0 App Language, 1 English, 2 Simplified Chinese, 3 Traditional Chinese, 4 Traditional Chinese & English

Values
0
App Language
1
English
2
Simplified Chinese
3
Traditional Chinese
4
Traditional Chinese & English
remarkstring
refresh_dataintegerrequired

This field is required.

Allowed values: 0 Do not refresh data, 1 Refresh data

Values
0
Do not refresh data
1
Refresh data

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

On success data is an empty object.

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs