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
Status reference
| Status | Color | Meaning | Action required |
|---|---|---|---|
NEEDS_SETUP | 🟡 Yellow | Property missing required configuration | Complete property setup |
READY | 🟢 Green | Ready to invoice | Send, or wait for auto-invoicing |
SENT | 🔵 Blue | Documents issued successfully | None |
SENT_WITH_ERRORS | 🟠 Orange | Invoice/receipt OK, fee failed | Check error details |
ERROR | 🔴 Red | Send failed entirely | Review error message and retry |
SPLIT | ⬜ Gray | Anchor for a year-spanning booking | Not 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
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.
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:- The original booking is marked SPLIT (anchor) — it is not invoiced
- Two child checkouts are created: one for December, one for January
- Each child is invoiced separately in the correct fiscal year
- Amounts are split proportionally (per night)
Year-Boundary Splits happen automatically. No action is required from you.
Filtering & Search
In the dashboard you can filter checkouts by:- Status (READY, SENT, ERROR, etc.)
- Property
- Date range (checkout date)
- Paused (yes/no)
