Fee Scenario Text

Queries billing-scenario copywriting used to maintain the customer-facing explanatory text for each fee item, organized by market tab.

Request parameters

Combine business filters through filters (see the filters field notes below for the available fields), and use page, page_size, and orderBy to control paging and sorting.

Business notes

Fee-item copy grouped by market (tab) and business type (biz_type).
Each record holds the fee-item name, multilingual charging description, the charging party, remarks, state, and the last editor.
Used to keep the customer-facing charging explanations consistent, such as the calculation basis and minimum-fee notes for transaction levies, SEC fees, and similar items.

Returns

On success, returns the matched record list with pagination. See the response definition for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

billing.account_fee_info_manage

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

Request body application/json

filtersobject

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

Child attributes

tabstring

Filters results by Tab (market tab).

The candidate values change dynamically. Call GET /v1/billing/myrates/markets to retrieve the currently available tabs, and use the returned tabs[].tab as this field's value (e.g. HK, US, US_OPTIONS, HAS).

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Fee Scenario Text 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

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

billing_item_idstring

Returned value: Fee Type.

billing_item_id_valstring

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

biz_typestring

Returned value: Biz Type.

biz_type_valstring

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

contentstring

Returned value: Content.

remarkstring

Returned value: Remark.

merchantstring

Returned value: Merchant.

statestring

Returned value: State.

state_valstring

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.

makerstring

Returned value: Maker.

updated_atstring

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "billing_item_id": "{\"zh-CN\":\"消费税\",\"zh-HK\":\"消費稅\",\"en\":\"GST\"}",
        "billing_item_id_val": "32338",
        "biz_type": "Options Trade",
        "biz_type_val": "5",
        "content": "{\"en\": \"en_content_期权交易_CA_OPTIONS_GST\", \"zh-CN\": \"zh-CN_content_期权交易_CA_OPTIONS_消费税\", \"zh-HK\": \"zh-HK_content_期权交易_CA_OPTIONS_消費稅\"}",
        "remark": "{\"en\": \"en_remark_期权交易_CA_OPTIONS_GST\", \"zh-CN\": \"zh-CN_remark_期权交易_CA_OPTIONS_消费税\", \"zh-HK\": \"zh-HK_remark_期权交易_CA_OPTIONS_消費稅\"}",
        "merchant": "{\"en\": \"en_merchant_期权交易_CA_OPTIONS_GST\", \"zh-CN\": \"zh-CN_merchant_期权交易_CA_OPTIONS_消费税\", \"zh-HK\": \"zh-HK_merchant_期权交易_CA_OPTIONS_消費稅\"}",
        "state": "Off",
        "state_val": "2",
        "maker": "user@example.com",
        "updated_at": "1767757289"
      }
    ],
    "total": 313
  }
}

Export

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

POSThttps://b-api.lbkrs.com/v1/datasets/booking_item_copywritings/download

billing.account_fee_info_manage

Export options Export records Download result