Comparar contrato com uma matrícula vinculada

GET

/v2/clients/{clientId}/contracts/{contractId}/crossing/{registryAnalysisId}

Compara um contrato com uma das matrículas vinculadas a ele. clientId é o cliente dono do contrato; contractId, o _id do contrato (o da listagem de contratos); registryAnalysisId, o _id da matrícula analisada (um dos itens de crossPropertyRegistration.registration nos detalhes do contrato, ou o _id devolvido ao vincular a matrícula), que já precisa estar vinculada a esse contrato. A resposta traz summary, com quatro totais (Partes, Financeiro, Campos e Cotas, no formato "conferidos/total" e diff verdadeiro quando há divergência), e contract e registration, cada um com o _id, o número (contractNumber ou registryNumber) e sections, com os blocos Dados básicos, Financeiro, Conformidade por campo e Cotas de consórcio. Em cada campo, label é o nome, type é text, currency, date ou taxId, value é o dado (número em currency; ausente quando não há dado, e então placeholder vem "-") e diff é verdadeiro quando o campo diverge entre as duas partes, falso quando confere e null quando o campo não é comparado. Contrato inexistente, removido ou que não é do cliente informado devolve 404 (Contrato não encontrado); matrícula inexistente, 404 (Matrícula não encontrada); matrícula que não está vinculada a este contrato, 404 (Matrícula não vinculada ao contrato). 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 Header

Respostas

🟢200

application/json

Comparação do contrato com a matrícula

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para ver contratos

🟠403Acesso negado

🟠404Cliente, usuário, contrato ou matrícula não encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/clients/7c9e6679-7425-40de-944b-e07fc1f90ae7/contracts/3f6b1d2e-8c4a-4b7e-9d1a-5e2c7a9b0f13/crossing/a3bb189e-8bf9-4388-9912-ace4e6543002' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "summary": [
        {
            "name": "Partes",
            "value": "4/4",
            "diff": false
        },
        {
            "name": "Financeiro",
            "value": "2/3",
            "diff": true
        },
        {
            "name": "Campos",
            "value": "5/5",
            "diff": false
        },
        {
            "name": "Cotas",
            "value": "1/2",
            "diff": true
        }
    ],
    "contract": {
        "_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "contractNumber": "CCB-2026/00123",
        "sections": [
            {
                "name": "Dados básicos",
                "fields": [
                    {
                        "label": "Número",
                        "type": "text",
                        "value": "CCB-2026/00123",
                        "diff": null
                    },
                    {
                        "label": "Devedor fiduciante",
                        "type": "text",
                        "value": "Maria Exemplo da Silva",
                        "diff": false
                    },
                    {
                        "label": "Documento devedor",
                        "type": "taxId",
                        "value": "111.444.777-35",
                        "diff": false
                    }
                ]
            },
            {
                "name": "Financeiro",
                "fields": [
                    {
                        "label": "Valor total da dívida",
                        "type": "currency",
                        "value": 250000,
                        "diff": false
                    },
                    {
                        "label": "Garantia fiduciária",
                        "type": "currency",
                        "value": 400000,
                        "diff": true
                    },
                    {
                        "label": "FGTS utilizado",
                        "type": "currency",
                        "placeholder": "-",
                        "diff": false
                    }
                ]
            },
            {
                "name": "Conformidade por campo",
                "fields": [
                    {
                        "label": "Saldo devedor",
                        "type": "currency",
                        "value": 250000,
                        "diff": false
                    },
                    {
                        "label": "Nº contrato averbado",
                        "type": "text",
                        "value": "CCB-2026/00123",
                        "diff": false
                    }
                ]
            },
            {
                "name": "Cotas de consórcio",
                "value": "2 cotas",
                "fields": [
                    {
                        "label": "G.001 / C.0123",
                        "type": "currency",
                        "value": 80000,
                        "diff": false
                    },
                    {
                        "label": "G.001 / C.0456",
                        "type": "currency",
                        "value": 120000,
                        "diff": true
                    }
                ]
            }
        ]
    },
    "registration": {
        "_id": "a3bb189e-8bf9-4388-9912-ace4e6543002",
        "registryNumber": "12.345",
        "sections": [
            {
                "name": "Dados básicos",
                "fields": [
                    {
                        "label": "Número da matrícula",
                        "type": "text",
                        "value": "12.345",
                        "diff": null
                    },
                    {
                        "label": "Proprietário atual",
                        "type": "text",
                        "value": "Maria Exemplo da Silva",
                        "diff": false
                    },
                    {
                        "label": "Documento proprietário",
                        "type": "taxId",
                        "value": "11144477735",
                        "diff": false
                    }
                ]
            },
            {
                "name": "Financeiro",
                "fields": [
                    {
                        "label": "Saldo devedor",
                        "type": "currency",
                        "value": 250000,
                        "diff": false
                    },
                    {
                        "label": "Valor de avaliação",
                        "type": "currency",
                        "value": 380000,
                        "diff": true
                    },
                    {
                        "label": "FGTS",
                        "type": "currency",
                        "placeholder": "-",
                        "diff": false
                    }
                ]
            },
            {
                "name": "Conformidade por campo",
                "fields": [
                    {
                        "label": "Saldo devedor",
                        "type": "currency",
                        "value": 250000,
                        "diff": false
                    },
                    {
                        "label": "Nº contrato averbado",
                        "type": "text",
                        "value": "CCB-2026/00123",
                        "diff": false
                    }
                ]
            },
            {
                "name": "Cotas de consórcio",
                "value": "2 cotas",
                "diff": true,
                "fields": [
                    {
                        "label": "G.001 / C.0123",
                        "type": "currency",
                        "value": 80000,
                        "diff": false
                    },
                    {
                        "label": "G.001 / C.0456",
                        "type": "currency",
                        "value": 110000,
                        "diff": true
                    }
                ]
            }
        ]
    }
}

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

Página anterior

Remover contrato de um cliente

Próxima página

Vincular várias matrículas a um contrato