Navegar na documentação

Locação

Os contratos de aluguel, os meses com a situação de cada cobrança, os repasses a fazer e os chamados de manutenção. Nada aqui move dinheiro: dar baixa, repassar e fazer o acerto são gestos da equipe, na tela.

As rotas

GET/v1/rent/contracts

Listar contratos de aluguel

Os contratos numa situação (padrão ACTIVE), do início mais recente ao mais antigo, com inquilinos, proprietários (sem a conta de repasse) e as taxas.

Permissão: rent:read

Filtros e paginação

statusstring
ACTIVE (padrão), ENDED ou CANCELLED.um de ACTIVE ENDED CANCELLED
limitinteger
Itens por página: de 1 a 100 (padrão 50).
cursorstring
O nextCursor da página anterior. A lista acabou quando ele vem nulo. Ele vale só para esta rota e esta conta.

Resposta200OK

datalista de RentContractobrigatório
Os contratos.
nextCursorstringobrigatóriopode vir nulo
Cursor da próxima página (nulo = acabou).

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/rent/contracts' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

E os erros comuns a toda rota

GET/v1/rent/contracts/{contractId}

Um contrato de aluguel

O contrato, pelo id.

Permissão: rent:read

Parâmetros no caminho

contractIdstringobrigatório
Id do contrato de aluguel.

Resposta200OK

dataRentContractobrigatório
O contrato.

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/rent/contracts/contractId' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

E os erros comuns a toda rota

GET/v1/rent/contracts/{contractId}/months

Meses do contrato

Os meses do contrato, do mais novo ao mais antigo: o que foi cobrado do inquilino, se pagou e o repasse somado.

Permissão: rent:read

Parâmetros no caminho

contractIdstringobrigatório
Id do contrato de aluguel.

Resposta200OK

datalista de RentMonthobrigatório
Os meses.
nextCursorstringobrigatóriopode vir nulo
Cursor da próxima página (nulo = acabou).

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/rent/contracts/contractId/months' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

E os erros comuns a toda rota

GET/v1/rent/contracts/{contractId}/tickets

Chamados do contrato

Todos os chamados de manutenção do contrato, do mais novo para o mais antigo.

Permissão: rent:read

Parâmetros no caminho

contractIdstringobrigatório
Id do contrato de aluguel.

Resposta200OK

datalista de RentTicketobrigatório
Os chamados.
nextCursorstringobrigatóriopode vir nulo
Cursor da próxima página (nulo = acabou).

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/rent/contracts/contractId/tickets' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

E os erros comuns a toda rota

GET/v1/rent/tickets

Chamados em aberto

Os chamados em aberto de todos os contratos, o mais parado primeiro, com o imóvel e o inquilino.

Permissão: rent:read

Resposta200OK

