https://b-api.longbridge.xyz/v1/datasets/atm_statement_historiesDataset 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
Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.
Permission
The Broker ACCESS_TOKEN must be granted the permission below, or the call will be rejected.
Query parameters
Combines business filters. Omit a filter field to disable that filter.
Child attributes
Filters results by Biz Date.
Filters results by Client.
Filters results by Statement Type.
0 · Daily Statement1 · Monthly Statement2 · Temp Statement
Filters results by Language.
en · Englishzh-CN · Simplified Chinesezh-HK · Traditional Chinesehk-EN · Traditional Chinese & English
Filters results by Offline Send.
-1 · YES1 · NO
Filters results by Status.
-1 · Creation Failed0 · Creation In Progress1 · Created Successfully2 · Sent3 · Regenerated
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.
Filters results by Account Mark.
1 · Discretionary2 · Virtual Account
Filters results by Create Date(Ledger Date)).
Filters results by Batch Send.
Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.
0 · Enable Batch Send1 · Only Single Send
Page number to retrieve, starting from 1.
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.codemessagedatadataobjectdata structureReturned value: List of list.
Child attributes
Returned value: Unique identifier of the current record.
Returned value: Biz Date.
Returned value: Member Id.
Returned value: A/C No..
Returned value: Account Name.
Returned value: Statement Type.
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.
Returned value: State.
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.
Returned value: Batch Send.
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.
Returned value: Offline Send.
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.
Returned value: Email Message ID.
Returned value: Notification.
Returned value: Language.
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.
Returned value: Client Name.
Returned value: A.E. Code.
Returned value: Account Mark.
Returned value: Create Date(ledger Date)). The date or time format follows the value returned by the API.
Returned value: Create Time. The date or time format follows the value returned by the API.
Returned value: Sender.
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.codemessagedatadataobjectdata structureNo nested fields
HTTP 401The user is not authenticated, or the login session has expired.codemessagedatadataobjectdata structureNo nested fields
HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.codemessagedatadataobjectdata structureNo nested fields
HTTP 408The request timed out. Check the business error code in code and the error details in message.codemessagedatadataobjectdata structureNo nested fields