Skip to main content

Getting Started

First-time workspace setup

This page is the setup hub — complete Recommended Setup Sequence (steps 1–12 on Account Settings tabs per Recommended setup order, then steps 13–15 in Listings, Bookings, and Tenants) and Onboarding a New Property — Step 7 go-live verification before relying on module, workflow, and concept deep dives. Guided walkthrough of settings steps 4–12: Onboarding a New Property. When sign-in was restored mid-setup, see Lockout catch-up after password recovery. Section pairing: Getting Started — Section cross-reference.

This section covers the basic concepts and navigation patterns you need to know before working with any specific module.

Finding your way in this guide

Skim Understanding the Interface Layout for the management shell, then Core Concepts and Terminology for portfolio hierarchy and payments. Hub subsection map: Getting Started hub subsection index (onboarding sections + Related subsections). First-time admins should continue to Recommended Setup Sequence (core steps 1–15, then optional deep dives such as Distribution & channels, Tenant-facing portal, and Finance & Tenants); returning operators can jump to Bookmarkable routes or Related → Navigation & bookmarks (Deep Links, Create New menu, Account Settings routes, interface language). Platform overview and module map before setup: Introduction — Key Platform Capabilities Non-linear operator habits (Lockout catch-up, Pending manual receipt approval, Reject/revert mistaken receipts, Partly collected security deposit, Portfolio segmentation by tenant category) and lifecycle handoff hubs (Property setup to first arrival handoff, New inventory to first booking handoff, Confirmation to check-in handoff, Check-in to check-out handoff, Same-day turnover coordination, Check-out final utilities handoff, Occupancy KPI to block hygiene handoff) have matching Related subsections below. Full pairing matrix: Getting Started — Section cross-reference.

Accessing the Platform

Pair with other Getting Started sections

After first login, continue with Understanding the Interface Layout (sidebar, bell, mobile shell). Team leads configuring a new account should follow Recommended Setup Sequence; bookmark daily routes from Bookmarkable routes. Full pairing matrix: Getting Started — Section cross-reference.

Navigate to platform.vivin.app and log in with your account credentials. Upon logging in, you will land on the Dashboard — your central hub for monitoring business performance at a glance.

The sign-in screen uses your email and password (no separate username field). Team members invited from Users activate their account from the invitation email before their first login.

Management frontend — sign-in page with email, password, and Reset your password link

If a management user cannot log in because they forgot their password, follow Resetting a Management User Password.

Lockout catch-up after password recovery

Operational backlog after regaining access

After Resetting a Management User Password — Step 3 restores sign-in, refresh external Landlord MCP Bearer JWTs (and Mcp-Session-Id if needed) before portfolio automation resumes — see Landlord MCP — How it connects. Catch up delayed operator work: Notification triage (Step 4 row-click — route payment overdue via Common Workflows — Payment alert to receivables triage and Upcoming alerts via Common Workflows — Confirmation alert triage; then Step 5; file Step 6 when row-click fails; notifications-row-navigation-flow.mp4), month-end Pending receipt mesh (Common Workflows — Pending manual receipt approval; Steps 6b across booking workflows — finance-transactions-pending-pill.png, bookings-detail-transactions-approve-payment-modal.png), receivables sign-off (Common Workflows — Finance debt receivables triage; finance-overview-income-chart-debt-aging.png, dashboard-kpi-total-debt-tooltip.png), portal gates on live bookings (Processing a New Booking — Step 6), deposit shortfalls (Common Workflows — Partly collected security deposit), older move-outs hidden by the default Finance → Deposits toolbar date range (Common Workflows — Deposit missing on Finance Deposits; finance-deposits-date-range-clear-flow.mp4), Common Workflows — Directory list load failures when /notifications or Bookings will not load (Retry before alert triage), and Portfolio KPI review — Step 7 when month-end reconciliation lagged during lockout. Hub parity: Common Workflows — Lockout catch-up after password recovery. Full mesh: Resetting a Management User Password section cross-reference.

| Symptom | Fix | | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Unread payment alerts | Notification triage — Step 4 | | Pending receipts on Finance | Pending manual receipt approval | | Pending manual in-payment alerts on /notifications | Notification row-click navigationPending manual receipt approval | | Total Debt high after alert triage | Receipts still pendingPending manual receipt approval then Finance debt receivables triage (finance-transactions-pending-pill.png, dashboard-kpi-total-debt-tooltip.png) | | /notifications or Bookings list will not load | First-fetch directory failure | Directory list load failuresRetry before Notification triage — Step 4 | | Deposit shortfall on booking Deposit | Partly collected security deposit | | Older move-outs missing from Finance Deposits | Deposit missing on Finance Deposits — clear toolbar date range | | External MCP 403 | Refresh JWT after Step 3 — Landlord MCP — How it connects | | Setup wizard still blocked | Rerun Onboarding — Step 7 |

Management sign-in — password reset entry point on the login page Notifications — row-click from payment alert opens booking detail for Transactions approval
Walkthrough: sign-in Forgot password? entry → /notifications row-click → Finance → Transactions amber Pending chip → Approve payment (cancel) → Finance → Overview debt sign-off.

Staying signed in and logging out

After a successful sign-in, Vivin keeps your management session active without asking you to re-enter your password on every screen change:

  • Silent refresh — When your short-lived access token expires, the app automatically requests a new one using a secure httpOnly refresh cookie (you do not see a separate prompt). API calls that failed with an expired token are retried once with the new token.
  • True session end — If refresh is no longer valid (for example you signed out elsewhere, an administrator revoked access, or the refresh cookie expired), the next protected action shows Your session expired. Please log in again. (wording follows your interface language) and returns you to the sign-in page.
  • LogoutLogout in the sidebar user section ends the session on the server (refresh token revoked) and clears local sign-in state so the next person on the same browser does not inherit your workspace.

Use Logout on shared computers. Closing the browser tab alone does not immediately sign you out — the refresh cookie can still allow a return visit until it expires or you log out explicitly.

On desktop, the sidebar user section at the bottom shows Account (Account Settings) and Logout — use Logout here to end the server session explicitly:

Screenshot freshness

