Listar imóveis rurais de um cliente, com totais

GET

/assets/{clientId}/properties/rural

Lista os imóveis rurais não removidos do cliente informado em clientId, do alterado mais recentemente para o mais antigo, em páginas de 60 itens, e traz os totais do cliente por classificação. Cada item traz dados resumidos do imóvel: propertyId, name, totalArea, state, city, irURL e year, mais os campos calculados areaOwnedPercent (percentual do cliente entre os proprietários do CAFIR, encontrado pelo CPF ou CNPJ do cliente, 0 quando ele não consta), areaOwned (esse percentual aplicado à área total), isGEORef (se alguma parcela tem coordenadas) e type (PARCERIA, PRÓPRIA, DE SOCIEDADE ou ARRENDADA). Os totais consideram todos os imóveis do cliente, não só a página: properties traz a quantidade de imóveis por classificação, areas traz a área somada por classificação (em inSociety entra a área do cliente, areaOwned; nas demais, a área total do imóvel) e totalArea é a soma de areas. owned corresponde a PRÓPRIA, leased a ARRENDADA, inSociety a DE SOCIEDADE e partnership a PARCERIA. value, em cada item, e totalValue vêm sempre 0: esta rota não calcula valor. Para os dados completos do imóvel (CAFIR, parcelas e CARs), use a listagem detalhada de imóveis rurais do cliente. page começa em 1, e valor menor ou igual a 0 vale 1. Requer autenticação via Bearer JWT ou header x-api-key. 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).

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

Imóveis rurais do cliente

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/assets/7c9e6679-7425-40de-944b-e07fc1f90ae7/properties/rural?page=1' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items": [
        {
            "propertyId": "f1a2b3c4-0000-4000-8000-000000000101",
            "name": "FAZENDA EXEMPLO",
            "totalArea": 480.5,
            "value": 0,
            "state": "MT",
            "city": "SORRISO",
            "isGEORef": true,
            "areaOwned": 240.25,
            "areaOwnedPercent": 50,
            "irURL": null,
            "year": null,
            "type": "DE SOCIEDADE"
        }
    ],
    "areas": {
        "owned": 0,
        "leased": 0,
        "inSociety": 240.25,
        "partnership": 0
    },
    "properties": {
        "owned": 0,
        "leased": 0,
        "inSociety": 1,
        "partnership": 0
    },
    "totalArea": 240.25,
    "totalValue": 0
}

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

Página anterior

Listar ativos financeiros de um cliente

Próxima página

Remover bem móvel