datalista de RentTicketobrigatório
Os chamados.
nextCursorstringobrigatóriopode vir nulo
Cursor da próxima página (nulo = acabou).

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/rent/tickets' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

    E os erros comuns a toda rota

    GET/v1/rent/payouts

    Repasses a fazer

    Os repasses pendentes, um por proprietário, pelo dia do repasse. Sem a chave PIX nem a conta bancária. Marcar como repassado é na tela.

    Permissão: rent:read

    Resposta200OK

    datalista de RentPayoutobrigatório
    Os repasses.
    nextCursorstringobrigatóriopode vir nulo
    Cursor da próxima página (nulo = acabou).

    Exemplo

    curl -X GET 'https://api.imobyflow.com.br/v1/rent/payouts' \
      -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
      -H 'Accept-Language: pt-BR'

    Erros desta rota

      E os erros comuns a toda rota

      POST/v1/rent/contracts/{contractId}/tickets

      Abrir um chamado

      Abre um chamado de manutenção no contrato: o que aconteceu e quem paga (padrão: o proprietário). Fotos só pela tela. Exige a Locação ligada.

      Permissão: rent:writeAceita modo ensaioAceita Idempotency-Key

      Parâmetros no caminho

      contractIdstringobrigatório
      Id do contrato de aluguel.

      Filtros e paginação

      dryRunboolean
      true = modo ensaio: valida e diz o que aconteceria, sem gravar nada.

      Corpo do pedido

      titlestring
      O que aconteceu (obrigatório ao abrir).
      descriptionstringpode vir nulo
      Detalhes. No PATCH, null limpa.
      payerstring
      Quem paga (padrão ao abrir: OWNER).um de OWNER RENTER NONE
      quoteAmountnumberpode vir nulo
      O orçamento. No PATCH, null limpa.
      supplierstringpode vir nulo
      O prestador. No PATCH, null limpa.

      Exemplo de corpo

      {
        "title": "Vazamento na pia da cozinha",
        "description": "O inquilino avisou que pinga embaixo da pia.",
        "payer": "OWNER"
      }

      Resposta201Criado

      dataRentTicketobrigatório
      O objeto como ficou.
      resultCrmWriteResultobrigatório
      O desfecho.

      Exemplo

      # Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
      curl -X POST 'https://api.imobyflow.com.br/v1/rent/contracts/contractId/tickets?dryRun=true' \
        -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
        -H 'Accept-Language: pt-BR' \
        -H "Idempotency-Key: $(uuidgen)" \
        -H 'Content-Type: application/json' \
        --data @- <<'JSON'
      {
        "title": "Vazamento na pia da cozinha",
        "description": "O inquilino avisou que pinga embaixo da pia.",
        "payer": "OWNER"
      }
      JSON

      Erros desta rota

      E os erros comuns a toda rota

      PATCH/v1/rent/contracts/{contractId}/tickets/{ticketId}

      Corrigir o chamado

      Corrige um chamado em aberto: texto, quem paga, o orçamento e o prestador. Mudar o orçamento em Orçamento com o proprietário pagando pede a aprovação dele de novo.

      Permissão: rent:writeAceita modo ensaioAceita Idempotency-Key

      Parâmetros no caminho

      contractIdstringobrigatório
      Id do contrato de aluguel.
      ticketIdstringobrigatório
      Id do chamado (tkt-…).

      Filtros e paginação

      dryRunboolean
      true = modo ensaio: valida e diz o que aconteceria, sem gravar nada.

      Corpo do pedido

      titlestring
      O que aconteceu (obrigatório ao abrir).
      descriptionstringpode vir nulo
      Detalhes. No PATCH, null limpa.
      payerstring
      Quem paga (padrão ao abrir: OWNER).um de OWNER RENTER NONE
      quoteAmountnumberpode vir nulo
      O orçamento. No PATCH, null limpa.
      supplierstringpode vir nulo
      O prestador. No PATCH, null limpa.

      Exemplo de corpo

      {
        "quoteAmount": 350,
        "supplier": "Hidráulica Exemplo"
      }

      Resposta200OK

      dataRentTicketobrigatório
      O objeto como ficou.
      resultCrmWriteResultobrigatório
      O desfecho.

      Exemplo

      # Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
      curl -X PATCH 'https://api.imobyflow.com.br/v1/rent/contracts/contractId/tickets/ticketId?dryRun=true' \
        -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
        -H 'Accept-Language: pt-BR' \
        -H "Idempotency-Key: $(uuidgen)" \
        -H 'Content-Type: application/json' \
        --data @- <<'JSON'
      {
        "quoteAmount": 350,
        "supplier": "Hidráulica Exemplo"
      }
      JSON

      Erros desta rota

      E os erros comuns a toda rota

      POST/v1/rent/contracts/{contractId}/tickets/{ticketId}/stage

      Mover o chamado

      Move entre as etapas em aberto (OPEN, QUOTE, IN_PROGRESS), inclusive para trás. Entrar em Orçamento com o proprietário pagando e o valor dado pede a aprovação dele, pelo link dele. Concluir é na tela: o valor final vira lançamento na cobrança ou no repasse.

      Permissão: rent:writeAceita modo ensaioAceita Idempotency-Key

      Parâmetros no caminho

      contractIdstringobrigatório
      Id do contrato de aluguel.
      ticketIdstringobrigatório
      Id do chamado (tkt-…).

      Filtros e paginação

      dryRunboolean
      true = modo ensaio: valida e diz o que aconteceria, sem gravar nada.

      Corpo do pedido

      stagestringobrigatório
      A etapa.um de OPEN QUOTE IN_PROGRESS
      notestring
      Anotação no histórico.

      Exemplo de corpo

      {
        "stage": "IN_PROGRESS",
        "note": "O proprietário aprovou."
      }

      Resposta200OK

      dataRentTicketobrigatório
      O objeto como ficou.
      resultCrmWriteResultobrigatório
      O desfecho.

      Exemplo

      # Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
      curl -X POST 'https://api.imobyflow.com.br/v1/rent/contracts/contractId/tickets/ticketId/stage?dryRun=true' \
        -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
        -H 'Accept-Language: pt-BR' \
        -H "Idempotency-Key: $(uuidgen)" \
        -H 'Content-Type: application/json' \
        --data @- <<'JSON'
      {
        "stage": "IN_PROGRESS",
        "note": "O proprietário aprovou."
      }
      JSON

      Erros desta rota

      E os erros comuns a toda rota

      POST/v1/rent/contracts/{contractId}/tickets/{ticketId}/cancel

      Cancelar o chamado

      Cancela um chamado em aberto (aberto por engano, resolvido sem custo), com o motivo no histórico.

      Permissão: rent:writeAceita modo ensaioAceita Idempotency-Key

      Parâmetros no caminho

      contractIdstringobrigatório
      Id do contrato de aluguel.
      ticketIdstringobrigatório
      Id do chamado (tkt-…).

      Filtros e paginação

      dryRunboolean
      true = modo ensaio: valida e diz o que aconteceria, sem gravar nada.

      Corpo do pedido

      reasonstringobrigatório
      O motivo.

      Exemplo de corpo

      {
        "reason": "O inquilino resolveu sozinho."
      }

      Resposta200OK

      dataRentTicketobrigatório
      O objeto como ficou.
      resultCrmWriteResultobrigatório
      O desfecho.

      Exemplo

      # Modo ensaio: nada é gravado. Tire o ?dryRun=true para gravar de verdade.
      curl -X POST 'https://api.imobyflow.com.br/v1/rent/contracts/contractId/tickets/ticketId/cancel?dryRun=true' \
        -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
        -H 'Accept-Language: pt-BR' \
        -H "Idempotency-Key: $(uuidgen)" \
        -H 'Content-Type: application/json' \
        --data @- <<'JSON'
      {
        "reason": "O inquilino resolveu sozinho."
      }
      JSON

      Erros desta rota

      E os erros comuns a toda rota

      Os objetos

      RentProperty

      O imóvel do contrato, com o endereço completo.

      titlestringobrigatóriopode vir nulo
      Título.
      typestringobrigatóriopode vir nulo
      Subtipo.
      streetstringobrigatóriopode vir nulo
      Rua.
      numberstringobrigatóriopode vir nulo
      Número.
      complementstringobrigatóriopode vir nulo
      Complemento.
      neighborhoodstringobrigatóriopode vir nulo
      Bairro.
      citystringobrigatóriopode vir nulo
      Cidade.
      ufstringobrigatóriopode vir nulo
      Estado.
      zipstringobrigatóriopode vir nulo
      CEP.

      RentRenter

      Um inquilino. Dado pessoal.

      leadIdstringobrigatóriopode vir nulo
      O cliente do CRM, quando o inquilino é um.
      namestringobrigatóriopode vir nulo
      Nome.
      documentstringobrigatóriopode vir nulo
      CPF ou CNPJ.
      emailstringobrigatóriopode vir nulo
      E-mail.
      phonestringobrigatóriopode vir nulo
      Telefone.

      RentOwner

      Um proprietário do contrato. Sem a chave PIX nem a conta bancária.

      namestringobrigatóriopode vir nulo
      Nome.
      documentstringobrigatóriopode vir nulo
      CPF ou CNPJ.
      emailstringobrigatóriopode vir nulo
      E-mail.
      phonestringobrigatóriopode vir nulo
      Telefone.
      sharePercentnumberobrigatóriopode vir nulo
      A parte dele no repasse, em %.

      RentGuarantee

      A garantia. Os fiadores ficam na tela.

      typestringobrigatóriopode vir nulo
      O tipo de garantia.
      depositAmountnumberobrigatóriopode vir nulo
      O valor da caução.
      providerstringobrigatóriopode vir nulo
      A seguradora ou a empresa da garantia.
      policyNumberstringobrigatóriopode vir nulo
      O número da apólice.
      validFromstringobrigatóriopode vir nulo
      Vale desde (dia).
      validUntilstringobrigatóriopode vir nulo
      Vale até (dia).

      RentContract

      Um contrato de aluguel.

      idstringobrigatório
      Id do contrato.
      numberstringobrigatóriopode vir nulo
      O número do contrato na imobiliária.
      propertyIdstringobrigatóriopode vir nulo
      O imóvel.
      propertyRentPropertyobrigatório
      O imóvel.
      statusstringobrigatório
      ACTIVE, ENDED ou CANCELLED (desfeito).um de ACTIVE ENDED CANCELLED
      billingModestringobrigatóriopode vir nulo
      Como o aluguel é cobrado: pela ImobyFlow ou só gestão.
      renterslista de RentRenterobrigatório
      Os inquilinos.
      ownerslista de RentOwnerobrigatório
      Os proprietários.
      guaranteeRentGuaranteeobrigatóriopode vir nulo
      A garantia.
      rentnumberobrigatóriopode vir nulo
      O aluguel de agora.
      dueDayintegerobrigatóriopode vir nulo
      O dia do vencimento.
      startOnstringobrigatóriopode vir nulo
      Início (dia).
      monthsintegerobrigatóriopode vir nulo
      Prazo em meses.
      endOnstringobrigatóriopode vir nulo
      Fim previsto (dia).
      readjustIndexstringobrigatóriopode vir nulo
      O índice de reajuste.
      readjustMonthintegerobrigatóriopode vir nulo
      O mês do reajuste (1–12).
      adminFeePercentnumberobrigatóriopode vir nulo
      A taxa de administração, em %.
      intermediationPercentnumberobrigatóriopode vir nulo
      A taxa de intermediação, em %.
      latePenaltyPercentnumberobrigatóriopode vir nulo
      A multa por atraso, em %.
      interestPercentMonthnumberobrigatóriopode vir nulo
      Os juros por mês de atraso, em %.
      punctualityDiscountnumberobrigatóriopode vir nulo
      O desconto por pontualidade.
      payoutDayintegerobrigatóriopode vir nulo
      O dia do repasse.
      guaranteedRentbooleanobrigatório
      Aluguel garantido ao proprietário.
      responsibleIdstringobrigatóriopode vir nulo
      O responsável pelo contrato na equipe.
      responsibleNamestringobrigatóriopode vir nulo
      O nome dele.
      moveOutOnstringobrigatóriopode vir nulo
      A saída avisada (dia).
      endedOnstringobrigatóriopode vir nulo
      Encerrado em (dia).
      endReasonstringobrigatóriopode vir nulo
      Por que encerrou.
      createdAtstringobrigatóriopode vir nulo
      Quando foi criado (UTC).
      updatedAtstringobrigatóriopode vir nulo
      Última alteração (UTC).

      RentEntry

      Um lançamento na cobrança do inquilino.

      kindstringobrigatóriopode vir nulo
      O tipo do lançamento.
      amountnumberobrigatóriopode vir nulo
      O valor (negativo = desconto).
      notestringobrigatóriopode vir nulo
      Anotação.
      installmentNointegerobrigatóriopode vir nulo
      A parcela.
      installmentsintegerobrigatóriopode vir nulo
      De quantas.

      RentPayoutBrief

      O repasse do mês, somado.

      statusstringobrigatóriopode vir nulo
      A situação do repasse.
      dueOnstringobrigatóriopode vir nulo
      O dia do repasse.
      netnumberobrigatóriopode vir nulo
      O líquido a repassar.

      RentMonth

      Um mês do contrato: a cobrança do inquilino e o repasse.

      contractIdstringobrigatório
      O contrato.
      competencestringobrigatório
      O mês (2026-11).
      dueOnstringobrigatóriopode vir nulo
      O vencimento (dia).
      rentnumberobrigatóriopode vir nulo
      O aluguel do mês.
      renterEntrieslista de RentEntryobrigatório
      Os lançamentos na cobrança.
      totalnumberobrigatóriopode vir nulo
      O total cobrado.
      chargeStatusstringobrigatório
      OPEN, PAID ou CANCELLED.
      paidOnstringobrigatóriopode vir nulo
      Pago em (dia).
      paidAmountnumberobrigatóriopode vir nulo
      O valor recebido.
      payoutRentPayoutBriefobrigatóriopode vir nulo
      O repasse.
      agreementIdstringobrigatóriopode vir nulo
      O acordo de dívida que cobre o mês.

      RentTicketStep

      Um passo no histórico do chamado.

      stagestringobrigatóriopode vir nulo
      A etapa.um de OPEN QUOTE IN_PROGRESS DONE CANCELLED
      atstringobrigatóriopode vir nulo
      Quando.
      notestringobrigatóriopode vir nulo
      Anotação.

      RentTicket

      Um chamado de manutenção.

      idstringobrigatóriopode vir nulo
      Id do chamado (tkt-…). Nulo no ensaio de uma abertura.
      contractIdstringobrigatório
      O contrato.
      titlestringobrigatóriopode vir nulo
      O que aconteceu.
      descriptionstringobrigatóriopode vir nulo
      Detalhes.
      stagestringobrigatório
      A etapa.um de OPEN QUOTE IN_PROGRESS DONE CANCELLED
      payerstringobrigatóriopode vir nulo
      Quem paga: OWNER, RENTER ou NONE.um de OWNER RENTER NONE
      quoteAmountnumberobrigatóriopode vir nulo
      O orçamento.
      supplierstringobrigatóriopode vir nulo
      O prestador.
      finalAmountnumberobrigatóriopode vir nulo
      O valor final (concluído).
      installmentsintegerobrigatóriopode vir nulo
      Em quantas parcelas o valor final foi lançado.
      ownerApprovalstringobrigatóriopode vir nulo
      A aprovação do orçamento pelo proprietário: PENDING, APPROVED ou REJECTED.
      originstringobrigatóriopode vir nulo
      Quem abriu (a equipe ou o inquilino, pelo link dele).
      propertyTitlestringobrigatóriopode vir nulo
      O imóvel (na lista dos abertos).
      renterNamestringobrigatóriopode vir nulo
      O inquilino (na lista dos abertos).
      stalebooleanobrigatório
      Parado há mais de 7 dias.
      historylista de RentTicketStepobrigatório
      O histórico.
      createdAtstringobrigatóriopode vir nulo
      Quando foi criado (UTC).
      lastMoveAtstringobrigatóriopode vir nulo
      Última mudança de etapa.
      doneAtstringobrigatóriopode vir nulo
      Quando foi concluído.

      RentPayout

      Um repasse a fazer. Sem a chave PIX nem a conta bancária.

      contractIdstringobrigatório
      O contrato.
      propertyTitlestringobrigatóriopode vir nulo
      O imóvel.
      renterNamestringobrigatóriopode vir nulo
      O inquilino.
      competencestringobrigatório
      O mês (2026-11).
      dueOnstringobrigatóriopode vir nulo
      O dia do repasse.
      ownerIndexintegerobrigatóriopode vir nulo
      Qual proprietário do contrato (0 = o primeiro).
      ownerNamestringobrigatóriopode vir nulo
      O proprietário.
      amountnumberobrigatóriopode vir nulo
      O valor a repassar.
      isPartnerbooleanobrigatório
      É a parte da imobiliária parceira.
      transferStatusstringobrigatóriopode vir nulo
      A situação da transferência pelo Asaas, quando pedida.

      RentTicketInput

      Os campos do chamado. Ao corrigir, só o que vier muda; null limpa a descrição, o orçamento e o prestador.

      titlestring
      O que aconteceu (obrigatório ao abrir).
      descriptionstringpode vir nulo
      Detalhes. No PATCH, null limpa.
      payerstring
      Quem paga (padrão ao abrir: OWNER).um de OWNER RENTER NONE
      quoteAmountnumberpode vir nulo
      O orçamento. No PATCH, null limpa.
      supplierstringpode vir nulo
      O prestador. No PATCH, null limpa.