Skip to content
Longport WhaleLongport Whale
Statement Template

Query Statement Text Config

Query the statement copy (text) configuration of a given organization.

Request parameters

  • Optional: org_id (organization ID); when omitted, queries the organization of the currently signed-in account.
  • See each field description for format, value range, and business meaning.

Returns

On success returns the organization's statement copy configuration. See the response definition below for field meanings.

GEThttps://b-api.lbkrs.com/portfolio/statement/query_statement_text

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.statement_setting

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

Parameters

org_idstring

Organization ID. When omitted, the query uses the organization of the currently authenticated account.

Responses

HTTP 200The request was processed successfully. data returns the statement text configuration for the organization.
Standard response envelopecodemessagedata
dataobjectdata structure

Statement text configuration details.

org_idnumber

Organization ID the configuration belongs to.

keystring

The storage key returned after the image is uploaded.

zhobject

Simplified Chinese text content.

enobject

English text content.

hkobject

Traditional Chinese text content.

company_emailstring

Company email shown on statements; empty string when not configured.

company_faxstring

Company fax number shown on statements; empty string when not configured.

company_telstring

Company phone number shown on statements; empty string when not configured.

social_mediastring

Company social media information shown on statements; empty string when not configured.

langstring

Statement text language (display value); the raw code is in lang_val. Empty string when not configured.

lang_valstring

Raw code of the lang field.

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