Tools

List Room Types

List room types (unit groups) for a property. Returns room type names, descriptions, max occupancy, and associated rate plans. Useful for understanding the room inventory structure.

List Reservations

Search and list reservations across properties. Filter by property, status, dates, room types, or text search. Returns paginated results with guest, room, and pricing details.

List Blocks

List room blocks for a property. Blocks reserve a set of rooms for group bookings. Filter by property, group, status, or date range. Returns block details including allocated rooms and pick-up status.

List Properties

List all properties (hotels/apartments) in the account. Returns each property's ID, name, location, and status. Use this to discover available properties before querying other resources.

Manage Folio

Perform operations on a guest folio: **post a charge** (e.g., minibar, restaurant), **post a payment**, **post a refund**, or **close** the folio. Commonly used by POS systems to charge services to a guest's room.

List Units

List rooms (units) for a property. Filter by room type, occupancy status, condition (clean/dirty/inspected), or maintenance state. Useful for housekeeping and room management workflows.

List Rate Plans

List rate plans for a property. Rate plans define pricing rules and policies for reservations. Filter by property, room type, or distribution channel. Returns plan details including pricing model and restrictions.

Create Booking

Create a new booking with one or more reservations. A booking groups reservations under a single booker. Each reservation represents a separate room stay. Supports rate plan assignments, guest details, corporate codes, and pre-payments.

List Folios

List guest folios filtered by property, reservation, or booking. Returns balance, charges, and payment summaries. Use this to find a guest's folio before posting charges or creating invoices.

Manage Company

Create, update, delete, or list company profiles. Companies can be linked to reservations for corporate bookings. Supports searching by text and filtering by property.

Manage Invoice

Create, cancel, or mark invoices as paid. To **create** an invoice, provide a folioId. To **cancel** or **mark as paid**, provide the invoiceId. Also supports retrieving a specific invoice by ID.

Trigger Night Audit

Trigger a night audit for a property. Night audit closes the current business day and processes end-of-day operations including posting daily charges, updating reservation statuses, and advancing the business date.

Search Offers

Search for available room offers for a specific property, dates, and guest configuration. Returns available rate plans with pricing, room type details, and availability. Use this to find what's available before creating a booking.

Get Reservation

Retrieve full details of a specific reservation by its ID. Returns comprehensive information including guest details, stay dates, room assignment, pricing, services, and current status.

Change Room Condition

Update the housekeeping condition of a room (unit). Set a room to Clean, Dirty, or CleanToBeInspected. Commonly used by housekeeping apps to update room status after cleaning.

Manage Reservation

Perform lifecycle actions on a reservation: **amend** stay details (dates, guests, rate plan), **cancel**, **check-in**, **check-out**, **no-show**, **assign room**, or **unassign room**. Choose the action and provide relevant parameters.