Pular para o conteúdo principal

Enviar Solicitações

Este endpoint permite o envio externo, via API, de um lote de informações de PL/Cota para processamento.

  • Método: POST
  • Caminho: /api/v1/pl-cota/envio

Headers da Requisição​

HeaderValorObrigatórioDescrição
AuthorizationBearer <token>SimToken de autenticação JWT
Content-Typeapplication/jsonSimFormato do payload
X-Correlation-ID<uuid>NãoID para rastreabilidade

Regras de Acesso​

Para envio via API, o usuário precisa atender às regras abaixo:

RegraValor esperado
Perfilsupervisor ou operator
PapelAdministrador, Gestor ou Controladoria
ServiçoPLCOTA
FuncionalidadePL_COTA_ENVIO

Usuário sysadmin não realiza envio de PL/Cota. O acesso de sysadmin é restrito à consulta e download de recibos.

Corpo da Requisição​

O corpo da requisição deve conter o campo informacoes, com uma lista de 1 até 3.000 informações.

{
"informacoes": [
{
"identificacao": {
"tipoIdentificador": "1",
"idRegistro": "CODIGO123",
"cnpjAdministrador": "11222333000199",
"cnpjProvedor": "11222333000199",
"tipoInforme": "1",
"moeda": "BRL",
"dataInformacao": "2026-04-17",
"reenvio": "N"
},
"informeSimples": {
"valorCota": "1000000,123456789",
"valorPatrimLiq": "1000000,12345"
}
}
]
}

Exemplo cURL​

curl -X POST "https://<host>/api/v1/pl-cota/envio" \
-H "Authorization: Bearer <seu_token>" \
-H "Content-Type: application/json" \
-d '{
"informacoes": [
{
"identificacao": {
"tipoIdentificador": "1",
"idRegistro": "CODIGO123",
"cnpjAdministrador": "11222333000199",
"cnpjProvedor": "11222333000199",
"tipoInforme": "1",
"moeda": "BRL",
"dataInformacao": "2026-04-17",
"reenvio": "N"
},
"informeSimples": {
"valorCota": "1000000,123456789",
"valorPatrimLiq": "1000000,12345"
}
}
]
}'

Blocos do Payload​

identificacao​

CampoTipoObrigatórioDescrição
tipoIdentificadorStringSimIdentificador da classe ou subclasse. Domínio: 1=Código STI, 2=Código ANBIMA, 3=CNPJ, 4=Identificador CVM da Subclasse
idRegistroStringSimCódigo de identificação da classe ou subclasse
cnpjAdministradorStringSimCNPJ do administrador
cnpjProvedorStringSimCNPJ do provedor/controlador de ativos
tipoInformeStringSimDomínio: 1=PL/Cota, 2=Informe Diário, 3=Integração CVM, 4=Cota Bruta
moedaStringSimCódigo da moeda, exemplo: BRL
dataInformacaoStringSimData base no formato AAAA-MM-DD
reenvioStringSimDomínio: S ou N
observacoesStringCondicionalObrigatório em cenários de reenvio com diferença. Mínimo 10 e máximo 500 caracteres

informeSimples​

CampoTipoObrigatórioDescrição
valorCotaStringCondicionalValor da cota líquida
valorPatrimLiqStringCondicionalValor do patrimônio líquido
valorCotaBrutaStringCondicionalValor da cota bruta
valorCotaPreEventoStringCondicionalValor da cota antes do evento
rentabilidadeCotaStringCondicionalVariação da cota

informeCompleto​

CampoTipoObrigatórioDescrição
valorTotalAplicStringCondicionalValor total das aplicações
valorTotalResgStringCondicionalValor total dos resgates
valorTotalComeCotasStringCondicionalValor total do come-cotas
numeroCotistasStringCondicionalNúmero total de cotistas

informeCvm​

CampoTipoObrigatórioDescrição
dataProxInfoPlStringCondicionalData do próximo informe CVM no formato AAAA-MM-DD
valorTotalCartFundoStringCondicionalValor total dos ativos da carteira do fundo
valorTotalAtivosStringCondicionalValor total dos ativos
valorTotalSaidasStringCondicionalValor total das saídas de caixa
cotistasSignificativosArrayCondicionalLista de até 5 cotistas significativos

Formato dos Valores​

Tipo de campoFormato
Datas da APIAAAA-MM-DD
Valores monetários/decimaisString com vírgula como separador decimal. Exemplo: 1000000,12345
CPF/CNPJSomente números

Campos decimais com ponto (.) são rejeitados com erro de separador decimal inválido.

Respostas​

Sucesso - 201 Created​

Em caso de recebimento com sucesso, o lote é gravado para processamento assíncrono e a API retorna o recibo da solicitação.

{
"recibo": "FSH5AUI2DNS7AJJ",
"idRequest": "b4b8f3fd-86c2-49b0-a8a5-0f5b4a6cb700",
"instituicao": "11222333000199",
"usuario": "usuario@empresa.com.br",
"dataHoraEnvio": "20260417T143000",
"statusProc": "1",
"totalInformacoes": 1,
"msgErro": []
}

Leiaute Inválido - 400 Bad Request​

Quando a validação síncrona identifica erro de leiaute, a API retorna status 400 com o recibo gerado para consulta posterior.

{
"recibo": "HON9D49BLMVNRX4",
"idRequest": "b4b8f3fd-86c2-49b0-a8a5-0f5b4a6cb700",
"instituicao": "11222333000199",
"usuario": "usuario@empresa.com.br",
"dataHoraEnvio": "20260417T143000",
"dataHoraProc": "20260417T143001",
"statusProc": "5",
"totalInformacoes": 1,
"msgErro": [
{
"erro": "Separador de decimais inválido"
}
]
}

Sem Autenticação - 401 Unauthorized​

Retornado quando o token não é enviado ou é inválido.

Sem Permissão - 403 Forbidden​

Retornado quando o token é válido, mas não atende às regras de perfil, papel, serviço ou funcionalidade do PL/Cota.