Locações

Listar locações

GET /locacoes

Retorna locações com filtros por participantes, prazos de reajuste e vencimentos de contrato.

Parâmetro	Tipo	Descrição
`codigo`	string	Filtra por código ou código interno
`status[]`	array de string	`Ativa`, `Rescindida`, `Finalizada`, `Prorrogada`, `Desocupação`, `Vencida`
`proprietarioId`	string	ID público do proprietário
`inquilinoId`	string	ID público do inquilino
`imovelId`	string	ID público do imóvel
`temReajuste`	boolean	Locações com reajuste previsto
`reajusteAutomatico`	boolean	Locações com reajuste automático
`dataInicioContrato[min]` / `[max]`	date	Intervalo de início do contrato (`Y-m-d`)
`dataDeCadastro[min]` / `[max]`	date	Intervalo de cadastro (`Y-m-d`)

curl "https://api-aberta-prod.useimobia.com.br/api/v1/locacoes?status[]=Ativa&temReajuste=true" \
  -H "API-KEY: SUA_CHAVE_AQUI"

Detalhes da locação

GET /locacoes/{id}

Exemplo de resposta (campos principais):

{
  "data": {
    "id": "5ZD7L...",
    "codigo": 8,
    "tipo": "Residencial",
    "imovelId": "0Jw79P...",
    "status": "Ativa",
    "dataDeCadastro": "2022-05-13",
    "dataInicioContrato": "2022-05-13",
    "dataFinalPrevista": "2023-11-11",
    "dataProximoReajuste": "2023-05-13",
    "primeiroVencimento": "2022-05-13",
    "duracao": 12,
    "periodoReajuste": 12,
    "periodoRepasse": 5,
    "temReajuste": false,
    "reajusteAutomatico": false,
    "valorVigente": "150.00",
    "valorTaxaAdministracao": "1.50",
    "tipoTaxaAdministracao": "porcento",
    "porcentagemTaxaAdministracao": "1.00",
    "proprietarios": [ { "pessoaId": "0Jw79P1..." } ],
    "inquilinos": [ { "pessoaId": "0Jw79P1..." } ],
    "fiadores": [ { "pessoaId": "0Jw79P1..." } ]
  }
}

Campos que merecem atenção

Campo	Descrição
`status`	Status calculado: `Ativa`, `Rescindida`, `Finalizada` ou `Vencida`
`duracao`	Duração do contrato em meses
`periodoReajuste`	Intervalo entre reajustes, em meses
`valorVigente`	Valor atual do aluguel
`tipoTaxaAdministracao`	Como a taxa é calculada (ex.: `porcento`)
`proprietarios` / `inquilinos` / `fiadores`	Cada `pessoaId` resolve em `GET /pessoas/{id}`

💡
Dica: as parcelas financeiras do contrato ficam em Contas — o par origemId/origemType: "Locacao" liga cada conta à locação de origem.