Settlement Transaction Record

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

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>.

Query parameters

filtersobject

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

Child attributes

nostring

Filters results by Contract No.

datasourcestring

Filters results by Data Source.

Allowed values:

1 - Trade
2 - Stock card
3 - Stock card (House)
4 - Backend
5 - Contract Amendments (Reverse)
6 - Contract Amendments (New)
7 - WTT Non-Day Trade
8 - Upstreaming File

1 · Trade2 · Stock card3 · Stock card (House)4 · Backend5 · Contract Amendments (Reverse)6 · Contract Amendments (New)7 · WTT Non-Day Trade8 · Upstreaming File

aaidstring

Filters results by Client.

trade_ledger_dateobject

Filters results by Ledger Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

contract.trade_dateobject

Filters results by Trade Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

expected_balance_settlement_dateobject

Filters results by Cash Settlement Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

marketstring

Filters results by Market.

Values are dynamic. Call GET /v1/datasets/refs/clearing_config_markets to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

counter_idstring

Filters results by Counter ID.

statestring

Filters results by Status.

Allowed values:

2 - To Be Calculated
3 - To Be Charged
4 - To Be Settled
5 - Settlement Completed
6 - Equity settled
1 - Init
-1 - --

2 · To Be Calculated3 · To Be Charged4 · To Be Settled5 · Settlement Completed6 · Equity settled1 · Init-1 · --

settlement_channelstring

Filters results by Settlement Channel.

Values are dynamic. Call GET /v1/datasets/refs/billing_settlement_channel to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

directionstring

Filters results by Trade Direction.

Allowed values:

1 - Buy
2 - Sell

1 · Buy2 · Sell

task_nostring

Filters results by Settlement Batch No.

currencystring

Filters results by Currency.

Values are dynamic. Call GET /v1/datasets/refs/tenant_currencies to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

contract.biz_typestring

Filters results by Biz Type.

Values are dynamic. Call GET /v1/datasets/refs/billing_business_type to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

positionstring

Filters results by Long/Short.

Allowed values:

LONG - Long
SHORT - Short

LONG · LongSHORT · Short

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Settlement Transaction Record 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

trade_ledger_datestring

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

trade_datestring

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

datasourcestring

Returned value: Data Source.

datasource_valstring

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

nostring

Returned value: Contract No.

aaidstring

Returned value: A/C No..

aaid_valstring

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

marketstring

Returned value: Market.

positionstring

Returned value: Position.

settlement_accountstring

Returned value: Sub Account.

counter_idstring

Returned value: Counter ID.

directionstring

Returned value: Trade Direction.

direction_valstring

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

trade_quantitystring

Returned value: Trade Qty.

currencystring

Returned value: Currency.

trade_amountstring

Returned value: Trade Amt.

ibond_amountstring

Returned value: Bond Interest.

receivable_amountstring

Returned value: Fee Receivable.

deduction_amountstring

Returned value: Fee Discount.

bill_amountstring

Returned value: Fee After Discount.

calculate_out_amountstring

Returned value: Calculated Amt.

policy_versionstring

Returned value: Billing Conf Version.

expected_balance_settlement_datestring

Returned value: Expected Settlement Date (Cash). The date or time format follows the value returned by the API.

expected_equity_settlement_datestring

Returned value: Expected Settlement Date (Qty). The date or time format follows the value returned by the API.

statestring

Returned value: Status.

state_valstring

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

settled_atstring

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

biz_typestring

Returned value: Biz Type.

biz_type_valstring

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

settlement_channelstring

Returned value: Settlement Channel.

settlement_channel_valstring

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

stagestring

Returned value: Trade Phase.

stage_valstring

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

custodian_idstring

Returned value: Broker.

custodian_id_valstring

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

security_typestring

Returned value: Security Type.

security_type_valstring

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

security_categorystring

Returned value: Security Sub Type.

security_category_valstring

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

account_regionstring

Returned value: Client Region.

account_region_valstring

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

account_locationstring

Returned value: Client Location.

account_location_valstring

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

offset_contract_nostring

Returned value: Offset contract no.

new_contract_nostring

Returned value: New contract no.

origin_contract_nostring

Returned value: Origin contract no.

currency_setlstring

Returned value: Currency Setl..

trade_to_setl_exchange_ratestring

Returned value: Ex Rate.

contract_idstring

Returned value: Contract ID.

admin_idstring

Returned value: Last Updated.

admin_id_valstring

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

created_atstring

Returned value: Creat Time. 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.

open_closestring

Returned value: Open/Close.

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/booking_calculated_contracts' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "trade_ledger_date": "20260714",
        "trade_date": "2026-07-14",
        "datasource": "Trade",
        "datasource_val": "1",
        "no": "OS2026071610152",
        "aaid": "H00000000",
        "aaid_val": "10000000",
        "market": "SH",
        "position": "LONG",
        "settlement_account": "",
        "counter_id": "ST/SH/600519",
        "direction": "Buy",
        "direction_val": "1",
        "trade_quantity": "500",
        "currency": "CNH",
        "trade_amount": "609,950",
        "ibond_amount": "",
        "receivable_amount": "60,422.53",
        "deduction_amount": "0",
        "bill_amount": "60,422.53",
        "calculate_out_amount": "60,422.53",
        "policy_version": "699735",
        "expected_balance_settlement_date": "2026-07-15",
        "expected_equity_settlement_date": "2026-07-14",
        "state": "Equity settled",
        "state_val": "6",
        "settled_at": "",
        "biz_type": "Stock Trade",
        "biz_type_val": "1",
        "settlement_channel": "settlement_ex_hk & CCASS",
        "settlement_channel_val": "5",
        "stage": "Normal",
        "stage_val": "1",
        "custodian_id": "0",
        "custodian_id_val": "0",
        "security_type": "Stock",
        "security_type_val": "ST",
        "security_category": "0",
        "security_category_val": "0",
        "account_region": "Hong Kong China",
        "account_region_val": "HK",
        "account_location": "",
        "account_location_val": "",
        "offset_contract_no": "",
        "new_contract_no": "",
        "origin_contract_no": "",
        "currency_setl": "CNH",
        "trade_to_setl_exchange_rate": "1",
        "contract_id": "7935685",
        "admin_id": "--",
        "admin_id_val": "0",
        "created_at": "1784185008",
        "updated_at": "1784185008",
        "open_close": "OPEN"
      }
    ],
    "total": 0
  }
}