Bankslip Profiles Retrieval

---

List bankslip profiles

Returns a paginated list of the bankslip profiles of a fund class. Access is granted only to the manager responsible for the fund class.

Request

ENDPOINT

/bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profiles

METHOD

GET

Path Params

Parameter	Description
fund_class_key	Key of the fund class. Returns 404 (NotFoundFundClass) if it doesn't exist.

Query Params

All parameters are optional.

Parameter	Type	Description
limit	int	Value between 0 and 50 with the number of items per page. Default: 10.
page	int	Zero-based page number. Default: 0.

When is_last_page is false, request the next page to retrieve the remaining results.

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
}

Paginated Object

Field	Type	Description
data	array	List of Bankslip Profile objects
limit	int	Limit of objects retrieved per page
page	int	Number of the retrieved page
is_last_page	boolean	Indicates whether the retrieved page is the last one
elapsed_time_ms	number	Server-side query execution time, in milliseconds

Bankslip Profile

Field	Type	Description
bankslip_profile_key	string	Identifier of the bankslip profile.
bankslip_profile_code	string	Profile code.
bankslip_profile_number	number	Profile number.
bankslip_provider	string	Bankslip provider.
additional_information	object	Additional information of the profile.
internal_account_key	string	Identifier of the associated internal account.
fund_class	object	Object representing the fund class (see Fund Class).
total_value	number	Total outstanding value of the profile. Only present after the profile's periodic balance calculation.
total_overdue_value	number	Total overdue value of the profile. Only present after the profile's periodic balance calculation.