Skip to content
Longport WhaleLongport Whale
Cost Statement

Cost Bill

Queries clearing cost bills, used to reconcile the upstream or broker cost behind each charge.

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

Data is derived by linking contract charges to billing items, and reflects the cost side of a fee rather than the revenue actually charged to the client.

Each record carries the business type, charge type, fee-rate currency, billing currency, order amount, money-flow direction, cost amount, manual remark, and update time.

Records can be filtered by update time, business type, charge type, and billing currency for cost accounting and reconciliation.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

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

name_idstring

Filters results by Name ID.

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.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Cost Bill 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
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_zhstring

Returned value: Name Zh.

fee_rate_currencystring

Returned value: Fee Rate Currency.

bill_currencystring

Returned value: Bill Currency.

metricstring

Returned value: Metric.

money_flow_directionstring

Returned value: Money Flow 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.

amountstring

Returned value: Amount.

remarkstring

Returned value: Remark.

updated_atstring

Returned value: Updated At. 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

Whale Docs