Visualizar protestos de um cliente

GET

/queries/clients/{clientId}/protests/{queryId}

Devolve o resumo dos protestos do cliente informado em clientId na consulta informada em queryId (o identificador da consulta, listado por serviço na rota de consultas do cliente). Com resultado, a resposta traz totalProtests (quantidade de protestos), valueTotalOfProtests (soma dos valores), totalsCities (cidades de cartório diferentes), totalCompanies (apresentantes ou cedentes diferentes), date (quando o resultado foi gravado) e items, um item por protesto, com company (o apresentante, ou o cedente quando não há apresentante), value, date, city e uf. Os valores em texto do protesto são convertidos para número, lendo o ponto como separador de milhar e a vírgula como separador decimal. Quando não há resultado para o cliente na consulta informada (consulta inexistente, de outro cliente ou ainda não finalizada), a resposta é 200 com a mensagem "Consulta não finalizada"; quando há resultado sem protestos, é 200 com a mensagem "Cliente não possui protestos". Nos dois casos message é um texto, não uma lista. Requer autenticação via Bearer JWT ou header x-api-key. O cliente precisa pertencer à empresa do usuário: cliente inexistente devolve 404 (Cliente não encontrado), cliente de outra empresa devolve 401 (Acesso negado) e usuário inativo devolve 404 (Usuário não encontrado).

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200

application/json

Resumo dos protestos do cliente

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/queries/clients/7c9e6679-7425-40de-944b-e07fc1f90ae7/protests/3f6b1d2e-8c4a-4b7e-9d1a-5e2c7a9b0f13' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "totalsCities": 1,
    "valueTotalOfProtests": 4300.9,
    "totalProtests": 2,
    "totalCompanies": 2,
    "date": "2026-09-18T14:03:00.000Z",
    "items": [
        {
            "company": "CREDOR EXEMPLO LTDA",
            "value": 1800.4,
            "date": "2026-03-05",
            "city": "SORRISO",
            "uf": "MT"
        },
        {
            "company": "COMERCIAL EXEMPLO",
            "value": 2500.5,
            "date": "2025-11-20",
            "city": "SORRISO",
            "uf": "MT"
        }
    ]
}

Modificado em 2026-10-13 09:47:06

Página anterior

Visualizar Boa Vista de um cliente

Próxima página

Visualizar Quod de um cliente