Skip to content
Longport WhaleLongport Whale
Broker Contract

Edit Company Task Settlement

Modify the delayed settlement of an institutional contract. Allowed only when the cash or securities settlement date is not earlier than the ledger date and the source is not an institutional reversal.

Request parameters

  • Required: task_id (task ID), modify_action (delay adjustment type), trade_ledger_date (ledger date)
  • Optional: trade_amount (trade amount), ibond_amount (accrued interest), trade_quantity (trade quantity), expected_balance_settlement_date (cash settlement date), expected_equity_settlement_date (securities settlement date)
  • See each field's description for format, value range, and business meaning.

Risk warning

This operation may change real funds, positions, or trade status. Confirm the target record and parameters before calling.

Result

On success, the operation completes; the resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/billing/company_task_edit

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.contract_manage_query

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

Request body application/json

task_idnumberrequired

Task ID associated with this request.

modify_actionnumberrequired

Specifies Modify Action. This field is required.

Allowed values: 0 Modify both cash and securities, 1 Cash-only adjustment, 2 Securities-only adjustment

Values
0
Modify both cash and securities.
1
Cash-only adjustment.
2
Securities-only adjustment.
trade_amountstring

Required when modify_action is 0/1; must not exceed the original trade_amount.

ibond_amountstring
trade_quantitystring

Required when modify_action is 0 or 2; must not exceed the original trade_quantity.

expected_balance_settlement_datestring
expected_equity_settlement_datestring
trade_ledger_datenumberrequired

Trade ledger date. The ledger date the clearing-contract task belongs to; defaults to the clearing system's current ledger date when creating a new task.

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