All Client Fee List · Whale Docs

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

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

fee_idstring

Filters results by Fee Details ID.

ref_nostring

Filters results by Business Serial No..

counter_idstring

Filters results by Stock Code.

created_atobject

Filters results by Created Time.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

ledger_dateobject

Filters results by Transaction Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

dtobject

Filters results by Deduction Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

account_atobject

Filters results by Account At.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

bizcodestring

Filters results by Business Type.

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

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.

settlement_channelstring

Filters results by Channel.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated All Client Fee List 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.

fee_idstring

Returned value: Fee Details ID.

ref_nostring

Returned value: Business Serial No..

member_idstring

Returned value: Client ID.

origin_idstring

Returned value: A/C No..

aaidstring

Returned value: AE code.

aaid_valstring

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

bizcodestring

Returned value: Business Type.

bizcode_valstring

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

is_dark_stock_tradingstring

Returned value: Indicates whether dark stock.

is_dark_stock_trading_valstring

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

name_localesstring

Returned value: Stock Name.

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.

fee_code_multi_namestring

Returned value: Fee Code.

currencystring

Returned value: Currency.

account_atstring

Returned value: Account At. The date or time format follows the value returned by the API.

dtstring

Returned value: Deduction Date.

ledger_datestring

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

amountstring

Returned value: Amount.

settlement_channelstring

Returned value: Channel.

created_atstring

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

updated_atstring

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

gst_rate_strstring

Returned value: Gst Rate Str.

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_member_fee_bills' \
  --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",
        "fee_id": "string",
        "ref_no": "string",
        "member_id": "string",
        "origin_id": "string",
        "aaid": "string",
        "aaid_val": "string",
        "bizcode": "string",
        "bizcode_val": "string",
        "is_dark_stock_trading": "string",
        "is_dark_stock_trading_val": "string",
        "name_locales": "string",
        "trade_direction": "string",
        "trade_direction_val": "string",
        "fee_code_multi_name": "string",
        "currency": "string",
        "account_at": "string",
        "dt": "string",
        "ledger_date": "string",
        "amount": "string",
        "settlement_channel": "string",
        "created_at": "string",
        "updated_at": "string",
        "gst_rate_str": "string"
      }
    ],
    "total": 0
  }
}

Export

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

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

Export options Export records Download result