Skip to content
Longport WhaleLongport Whale
Statement Query

Statement

查询「结单」数据，可通过 filters 组合业务筛选条件，并使用 page、page_size 控制分页。

返回结果

成功时返回匹配的记录列表及分页信息。各过滤字段的用途、可选值和动态数据来源见对应字段说明。

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

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

Authorizationstringheaderb2b_statement.listaccount.statement_historyRequired

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

Query parameters

filtersobject

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

Child attributes
dtstring

Filters results by Biz Date.

aaidstring

Filters results by Client.

file_typestring

Filters results by Statement Type.

Allowed values:

  • 0 - Daily Statement
  • 1 - Monthly Statement
  • 2 - Temp Statement

0 · Daily Statement1 · Monthly Statement2 · Temp Statement

langstring

Filters results by Language.

Allowed values:

  • en - English
  • zh-CN - Simplified Chinese
  • zh-HK - Traditional Chinese
  • hk-EN - Traditional Chinese & English

en · Englishzh-CN · Simplified Chinesezh-HK · Traditional Chinesehk-EN · Traditional Chinese & English

statement_sendstring

Filters results by Offline Send.

Allowed values:

  • -1 - YES
  • 1 - NO

-1 · YES1 · NO

statestring

Filters results by Status.

Allowed values:

  • -1 - Creation Failed
  • 0 - Creation In Progress
  • 1 - Created Successfully
  • 2 - Sent Successfully
  • 3 - Regenerated

-1 · Creation Failed0 · Creation In Progress1 · Created Successfully2 · Sent3 · Regenerated

broker_codestring

Filters results by A.E. Code.

Values are dynamic. Call GET /v1/datasets/refs/report_broker_accounts to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

da_flagstring

Filters results by Account Mark.

Allowed values:

  • 1 - Discretionary
  • 2 - Virtual Account

1 · Discretionary2 · Virtual Account

ledger_datestring

Filters results by Create Date(Ledger Date)).

disable_batch_sendstring

Filters results by Batch Send.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values:

  • 0 - Enable Batch Send
  • 1 - Only Single Send

0 · Enable Batch Send1 · Only Single Send

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

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

member_idstring

Returned value: Member Id.

account_nostring

Returned value: A/C No..

statement_account_namestring

Returned value: Account Name.

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.

statestring

Returned value: State.

state_valstring

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

disable_batch_sendstring

Returned value: Batch Send.

disable_batch_send_valstring

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

statement_sendstring

Returned value: Offline Send.

statement_send_valstring

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

email_post_idstring

Returned value: Email Message ID.

noticestring

Returned value: Notification.

langstring

Returned value: Language.

lang_valstring

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

member_namestring

Returned value: Client Name.

broker_codestring

Returned value: A.E. Code.

account_markstring

Returned value: Account Mark.

ledger_datestring

Returned value: Create Date(ledger Date)). The date or time format follows the value returned by the API.

generated_atstring

Returned value: Create Time. The date or time format follows the value returned by the API.

senderstring

Returned value: Sender.

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