Sidebar user-section capture refreshed 2026-06-12 18:15 UTC (VIVIN_DOCS_BASE_URL=http://localhost:5173 VIVIN_DOCS_RECORD_API=$VITE_API_BASE_URL npx tsx tools/capture-getting-started-logout-sidebar.ts).

Dashboard — sidebar user section with Account and Logout at the bottom of the left rail

For help from the Vivin team, use Get Help & Support (email and the public status page). If your organisation has the Support permission, you can also open and track Vivin support tickets inside the management app — see Using in-app support.

If your team wires external AI clients or custom automation against VIVIN (outside the browser), start with Automation & AI — External AI clients (MCP), then the dedicated Landlord MCP (account-scoped) and Tenant MCP (booking-scoped) guides. Administrators configure API keys, tool permissions, and connector OAuth scope on Account Settings → AI / MCP (/settings/mcp) — Claude.ai and ChatGPT connectors use MCP OAuth on the Core API host instead of pasted keys. For direct HTTP integration, see the API Reference — operators use Management session authentication; partners use integration Bearer keys.

Understanding the Interface Layout

Pair with other Getting Started sections

Pair shell navigation with The + Create New Menu shortcuts and Working with Tables behaviour in module directories. For entity names behind each sidebar group, read Core Concepts and Terminology; for stable URLs, see Bookmarkable routes. Full pairing matrix: Getting Started — Section cross-reference.

The Vivin interface has three main areas that remain consistent across all modules:

Dashboard — management shell with left sidebar, KPI cards, and main workspace

The four KPI cards in the top-left grid (Listings, Today, Total Debt, Monthly Revenue) are your daily health check before you open Finance or Analytics — see Glossary — Dashboard KPI cards and Dashboard > KPI cards for what each card measures.

Walkthrough: sign-in screen, Dashboard KPIs, header notifications bell, + Create New panel, a quick Account Settings → General visit, and return to the dashboard.

Left Sidebar A vertical panel that is always visible, containing:

  • Logo — links to the Dashboard
  • Collapse control (desktop) — chevron on the sidebar edge collapses the rail to icons only so the main workspace gains width. Your choice is remembered in the browser (vivin:sidebar-collapsed). When collapsed, + Create New stays available as an icon with a tooltip (see Create New Menu).
Dashboard — desktop sidebar collapsed to icons only with expand chevron on the rail edge
  • + Create New button — opens a slide-out panel for creating properties, units, bookings, tickets, and more without navigating away from your current view (see Create New Menu for every category and permission rule)
Create New slide-out — What would you like to create? with People, Listings, Reservations, Operations, and Payments categories
  • Main Navigation — grouped into sections:
    • Portfolio: Listings, Bookings, Tenants
    • Business: Sales, Finance, Analytics (KPI workspace at /analytics — after Finance in the sidebar; requires Analytics module permission), Operations
    • Tools: Inbox (portfolio-wide WhatsApp at /inbox when tenant chatbot is enabled — desktop only; see Inbox module; per-booking threads: FAQ — WhatsApp and email per booking), Utilities, Audit (manual availability blocks; requires Listings permission — see Manual block hygiene), AI Chat (internal). Rich booking-engine property and unit content is edited from Listings via the Full integration pill in sidebars (who can open the details editor).
  • User section (bottom) — Account (opens Account Settings), Logout

The Tenants entry opens /tenants and provides a dedicated tenant-management workspace (status pills, toolbar Search, grid vs table view). In table view, expand a row to see linked bookings inline before you open a profile sidebar — see Tenants — Table view and Glossary — Tenants table expand. Visibility follows your Tenants module permission (tenants.module), so some roles may see it disabled or unavailable.

For personal profile updates, use My Profile at /profile.

Interface language controls Language is chosen from Account Settings → Personal Settings at /settings/personal (see Interface Language). On mobile, open the main menu (top-left) — the drawer exposes a compact language switch (current language code) next to Logout, using the same preference as Personal Settings:

Mobile navigation drawer — compact language control beside Logout

There is no language switcher under Account Settings → Preferences today.

See Interface Language for supported options and behaviour scope.

Notification access On desktop Dashboard (/), a bell in the page header opens a Notifications slide-over. When the WhatsApp global inbox release is active (#1812), the panel splits into General and Inbox sub-tabs:

Sub-tabContents
GeneralPayment, ticket, booking, and other platform alerts
InboxInbound WhatsApp and email message pings (one row per conversation, coalesced)

Each sub-tab has its own unread badge; Mark all as read clears only the active sub-tab. Inbox rows with a backend link jump straight to /inbox?contact=… or a booking Communication deep link. The list loads more rows as you scroll (skeleton placeholders while the next batch fetches); the bell does not include search or All / Unread / Read filters.

Dashboard — header notifications slide-over on the General sub-tab with scrollable history, Mark all as read, and total/unread counts (labels follow your interface language) Dashboard — notifications bell slide-over on the Inbox sub-tab with WhatsApp and email channel icons and an unread badge on the tab label

When the account tenant chatbot is not enabled, the Inbox sub-tab is greyed out — triage General only until Vivin enables messaging (Inbox — Chatbot gating). For portfolio-wide replies without opening each booking first, use Tools → Inbox at /inbox (Inbox module).

The bell is not shown on other modules’ headers in the current layout, and it is hidden on narrow (mobile) viewports. There is no dedicated Notifications item in the left sidebar.

For the full alert history (search, All / Unread / Read filters, mixed General + Inbox rows, and End of list), open the Notifications module at /notifications in your browser (bookmark or address bar). On that page, clicking a row marks unread items read and, when the event carries a target, opens the related booking, tenant, listing, or property — see FAQ — Notification row-click navigation and Glossary — Notification row navigation. For payment overdue rows, continue with Handling a Late Payment — Step 1 after the row-click lands on the booking. Step-by-step triage: Notification triage. See Deep Links — Notifications for the bookmarkable route.

Narrow viewports (below 768px)

Below the desktop breakpoint (768px wide), several layout affordances switch to a compact shell:

  • Mobile menu drawer — Open the header menu (top-left) for navigation instead of the always-visible desktop sidebar.
  • Dashboard bell — The header notifications bell on Dashboard is hidden on narrow layouts; use /notifications for the full inbox.
  • Operations bottom tab bar — Inside Operations, a fixed bottom tab bar (when the browser is under 768px wide) switches between Overview, Tickets, Check-in & Check-out, and Cash Flows. A floating + button adds a ticket or cash-flow entry depending on the active tab. Schedule is not on that bar (desktop tab strip only for Vivin internal users) — bookmark /operations/schedule or use a wider screen when you need the timeline.
  • Language — The compact language control lives in the mobile menu drawer next to Logout (same preference as Personal Settings).
  • Install app (PWA) — On phones and tablets (coarse pointer / touch layouts), Vivin may offer Install app so you can add the management UI to your home screen. A compact Install app card can appear at the bottom of the mobile menu drawer; the first visit may also show a full-screen prompt with Install and Maybe later (dismissed prompts can reappear after about 30 minutes). iOS Safari uses Share → Add to Home Screen when the native install event is not available. Install prompts are not shown on /login or /reset-password, and desktop browsers are not interrupted. After installation, the app opens in standalone mode without the browser chrome.

Mobile phones (operations-only shell)

Separate from viewport width: on an actual mobile phone (user-agent detection — iPhone, Android phone, etc.), users whose role includes the Operations module get an operations-only experience:

  • Route guard — Opening Dashboard, Listings, Bookings, Finance, or other modules redirects to /operations (exceptions: /settings/support deep links still open).
  • Sidebar — The mobile menu lists Operations only, not the full Portfolio / Business / Tools list.

iPads and other tablets keep the full module list even in portrait. Resizing a desktop browser narrow does not trigger the redirect — only real phone user agents do. Use a tablet or desktop browser when you need Listings, Bookings, Finance, or other modules on the go from a phone-class device.

Mobile management shell at phone width — Install app entry in the navigation drawer with Account and Logout Mobile Safari — full-screen Install app prompt with benefits list, Install app, and Maybe later before the overlay is dismissed Operations — Tickets tab on a narrow viewport with the mobile bottom tab bar and floating add control
Walkthrough (mobile phone): visiting /bookings redirects to Operations; use the bottom tab bar to move between Overview, Tickets, Check-in & Check-out, and Cash Flows.

See Operations — Mobile and narrow layouts, Glossary — Operations-only phone shell, Deep Links — Operations, and FAQ — Why does my phone only show Operations?.

Several large directories (Listings, Bookings list view, Bookings Timeline listing-axis rows, Tenants, Notifications, Sales Pricing and Channels grids, Operations Tickets and Cash Flows, Utilities Connections and Allocations, and Timeline property rows) and Vivin support (Help & Support drawer and the full inbox at /settings/support) load additional rows as you scroll (skeleton placeholders or a small spinner while the next batch loads; End of list or Showing X of Y on full-page directories when finished — the drawer and Dashboard notifications bell omit that marker). On /notifications, the explicit End of list marker appears after the final server page — see Notifications — History loading and Notification triage — Step 5. Vacant Unit Preference on Preferences → Booking Defaults controls whether manual blocks count as free on Dashboard Today / Vacant Units and Sales Available now filters (#1427). Default excludes operator holds; Include manual blocks treats them as physical vacancy while OTA/iCal blocks still occupy the unit.

When a directory’s first fetch fails, Vivin shows an explicit Failed to load … card with Retry — not an empty table that looks like zero data. See FAQ — Directory list load failures and Glossary — Directory list load failures. See FAQ — Notifications & alerts (scroll-to-load behaviour), Using in-app support, Bookings — Loading more rows, Bookings — Timeline listing-axis loading, Operations — Tickets list loading, and Glossary — Infinite scroll (directory loading).

Some forms use the same chunked loading inside a dropdown when you pick a tenant, property, or similar record from a very large portfolio — see Glossary — Server-driven search picker.

Main Content Area (center) The active module's data, tables, forms, and visualizations. This area updates when you select a different module from the navigation menu.

Core Concepts and Terminology

Pair with other Getting Started sections

Apply these terms while walking Recommended Setup Sequence; use Working with Tables when you open your first Listings or Bookings directory. For deeper models, continue to Concepts; for daily procedures, see Common Workflows. Full pairing matrix: Getting Started — Section cross-reference.

Before working with specific modules, it is important to understand the entities and terms used throughout Vivin.

The Portfolio Hierarchy

Vivin organizes your portfolio in a two-level hierarchy:

Property (building or complex)
└── Unit (individual rentable space)

A Property represents a physical building or location (e.g., "Alpha Building," "Riverside Complex"). A Unit is an individual rentable space within that property (e.g., "Room 101," "Studio A," "Bed 3"). Every unit belongs to exactly one property.

note

In the Listings module, "Unit" and "Listing" are used interchangeably. A unit is always displayed within its parent property. See Managing Listings for full details.

tip

Use Listings (Portfolio > Listings) for portfolio setup, property and unit editing, and hierarchy workflows. Inside Listings, switch between the Portfolio and Archived pills at the top when you need to review or restore archived properties (/listings/archived).

Older /properties bookmarks still work: they redirect into Listings. See Legacy /properties URLs (guide subsection index) for how each path resolves.

Bookings and Tenants

A Booking is a reservation linking a Tenant (the person renting) to a Unit for a specified period. Booking status is computed from dates and cancellation state:

Product Value (bookingStatus)UI LabelMeaning
upcomingUpcomingStart/check-in date is in the future
currentOngoingBooking is active today
endedEndedEnd/check-out date is in the past
canceledCanceledBooking was canceled through the cancellation workflow

For a detailed explanation of computed status behavior and transitions, see Booking Lifecycle.

In the Bookings module, use List for the full table (filters, export, canceled rows) or Timeline for a portfolio Gantt chart at /bookings/timeline — same search and property filters, with Day / Week / Month scales and an optional Only bookings toggle to show or hide calendar blocks on each unit row. Clear Only bookings to see manual and channel holds on the same Gantt; for portfolio-wide manual-block triage (filter, export, column sort), use Tools → Audit — see Bookings — Timeline listing-axis loading and Manual block hygiene.

For tenant-centric filtering, profile management, and debt-focused follow-up, see Tenants.

Dates: Contract vs. Occupancy

It is important to distinguish between two types of dates:

  • Contract Date — when the rental agreement legally begins (used for payment scheduling)
  • Occupancy Date (Move-in Date) — when the tenant physically enters the property

These dates may differ. For example, a contract might start on the 1st of the month, but the tenant physically moves in on the 5th.

Payments

Vivin uses a two-layer payment model:

  • Scheduled Payments (Contract Values) — what the tenant is expected to pay and when (generated automatically when a booking is created)
  • Incoming Payments (Transactions) — what the tenant has actually paid

A payment is marked as "received" only when an incoming payment is recorded and allocated to a scheduled charge. For a detailed explanation of how allocation works, see Payment Allocation.

Manual receipts may stay pending until Approve payments acts on Finance → Transactions or a booking Transactions tab. To remove a mistaken duplicate, use Reject payment (per row on the booking) or Reject selected (bulk-only on the Finance ledger). Revert payment rolls back a confirmed receipt. When Finance already invoiced the charge, confirmation modals warn that you may need credit notes in your accounting system — see Payment Allocation — Correcting mistaken receipts. Lowering rent on an already-invoiced month is blocked by the invoiced floor on Change monthly rent and Contract Values → Edit amount — see FAQ — Lower rent below invoiced.

Security deposits are tracked on Finance → Deposits (and each booking’s Deposit tab). Payment-driven lifecycle (Not Paid through Refunded, optional Disputed) is summarized on the depositStatus pill — see Glossary — Deposit lifecycle status. The Deposits toolbar date range defaults to about the last three months — rows appear when check-in, check-out, or Refund Due Date intersects that window, not when the booking was created. Clear or widen the range before triaging older move-outs, disputes, or export. Refund Due Date follows your account Deposit Refund Deadline in Settings → Payments. When a tenant contests deductions before refund, Enable deposit disputes lets operators Mark as Disputed so Refund stays frozen until Resolve Dispute — see Glossary — Deposit dispute. See Glossary — Finance Deposits date range and Managing a Check-out — Step 5.

Tickets

Tickets are actionable operational tasks: maintenance, cleaning, inspections, repairs, or tenant requests. Each ticket has:

  • A priority (Low, Medium, High, Critical)
  • A status (Unassigned, Open, In Progress, Completed, Cancelled, Duplicate)
  • An assignee (the team member responsible)
  • A category and due date

In product data and API payloads, the Completed status is stored as closed.

Tickets are managed in the Operations module. Categories are configured in Settings > Categories. Far-future Schedule date values surface as Draft (display status) in the list — use the Draft KPI card to review long-lead jobs without mixing them into today’s Unassigned queue. On a ticket sidebar, Cost allocation can link cash flows from the operational ledger so repair totals reconcile with contractor invoices. For same-day turnovers (check-out and check-in on one unit the same day), schedule cleaning and inspection tickets with a due date before the incoming arrival — see Managing a Check-in and FAQ — How do I handle same-day turnovers?.

Cash Flow

Cash Flow refers to operational financial transactions — expenses and income that are not part of a tenant's booking payment. For example: a contractor invoice for plumbing repairs, or income from a one-off service fee. Cash flows are tracked in the Operations module.

The + Create New Menu

Pair with other Getting Started sections

The slide-out mirrors categories in Understanding the Interface Layout; permission rules and every row are documented in Create New Menu. During onboarding, use it while following Recommended Setup Sequence steps 13–15. Full pairing matrix: Getting Started — Section cross-reference.

The + Create New button in the left sidebar is your primary shortcut for adding new records. Clicking it opens a slide-out panel titled What would you like to create? with actions grouped into categories: People, Listings, Reservations, Operations, and Payments. If you sign in with a Vivin internal email (@vivin.app), an extra Tools category appears for shortcuts such as utility bill upload. After Booking or Transfer shortcuts, unpaid schedules can surface payment overdue alerts — row-click opens the booking for Handling a Late Payment — Step 1.

Create New slide-out — “What would you like to create?” with category grid; disabled rows show a no-permission hint on hover

For a complete reference of all available actions, layout, and permissions, see Create New Menu. From medium-width layouts and up, you can use the sidebar button from any screen; on narrow mobile layouts, use each module’s own create actions instead.

Working with Tables

Pair with other Getting Started sections

Table behaviour appears in every module — start with Core Concepts and Terminology (Bookings, Tenants, Tickets) then open the matching Modules page. Large directories also load more rows on scroll (see Understanding the Interface Layout). Full pairing matrix: Getting Started — Section cross-reference.

Data tables appear throughout the platform. They share consistent behavior:

  • Click a row to open the detail view for that record
  • Column headers can be clicked to sort the table
  • Filter controls appear above the table and update results in real-time
  • Search bars filter results as you type
  • Tenant category filters — When your account defines segments under Tenant categories, narrow Bookings (Other filters → Tenant category) or Tenants (All categories toolbar dropdown) before export or month-end review; filters combine with search, status pills, and infinite scroll server-side

Bookmarkable routes

Pair with other Getting Started sections

Bookmark routes after you know the shell from Understanding the Interface Layout; the complete URL table lives in Management Frontend Deep Links. Pair with Recommended Setup Sequence optional sections when you wire integrations or portal links. Full pairing matrix: Getting Started — Section cross-reference.

Most modules and tabs have stable URLs you can bookmark, paste into team chats, or open from notification deep links. The management shell keeps the same sidebar while the main workspace changes.

RouteUse when
/Return to post-login KPI snapshot
/notificationsFull alert history with search and All / Unread / Read filters
/analyticsMulti-month portfolio KPI charts (Business → Analytics)
/audit/discountsCross-portfolio discounted contract values
/bookings/timelineGantt-style reservation chart by unit
/operations/ticketsMaintenance ticket queue and Draft KPI filter

For the complete URL table (Finance tabs, booking sidebar deep links, settings routes, and mobile Operations behaviour), see Management Frontend Deep Links. Partner HTTP integration contracts live in the separate API Reference section.

When a Dashboard bell row or /notifications alert needs follow-up before you deep-dive a module:

Pair with other Getting Started sections

Complete Accessing the Platform (invites and session behaviour) before step 3 (Users). Keep Core Concepts and Terminology open for hierarchy and payment vocabulary; use The + Create New Menu for steps 13–15. Module names and integration entry points during setup: Introduction — Key Platform Capabilities. Step-to-tab map: Account Settings — Recommended setup order. Guided walkthrough: Onboarding a New Property. When behaviour does not match expectations during setup (permissions, integrations, Communication Rules), check FAQ & Troubleshooting (Navigation & shortcuts, Settings & tenant communications, Help & Vivin support) before escalating. Unfamiliar labels on screen: Glossary (hub: Glossary cluster cross-reference, Setup sequence vocabulary). When a tab save, wizard submit, or permission gate still blocks progress after self-serve docs, continue with Get Help & Support (email or in-app Settings / Listings module tickets — step-to-module pairing: Support — Setup sequence escalation; see Using in-app support). Full pairing matrix: Getting Started — Section cross-reference.

If you are setting up Vivin for the first time, follow this sequence to configure the platform before adding operational data:

  1. General Information — set your company name, logo, and contact details
  2. Preferences — set default check-in/out times and preparation-day buffers (account-wide)
  3. Users — add your team members and define role permissions (prevents greyed + Create New rows and surprise permission denied toasts later)
  4. Owners — register property owners before creating properties
  5. Payments — configure due date policies, penalties, deposit rules, and payment priorities
  6. Invoicing — configure VAT rates for invoice line items
  7. Utilities — enable utility types for tenant overage billing
  8. Contract — upload your standard contract template
  9. Categories — create categories for properties, tickets, and financial items
  10. Tenant categories — define tenant segments (portal modules, field visibility, default for integrations) before channel imports assign new tenants automatically
  11. Emails — customize automated emails sent to tenants
  12. Integrations — enable marketplaces and other providers (Airbnb, Booking.com, Nuki, Invoice-xpress, etc.) and enter account credentials or API keys where required. Turning on a platform here does not publish a new listing on that site by itself: after your properties exist, link each unit to its marketplace listing and iCal URLs from Listings → Channels so imports and calendar sync attach to the correct inventory.
  13. Listings — create and configure properties and units (older /properties URLs redirect here; see Legacy /properties URLs)
  14. Bookings — start creating or importing reservations
  15. Tenants — monitor tenant status, update profiles, and track booking-linked debt from a dedicated tenant workspace

Steps 1–12 map to Account Settings tabs in Account Settings — Recommended setup order; optional tabs (Services, ChatBot, Subscription, Personal Settings, Integration field capability) are listed there and in the optional subsections below.

For a guided walkthrough of steps 4–12 (owners through channel linking), see Onboarding a New Property.

After steps 13–15 go live, run Onboarding a New Property — Step 7 to confirm Listings, Multicalendar, and first-booking alerts look correct — then hub: Common Workflows — New inventory to first booking handoff for the first reservation, and Common Workflows — Property setup to first arrival handoff when the first guest is ~7 days out (workflows-operations-check-in-out-planning-view.png) — the workflow’s Steps 1–6 mirror settings steps 4–12 and the property wizard; Step 7 is the go-live verification pass once Bookings and Tenants modules have data. Pair unfamiliar on-screen labels during verification with Glossary — Visual quick reference and Glossary cluster cross-reference (First-time setup row). If a management lockout delayed setup, recover with Resetting a Management User Password first, then Lockout catch-up after password recovery before you rerun Step 7. When a settings tab, property wizard step, or integration credential save still fails after self-serve docs, open Get Help & Support or Using in-app support — choose module Settings or Listings on the ticket, cite the matching setup step number from this sequence, and pair with Support — Setup sequence escalation. For common permission, integration, and Communication Rules mismatches during setup, see FAQ — Navigation & shortcuts, FAQ — Settings & tenant communications, and FAQ — Integrations & Distribution.

External AI and automation (optional)

Pair with other Getting Started optional sections

External AI pairs with Tenant-facing portal (Chatbot channels) and Partner HTTP & API Reference (management JWT vs partner Bearer keys). Vivin-internal operators: Communication, Sales & alerts (AI Chat). Full pairing matrix: Getting Started section cross-reference.

After core setup, teams that wire IDE assistants or custom bots should read Automation & AI for how in-product AI Chat, tenant ChatBot, and external HTTP servers differ:

Partner marketplace integrations use separate API Reference Bearer keys — do not confuse them with management JWTs or MCP session headers.

Tenant Services Marketplace (optional)

Pair with other Getting Started optional sections

Services catalogue pairs with Tenant-facing portal (Preferences — Tenant Portal toggles) and Finance & Tenants when portal orders post to Payment plan. Setup step 10: Recommended Setup Sequence. Full pairing matrix: Getting Started section cross-reference.

After Tenant categories (setup step 10) and before your first channel imports, teams that sell add-ons through the portal should:

  • Configure the catalogue under Account Settings → Services (cleaning, parking, gym, transfers, and other extras)
  • Turn on Allow to see services in Preferences — Tenant Portal so tenants can browse cards in the portal
  • Read Services Marketplace for approval queues, Payment plan charges, and Finance reconciliation when portal orders post

Tenant-facing portal (optional)

Pair with other Getting Started optional sections

Portal gates pair with Tenant communication & lifecycle emails (lifecycle templates) and Tenant Services Marketplace (add-on cards). WhatsApp: Communication, Sales & alerts (Inbox). Full pairing matrix: Getting Started section cross-reference.

After Emails (setup step 11) and Tenant categories (step 10), read Tenant Portal before your first tenant moves in:

  • Configure Preferences — Tenant Portal toggles (profile edits, tickets, utilities, services, contract-signing gates); troubleshoot blocked signing with FAQ — Tenant contract signing blocked (settings-preferences-tenant-portal-contract-signing-required.png)
  • Include portal links in onboarding/check-in Communication Rules when tenants should self-serve payments or sign digitally
  • Pair with Chatbot when tenants also message on WhatsApp — operators triage portfolio threads in Inbox or per-booking Communication

Distribution & channels (optional)

Pair with other Getting Started optional sections

Channel linking pairs with Listings & Properties (Channels tab) and Partner HTTP & API Reference (partial vs full feeds). Go-live check: Onboarding a New Property — Step 7. Full pairing matrix: Getting Started section cross-reference.

After Integrations (setup step 12) credentials are saved, read Integrations & Distribution for how marketplace APIs, short-term iCal, and the white-label booking engine keep calendars aligned:

Tenant communication & lifecycle emails (optional)

Pair with other Getting Started optional sections

Communication Rules pair with Tenant-facing portal (signing gates) and Reservation lifecycle & status filters (check-in triggers). Validate Tenant category audience on Bookings, Finance, and Tenants. Full pairing matrix: Getting Started section cross-reference.

After Emails (setup step 11), configure both sub-tabs before tenants receive automated mail:

Deposits & check-out settlement (optional)

Pair with other Getting Started optional sections

Deposit policy pairs with Check-out vs cancellation (policy void vs normal departure), Check-out collections before refund (unpaid Payment Plan lines before Ready To Refund), Check-out ledger cleanup before refund (duplicate departure transfers before Ready To Refund), Payment allocation & invoiced floor (refund receipts), and Operations, tickets & cash flows (damage tickets). Workflows: Managing a Check-out · Cancelling a Booking. Full pairing matrix: Getting Started section cross-reference.

After Payments (setup step 5) and your first Bookings, read Managing a Check-out & Deposit Refund before the first move-out:

Payment allocation & invoiced floor (optional)

Pair with other Getting Started optional sections

Two-layer payments pair with Finance & Tenants (Transactions approve/reject) and Deposits & check-out settlement (refund disputes). Workflow mesh: Common Workflows — Reject/revert mistaken receipts. Full pairing matrix: Getting Started section cross-reference.

After Invoicing & Payments (setup step 5) and your first confirmation receipt, read Payment Allocation before you approve, reject, or revert manual payments:

Reservation lifecycle & status filters (optional)

Pair with other Getting Started optional sections

Computed statuses pair with Listings & Properties (unit occupancy) and Distribution & channels (imported rows). Cancellation: Cancelling a Booking. Full pairing matrix: Getting Started section cross-reference.

After Bookings (setup step 14), read Booking Lifecycle before you rely on list filters or Timeline for occupancy decisions:

  • Statuses (Upcoming, Ongoing, Ended, Canceled) are computed from dates — you do not manually advance them
  • Use Bookings → Timeline for Gantt-style unit occupancy; compare with Sales → Multicalendar for availability-only context
  • Canceled requires the explicit cancellation workflow — distinct from a normal check-out to Ended

Utilities & Bills Included (optional)

Pair with other Getting Started optional sections

Bills Included ceilings pair with Listings & Properties (property wizard Step 3) and Finance & Tenants (overage lines on Payment plan). Monthly workflow: Entering Monthly Utility Bills. Full pairing matrix: Getting Started section cross-reference.

After Listings property wizard (setup steps 4–6) and Settings > Utilities (setup step 5), read Entering Monthly Utility Bills before your first supplier billing cycle:

Operations, tickets & cash flows (optional)

Pair with other Getting Started optional sections

Turnover queues pair with Reservation lifecycle & status filters (same-day turnover), Check-in to check-out handoff (mid-stay → departure week), and Deposits & check-out settlement (linked cash flows). Arrival/departure: Managing a Check-in · Managing a Check-out. Full pairing matrix: Getting Started section cross-reference.

After Bookings (setup step 14) and Categories (setup step 9), read Operations before your first turnover week:

Listings & Properties (optional)

Pair with other Getting Started optional sections

Property wizard pairs with Distribution & channels (Channels tab) and Utilities & Bills Included (wizard Steps 2–3). Legacy URLs: Properties workspace. Full pairing matrix: Getting Started section cross-reference.

After Integrations (setup step 12) and before your first booking:

  • Create properties and units in Listings — use the property wizard (Steps 1–6), Channels tab for marketplace linking, and Archived when sunsetting inventory
  • Bookmark older /properties URLs — they redirect into Listings; see Properties workspace for the mapping table
  • Open the Full integration pill from Listings sidebars to edit rich marketplace payloads in Booking engine details before partner feeds poll updates

Finance & Tenants (optional)

Pair with other Getting Started optional sections

After Bookings (setup step 14) and Tenants (step 15):

Communication, Sales & alerts (optional)

Pair with other Getting Started optional sections

Alert triage pairs with Tenant communication & lifecycle emails and Dashboard & portfolio KPIs (bell vs /notifications). Month-end: Portfolio KPI review. Full pairing matrix: Getting Started section cross-reference.

After Chatbot and Emails (setup steps 11–12):

  • Open Sales for portfolio Overview KPIs, Multicalendar availability, Pricing monthly rent grid, and Channels manager linking
  • Triage inbound WhatsApp on Tools → Inbox or the Dashboard bell Inbox sub-tab; use Notifications at /notifications for searchable alert history with All / Unread / Read filters
  • Follow Notification triage after busy booking or payment days; when a payment overdue alert row-click brought you here, continue with Handling a Late Payment — Step 1; Vivin-internal operators can use AI Chat for cross-booking portfolio questions (verify answers in Finance and Bookings)

Audit & Account Settings (optional)

Pair with other Getting Started optional sections

After Users and roles (setup step 2) and before high-volume bookings:

Partner HTTP & API Reference (optional)

Pair with other Getting Started optional sections

Partner HTTP pairs with Distribution & channels and External AI and automation (management JWT vs MCP vs Bearer keys). Field matrix: Integration field capability. Full pairing matrix: Getting Started section cross-reference.

After Integrations (setup step 12) and the Distribution & channels section above, teams building partner feeds or custom HTTP automation should read the API Reference hub:

Dashboard & portfolio KPIs (optional)

Pair with other Getting Started optional sections

Same-day KPIs pair with Finance & Tenants (debt drill-down) and Communication, Sales & alerts (bell triage). Month-range charts: Analytics. Full pairing matrix: Getting Started section cross-reference.

After login you land on the Dashboard — use it for same-day portfolio checks before deep-diving other modules:

Optional setup deep dives

Pair with other Getting Started sections

These optional subsections extend Recommended Setup Sequence after core steps 1–15. Each block opens with its own pairing tip and stable anchor — use Introduction — Setup sequence after go-live and Common Workflows — Setup sequence after go-live for workflow mapping. Full pairing matrix: Getting Started section cross-reference.

Optional readWhen to open it
External AI and automationIDE assistants, Landlord MCP, Tenant MCP, or direct Core API automation after core setup
Tenant Services MarketplacePortal add-on catalogue before channel imports (after setup step 10)
Tenant-facing portalSelf-service gates before the first move-in (steps 10–11)
Distribution & channelsMarketplace linking after Integrations (step 12)
Tenant communication & lifecycle emailsCommunication Rules and lifecycle templates (step 11)
Deposits & check-out settlementFirst move-out and Finance → Deposits policy
Payment allocation & invoiced floorApprove / Reject / Revert receipts and invoiced floor
Reservation lifecycle & status filtersBookings list filters and Timeline (step 14)
Utilities & Bills IncludedSupplier billing and overage charges
Operations, tickets & cash flowsTurnover-week tickets and contractor ledger
Listings & PropertiesProperty wizard and Channels before first booking (step 13)
Finance & TenantsPortfolio ledgers and tenant segmentation (steps 14–15)
Communication, Sales & alertsInbox, /notifications, and Sales after chatbot + emails
Audit & Account SettingsGo-live tab review and Manual Blocks permission
Partner HTTP & API ReferencePartner feeds and custom HTTP (after Distribution & channels)
Dashboard & portfolio KPIsPost-login KPI snapshot and month-end Portfolio KPI review

Getting Started section cross-reference

Pair with other Getting Started sections

This table pairs onboarding sections with setup, modules, and escalation hubs. Start with Accessing the Platform if you are new; jump to Recommended Setup Sequence for first-time workspace configuration. Full hub map: the Finding your way tip at the top of this page.

Use this table when one onboarding topic naturally leads into another — each row links to the sections you should read before or after the primary topic.

| Section | Pair with these sections | | --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Getting Started hub subsection index | Introduction hub subsection index (platform overview), Concepts hub subsection index (underlying models), Modules hub subsection index (screen workspaces), Common Workflows hub subsection index (operational procedures), Account Settings hub subsection index (setup tabs), API hub subsection index (partner HTTP guides), FAQ subsection cross-reference (troubleshooting deep-dives), Support hub subsection index (escalation steps), Glossary deep-dive index (term definitions), Recommended Setup Sequence (steps 1–15), Optional setup deep dives (post-go-live concept reads) | | Accessing the Platform | Understanding the Interface Layout (post-login shell), Lockout catch-up after password recovery (operational backlog mesh after Resetting a Management User Password — Step 3), Bookmarkable routes (return to /), Recommended Setup Sequence (first-time admins), Landlord MCP — How it connects (JWT refresh after password rotation) | | Understanding the Interface Layout | The + Create New Menu (sidebar shortcuts), Core Concepts and Terminology (entity names), Bookmarkable routes (module URLs) | | Core Concepts and Terminology | Recommended Setup Sequence (apply hierarchy during setup), Working with Tables (list and filter behaviour), Concepts (deeper models), Settings > Tenant categories (portal segments — setup step 10), Glossary — Tenant category | | The + Create New Menu | Understanding the Interface Layout (sidebar placement), Recommended Setup Sequence (steps 13–15), Create New Menu (full action matrix), Notifications — Payment overdue alerts (after Booking / Transfer shortcuts) | | Working with Tables | Core Concepts and Terminology (bookings, tenants, tickets), Modules (per-workspace tables), Bookings — Other filters / Tenants — Tenant category filter (portfolio segmentation), Understanding the Interface Layout (infinite scroll) | | Bookmarkable routes | Understanding the Interface Layout (where routes open), Deep Links (complete URL table), Deep Links — Tenant categories (/settings/tenantCategories), Self-serve quick links while triaging (payment overdue alerts), Recommended Setup Sequence (optional integration, portal, and marketplace sections) | | Recommended Setup Sequence | Introduction — Key Platform Capabilities (module map before steps 13–15), Introduction — Section cross-reference (documentation map), Modules — Setup sequence after go-live (module hub parity), Concepts — Setup sequence after go-live (concept hub parity), Glossary — Setup sequence after go-live (glossary hub parity), FAQ — Setup sequence after go-live (FAQ hub parity), Support — Setup sequence after go-live (support hub parity), API Reference — Setup sequence after go-live (API hub parity), Glossary (hub: Glossary cluster cross-reference, Setup sequence vocabulary), FAQ — Section cross-reference (troubleshooting hub), FAQ — Navigation & shortcuts (permissions during setup), FAQ — Settings & tenant communications (steps 10–12), FAQ — Help & Vivin support (setup tickets), Accessing the Platform (team invites), Core Concepts and Terminology (payments and deposits), Account Settings — Recommended setup order (steps 1–12 tab map), Account Settings — Tab cross-reference (go-live tab pairing), Get Help & Support (setup blocked after self-serve docs), Support — Setup sequence escalation (step-to-module ticket pairing), Using in-app support (in-app Settings / Listings module tickets), Support — Section cross-reference, Common Workflows (operational guides after setup), Common Workflows section cross-reference, Common Workflows — Setup sequence after go-live (which workflows follow each setup phase), Settings > Tenant categories (step 10 — default for integrations before step 12), Tenant Portal (optional portal section), Services Marketplace (optional add-on catalogue), Bookings — Other filters / Finance — Tenant category filter / Tenants — Tenant category filter (validate segments after step 14), Onboarding a New Property (guided steps 4–12), Onboarding a New Property — Step 7 (go-live verification after steps 13–15), Lockout catch-up after password recovery (when setup lagged during sign-in recovery), Optional setup deep dives (post–step-15 concept and workflow pairing) | | Optional setup deep dives | External AI and automation · Tenant Services Marketplace · Tenant-facing portal · Distribution & channels · Tenant communication & lifecycle emails · Deposits & check-out settlement · Payment allocation & invoiced floor · Reservation lifecycle & status filters · Utilities & Bills Included · Operations, tickets & cash flows · Listings & Properties · Finance & Tenants · Communication, Sales & alerts · Audit & Account Settings · Partner HTTP & API Reference · Dashboard & portfolio KPIs; hub parity: Introduction — Setup sequence after go-live, Common Workflows — Setup sequence after go-live | | Documentation map & escalation | Introduction — Section cross-reference, FAQ — Section cross-reference, Support — Section cross-reference, Common Workflows section cross-reference, Using in-app support | | Navigation & bookmarks | Management Frontend Deep Links, Create New menu, Deep Links — Account Settings, Settings > Interface language, Resetting a Management User Password | | Settings that shape platform behaviour | Account Settings — Tab cross-reference, Settings > Tenant categories, Settings > Integrations, Support — Settings that shape escalations | | Deeper concept reads | Payment Allocation, Booking Lifecycle, Integrations & Distribution, Tenant Portal · Automation & AI | | Deeper workflow reads | Onboarding a New Property, Processing a New Booking, Portfolio KPI review | | Recommended operator workflows | Common Workflows — Workflow cross-reference, Onboarding a New Property, Portfolio KPI review, Notification triage | | Lockout catch-up after password recovery | Sign-in restored after password reset; onboarding or month-end backlog during lockout | Common Workflows — Lockout catch-up after password recovery, Resetting a Management User Password, Notification triage | | Lockout catch-up after password recovery | Sign-in restored after password reset; onboarding or month-end backlog during lockout | Common Workflows — Lockout catch-up after password recovery, Resetting a Management User Password, Notification triage | | Walkthrough media | MP4 walkthroughs beside PNG screenshots | Common Workflows — Walkthrough media, Modules, Account Settings | | Same-day turnover coordination | Shared-unit check-out + check-in on one calendar day during go-live turnover weeks | Common Workflows — Same-day turnover coordination, Managing a Check-in — Step 1, Managing a Check-out — Step 2, FAQ — Same-day turnovers (bookings-timeline-day-week-month-and-sidebar.mp4) | | Check-out final utilities handoff | Final supplier bills + utility overage lines before Ready To Refund on first departure weeks after go-live | Common Workflows — Check-out final utilities handoff, Entering Monthly Utility Bills — Step 4, Managing a Check-out — Step 6, Utilities & Bills Included (utilities-allocations-review-flow.mp4) | | Property setup to first arrival handoff | Go-live inventory → first arrival week (~7 days before move-in) after setup steps 13–15 | Common Workflows — Property setup to first arrival handoff, Onboarding a New Property — Step 7, Managing a Check-in — Step 1, FAQ — Property setup to first arrival handoff (workflows-operations-check-in-out-planning-view.png, workflows-onboarding-property-wizard.mp4) | | New inventory to first booking handoff | Go-live property wizard → first Upcoming reservation on new inventory | Common Workflows — New inventory to first booking handoff, Onboarding a New Property — Step 7, Processing a New Booking — Step 1 / Step 6, FAQ — New inventory to first booking handoff (listings-module-overview.png, bookings-add-booking-modal.png) | | Confirmation to check-in handoff | Upcoming portal gates + confirmation receipts before arrival-week planning (~7 days out) | Common Workflows — Confirmation to check-in handoff, Processing a New Booking — Step 6, Managing a Check-in — Step 1, Confirmation alert triage (bookings-detail-contract-method-of-payments.png, booking-lifecycle-status-tabs-flow.mp4) | | Check-in to check-out handoff | Ongoing mid-stay → departure-week planning (~7 days before check-out) | Common Workflows — Check-in to check-out handoff, Managing a Check-in — Step 4, Managing a Check-out — Step 1, FAQ — Check-in to check-out handoff (operations-check-in-out-check-outs-next-7-days.png, bookings-timeline-view.png) | | Occupancy KPI to block hygiene handoff | Analytics Occupancy / RevPAR dip without rate change after go-live — stale manual holds before pricing edits | Common Workflows — Occupancy KPI to block hygiene handoff, Portfolio KPI review — Step 3, Manual block hygiene — Step 1, Dashboard & portfolio KPIs (analytics-kpi-occupancy-tab.png, audit-manual-blocks-workspace.png) | | Portfolio segmentation by tenant category | Review only corporate, short-stay, or unassigned tenants across reservations, receivables, and profiles | Common Workflows — Portfolio segmentation by tenant category, Settings > Tenant categories, Bookings — Other filters, Finance — Tenant category filter, Tenants — Tenant category filter, Glossary — Tenant category | | Partly collected security deposit | Security deposit Partially paidPaid above zero but below Amount; distinct from Partial Paid rent | Common Workflows — Partly collected security deposit, Finance — Deposits status summary cards, FAQ — Partly collected security deposit, Glossary — Deposit lifecycle status | | Pending manual receipt approval | Common Workflows — Pending manual receipt approval, Finance — Pending manual payments, FAQ — Manual receipt still pending | | Reject/revert mistaken receipts | Common Workflows — Reject/revert mistaken receipts, Payment Allocation — Correcting mistaken receipts, FAQ — Reject or revert an incoming payment, Rent reduction after invoicing, Pending manual receipt approval (bookings-detail-transactions-reject-modal-credit-note-banner.png, bookings-payment-row-actions-flow.mp4) | | Modules where capabilities surface | Modules — Module cross-reference, Dashboard, Bookings, Finance, Support — Module documentation hubs | | Key glossary terms | Glossary cluster cross-reference, Glossary — Setup sequence vocabulary, Payment Allocation — Correcting mistaken receipts |


Platform overview and documentation map: Introduction (hub: Key Platform Capabilities, Introduction — Section cross-reference). First-time setup hub: Recommended Setup Sequence (steps 1–12 tab map: Account Settings — Recommended setup order; workflow pairing: Common Workflows — Setup sequence after go-live). Definitions behind linked terms: Glossary (hub: Glossary cluster cross-reference, Setup sequence vocabulary, Setup sequence after go-live). Troubleshooting during setup: FAQ & Troubleshooting (hub: FAQ — Section cross-reference, Setup sequence after go-live). Escalation when self-serve docs do not unblock setup: Get Help & Support (hub: Support — Section cross-reference, Setup sequence after go-live, Setup sequence escalation).

Getting Started hub subsection index

Pair with other Getting Started hub sections

This index pairs onboarding sections and Related hub subsections — use it when first-time setup spans shell navigation, Account Settings tabs, optional concept reads, or escalation hubs. Full pairing matrix: Getting Started section cross-reference.

SubsectionWhen to open itPair with
Accessing the PlatformFirst login, invites, session behaviourUnderstanding the Interface Layout, Lockout catch-up after password recovery
Understanding the Interface LayoutSidebar, bell, mobile shellThe + Create New Menu, Bookmarkable routes
Core Concepts and TerminologyPortfolio hierarchy and payment vocabularyRecommended Setup Sequence, Concepts
The + Create New MenuGlobal + shortcuts during setupCreate New menu, Recommended Setup Sequence (steps 13–15)
Working with TablesDirectory scroll, filters, grid vs tableModules, Bookings — Other filters
Bookmarkable routesDaily module URLs and triage shortcutsManagement Frontend Deep Links, Self-serve quick links while triaging
Recommended Setup SequenceFirst-time workspace steps 1–15Account Settings — Recommended setup order, Onboarding a New Property
Optional setup deep divesPost–step-15 concept and workflow pairingIntroduction — Setup sequence after go-live, Common Workflows — Setup sequence after go-live
Documentation map & escalationCross-hub navigation during onboardingIntroduction — Section cross-reference, FAQ — Section cross-reference, Support — Section cross-reference
Navigation & bookmarksDeep links and sign-in recoveryManagement Frontend Deep Links, Resetting a Management User Password
Settings that shape platform behaviourAccount-wide defaults (steps 1–12)Account Settings — Tab cross-reference, Settings > Tenant categories
Deeper concept readsUnderlying models after core setupPayment Allocation, Booking Lifecycle, Tenant Portal
Deeper workflow readsOnboarding and go-live proceduresOnboarding a New Property, Processing a New Booking
Recommended operator workflowsDay-to-day procedures after go-liveCommon Workflows — Workflow cross-reference, Onboarding a New Property — Step 7
Walkthrough mediaMP4 walkthroughs beside PNG screenshotsCommon Workflows — Walkthrough media, Modules, Account Settings
Notification row-click navigation/notifications row-click after setup — alert-driven module entryCommon Workflows — Notification row-click navigation, Notification triage — Step 4, FAQ — Notification row-click navigation (notifications-row-navigation-flow.mp4)
Confirmation alert triageUpcoming Booking created / Payment received after first importsCommon Workflows — Confirmation alert triage, Processing a New Booking — Step 5b / Step 6, Pending manual receipt approval
Portfolio segmentation by tenant categoryReview only one tenant segment across Bookings, Finance, and TenantsCommon Workflows — Portfolio segmentation by tenant category, Settings > Tenant categories, Glossary — Tenant category
Partly collected security depositDeposit shortfall after confirmation or move-in paymentCommon Workflows — Partly collected security deposit, Finance — Deposits status summary cards, Processing a New Booking — Step 5
Payment alert to receivables triagePayment overdue alert row-click — confirm balance before Debt Aging or collections outreachCommon Workflows — Payment alert to receivables triage (Notification triage — Step 4 / Step 5; notifications-row-navigation-flow.mp4), Finance debt receivables triage,
Finance debt receivables triageUnsure which receivables surface to open for collections — clear Pending first when KPIs lag after Add PaymentCommon Workflows — Finance debt receivables triage, Handling a Late Payment collections, Pending manual receipt approval, FAQ — Finance debt receivables triage hub, FAQ — Handling a Late Payment hub, Handling a Late Payment — Step 1 (finance-overview-income-chart-debt-aging.png, finance-transactions-pending-pill.png)
Finance Income status drill-downIncome → In debt payment-line modal vs Debt Aging Top debtors during first Finance reviewCommon Workflows — Finance Income status drill-down, Finance debt receivables triage, FAQ — Finance Income status drill-down hub (finance-overview-income-status-in-debt-modal.png, finance-overview-income-drill-down-flow.mp4)
Cash flow forecast drill-downCollections history vs Dashboard rent-due chart during first month-end reviewCommon Workflows — Cash flow forecast drill-down, Finance Income status drill-down, FAQ — Cash flow forecast drill-down hub (finance-overview-cash-flow-all-payments-modal.png, finance-overview-cash-flow-drill-down-flow.mp4)
Same-day turnover coordinationShared-unit departure + arrival on one calendar day after go-liveCommon Workflows — Same-day turnover coordination, Managing a Check-in, Managing a Check-out, FAQ — Same-day turnovers
Check-out final utilities handoffFirst departure-week final overages before Ready To RefundCommon Workflows — Check-out final utilities handoff, Entering Monthly Utility Bills, Managing a Check-out — Step 6, Utilities & Bills Included
Property setup to first arrival handoffGo-live property → first arrival week (~7 days out)Common Workflows — Property setup to first arrival handoff, Onboarding a New Property — Step 7, Managing a Check-in — Step 1, FAQ — Property setup to first arrival handoff
New inventory to first booking handoffGo-live property → first Upcoming reservationCommon Workflows — New inventory to first booking handoff, Onboarding a New Property — Step 7, Processing a New Booking, FAQ — New inventory to first booking handoff
Confirmation to check-in handoffUpcoming portal gates before arrival-week planningCommon Workflows — Confirmation to check-in handoff, Processing a New Booking — Step 6, Managing a Check-in — Step 1, Confirmation alert triage
Check-in to check-out handoffOngoing → departure-week planning (~7 days before check-out)Common Workflows — Check-in to check-out handoff, Managing a Check-in — Step 4, Managing a Check-out — Step 1, FAQ — Check-in to check-out handoff
Occupancy KPI to block hygiene handoffAnalytics Occupancy dip without rate change → Tools → AuditCommon Workflows — Occupancy KPI to block hygiene handoff, Portfolio KPI review — Step 3, Manual block hygiene, Dashboard & portfolio KPIs
WhatsApp per-booking messagingInbox vs Bookings → Communication for tenant WhatsAppCommon Workflows — WhatsApp per-booking messaging, FAQ — WhatsApp and email per booking, Inbox module, ChatBot settings (bookings-detail-communication-tab-whatsapp-thread.png, inbox-module-triage-flow.mp4)
Pending manual receipt approvalRecorded bank transfers still pending until approvalCommon Workflows — Pending manual receipt approval, Finance — Pending manual payments, FAQ — Manual receipt still pending
Reject/revert mistaken receiptsDuplicate or invoiced receipt cleanupCommon Workflows — Reject/revert mistaken receipts, Payment Allocation — Correcting mistaken receipts, FAQ — Reject or revert an incoming payment, Rent reduction after invoicing (bookings-detail-transactions-reject-modal-credit-note-banner.png, bookings-payment-row-actions-flow.mp4)
Modules where capabilities surfaceScreen docs for setup steps 13–15Modules — Module cross-reference, Introduction — Core Modules
Key glossary termsDefinitions cited during onboardingGlossary deep-dive index, Glossary — Setup sequence vocabulary
Pair with other Getting Started hub sections

Related below is the documentation map when onboarding spans settings, modules, concepts, workflows, or escalation paths. Pair Recommended Setup Sequence with Account Settings — Recommended setup order; pair Getting Started — Section cross-reference with Introduction — Section cross-reference. Each Related subsection has a row in Getting Started section cross-reference above. Full hub map: the Finding your way tip at the top of this page.

Documentation map & escalation

Pair with other Getting Started hub sections
Pair with other Getting Started hub sections

Bookmark routes pair with Bookmarkable routes and Management Frontend Deep Links. Missing records: Create New menu. Full pairing matrix: Getting Started section cross-reference.

Session behaviour (silent refresh, Logout, session expiry) is documented in Accessing the Platform — Staying signed in and logging out.

Settings that shape platform behaviour

Pair with other Getting Started hub sections

Account-wide defaults here pair with Account Settings — Tab cross-reference and Recommended Setup Sequence steps 1–12. Tenant segments: Settings > Tenant categories. Full pairing matrix: Getting Started section cross-reference.

Deeper concept reads

Pair with other Getting Started hub sections

Concept reads pair with Concepts hub subsection index, Core Concepts and Terminology, and optional setup sections on Recommended Setup Sequence. Tenant-facing: Tenant Portal. External AI: Landlord MCP · Tenant MCP. Full pairing matrix: Getting Started section cross-reference.

Pair with other Getting Started hub sections

Walkthrough media

Pair with other Getting Started hub sections

MP4 clips complement PNG screenshots on workflow and module guides — start at Common Workflows — Walkthrough media. Hub parity: Common Workflows — Walkthrough media. Full pairing matrix: Getting Started section cross-reference.

Portfolio segmentation by tenant category

Pair with other Getting Started hub sections

Segment filters pair with Finance debt receivables triage (segment-scoped collections), Working with Tables (portfolio segmentation), and setup step 10 Settings > Tenant categories. Hub parity: Common Workflows — Portfolio segmentation by tenant category. Full pairing matrix: Getting Started section cross-reference.

Payment alert to receivables triage

Pair with other Getting Started hub sections

Alert-driven receivables triage pairs with Notification triage (Step 4 row-click → Step 5 after balance confirms), Finance debt receivables triage (Debt Aging / Top debtors when portfolio rank needed), Handling a Late Payment collections (Steps 1–6), Pending manual receipt approval (Pending before Debt Aging), Reject/revert mistaken receipts (Revert duplicates before collections), and Communication, Sales & alerts. Hub parity: Common Workflows — Payment alert to receivables triage (notifications-row-navigate-to-booking-detail.png, notifications-row-navigation-flow.mp4, finance-overview-debt-aging-walkthrough-flow.mp4). Full pairing matrix: Getting Started section cross-reference.

Alert textNotification stepReceivables surface
Payment overdueStep 4Payment PlanDebt Aging when portfolio-wide rank needed
Payment received / Pending manual in-paymentStep 4ApprovePending manual receipt approval — not Debt Aging yet
Month-end Total Debt driftStep 5 after approvalPortfolio KPI review — Step 7 (dashboard-kpi-total-debt-tooltip.png)
Top debtors still high after alert batchPending manual receipt approval or Reject/revert mistaken receiptsFinance debt receivables triagefinance-overview-debt-aging-expanded-bucket.png
Finance Income status drill-downIncome segment drill-down during setup month-end reviewCommon Workflows — Finance Income status drill-down, Finance debt receivables triage, FAQ — Finance Income status drill-down hub
Cash flow forecast drill-downCollections history vs Dashboard chart during setupCommon Workflows — Cash flow forecast drill-down, Finance Income status drill-down, FAQ — Cash flow forecast drill-down hub

Finance debt receivables triage

Pair with other Getting Started hub sections

Debt triage pairs with Payment alert to receivables triage (upstream Notification triage — Step 4 on Payments alerts), Handling a Late Payment collections (Steps 1–6 after triage surfaces), Reject/revert mistaken receipts (Revert approved duplicates before Top debtors collections), Pending manual receipt approval (amber Pending chip before Top debtors), Portfolio segmentation by tenant category (segment-scoped Top debtors), Finance & Tenants, and Communication, Sales & alerts. Hub parity: Common Workflows — Payment alert to receivables triage · Finance debt receivables triage. Full pairing matrix: Getting Started section cross-reference.

| Symptom | Fix | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | Need ranked debtors with days overdue | Finance → Overview → Debt AgingTop debtors or overdue bucket | | Opened payment-line modal, not booking rows | Income → In debt is month-scoped — use Debt Aging for tenant · unit rows | | Dashboard Total Debt not clickable | Headline only — open Finance → Overview for drill-down | | Uncovered Debt close to Total Debt | Prioritize thin deposit coverage — FAQ — Uncovered Debt KPI | | Top debtors skewed to one segment | Mixed default Finance views | Portfolio segmentation by tenant categoryFinance → Other filters → Tenant category | | Total Debt unchanged after recording transfer | Receipt still pending | Pending manual receipt approval — approve before Debt Aging (finance-transactions-pending-pill.png) | | Top debtors still high after tenant paid twice | Duplicate approved on ledger | Reject/revert mistaken receiptsRevert then re-open Debt Aging |

Finance Income status drill-down

Pair with other Getting Started hub sections

During first Finance review after setup, Income chart segment-click opens month-scoped payment-line modals — pair with Finance debt receivables triage for booking-level Top debtors. Hub parity: Common Workflows — Finance Income status drill-down. Full pairing matrix: Getting Started — Section cross-reference.

Cash flow forecast drill-down

Pair with other Getting Started hub sections

During first month-end review, Cash flow forecast lists confirmed collections — distinct from post-login Dashboard rent due chart and Income status segments. Hub parity: Common Workflows — Cash flow forecast drill-down. Full pairing matrix: Getting Started — Section cross-reference.

Property setup to first arrival handoff

Pair with other Getting Started hub sections

After setup steps 13–15 and Onboarding a New Property — Step 7 go-live verification, pair Access Lockers / portal gates with Managing a Check-in — Step 1 when the first guest is ~7 days out. Hub parity: Common Workflows — Property setup to first arrival handoff. Full pairing matrix: Getting Started section cross-reference.

SymptomSetup / go-live checkArrival-week workflow
Empty Check-ins Next 7 days on new propertyStep 7 Listings / Multicalendar verifyManaging a Check-in — Step 1
Portal Copy / Impersonate Tenant blockedTenant-facing portal + Settings > Tenant categoriesProcessing a New Booking — Step 6
Smart-lock / locker fields missingListings — Access Lockers on property wizardManaging a Check-in — Step 4

New inventory to first booking handoff

Pair with other Getting Started hub sections

First reservation on go-live inventory pairs with Onboarding a New Property — Step 7 (Listings / Multicalendar verify) and Processing a New Booking Steps 1–6 before Confirmation to check-in handoff. Hub parity: Common Workflows — New inventory to first booking handoff. Full pairing matrix: Getting Started section cross-reference.

SymptomFirst-booking workflowDownstream handoff
Duplicate channel import on new unitProcessing a New Booking — Step 1Step 6 portal sanity
Empty Upcoming after go-liveOnboarding — Step 7 + + Create New bookingConfirmation alert triage on first Booking created alert
Booking created alert on new propertyConfirmation alert triageConfirmation to check-in handoff

Same-day turnover coordination

Pair with other Getting Started hub sections

Shared-unit check-out and check-in on one calendar day require outgoing Managing a Check-out — Steps 1–2 before incoming Managing a Check-in — Step 4. Pair with Operations, tickets & cash flows (turnover ticket due date). Hub parity: Common Workflows — Same-day turnover coordination · Check-in to check-out handoff. Full pairing matrix: Getting Started section cross-reference.

SymptomDeparture workflowArrival workflow
Same-day overlap on TimelineManaging a Check-out — Step 2 turnover ticketManaging a Check-in — Step 4 after outgoing Step 6 when utilities apply
Outgoing In Debt blocks incoming keysHandling a Late Payment — Step 1 on departing stayDefer incoming access until outgoing Step 6

Occupancy KPI to block hygiene handoff

Pair with other Getting Started hub sections

When Analytics → Occupancy or RevPAR dips without a rate change after go-live, pair Dashboard & portfolio KPIs with Manual block hygiene before editing Sales → Pricing. Hub parity: Common Workflows — Occupancy KPI to block hygiene handoff. Full pairing matrix: Getting Started section cross-reference.

SymptomKPI reviewHold cleanup
Dashboard Vacant Units vs Analytics Occupancy disagreePortfolio KPI review — Step 3Manual block hygiene — Step 1
Calendar edit blocked after hold removalAudit & Account SettingsManual block hygiene — Step 6
Dip tracks one tenant category onlyPortfolio segmentation by tenant categoryNot a hold issue — review segment filters first

Confirmation to check-in handoff

Pair with other Getting Started hub sections

Reservation confirmation pairs with Managing a Check-in (arrival week after Processing a New Booking — Step 6; on new inventory also Property setup to first arrival handoff), Pending manual receipt approval (Step 5b confirmation / Step 3b move-in approval — finance-transactions-pending-pill.png), Partly collected security deposit, Payment alert to receivables triage (contrast Ongoing receivables vs Upcoming confirmation alerts), and Communication, Sales & alerts (payment overdue before key handover). Hub parity: Common Workflows — Confirmation alert triage · Confirmation to check-in handoff (notifications-row-navigation-flow.mp4, booking-lifecycle-status-tabs-flow.mp4). Full pairing matrix: Getting Started section cross-reference.

SymptomConfirmation workflowCheck-in workflow
Portal Copy blockedProcessing a New Booking — Step 6Managing a Check-in — Step 6 when category is correct
~7 days to move-inStep 6 portal sanityManaging a Check-in — Step 1
Unpaid move-in chargesHandling a Late Payment — Step 1Managing a Check-in — Step 3 before access
Payment received alert, receipt still PendingStep 5bPending manual receipt approvalbookings-detail-transactions-approve-payment-modal.png
Booking created alert on new propertyNew inventory to first booking handoffStep 6 portal sanity

Check-in to check-out handoff

Pair with other Getting Started hub sections
SymptomCheck-in workflowCheck-out workflow
Guest Ongoing, ~7 days to departureKeys already handed — Step 4 doneManaging a Check-out — Step 1
Same-day turnover on unitIncoming Managing a Check-inManaging a Check-out — Step 2 before incoming access
Deposit not fully collectedPartly collected security depositManaging a Check-out — Step 5 blocked
Unpaid rent/fee before refundHandling a Late Payment — Step 1Managing a Check-out — Step 6 — hub: Check-out collections before refund
Final utility charges before refundEntering Monthly Utility Bills — Step 4Managing a Check-out — Step 6 — hub: Check-out final utilities
Duplicate departure transfer on ledgerReject/revert mistaken receiptsRevert duplicateManaging a Check-out — Step 6 — hub: Check-out ledger cleanup
Walkthrough: Operations → Check-in & Check-out Check-outs pill + Next 7 daysBookings → Timeline Week departure bar → return to Check-outs planning (Managing a Check-out — Step 1).

Check-out collections before refund

Pair with other Getting Started hub sections

Departure-week rent and fee collections pair with Common Workflows — Check-out collections before refund (Managing a Check-out — Step 6Handling a Late Payment — Steps 1–4 before Step 5; workflows-check-out-coordination-flow.mp4), Managing a Check-out, Handling a Late Payment, Deposits & check-out settlement (refund readiness), and Finance & Tenants (Contract Values In Debt). Full pairing matrix: Getting Started section cross-reference.

SymptomCollections workflowCheck-out workflow
Payment Plan row still OverdueHandling a Late Payment — Step 1Not Step 5 until Step 6
Tenant paid, balance unchangedStep 4bStep 6b
Shortfall is deposit, not rentPartly collected security depositCollect deposit — not rent collections
Ready To Refund greyed by rent arrearsHandling a Late Payment — Step 1 on Payment PlanManaging a Check-out — Step 6 — hub: Check-out collections before refund (bookings-detail-payment-plan-tab-schedule.png)
Duplicate departure transfer on ledgerReject/revert mistaken receiptsRevertNot collections — hub: Check-out ledger cleanup before refund

Check-out vs cancellation

Pair with other Getting Started hub sections

End-of-stay routing pairs with Managing a Check-out (completed stay → Ended), Cancelling a Booking (policy void → Canceled), Cancel Booking vs Delete Booking (mistaken rows), and Deposits & check-out settlement (refund readiness). Hub parity: Common Workflows — Check-out vs cancellation. Full pairing matrix: Getting Started section cross-reference.

SituationWorkflowStatus filter
Guest completes scheduled stayManaging a Check-outEnded
Tenant or operator voids under policyCancelling a BookingCanceled
Mistaken Add booking duplicateDelete BookingSoft-archived
Mid-stay cancel with deposit overlapCancelling a Booking — Step 3Not Step 5 alone — hub: Check-out vs cancellation
Ended status fails but stay was voidedCancelling a Booking — Step 6Not Step 7 — row is Canceled
Deposit refund after policy voidCancelling a Booking — Step 3Managing a Check-out — Step 5 for normal departure

Cancellation collections before void

Pair with other Getting Started hub sections

Pre-cancel collections pair with Cancelling a Booking (Step 2 before Step 4), Handling a Late Payment (Steps 1–4; finance-contract-values-in-debt-filter.png, bookings-detail-transactions-approve-payment-modal.png), Check-out vs cancellation (policy void vs normal departure), and Finance & Tenants (Contract Values In Debt). Hub parity: Common Workflows — Cancellation collections before void. Full pairing matrix: Getting Started section cross-reference.

SymptomCollections workflowCancellation step
Payment Plan row still OverdueHandling a Late Payment — Step 1Not Step 4 until Step 2
Tenant paid, balance unchangedStep 4bStep 2a
Collections failed after outreachStep 6Step 4 refund types

Check-out ledger cleanup before refund

Pair with other Getting Started hub sections

Departure-week duplicate transfers pair with Managing a Check-out (Step 6 / Step 6b before Step 5), Reject/revert mistaken receipts, Deposits & check-out settlement (refund readiness), and Payment allocation & invoiced floor (Reject / Revert on Transactions). Hub parity: Common Workflows — Check-out ledger cleanup before refund. Full pairing matrix: Getting Started section cross-reference.

SymptomLedger cleanupCheck-out step
Two identical final transfersReject pending duplicate or Revert approved duplicateStep 6 before Step 5
Est. Refund wrong after tenant paidRevert duplicate on booking TransactionsStep 5
Invoiced charge — red / blue modalIssue credit notes on Finance ledgerRe-check Deposit tab

Check-out final utilities handoff

Pair with other Getting Started hub sections

Departure-week utility settlement pairs with Managing a Check-out (Step 6 before Step 5; Step 7 when End of Booking charge time defers posting), Entering Monthly Utility Bills (Steps 2–4 final overages), Utility overage collections (mid-stay and month-end overage arrears), Utilities & Bills Included (setup prerequisites), and Deposits & check-out settlement (refund readiness). Hub parity: Common Workflows — Check-out final utilities handoff. Full pairing matrix: Getting Started section cross-reference.

SymptomUtility bills workflowCheck-out workflow
Final bill not enteredStep 2Step 6 blocked
Overage unpaid on Payment PlanStep 4Handling a Late Payment — Step 1
Overage receipt PendingStep 4bStep 6b
End of Booking — line not on Payment Plan yetStep 3Step 7 then Step 6
Rent + utility both block Ready To RefundUtility overage collectionsCheck-out collections before refund

Utility overage collections

Pair with other Getting Started hub sections

Utility overage collections pair with Entering Monthly Utility Bills (Step 4 / Step 4b posting), Handling a Late Payment (Steps 1–4; utilities-allocations-row-breakdown-expanded.png, finance-contract-values-in-debt-filter.png), Check-out final utilities handoff (departure-week subset), and Utilities & Bills Included (setup prerequisites). Hub parity: Common Workflows — Utility overage collections (utilities-allocations-review-flow.mp4). Full pairing matrix: Getting Started section cross-reference.

SymptomUtility bills stepCollections step
Overage Overdue on Payment PlanStep 4Handling a Late Payment — Step 1Step 3
Tenant paid, balance unchangedStep 4bStep 4b
End of Booking — line not posted yetGlossary — End-of-Booking cost splitManaging a Check-out — Step 7
In Debt includes utility-type line on portfolioStep 4 spot-checkHandling a Late Payment — Step 1 — filter Property on Contract Values (finance-contract-values-in-debt-filter.png)
Segment-wide overage arrears at month-endStep 5 (Missing gaps)Portfolio KPI review — Step 7 after Steps 1–4

Handling a Late Payment collections

Pair with other Getting Started hub sections

Collections pairs with Payment alert to receivables triage (Notification triage — Step 4Debt Aging), Finance debt receivables triage (Debt Aging before tenant outreach), Communication, Sales & alerts (payment overdue alert row-click), Pending manual receipt approval (Step 4b approval), and Reject/revert mistaken receipts (ledger cleanup before Step 3). Hub parity: Common Workflows — Handling a Late Payment collections hub. Full pairing matrix: Getting Started section cross-reference.

SymptomTriage surfaceCollections step
Payment overdue alertRow-click on /notificationsHandling a Late Payment — Step 1
Ranked debtors neededFinance → Overview → Debt AgingStep 1 after booking open
Balance unchanged after transferPending manual receipt approvalStep 4b

WhatsApp per-booking messaging

Pair with other Getting Started hub sections
SymptomFix
Bell ping New WhatsApp message from …Bell Inbox sub-tab or Tools → Inbox
Need Payment Plan while replyingBookings → Communication for that reservation
Unlock your communication historyEnable chatbot — ChatBot settings
Could not load messages on CommunicationHeader RefreshBooking sidebar tab load failures
New WhatsApp message from … on /notificationsNotification row-click navigation — bell Inbox or row link
Row-click opened booking, need threadOpen Communication tab — same UAZAPI state as Inbox

Pending manual receipt approval

Pair with other Getting Started hub sections

| Symptom | Fix | | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | Total Debt unchanged after recording transfer | Approve payment on Finance → Transactions or booking Transactions | | Manual Payments KPI non-zero, queue unclear | KPI is monthly total including pending — triage amber Pending chip on Transactions | | Pending manual in-payment alert on /notifications | Row-click → Approve — expected until ledger approval | | Month-end KPIs lag after password lockout | Clear Pending mesh — Lockout catch-up after password recovery | | Two identical transfers in Pending queue | Duplicate before approval | Reject selectedReject/revert mistaken receipts | | Total Debt high after cleanup attempt | Duplicate already approved | Revert payment — not approval queue alone |

QuestionLegitimate receiptDuplicate / mistake
Row still pendingApprove paymentReject payment / Reject selected
Row already approvedN/ARevert payment
Invoiced charge reversedIssue credit notes (N) after Reject / RevertSame — Reject/revert mistaken receipts

Rent reduction after invoicing

Pair with other Getting Started hub sections

Invoiced-floor blocks pair with Bulk Hostkit invoicing (Issue credit notes after external rent relief — same Hostkit pacing as Issue allocation; finance-transactions-bulk-selection-bar.png), Month-end invoicing (fixed date) (set fixed Invoice date before first bulk export), Payment allocation & invoiced floor, and month-end Portfolio KPI review. Hub parity: Common Workflows — Rent reduction after invoicing. Full pairing matrix: Getting Started section cross-reference.

| Symptom | Fix | | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | Change monthly rent clamps exported months | Blue Already invoiced months banner — issue credit notes for true reductions | | Contract Values → Edit amount Save disabled | Net would drop below invoiced+draft totals on that line | | Hostkit Not issued credit note after rent relief | External credit note registered in Vivin | Issue credit notes (N)Bulk Hostkit invoicing |

Directory list load failures

Pair with other Getting Started hub sections

Directory load failures pair with Communication, Sales & alerts and shell navigation after setup. Hub parity: Common Workflows — Directory list load failures · Glossary — Directory list load failures hub. Full pairing matrix: Getting Started section cross-reference.

SymptomFix
Failed to load … + RetryFirst-fetch failure — not an empty portfolio
Empty table, no error bannerNormal zero-row filter result
One booking tab failsTab-scoped Refresh / RetryBooking sidebar tab load failures

Booking sidebar tab load failures

Pair with other Getting Started hub sections
SymptomFix
Could not load messages on CommunicationRefresh in the booking sidebar header
Could not load tickets on TicketsRetry on the red banner inside the tab
Payment Plan still worksKeep working — only the failed tab needs retry
Whole Bookings list failsWhole-module RetryDirectory list load failures

Confirmation alert triage

Pair with other Getting Started hub sections

Upcoming Booking created / Payment received alerts pair with Communication, Sales & alerts and Confirmation to check-in handoff. Hub parity: Common Workflows — Confirmation alert triage. Full pairing matrix: Getting Started section cross-reference.

Month-end invoicing (fixed date)

Pair with other Getting Started hub sections

Fixed document-date batches pair with Bulk Hostkit invoicing (same bulk toolbar) and month-end Portfolio KPI review. Hub parity: Common Workflows — Month-end invoicing (fixed date). Full pairing matrix: Getting Started section cross-reference.

SymptomFix
Wrong document date on issued invoicesTurn Use today as invoice date back onInvoicing — Default invoice date
No amber banner on TransactionsSave fixed date with toggle off, reload ledger
Bulk Pending for minutesHostkit pacing — Bulk Hostkit invoicing

Bulk Hostkit invoicing

Pair with other Getting Started hub sections

Bulk Hostkit pacing pairs with Month-end invoicing (fixed date) (fixed Invoice date before bulk export — finance-transactions-bulk-toolbar-fixed-invoice-date-banner.png), Rent reduction after invoicing (invoiced floor → external credit notesIssue credit notesbookings-rent-reduction-invoiced-floor-flow.mp4), Reject/revert mistaken receipts (Issue credit notes after invoiced Reject / Revert), Finance & Tenants, and month-end reconciliation after setup step 15. Hub parity: Common Workflows — Bulk Hostkit invoicing. Full pairing matrix: Getting Started section cross-reference.

| Symptom | Fix | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- | | Rows stay Pending / Failed for minutes | Leave batch running; refresh Transactions before re-issuing | | Persistent Failed after refresh | Confirm Listing keys + Hostkit invoice series | | Wrong invoice document date | Check Month-end invoicing (fixed date) — toggle Use today back on after batch | | Change monthly rent clamped on exported months | Invoiced floor — not Hostkit slowness | Rent reduction after invoicing |

Notification row-click navigation

Pair with other Getting Started hub sections

Row-click navigation pairs with WhatsApp per-booking messaging (New WhatsApp message from … alerts), Communication, Sales & alerts, and alert triage after setup. Hub parity: Common Workflows — Notification row-click navigation. Full pairing matrix: Getting Started section cross-reference.

SurfaceRow click
/notificationsOpens booking, tenant, listing, or property (first match on target fields)
Dashboard bell — GeneralStays in-panel unless link is set
MobileBookmark /notifications — bell is hidden
SymptomFix
Pending manual in-payment alert persistsRow-click → TransactionsApprovePending manual receipt approval
Payment overdue opened bookingContinue Handling a Late Payment — Step 1
Bell General row stayed in-panelUse /notifications for row-click triage
New WhatsApp message from … alertBell Inbox sub-tab or Tools → InboxWhatsApp per-booking messaging
Row-click opened booking, thread missingOpen Communication tab — bookingId target without link

Portfolio retirement decisions

Pair with other Getting Started hub sections

Portfolio retirement pairs with Cancel Booking vs Delete Booking (reservation void vs soft-archive), Listings & Properties, and reservation lifecycle workflows after setup step 15. Hub parity: Common Workflows — Portfolio retirement decisions. Full pairing matrix: Getting Started section cross-reference.

SituationSurfaceOutcome
Sunset a whole buildingListings → PortfolioArchiveProperty moves to Archived tab; bookings and finance history stay
Void a real stayBookingsCancel bookingCanceled filter; full Finance → Transactions history
Remove mistaken/test rowBookingsDelete BookingDrops from default lists; Manual Transactions hidden (#1897)
SymptomLikely wrong controlFix
Need refund dialog and settlement historyDelete BookingCancel bookingCancelling a Booking
Manual receipts vanished after cleanupDelete Booking on reconciled stayExpected #1897 — use CancelManual payments after Delete Booking
Building should leave pickersDelete Booking on every reservationArchive propertyArchive a property
Delete Booking blocked on OTA importPending provider platform in-paymentReject first (#2076) — Delete Booking on integration reservation
Month-end totals short after cleanupSoft-archived rows with manual receiptsPortfolio KPI review — Step 7
Listings — Archived tab with populated property cards

Bookings — Cancel booking dialog with refund types (contrast with Delete Booking) alt="Bookings list — Other filters drawer with Tenant category multi-select and one segment active" />

Finance Contract Values — Other filters drawer with Tenant category multi-select and one segment active

Wrong tenant on a booking

Pair with other Getting Started hub sections

Wrong-profile reassignment pairs with Cancel Booking vs Delete Booking (duplicate row → Delete, not Change tenant). Hub parity: Common Workflows — Wrong tenant on a booking. Full pairing matrix: Getting Started section cross-reference.

QuestionUseNot this
Wrong person on valid upcoming stayChange tenant on Contract InfoDelete Booking — reservation stays live
Duplicate import or training rowDelete BookingChange tenant — remove the row
Real stay voided under policyCancel bookingChange tenant — use refund dialog

Cancel Booking vs Delete Booking

Pair with other Getting Started hub sections

Reservation void vs cleanup pairs with Wrong tenant on a booking (Change tenant when profile link is wrong), Portfolio retirement decisions (building Archive is a third scope). Hub parity: Common Workflows — Cancel Booking vs Delete Booking. Full pairing matrix: Getting Started section cross-reference.

QuestionUseFinance → Transactions
Real stay voided under policyCancel bookingAll payment types stay visible
Duplicate import or training rowDelete BookingManual Transactions hidden (#1897)
Whole building leaves pickersArchive propertyPortfolio retirement decisionsAll booking history stays

Deposit missing on Finance Deposits

Pair with other Getting Started hub sections

Missing deposit rows pair with Finance & Tenants and check-out workflows after setup step 15. Hub parity: Common Workflows — Deposit missing on Finance Deposits. Full pairing matrix: Getting Started section cross-reference.

SituationSurfaceOutcome
Older move-out missing from FinanceFinance → Deposits toolbar date rangeClear or widen before Search — rows key off check-in, check-out, or Refund Due Date
Dispute row chips missingSame toolbar filterClear range before Mark disputed / Resolve dispute triage
Booking Deposit tab shows dataPer-booking sidebarConfirms deposit exists — widen Finance range next

Partly collected security deposit

Pair with other Getting Started hub sections

Deposit shortfalls pair with Payment allocation & invoiced floor and first-reservation workflows after setup step 15. Hub parity: Common Workflows — Partly collected security deposit. Full pairing matrix: Getting Started section cross-reference.

SituationSurfaceOutcome
Portfolio deposit shortfallsFinance → DepositsPartial paid lifecycle cardRows where Paid > 0 but < Amount
Same filter from BookingsOther filters → Deposit status → Partial paidLifecycle slice without opening Finance first
Per-booking shortfallBooking Deposit tab — Initial DepositAmber Partially paid + remaining helper
Rent schedule only partly paidPayment Plan rent linesNot the security deposit — see Handling a Late Payment — Step 1

Reject/revert mistaken receipts

Pair with other Getting Started hub sections

Receipt cleanup pairs with Finance debt receivables triage (re-check Top debtors after Revert — collections vs ledger cleanup), Pending manual receipt approval (amber Pending chip — approve legitimate rows before Revert), Payment allocation & invoiced floor, and FAQ — Reject or revert an incoming payment. Hub parity: Common Workflows — Reject/revert mistaken receipts. Full pairing matrix: Getting Started section cross-reference.

SituationActionSurface
Duplicate never approvedReject payment / Reject selectedBooking Transactions or Finance → Transactions bulk bar
Duplicate already approvedRevert paymentBooking Transactions or Finance row menu
Invoiced charge reversed in VivinIssue credit notesFinance → TransactionsNot issued credit note filter
Rent cut blocked below exported monthInvoiced floorRent reduction after invoicing — external credit notes
SymptomLikely causeFix
Delete payment disabledvIBAN / provider platform or invoiced rowRevert or Issue credit notes after invoiced reject/revert
Red / blue modal on Reject / RevertFinance already invoiced the chargeNot issued credit note filter on Finance → Transactions
Total Debt unchanged after cleanupDuplicate still pending or credit note queue openPending manual receipt approval + Finance — Issuing credit notes
Booking detail Transactions — Reject payment confirmation with red credit-note warning banner
Walkthrough: booking Transactions — open row-action confirmation modals (demo cancels without saving).

Deeper workflow reads

Modules where capabilities surface

Pair with other Getting Started hub sections

Module rows pair with Recommended Setup Sequence steps 13–15 and Modules — Module cross-reference. Permission-gated modules: FAQ — Navigation & shortcuts. Full pairing matrix: Getting Started section cross-reference.

Key glossary terms

Pair with other Getting Started hub sections