Bank Statement-Deposit

Queries Bank Statement-Deposit data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

POSThttps://b-api.lbkrs.com/v1/datasets/atm_bank_bill_deposits

Authorization

AuthorizationstringheaderRequired

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

Permission

accounting.list_accounting_deposit

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

filtersobject

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

Child attributes

idstring

Deposit Bill ID. Filters results by Deposit Bill ID.

member_idstring

Client ID. Filters results by Client ID.

channel_accountstring

A/C No.. Filters results by A/C No..

detail_idstring

Deposit Detail ID. Filters results by Deposit Detail ID.

bank_serial_nostring

Bank Serial No.. Filters results by Bank Serial No..

bank_user_namestring

Payer Name. Filters results by Payer Name.

bank_accountstring

Debit Bank Account. Filters results by Debit Bank Account.

show_fund_type_idstring

Deposit Type. Filters results by Deposit Type.

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

match_statestring

Match State. Filters results by Match State.

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

Values

1: Matched
2: Unmatch
4: Manually Match
5: Pending Transfer Audit
6: Frozen

statestring

Deposit Status. Filters results by Deposit Status.

Values

3: Match
4: Counter Deal
5: Load Completed
8: Failed
9: Deleted
100: Pending Release
200: Pending Release Review
6: Rejected

bill_datetimeobject

Date Recorded. Filters results by Date Recorded.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

currencystring

Currency. Filters results by Currency.

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

updated_atobject

Update Time. Filters results by Update Time.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

amountobject

Amount Received. Filters results by Amount Received.

Child attributes

gtenumber

Greater Than or Equal. Inclusive lower bound of the filter range.

ltenumber

Less Than or Equal. Inclusive upper bound of the filter range.

lb_channel_accountstring

Bank Account No.. Filters results by Bank Account No..

lb_channelstring

Bank. Filters results by Bank.

invisiblestring

Is Hidden. Filters results by Is Hidden.

Values

0: Visible
1: Invisible

bank_remarkstring

Bank Remark. Filters results by Bank Remark.

rms_dateobject

Deposit Date. Filters results by Deposit Date.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Bank Statement-Deposit records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

idstring

Deposit Bill ID. Returned value: Unique identifier of the current record.

detail_idstring

Deposit Detail ID. Returned value: Deposit Detail ID.

show_fund_type_idstring

Deposit Type. Returned value: Deposit Type.

show_fund_type_id_valstring

Deposit Type (raw value). Raw value of show_fund_type_id. The show_fund_type_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

bank_accountstring

Debit Bank Account. Returned value: Debit Bank Account.

bank_user_namestring

Payer Name. Returned value: Payer Name.

currencystring

Currency. Returned value: Currency.

amountstring

Amount Received. Returned value: Amount Received.

lb_channel_accountstring

Bank Account No.. Returned value: Bank Account No..

lb_channelstring

Bank. Returned value: Bank.

member_idstring

Client ID. Returned value: Client ID.

customer_namestring

Customer Name. Returned value: Customer Name.

channel_accountstring

A/C No.. Returned value: A/C No..

bill_datetimestring

Date Recorded. Returned value: Date Recorded. The date or time format follows the value returned by the API.

rms_datestring

Deposit Date. Returned value: Deposit Date. The date or time format follows the value returned by the API.

bank_serial_nostring

Bank Serial No.. Returned value: Bank Serial No..

match_statestring

Match State. Returned value: Match State.

match_state_valstring

Match State (raw value). Raw value of match_state. The match_state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

show_statestring

Deposit Status. Returned value: Deposit Status.

show_state_valstring

Deposit Status (raw value). Raw value of show_state. The show_state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

detail_reasonstring

Reason. Returned value: Reason.

order_id_showstring

Order ID. Returned value: Order ID.

bank_busi_typestring

Business Type. Returned value: Business Type.

bank_sub_accountstring

Sub Account. Returned value: Sub Account.

bank_ret_msgstring

Reason For Inter Bank Return. Returned value: Reason For Inter Bank Return.

bank_remarkstring

Bank Remark. Returned value: Bank Remark.

balancestring

Bank Balance. Returned value: Bank Balance.

updated_atstring

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

remarkstring

Remark. Returned value: Remark.

invisiblestring

Is Hide. Returned value: Is Hide.

invisible_valstring

Is Hide (raw value). Raw value of invisible. The invisible field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Total. 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 --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/atm_bank_bill_deposits' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "377429",
        "detail_id": "3161126035",
        "show_fund_type_id": "Client Deposit",
        "show_fund_type_id_val": "2",
        "bank_account": "Zhang San",
        "bank_user_name": "Zhang San",
        "currency": "HKD",
        "amount": "70,000.00",
        "lb_channel_account": "861520160012",
        "lb_channel": "072-072 ICBC (Asia) Ltd",
        "member_id": "101456715",
        "customer_name": "Zhang San",
        "channel_account": "H00000000",
        "bill_datetime": "1784131200",
        "rms_date": "1784183889",
        "bank_serial_no": "",
        "match_state": "Manually Match",
        "match_state_val": "4",
        "show_state": "Load Completed",
        "show_state_val": "5",
        "detail_reason": "",
        "order_id_show": "188731",
        "bank_busi_type": "",
        "bank_sub_account": "",
        "bank_ret_msg": "",
        "bank_remark": "",
        "balance": "",
        "updated_at": "1784183889",
        "remark": "--",
        "invisible": "Visible",
        "invisible_val": "0"
      }
    ],
    "total": 486
  }
}