# Docs

- [Documentation](/docs): How to run your properties, and how the people who live in them use their portal.
- Getting started
  - [Getting started](/docs/getting-started): What this platform is, who uses it, and how each of them signs in.
  - [Who uses it](/docs/getting-started/who-uses-it): Four portals, four audiences, and how to tell which one you want.
  - [Signing in](/docs/getting-started/signing-in): Each role signs in differently — a password, an emailed code, or a link that is itself the credential.
- Platform guide
  - [Getting Started](/docs/platform/getting-started): Navigation, Global Search, Notifications & Roles
  - [Dashboard Home](/docs/platform/dashboard-home): Daily Overview
  - [Reservations](/docs/platform/reservations): Bookings, Links, Import, Room Changes & Estimates
  - [Rent Roll](/docs/platform/rent-roll): Availabilities, Unit Map, Residents & Payments
  - [Rent Roll](/docs/platform/rent-roll-financials): Profit & Loss, Deposits & Reports
  - [Move Outs](/docs/platform/move-outs): Notices, Room Checks, Reports & Deposit Settlements
  - [Departure Checklists](/docs/platform/move-out-checklists): What the move-out confirmation email asks residents to do before they leave
  - [Housekeeping](/docs/platform/housekeeping): Cleaning Events, Recurring Schedules, Timesheets & Paid Holiday
  - [Maintenance](/docs/platform/maintenance): Projects, Requests, Visits, Visit Planner & Timesheets
  - [Sodai Gomi](/docs/platform/sodai-gomi): Oversized-rubbish requests, ward bookings, the calendar event and putting it out
  - [Inbox, OTA Inbox & Contacts](/docs/platform/inbox): Messages and Lead Management
  - [Schedule](/docs/platform/schedule): Staff Calendar & Appointments
  - [Viewings](/docs/platform/viewings): Viewing Requests to Bookings
  - [Properties](/docs/platform/properties): Buildings & Units
  - [Property Owners](/docs/platform/property-owners): Landlord accounts for the owner portal
  - [Waiting List](/docs/platform/waiting-list): Entries, Matches & Offers
  - [Reviews, Overnight Guests & Resident Services](/docs/platform/reviews-and-overnight-guests)
  - [House Leaders](/docs/platform/house-leaders): Discounts, Supplies, Receipts & Garbage Duties
  - [Reports](/docs/platform/tickets): Resident Tickets, Labels & Ticket Analytics
  - [Handbooks](/docs/platform/handbooks): Resident Handbooks & Minpaku Guest Handbooks
  - [Inventory & Purchases](/docs/platform/inventory-and-purchases)
  - [Expenses](/docs/platform/expenses): Every expense in one list: purchases, typed-in costs, recurring ones and everything booked elsewhere
  - [IoT Monitoring & Freee Accounting](/docs/platform/iot-and-accounting)
  - [Announcements & Newsletter](/docs/platform/announcements-and-newsletter)
  - [Social Media](/docs/platform/social-media): Queue, Autopilot & Analytics
  - [Content](/docs/platform/content): Blog, Campaigns & Public Knowledge Base
  - [Positions](/docs/platform/positions): Job Openings
  - [Analytics](/docs/platform/analytics): Occupancy, Income, Pricing, Marketing & Audience
  - [AI Chat & Staff Knowledge Base](/docs/platform/assistant): Asking Questions and Adding Knowledge
  - [Settings](/docs/platform/settings): Configuration Reference
  - [Contract templates](/docs/platform/contract-templates): Write, preview and publish your contract templates
  - [FAQ & Troubleshooting](/docs/platform/troubleshooting): Moved Pages, Common Confusions
