Skip to content
Longport WhaleLongport Whale
Customer Memo

Update Statement Remark

Update the existing customer remark on a specific statement for a given client.

Request parameters

  • Required: aaid (AAID), file_type (File Type), dt (Date), remark (Remark), action_in (Action Type)
  • Optional: account_no (Account No.), front_payload (Front Payload), audit_frontend_resource (Audit Context)
  • See each field for its format, allowed values, and business meaning.

Business notes

Overwrites the customer remark of the statement uniquely identified by aaid, file_type, and dt. For an edit operation, always send action_in as 3.

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

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

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

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

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 below, or the call will be rejected.

Request body application/json

aaidstringrequired

This field is required.

account_nostring

Specifies Account No.. When omitted, the client is located by aaid.

file_typestringrequired

Statement file type. This field is required.

0 · Daily Statement1 · Monthly Statement2 · 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

Updated customer remark text. This field is required.

action_instringrequired

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

1 · Create2 · Delete3 · Edit

front_payloadobject

Included only when editing as { type: 'data_diff', data: <before/after changes> } for approval display.

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

On success data is an empty object.

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