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

Avaliações por chave de nota em Lote

post

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

Body

monitoramentobooleanOptional

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

Example: true

disponibilizacao_arquivo_retornobooleanOptional

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

Example: true

tipostring · enumOptional

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

Possible values:

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.

Responses

201

Lote recebido com sucesso.

400

Requisição Inválida

application/json

401

Falha de autenticação

422

Parâmetros inválidos

application/json

post

HTTPcURLJavaScriptPython

POST /transaction-io/tio-mapper/v1/operations/avaliacoes-em-lote HTTP/1.1
Host: api.int.cerc.com
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "veiculo": {
    "id": "2655581f-1d78-47d7-95de-75234d28b53e"
  },
  "monitoramento": true,
  "disponibilizacao_arquivo_retorno": true,
  "tipo": "nfe",
  "identificadores": [
    "text"
  ]
}

No content

---

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

---