Skip to main content
Imoview is a property management and real estate CRM platform that supports rental and sale workflows, tenant and guarantor contracts, inspections, condominiums, and client (user) data. Data is extracted via the Imoview API using an API key (chave) and optional email/senha for app endpoints that require user context.

​
Configuring Imoview as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Imoview option from the list of connectors. Click Next and you’ll be prompted to add your access.

​
1. Add account access

You’ll need to provide your Imoview API credentials so Nekt can access your data. The following configurations are available:
  • API key: API key (chave) for the Imoview API. The access key is provided by UNIVERSAL SOFTWARE.
  • Email: Imoview user email. When provided together with Password, Nekt uses it to obtain codigoacesso and codigoUsuario via the app validation endpoint. This is required for streams that use App_ endpoints (e.g. client_companies, guarantor_contracts).
  • Password: Imoview user password. Used with Email to authenticate and retrieve app credentials for App_ endpoints.
Once you’re done, click Next.

​
2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.
Tip: The stream can be found more easily by typing its name.
Select the streams and click Next.

​
3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data), and the type of sync.
  • Layer: Choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
  • Folder: A folder can be created inside the selected layer to group all tables being created from this new data source.
  • Table name: We suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
  • Sync Type: You can choose between INCREMENTAL and FULL_TABLE.
    • Incremental: Every time the extraction happens, we’ll get only the new or updated data. Supported for users, tenant_contracts, tenant_inspections, guarantor_contracts, condominiums, properties_rent, and properties_sale where the API supports replication by date.
    • Full table: Every time the extraction happens, we’ll get the current state of the data.
Once you are done configuring, click Next.

​
4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:
  • Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
  • Determine when to execute an Additional Full Sync.
Once you are ready, click Next to finalize the setup.

​
5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.

​
Streams and Fields

Below you’ll find all available data streams from Imoview and their corresponding fields:
Stream for clients (locador, locatário, proprietário, comprador, fiador). Source: RetornarTipo3.Key Fields:
  • codigo - Código do cliente
  • nome - Nome do cliente
  • cpfoucnpj - CPF ou CNPJ do cliente
  • telefones - Telefones do cliente
  • email - E-mail do cliente
  • endereco - Endereço do cliente
  • locatario - Indica se o cliente é locatário
  • comprador - Indica se o cliente é comprador
  • locador - Indica se o cliente é locador
  • vendedor - Indica se o cliente é vendedor
  • fiador - Indica se o cliente é fiador
  • parceiro - Indica se o cliente é parceiro
  • quantidadeimoveislocador - Quantidade de imóveis do locador
  • quantidadeimoveisvendedor - Quantidade de imóveis do vendedor
  • quantidadecontratoslocatario - Quantidade de contratos do locatário
  • quantidadeboletosativoslocatario - Quantidade de boletos ativos do locatário
  • datainclusao - Data de inclusão do cliente
  • dataultimaalteracao - Data da última alteração do cliente
Flags & config:
  • senhacadastrada, emailcadastrado, temvistoria, temesteira, naoexigircpf, temcashgo, naoexibiravisodesocupacao
  • anosdisponiveis - Anos disponíveis (array)
  • diasminimoavisodesocupacao - Dias mínimos de aviso de desocupação
  • whatsappbotiniciarConversa
Stream for rental contracts by tenant (child of users; only for clients with locatário=true). Source: Locatario/RetornarContratos.Key Fields:
  • codigo - Código do contrato
  • codigoauxiliar - Código auxiliar
  • unidadecodigo, unidade - Unidade
  • locatariocodigo, locatarionome, locatariotelefone1, locatariotelefone2, locatarioemail, locatariocpf
  • situacao, status, motivostatus
  • valoraluguel, taxaadministracao, tipotaxaadministracao, taxaintermediacao, tipotaxaintermediacao
  • datainclusao, dataultimaalteracao, dataativacao, datainicio, datafim
  • dataproximoreajuste, dataproximoaluguel, dataproximorepasse
  • diavencimento, diarepasse, diavencimentoaluguel, diavencimentorepasse
  • dataavisodesocupacao, dataprevisaorescisao, datarescisao, motivorescisao, complementomotivo
  • formacobranca, formarecebimento, comofazerrepasse
  • destinacao, ramoatividade, indicereajuste
  • garantido, tipogarantido, quantosmesesgarantido
  • responsavel, advogadoresponsavel, resumo
  • contratosassinado, vistoriasassinado - Arrays
  • imoveis - Array de imóveis
  • seguroincendio, garantialocaticia - Objects
