Skip to content
API raw data

API Deposit Bill

Queries API Deposit Bill 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.

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

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

Authorizationstringheaderatm.api_deposit_message_inquiryRequired

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

Query parameters

filtersobject

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

Child attributes
idstring

ID. Filters results by ID.

refstring

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

from_bank_usernamestring

Name of Counterparty. Filters results by Name of Counterparty.

from_bank_accountstring

Bank Account of Counterparty. Filters results by Bank Account of Counterparty.

lb_bank_accountstring

Company Bank Account. Filters results by Company Bank Account.

to_bank_namestring

Company Bank. Filters results by Company Bank.

bank_remarkstring

Bank Remark. Filters results by Bank Remark.

business_timeobject

Accounting Date (Bank). Filters results by Accounting Date (Bank).

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.

updated_atobject

Updated Time. Filters results by Updated 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. Filters results by Amount.

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.

currencystring

Currency. Filters results by Currency.

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

statusstring

Status. Filters results by Status.

Allowed values:

  • 0 - Not Pushed (Pending Auto Processing)
  • 1 - Pushed
  • 2 - Pending Push Review
  • 3 - Not Pushed (Pending Manual Processing)

0123

drstring

Fund Flows. Filters results by Fund Flows.

Allowed values:

  • 2 - Deposit
  • 1 - Withdraw

21

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 API Deposit Bill 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

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

drstring

Fund Flow. Returned value: Fund Flow.

dr_valstring

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

custom_counterparty_info_from_serverstring

Counterparty Acct Info. Returned value: Counterparty Acct Info.

lb_bank_accountstring

Company Bank Account-A/C No.. Returned value: Company Bank Account-A/C No..

custom_company_bank_account_from_serverstring

Company Bank Account. Returned value: Company Bank Account.

amountstring

Amount (Currency). Returned value: Amount (Currency).

bank_busi_typestring

Bill Info-Business Type. Returned value: Bill Info-Business Type.

bank_ret_msgstring

Bill Info-Cross-bank Return Reason. Returned value: Bill Info-Cross-bank Return Reason.

bank_remarkstring

Bill Info-Bank Remark. Returned value: Bill Info-Bank Remark.

order_contentstring

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

statusstring

Status. Returned value: Status.

status_valstring

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

latest_remarkstring

Backend Remarks. Returned value: Backend Remarks.

updaterstring

Updater. Returned value: Updater.

created_atstring

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

updated_atstring

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

business_timestring

Time-Accounting Date (Bank). Returned value: Time-Accounting Date (Bank). The date or time format follows the value returned by the API.

custom_time_from_serverstring

Time. Returned value: Time.

custom_bill_infostring

Bill Info. Returned value: Bill Info.

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

Whale Docs