Central de Atendimento

Visão Geral

Este endpoint fornece acesso aos dados de imóveis do sistema, permitindo buscas com filtros específicos e paginação dos resultados.

Detalhes do Endpoint

URL Base

GET /v1/imob/imoveis

Autenticação

• Requer permissão de acesso total (FULL_ACCESS)
• É necessário estar autenticado no sistema

Parâmetros da Requisição

Estrutura da Resposta

A resposta será no formato JSON com a seguinte estrutura:

{
    "data": [
        {
            "id": "123",
            "tipo": "Apartamento",
            "endereco": "Rua das Flores, 123",
            "locaisUsoComercial": [
                {
                    "numero": "QT 101",
                    "tipo": "QT",
                    "metragem": 45.5,
                    "locador": {
                        // Dados do locador (NegocianteDto)
                    },
                    "contrato": {
                        "dataContrato": "2024-01-01",
                        "dataFimVigencia": "2025-01-01",
                        "status": "Ativo",
                        "cliente": {
                            // Dados do cliente (NegocianteDto)
                        },
                        "servicos": [
                            {
                                "empresaId": 1,
                                "valor": 1500.00,
                                "item": {
                                    "id": 10,
                                    "codigo": "ITM-001",
                                    "descricao": "Serviço de limpeza"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ],
    "metadata": {
        "resultset": {
            "count": "número total de registros",
            "start": "índice inicial",
            "limit": "limite por página"
        }
    }
}

Detalhamento dos Objetos

ImovelDto

LocalUsoComercialDto

ContratoDto

ServicoContratoDto

ItemDto

Códigos de Resposta

Exemplos de Uso

Busca básica

GET /v1/imob/imoveis

Busca com paginação

GET /v1/imob/imoveis?page.start=0&page.limit=10

Busca completa

GET /v1/imob/imoveis?tipoImovel=RURAL&page.start=0&page.limit=10

Observações Importantes

1. A paginação é opcional, mas recomendada para grandes volumes de dados
2. Os filtros de data são opcionais e podem ser usados em conjunto
3. O tipo de imóvel é um filtro opcional que pode ser usado para refinar a busca
4. A resposta inclui metadados úteis para paginação e contagem total de registros
5. Cada imóvel pode ter múltiplos locais de uso comercial
6. Cada local de uso comercial pode ter um contrato associado
7. Os contratos podem ter múltiplos serviços vinculados

Limitações

• O limite padrão de registros por página é 50
• É necessário ter a permissão FULL_ACCESS para acessar este endpoint
• Os valores monetários são retornados em formato decimal

Exemplo de Resposta Completa

{
    "data": [
        {
            "id": 123,
            "tipo": "Apartamento",
            "endereco": "Rua das Flores, 123",
            "locaisUsoComercial": [
                {
                    "numero": "QT 101",
                    "tipo": "QT",
                    "metragem": 45.5,
                    "locador": {
                        "id": 1,
                        "nome": "João Silva",
                        "documento": "123.456.789-00"
                    },
                    "contrato": {
                        "dataContrato": "2024-01-01",
                        "dataFimVigencia": "2025-01-01",
                        "status": "Ativo",
                        "cliente": {
                            "id": 2,
                            "nome": "Maria Santos",
                            "documento": "987.654.321-00"
                        },
                        "servicos": [
                            {
                                "empresaId": 1,
                                "valor": 1500.00,
                                "item": {
                                    "id": 10,
                                    "codigo": "ITM-001",
                                    "descricao": "Serviço de limpeza"
                                }
                            },
                            {
                                "empresaId": 1,
                                "valor": 800.00,
                                "item": {
                                    "id": 11,
                                    "codigo": "ITM-002",
                                    "descricao": "Serviço de segurança"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ],
    "metadata": {
        "resultset": {
            "count": 1,
            "start": 0,
            "limit": 50
        }
    }
}

Esta API é parte do sistema ERP Easy e está disponível para clientes com as devidas permissões de acesso.