Stream for property inspections by tenant (child of users; only for locatários). Source: Locatario/RetornarVistorias.Key Fields:
  • codigo - Código da vistoria
  • tipo - Tipo da vistoria
  • situacao, situacaocodigo
  • datahora, datahorafimconsideracoes
  • imovelresumo, contratoresumo, locatario, vistoriador
  • ambientes, medidores, chaves - Arrays
Stream for rental contracts by guarantor (child of users; only for clients with fiador=true). Source: Fiador/App_RetornarContratos. Requires email and senha for app credentials.Key Fields: Same structure as Tenant Contracts (codigo, unidade, locatário, situacao, status, valores, datas, formacobranca, formarecebimento, garantia, etc.), including contratosassinado, vistoriasassinado, imoveis, seguroincendio, garantialocaticia.
Stream for companies from Imoview CRM. Source: Cliente/App_RetornarEmpresas. Requires email and senha for app credentials.Key Fields:
  • codigo - Código da empresa
  • nome - Nome da empresa
  • telefone - Telefone
  • email1 - E-mail principal
Stream for available condominiums. Source: Imovel/RetornarCondominiosDisponiveis (POST).Key Fields:
  • codigo, nome, codigodestinacao, destinacao, tipo, formacobranca
  • construtora, anoconstrucao, arealote
  • datahoracadastro, datahoraultimaalteracao, descricao
  • codigobairro, bairro, codigocidade, cidade, estado, codigoregiao, regiao, codigosubregiao, subregiao
  • cep, endereco, numero, complemento, pontoreferencia, melhoracesso
  • latitude, longitude
  • numerovagavisitante, tipovagavisitante, numeroelevador, numerotorres, numeroandares, unidadesporandar, totalunidades
  • cartorio, matriculacartorio, livrocartorio, folhacartorio
  • valorcondominio, valorfundoreserva, valoraluguel, valoralugado, valorvenda, valorvendido
  • areainterna, areaexterna, numeroquartos, numerobanhos, numerosuites, numerovagas
  • Quartis (primeiroquartilaluguel, medianaquartilaluguel, etc.)
  • Boolean amenities: aguaindividual, alarme, piscina, academia, churrasqueira, portaria24horas, etc.
  • urlfotoprincipal, urlvideo, fotos, fotos360, extras, extras2
  • unidadesaluguel, unidadesvenda - Arrays
Stream for available rental properties (finalidade=1). Source: Imovel/RetornarImoveisDisponiveis (POST).Key Fields:
  • codigo, codigomae, emdesocupacao, empreendimento, empreendimentofilho, nomeempreendimento, siteempreendimento
  • codigocondominio, nomecondominio, titulo, metadescription, codigoauxiliar
  • unidade, nomeunidade, telefoneunidade, emaileunidade
  • finalidade, codigodestinacao, destinacao, codigotipo, tipo, codigotipo2, tipo2, situacao
  • valor, valoranterior, valorm2, valorcondominio, valoriptu
  • codigobairro, bairro, codigocidade, cidade, estado, codigoregiao, regiao, cep, endereco, numero, complemento
  • numeroquartos, numerobanhos, numerovagas, numerosuites, areaprincipal, areainterna, areaexterna, latitude, longitude
  • descricao, aceitafinanciamento, aceitapermuta
  • datahoracadastro, datahoraultimaalteracao, datahoraultimavalidacao
  • urlfotoprincipal, urlpublica, anexos, proprietarios, fotos - Arrays/objects
Stream for available properties for sale (finalidade=2). Same endpoint as Properties Rent with finalidade=2.Key Fields: Same structure as Properties Rent (codigo, condomínio, título, tipo, situação, valor, endereço, quartos, áreas, datas, fotos, etc.).

​
Data Model

The following diagram illustrates the relationships between the data streams in Imoview. Users is the main entity; tenant_contracts, tenant_inspections, and guarantor_contracts are child streams filtered by client role (locatário or fiador). Client companies, condominiums, properties_rent, and properties_sale are independent streams.

​
Implementation Notes

​
Authentication

  • For client_companies and guarantor_contracts, the tap calls the app validation endpoint with email and senha (MD5) to obtain codigoacesso and codigoUsuario, which are then sent in headers or params as required by the API.

​
Replication

  • Users supports incremental sync via dataultimaalteracao (filter dataHoraInicialUltimaAlteracao).
  • Tenant contracts, guarantor_contracts, condominiums, properties_rent, and properties_sale support replication by their respective date fields where the API allows.

​
Pagination

  • Streams use page-based pagination (numeroPagina / numeroRegistros or pagina). Page size varies by stream (e.g. 20 for tenant_contracts, 100 for others).