list_vouchers
List Vouchers
Lists vouchers with optional filtering by rental dates, resource, and code prefix. Returns voucher details including usage counts and discount values.
list_vouchers
Lists vouchers with optional filtering by rental dates, resource, and code prefix. Returns voucher details including usage counts and discount values.
modify_user
Modifies an existing user's personal details, contact info, custom properties, and account flags. Identify the user by ID or email.
record_payment
Records a payment against a reservation. Specify the payment method, status, amount, and a unique transaction identifier. **Payment modes**: 2=Cash, 3=Cheque, 4=Bank transfer, 5=Other, 6=Gift certificate, 9=Discount, 10=Credit card on file, 1=PayPal. **Payment statuses**: 1=Successful, 2=Pending, 3=Error, 4=Refund.
list_reservations
Searches and lists reservations within a time period. Filter by resource, customer, status, modification date, and custom properties. Supports pagination (up to 500 per page).
modify_reservation
Modifies an existing reservation. Can change the resource, time period, quantity, assigned user, and custom form fields. By default, the price is recalculated after modifications.
create_user
Creates a new customer user or updates an existing user's custom properties. If a user with the given email already exists, their custom properties and personal details are updated (login credentials remain unchanged).
reservation_action
Performs an administrative action on a reservation such as confirming, cancelling, checking in/out, marking as no-show, or other status changes. Available actions: **Confirm**, **Cancel** (admin cancel), **User_cancel** (customer cancel), **Checkin**, **Checkout**, **Noshow**, **Clear_checkin**, **Clear_noshow**, **Unconfirm**, **Uncancel**, **Lock**, **Unlock**, **Preapprove**, **Verify**, **Mark_as_quote**, **Promote** (from waitlist).
list_resources
Lists bookable resources with optional filtering by publish status, resource type, and custom properties. Supports pagination (up to 100 per page).
create_voucher
Creates a new voucher (discount code) that customers can apply to reservations. Supports percentage or fixed-amount discounts, resource restrictions, and date limitations.
list_users
Searches and lists customer users with filtering by name, email, location, and custom properties. Supports wildcard search using `*` character. Paginated results (up to 1000 per page).
get_resource_usage
Retrieves usage (occupancy) data for a resource or all resources over a date range. Returns grouped time periods with the number of units occupied in each period. Useful for understanding booking density and remaining availability.
get_resource
Retrieves detailed information about a single bookable resource including availability settings, pricing, booking rules, photos, properties, and admin details.
list_payments
Lists payments within a date range. Can filter by resource and payment method. Returns payment details including amount, status, customer info, and associated reservation.
check_availability
Checks whether a reservation can be made for a resource during a given time period. Uses the comprehensive `can_make_reservation` check which considers all booking constraints (not just availability). Optionally returns the calculated price.
get_user
Retrieves detailed information about a customer user by ID or email, including personal details, contact info, custom properties, and reservation count.
get_rental_price
Calculates the rental price for a resource given a time period, quantity, and optional voucher code. Returns the total price along with a breakdown of applied pricing rules and products.
get_site_info
Retrieves site-level information including name, category, timezone, admin email, custom resource property definitions, and photos.
get_reservation
Retrieves complete details of a single reservation including customer info, pricing, payments, custom properties, additional products, and activity log.
delete_reservation
Permanently deletes a reservation. **This cannot be undone.** For non-permanent removal, use the Reservation Action tool with action "Cancel" instead.
create_reservation
Creates a new reservation for a bookable resource. Specify the resource, time period, quantity, and customer details (either by providing an existing user ID or by supplying email and name). Supports custom form fields, voucher codes, pricing overrides, and shopping cart grouping.
Create, modify, cancel, and search reservations for bookable resources such as vacation properties, car rentals, hotels, equipment, and event spaces. Manage resource availability, vacations, and weekly schedules. Configure pricing rules, calculate rental prices, and handle seasonal pricing. Record and track payments against reservations. Create and manage customers, assign roles, and search users by custom properties. Define additional products, coupons, and vouchers for reservations. Generate invoices, send customer emails, and sync availability via iCal feeds. Manage site and meta-site settings, notification templates, and webhook callbacks for reservation lifecycle, payment, check-in/check-out, and scheduling events.
Common questions about connecting Planyo Online Booking to AI agents with Metorial.