Vincular uma matrícula analisada a um contrato

Vincula ao contrato informado em contractId a matrícula registryAnalysisId do cliente e devolve a conferência dela com o contrato. A matrícula passa a ficar vinculada a este contrato mesmo que já estivesse vinculada a outro. A resposta traz _id e status da matrícula, propertyRegistration (o número da matrícula), consortiumMember (os nomes das partes do contrato com papel de devedor, separados por vírgula e "e"; quando o contrato não tem devedor, o nome da parte principal) e conference, com seis campos booleanos (contractNumber, registeredProperty, debtorAndOwner, fgts, totalAmountDebt e groupsAndQuotas), verdadeiros quando o dado da matrícula confere com o do contrato. Contrato inexistente, removido ou que não é do cliente informado devolve 404 (Contrato não encontrado.); matrícula inexistente, removida ou que não é do cliente, 404 (Matrícula não encontrada.). Para vincular várias de uma vez, use a rota em lote; para enviar uma matrícula nova, a rota que recebe o PDF. Requer autenticação via Bearer JWT ou header x-api-key e a permissão de vincular matrículas 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).

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Respostas

🟢200

application/json

Matrícula vinculada, com a conferência dela com o contrato

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para vincular matrículas

🟠403Acesso negado

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

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

{ "_id": "a3bb189e-8bf9-4388-9912-ace4e6543002", "propertyRegistration": "12.345", "consortiumMember": "Maria Exemplo da Silva", "status": "FINALIZADO", "conference": { "contractNumber": true, "registeredProperty": true, "debtorAndOwner": true, "fgts": false, "totalAmountDebt": true, "groupsAndQuotas": true } }

Vincular uma matrícula analisada a um contrato

Requisição

Respostas