Skip to content
Longport WhaleLongport Whale
Summary check

Add Book Remarks

Add an accounting remark to a bookkeeping business object.

Request parameters

  • Required: ref_id (related business object ID), ref_no (related reference number), biz_type (business type), and remarks (remark content).
  • See the individual field docs for each field's format, allowed values, and meaning.

Business notes

The remark is linked to a specific business object via ref_id, ref_no, and biz_type, providing supplementary notes for that record.

Result

On success, the accounting remark is added; refer to the 200 response for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/book/addBookRemarks

Authorization

AuthorizationstringheaderRequired

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

Permission

accounting.deposit_transit_details

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

Request body application/json

ref_idnumberrequired

Ref ID associated with this request.

ref_nostringrequired

Specifies Ref No.. This field is required.

biz_typestringrequired

Identifies the business scenario to which this request applies. This field is required.

remarksstringrequired

Remarks saved with this operation. This field is required.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
idstring
idsarray<object>
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