Skip to content
Longport WhaleLongport Whale
Fee Details

User Bill Detail

Queries client charge line items — the per-billing-item breakdown of client charges, forming the detail layer beneath the client statement.

Request parameters

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

Business notes

Each record is a single fee line for one charge type under a client contract.

A record carries the contract number, client securities account, business date, business type, charge type, fee-rate currency, billing currency, order amount, calculated amount, discount amount, final charged amount, money-flow direction, deduction time, and remark.

Records can be filtered by update time, business type, contract number, charge type, billing currency, client, and business date for line-by-line reconciliation of client charges.

Returns

On success, returns the matching records with pagination. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_charging.lb_hk_userbill_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
updated_atobject

Filters results by Updated At.

Child attributes
gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

biz_typestring

Filters results by Biz Type.

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

contract_nostring

Filters results by Contract No.

name_idstring

Filters results by Fee Type.

Values are dynamic. Call GET /v1/datasets/refs/billing_item_names_zh 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 to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

aaidstring

Filters results by Client.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

biz_datestring

Filters results by Biz Date.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

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

contract_nostring

Returned value: Contract No.

biz_datestring

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

origin_idstring

Returned value: A/C No..

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.

namestring

Returned value: Fee Type.

bill_currencystring

Returned value: Currency (Fee).

fee_rate_currencystring

Returned value: Currency (Rate).

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.

metricstring

Returned value: Metric Amt.

calculate_out_amountstring

Returned value: Fee After Discount.

amountstring

Returned value: Amount.

deduction_amountstring

Returned value: Fee Discount.

money_flow_directionstring

Returned value: Direction.

money_flow_direction_valstring

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

remarkstring

Returned value: Remarks.

charged_atstring

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

updated_atstring

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

step_before_metricstring

Returned value: Gradient Initial Value.

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

Whale Docs