Clearing - Internal Reconciliation Details

Query the clearing internal reconciliation details. Combine business filters through filters, and control pagination with page and page_size.

Response

On success, returns the matching list of records together with pagination information. See each field's documentation for the purpose, allowed values, and dynamic data source of every filter.

GEThttps://b-api.longbridge.xyz/v1/datasets/clearing_internal_check_details

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

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 below, or the call will be rejected.

Query parameters

filtersobject

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

Child attributes

ledger_datestring

Filters results by Executive Date(Sys Date).

task_codestring

Filters results by Task Name.

opposite_trade_details · Trade reconciliation(client vs. broker)check_lending_settle_price_ready · Presence of an underlying with a lending settlement price of 0dawn_settlement_account_balance_changes · Reconciliation of cash movements (clearing vs. RMS)dawn_settlement_equity_holding_changes · Reconciliation of holding movements (clearing vs. RMS)billing_outstandings · Reconciliation of outstanding(clearing vs. billing)clearing_custodian_efficient · Same client, same underlying across Sub A/Cclearing_custodian_equity_holdings · Reconciliation of holding(clearing vs. custodian)clearing_lending_fee_rates · Missing check on lending fee ratesbilling_interests · Unsettlement interest reconciliation (clearing vs. billing)billing_interest_settlements · Interest settlement reconciliation (clearing vs. billing)clearing_account_balance_outstandings · Reconciliation of unsettlement cash (clearing vs. billing)clearing_equity_holding_outstandings · Reconciliation of unsettlement holding (clearing vs. billing)billing_lending_interests · Reconciliation of unsettlement lending interests(clearing vs. billing)billing_lending_interest_settlements · Reconciliation of lending interests settlement (clearing vs. billing)billing_custodian_fee · Reconciliation of unsettlement portfolio fee(clearing vs. billing)billing_va_custodian_fee · Reconciliation of unsettlement VA custodian fee (clearing vs. billing)extra_opposite_position_details · Holding reconciliation (by sub A/C) (client vs. custodian)extra_dawn_settlement_account_balances · Reconciliation of cash after Day-End (clearing vs. RMS)extra_dawn_settlement_equity_holdings · Reconciliation of cash after Day-End (clearing vs. RMS)trade_reconciliation_after_billing · Trade reconciliation after billing (exception entry Mgmt vs. clearing)clearing_reconciliation_of_holding · Reconciliation of holding (Clearing today vs. prior day + change)clearing_reconciliation_of_balance · Reconciliation of cash balance(Clearing today vs. prior day + change)billing_va_custodian_fee_settlements · Reconciliation of VA custodian fee settlement (clearing vs. billing)billing_custodian_fee_settlements · Reconciliation of portfolio fee settlement (clearing vs. billing)dawn_frozen_account_balance_changes · Reconciliation of manual cash freeze reconciliation(clearing vs. RMS)dawn_frozen_equity_holding_changes · Reconciliation of manual holding freeze reconciliation(clearing vs. RMS)clearing_lending_equity_holding · Short selling quantity check (short selling quantity vs. short position)clearing_option_exercise · Option Exercise Reconciliation (Clearing vs. RMS)

task_idstring

Filters results by Task ID.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Clearing - Internal Reconciliation Details 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: Executive Date(Sys Date). The date or time format follows the value returned by the API.

task_idstring

Returned value: Task ID.

task_codestring

Returned value: Task Name.

task_code_valstring

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

clearing_idstring

Returned value: Ref No (Local).

clearing_detailstring

Returned value: Details (Local).

clearing_aaidstring

Returned value: AAID (Local).

clearing_aaid2string

Returned value: A/C No. (Local).

clearing_aaid2_valstring

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

clearing_counter_idstring

Returned value: Counter ID(Local ).

clearing_currencystring

Returned value: Currency(Local ).

other_idstring

Returned value: Ref No (Broker).

other_detailstring

Returned value: Details (Counterparty).

other_aaidstring

Returned value: AAID (Counterparty).

other_aaid2string

Returned value: A/C No. (Counterparty).

other_aaid2_valstring

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

other_counter_idstring

Returned value: Counter ID(Broker).

other_currencystring

Returned value: Currency(Broker ).

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

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/clearing_internal_check_details' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={"ledger_date":"0"}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "ledger_date": "string",
        "task_id": "string",
        "task_code": "string",
        "task_code_val": "string",
        "clearing_id": "string",
        "clearing_detail": "string",
        "clearing_aaid": "string",
        "clearing_aaid2": "string",
        "clearing_aaid2_val": "string",
        "clearing_counter_id": "string",
        "clearing_currency": "string",
        "other_id": "string",
        "other_detail": "string",
        "other_aaid": "string",
        "other_aaid2": "string",
        "other_aaid2_val": "string",
        "other_counter_id": "string",
        "other_currency": "string"
      }
    ],
    "total": 1
  }
}