获取 Boleto 档案

---

列出 boleto 档案

返回基金类别下 boleto 档案的分页列表。仅允许负责该基金类别的管理人（manager）访问。

Request

ENDPOINT

/bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profiles

METHOD

GET

Path Params

参数	描述
fund_class_key	基金类别的键。若不存在则返回 404（NotFoundFundClass）。

Query Params

所有参数均为可选。

参数	类型	描述
limit	int	每页条目数，取值范围为 0 到 50。默认值：10。
page	int	页码（从零开始）。默认值：0。

当 is_last_page 为 false 时，请请求下一个 page 以获取其余结果。

Response

Response Body

Response Body

{
    "data": [
        {
            "bankslip_profile_key": "a1d7f09b-cb77-48da-a23d-b83d97d4b46b",
            "bankslip_profile_code": "329-09-0001-0000000",
            "bankslip_profile_number": 9,
            "bankslip_provider": "qi_scd",
            "additional_information": {
                "requester_profile_key": "30f72181-042c-4aae-9be7-b2794916416f"
            },
            "internal_account_key": "18809219-17d9-4845-a830-51e7f2beaf28",
            "fund_class": {
                "fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
                "document_number": "00.000.000/0001-01",
                "name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
                "manager": {
                    "name": "GESTÃO DE RECURSOS",
                    "manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
                    "document_number": "00.100.100/0001-00"
                }
            },
            "total_value": 12345.67,
            "total_overdue_value": 890.12
        },
        {
            "bankslip_profile_key": "e0771a02-4f3e-4162-a468-a872fc6975e4",
            "bankslip_profile_code": "329-09-0001-0000001",
            "bankslip_profile_number": 10,
            "bankslip_provider": "qi_scd",
            "additional_information": {
                "requester_profile_key": "cdec985f-e629-44ce-8511-a323f38bd63e"
            },
            "internal_account_key": "5e621ba2-b4ac-4ddd-9893-82d220e1577e",
            "fund_class": {
                "fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
                "document_number": "00.000.000/0001-01",
                "name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
                "manager": {
                    "name": "GESTÃO DE RECURSOS",
                    "manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
                    "document_number": "00.100.100/0001-00"
                }
            }
        }
    ],
    "limit": 10,
    "page": 0,
    "is_last_page": true,
    "elapsed_time_ms": 12.34
}

分页对象

字段	类型	描述
data	array	Bankslip Profile 对象列表
limit	int	每页获取的对象数量上限
page	int	获取的页码
is_last_page	boolean	指示获取的页面是否为最后一页
elapsed_time_ms	number	服务器端查询执行时间（毫秒）

Bankslip Profile

字段	类型	描述
bankslip_profile_key	string	boleto 档案的标识符。
bankslip_profile_code	string	档案代码。
bankslip_profile_number	number	档案编号。
bankslip_provider	string	boleto 提供方。
additional_information	object	档案的附加信息。
internal_account_key	string	关联内部账户的标识符。
fund_class	object	表示基金类别的对象（参见 Fund Class）。
total_value	number	档案的未结总额。仅在档案的定期余额计算完成后出现。
total_overdue_value	number	档案的逾期总额。仅在档案的定期余额计算完成后出现。