Listar contratos de um cliente

GET

/v2/clients/{clientId}/contracts

Lista os contratos do cliente informado em clientId que foram enviados para análise e não foram removidos. Cada item traz _id, createdAt (quando o contrato foi enviado), status (a situação da análise; um contrato recém-enviado está em FILA), contractNumber, debtors (os nomes das partes cujo papel contém "devedor" ou que são marcadas como essenciais), modality, totalAmountDebt (valor da dívida), guaranteeValue (valor da garantia) e registers (os ids das matrículas vinculadas). Enquanto o contrato não tem dados extraídos, contractNumber e modality vêm vazios, debtors e registers vêm como lista vazia e os dois valores vêm 0. search filtra pelo número do contrato (contém o texto, sem diferenciar maiúsculas); offset e limit paginam (limit de 20 a 100, padrão 20); sort e order ordenam, e sem sort a lista vem do contrato mais recente para o mais antigo. sort aceita createdAt, contractNumber, modality, totalAmountDebt e guaranteeValue; com debtors a lista continua do mais recente para o mais antigo, e order só ordena os nomes dentro de cada contrato. total é a quantidade de contratos que atendem à busca, sem a paginação. Requer autenticação via Bearer JWT ou header x-api-key e a permissão de ver contratos de clientes. 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). Usuário sem perfil de permissão recebe 403 (Acesso negado); perfil inexistente, 401 (Permissão inválida!); perfil sem a permissão, 400 (Permissão não encontrada).

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 de Consulta

Parâmetros Header

Respostas

🟢200

application/json

Contratos do cliente

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para ver contratos

🟠403Acesso negado

🟠422Parâmetros de consulta inválidos

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/clients/7c9e6679-7425-40de-944b-e07fc1f90ae7/contracts?search=CCB&offset=0&limit=20&sort=createdAt&order=desc' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items": [
        {
            "_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "createdAt": "2026-10-07T13:45:10.123Z",
            "status": "FILA",
            "contractNumber": "",
            "debtors": [],
            "modality": "",
            "totalAmountDebt": 0,
            "guaranteeValue": 0,
            "registers": []
        }
    ],
    "total": 1
}

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

Página anterior

Listar banners em exibição

Próxima página

Cadastrar contrato de um cliente para análise