Skip to content
Clearing Cancellation

Clearing - Clearing Reversal Logs

Query clearing-cancellation (revert) operation logs, capturing the handling options chosen and their results when a ledger date's clearing is reverted, for the clearing team to trace cancellation history.

Request parameters

  • Combine business filters through filters (see the filters field notes below for optional fields), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • Records come from clearing-cancellation operations, organized by ledger date; filters supports filtering by ledger date only.
  • Each record carries the ledger date, market, statement-resend method, RMS cancellation, intraday trading adjustment, unsettled-interest recalculation, plus the edit/cancel handling for holdings, interest, trade supplements, flow dates, closing prices, and contracts.
  • It also includes the processing status, operator, submission time, update time, and remarks.
  • Typically used to trace the scope and execution status of a ledger date's clearing-cancellation operation.

Returns

On success, returns the matching records and pagination info. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/clearing_asset_revert_logs

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_busin_steps

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

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes
ledger_datestring

Filters results by Ledger Date.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Clearing - Clearing Cancellation Log records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Returned value: List of list.

Child attributes
ledger_datestring

Returned value: Ledger Date. The date or time format follows the value returned by the API.

not_sync_trade_changesstring

Returned value: Non-transaction Flow Update.

statementstring

Returned value: Ways to resend statements.

statement_valstring

Raw value of statement. The statement field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

revert_typestring

Returned value: RMS Cancellation.

revert_type_valstring

Raw value of revert_type. The revert_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

modify_typestring

Returned value: Intraday Trading Adjustment.

modify_type_valstring

Raw value of modify_type. The modify_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

marketsstring

Returned value: Market.

not_settle_interestsstring

Returned value: Recalculation Of Unsettled Interest.

modify_position_logstring

Returned value: Edit Holdings Log.

modify_interest_logstring

Returned value: Edit Interest Log.

modify_logstring

Returned value: Add Trade Log.

modify_ledger_date_logstring

Returned value: Edit Flow Date Log.

modify_last_price_logstring

Returned value: Edit Closing Price Log.

modify_contract_logstring

Returned value: Edit Contract Log.

statusstring

Returned value: State.

status_valstring

Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

operatorstring

Returned value: Operator.

operator_valstring

Raw value of operator. The operator field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Returned value: Created At. The date or time format follows the value returned by the API.

updated_atstring

Returned value: Updated At. The date or time format follows the value returned by the API.

suggestionstring

Returned value: Remarks.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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