Fund File

Query fund file (announcement and reference document) configurations, used by content operations to maintain documents that can be attached to funds and shown to customers.

Request parameters

Combine business filters through filters (see the filter field descriptions below), and use page, page_size, and orderBy for pagination and sorting.

Business notes

Each record is one fund file and can be filtered by name_locales (file name) and scenario (display scenario).

A record carries the multilingual file name and link, the display scenario, a remark, the target user group, and the approval status; adding, editing, and deleting a file all go through an approval flow.

Returns

On success, returns the matching records with pagination info. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/fund_files

Authorization

AuthorizationstringheaderRequired

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

Permission

fund.fund_file_query

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

Request body application/json

filtersobject

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

Child attributes

name_localesstring

File Name. Filters results by File Name.

scenariostring

Scenario. Filters results by Scenario.

Allowed values: popup_fund_details_subscription Fund Details Subscription Popup, popup_aip_submit Fund Order Subscription, inline_fund_order_subscription Fund Order Subscription, inline_fund_order_redemption Fund Order Redemption, inline_fund_details_profile Fund Details Profile, inline_private_fund_details_fundamental_information Fund Details Fundamental Information

Values

popup_fund_details_subscription: Fund Details Subscription Popup
popup_aip_submit: Fund Order Subscription
inline_fund_order_subscription: Fund Order Subscription
inline_fund_order_redemption: Fund Order Redemption
inline_fund_details_profile: Fund Details Profile
inline_private_fund_details_fundamental_information: Fund Details Fundamental Information

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

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

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

scenariostring

Scenario. Returned value: Scenario.

scenario_valstring

Scenario (raw value). Raw value of scenario. The scenario field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

file_idstring

File ID. Returned value: File ID.

name_localesstring

File Name. Returned value: File Name.

remarkstring

Remark. Returned value: Remark.

user_group_idsstring

User Group. Returned value: User Group.

updated_atstring

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

operatorstring

Last Editor. Returned value: Last Editor.

operator_valstring

Last Editor (raw value). Raw value of operator. The operator field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Total. 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 --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/fund_files' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "scenario": "Fund Details Subscription Popup,Fund Order Subscription,Fund Order Subscription,Fund Order Redemption,Fund Details Fundamental Information,Fund Details Profile",
        "scenario_val": "popup_fund_details_subscription,popup_aip_submit,inline_fund_order_subscription,inline_fund_order_redemption,inline_private_fund_details_fundamental_information,inline_fund_details_profile",
        "file_id": "20260119200847",
        "name_locales": "{\"en\": \"基金详情申购en\", \"zh-CN\": \"基金详情申购\", \"zh-HK\": \"基金详情申购ft\"}",
        "remark": "基金详情申购,基金定投弹窗,申购下单\t",
        "user_group_ids": "",
        "updated_at": "1776413055",
        "operator": "Zhang San",
        "operator_val": "Zhang San"
      }
    ],
    "total": 9
  }
}