Settlement Contract · Whale Docs

GEThttps://b-api.longbridge.xyz/v1/datasets/holding_contract_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

contract_nostring

Filters results by Contract No.

idstring

Filters results by ID.

account_atobjectrequired

Filters results by Account Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

currencystring

Filters results by Currency.

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

biz_codestring

Filters results by Business type.

Values are dynamic. Call GET /v1/datasets/refs/book_bill_stat_business_type 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 Settlement Contract 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.

biz_codestring

Returned value: Business Type.

biz_code_valstring

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

data_source_ledger_datestring

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

account_atstring

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

contract_nostring

Returned value: Contract No.

account_typestring

Returned value: Account Type.

account_type_valstring

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

directionstring

Returned value: Direction.

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.

currencystring

Returned value: Currency.

currency_valstring

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

amountstring

Returned value: Amount.

channelstring

Returned value: Channel.

equity_typestring

Returned value: Product Type.

equity_type_valstring

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

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/holding_contract_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": "string",
        "biz_code": "string",
        "biz_code_val": "string",
        "data_source_ledger_date": "string",
        "account_at": "string",
        "contract_no": "string",
        "account_type": "string",
        "account_type_val": "string",
        "direction": "string",
        "direction_val": "string",
        "currency": "string",
        "currency_val": "string",
        "amount": "string",
        "channel": "string",
        "equity_type": "string",
        "equity_type_val": "string"
      }
    ],
    "total": 0
  }
}

Export

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

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

Export options Export records Download result