Carteira - Baixar a Carteira

Introdução

Este recurso gera, de forma síncrona, um relatório da classe de fundo e o devolve em base64.

Disponível em

Perfil	Host	Permissão exigida
Gestora	manager-api	Leitura
Consultoria	consultant-api	Ler Carteiras

URL base de cada host: Ambientes (Hosts).

Request

ENDPOINT

/composition/fund_class/FUND_CLASS_KEY/report

MÉTODO

POST

STATUS

201

Request Body

{
    "report_type": "wallet_composition_by_composition",
    "composition_type": "final_quota",
    "reference_date": "2025-01-20"
}

Campo	Tipo	Obrigatório	Descrição
report_type	string	Sim	Relatório a gerar. Ver tabela abaixo.
reference_date	string	Sim	Data de referência, no formato YYYY-MM-DD.
composition_type	string	Para relatórios da carteira, este ou composition_key	pre_quota, final_quota ou opening_quota. Usa a carteira desse tipo na reference_date.
composition_key	string	Para relatórios da carteira, este ou composition_type	Chave de uma carteira específica.

Relatórios disponíveis

report_type	Conteúdo	Precisa identificar a carteira
wallet_composition_by_composition	Carteira em planilha (.xlsx)	Sim
wallet_composition_by_composition_pdf	Carteira em PDF	Sim
xml_401_by_composition	XML 4.01 da carteira — não aceita pre_quota	Sim
xml_5_by_composition	XML 5.0 da carteira — não aceita pre_quota	Sim
cash_account_demonstrative	Demonstrativo da conta caixa	Não (só reference_date)
pmts_reconciliation	Conciliação de PMTs	Não (só reference_date)

Os demais valores aceitos pelo contrato (wallet_composition_a_pagar, assets_wallet_composition_legacy, wallet_asset_installments_settlement_legacy, settlements_status_by_reference_date, discarded_settlements_on_payment_batch) não são gerados por este endpoint e devolvem CMP000027.

Response

Response Body

{
    "document_b64": "UEsDBBQABgAIAAAAIQ..."
}

document_b64 é o arquivo do relatório codificado em base64.

Atenção

Para os relatórios da carteira, ela precisa estar em confirmed, pending_confirmation ou reproved_by_agent. Em outro status, a resposta é 400 (CMP000015).

Erros

Status	Código	Quando acontece
400	CMP000015	A carteira não está em confirmed, pending_confirmation ou reproved_by_agent.
400	CMP000044	Relatório da carteira sem composition_key nem composition_type.
400	CMP000027	report_type não é gerado por este endpoint.
404	CMP000026	xml_401_by_composition ou xml_5_by_composition pedido para uma carteira pre_quota.
404	CMP000012	Não existe carteira com a composition_key informada, ou do composition_type na reference_date.
400	CMP000014	O gerador de relatórios recusou o pedido; a description traz o motivo.
400	QIT000001	Corpo fora do contrato: campo obrigatório ausente, data fora do formato ou campo não previsto.
400	QIT000004	A fund_class_key é de uma classe de outra gestora.

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