Exportar conferência de matrículas de um contrato (CSV)

GET

/v2/clients/{clientId}/contracts/{contractId}/export

Exporta em CSV a conferência das matrículas vinculadas ao contrato, uma linha por matrícula, com as mesmas seis conferências de crossPropertyRegistration dos detalhes do contrato. As colunas são Matrícula, Membro do Consórcio (o nome do primeiro proprietário da matrícula), Número do Contrato, Imóvel Registral, Devedor / Proprietário, FGTS, Valor da Dívida e Grupos e Cotas; as seis últimas trazem Conforme ou Divergente. O arquivo vem como download (Content-Disposition: attachment), em UTF-8 com BOM e separado por vírgula; o nome é o número do contrato (letras, números, ponto, hífen e sublinhado; o resto vira sublinhado) ou, quando o contrato não tem número, o _id dele, com a extensão .csv. Contrato sem matrícula vinculada gera um arquivo só com o cabeçalho. Contrato inexistente, removido ou que não é do cliente informado devolve 404 (Contrato não encontrado). 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

text/csv

Arquivo CSV com a conferência das matrículas

Headers

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para ver contratos

🟠403Acesso negado

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

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Sucesso

Matrícula,Membro do Consórcio,Número do Contrato,Imóvel Registral,Devedor / Proprietário,FGTS,Valor da Dívida,Grupos e Cotas
12.345,Maria Exemplo da Silva e João Exemplo da Silva,Conforme,Conforme,Conforme,Divergente,Conforme,Conforme
9.876,Empresa Exemplo Ltda,Divergente,Conforme,Divergente,Divergente,Divergente,Divergente

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

Página anterior

Visualizar detalhes de um contrato

Próxima página

Remover contrato de um cliente