Skip to content
Longport WhaleLongport Whale
Portfolio Fee

Ahead Settle Portfolio Fee

Settles a securities portfolio-fee contract ahead of schedule, bringing forward principal recovery and settlement of the contract's remaining chargeable balance.

Request parameters

  • Required: id (contract/record ID identifying the target contract to settle early).
  • Optional: audit_frontend_resource (caller-provided audit context).
  • See the field definitions for each field's format, value range, and business meaning.

Business notes

Early settlement changes the target contract's charging and settlement progress. Confirm that id points to the correct contract before calling.

Risk warning

This operation changes a real fee contract and its settlement state. Confirm the target contract and parameters before calling.

Result

On success the target contract is settled early; the resulting state and returned data are defined by the 200 response.

PUThttps://b-api.lbkrs.com/billing/portfolio/settle/ahead

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.fee_operation

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

Request body application/json

idstringrequired

This field is required.

audit_frontend_resourceobject

Provides audit context for this operation.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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