Skip to content
Longport WhaleLongport Whale
Account Attributes

Modify Account Attribute

Modifies an existing account attribute configuration.

Request parameters

  • Required: id (account attribute ID of the record to modify) and record (the updated fields), within which name (attribute name), direct (balance direction), and prefix_code (level-1 subject code sequence) are all required.
  • See the field definitions for format, value ranges, and business meaning.

Risk warning

This operation changes a real account-attribute configuration and affects the chart of accounts and booking rules. Confirm the target record and parameters before calling.

Result

On success the account attribute record is updated. Refer to the 200 response definition for returned data.

POSThttps://b-api.lbkrs.com/book/feature/modify

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_book.book_features_modify

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

Request body application/json

idstringrequired

Account attribute id of the record to update.

recordobjectrequired

Updated Account Attribute fields.

Child attributes
namestringrequired

Account attribute name.

directstringrequired

Balance side.

Allowed values: 1 Debit, 2 Credit, 3 Common

Values
1
Debit
2
Credit
3
Common
prefix_codestringrequired

Level-1 account code serial number.

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