Neste artigo, iremos abordar o método de geração de relatórios de consumo de consultas e negativações.
Nele, é possível ter as informações resumidas, como custos e data de efetivação, de todas as consultas e negativações realizadas em um intervalo de até 90 dias.
Definição da Requisição
A solicitação é feita através de uma requisição GET. A rota chamada deve ter a seguinte URL:
Produção:
https://api.consultanegativacao.com.br/v1/resumo?dataInicial=[data em formato YYYY-MM-DD]&dataFinal=[data em formato YYYY-MM-DD]
Headers
| Nome | Descrição | Exemplo |
| cnpjSh | CNPJ da Software House que possui contrato com a Tecnospeed | 01001001000113 |
| tokenSh | Token da Software House que possui contrato com a Tecnospeed | f22b97c0c9a3d41ac0a3875aba69e5aa |
| cnpjusuario | CNPJ do cliente que irá disparar as consultas | 01001001000113 |
Retornos
Em caso de sucesso:
- Status code 200:
{
"total": {
"valorTotal": 31.5,
"quantidade": 3,
"repasseSoftwareHouse": 4.5
},
"consultas": [
{
"protocolo": "8H9it6lrRt",
"cpfCnpj": "0012345678901",
"tipoConsulta": "Negativação",
"dataEfetivacao": "2021-03-18",
"valor": 10.5,
"repasse": 1.5
},
{
"protocolo": "7R8Msb0rEk",
"cpfCnpj": "0012345678902",
"tipoConsulta": "Negativação",
"dataEfetivacao": "2021-03-18",
"valor": 10.5,
"repasse": 1.5
},
{
"protocolo": "1G6yb44gK1",
"cpfCnpj": "0012345678903",
"tipoConsulta": "Concentre Top",
"dataEfetivacao": "2021-03-01",
"valor": 10.5,
"repasse": 1.5
}
]
}
Em caso de erro:
- StatusCode: 422
{
"code": 422,
"message": "Unprocessable Entity",
"errors": [
{
"message": "O intervalo de busca deve ser menor ou igual a 90 dias",
"internalCode": 6005
}
]
}
- StatusCode: 401
{
{
"code": 401,
"message": "Token inválido verifique os dados inseridos"
}
}
Nos retornos acima, o objeto "errors" trará a listagem de erros que poderão ter ocorrido na solicitação da consulta. E o campo "message" trará uma mensagem informando o motivo do erro.
Feito com amor pela Comunicação
Comentários
0 comentário
Por favor, entre para comentar.