Rules · Whale Docs

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

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>.

Query parameters

filtersobject

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

Child attributes

idstring

Filters results by Entry Rule ID.

source_idstring

Filters results by Entry Data Source.

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

payment_account_type_idstring

Filters results by Payment Account Type.

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

payment_booking_type_idstring

Filters results by Payment business type.

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

payee_account_type_idstring

Filters results by Collecting Account Type.

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

payee_booking_type_idstring

Filters results by Payee business type.

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

name_typesstring

Filters results by Entry Summary.

currencystring

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.

items_debit_querystring

Filters results by Items Debit Query.

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

items_credit_querystring

Filters results by Items Credit Query.

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

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

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

source_idstring

Returned value: Entry Data Source.

source_id_valstring

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

payment_account_type_idstring

Returned value: Payment Account Type.

payment_account_type_id_valstring

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

payment_booking_type_idstring

Returned value: Payment Business Type.

payment_booking_type_id_valstring

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

payment_channel_accountstring

Returned value: Paying Securities Account.

payee_account_type_idstring

Returned value: Collecting Account Type.

payee_account_type_id_valstring

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

payee_booking_type_idstring

Returned value: Collecting Business Type.

payee_booking_type_id_valstring

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

payee_channel_accountstring

Returned value: Receiving Securities Account.

channelstring

Returned value: Channel.

user_account_typestring

Returned value: User Account Type.

user_account_type_valstring

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

currencystring

Returned value: Currency.

currency_valstring

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

org_idstring

Returned value: Securities trader.

org_id_valstring

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

trade_directionstring

Returned value: Trade direction.

trade_direction_valstring

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

nature_typestring

Returned value: Nature of account.

nature_type_valstring

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

bank_accountstring

Returned value: Bank Account.

bank_account_valstring

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

remarkstring

Returned value: Remark.

amount_plus_or_minusstring

Returned value: Amount plus or minus.

amount_plus_or_minus_valstring

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

name_typesstring

Returned value: Entry Summary.

sssstring

Returned value: Entry Summary.

debit_level_full_namestring

Returned value: Debit Account Name (Level 3).

credit_level_full_namestring

Returned value: Credit Account Name (Level 3).

debit_level_custom_namestring

Returned value: Debit Account.

credit_level_custom_namestring

Returned value: Credit Account.

debit_display_brokerstring

Returned value: Debit AE code.

debit_display_broker_valstring

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

credit_display_brokerstring

Returned value: Credit AE code.

credit_display_broker_valstring

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

updated_atstring

Returned value: Updated Time. 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/booking_account_entries' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "string",
        "source_id": "string",
        "source_id_val": "string",
        "payment_account_type_id": "string",
        "payment_account_type_id_val": "string",
        "payment_booking_type_id": "string",
        "payment_booking_type_id_val": "string",
        "payment_channel_account": "string",
        "payee_account_type_id": "string",
        "payee_account_type_id_val": "string",
        "payee_booking_type_id": "string",
        "payee_booking_type_id_val": "string",
        "payee_channel_account": "string",
        "channel": "string",
        "user_account_type": "string",
        "user_account_type_val": "string",
        "currency": "string",
        "currency_val": "string",
        "org_id": "string",
        "org_id_val": "string",
        "trade_direction": "string",
        "trade_direction_val": "string",
        "nature_type": "string",
        "nature_type_val": "string",
        "bank_account": "string",
        "bank_account_val": "string",
        "remark": "string",
        "amount_plus_or_minus": "string",
        "amount_plus_or_minus_val": "string",
        "name_types": "string",
        "sss": "string",
        "debit_level_full_name": "string",
        "credit_level_full_name": "string",
        "debit_level_custom_name": "string",
        "credit_level_custom_name": "string",
        "debit_display_broker": "string",
        "debit_display_broker_val": "string",
        "credit_display_broker": "string",
        "credit_display_broker_val": "string",
        "updated_at": "string"
      }
    ],
    "total": 0
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/booking_account_entries/download

Export options Export records Download result