Solicitação de Avaliação por chave de nota em Lote

Avaliações por chave de nota em Lote

Serviço para criar um pedido de Avaliação para um lote de Duplicatas.

post

/transaction-io/tio-mapper/v1/operations/avaliacoes-em-lote

Body

monitoramentoboolean

Seleção que define a inclusão ou não de monitoramento na avaliação

Example: true

disponibilizacao_arquivo_retornoboolean

Seleção que define a geração ou não de arquivo de retorno.

Example: true

tipostring · enum

Tipo de duplicata a ser avaliado, "nfe" para duplicata_mercantil.

Options: nfe

identificadoresstring[]required

Chaves de nota a serem avaliadas separadas por vírgula como descrito no modelo do body. Em caso de apenas 1 chave de nota, basta colocar apenas uma dentro do array.

veiculoobject

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.int.cerc.com/transaction-io/tio-mapper/v1/operations/avaliacoes-em-lote' \
  --header 'Content-Type: application/json' \
  --data '{"monitoramento":true,"disponibilizacao_arquivo_retorno":true,"tipo":"nfe","identificadores":[null],"veiculo":{"id":"2655581f-1d78-47d7-95de-75234d28b53e"}}'

201

400

401

422

201

No body

Lote recebido com sucesso.

---

Request Body:

Campo	Obrigatório	Tipo	Descrição
veiculo	Obrigatório	Object	Investimento jurídico ou entidade financiadora a favor da qual foi solicitada a Avaliação. Corresponde ao campo “Titular/Carteira” do Portal do Agente.
id	Obrigatório	String	Identificador do titular/carteira.
monitoramento	Obrigatório	Boolean	Se enviado como verdadeiro, o monitoramento será ativado para cada item no lote de Avaliação. Caso seja marcado como falso ou não seja enviado, o monitoramento não será ativado para o lote de Avaliações e as tags que identificam o monitoramento não serão retornadas na Pesquisa de Avaliação dos Direitos de Crédito do Ponto Final.
disponibilizacao_arquivo_retorno	Obrigatório	Boolean	Se enviado como verdadeiro, será gerado um Arquivo de Retorno sobre o processamento do lote de Avaliação. O status de disponibilidade do arquivo pode ser verificado no serviço de consulta em lote de avaliação. O arquivo pode ser solicitado pelo serviço de consulta de retorno em lote de Avaliações.
aguardar_documentos	Opcional	Boolean	Se enviado como verdadeiro, o participante poderá enviar solicitação de cadastro sem a chave da NF-e, sendo necessário o envio do arquivo XML separadamente.
buscar_documentos	Opcional	Boolean	Se enviado como verdadeiro, o participante poderá enviar solicitação de cadastro sem a chave da NF-e, não haverá necessidade de enviar o arquivo XML separadamente, o sistema será responsável pela busca de um documento fiscal, com sucesso ou não. Caso o campo aguardar_documentos seja enviado com o valor true, a regra de espera de documento será respeitada para que o sistema possa então buscar um documento.
validacoes	Obrigatório	Array	Lista de dados para os quais você deseja solicitar Avaliações

---