Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.etherly.app/llms.txt

Use this file to discover all available pages before exploring further.

Checkouts & Statuses

A checkout corresponds to a completed booking from Hosthub — a guest stay that has ended or is expected to end. Each checkout follows a predictable lifecycle.

Checkout lifecycle

Hosthub booking


 NEEDS_SETUP ──── (configure property) ────▶ READY

                                     (send invoice)

                               ┌───────────────┼───────────────┐
                               ▼               ▼               ▼
                             SENT     SENT_WITH_ERRORS       ERROR

Status reference

StatusColorMeaningAction required
NEEDS_SETUP🟡 YellowProperty missing required configurationComplete property setup
READY🟢 GreenReady to invoiceSend, or wait for auto-invoicing
SENT🔵 BlueDocuments issued successfullyNone
SENT_WITH_ERRORS🟠 OrangeInvoice/receipt OK, fee failedCheck error details
ERROR🔴 RedSend failed entirelyReview error message and retry
SPLIT⬜ GrayAnchor for a year-spanning bookingNot invoiceable (child checkouts are invoiced)

Automatic sync

Etherly Sync syncs with Hosthub every 5 minutes. During each sync:
  • New bookings are added immediately as checkouts
  • Changes (dates, amounts, guest info) are updated automatically
  • Cancellations are detected and those checkouts are excluded from invoicing
You can also trigger a manual sync at any time by clicking Sync Now in the dashboard.

Pause / Resume

Temporarily stop invoicing a checkout without deleting it.

Manual Pause

Click Pause next to the checkout. It stays paused through subsequent syncs — only the user can resume it with Resume.

Automatic skip via notes

If a Hosthub booking has a ##sync-skip note, the system automatically pauses the checkout during sync. Remove the note from Hosthub and the checkout will resume on the next sync.
Use ##sync-skip in Hosthub booking notes to pause checkouts without logging into Etherly Sync — ideal for property managers who primarily work in Hosthub.

Year-Boundary Split

If a booking spans two calendar years (e.g., Dec 28, 2024 → Jan 3, 2025), Etherly Sync handles the fiscal year boundary automatically:
  1. The original booking is marked SPLIT (anchor) — it is not invoiced
  2. Two child checkouts are created: one for December, one for January
  3. Each child is invoiced separately in the correct fiscal year
  4. Amounts are split proportionally (per night)
Year-Boundary Splits happen automatically. No action is required from you.
In the dashboard you can filter checkouts by:
  • Status (READY, SENT, ERROR, etc.)
  • Property
  • Date range (checkout date)
  • Paused (yes/no)