Skip to main content

Resumo de ativos do lote

Retorna a quantidade de ativos de um lote de cessão, separada entre aprovados e reprovados, e o valor total do lote. São os mesmos números conferidos na aprovação do lote.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura
Consultoriaconsultant-apiLer Cessões

URL base de cada host: Ambientes (Hosts).

Quando utilizar

O webhook pending_consultant_approval ou pending_manager_approval informa só a mudança de status do lote. Consulte este endpoint nesse momento para saber quantos ativos o lote tem, por exemplo para confirmar que todos os ativos esperados chegaram, sem precisar paginar a listagem de ativos. Os valores de number_of_approved_assets e assignment_total_value podem ser enviados sem alteração no corpo da aprovação.

Request​

ENDPOINT
/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/assets_summary
MÉTODO
GET

Path params​

ParâmetroTipoDescrição
fund_class_keystringChave única do fundo (UUID).
assignment_configuration_keystringChave da configuração de cessão (UUID).
assignment_external_idstringO external_id informado na criação do lote.

Response​

STATUS
200
Response Body
{
"assignment_external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
"assignment_status": "pending_manager_approval",
"number_of_assets": 198,
"number_of_approved_assets": 195,
"number_of_denied_assets": 3,
"assignment_total_value": 1234567.89
}

Atributos da resposta​

CampoTipoDescrição
assignment_external_idstringO external_id do lote informado na criação.
assignment_statusstringStatus atual do lote. Veja os status do lote.
number_of_assetsintegerQuantidade total de ativos do lote, em qualquer status. Inclui os ativos ainda em análise.
number_of_approved_assetsintegerAtivos em pre_approved ou pending_formalization. É o número conferido em number_of_approved_assets na aprovação.
number_of_denied_assetsintegerAtivos em denied ou registry_denied.
assignment_total_valuenumberValor total do lote, em reais: soma do valor de compra dos ativos não reprovados, descontado o valor dos ativos recomprados no lote. É o valor conferido em assignment_total_value na aprovação.

number_of_assets pode ser maior que a soma de aprovados e reprovados enquanto houver ativos em análise. Quando o lote chega em pending_consultant_approval ou pending_manager_approval, a análise de todos os ativos já terminou e os números ficam estáveis até a decisão, salvo se ativos forem removidos do lote.

Envie o valor sem arredondar

A aprovação compara assignment_total_value com o valor do lote de forma exata. Envie o número como ele veio na resposta: um valor arredondado ou truncado devolve TRC000096.

Erros​

StatusCódigoQuando acontece
404TRC000016A combinação de fund_class_key e assignment_configuration_key não corresponde a nenhuma configuração de cessão.
404TRC000018Nenhum lote com esse external_id nesta configuração de cessão.

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