Documentation
Nerve Docs
Guides, concepts, and reference for building on Open Hotel Protocols — the open interface layer that lets AI agents and partner systems book, manage, and operate stays end to end.
Getting Started
Orient yourself and make your first Open Hotel Protocols call.
- IntroductionWhat Nerve PMS is and why it is built for the agentic era of hospitality.
- QuickstartMake your first request against the Open Hotel Protocols API.
- Sign in and find your way aroundGet into Nerve, read the two-level sidebar, and understand why your menu is built from your permissions rather than from a fixed list.
Show all 8Show fewer
- System status: is Nerve working?Read the status badge and panel: what each state means, why "not wired" is not a fault, and where to check past incidents.
- Language and appearanceRead Nerve in your own language and choose light or dark — and see why times and money keep following the property instead of you.
- Workspaces, organisations and propertiesHow an organisation, a property and your active context relate — and what changes when you switch between them mid-shift.
- Why your menu differs from a colleague'sRole, app installation and context all have to line up before a screen appears — how to tell which of the three is missing.
- Your first week on NerveA sequenced path from an empty property to a first check-in and a closed night — in the order that avoids re-doing work.
Concepts
The ideas behind Nerve and Open Hotel Protocols.
Front Desk
Arrivals, departures, the room rack, folios and payments.
- Front Desk overviewWhat lives in the Front Desk workspace, what moved to Settings and Engineering, and who can reach each part.
- Create, find, change and cancel a reservationBook one stay or a whole group, shop the rates before committing, record the terms the booking was sold on, and work it from its own page.
- The room rack: assign, move, look aheadRooms down, nights across. Choose how far ahead to look, drag a stay onto a room, and let auto-assign place a queue.
Show all 17Show fewer
- The floor plan: floors, background images and room markersThe physical-layout view a rack list can't give you — upload a floor's image, then drag rooms onto it, colour-coded by housekeeping status.
- Room categories, and the rooms behind themWhat the house sells versus what it opens the door to — how to put a room number behind a category, lend one to a second category, or build a whole unit from several.
- Guest profiles, history and merging duplicatesOne durable profile per person, so a repeat guest arrives with their history — and two profiles for one person can be folded into one.
- Guest profile detailsWho a guest is and how they were won, whether they are a VIP or blacklisted, the identity documents and scans you record at check-in, their contacts, loyalty and standing preferences.
- Check a guest inFind today's arrivals, run guided check-in with a deposit, and clear the room-readiness gate.
- Walk-insA guest arriving without a booking: one flow creates the profile, the reservation and an already-in-house stay.
- Check a guest outFind today's departures, settle the folio to zero, issue the receipt — and know what the balance gate will and will not let past.
- Take a room out of orderBlock a room for maintenance, read every block and timed job in one window, and clear it when the work is done.
- Work orders and preventive schedulesLog the work behind a broken object with its urgency, location and photos, move it through open/in progress/completed, pause it when it is blocked, and generate the preventive jobs a schedule is due for.
- Folios: post, split and transfer chargesOne account per stay, or several. Post a charge, correct one with a linked reversal, route a folio to a master bill, and settle to an invoice.
- Taking payments and issuing refundsMoney in and money back out, always against a folio rather than a stay — with the reference that makes it answerable later.
- Group bookings and master-folio routingOne reservation, several stays, one account. Open a master folio and decide, per stay, what lands on it.
- Stay-time policiesSet the house check-in and check-out clock times, override them per room category or rate plan, and leave time to turn a room.
- Set up the ancillary catalogAuthor the extras a guest can buy against a stay — late check-out, an extra bed, a transfer — with the pricing and the check each one needs.
CRS
Central reservation system — rates, availability, restrictions and the channels you sell through.
- Reservations overviewThe commercial side of the house: what you sell, at what price, with what restrictions, through which channel — and who is allowed to change it.
- Bookings from every channelEvery booking that reached the property, who collects the money — and the repair queue for the ones a missing mapping held back.
- Read the Planning gridAvailability, price and restrictions for every date on one grid — and the CRS menu names that changed with it.
Show all 10Show fewer
- Room categories and rate plansWhat a rate plan is, how a derived plan follows its parent's price, and where the catalog surfaces across the product today.
- Availability and ARI distributionQueue a rate, availability, restriction or stop-sell change over a date range and watch it reach every connected channel.
- Restrictions and stop-sellMinimum stays, closed-to-arrival and stop-sell — one set of rules that binds the direct booking widget and every OTA alike.
- Distribution settings and the availability seriesSet the booking window, cut-offs and price guards, shape what a channel is told with a rule, and read what it actually sees per night.
- Connecting a channelConnect a distribution channel, map its rooms and rates to yours, certify it, and recover anything its feed missed.
- Listings and vanity propertiesPresent one operational hotel as several OTA storefronts — a villa, a wing, a brand — each with its own room categories and channels.
- Property content has movedThis screen is gone. The description, photos, facilities and publish-to-channel controls it held are now on Settings → Hotel.
Messaging
Guest conversations and guest reviews, grouped by the person rather than the channel.
Housekeeping
Room status, readiness, and the gate it puts on check-in.
- The housekeeping overviewThe shift's whole picture on one screen: how many rooms are in each state, who is arriving and leaving, what is held out of availability, and what is still open on the floor.
- The room status boardOne tile per room: the state it is in, whether a guest is in it, how to move it from dirty to clean to inspected, and the standing requests on its occupant.
- Readiness and the check-in gateHousekeeping decides whether a room is ready; the front desk acts on it live, and a room that is not ready stops the check-in.
Show all 8Show fewer
- The rooming listToday's arrivals as the floor needs them — room, guest, arrival time, party size and standing requests — reachable without any front-desk permission at all.
- Room status discrepanciesWhen the floor finds a room in a different state from the one the desk holds, the register records both readings side by side and corrects neither until somebody decides.
- Trace notesDated reminders attached to a room. They surface on the room's own tile on the day they come due, and an open one never falls silently past its date.
- Lost & foundThe register of what was left behind: what it is, where it was found, who collected it, and when it may be disposed of. Nothing ever leaves it.
- Guest preferencesEvery open request in the house as one list — the coded ones the board already badges, and the written ask that has no catalog entry.
Accounting
The ledger, payables, receivables and the night audit.
- Accounting overview and the chart of accountsFolio activity posts to the ledger by itself. What the back office is for, who works in it, and the chart of accounts every figure lands in.
- Chart of accountsCreate, classify, arrange and retire the accounts every journal entry posts against — plus importing and exporting the whole chart as a spreadsheet.
- The ledgerA read-only book fed by the operations that caused it — the trial balance, the journal, and one folio charge traced to the entry it produced.
Show all 15Show fewer
- The outstanding folio reportEvery bill in the property carrying a balance, in one table — guest bills, master bills, ledger bills and no-show bills — with what is owed now and what will be owed at departure.
- The general cashierHouse cash that is not a guest payment — paid-outs, petty cash, floats and bank runs — recorded against a named account and a purpose that carries its own direction.
- The cash summaryThe General Cashier's consolidation: front-office cash, outlet cash and the property total — with the arithmetic behind each one shown as separate lines.
- Accounts payableA supplier bill goes draft, approved, paid — and cannot skip the middle step. Entering one and approving it are deliberately separate permissions.
- AP agingWhat the property owed each supplier on a chosen date, banded by age and grouped by supplier segment — counting approved bills only.
- Consignment settlementStock the hotel sells but does not own: the supplier record, the terms on each product, and what each consignor is owed over a period.
- Accounts receivable and the city ledgerCompany, OTA and government balances: recording what is owed, setting a credit limit, reconciling a remittance against it, and reading AR aging.
- AR aging balanceWhat each account owed the property on a chosen date, banded by age — one block per currency, with no total that spans two of them.
- Settlement bank accountsThe accounts a property settles into — masked by default, encrypted at rest, with every reveal of the full number recorded.
- Night auditClosing the property's day and rolling the business date — as a guided Pre-audit / Run / Post-audit checklist, with the report catalog and step sequence behind it.
- The Fixed Asset RegisterRegistering an asset, running depreciation for a period, and disposing of one without losing the accounting fact.
- Daily and period reportsTwo reports from one journal: a closed day's revenue and takings, and the whole book's trial balance — with the CSV export and how to reconcile them.
Sales & Catering
The sales pipeline, accounts and banquet proposals — the business a sales team books into the property it works for.
- Sales & Catering overviewA pipeline of opportunities against accounts, with configurable stages, sellable products, and a proposal that becomes a real banquet event order the moment it's accepted.
- Sales accountsThe companies and agencies a sales team sells to — who to call, why they stay, how they were won, and what each reason for stay is worth in the pipeline.
- OpportunitiesThe sales pipeline as a board of stages you own, with weighted value per stage and a conversion rate per referral source.
Revenue
Analytics, pace, forecast and rate recommendations.
- Revenue overviewOccupancy, ADR, pace and rate recommendations, all derived from bookings you already took — and the one commercial section a Manager runs end to end.
- Revenue analyticsOccupancy, ADR, RevPAR, daily trends and the source/channel/company mix for any window of nights — and the page where every metric in this section is defined.
- Forecast and paceHow the book is building against the same window last year, what was picked up recently, and where each night is forecast to finish.
Show all 9Show fewer
- Planning: budgets and forecast scenariosSplit a month into what you earned and what is still to come, then grade it against a budget version or a locked forecast scenario.
- Grain and variancePivot the book by segment, room category or booking window, and grade it against the active budget at the coarsest grain the two share.
- DemandWhat the property actually faced rather than what it sold — unconstrained demand, the outcome corpus behind cancellations and no-shows, the event calendar, and booking curves.
- Rate recommendationsAccept a bounded, forecast-driven price move and watch it reach every mapped channel in one action.
- Competitor sets and benchmarkingWho you are pricing against, and what they were charging — recorded by hand today, with the door left open for a live rate feed.
- Portfolio roll-up has movedThis screen is gone. Every property you reach, with its rooms, occupancy, ADR and revenue, is now on the portfolio home you land on after sign-in.
Protocols
Turning a hotel's operating knowledge into plays that fire on real moments, land in a person's queue, and are measured by what they caused.
- ProtocolsYour operating knowledge, written down as plays that fire on real moments, land in a person's queue, and are measured by what they actually caused.
- The queueWhere a play becomes somebody's next task: what an engagement card carries, the states it moves through, and why the desk never gets buried.
- Authoring playsWriting a protocol: the fields, why an edit mints a version instead of changing one, and what the authority envelope is actually for.
Show all 5Show fewer
- Effectiveness & the operating manualWhether a play worked, where new plays come from, and the two-register manual that keeps what the system runs and what your staff are taught from drifting apart.
- GovernanceConsent, ceilings, suppression and the kill switches — the deny-by-default checks a play passes before it is ever allowed to reach a guest.
Inventory
Stores, suppliers, purchasing, recipes and stock counts.
- Inventory overviewPurchase order to payable, and the weighted-average cost of everything on the shelf: what Inventory is for and who does which part of it.
- The stock catalog: stores and itemsStores are where stock lives and items are what the house buys — grouped two levels deep, and counted in the base unit you set here.
- Suppliers and price listsWho you buy from, the segment you classify them under, and the last price you agreed — the figure that fills in a purchase-order line by itself.
Show all 11Show fewer
- Raise a purchase orderRaise an order with its credit term and requesting department, approve it, send it, print it, and reopen a closed one when you have to.
- Purchasing spendWhat the property committed, received and still owes over a window — grouped by cost centre, by department or by supplier.
- Receive goods, and return themBook a delivery into stock, in full or in part, at the price on the order — and send back what should never have been accepted.
- Match a supplier invoiceCheck the supplier's invoice against the order and the goods, then match it to raise an already-approved bill in Payables.
- RecipesWhat a dish is made of, priced at what its ingredients cost today rather than what they cost when you wrote it down.
- Issue stock to a departmentIssue stock by item or by recipe. It depletes at weighted-average cost and books the cost of goods sold to the ledger.
- Stock countsCount a store, post the variance, and let the books agree with the shelf. A posted count is frozen — check before you press it.
- Stock valuation and reorder pointsWhat is on hand, what it is worth at weighted-average cost, whether the levels still reconcile with their own history — and the minimum each store should never drop below.
Point of Sale
Outlets, the terminal, events and settlement.
- Point of Sale overviewEvery revenue point that isn't a room — and the route that puts a restaurant check on a guest's folio instead of in a till.
- Outlets and catalogCreate the revenue points a property sells from and the items they sell — and see why an outlet's kind decides which screens it appears on.
- The terminal: opening and closing checksOpen a check, add items, fire the course, hand it to another drawer, and settle it — to a room, to an event, or to any of nine payment methods at the outlet.
Show all 10Show fewer
- The kitchen displayThe screen a prep station stands at: every course fired from the terminal, aged by colour, moved along with Start, Ready and Served.
- Events and function spacesMove an event from enquiry to closed, and hold the function spaces it needs — holds that cannot overlap, because the database will not allow it.
- The banquet plan and option cutoffsFunction spaces laid out against time so a double-booking is visible, and the queue of tentative holds coming up to their release date.
- The resource schedulerBookable resources and today's capacity sessions for a spa or an activity outlet, and why a treatment needs every resource it asks for.
- Settlement and closeRead the day's settlements, run the cashier drawer, hand a check to another drawer mid-shift, and freeze an outlet's business day for the night audit.
- Outlet reportsThe point-of-sale reporting catalog — six financial reports and four operational ones, each answering one question about what an outlet did.
- Outlet procurementThe four screens an outlet buys through — asking for something bought, drawing stock from a store, the daily perishables sheet, and the cash a market run is floated with.
Integrations
API keys, webhooks, MCP agents and the booking widget.
- Integrations overviewThe developer surface inside the product — and why none of it appears in your menu until somebody installs the Integration Hub for that property.
- Telephony: call rates, extensions & postingWhat a guest call costs, which room an extension belongs to, and how a rated call lands on that guest's folio — behind a PABX provider seam.
- Interfaces: booking-engine & rate mappingOne instance per external system, with its own pull and push rate-code mapping and its own country/currency vocabulary — the booking engine is the first one wired up.
Show all 8Show fewer
- API keysScoped credentials for the public API and MCP. The token is shown once, a key can never out-scope its creator, and revoking takes effect immediately.
- Webhooks, retries and replaySigned delivery, six retries with backoff, and a replay that re-sends the same event id — which is what makes pressing it twice cost a consumer nothing.
- MCP agentsConnect an AI agent with an API key. What it is handed is an intent — a job — not a list of endpoints, the list is filtered to what that key can do, sensitive jobs ask first, and every call lands in the audit log.
- The playgroundMint a fifteen-minute scratch key and run real API, MCP and job calls from inside the product, before you write a line of code against them.
- Embedding the direct booking widgetEmbed commission-free direct booking on your own site. The server prices it, stop-sell binds it, and the booking arrives as an ordinary reservation.
Headquarter
Cross-property BI roll-ups for portfolios that don't necessarily share an owner — a consortium or franchise reporting group.
- Headquarter overviewA cross-property roll-up for portfolios that don't share an owner — a consortium or franchise reporting group, invited by email and consented to per property.
- GroupsCreate a group and invite properties by email, from the owning side — or accept or decline an invitation addressed to your own account.
- DashboardOne card per active member property — occupancy, ADR, RevPAR and room revenue, fanned out across a group your organisation owns.
Settings
Organisation, properties, members, roles and audit.
- Settings overviewWhere an organisation is administered: its properties, its people, what each role carries, what your house calls things, and what everybody did afterwards.
- Your profile and accountYour own row in the Team roster — name, photo, department, sign-in methods, language and appearance, plus the roles and properties that are actually yours.
- Organisation settingsRename your organisation, find the id an operator needs to link to you, and see which parts of the account the Nerve team owns rather than you.
Show all 33Show fewer
- Hotel: properties, profile and policyOne screen for a property's identity, the rules it runs by, and what a channel is shown — create a property, write its description, and set photos, facilities and policy.
- OutletsThe primary place to edit an outlet's profile — name, kind, revenue centre and default currency. Point of Sale keeps quick-create; full editing lives here.
- POS ArticlesTwo-level category groups for the item picker, the modifiers and variants an article offers, and an optional charge code every article can map to for accounting.
- Charge codes, tax and billing setupEvery article the property can post, the groups a revenue report rolls up by, the tax and service rates applied to them, and the routing templates a group applies at billing time.
- Happy hour pricingTime-windowed price adjustments per outlet, resolved in the hotel's own timezone and applied the moment a line is rung up.
- Shift definitions & varianceName an outlet's expected work periods so a drawer opens against one, and see cash variance rolled up per shift.
- Table planLay an outlet's tables out on a floor plan by drag and drop, so the terminal and the scheduler can show where a table actually sits.
- Fixed asset setup: locations, groups, useful life and budgetsWhere an asset physically sits, the main/sub group it rolls up under, the useful-life policy it inherits, and the capex budget it draws against.
- Engineering: Maintenance setupThe two lists that feed a work order before it is even raised: standard repair durations and preventive maintenance schedules.
- Team: people and what they reachOne list of everybody who has access, one way to add somebody, a profile per person showing which properties their roles actually reach, and the departments they belong to.
- Procurement setupPurchase tax, spending cards for officers, a sequenced approval chain, and cost centres a purchase invoice can be split across.
- Roles and custom permission bundlesAuthor a role from the permission catalog, clone one you already have, and learn what the reserved Owner role will not let you do.
- Reference dataThe code lists your property picks from — ID document types, titles, nationalities, source regions, contact types — and how to rename, reorder and retire an entry without a deploy.
- Letters & document templatesThe operator-editable templates behind every guest-facing letter and document — organised by category, previewed per language, and test-sent before they go live.
- Printers: definitions & routingWhat your property's printers are, and what prints to each of them — kitchen tickets, folios, reports — without a developer wiring a device by hand.
- General parametersA handful of per-property operator switches that don't belong to any one module — kitchen-ticket copies, cash rounding, the default guest language.
- Roles and what each one can doThe default role bundles, what each can and cannot reach, and how role, permission and app enablement combine to decide your sidebar.
- Function spaces & banquet productsCapacity by layout, area and combinability for every banquet space — configured from Settings, still owned by Point of Sale underneath.
- Self-service setupSelf-order and self check-in, configured per outlet and per property, each shipping dark until you switch it on — plus the payment-method mapping both depend on.
- Cashless setupConnect an e-wallet/cashless provider, then map every one of its method codes to an internal payment and GL account before you reconcile a settlement file.
- e-Procurement setupConnect an external supplier marketplace, keep its catalogue in sync, and map its suppliers to your own — so a marketplace order still goes through your existing approval chain.
- Installing and enabling apps for a propertyOne switch per app, per property, self-service from the App Directory — and why an app outside your plan shows a paywall instead of an Install button.
- Agent runs, spend & limitsEvery background model call the platform makes on your behalf: what it did step by step, what it stopped to ask you, and what it cost against your plan.
- White-label: house terminologyRename Nerve's hospitality vocabulary to the words your house uses, per language. Part of the enterprise plan — and this is where Terminology went.
- Importing your dataFill one spreadsheet offline, upload it, read the cell-by-cell validation, and commit — the fastest way to bring a new property to life.
- Operator links and the delegation rosterHow one organisation's staff come to operate another organisation's hotels — invited, accepted, delegated, and revocable in one move.
- The operator portfolio has movedThis screen is gone. Today's position across every managed property is now on the portfolio home you land on after sign-in, alongside your own organisations.
- Notifications and documentsPreview what a guest receives, in their language, before they receive it — and check whether the message you thought was sent actually arrived.
- Escalation: who may ask, and who may sign offWhich money-impact actions make someone re-prove who they are, above what amount, who may request each one and who may approve it, and the verification record.
- The audit logOne chronological trail of the high-trust actions in your organisation — people, API keys and agents in the same stream, with actor, target and outcome.
Partner Portal
Portfolio, statements, payouts and white-label for affiliates.
- The partner portalThe affiliate portal is a realm of its own: a partner-only account resolves straight into it and never sees a hotel workspace.
- Realms, and accounts that hold bothHold a hotel role and a partner membership on one account and sign-in gives you a picker — plus a password prompt on the way into the portal.
- Your portfolioThe customers you earn commission on, the relationship behind each and the rate it pays — and what onboarding a new one does and does not do.
Show all 7Show fewer
- Commissions and statementsGenerate a commission statement from Nerve's settled invoices, read its snapshot lines, and reconcile it when billing moves underneath it.
- PayoutsSchedule the commission on a statement, track it to paid, and see why Nerve records a payout without ever holding your bank details.
- White-label brandingYour brand name, colour and booking domain — one configuration per partner, resolved publicly by domain so a resold site can theme itself.
- Your teamWho else may act for this partner, at which of the two roles, and the guards on inviting, promoting and revoking them.
Guides
Task-shaped walkthroughs for common integrations.
- Open a new property end to endThe order to do things in when adding a property to an existing organisation, from creating it to taking the first check-in.
- A day at the front deskWorking one shift end to end: the checks before the doors open, arrivals, in-house service, departures, and what to leave the next shift.
- Close the day: night audit checklistThe checks nothing forces you to make — unposted charges, open folios, unassigned arrivals — then closing each outlet and rolling the business date.
Show all 5Show fewer
- Go live on a new channelCatalog and content first, then connect, map and certify, then the first ARI push, the first ingested booking, and the money coming back.
- Connect an agent to your hotelSwitch the Hub on, size the key in the playground, mint it once, point an agent at the MCP endpoint, and read what it did in the ordinary audit log.