Rentals
Rental contracts, the months with each charge status, pending owner payouts and maintenance tickets. Nothing here moves money: marking as paid, paying out and settling are team gestures, in the dashboard.
- GET/v1/rent/contracts— List rental contracts
- GET/v1/rent/contracts/{contractId}— A rental contract
- GET/v1/rent/contracts/{contractId}/months— The contract's months
- GET/v1/rent/contracts/{contractId}/tickets— The contract's tickets
- GET/v1/rent/tickets— Open tickets
- GET/v1/rent/payouts— Pending payouts
- POST/v1/rent/contracts/{contractId}/tickets— Open a ticket
- PATCH/v1/rent/contracts/{contractId}/tickets/{ticketId}— Update the ticket
- POST/v1/rent/contracts/{contractId}/tickets/{ticketId}/stage— Move the ticket
- POST/v1/rent/contracts/{contractId}/tickets/{ticketId}/cancel— Cancel the ticket
Routes
/v1/rent/contractsList rental contracts
Contracts in one status (default ACTIVE), most recent start first, with renters, owners (without payout accounts) and fees.
rent:readQuery parameters
statusstringACTIVE(default),ENDEDorCANCELLED.one ofACTIVEENDEDCANCELLEDlimitinteger- Items per page: 1 to 100 (default 50).
cursorstring- The
nextCursorfrom the previous page. The list is over when it comes back null. It is only valid for this route and this account.
Response200OK
datalist of RentContractrequired- The contracts.
nextCursorstringrequirednullable- Next page cursor (null = done).
Example
curl -X GET 'https://api.imobyflow.com.br/v1/rent/contracts' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en'Errors for this route
/v1/rent/contracts/{contractId}A rental contract
The contract, by id.
rent:readPath parameters
contractIdstringrequired- Rental contract id.
Response200OK
dataRentContractrequired- The contract.
Example
curl -X GET 'https://api.imobyflow.com.br/v1/rent/contracts/contractId' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en'Errors for this route
/v1/rent/contracts/{contractId}/monthsThe contract's months
The contract's months, newest first: what the renter was charged, whether they paid and the totaled payout.
rent:readPath parameters
contractIdstringrequired- Rental contract id.
Response200OK
datalist of RentMonthrequired- The months.
nextCursorstringrequirednullable- Next page cursor (null = done).
Example
curl -X GET 'https://api.imobyflow.com.br/v1/rent/contracts/contractId/months' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en'Errors for this route
/v1/rent/contracts/{contractId}/ticketsThe contract's tickets
All of the contract's maintenance tickets, newest first.
rent:readPath parameters
contractIdstringrequired- Rental contract id.
Response200OK
datalist of RentTicketrequired- The tickets.
nextCursorstringrequirednullable- Next page cursor (null = done).
Example
curl -X GET 'https://api.imobyflow.com.br/v1/rent/contracts/contractId/tickets' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en'Errors for this route
/v1/rent/ticketsOpen tickets
Open tickets across all contracts, the most idle first, with the property and the renter.
rent:readResponse200OK
datalist of RentTicketrequired- The tickets.
nextCursorstringrequirednullable- Next page cursor (null = done).
Example
curl -X GET 'https://api.imobyflow.com.br/v1/rent/tickets' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en'Errors for this route
/v1/rent/payoutsPending payouts
Pending payouts, one per owner, by payout day. Without the PIX key or bank account. Marking as paid out happens in the dashboard.
rent:readResponse200OK
datalist of RentPayoutrequired- The payouts.
nextCursorstringrequirednullable- Next page cursor (null = done).
Example
curl -X GET 'https://api.imobyflow.com.br/v1/rent/payouts' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en'Errors for this route
/v1/rent/contracts/{contractId}/ticketsOpen a ticket
Opens a maintenance ticket on the contract: what happened and who pays (default: the owner). Photos only in the dashboard. Requires the Rentals module on.
rent:writeSupports dry runSupports Idempotency-KeyPath parameters
contractIdstringrequired- Rental contract id.
Query parameters
dryRunbooleantrue= dry run: validates and says what would happen, without writing anything.
Request body
titlestring- What happened (required when opening).
descriptionstringnullable- Details. On PATCH,
nullclears it. payerstring- Who pays (default when opening:
OWNER).one ofOWNERRENTERNONE quoteAmountnumbernullable- The quote. On PATCH,
nullclears it. supplierstringnullable- The supplier. On PATCH,
nullclears it.
Example body
{
"title": "Vazamento na pia da cozinha",
"description": "O inquilino avisou que pinga embaixo da pia.",
"payer": "OWNER"
}Response201Created
dataRentTicketrequired- The object as it now stands.
resultCrmWriteResultrequired- The outcome.
Example
# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X POST 'https://api.imobyflow.com.br/v1/rent/contracts/contractId/tickets?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en' \
-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"
}
JSONErrors for this route
/v1/rent/contracts/{contractId}/tickets/{ticketId}Update the ticket
Updates an open ticket: text, who pays, the quote and the supplier. Changing the quote at the Quote stage with the owner paying asks for their approval again.
rent:writeSupports dry runSupports Idempotency-KeyPath parameters
contractIdstringrequired- Rental contract id.
ticketIdstringrequired- Ticket id (
tkt-…).
Query parameters
dryRunbooleantrue= dry run: validates and says what would happen, without writing anything.
Request body
titlestring- What happened (required when opening).
descriptionstringnullable- Details. On PATCH,
nullclears it. payerstring- Who pays (default when opening:
OWNER).one ofOWNERRENTERNONE quoteAmountnumbernullable- The quote. On PATCH,
nullclears it. supplierstringnullable- The supplier. On PATCH,
nullclears it.
Example body
{
"quoteAmount": 350,
"supplier": "Hidráulica Exemplo"
}Response200OK
dataRentTicketrequired- The object as it now stands.
resultCrmWriteResultrequired- The outcome.
Example
# Dry run: nothing is written. Remove ?dryRun=true to write for real.
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: en' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"quoteAmount": 350,
"supplier": "Hidráulica Exemplo"
}
JSONErrors for this route
/v1/rent/contracts/{contractId}/tickets/{ticketId}/stageMove the ticket
Moves between the open stages (OPEN, QUOTE, IN_PROGRESS), backwards too. Entering Quote with the owner paying and an amount set asks for their approval, through their link. Completing happens in the dashboard: the final amount becomes an entry on the charge or the payout.
rent:writeSupports dry runSupports Idempotency-KeyPath parameters
contractIdstringrequired- Rental contract id.
ticketIdstringrequired- Ticket id (
tkt-…).
Query parameters
dryRunbooleantrue= dry run: validates and says what would happen, without writing anything.
Request body
stagestringrequired- The stage.one of
OPENQUOTEIN_PROGRESS notestring- Note in the history.
Example body
{
"stage": "IN_PROGRESS",
"note": "O proprietário aprovou."
}Response200OK
dataRentTicketrequired- The object as it now stands.
resultCrmWriteResultrequired- The outcome.
Example
# Dry run: nothing is written. Remove ?dryRun=true to write for real.
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: en' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"stage": "IN_PROGRESS",
"note": "O proprietário aprovou."
}
JSONErrors for this route
/v1/rent/contracts/{contractId}/tickets/{ticketId}/cancelCancel the ticket
Cancels an open ticket (opened by mistake, solved at no cost), with the reason in the history.
rent:writeSupports dry runSupports Idempotency-KeyPath parameters
contractIdstringrequired- Rental contract id.
ticketIdstringrequired- Ticket id (
tkt-…).
Query parameters
dryRunbooleantrue= dry run: validates and says what would happen, without writing anything.
Request body
reasonstringrequired- The reason.
Example body
{
"reason": "O inquilino resolveu sozinho."
}Response200OK
dataRentTicketrequired- The object as it now stands.
resultCrmWriteResultrequired- The outcome.
Example
# Dry run: nothing is written. Remove ?dryRun=true to write for real.
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: en' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"reason": "O inquilino resolveu sozinho."
}
JSONErrors for this route
Objects
RentProperty
The contract's property, with the full address.
titlestringrequirednullable- Title.
typestringrequirednullable- Subtype.
streetstringrequirednullable- Street.
numberstringrequirednullable- Number.
complementstringrequirednullable- Complement.
neighborhoodstringrequirednullable- Neighborhood.
citystringrequirednullable- City.
ufstringrequirednullable- State.
zipstringrequirednullable- ZIP code.
RentRenter
A renter. Personal data.
leadIdstringrequirednullable- The CRM client, when the renter is one.
namestringrequirednullable- Name.
documentstringrequirednullable- CPF or CNPJ.
emailstringrequirednullable- E-mail.
phonestringrequirednullable- Phone.
RentOwner
A contract owner. Without the PIX key or bank account.
namestringrequirednullable- Name.
documentstringrequirednullable- CPF or CNPJ.
emailstringrequirednullable- E-mail.
phonestringrequirednullable- Phone.
sharePercentnumberrequirednullable- Their payout share, in %.
RentGuarantee
The guarantee. Guarantors stay in the dashboard.
typestringrequirednullable- The guarantee type.
depositAmountnumberrequirednullable- The deposit amount.
providerstringrequirednullable- The insurer or guarantee company.
policyNumberstringrequirednullable- The policy number.
validFromstringrequirednullable- Valid from (day).
validUntilstringrequirednullable- Valid until (day).
RentContract
A rental contract.
idstringrequired- Contract id.
numberstringrequirednullable- The agency's contract number.
propertyIdstringrequirednullable- The property.
propertyRentPropertyrequired- The property.
statusstringrequiredACTIVE,ENDEDorCANCELLED(undone).one ofACTIVEENDEDCANCELLEDbillingModestringrequirednullable- How the rent is billed: through ImobyFlow or management only.
renterslist of RentRenterrequired- The renters.
ownerslist of RentOwnerrequired- The owners.
guaranteeRentGuaranteerequirednullable- The guarantee.
rentnumberrequirednullable- The current rent.
dueDayintegerrequirednullable- The due day.
startOnstringrequirednullable- Start (day).
monthsintegerrequirednullable- Term in months.
endOnstringrequirednullable- Planned end (day).
readjustIndexstringrequirednullable- The readjustment index.
readjustMonthintegerrequirednullable- The readjustment month (1–12).
adminFeePercentnumberrequirednullable- The management fee, in %.
intermediationPercentnumberrequirednullable- The intermediation fee, in %.
latePenaltyPercentnumberrequirednullable- The late penalty, in %.
interestPercentMonthnumberrequirednullable- Interest per month late, in %.
punctualityDiscountnumberrequirednullable- The on-time discount.
payoutDayintegerrequirednullable- The payout day.
guaranteedRentbooleanrequired- Rent guaranteed to the owner.
responsibleIdstringrequirednullable- The team member responsible for the contract.
responsibleNamestringrequirednullable- Their name.
moveOutOnstringrequirednullable- The announced move-out (day).
endedOnstringrequirednullable- Ended on (day).
endReasonstringrequirednullable- Why it ended.
createdAtstringrequirednullable- When it was created (UTC).
updatedAtstringrequirednullable- Last change (UTC).
RentEntry
An entry on the renter's charge.
kindstringrequirednullable- The entry type.
amountnumberrequirednullable- The amount (negative = discount).
notestringrequirednullable- Note.
installmentNointegerrequirednullable- The installment.
installmentsintegerrequirednullable- Out of how many.
RentPayoutBrief
The month's payout, totaled.
statusstringrequirednullable- The payout status.
dueOnstringrequirednullable- The payout day.
netnumberrequirednullable- The net to pay out.
RentMonth
A contract month: the renter's charge and the payout.
contractIdstringrequired- The contract.
competencestringrequired- The month (
2026-11). dueOnstringrequirednullable- The due date (day).
rentnumberrequirednullable- The month's rent.
renterEntrieslist of RentEntryrequired- The entries on the charge.
totalnumberrequirednullable- The total charged.
chargeStatusstringrequiredOPEN,PAIDorCANCELLED.paidOnstringrequirednullable- Paid on (day).
paidAmountnumberrequirednullable- The amount received.
payoutRentPayoutBriefrequirednullable- The payout.
agreementIdstringrequirednullable- The debt agreement covering the month.
RentTicketStep
A step in the ticket's history.
stagestringrequirednullable- The stage.one of
OPENQUOTEIN_PROGRESSDONECANCELLED atstringrequirednullable- When.
notestringrequirednullable- Note.
RentTicket
A maintenance ticket.
idstringrequirednullable- Ticket id (
tkt-…). Null in the dry run of a new ticket. contractIdstringrequired- The contract.
titlestringrequirednullable- What happened.
descriptionstringrequirednullable- Details.
stagestringrequired- The stage.one of
OPENQUOTEIN_PROGRESSDONECANCELLED payerstringrequirednullable- Who pays:
OWNER,RENTERorNONE.one ofOWNERRENTERNONE quoteAmountnumberrequirednullable- The quote.
supplierstringrequirednullable- The supplier.
finalAmountnumberrequirednullable- The final amount (done).
installmentsintegerrequirednullable- In how many installments the final amount was posted.
ownerApprovalstringrequirednullable- The owner's approval of the quote:
PENDING,APPROVEDorREJECTED. originstringrequirednullable- Who opened it (the team or the renter, through their link).
propertyTitlestringrequirednullable- The property (in the open list).
renterNamestringrequirednullable- The renter (in the open list).
stalebooleanrequired- Idle for more than 7 days.
historylist of RentTicketSteprequired- The history.
createdAtstringrequirednullable- When it was created (UTC).
lastMoveAtstringrequirednullable- Last stage change.
doneAtstringrequirednullable- When it was done.
RentPayout
A pending payout. Without the PIX key or bank account.
contractIdstringrequired- The contract.
propertyTitlestringrequirednullable- The property.
renterNamestringrequirednullable- The renter.
competencestringrequired- The month (
2026-11). dueOnstringrequirednullable- The payout day.
ownerIndexintegerrequirednullable- Which contract owner (0 = the first).
ownerNamestringrequirednullable- The owner.
amountnumberrequirednullable- The amount to pay out.
isPartnerbooleanrequired- It is the partner agency's share.
transferStatusstringrequirednullable- The Asaas transfer status, when requested.
RentTicketInput
The ticket fields. When updating, only what comes changes.
titlestring- What happened (required when opening).
descriptionstringnullable- Details. On PATCH,
nullclears it. payerstring- Who pays (default when opening:
OWNER).one ofOWNERRENTERNONE quoteAmountnumbernullable- The quote. On PATCH,
nullclears it. supplierstringnullable- The supplier. On PATCH,
nullclears it.