Skip to content
Longport WhaleLongport Whale
Broker Contract

Edit Company Task Settlement

Updates settlement only when both cash and security settlement dates are on or after the accounting date and the source is not an institutional reversal.

Request parameters

  • Required: task_id (Task ID), modify_action (Modify Action), trade_ledger_date (Trade Ledger Date)
  • Optional: trade_amount (Trade Amount), ibond_amount (IBond Amount), trade_quantity (Trade Quantity), expected_balance_settlement_date (Expected Balance Settlement Date), expected_equity_settlement_date (Expected Equity Settlement Date)
  • See each field for its format, allowed values, default behavior, and business meaning.

Result

On success, the endpoint completes the described business operation. See the 200 response schema for returned data.

POSThttps://b-api.longbridge.xyz/billing/company_task_edit

Authorization

Authorizationstringheaderlb_hk_clearing.contract_manage_queryRequired

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

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.

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

Specifies IBond Amount.

trade_quantitystring

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

expected_balance_settlement_datestring

Specifies Expected Balance Settlement Date.

expected_equity_settlement_datestring

Specifies Expected Equity Settlement Date.

trade_ledger_datenumberrequired

From getNearThreeLedgerDate, in YYYYMMDD format.

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