Fee Scenario List

Query the list of charging scenarios (billing items) configured in the broker billing system, used by operations to maintain under which conditions and by which rules each business is charged.

Request parameters

Combine business filters through filters (see the filter field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data comes from the charging-scenario configuration of the billing system. Each record represents an enabled billing item, that is, one complete set of charging rules for a business.

Each record carries elements such as fee type, business type, basis type, market/currency, metric type, benchmark rate, and charging direction, together with computation parameters such as fee granularity, coefficient, days of annual fee rate, rounding method, and rounding decimals.

Operations use it to review and reconcile the charging basis of each fee in one place, forming the configuration foundation for maintaining charging rules.

Returns

On success, returns the matching records with pagination. See the response definition for the meaning of each column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_charging.lb_hk_scene_query

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

biz_type_codestring

Filters results by Fee Type.

Values are dynamic. Call GET /v1/datasets/refs/billing_business_type_code 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 Fee Scenario 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.

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.

name_idstring

Returned value: Fee Type.

name_id_valstring

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

basis_typestring

Returned value: Basis Type.

basis_type_valstring

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

basisstring

Returned value: Market/Currency.

metric_typestring

Returned value: Metric Type.

metric_type_valstring

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

benchmark_rate_showstring

Returned value: Benchmark Rate.

granularitystring

Returned value: Fee Granularity.

granularity_valstring

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

coefficientstring

Returned value: Coefficient.

divisorstring

Returned value: Days of Annual Fee Rate.

directionstring

Returned value: Direction.

direction_valstring

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

cutoff_methodstring

Returned value: Rounding Method.

cutoff_method_valstring

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

cutoff_digitsstring

Returned value: Rounding (Decimals).

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/billing_item_for_secondary_item' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "1000000001",
        "biz_type": "1",
        "biz_type_val": "1",
        "name_id": "1000000001",
        "name_id_val": "1",
        "basis_type": "1",
        "basis_type_val": "1",
        "basis": "1",
        "metric_type": "1",
        "metric_type_val": "1",
        "benchmark_rate_show": "1",
        "granularity": "1",
        "granularity_val": "1",
        "coefficient": "string",
        "divisor": "string",
        "direction": "1",
        "direction_val": "1",
        "cutoff_method": "1",
        "cutoff_method_val": "1",
        "cutoff_digits": "2"
      }
    ],
    "total": 1
  }
}