Business type · Whale Docs

GEThttps://b-api.longbridge.xyz/v1/datasets/booking_booking_types

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Query parameters

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

idstring

Filters results by No.

source_idstring

Filters results by Entry Data Source.

Values are dynamic. Call GET /v1/datasets/refs/book_data_source_filterable to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

codestring

Filters results by Business Type.

Values are dynamic. Call GET /v1/datasets/refs/book_type_bilateral_member_mapping to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Business type records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

idstring

Returned value: Unique identifier of the current record.

source_idstring

Returned value: Entry Data Source.

source_id_valstring

Raw value of source_id. The source_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

directionstring

Returned value: Payment/Collecting.

direction_valstring

Raw value of direction. The direction field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

code_descstring

Returned value: Business type.

is_accountstring

Returned value: Indicates whether accounting requirements.

is_account_valstring

Raw value of is_account. The is_account field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

account_currenciesstring

Returned value: Currency.

created_atstring

Returned value: Creation time. The date or time format follows the value returned by the API.

updated_atstring

Returned value: Update time. The date or time format follows the value returned by the API.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/booking_booking_types' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "124006",
        "source_id": "Payment Transaction",
        "source_id_val": "1",
        "direction": "Payment",
        "direction_val": "Payment",
        "code_desc": "[LCDP]Deposit Cash",
        "is_account": "Charge up",
        "is_account_val": "Y",
        "account_currencies": "[\"ALL\"]",
        "created_at": "1783296446",
        "updated_at": "1783296446"
      }
    ],
    "total": 353
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/booking_booking_types/download

Export options Export records Download result