Skip to content
Business type

Edit Booking Type

Edits an existing booking business type.

Request parameters

  • Required: id (business-type ID), source_id (data source), biz_code (business code), is_account (whether it is booked), account_currencies (booking currencies).
  • Optional: direction (receipt/payment direction), language_en, language_cn, language_hk, audit_frontend_resource (audit context).
  • When is_account=N, account_currencies is fixed to ['ALL'].
  • See the field definitions for format, value ranges, and business meaning.

Risk warning

This operation changes a real booking business-type configuration and affects downstream accounting and booking rules. Confirm the target record and parameters before calling.

Result

On success the booking business type is updated. Refer to the 200 response definition for returned data.

POSThttps://b-api.lbkrs.com/book/edit_booking_types

Authorization

AuthorizationstringheaderRequired

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

Permission

book.booking_types_update

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

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 Payment, Payee Collection

Values
Payment
Payment
Payee
Collecting
biz_codestringrequired

Business code. The available options depend on the selected data source (source_id): member fees, agent fees, settlement contracts, atomic vault and other sources each have their own business-code list, returned by the backend according to the chosen source_id; use the options the service returns.

is_accountstringrequired

A radio whose enum comes from the ref booking_types_is_account.

Allowed values: Y Accounted, N Not accounted

Values
Y
Yes
N
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
idstring
idsarray<object>
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