Skip to content
Option

Back Office Temporary Adjustment List

Query back-office temporary adjustment records for options and similar assets, used by risk-control operations to temporarily adjust a customer's positions and to track approval and execution.

Request parameters

  • Combine business filters through filters (optional fields are described under the filters section below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • The data source is the option (and similar asset) adjustments within the temporary-adjustment ledger, further distinguishable by asset type.

  • Each record identifies the securities account, counter, security code, asset type, position side, adjustment direction (increase/decrease), amount or quantity, total cost price, and currency, with its validity period and remark.

  • Records also carry the approval workflow (ticket number, review status, submitter, approver) plus the status, adjustment result, expiry time, and expiring operator.

Returns

On success, returns the list of matching records together with pagination information. See the response definition for the meaning of each column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

option_temp_adjust_query.query

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

Request body application/json

filtersobject

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

Child attributes
aaidstring

AAID. Filters results by AAID.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

counter_idstring

Stock Code. Filters results by Stock Code. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

security_typestring

Asset Type. Filters results by Asset Type.

Allowed values: CASH Cash, STOCK Stock, OPTION Option

Values
CASH
Cash
STOCK
Stock
OPTION
Option
directionstring

Adjustment Direction. Filters results by Adjustment Direction.

Allowed values: DEBIT Debit, CREDIT Credit

Values
DEBIT
CREDIT
biz_codestring

Biz Code. Filters results by Biz Code.

Allowed values: LOPPCR Option Temporary Increase [LOPPCR], LOPPDR Option Temporary Decrease [LOPPDR]

Values
LOPPCR
Option Temporary Increase [LOPPCR]
LOPPDR
Option Temporary Decrease [LOPPDR]
ticket_statusstring

Approval Status. Filters results by Approval Status.

Allowed values: WAIT_APPROVE Under Approval, APPROVED Approved, REJECTED Rejected, CLOSE Close, NONE Not Need

Values
WAIT_APPROVE
Under Approval
APPROVED
Approved
REJECTED
Rejected
CLOSE
Close
NONE
Not Need
statusstring

Status. Filters results by Status.

Allowed values: ADJUSTED Adjusted, EXPIRED Expired, FAILED Failed, EXPIRE_FAILED Expire Failed

Values
ADJUSTED
Adjusted
EXPIRED
Expired
FAILED
Failed
EXPIRE_FAILED
Expire Failed
pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

Responses

HTTP 200On success, returns paginated Back Office Temporary Adjustment List records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
idstring

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

account_channelstring

Channel. Returned value: Channel.

aaidstring

A/C No. Returned value: A/C No.

aaid_valstring

A/C No (raw value). 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.

biz_codestring

Biz Code. Returned value: Biz Code.

biz_code_valstring

Biz Code (raw value). Raw value of biz_code. The biz_code field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

counter_idstring

Stock Code. Returned value: Stock Code.

amount_or_quantitystring

Qty. Returned value: Qty.

currencystring

Currency. Returned value: Currency.

cost_pricestring

Cost. Returned value: Cost.

directionstring

Adjustment Direction. Returned value: Adjustment Direction.

direction_valstring

Adjustment Direction (raw value). 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.

position_sidestring

Holding Direction. Returned value: Holding Direction.

remarkstring

Remarks. Returned value: Remarks.

expire_timestring

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

ticket_idstring

Ticket No. Returned value: Ticket No.

statusstring

Status. Returned value: Status.

status_valstring

Status (raw value). 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.

ticket_statusstring

Ticket Status. Returned value: Ticket Status.

ticket_status_valstring

Ticket Status (raw value). Raw value of ticket_status. The ticket_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

expire_responsestring

Adjustment Status. Returned value: Adjustment Status.

expire_response_valstring

Adjustment Status (raw value). Raw value of expire_response. The expire_response field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

ticket_approvedstring

Approved By. Returned value: Approved By.

ticket_approved_valstring

Approved By (raw value). Raw value of ticket_approved. The ticket_approved field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

ticket_creatorstring

Submitted By. Returned value: Submitted By.

ticket_creator_valstring

Submitted By (raw value). Raw value of ticket_creator. The ticket_creator field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

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

adjust_timestring

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

expire_exec_timestring

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

expire_operatorstring

Cancelled By. Returned value: Cancelled By.

expire_operator_valstring

Cancelled By (raw value). Raw value of expire_operator. The expire_operator field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

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