Remoção de Ativos do Lote

Processo para retirar ativos de um lote que está aguardando aprovação do gestor. A remoção envolve 3 passos sequenciais: reabrir o lote, remover os ativos desejados e fechar o lote novamente.

Pré-requisito

A remoção de ativos só é possível quando o lote está no status pending_manager_approval (aguardando aprovação do gestor). Com o lote nesse status, é necessário reabri-lo antes de realizar qualquer alteração nos ativos.

Passo 1 — Reabrir o lote

Altere o status do lote para pending_assets_insertion para permitir a remoção de ativos.

Request

ENDPOINT

/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}

MÉTODO

PUT

Request Body

{
    "assignment_status": "pending_assets_insertion"
}

Atributos do body

Campo	Tipo	Obrigatoriedade	Descrição
assignment_status	string	obrigatório	Status para o qual o lote será atualizado. Para reabrir, envie pending_assets_insertion.

Response

STATUS

200

Response Body

{
    "assignment_key": "8e515a17-8b4d-49a3-aed6-47c9574e426a",
    "external_id": "9eec85be-97c9-41e0-88b3-b17a39869b36",
    "status": "pending_assets_insertion",
    "number_of_approved_assets": 10,
    "assignment_total_value": 1234.99
}

Atributos da resposta

Campo	Tipo	Descrição
assignment_key	string	Identificador único do lote (UUID).
external_id	string	Chave externa do lote fornecida pelo parceiro.
status	string	Novo status do lote: pending_assets_insertion.
number_of_approved_assets	integer	Quantidade de ativos aprovados no lote.
assignment_total_value	number	Valor total da cessão em reais.

Passo 2 — Remover ativos

Com o lote reaberto, remova cada ativo desejado alterando seu status para denied. Realize uma requisição para cada ativo a ser removido.

Request

ENDPOINT

/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/asset/{asset_external_id}

MÉTODO

PUT

Path params

Parâmetro	Tipo	Descrição
asset_external_id	string	O external_id do ativo que será removido.

Request Body

{
    "asset_status": "denied"
}

Atributos do body

Campo	Tipo	Obrigatoriedade	Descrição
asset_status	string	obrigatório	Status para o qual o ativo será atualizado. Para remover, envie denied.

Response

STATUS

200

Response Body

{
    "external_id": "9eec85be-97c9-41e0-88b3-b17a39869b36",
    "status": "denied"
}

Atributos da resposta

Campo	Tipo	Descrição
external_id	string	Chave externa do ativo.
status	string	Novo status do ativo: denied.

Passo 3 — Fechar o lote novamente

Após remover os ativos desejados, feche o lote para que ele siga novamente para aprovação do gestor.

Request

ENDPOINT

/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}

MÉTODO

PUT

Request Body

{
    "assignment_status": "completed_assets_insertion"
}

Atributos do body

Campo	Tipo	Obrigatoriedade	Descrição
assignment_status	string	obrigatório	Status para o qual o lote será atualizado. Para fechar, envie completed_assets_insertion.

Response

STATUS

200

Response Body

{
    "assignment_key": "8e515a17-8b4d-49a3-aed6-47c9574e426a",
    "external_id": "9eec85be-97c9-41e0-88b3-b17a39869b36",
    "status": "completed_assets_insertion",
    "number_of_approved_assets": 10,
    "assignment_total_value": 1234.99
}

Atributos da resposta

Campo	Tipo	Descrição
assignment_key	string	Identificador único do lote (UUID).
external_id	string	Chave externa do lote fornecida pelo parceiro.
status	string	Novo status do lote: completed_assets_insertion.
number_of_approved_assets	integer	Quantidade de ativos aprovados remanescentes.
assignment_total_value	number	Valor total atualizado da cessão em reais.

Após fechar o lote, ele seguirá novamente para aprovação do gestor e continuará o fluxo normalmente.

Possíveis erros

STATUS

404

Ativo não encontrado

O asset_external_id informado na URL não corresponde a nenhum ativo do lote. Verifique se o identificador está correto e se o ativo pertence ao lote informado.

{
  "title": "Asset not found",
  "description": "Asset not found",
  "translation": "Ativo não foi encontrado",
  "code": "TRC000020"
}

STATUS

400

Ativo não pode ser removido

O ativo informado não pode ser negado/removido no status atual. Isso pode ocorrer quando o ativo já foi descartado ou quando o lote não está aberto para modificação.

{
  "title": "Cant deny this asset.",
  "description": "This asset cant be denied.",
  "translation": "Esse ativo não pode ser negado",
  "code": "TRC000086"
}

STATUS

400

Status do lote inválido para esta operação

O lote não está em um status que permita esta operação. Para remover ativos, o lote precisa estar no status pending_assets_insertion. Verifique o status atual do lote e, se necessário, reabra-o primeiro (Passo 1).

{
  "title": "Invalid assignment status",
  "description": "Assignment is not in a valid status for this operation",
  "translation": "O lote não está em um status valido para essa operação",
  "code": "TRC000087"
}