Documentation

• 

  Create a rental

  Step-by-step guide to create a new rental, from defining the residence to creating its units.

• 

  Create a unit

  Create a unit (flat, room, house, parking space…): rental type, home type, floor, rent, charges, number of contracts and publication in the directory.

• 

  Add a tenant to a unit

  Add a tenant to a unit with the 5-step wizard: ID document with automatic reading, tenant details, contract dates, guarantor and confirmation.

• 

  API — Authentication and OAuth2 tokens

  Overview of the API and of the two OAuth2 authentication flows available to get an access token.

• 

  Two-factor authentication (MFA): setup and use

  Complete guide to understand, turn on and use two-factor authentication (2FA/MFA) on the platform: first setup, everyday sign-in, troubleshooting and lost access.

• 

  API — projects/list endpoint

  Documentation of the GET /api/projects/list endpoint: required scope, response structure, example call and built-in tester.

• 

  API — rentals/summary endpoint

  Documentation of the GET /api/rentals/summary endpoint: required scope, response structure, example call and built-in tester.

• 

  API — Common errors

  Table of the error codes returned by the API (401, 403, 404, 422) and how to fix them.

• 

  API — project/{id}/data endpoint

  Documentation of the GET /api/project/{project_id}/data endpoint: status and aggregated rental data of a single project, with its access rights.

• 

  API — project/{id}/state endpoint (write)

  Documentation of the PATCH /api/project/{project_id}/state endpoint: change the status of a project through the OAuth2 API.

• 

  Mixed, girls-only or boys-only flatshare

  Specify whether a flatshare is mixed, girls-only or boys-only: setting it when creating the unit, changing it and how it appears on listings.

• 

  Add photos and videos to a rental

  Upload the photos, videos and documents of your rental to the project media library, view them, edit them and download them with your company logo.

• 

  Link photos and videos to a unit

  Choose from the rental's media library the photos and videos to show for a unit, set its cover photo and update its listing.

• 

  Building services: parking, caretaker, CCTV...

  Present the services of your residence (parking space, underground parking, caretaker, cameras, generator, internet...) and assign them to all your units or to some of them.

• 

  Quickly access your projects and rentals

  Use the “My projects” and “My rentals” menus of the top bar to open your construction projects and your rentals in one click.

• 

  Customise the unit: rooms, equipment and floor plan

  Describe a unit precisely: private and common areas, size and equipment of each room, then a 2D floor plan layout and a 3D view.

• 

  Publish the unit and organise viewings

  Publish a unit in the property directory to make it visible to applicants, then offer viewing slots that can be booked online.

• 

  The rental agreement: download, renewal and termination

  Download a tenant's lease, understand its automatic renewal and terminate it when the tenant leaves.

• 

  Rent, charges and fees: set and adjust the amounts

  Set the rent and charges of a unit, adapt them for a tenant, and add one-off fees (repairs, water, electricity...).

• 

  Record payments and track arrears

  Record your tenants' payments, spot late payments at a glance, and chase them with the arrears invoice for effective debt recovery.

• 

  Day-to-day monitoring: dashboard, expenses and annual report

  Manage your rentals day to day: dashboard of collections and occupancy, one-off and recurring expenses, annual PDF report and notifications.

• The rental agreement: content and rules by country

  What the generated lease contains and how it adapts to the country of the residence (France, Cameroon, Senegal): term, security deposit, rent and due date, notice, flatshare, appendices.

No guide matches your search.