IFAST Statement · Whale Docs

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

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

id_strstring

Filters results by ID.

table_typestring

Filters results by Table Type.

Allowed values: Daily, Monthly, Quarterly

Daily · DailyMonthly · MonthlyQuarterly · Quarterly

report_namestring

Filters results by Report Name.

Allowed values: IFAST Settlement_File, IFAST Billing_Consolidated_1, IFAST sub_acct_aum

IFAST Settlement_File · IFAST Settlement_FileIFAST Billing_Consolidated_1 · IFAST Billing_Consolidated_1IFAST sub_acct_aum · IFAST sub_acct_aum

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.

business_typestring

Filters results by Business Type.

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

created_atobject

Filters results by Modify Time.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

account_dtobject

Filters results by Account Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

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

table_typestring

Returned value: Table Type.

report_namestring

Returned value: Report Name.

business_typestring

Returned value: Business Type.

account_dtstring

Returned value: Account Date.

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.

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/clearing_ifast_statements' \
  --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",
        "table_type": "string",
        "report_name": "string",
        "business_type": "string",
        "account_dt": "string",
        "currency": "string",
        "currency_val": "string",
        "amount": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0
  }
}

Export

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

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

Export options Export records Download result