Skip to content
Longport WhaleLongport Whale
Customer Memo

Customer Remarks Query List

Query customer statement remark records, used to view and maintain remarks attached to customer statements.

Request parameters

  • Combine business filters through filters (see the filter field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data comes from the statement remark store; each record represents one remark written for a customer's statement.

Each record carries the customer, securities account, statement date, statement type (daily or monthly), remark text, and the last operator and update time.

Remarks are typically used to explain statement handling or special notes, so operators can look them up by customer, statement type, and date.

Returns

On success, returns the list of matching records with pagination. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/atm_statement_remarks

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.statement_customer_remark

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

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes
aaidstring

Filters results by Client.

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.

file_typestring

Filters results by Statement Type.

Allowed values: 0 Daily Statement, 1 Monthly Statement

Values
0
Daily Statement
1
Monthly Statement
dtstring

Filters results by Biz Date.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Client Remark Query List records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Returned value: List of list.

Child attributes
idstring

Returned value: Unique identifier of the current record.

dtstring

Returned value: Biz Date.

account_nostring

Returned value: A/C No..

file_typestring

Returned value: Statement Type.

file_type_valstring

Raw value of file_type. The file_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

remarkstring

Returned value: Remarks.

operatorstring

Returned value: Operator.

updated_atstring

Returned value: Updated At. The date or time format follows the value returned by the API.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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