Skip to content
Longport WhaleLongport Whale
DA Statement Setting

DA Statement Delivery Frequency Management

Query the statement send-frequency settings for discretionary (DA) accounts, used to manage how often statements are sent for these accounts.

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 discretionary-account statement frequency settings; each record represents the send-frequency configuration for one customer (DA-tagged).

Each record carries the member ID, account source, DA tag, the statement send months (for example {3,6,9,12} means quarterly), whether daily batch send is disabled, and the last operator and update time.

This determines in which months a discretionary account generates and sends statements, and whether it takes part in daily batch sending.

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_da_frequencies

Authorization

AuthorizationstringheaderRequired

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

Permission

clearing.statement_discretionary_setting

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.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated DA Statement Delivery Frequency Management 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.

member_idstring

Returned value: Client.

origin_idstring

Returned value: A/C No..

da_tagstring

Returned value: Account Mark.

da_send_monthstring

Returned value: Monthly Satement Batch Send.

is_send_dailystring

Returned value: Indicates whether daily statement batch send.

is_send_daily_valstring

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

operatorstring

Returned value: Last Updated.

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