Getting Started
Core Concepts & Terminology
The vocabulary this documentation, and the product itself, uses everywhere.
These are the building blocks nearly every other page assumes you already know. Skim it once — you'll recognize the names constantly afterward.
People and organizations
- Customer — a single real person. Every person who has ever booked a
room, bought a day pass, signed a lease, or even just submitted a lead
form is exactly one
Customerrecord, matched by email. A guest checkout and a later portal sign-up with the same email link to the same Customer — never a duplicate. - Company — a business entity that groups customers together for shared billing or shared access: a shared day-pass pack, a shared office-lease seat pool, or a billing contact who pays on everyone's behalf. Not every customer belongs to a company.
- Lead — a
CustomerwhosestatusisLEAD: someone who has expressed interest (a "learn more" form, a guided inquiry) but hasn't become a paying customer yet. Leads live on the CRM pipeline board. A customer's status can also beACTIVE(a real paying customer) orFORMER(someone who was active but no longer is) — aFORMERcustomer can be reactivated straight back toACTIVEwithout losing their history. - Staff member — an internal team member with a role:
OWNER,ADMIN, orFRONT_DESK. Staff accounts are entirely separate from customer accounts (see Roles & Accounts).
What gets sold
- Resource — a physical, bookable thing at the location: a meeting
room (
MEETING_ROOM, booked by the hour) or a private office (PRIVATE_OFFICE, leased by the month). Each has its own rate, capacity, amenities, and photos. - Product — a sellable item that isn't a physical resource: a day pass, a day-pass multi-pack, a registered/virtual office plan, or a store item. Products have prices; resources have rates.
- Booking — one reservation of a meeting room for a specific time
window. A recurring series of bookings shares a
BookingSeries; several bookings checked out together in one cart share aBookingGroup. - Day pass — a single day's access, sold individually or in a
DayPassPack(a multi-use bundle, which can also be shared across a company). - Office lease (
OfficeLease) — a private office rental: month-to-month or fixed-term, billed monthly or paid in full upfront. Comes with a monthly meeting-room credit allowance. - Registered office account — a mail/virtual-office subscription tied to a real USPS Form 1583 compliance record and a PMB (Personal Mailbox) number.
Money
- Invoice — the record of a charge, made up of one or more InvoiceLineItems (each pointing back at what it's for — a booking, a day pass, an office lease, etc.). Every real charge in the system has an invoice behind it, even instant card payments.
- Payment — a specific attempt to collect an invoice, by card, ACH, cash, or check. An invoice can have more than one payment (a failed attempt followed by a successful retry).
- Refund — always tied to a specific payment, never a bare "give money back." Refunds above the location's configured threshold require a second staff member's approval (see Approvals).
- Membership credit / meeting-room credit — free meeting-room hours included with an office lease or registered-office plan, drawn down automatically before any card is charged.
Oversight
- PendingApproval — a "propose now, a higher tier decides later" gate used for refunds over threshold, invoice voids, weekend staff bookings, staff invites/role changes, and large proposal discounts. See Approvals.
- AuditLog — a permanent record of who did what, when, to what. Every action that touches money or access writes one of these, and it's never edited or deleted.
- CommunicationLog — a record of every email actually sent (or deliberately suppressed), which template, and whether it succeeded.
Compliance
- Form 1583 — the real USPS form required to receive mail on someone's behalf. A registered-office signup isn't complete until this is filled out, notarized, and the customer's photo ID is on file.
- PMB (Personal Mailbox) — the mailbox number assigned to a registered office account once its 1583 is approved. Never assigned before that.
- Authorized Individual — a second person a registered-office customer can name as allowed to receive their mail, with their own (lighter) 1583 section.