Skip to content
Longport WhaleLongport Whale
Customer Memo

Customer Remarks Query List

Query the customer remarks list. Combine business filters through filters, and control pagination with page and page_size.

Response

On success, returns the matching list of records together with pagination information. See each field's documentation for the purpose, allowed values, and dynamic data source of every filter.

GEThttps://b-api.longbridge.xyz/v1/datasets/atm_statement_remarks

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

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 below, or the call will be rejected.

Query parameters

filtersobject

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

Child attributes
aaidstring

Filters results by Client.

file_typestring

Filters results by Statement Type.

0 · Daily Statement1 · 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