Skip to content
Longport WhaleLongport Whale
Fee Logic Setups

Get Billing Item Names

Returns the available billing types (billing-item names) for a biz_type, for use in dependent name_id dropdowns such as the Create Billing Scenario form.

Request parameters

  • Required: biz_type (biz_type)
  • See each field for its format, allowed values, default behavior, and business meaning.

Result

On success, the endpoint returns the requested data. See the 200 response schema for details.

GEThttps://b-api.longbridge.xyz/billing/billing_item_name

Authorization

AuthorizationstringheaderRequired

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

Parameters

biz_typestringRequired

Business type used to filter fee types.

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

Responses

HTTP 200The request was processed successfully. data contains names.
Standard response envelopecodemessagedata
dataobjectdata structure
namesarray<object>

Returned value: List of billing item names.

Child attributes
idnumber

Submitted as the name_id field when creating a billing scenario.

name_enstring

Returned value: Name (English).

name_zhstring

Returned value: Name (Simplified Chinese).

name_zh_hkstring

Returned value: Name (Traditional Chinese).

statenumber

See the billing_item_name_state data dictionary for value definitions.

charing_partynumber

See the billing_item_name_charing_party reference data for value meanings.

typenumber

See the billing_item_name_type data dictionary for value definitions.

codestring

Returned value: Fee Code.

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