Manual Adjustment - Cash

Query manual settlement-adjustment records for cash, used by clearing and operations teams to track manual adjustment tickets raised against a client's cash balances, along with their approval and posting status.

Request parameters

Combine business filters through filters (optional fields are described in the filters section below), and use page, page_size, and orderBy for pagination and sorting.

Business notes

The data comes from settlement-adjustment tickets and is limited to cash assets; each record is one manual adjustment raised against a specific client account.
A record carries client information (client, name, securities account), the adjustment direction (increase or decrease), the business classification, the adjusted currency and amount, and the cost currency.
It also includes the approval workflow (status, submitter, approver), the adjustment result, remarks and internal remarks, the created / business / ledger / completed timestamps, the ticket number, and the batch ID (request_id).
Each record additionally flags whether an App push and an email notification are sent to the client.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

balance_change_ticket.list

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.

directionstring

Adjustment Direction. Filters results by Adjustment Direction.

Allowed values: DEBIT Debit, CREDIT Credit

Values

DEBIT
CREDIT

ticket_statusstring

Status. Filters results by Status.

Allowed values: WAIT Waiting for Approval, WAIT_APPROVE Under Approval, REJECTED Rejected, CLOSE Close, REVOKING Revoking, REVOKED Revoked, SUCCESS Success, FAILED Failed, PROCESS Process

Values

WAIT: Waiting for Approval
WAIT_APPROVE: Under Approval
REJECTED: Rejected
CLOSE: Close
REVOKING: Revoking
REVOKED: Revoked
SUCCESS: Success
FAILED: Failed
PROCESS: Process

request_idstring

Batch ID. Filters results by Batch ID.

finish_atobject

Completed At. Filters results by Completed At.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

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 Manual Adjustment - Cash 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

ID. Returned value: Unique identifier of the current record.

member_idstring

Member ID. Returned value: Member ID.

member_id_valstring

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

aaid2string

Name. Returned value: Name.

aaid2_valstring

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

aaid3string

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

aaid3_valstring

A/C No (raw value). Raw value of aaid3. The aaid3 field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

security_typestring

Asset Type. Returned value: Asset Type.

security_type_valstring

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

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.

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.

biz_code_visiblestring

Display to Client?. Returned value: Display to Client?.

biz_code_visible_valstring

Display to Client? (raw value). Raw value of biz_code_visible. The biz_code_visible field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

incurred_amountstring

Amount. Returned value: Amount.

currencystring

Currency. Returned value: Currency.

ticket_statusstring

Status. Returned value: Status.

ticket_status_valstring

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.

resultstring

Adjustment Status. Returned value: Adjustment Status.

result_valstring

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

remarkstring

Remarks. Returned value: Remarks.

inner_remarkstring

Internal Remarks. Returned value: Internal Remarks.

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.

finish_atstring

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

ticket_idstring

Ticket No. Returned value: Ticket No.

request_idstring

Batch ID. Returned value: Batch ID.

revoke_request_idstring

Revoke Batch ID. Returned value: Revoke Batch ID.

user_ledger_datestring

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

third_flagstring

Third Party. Returned value: Third Party.

third_flag_valstring

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

cheque_flagstring

Cheque. Returned value: Cheque.

cheque_flag_valstring

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

company_card_namestring

Company Bank Name. Returned value: Company Bank Name.

member_card_namestring

Client Bank Name. Returned value: Client Bank Name.

member_card_name_valstring

Client Bank Name (raw value). Raw value of member_card_name. The member_card_name field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

company_cardstring

Company Bank Account. Returned value: Company Bank Account.

member_cardstring

Client Bank Account. Returned value: Client Bank Account.

app_notifystring

App Push. Returned value: App Push.

app_notify_valstring

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

email_notifystring

Email Push. Returned value: Email Push.

email_notify_valstring

Email Push (raw value). Raw value of email_notify. The email_notify 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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/clearing_adjust_cash' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "13585149",
        "member_id": "101456715",
        "member_id_val": "",
        "aaid2": " LB",
        "aaid2_val": "56827315",
        "aaid3": "H00000000",
        "aaid3_val": "56827315",
        "security_type": "Cash",
        "security_type_val": "CASH",
        "direction": "DEBIT",
        "direction_val": "DEBIT",
        "biz_code": "LCWD [Cheque Withdrawal]",
        "biz_code_val": "LCWD",
        "biz_code_visible": "Visible",
        "biz_code_visible_val": "true",
        "incurred_amount": "300",
        "currency": "HKD",
        "ticket_status": "Success",
        "ticket_status_val": "SUCCESS",
        "result": "Finished",
        "result_val": "调账完成",
        "remark": "",
        "inner_remark": "",
        "ticket_approved": "0",
        "ticket_approved_val": "0",
        "ticket_creator": "Zhang San",
        "ticket_creator_val": "Zhang San",
        "created_at": "1784173042",
        "finish_at": "1784173052",
        "ticket_id": "4494238",
        "request_id": "202607160337229cd87c2eead6f9fa",
        "revoke_request_id": "",
        "user_ledger_date": "",
        "third_flag": " ",
        "third_flag_val": "false",
        "cheque_flag": " ",
        "cheque_flag_val": "false",
        "company_card_name": "",
        "member_card_name": "",
        "member_card_name_val": "",
        "company_card": "",
        "member_card": "",
        "app_notify": false,
        "app_notify_val": "false",
        "email_notify": "user@example.com",
        "email_notify_val": "user@example.com"
      }
    ],
    "total": 15965
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.lbkrs.com/v1/datasets/clearing_adjust_cash/download

balance_change_ticket.list

Export options Export records Download result