- Help centre
  - [Help centre](/docs/help): For residents, owners and cleaning staff — using your portal.
  - Residents
    - [For residents](/docs/help/residents): Your portal — what is in it, and what you can do there.
    - [Signing in](/docs/help/residents/signing-in): There is no password — you sign in with a code sent to your email.
    - [Why a tab is missing](/docs/help/residents/why-a-tab-is-missing): The sidebar changes with your tenancy — here is exactly what unlocks what.
    - Searching
      - [Favourites](/docs/help/residents/searching/favourites): Save rooms you are considering so you can compare them later.
      - [Showings](/docs/help/residents/searching/showings): Viewings you have booked, and who is meeting you.
      - [The waiting list](/docs/help/residents/searching/waiting-list): Join a list for a room that is not free yet, and respond when one is offered.
    - My lease
      - [Your reservation](/docs/help/residents/my-lease/your-reservation): Your contract dates, status and documents, in one place.
      - [Reviewing your contract](/docs/help/residents/my-lease/contract-review): Check the details and confirm them before anything is signed.
      - [Your contract explanation](/docs/help/residents/my-lease/contract-explanation): Book the session where the contract is walked through with you.
      - [Paying your rent](/docs/help/residents/my-lease/pay-your-rent): What is due, how to pay it, and what happens if a payment is late.
      - [Understanding your bill](/docs/help/residents/my-lease/understanding-your-bill): Why the monthly total is made of several lines, and why a month can differ.
      - [Payment methods and saved cards](/docs/help/residents/my-lease/payment-methods): Save a card for next time, or remove one you no longer use.
    - Living here
      - [Your move-in condition report](/docs/help/residents/living/move-in-condition): Photograph anything already damaged — this is what protects your deposit.
      - [Registering an overnight guest](/docs/help/residents/living/overnight-guests): Tell us who is staying, before they stay.
      - [Reporting a problem](/docs/help/residents/living/report-a-problem): Something broken, a neighbour issue, a question — raise it here and follow it.
      - [Submitting a receipt](/docs/help/residents/living/receipts): Claim something you paid for on the building's behalf.
      - [Giving notice](/docs/help/residents/living/give-notice): Tell us you are leaving, and see what it costs before you confirm.
      - [Getting your deposit back](/docs/help/residents/living/the-settlement): What happens after you leave, and where to watch it.
    - House leader
      - [Being a house leader](/docs/help/residents/house-leader): The extra section in your portal, and what it is for.
      - [Supply requests](/docs/help/residents/house-leader/supply-requests): Ask for consumables when the building is running out.
      - [The garbage schedule](/docs/help/residents/house-leader/garbage-schedule): Set who takes the rubbish out, week by week.
      - [Duty reports](/docs/help/residents/house-leader/duty-reports): Record when a scheduled duty was not done.
      - [Sodai Gomi](/docs/help/residents/house-leader/sodai-gomi): Report oversized rubbish, and put it out when it is booked.
      - [Maintenance](/docs/help/residents/house-leader/maintenance): Small jobs the office asks you to help with, and how to mark them done.
    - [Ask the assistant](/docs/help/residents/assistant): Quick answers about your stay, your building and the house rules — and where to go when it can't help.
    - [Contact and directions](/docs/help/residents/contact): How to reach the office, and how to get there.
  - Owners
    - [For owners](/docs/help/owners): Your statements, your residents, and your occupancy.
    - [Signing in](/docs/help/owners/signing-in): Your email, then a six-digit code.
    - [Your monthly statements](/docs/help/owners/monthly-statements): Rent collected, management fee, your costs, and the net payable to you.
    - [Payments and balance](/docs/help/owners/payments): Every payment made to you, the proof behind it, and what is still owed.
    - [Your residents](/docs/help/owners/your-residents): Who is in each unit, with dates, status and rent.
    - [Occupancy](/docs/help/owners/occupancy): How full your buildings are, and what "occupied" counts.
    - [Documents](/docs/help/owners/documents): Not built yet — statements are downloaded from the Statements page.
    - [What you can and cannot see](/docs/help/owners/what-you-can-see): The deliberate limits on the owner portal.
  - Housekeepers
    - [For housekeepers](/docs/help/housekeepers): Your cleaning events, room checks, errands and timesheets — all in the dashboard.
    - [Signing in](/docs/help/housekeepers/signing-in): Email and password, or an emailed one-time code.
    - [Your cleaning events](/docs/help/housekeepers/your-visits): What you have been assigned, and how it got there.
    - [Completing a cleaning event](/docs/help/housekeepers/completing-a-visit): Work periods, travel, and the photos that have to exist before you can finish.
    - [Room checks](/docs/help/housekeepers/room-checks): Inspecting a room between residents.
    - [Timesheets and pay](/docs/help/housekeepers/timesheets-and-pay): How your hours become a monthly total, and what to check when it looks wrong.
- Concepts
  - [Concepts](/docs/concepts): The domain model, in plain language — for operators, not developers.
  - [The tenancy lifecycle](/docs/concepts/the-tenancy-lifecycle): Booking to settlement, and which record owns each stage.
  - [Availability](/docs/concepts/availability): Whether a room can be booked is derived, never typed in.
  - [Month to month](/docs/concepts/month-to-month): What happens when a contract reaches its end and nobody has left.
  - [Contract dates](/docs/concepts/contract-dates): Four different dates, and which one drives which decision.
  - [The fee catalogue](/docs/concepts/the-fee-catalogue): Every fee your workspace charges is a row you control, not a number in the code.
  - [Pricing snapshots](/docs/concepts/pricing-snapshots): A reservation remembers what it was quoted, so a later price change cannot rewrite it.
  - [The ledger](/docs/concepts/the-ledger): Every amount billed or spent is one entry with itemised lines.
  - [Proration](/docs/concepts/proration): Partial months are billed by day, automatically, in both directions.
  - [Deposits](/docs/concepts/deposits): Held for the tenancy, carried across on a room change, settled at the end.
  - [Move-out penalties](/docs/concepts/move-out-penalties): Two situations, never stacked, always billed as a charge.
  - [The maintenance model](/docs/concepts/the-maintenance-model): Requests come in, projects organise the work, visits are the trips people make.
  - [Roles and portals](/docs/concepts/roles-and-portals): Who sees what, and why the boundaries are where they are.
  - [Dates and currency](/docs/concepts/dates-and-currency): Calendar days in JST, and whole yen. Both conventions have consequences.
  - [Glossary](/docs/concepts/glossary): The words this product uses, and what they actually mean.
- API reference
  - [API reference](/docs/api): A narrow, read-oriented API for integrations and external agents.
  - [Authentication](/docs/api/authentication): Bearer tokens, scoped per workspace, revocable, rate-limited per key.
  - [Properties](/docs/api/properties): Query the catalogue of buildings and units, with the filters a search page needs.
  - [Residents](/docs/api/residents): Read resident records for your workspace. Personal data — scope the key accordingly.
  - [Webhooks](/docs/api/webhooks): Inbound only. There is no outbound event feed yet — poll instead.
  - [Errors](/docs/api/errors): Status codes, the error body, and which failures are worth retrying.
- Changelog
  - [Changelog](/docs/changelog): What changed in the product, month by month.