Busca de Avaliações de Duplicatas Mercantis

Esta documentação descreve a API para consultar o status de processamento das Avaliações.

Conjunto de serviços para a consulta de dados do documento fiscal e das partes envolvidas na operação.

Serviço para consultar o status de processamento das Avaliações. O resultado é uma lista com resumos das Avaliações consultadas. Este pode ser filtrado através dos atributos passados no corpo da requisição. O serviço retorna uma lista com as Avaliações filtradas pelos parâmetros enviados na requisição. O campo id da Avaliação só será adicionado quando a situação do status da Avaliação for concluido. A presença do campo lote_id indicará que a Avaliação foi solicitada através de uma requisição de avaliação em lote. Uma Avaliação também pode ser feita avulsa por meio do Portal CERC.

post

/transaction-io/tio-mapper/v1/operations/validacoes/busca-de-validacoes-duplicata-mercantil

Authorizations

stgAuthServerintAuthServerprdAuthServer

Header parameters

authorizationstringrequired

Example: Bearer {TokenJWT}

Body

status_de_processamentostring

Status de processamento do veículo

lote_idsstring[]

Lista de identificadores únicos de lotes associados ao veículo

chaves_nfestring[]

Lista de chaves NFE associadas ao veículo

referencias_externasstring[]

Lista de referências externas associadas ao veículo

veiculoobject

Objeto contendo informações sobre o veículo

paginacaoobject

Objeto contendo informações de paginação

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.int.cerc.com/transaction-io/tio-mapper/v1/operations/validacoes/busca-de-validacoes-duplicata-mercantil' \
  --header 'authorization: Bearer {TokenJWT}' \
  --header 'Content-Type: application/json' \
  --data '{"lote_ids":[null],"chaves_nfe":[null],"referencias_externas":[null],"veiculo":{"id":"text"},"paginacao":{"por_pagina":1,"pagina":1}}'

200

400

401

422

200

{
  "busca_validacao_duplicata_mercantil": {
    "lote_ids": [
      "text"
    ],
    "chaves_nfe": [
      "text"
    ],
    "referencias_externas": [
      "text"
    ],
    "status_de_processamento": "text",
    "veiculo": {
      "id": "text"
    },
    "paginacao": {
      "por_pagina": 1,
      "pagina": 1
    }
  }
}

Em caso de sucesso

---

Path Parameters:

Campo	Obrigatório	Tipo	Descrição
validacao_id	Obrigatório	String	Identificador da Avaliação.

---

Header Parameters:

Campo	Obrigatório	Tipo	Descrição
id	Obrigatório	String	Identificador único do veículo.
lote_ids	Opcional	Array	Lista de identificadores únicos de lotes associados ao veículo
chaves_nfe	Opcional	Array	Lista de chaves NFE associadas ao veículo
referencias_externas	Opcional	Array	Lista de referências externas associadas ao veículo.
status_de_processamento	Opcional	String	Status de processamento do veículo. Os valores permitidos são "pendente", "processando", "concluido" e "com_erro".
paginacao	Opcional	Object	Objeto contendo informações de paginação
paginacao.por_pagina	Obrigatório	Integer	Quantidade de itens por página.
paginacao_pagina	Obrigatório	Integer	Número da página

---