Recuperação de Carteiras de Cobrança

---

Listar carteiras de cobrança

Retorna uma lista paginada das carteiras de cobrança (bankslip profiles) de uma classe de fundo. O fundo precisa ser da gestora autenticada ou estar vinculado à consultoria autenticada.

Request

Disponível em

Perfil	Host	Permissão exigida
Gestora	manager-api	Leitura
Consultoria	consultant-api	Liberada pelo time de integração

URL base de cada host: Ambientes (Hosts).

ENDPOINT

/bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profiles

MÉTODO

GET

Path Params

Parâmetro	Descrição
fund_class_key	Chave da classe de fundo. Retorna 404 (BSC000006) caso não exista.

Query Params

Todos os parâmetros são opcionais.

Parâmetro	Tipo	Descrição
limit	int	Valor entre 0 e 50 com o número de itens por página. Padrão: 10.
page	int	Número da página (começando por zero). Padrão: 0.

Quando is_last_page for false, solicite a próxima page para recuperar os demais resultados.

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
}

Objeto Paginado

Campo	Tipo	Descrição
data	array	Lista de objetos de Bankslip Profile
limit	int	Limite de objetos recuperados por página
page	int	Número da página recuperada
is_last_page	boolean	Informação que indica se a página recuperada é a última
elapsed_time_ms	number	Tempo de execução da consulta no servidor, em milissegundos

Bankslip Profile

Campo	Tipo	Descrição
bankslip_profile_key	string	Identificador da carteira de cobrança.
bankslip_profile_code	string	Código da carteira de cobrança.
bankslip_profile_number	number	Número da carteira de cobrança.
bankslip_provider	string	Provedor do boleto.
additional_information	object	Informações adicionais da carteira de cobrança.
internal_account_key	string	Identificador da conta interna associada.
fund_class	object	Objeto representando a classe de fundo (ver Fund Class).
total_value	number	Valor total em aberto da carteira. Presente apenas após o cálculo periódico de saldo da carteira.
total_overdue_value	number	Valor total vencido da carteira. Presente apenas após o cálculo periódico de saldo da carteira.

Erros

Status	Código	Quando acontece
404	BSC000006	A fund_class_key não existe.
403	BSC000036	O fundo não pertence ao seu perfil.

Erros de autenticação, permissão e host: veja Erros da API.