DA Statement Delivery Frequency Management

Query the DA statement delivery frequency management settings. 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_da_frequencies

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

clearing.statement_discretionary_setting

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.

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

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_statement_da_frequencies' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "53711",
        "member_id": "1000000000000000000",
        "origin_id": "H00000000",
        "da_tag": "Discretionary",
        "da_send_month": "{3,6,9,12}",
        "is_send_daily": "Disable Batch Send",
        "is_send_daily_val": "0",
        "operator": "user@example.com",
        "updated_at": "1784149707"
      }
    ],
    "total": 487
  }
}