CCASS Statement · Whale Docs

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

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

remarkstring

Filters results by Description.

idstring

Filters results by Serial Number.

serialstring

Filters results by Report Number.

Allowed values: CCLTN04, CSEMS08, CSESE01

CCLTN04 · CCLTN04CSEMS08 · CSEMS08CSESE01 · CSESE01

business_typestring

Filters results by Business Type.

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

account_atobject

Filters results by Accounting Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

currencystring

Filters results by Currency.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated CCASS Statement 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.

serialstring

Returned value: Report No.

serial_valstring

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

namestring

Returned value: Report Name.

business_typestring

Returned value: Business Type.

business_type_valstring

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

account_atstring

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

marketstring

Returned value: Market.

origin_business_typestring

Returned value: Original transaction type.

remarkstring

Returned value: Description.

currencystring

Returned value: Currency.

amountstring

Returned value: Amount.

created_atstring

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

updated_atstring

Returned value: Updated At. 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_ccass_bills' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "138075",
        "serial": "CSESE01",
        "serial_val": "CSESE01",
        "name": "SETTLEMENT REPORT",
        "business_type": "Unsettled-Positions-Payable",
        "business_type_val": "Unsettled-Positions-Payable",
        "account_at": "1765324800",
        "market": "HONG KONG MK",
        "origin_business_type": "",
        "remark": "",
        "currency": "HKD",
        "amount": "45,100.00",
        "created_at": "1783296467",
        "updated_at": "1783296467"
      }
    ],
    "total": 1
  }
}

Export

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

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

Export options Export records Download result