Skip to content
Longport WhaleLongport Whale
Subscription Record Synchronization

Sync order details

Returns the reporting details under a sync record, used to reconcile item by item the differences in subscription method and financing ratio between the client order and what was reported upstream, along with the report result.

Request parameters

  • Combine business filters through filters (see the filter field notes below for the available fields), then use page, page_size, and orderBy for pagination and sorting.

Business notes

  • For a given sync record (record_id), returns every reporting item linked to it, including the client account number, reported order number, channel, method, client financing ratio, subscription amount and quantity, reported subscription method, reported financing ratio, report result, and remark.
  • It exposes both the client-side and the reported (upstream) subscription method and financing ratio so the two sides can be compared for consistency.
  • Commonly used within the subscription-record sync flow to investigate the specific items that failed to report or differ.

Returns

On success, returns the matched records with pagination info. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

ipo.financing_rate

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

Request body application/json

filtersobject

Filters

Child attributes
record_idstring

Record ID

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

account_nostring

A/C No.

order_idstring

Order Id

channelstring

Channel

methodstring

Method

method_valstring

Method (raw value). Raw value behind field method: method returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

rratiostring

Client Financing Ratio

sub_amountstring

Subscription Amounts

sub_qtystring

Subscription Qty

target_methodstring

Counterparty Subscription Method

target_method_valstring

Counterparty Subscription Method (raw value). Raw value behind field target_method: target_method returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

tratiostring

Counterparty Financing Ratio

statusstring

Counterparty Status

status_valstring

Counterparty Status (raw value). Raw value behind field status: status returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

remarkstring

Remark

totalintegerrequired

Total

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