> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nekt.com/llms.txt
> Use this file to discover all available pages before exploring further.
# CasaSoft as a data source
> Bring data from CasaSoft to Nekt.
CasaSoft is a Brazilian property-management ERP for real-estate agencies, delivered in the cloud as cloudSLIM. It runs the whole rental operation: the property portfolio and its owners, the tenant contracts and the guarantees backing them, the charges billed every month, the municipal property tax, the brokerage deals, and the agency's own service tickets and filed documents. This connector brings that operation into your catalog.
## Configuring CasaSoft as a Source
In the [Sources](https://app.nekt.ai/sources) tab, click on the "Add source" button located on the top right of your screen. Then, select the CasaSoft option from the list of connectors.
Click **Next** and you'll be prompted to add your access.
### 1. Add account access
You'll need a cloudSLIM user and the company code of your account. Ask CasaSoft support for a user dedicated to the integration rather than reusing a person's login — that way the extraction keeps working when people join or leave, and its access can be reviewed on its own.
The following configurations are available:
* **User**: The *Identificação* used to sign in to cloudSLIM, usually an email address.
* **Password**: The password of that user. It is stored encrypted.
* **Company code**: The *Empresa* code of your account, a number such as `1930`. It is the same code you type when signing in, and it selects which company's data is read.
* **Start date**: (Advanced) The earliest date to read, for the streams that grow over time. See the note below on which streams it applies to. Leave it empty to load the whole history.
The **Start date** deliberately does not apply to every stream. It bounds the streams that read a log of events — Tickets, Non-conformities, Documents, Terminated Contracts, Property Tax and Brokerage Deals — because those grow without limit and you choose how much history to keep. Properties, tenants, owners and their insurance are always read in full: CasaSoft only lets those be filtered by a status or signature date, so filtering on one would leave out properties and contracts that were registered years ago and are still active today.
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.
CasaSoft exposes the same entity through more than one endpoint, each carrying a different set of columns — Properties, Properties (base view) and Properties (detailed view) describe the same properties, and so do the two Owners streams and the two Surety Bonds streams. Pick the view that carries the columns you need rather than all of them; selecting several means reading the same records more than once.
Selecting a stream your cloudSLIM plan does not include will fail the extraction rather than silently produce an empty table. If a run fails saying CasaSoft refused access to a stream, unselect that stream or ask CasaSoft to release the module for the integration user.
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 data - which is good if, for example, you want to keep every record ever fetched.
* Full table: every time the extraction happens, we'll get the current state of the data - which is good if, for example, you don't want to have deleted data in your catalog.
Every CasaSoft stream is a **full table** sync. None of the CasaSoft endpoints exposes a "last modified" column, so there is nothing an incremental sync could reliably use: a contract edited months after it was signed would never come back. Reading each collection in full on every run is what keeps the tables faithful to what is in cloudSLIM right now.
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](https://docs.nekt.com/runs/scheduling-and-triggers), 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](https://docs.nekt.com/get-started/core-concepts/resource-control).
* Determine when to execute an **Additional [Full Sync](https://docs.nekt.com/get-started/core-concepts/types-of-sync#additional-full-sync)**. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
Once you are ready, click **Next** to finalize the setup.
### 5. Check your new source
You can view your new source on the [Sources](https://app.nekt.ai/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](https://app.nekt.ai/catalog), you need at least one successful source run.
# Streams and Fields
## Available streams
| Stream | Slug | Sync | Description |
| -------------------------------- | ------------------------------- | ---------- | ----------------------------------------------------- |
| Properties | `imoveis` | Full table | Properties with their commercial terms |
| Properties (base view) | `imoveis_base` | Full table | Properties with utility accounts and current tenant |
| Properties (detailed view) | `imoveis_detalhes` | Full table | Properties with their building and assigned staff |
| Property Fire Insurance | `imoveis_seguro_incendio` | Full table | Fire insurance policies for the managed properties |
| Tenant Contracts | `inquilinos` | Full table | Rental contracts and the tenants holding them |
| Tenant Contracts (detailed view) | `inquilinos_detalhes` | Full table | Contracts with their guarantee and payment agreements |
| Terminated Contracts | `inquilinos_contratos_baixados` | Full table | Contracts that were closed, with the reason |
| Surety Bonds (by contract) | `inquilinos_fiancas_seguro` | Full table | Surety bonds reached through the tenant endpoint |
| Owners | `proprietarios` | Full table | Owners with their payout and tax settings |
| Owners (base view) | `proprietarios_base` | Full table | Owners with nationality and occupation |
| Surety Bonds | `fianca_seguros` | Full table | Surety bonds guaranteeing rental contracts |
| Property Tax (IPTU) | `iptus` | Full table | Municipal property tax records |
| Brokerage Deals | `intermediacoes` | Full table | Deals closed by the agency and their commission |
| Charges | `lancamentos` | Full table | Individual charges and credits posted to a contract |
| Recurring Charges | `taxas_fixas` | Full table | Charges configured to repeat every month |
| Tickets | `tickets` | Full table | Support tickets opened with the agency |
| Non-conformities | `rncs` | Full table | Non-conformity records from the quality process |
| Documents | `geds` | Full table | Index of the documents filed in cloudSLIM |
## How the data arrives
**References are how the tables join.** cloudSLIM identifies records by a business reference rather than by a foreign key: an owner is `00000.00`, a property `00000.000` and a tenant contract `00000.000.00`, each extending the one above it. Join on `referencia`, `ref_proprietario` and `ref_imovel` to walk from an owner to their properties and from a property to its contracts.
**Some columns hold structured data as a JSON string** — the building of a property, the staff assigned to it, the instalments of a property tax record or a brokerage deal, the attachments of a ticket. Use your warehouse's JSON functions to expand them in a Query or Notebook.
**Dates that were never filled in arrive empty.** cloudSLIM returns a placeholder date for fields that were never set; the connector turns those into nulls, so an empty termination date means the contract is still open rather than a contract terminated in the year 1. All timestamps are converted to UTC from Brazilian local time.
**Documents are indexed, not downloaded.** The Documents stream carries what each filed document is, who filed it and which record it belongs to. The file itself stays in cloudSLIM.
## Fields by stream
Below you'll find all available data streams from CasaSoft and their corresponding fields:
Every property the agency manages, with the commercial terms agreed with its owner.
**Endpoint:** `/imoveis` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the property record in cloudSLIM.
* `referencia` - Business reference of the property in the format 00000.000, used across cloudSLIM to link the property to its owner, tenants and charges.
* `ref_proprietario` - Reference of the owner this property belongs to, in the format 00000.00.
* `situacao_locacao` - Rental status of the property: Locado (rented), Divulgação (advertised), Disponível (available), Baixado (deactivated) or Próprio (owned by the agency).
* `data_cadastro` - Date the property was registered in cloudSLIM.
* `endereco` - Street name of the property address.
* `tipo_endereco` - Type of thoroughfare of the address, such as Rua, Avenida or Travessa.
* `numero` - Street number of the property.
* `complemento` - Address complement, such as the apartment, block or unit.
* `cep` - Brazilian postal code (CEP) of the property.
* `bairro` - Neighbourhood of the property.
* `cidade` - City of the property.
* `estado` - Brazilian state (UF) of the property.
* `finalidade` - Intended use of the property, such as residential or commercial.
* `area_total` - Total area of the property in square metres.
* `area_util` - Usable (private) area of the property in square metres.
* `data_desde_locacao` - Date the property became available for rent.
* `data_desde_venda` - Date the property became available for sale.
* `tipo_imovel` - Category of the property, such as apartment, house, shop or land.
* `tipo_construcao` - Construction type of the property, such as masonry or wood.
* `data_baixa` - Date the property was deactivated in cloudSLIM, when it no longer is managed.
* `locacao` - Whether the property is managed for rental.
* `matricula_agua` - Water utility account number registered for the property.
* `matricula_energia` - Electricity utility account number registered for the property.
* `matricula_gas` - Gas utility account number registered for the property.
* `data_angariacao` - Date the agency took the property into its portfolio.
* `comissao` - Management commission charged on the rent, as a percentage.
* `comissao_sobre_taxas` - Whether and how the commission also applies to the charges billed with the rent.
* `indice_reajuste` - Inflation index used to adjust the rent, such as IGPM or IPCA.
* `forma_reajuste` - How the rent adjustment is applied, for example annually on the contract date.
* `valor_aluguel` - Rent amount currently registered for the property.
* `multa_desconto` - Whether the amount in valor\_multa\_desconto is a penalty or a discount.
* `valor_multa_desconto` - Penalty or discount amount applied to the rent.
* `ultimo_inquilino` - Name of the most recent tenant of the property.
* `dia_extrato` - Day of the month on which the owner statement is issued for this property.
* `comissao_minima` - Whether a minimum commission applies to this property.
* `motivo_baixa_complemento` - Free-text reason recorded when the property was deactivated.
* `divulgar_internet` - Whether the property may be advertised on the agency's website and portals.
* `numero_mes_garantido` - Number of months of rent guaranteed to the owner regardless of tenant payment.
* `grupo` - Grouping the agency uses to classify the property.
* `administra_condominio` - Whether the agency also administers the condominium fee of this property.
The same properties, seen through the endpoint that carries the utility accounts and the current tenant instead of the commercial terms.
**Endpoint:** `/imoveis/base` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the property record in cloudSLIM.
* `referencia` - Business reference of the property in the format 00000.000, used across cloudSLIM to link the property to its owner, tenants and charges.
* `ref_proprietario` - Reference of the owner this property belongs to, in the format 00000.00.
* `situacao_locacao` - Rental status of the property: Locado (rented), Divulgação (advertised), Disponível (available), Baixado (deactivated) or Próprio (owned by the agency).
* `data_cadastro` - Date the property was registered in cloudSLIM.
* `endereco` - Street name of the property address.
* `tipo_endereco` - Type of thoroughfare of the address, such as Rua, Avenida or Travessa.
* `numero` - Street number of the property.
* `complemento` - Address complement, such as the apartment, block or unit.
* `cep` - Brazilian postal code (CEP) of the property.
* `bairro` - Neighbourhood of the property.
* `cidade` - City of the property.
* `estado` - Brazilian state (UF) of the property.
* `finalidade` - Intended use of the property, such as residential or commercial.
* `area_total` - Total area of the property in square metres.
* `area_util` - Usable (private) area of the property in square metres.
* `data_desde_locacao` - Date the property became available for rent.
* `data_desde_venda` - Date the property became available for sale.
* `tipo_imovel` - Category of the property, such as apartment, house, shop or land.
* `tipo_construcao` - Construction type of the property, such as masonry or wood.
* `data_baixa` - Date the property was deactivated in cloudSLIM, when it no longer is managed.
* `locacao` - Whether the property is managed for rental.
* `matricula_agua` - Water utility account number registered for the property.
* `matricula_energia` - Electricity utility account number registered for the property.
* `matricula_gas` - Gas utility account number registered for the property.
* `data_agua` - Date the water utility account was registered or last updated.
* `situacao_agua` - Status of the water utility account for the property.
* `data_energia` - Date the electricity utility account was registered or last updated.
* `situacao_energia` - Status of the electricity utility account for the property.
* `data_gas` - Date the gas utility account was registered or last updated.
* `situacao_gas` - Status of the gas utility account for the property.
* `indicacoes_fiscais` - Municipal fiscal registrations (indicações fiscais) linked to the property, as a JSON array of objects. Each entry ties the property to a property-tax record; see the iptus stream for the amounts.
* `inquilino` - Summary of the tenant currently occupying the property, as a JSON object. The full contract is in the inquilinos stream.
The same properties, enriched with the building the unit belongs to and the staff assigned to it.
**Endpoint:** `/imoveis/detalhes` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the property record in cloudSLIM.
* `referencia` - Business reference of the property in the format 00000.000, used across cloudSLIM to link the property to its owner, tenants and charges.
* `ref_proprietario` - Reference of the owner this property belongs to, in the format 00000.00.
* `situacao_locacao` - Rental status of the property: Locado (rented), Divulgação (advertised), Disponível (available), Baixado (deactivated) or Próprio (owned by the agency).
* `data_cadastro` - Date the property was registered in cloudSLIM.
* `endereco` - Street name of the property address.
* `tipo_endereco` - Type of thoroughfare of the address, such as Rua, Avenida or Travessa.
* `numero` - Street number of the property.
* `complemento` - Address complement, such as the apartment, block or unit.
* `cep` - Brazilian postal code (CEP) of the property.
* `bairro` - Neighbourhood of the property.
* `cidade` - City of the property.
* `estado` - Brazilian state (UF) of the property.
* `finalidade` - Intended use of the property, such as residential or commercial.
* `area_total` - Total area of the property in square metres.
* `area_util` - Usable (private) area of the property in square metres.
* `data_desde_locacao` - Date the property became available for rent.
* `data_desde_venda` - Date the property became available for sale.
* `tipo_imovel` - Category of the property, such as apartment, house, shop or land.
* `tipo_construcao` - Construction type of the property, such as masonry or wood.
* `data_baixa` - Date the property was deactivated in cloudSLIM, when it no longer is managed.
* `locacao` - Whether the property is managed for rental.
* `matricula_agua` - Water utility account number registered for the property.
* `matricula_energia` - Electricity utility account number registered for the property.
* `matricula_gas` - Gas utility account number registered for the property.
* `data_angariacao` - Date the agency took the property into its portfolio.
* `comissao` - Management commission charged on the rent, as a percentage.
* `comissao_sobre_taxas` - Whether and how the commission also applies to the charges billed with the rent.
* `indice_reajuste` - Inflation index used to adjust the rent, such as IGPM or IPCA.
* `forma_reajuste` - How the rent adjustment is applied, for example annually on the contract date.
* `valor_aluguel` - Rent amount currently registered for the property.
* `multa_desconto` - Whether the amount in valor\_multa\_desconto is a penalty or a discount.
* `valor_multa_desconto` - Penalty or discount amount applied to the rent.
* `ultimo_inquilino` - Name of the most recent tenant of the property.
* `dia_extrato` - Day of the month on which the owner statement is issued for this property.
* `comissao_minima` - Whether a minimum commission applies to this property.
* `motivo_baixa_complemento` - Free-text reason recorded when the property was deactivated.
* `divulgar_internet` - Whether the property may be advertised on the agency's website and portals.
* `numero_mes_garantido` - Number of months of rent guaranteed to the owner regardless of tenant payment.
* `grupo` - Grouping the agency uses to classify the property.
* `administra_condominio` - Whether the agency also administers the condominium fee of this property.
* `edificio` - Building the unit belongs to, as a JSON object: its name and address, the administrator of the condominium and the utility suppliers registered for it.
* `atendente` - Agency staff assigned to the property, as a JSON array of objects. Serialized as text so the column stays stable as cloudSLIM adds attributes to it.
Fire insurance policies contracted for the managed properties.
**Endpoint:** `/imoveis/seguroincendio` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the fire insurance record in cloudSLIM.
* `referencia` - Reference of the insured property, in the format 00000.000.
* `seguradora_id` - Internal identifier of the insurance company that issued the policy.
* `seguradora` - Name of the insurance company that issued the policy.
* `apolice` - Policy number of the fire insurance.
* `data_apolice` - Date the policy was issued.
* `data_renovacao_seguro` - Date the policy is due for renewal.
* `situacao` - Status of the policy: Normal, Cancelado (cancelled), Baixado (closed) or Simulação (quote only).
* `data_situacao` - Date the policy reached its current status.
* `data_inicio` - Date the coverage starts.
* `data_final` - Date the coverage ends.
* `valor_seguro` - Insured value of the property.
* `valo_segurado` - Amount effectively insured. The field name carries the typo cloudSLIM uses in its own payload.
* `valor_predial` - Coverage amount for the building structure.
* `valor_moveis_utencilio` - Coverage amount for furniture and fittings.
* `valor_vendaval` - Coverage amount for windstorm damage to the building.
* `valor_vendaval_conteudo` - Coverage amount for windstorm damage to the contents.
* `valor_danos_eletricos` - Coverage amount for electrical damage.
* `valor_perda_aluguel` - Coverage amount for loss of rent while the property is uninhabitable.
* `valor_primeira_parcela` - Amount of the first instalment billed for the policy.
* `valor_parcela` - Amount of each remaining instalment billed for the policy.
* `mes_ano_inicial` - First month billed for the policy, as MM/YYYY.
* `mes_ano_final` - Last month billed for the policy, as MM/YYYY.
* `codigo_taxa` - Code of the charge type used to bill the policy, from 000 to 999.
* `nao_debitar_proprietario` - Whether the instalments must not be debited from the owner.
* `nao_debitar_inquilino` - Whether the instalments must not be debited from the tenant.
* `observacao` - Free-text notes recorded about the policy.
One row per rental contract: who rents, which property, on what terms.
**Endpoint:** `/inquilinos` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the tenant contract in cloudSLIM.
* `referencia` - Business reference of the tenant contract in the format 00000.000.00. The first two blocks match the reference of the rented property.
* `ref_proprietario` - Reference of the owner of the rented property, in the format 00000.00.
* `ref_imovel` - Reference of the rented property, in the format 00000.000.
* `imovel_id` - Internal identifier of the rented property, matching id on the property streams.
* `nome` - Full name or company name of the tenant.
* `cpf_cnpj` - Brazilian taxpayer number of the tenant: CPF for individuals, CNPJ for companies.
* `tipo` - Whether the tenant is an individual or a company.
* `situacao` - Status of the tenant contract: Normal, Baixado (terminated), Bloqueado (blocked) or Desocupação (moving out).
* `email` - Email address of the tenant.
* `telefone` - Primary phone number of the tenant.
* `telefone_secundario` - Secondary phone number of the tenant.
* `whats_app` - WhatsApp number of the tenant.
* `data_cadastro` - Date the tenant was registered in cloudSLIM.
* `data_locacao` - Date the rental contract was signed.
* `data_ocupacao` - Date the tenant took occupancy of the property.
* `data_vigencia` - Date the current contract term ends.
* `data_baixa` - Date the contract was terminated, when it no longer is active.
* `motivo_baixa` - Reason recorded for terminating the contract.
* `data_ultimo_reajuste` - Date of the most recent rent adjustment on this contract.
* `data_proxio_reajuste` - Date of the next scheduled rent adjustment. The field name carries the typo cloudSLIM uses in its own payload.
* `data_revisional` - Date the contract is due for a rent review.
* `indice_reajuste` - Inflation index used to adjust this contract's rent, such as IGPM or IPCA.
* `prazo_locacao` - Contract term, usually expressed in months.
* `valor_aluguel` - Rent amount agreed in this contract.
* `multa_desconto` - Whether the amount in valor\_multa\_desconto is a penalty or a discount.
* `valor_multa_desconto` - Penalty or discount amount applied to this contract's rent.
* `fianca` - Type of guarantee backing the contract, such as a surety bond, a guarantor or a security deposit.
* `utilizacao_imovel` - Declared use of the property under this contract, such as residential or commercial.
* `grupo` - Grouping the agency uses to classify the tenant.
* `data_nascimento` - Date of birth of the tenant, for individuals.
* `estado_civil` - Marital status of the tenant.
* `nacionalidade` - Nationality of the tenant.
* `profissao` - Occupation of the tenant.
* `sexo` - Gender recorded for the tenant.
* `atendente` - Agency staff assigned to this contract, as a JSON array of objects. Serialized as text so the column stays stable as cloudSLIM adds attributes to it.
The same contracts, plus the surety bond backing them and any payment agreement negotiated with the tenant.
**Endpoint:** `/inquilinos/detalhes` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the tenant contract in cloudSLIM.
* `referencia` - Business reference of the tenant contract in the format 00000.000.00. The first two blocks match the reference of the rented property.
* `ref_proprietario` - Reference of the owner of the rented property, in the format 00000.00.
* `ref_imovel` - Reference of the rented property, in the format 00000.000.
* `imovel_id` - Internal identifier of the rented property, matching id on the property streams.
* `nome` - Full name or company name of the tenant.
* `cpf_cnpj` - Brazilian taxpayer number of the tenant: CPF for individuals, CNPJ for companies.
* `tipo` - Whether the tenant is an individual or a company.
* `situacao` - Status of the tenant contract: Normal, Baixado (terminated), Bloqueado (blocked) or Desocupação (moving out).
* `email` - Email address of the tenant.
* `telefone` - Primary phone number of the tenant.
* `telefone_secundario` - Secondary phone number of the tenant.
* `whats_app` - WhatsApp number of the tenant.
* `data_cadastro` - Date the tenant was registered in cloudSLIM.
* `data_locacao` - Date the rental contract was signed.
* `data_ocupacao` - Date the tenant took occupancy of the property.
* `data_vigencia` - Date the current contract term ends.
* `data_baixa` - Date the contract was terminated, when it no longer is active.
* `motivo_baixa` - Reason recorded for terminating the contract.
* `data_ultimo_reajuste` - Date of the most recent rent adjustment on this contract.
* `data_proxio_reajuste` - Date of the next scheduled rent adjustment. The field name carries the typo cloudSLIM uses in its own payload.
* `data_revisional` - Date the contract is due for a rent review.
* `indice_reajuste` - Inflation index used to adjust this contract's rent, such as IGPM or IPCA.
* `prazo_locacao` - Contract term, usually expressed in months.
* `valor_aluguel` - Rent amount agreed in this contract.
* `multa_desconto` - Whether the amount in valor\_multa\_desconto is a penalty or a discount.
* `valor_multa_desconto` - Penalty or discount amount applied to this contract's rent.
* `fianca` - Type of guarantee backing the contract, such as a surety bond, a guarantor or a security deposit.
* `utilizacao_imovel` - Declared use of the property under this contract, such as residential or commercial.
* `grupo` - Grouping the agency uses to classify the tenant.
* `data_nascimento` - Date of birth of the tenant, for individuals.
* `estado_civil` - Marital status of the tenant.
* `nacionalidade` - Nationality of the tenant.
* `profissao` - Occupation of the tenant.
* `sexo` - Gender recorded for the tenant.
* `atendente` - Agency staff assigned to this contract, as a JSON array of objects. Serialized as text so the column stays stable as cloudSLIM adds attributes to it.
* `fianca_seguro` - Surety bond backing this contract, as a JSON object. The same records are available as columns in the inquilinos\_fiancas\_seguro stream.
* `acordo` - Payment agreement negotiated with the tenant over unpaid charges, as a JSON object: the instalments, amounts and status of the agreement.
Contracts that were closed, with the reason and who handled it.
**Endpoint:** `/inquilinos/contratos/baixados` · **Primary key:** `referencia`, `data_baixa`
**Fields:**
* `referencia` - Reference of the terminated tenant contract, in the format 00000.000.00.
* `data_baixa` - Date the contract was terminated.
* `motivo` - Reason recorded for terminating the contract.
* `tipo_fianca` - Type of guarantee that backed the contract.
* `cia_seguro` - Insurance company of the surety bond, when the guarantee was a bond.
* `atendente_nome` - Name of the agency staff who handled the termination.
The same bonds as the Surety Bonds stream, reached through the tenant endpoint.
**Endpoint:** `/inquilinos/fiancas/seguro` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the surety bond record in cloudSLIM.
* `referencia` - Reference of the tenant contract the bond guarantees, in the format 00000.000.00.
* `cia_seguro` - Insurance company that issued the surety bond.
* `numero_apolice` - Policy number of the surety bond.
* `tipo` - Type of surety bond contracted.
* `situacao` - Status of the bond, such as Normal or Cancelado.
* `data_situacao` - Date the bond reached its current status.
* `data_inicial` - Date the coverage starts.
* `data_final` - Date the coverage ends.
* `primeira_parcela` - Month and year of the first instalment charged for the bond, as MM/YYYY.
* `ultima_parcela` - Month and year of the last instalment charged for the bond, as MM/YYYY.
* `valor` - Total amount of the surety bond.
* `premio_liquido` - Net premium of the policy, before charges and taxes.
* `encargos` - Charges and taxes added to the net premium.
* `valor_inquilino` - Share of the bond amount charged to the tenant.
* `valor_proprietario` - Share of the bond amount charged to the owner.
* `debito_seguro` - Who the bond instalment is debited from.
* `codigo_taxa` - Code of the charge type used to bill the bond, from 000 to 999.
* `sobre` - Base the bond amount is calculated on, such as the rent or the total charges.
* `observacao` - Free-text notes recorded about the bond.
Property owners, with their contact details, payout terms and tax settings.
**Endpoint:** `/proprietarios` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the owner record in cloudSLIM.
* `referencia` - Business reference of the owner in the format 00000.00, used to link the owner to their properties.
* `nome` - Full name or company name of the owner.
* `cpf_cnpj` - Brazilian taxpayer number of the owner: CPF for individuals, CNPJ for companies.
* `tipo` - Whether the owner is an individual or a company.
* `email` - Email address of the owner.
* `telefone` - Primary phone number of the owner.
* `telefone_secundario` - Secondary phone number of the owner.
* `telefone_whats_app` - WhatsApp number of the owner.
* `endereco` - Street name of the owner's mailing address.
* `numero` - Street number of the owner's mailing address.
* `complemento` - Address complement of the owner's mailing address.
* `cep` - Brazilian postal code (CEP) of the owner's mailing address.
* `bairro` - Neighbourhood of the owner's mailing address.
* `cidade` - City of the owner's mailing address.
* `estado` - Brazilian state (UF) of the owner's mailing address.
* `est_civil` - Marital status of the owner.
* `grupo` - Grouping the agency uses to classify the owner.
* `sub_grupo` - Sub-grouping the agency uses to classify the owner.
* `data_cadastro` - Date the owner was registered in cloudSLIM.
* `sexo` - Gender recorded for the owner.
* `data_nascimento` - Date of birth of the owner, for individuals.
* `data_baixa` - Date the owner was deactivated in cloudSLIM.
* `participacao` - Share of the property this owner holds, as a percentage, when a property has more than one owner.
* `dia_extrato` - Day of the month on which this owner's statement is issued.
* `calcular_irrf` - Whether Brazilian withholding income tax (IRRF) is calculated on this owner's rental income.
* `irrf_desconto_simplificado` - Whether the simplified IRRF deduction is applied to this owner.
The same owners, seen through the endpoint that carries nationality and occupation instead of the payout terms.
**Endpoint:** `/proprietarios/base` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the owner record in cloudSLIM.
* `referencia` - Business reference of the owner in the format 00000.00, used to link the owner to their properties.
* `nome` - Full name or company name of the owner.
* `cpf_cnpj` - Brazilian taxpayer number of the owner: CPF for individuals, CNPJ for companies.
* `tipo` - Whether the owner is an individual or a company.
* `email` - Email address of the owner.
* `telefone` - Primary phone number of the owner.
* `telefone_secundario` - Secondary phone number of the owner.
* `telefone_whats_app` - WhatsApp number of the owner.
* `endereco` - Street name of the owner's mailing address.
* `numero` - Street number of the owner's mailing address.
* `complemento` - Address complement of the owner's mailing address.
* `cep` - Brazilian postal code (CEP) of the owner's mailing address.
* `bairro` - Neighbourhood of the owner's mailing address.
* `cidade` - City of the owner's mailing address.
* `estado` - Brazilian state (UF) of the owner's mailing address.
* `est_civil` - Marital status of the owner.
* `grupo` - Grouping the agency uses to classify the owner.
* `sub_grupo` - Sub-grouping the agency uses to classify the owner.
* `data_cadastro` - Date the owner was registered in cloudSLIM.
* `nacionalidade` - Nationality of the owner.
* `profissao` - Occupation of the owner.
Surety bonds (seguro fianca) contracted to guarantee rental contracts.
**Endpoint:** `/fiancaSeguros` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the surety bond record in cloudSLIM.
* `referencia` - Reference of the tenant contract the bond guarantees, in the format 00000.000.00.
* `cia_seguro` - Insurance company that issued the surety bond.
* `numero_apolice` - Policy number of the surety bond.
* `tipo` - Type of surety bond contracted.
* `situacao` - Status of the bond, such as Normal or Cancelado.
* `data_situacao` - Date the bond reached its current status.
* `data_inicial` - Date the coverage starts.
* `data_final` - Date the coverage ends.
* `primeira_parcela` - Month and year of the first instalment charged for the bond, as MM/YYYY.
* `ultima_parcela` - Month and year of the last instalment charged for the bond, as MM/YYYY.
* `valor` - Total amount of the surety bond.
* `premio_liquido` - Net premium of the policy, before charges and taxes.
* `encargos` - Charges and taxes added to the net premium.
* `valor_inquilino` - Share of the bond amount charged to the tenant.
* `valor_proprietario` - Share of the bond amount charged to the owner.
* `debito_seguro` - Who the bond instalment is debited from.
* `codigo_taxa` - Code of the charge type used to bill the bond, from 000 to 999.
* `sobre` - Base the bond amount is calculated on, such as the rent or the total charges.
* `observacao` - Free-text notes recorded about the bond.
Municipal property tax records tied to the managed properties.
**Endpoint:** `/iptus` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the property tax record in cloudSLIM.
* `referencia` - Reference of the property the tax record belongs to, in the format 00000.000.
* `codigo_iptu` - Municipal fiscal registration code (indicação fiscal) the tax is assessed on.
* `codigo_imovel_prefeitura` - Identifier of the property in the municipality's own records.
* `codigo_contribuinte` - Taxpayer code registered with the municipality for this property.
* `regiao_id` - Internal identifier of the region the property belongs to.
* `data_cadastro` - Date the tax record was registered in cloudSLIM. This is the date the source's start date filters on.
* `data_ultima_alteracao` - Date the tax record was last changed in cloudSLIM.
* `data_baixa` - Date the fiscal registration was deactivated.
* `situacao` - Status of the property tax record.
* `situacao_locacao` - Rental status of the property the tax record belongs to.
* `natureza` - Nature of the property as classified by the municipality.
* `zoneamento` - Municipal zoning classification of the property.
* `area_terreno` - Land area assessed by the municipality, in square metres.
* `area_construida` - Built area assessed by the municipality, in square metres.
* `valor_venal_imovel` - Assessed (venal) value of the property used to calculate the tax.
* `aliquota` - Tax rate applied to the assessed value, as a percentage.
* `economia` - Number of economic units (economias) the municipality counts on the fiscal registration.
* `percentual` - Share of the fiscal registration's total tax that falls on this property, as a percentage, when one registration covers several units.
* `total_valor` - Total tax amount assessed for the fiscal registration.
* `valor_rateado` - Portion of the total tax apportioned to this property.
* `total_data_vencimento` - Due date of the tax when paid in a single instalment.
* `numero_parcela` - Number of instalments the tax is split into.
* `mes_primeira_parcela` - Month of the year the first instalment is due.
* `codigo_taxa` - Code of the charge type used to bill the tax to the contract.
* `gerar_pagamento` - Whether the agency pays the tax to the municipality on the owner's behalf.
* `proprietario_pgto_total` - Whether the owner paid the whole assessed amount.
* `inquilino_pgto_total` - Whether the tenant paid the whole assessed amount.
* `nao_creditar_proprietario` - Whether the amount must not be credited to the owner's statement.
* `isento` - Whether the property is exempt from the tax.
* `recibo` - Receipt number recorded for the tax payment.
* `observacao_do_iptu` - Free-text notes recorded about the property tax record.
* `parcelas` - Instalments of the tax as assessed by the municipality, as a JSON array of objects with their due dates and amounts.
* `iptu_parcelas` - Instalments as billed by the agency, as a JSON array of objects. These are what reaches the owner's or tenant's statement.
Brokerage deals closed by the agency, with the commission and how it is collected.
**Endpoint:** `/intermediacoes` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the brokerage deal in cloudSLIM.
* `referencia` - Reference of the property the deal refers to, in the format 00000.000.
* `endereco_imovel` - Address of the property the deal refers to.
* `data_cadastro` - Date the deal was registered in cloudSLIM. This is the date the source's start date filters on.
* `negociador` - Name of the broker who closed the deal.
* `comissao_negociador` - Commission owed to the broker for the deal.
* `valor_aluguel` - Rent agreed in the deal, which the brokerage fee is calculated from.
* `codigo_taxa` - Code of the charge type used to bill the brokerage fee.
* `parcelas` - Instalments the brokerage fee is collected in, as a JSON array of objects with their periods and amounts.
* `observacao` - Free-text notes recorded about the deal.
* `as_json` - The deal exactly as cloudSLIM serializes it internally, as a JSON string. Useful when the API adds attributes the other columns do not carry yet.
The agency's ledger: every charge and credit posted against a contract in a given month.
**Endpoint:** `/lancamentos` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the charge in cloudSLIM.
* `referencia` - Reference of the contract the charge belongs to, in the format 00000.000.00.
* `periodo` - Month the charge belongs to, as MM/YYYY.
* `dia_periodo` - Day within the period the charge is assigned to.
* `data_lancamento` - Date the charge was posted.
* `codigo_taxa` - Code of the charge type, from 000 to 999. It identifies what is being charged — rent, condominium fee, insurance instalment and so on.
* `historico` - Description of the charge, as it appears on the statement.
* `complemento` - Additional description printed with the charge.
* `participante` - Participant number, from 00 to 99, distinguishing co-owners or co-tenants sharing the same contract.
* `inquilino_dcn` - How the charge affects the tenant: D debits it, C credits it, N leaves the tenant untouched.
* `proprietario_dcn` - How the charge affects the owner: D debits it, C credits it, N leaves the owner untouched.
* `comissao_dcn` - How the charge affects the agency's commission: D debits it, C credits it, N leaves it untouched, A excludes the charge from the commission calculation.
* `valor_total` - Total amount of the charge.
* `valor_comissao` - Portion of the charge that is the agency's commission.
The templates behind repeated charges: what is billed every month, to whom, over which period.
**Endpoint:** `/TaxaFixas` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the recurring charge in cloudSLIM.
* `referencia` - Reference of the contract or property the recurring charge belongs to.
* `taxa` - Code of the charge type applied every month, from 000 to 999.
* `grupo` - Grouping used to classify the recurring charge.
* `historico` - Description posted with each occurrence of the charge.
* `valor` - Amount charged in each occurrence.
* `fator` - Factor the amount is calculated from, when the charge is not a fixed value — a percentage of the rent, for instance.
* `periodo_inicial` - First month the charge is posted, as MM/YYYY.
* `periodo_final` - Last month the charge is posted, as MM/YYYY.
* `ocorrencia` - Number of times the charge has been posted so far.
* `proporcional` - Whether the amount is prorated when the contract covers only part of the month.
* `participante` - Participant number, from 00 to 99, distinguishing co-owners or co-tenants sharing the same contract.
* `proprietario_id` - Internal identifier of the owner the charge is assigned to.
* `proprietario_dcn` - How the charge affects the owner: D debits it, C credits it, N leaves it untouched.
* `inquilino_dcn` - How the charge affects the tenant: D debits it, C credits it, N leaves it untouched.
* `comissao_dcn` - How the charge affects the agency's commission: D debits it, C credits it, N leaves it untouched.
* `usuario` - User who created or last changed the recurring charge.
Support tickets opened with the agency.
**Endpoint:** `/tickets` · **Primary key:** `id`
**Fields:**
* `id` - Ticket number, unique within the company.
* `assunto` - Subject of the ticket.
* `solicitacao` - Full text of what the requester asked for.
* `situacao` - Current status of the ticket, such as open, in progress or closed.
* `data_hora_cadastro` - Date and time the ticket was opened. This is the date the source's start date filters on.
* `referencia` - Reference of the record the ticket is about — a property, a tenant contract or an owner, depending on referencia\_tipo.
* `referencia_tipo` - Which kind of record the reference points at.
* `solicitante_nome` - Name of the person who opened the ticket.
* `solicitante_email` - Email address of the person who opened the ticket.
* `solicitante_telefone` - Phone number of the person who opened the ticket.
* `equipe` - Team or department the ticket was filed under.
* `equipe_responsavel` - Team currently responsible for resolving the ticket.
* `atribuido_para` - Agency user the ticket is currently assigned to.
* `responsavel` - Agency user accountable for the ticket.
* `privativa` - Whether the ticket is private and visible only to agency staff.
* `anexo` - Attachments of the ticket, as a JSON array of objects with the file name and identifier. The files themselves are not extracted.
Non-conformity records (RNCs) from the agency's quality process.
**Endpoint:** `/rncs` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the non-conformity record in cloudSLIM.
* `data_registro` - Date the non-conformity was raised. This is the date the source's start date filters on.
* `nao_conformidade` - Type of non-conformity that was raised.
* `descricao_ocorrencia` - Description of what happened.
* `setor_equipe_registrador` - Team that raised the non-conformity.
* `setor_equipe_causador` - Team identified as having caused the non-conformity.
* `setor_equipe_analise` - Team responsible for analysing the non-conformity.
* `data_analise` - Date the non-conformity was analysed.
* `descricao_analise` - Conclusions of the analysis.
* `data_disposicao` - Date the immediate disposition was decided.
* `descricao_disposicacao` - Immediate disposition applied to the occurrence. The field name carries the typo cloudSLIM uses in its own payload.
* `descricao_acao` - Corrective action defined to keep the occurrence from repeating.
* `usuario` - User who registered the non-conformity.
* `vistado_por` - User who reviewed the record.
* `analisado_por` - User who carried out the analysis.
Index of the documents filed in cloudSLIM's document manager. The files themselves are not extracted.
**Endpoint:** `/geds` · **Primary key:** `id`
**Fields:**
* `id` - Unique internal identifier of the document in cloudSLIM.
* `nome` - Name the document is filed under.
* `nome_original` - Original file name of the uploaded document.
* `descricao` - Description recorded for the document.
* `tipo` - Type of document, such as a contract, a receipt or an inspection report.
* `classificacao` - Classification assigned to the document in the document manager.
* `identificacao` - Reference of the record the document belongs to — a property, a tenant contract or an owner.
* `setor` - Department that filed the document.
* `usuario` - User who filed the document.
* `data` - Date the document was filed. This is the date the source's start date filters on.
* `hora` - Time of day the document was filed, as reported by cloudSLIM.
* `data_controle` - Control date recorded for the document, such as its expiry.
* `conteudo` - Text content indexed for the document, when the document manager extracted any.
* `fisico` - Whether a physical copy of the document is also archived.
* `validado` - Whether the document has been validated by an agency user.
* `validado_usuario` - User who validated the document.
* `validado_data_hora` - Date and time the document was validated.
* `path_ged` - Path of the document inside cloudSLIM's document store.