Skip to content
After Event Adjustment

Post Adjust Detail Items

Query the client-level post-event adjustment details of one announcement. Each row is one client on one event, with the credited amount, credited quantity and withholding tax, plus the ID of each adjustment item.

Request parameters

  • filters.ann_id (announcement ID) is required and limits the result to the registered accounts of that announcement.
  • filters.adjustment_id (adjustment ID) only selects which adjustment the item columns (*_item_id, *_confirmed) come from; use it together with ann_id. It does not exclude other registered accounts of the announcement.
  • filters.group_id (sub-position group ID) limits rows to accounts whose sub-positions belong to that group; without it all registered accounts of the announcement are returned.
  • adjustment_id is the adjustment_id returned by post_adjust or a row id from corp_action_post_adjust_records; group_id is the group id returned by sub_position_view_detail.
  • Use page and page_size for pagination.

Business notes

amount_item_id, quantity_item_id and fee_item_id are the IDs of the client's amount, quantity and withholding-tax adjustment items, i.e. the item_id of update_post_adjust_detail; empty means the item does not exist yet. *_origin is the original value and *_confirmed the current confirmed value.

Returns

On success, returns the matching record list with pagination. See the response definition for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

corporate.after_event_adjustment_query

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

Request body application/json

filtersobjectrequired

Combines business filters. ann_id is required; omit any other filter field to disable that filter.

Child attributes
ann_idstringrequired

Announcement ID. Required.

adjustment_idstring

Adjustment ID: the adjustment_id returned by post_adjust or a row id from corp_action_post_adjust_records. Use it together with ann_id; it only affects the item columns.

counterpart_accountstring

Sub-position account.

group_idstring

Sub-position group ID: the group id returned by sub_position_view_detail. Limits rows to accounts whose sub-positions belong to that group; without it all registered accounts of the announcement are returned.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Post Adjust Detail Items records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Returns: list of detail rows.

Child attributes
aaidstring

Returns: Internal securities account ID aaid.

account_nostring

Returns: Securities account number.

real_namestring

Returns: Name.

adjustment_idstring

Returns: Adjustment ID.

event_idstring

Returns: Event ID.

event_typestring

Returns: Event type.

event_type_valstring

Returns: Raw value of event_type.

quantitystring

Returns: Holding quantity.

amount_item_idstring

Returns: Amount adjustment item ID, the item_id of update_post_adjust_detail; empty if the item does not exist.

amount_originstring

Returns: Original credited amount.

amount_confirmedstring

Returns: Adjusted credited amount.

fee_item_idstring

Returns: Withholding-tax adjustment item ID, the item_id of update_post_adjust_detail; empty if the item does not exist.

fee_originstring

Returns: Original withholding tax.

fee_confirmedstring

Returns: Adjusted withholding tax.

quantity_item_idstring

Returns: Quantity adjustment item ID, the item_id of update_post_adjust_detail; empty if the item does not exist.

quantity_originstring

Returns: Original credited quantity.

quantity_confirmedstring

Returns: Adjusted credited quantity.

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

Whale Docs