Skip to content
Longport Whale
Business type

Add Booking Type

Submitted from the "Add" dialog on the Business type page. Fields come from the form plus the language_en/cn/hk values and id=0 added on submit.

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

idintegerrequired

Record ID. On creation the front end always passes 0 (values.id = 0 in onSubmit).

source_idstringrequired

Data Source. Single-select; values come from optionsMap['book_data_source'] (ref_id=book_data_source), e.g. 1 = cash / other data-source enum.

directionstringrequired

Direction (Pay/Receive). Single-select; value comes from optionsMap['booking_types_pay'] (ref_id=booking_types_pay). When source_id equals the configured clientFeeList, this field is hidden on the page and may not actually be submitted.

biz_codestringrequired

Business Code. Selected from the result of getBizCodeOptions({source_id}); the list of available business codes is loaded dynamically as source_id changes.

is_accountstringrequired

Is Accounted. Single-select; values come from optionsMap['booking_types_is_account'] (ref_id=booking_types_is_account), e.g. Y/N. When N is selected, the front end forces account_currencies to ["ALL"].

account_currenciesarray<string>required

Account Currencies. A tree multi-select; the value is ["ALL"] or a list of specific currency codes (e.g. ["USD","HKD"]). Currency options come from optionsMap['global_currency_filter_by_account_channel']; when is_account=N it is fixed to ["ALL"]. Array elements are strings.

language_enstring

Business Name (English). Extracted from the name.en of the option corresponding to biz_code in onSubmit and appended on submission; not a directly entered form field.

language_cnstring

Business Name (Simplified Chinese). Extracted in onSubmit from name['zh-CN'] of the option matching biz_code and appended to the submission; not a directly entered form field.

language_hkstring

Business Name (Traditional Chinese/HK). On submit, taken from the name['zh-HK'] of the option corresponding to biz_code and attached to the request; not a directly entered form field.

Responses

HTTP 200No confirmable field definitions are available for the response yet.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs