Recuperação de Configurações de Boleto

---

Listar configurações de boleto

Retorna uma lista paginada das configurações de boleto de uma carteira de cobrança de uma classe de fundo. O acesso é permitido apenas ao gestor responsável pela classe de fundo.

Request

ENDPOINT

/bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profile/BANKSLIP_PROFILE_KEY/bankslip_configurations

MÉTODO

GET

Path Params

Parâmetro	Descrição
fund_class_key	Chave da classe de fundo. Retorna 404 (NotFoundFundClass) caso não exista.
bankslip_profile_key	Chave da carteira de cobrança, que deve pertencer à classe de fundo. Retorna 404 (NotFoundBankslipProfile) caso não seja encontrada.

Query Params

Todos os parâmetros são opcionais.

Parâmetro	Tipo	Descrição
issuer_type	string	Filtra pelo tipo do emissor (ver Tipo de Emissor). Um valor desconhecido retorna o erro InvalidValueForEntity.
limit	int	Valor entre 0 e 30 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_configuration_key": "1b382eb7-7006-4389-975b-afa76b0ad7b4",
            "bankslip_profile": {
                "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"
                    }
                }
            },
            "bankslip_issuer_type": "manager",
            "delay": 0,
            "our_number_range": {
                "our_number_range_initial": 1,
                "our_number_range_final": 99999
            }
        },
        {
            "bankslip_configuration_key": "9c47d1a8-3f2e-4b6d-8a1c-5e7f9b3d2c80",
            "bankslip_profile": {
                "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"
                    }
                }
            },
            "bankslip_issuer_type": "internal",
            "delay": 1
        }
    ],
    "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 Configuration
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 Configuration

Campo	Tipo	Descrição
bankslip_configuration_key	string	Identificador único da configuração de boleto.
bankslip_profile	object	Carteira de cobrança associada (ver Bankslip Profile).
bankslip_issuer_type	string	Tipo do emissor do boleto (ver Tipo de Emissor).
delay	int	Delay configurado para a emissão dos boletos.
our_number_range	object	Faixa de "nosso número" atribuída à configuração (ver Our Number Range). Presente apenas quando a configuração possui uma faixa atribuída.

Our Number Range

Campo	Tipo	Descrição
our_number_range_initial	int	Início da faixa de "nosso número".
our_number_range_final	int	Fim da faixa de "nosso número".

Tipo de Emissor

Enumerador	Descrição
internal	Interno
manager	Gestor
consultant	Consultor