Skip to content
Customer Memo

Add Statement Remark

Add a customer remark to a specific statement of a given customer.

Request parameters

  • Required: aaid (customer asset account), file_type (statement file type), dt (date), remark (remark text), action_in (action type)
  • Optional: account_no (account number), audit_frontend_resource (caller-provided audit context)
  • See each field description for format, value range, and business meaning.

Business notes

Creates a customer remark for the single statement uniquely identified by aaid, file_type, and dt. For creation, action_in is always 1.

The granularity of dt depends on file_type: monthly statements (file_type=1) use YYYYMM, others use YYYYMMDD.

Result

On success the customer remark is created; refer to the 200 response for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/portfolio/statement/add_statement_remark

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.statement_customer_remark

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

Request body application/json

aaidstringrequired

This field is required.

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.

file_typestringrequired

Statement file type. This field is required.

Allowed values: 0 Daily statement, 1 Monthly statement, 2 Temporary statement

Values
0
Daily Statement
1
Monthly Statement
2
Temp Statement
dtstringrequired

Date the statement belongs to. Submit YYYYMM for monthly statements (file_type=1) and YYYYMMDD for other types. This field is required.

remarkstringrequired

Customer remark text. This field is required.

action_instringrequired

Action type for this request. For adding a remark, always send 1. This field is required.

Allowed values: 1 Create, 2 Delete, 3 Edit

Values
1
Create
2
Delete
3
Edit
audit_frontend_resourceobject

An audit-trail field that records the differences before and after the operation. It is not a business parameter.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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