Skip to content
Business type

Edit Booking Type

Edit Booking Type.

Request parameters

  • Required: id (Booking Type ID), source_id (Source ID), biz_code (Biz Code), is_account (Is Account), account_currencies (Account Currencies)
  • Optional: direction (Direction), language_en (Language EN), language_cn (Language CN), language_hk (Language HK), audit_frontend_resource (Audit Context)
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

idstringrequired

Taken from the row data record.id.

source_idstringrequired

Single-select, enum sourced from ref book_data_source_editable.

Call GET /v1/datasets/refs/book_data_source_editable to retrieve the current data dictionary, and use the returned entry's key as this field's value.

directionstring

A radio whose enum comes from the booking_types_pay reference; hidden and not submitted when source_id is the client fee list.

Allowed values: Payment, Payee (Collecting)

Payment · PaymentPayee · Collecting

biz_codestringrequired

The dropdown options come from getBizCodeOptions.

is_accountstringrequired

A radio whose enum comes from the ref booking_types_is_account.

Allowed values:

  • Y - Yes
  • N - No

Y · YesN · No

account_currenciesarray<string>required

A tree-select component; fixed to ['ALL'] when is_account=N.

language_enstring

Taken from the name.en of the biz_code option.

language_cnstring

Taken from name['zh-CN'] of the biz_code option.

language_hkstring

Taken from name['zh-HK'] of the biz_code option.

audit_frontend_resourceobject

Taken from the row data record before editing; not a business field.

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