Skip to content
Longport WhaleLongport Whale
Agent Billing

Company Fee Detail

Retrieves the fee configuration of a single organization-fee record by id.

Request parameters

  • Required: id (organization-fee record id), passed as a query parameter.

Returns

On success, returns the organization-fee configuration in data.fee. See the response definition below for field meanings.

GEThttps://b-api.lbkrs.com/billing/company_fee

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_charging.lb_hk_scene_update

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

Parameters

idstringRequired

Company fee record id.

Responses

HTTP 200The request was processed successfully. data.fee contains the fee configuration.
Standard response envelopecodemessagedata
dataobjectdata structure
feeobject

Fee configuration. Key sub-fields:

  • billing_item_id: id of the associated charging scene.
  • currency: currency.
  • min / max / threshold: billing range and starting threshold.
  • rates: tiered rate list; each tier has gt, lte, fee_rate, min.
  • fee_rate_type: fee rate type.
  • special_fees: special rate list; each item has conditions (matching conditions, e.g. by stock symbol) and its own rate parameters.
  • metric_type / granularity: metric type and billing granularity.
  • cutoff_method / cutoff_digits: rounding method and retained digits.
  • billing_item: embedded charging scene configuration; fields are the same as "Charging Scene Detail".
  • calculation_method: calculation method.
custodian_idstring

Custodian ID associated with this organization fee.

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