Cadastrar imóvel rural no patrimônio de um cliente

POST

/assets/properties/rural

Cadastra manualmente um imóvel rural no patrimônio do cliente informado em clientId, no corpo. São obrigatórios clientId, name e totalArea (número maior que zero). São opcionais nirf (8 caracteres, letras maiúsculas e números), num_incra (número do imóvel no INCRA), cars (códigos CAR do imóvel), state (sigla da UF, em maiúsculas), city, typeProperty e totalAreaProperty. typeProperty define a situação do imóvel para o cliente: ARRENDADA marca o imóvel como não próprio, PARCERIA como parceria e DE SOCIEDADE como em sociedade; qualquer outro valor, ou a ausência dele, cadastra o imóvel como próprio. Com PARCERIA ou DE SOCIEDADE, totalAreaProperty é gravada como a participação percentual do cliente no imóvel; nos demais casos, a participação é 100. Se nirf, num_incra ou cars forem enviados, a rota consulta um serviço externo de dados de imóveis rurais, e os dados que ele devolve (CAFIR, parcelas e CARs) substituem os do cadastro; se essa consulta falhar, a resposta é o erro dela, mas o imóvel já está cadastrado. Devolve o ID do imóvel criado, em propertyId. Cliente inexistente devolve 404; nirf já cadastrado para o cliente devolve 402; corpo fora do formato devolve 422. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Imóvel rural cadastrado

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠402Imóvel já cadastrado neste NIRF

🟠404Cliente não encontrado

🟠422Dados do imóvel inválidos

Request Example

Shell

JavaScript

Java

Swift

curl --location '/assets/properties/rural' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "clientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "name": "Fazenda Exemplo",
    "totalArea": 480.5,
    "state": "MT",
    "city": "Sorriso",
    "typeProperty": "PARCERIA",
    "totalAreaProperty": 50
}'

Response Example

200 - Sucesso

{
    "propertyId": "f1a2b3c4-0000-4000-8000-000000000101"
}

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

Página anterior

Cadastrar ativo financeiro de um cliente

Próxima página

Consultar imóvel rural