Skip to content
Longport WhaleLongport Whale
Entry Rules

Entry Rule Detail

Retrieve the full configuration of a single accounting entry rule by id. It is used to prefill the form when editing or copying an entry rule through Create Or Modify Account Entries (POST /book/create_or_modify_account_entries_v2).

Request parameters

  • Required: id (entry rule id), supplied in the JSON request body.

Result

On success, data contains the full configuration of the entry rule, whose fields correspond one-to-one to the request parameters of the create/modify endpoint. See the 200 response fields for the meaning of each field.

POSThttps://b-api.longbridge.xyz/book/account_entry_detail_v3

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

idstringrequired

Id of the entry rule to retrieve.

Responses

HTTP 200The request was processed successfully. data contains the full configuration of the entry rule.
Standard response envelopecodemessagedata
dataobjectdata structure

Full configuration of the entry rule. Fields correspond to the request parameters of Create Or Modify Account Entries.

idstring

Entry rule id.

source_idinteger

Entry data source. The value comes from the book_entry_data_source dynamic enum and determines the visibility and required status of subfields such as payment_* / payee_*.

Call GET /v1/datasets/refs/book_entry_data_source to retrieve the current data dictionary.

payment_account_type_idstring

Payment account type. The value comes from the book_entry_account_types dynamic enum (cascading with source_id).

Call GET /v1/datasets/refs/book_entry_account_types to retrieve the current data dictionary.

payment_booking_type_idstring

Payment booking type. The value comes from the book_business_types_by_source dynamic enum (cascading with source_id).

Call GET /v1/datasets/refs/book_business_types_by_source to retrieve the current data dictionary.

payment_channel_accountstring

Paying securities account, corresponding to the payer member's aaid/origin_id.

payment_member_idstring

Payer member id, associated with payment_channel_account and used to prefill the payer selection.

payment_business_groupstring

Payment business group. The value comes from the book_business_groups dynamic enum.

Call GET /v1/datasets/refs/book_business_groups to retrieve the current data dictionary.

payee_account_type_idstring

Payee account type. The value comes from the book_entry_account_types dynamic enum (cascading with source_id).

Call GET /v1/datasets/refs/book_entry_account_types to retrieve the current data dictionary.

payee_booking_type_idstring

Payee booking type. The value comes from the book_business_types_by_source dynamic enum (cascading with source_id).

Call GET /v1/datasets/refs/book_business_types_by_source to retrieve the current data dictionary.

payee_channel_accountstring

Receiving securities account, corresponding to the payee member's aaid/origin_id.

payee_member_idstring

Payee member id, associated with payee_channel_account and used to prefill the payee selection.

channelstring

Channel; populated under some data sources.

user_account_typeinteger

User account type.

0 · Not Match1 · Cash2 · Margin3 · House

currencyarray<string>

Currency, multi-value. The values come from the tenant_currencies_by_channel dynamic enum.

Call GET /v1/datasets/refs/tenant_currencies_by_channel to retrieve the current data dictionary.

org_idinteger

Broker org. The value comes from the book_brokers dynamic enum.

Call GET /v1/datasets/refs/book_brokers to retrieve the current data dictionary.

trade_directionstring

Trade direction.

SELL · SELLBUY · BUY

nature_typestring

Nature type. Populated only when the data source is a bank.

client · Clienthouse · House

bank_accountstring

Bank account. The value comes from the book_entry_bank_accounts dynamic enum, and is populated only when the data source is a bank.

Call GET /v1/datasets/refs/book_entry_bank_accounts to retrieve the current data dictionary.

remarkstring

Remark, up to 100 characters.

amount_plus_or_minusstring

Whether the amount is positive or negative.

PLUS · Positive amountMINUS · Negative amount

name_typesarray<object>

Entry summary (name types) configuration; each item corresponds to one summary-concatenation rule. Sub-structure:

  • name_type (string): 1 for fixed text, 2 for a referenced field type.
  • name (string, optional): fixed text.
  • name_field_type (string, optional): when using a referenced field type, an available summary-field type returned for the selected data source.
Child attributes
name_typestring

Summary type: 1 fixed text, 2 referenced field type.

namestring

Fixed text content (used when name_type is 1).

name_field_typestring

Referenced summary-field type (used when name_type is 2).

debit_featurestring

Debit account feature. The value comes from the book_account_features dynamic enum (with an additional "All" option).

Call GET /v1/datasets/refs/book_account_features to retrieve the current data dictionary.

debit_subject_codearray<string>

Debit account code path, ordered from the top level down to the leaf level; the last element is the debit leaf-level (level 3) account code.

debit_amount_typestring

Debit amount type.

AMOUNT_ABS · The absolute value of the billAMOUNT_NEG · The opposite of the bill amountAMOUNT_ORIGIN · Original bill amount

debit_display_brokerstring

Whether the debit side shows the broker (AE) account.

yes · Yesno · No

credit_featurestring

Credit account feature. The value comes from the book_account_features dynamic enum (with an additional "All" option).

Call GET /v1/datasets/refs/book_account_features to retrieve the current data dictionary.

credit_subject_codearray<string>

Credit account code path, ordered from the top level down to the leaf level; the last element is the credit leaf-level (level 3) account code.

credit_amount_typestring

Credit amount type. Kept consistent with the debit amount type.

AMOUNT_ABS · The absolute value of the billAMOUNT_NEG · The opposite of the bill amountAMOUNT_ORIGIN · Original bill amount

credit_display_brokerstring

Whether the credit side shows the broker (AE) account.

yes · Showno · Not Show

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