Clearing - Internal Reconciliation Summary Export

Export the Clearing - Internal Reconciliation Summary list to a file. In sync mode (mode:0) the download URL is returned directly; in async mode (mode:1) a file_download_id is returned, to be polled via the shared GET/DELETE /v1/datasets/download/{id} endpoint for status and the final download URL.

POSThttps://b-api.longbridge.xyz/v1/datasets/clearing_internal_check_summaries/download

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters. Same fields as the filters of clearing_internal_check_summaries.yaml (the query capability).

Child attributes

filters.ledger_datestring

Execution Date. Defaults to today (rolling relative to the request date) when omitted.

filters.task_codestring

Task Code. Options: opposite_trade_details = Trade reconciliation(client vs. broker); check_lending_settle_price_ready = Presence of an underlying with a lending settlement price of 0; dawn_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/C; clearing_custodian_equity_holdings = Reconciliation of holding(clearing vs. custodian); clearing_lending_fee_rates = Missing check on lending fee rates; billing_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)

opposite_trade_detailscheck_lending_settle_price_readydawn_settlement_account_balance_changesdawn_settlement_equity_holding_changesbilling_outstandingsclearing_custodian_efficientclearing_custodian_equity_holdingsclearing_lending_fee_ratesbilling_interestsbilling_interest_settlementsclearing_account_balance_outstandingsclearing_equity_holding_outstandingsbilling_lending_interestsbilling_lending_interest_settlementsbilling_custodian_feebilling_va_custodian_feeextra_opposite_position_detailsextra_dawn_settlement_account_balancesextra_dawn_settlement_equity_holdingstrade_reconciliation_after_billingclearing_reconciliation_of_holdingclearing_reconciliation_of_balancebilling_va_custodian_fee_settlementsbilling_custodian_fee_settlementsdawn_frozen_account_balance_changesdawn_frozen_equity_holding_changesclearing_lending_equity_holdingclearing_option_exercise

filters.marketstring

Market. Values are dynamically queried from clear_used_market (not fixed); fetch them live via GET /v1/datasets/refs/clearing_config_markets.

filters.stepstring

Phase. Options: 1 = Before Check; 2 = Clearing Check; 3 = After Check; 4 = Extra Check

1234

orderByarray<object>

Order By

modeinteger

Mode. Defaults to 0 (sync) when omitted.. Options: 0 = Sync; 1 = Async

01

extstring

Ext. Supports csv/xlsx; defaults to csv.

csvxlsx

file_namestring

File Name

remarkstring

Remark

down_fieldsarray<string>

Down Fields. When omitted, all fields are exported; allowed values are listed under items.enum (the same field list as the query endpoint's data.list.items).

ticket_contentstring

Ticket Content. Shown to the approver when the template has a download-approval ticket configured.

ticket_preview_urlstring

Ticket Preview URL

hideinteger

Hide. Options: 0 = Not Hidden; 1 = Hidden

01

Responses

HTTP 200Export result. In sync mode the download URL is returned directly; in async mode a file_download_id is returned for subsequent polling.

Standard response envelopecodemessagedata

dataobjectdata structure

urlstring

Download URL. Returned in sync mode (mode:0); empty in async mode.

file_download_idstring

File Download ID. Returned in async mode (mode:1); used to poll GET/DELETE /v1/datasets/download/{id}.

ticket_idstring

Ticket ID

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/clearing_internal_check_summaries/download' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "orderBy": [],
  "mode": 0,
  "ext": "csv",
  "file_name": "",
  "remark": "",
  "down_fields": [],
  "ticket_content": "",
  "ticket_preview_url": "",
  "hide": 0
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "url": "<string>",
    "file_download_id": "<string>",
    "ticket_id": "<string>"
  }
}