Servers Playground How we check Add a server Log in

Bookingmood MCP by usefulapi

Working · 916 ms

io.usefulapi/bookingmoodv1.0.3 Domain verified

Read Bookingmood bookings, availability, guests, payments and invoices; update bookings, contacts.

Maps & Travel

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://bookingmood.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

bookingmood_check_availability Read-only

Availability calendar of up to 5 products: per product a list of intervals {start, end, status} with status available, tentative, unavailable, booked or reserved. One request per product. GET /availability?product_id={id}.

product_idsarray, required

Product ids (UUIDs), 1-5.

show_pending_asstring

How pending (tentative) bookings count (default TENTATIVE).

Bookingmood MCP by usefulapi MCP server | mcptry

Tools (21)

bookingmood_check_availability

read-only

Argument	Type	Description
product_ids*	array	Product ids (UUIDs), 1-5.
show_pending_as	string	How pending (tentative) bookings count (default TENTATIVE).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_ids"
  ],
  "properties": {
    "product_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      },
      "maxItems": 5,
      "minItems": 1,
      "description": "Product ids (UUIDs), 1-5."
    },
    "show_pending_as": {
      "enum": [
        "TENTATIVE",
        "CONFIRMED",
        "CANCELLED"
      ],
      "type": "string",
      "description": "How pending (tentative) bookings count (default TENTATIVE)."
    }
  }
}

bookingmood_create_contact

WRITE: create ONE new contact (guest/customer) in Bookingmood. Not idempotent: calling it twice creates two contacts, so search with bookingmood_list_contacts first. No message is sent to the contact. POST /contacts.

Argument	Type	Description
zip	string
city	string
email	string
notes	string
phone	string
state	string
street	string
street2	string
language	string	Contact language, e.g. en-US or nl-NL.
province	string
last_name	string
first_name	string
company_name	string
country_code	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "zip": {
      "type": "string",
      "maxLength": 30,
      "minLength": 1
    },
    "city": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1
    },
    "email": {
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "maxLength": 254
    },
    "notes": {
      "type": "string",
      "maxLength": 5000
    },
    "phone": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1
    },
    "state": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1
    },
    "street": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "street2": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "language": {
      "type": "string",
      "pattern": "^[a-z]{2,3}(-[A-Za-z]{2,4})?$",
      "description": "Contact language, e.g. en-US or nl-NL."
    },
    "province": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1
    },
    "last_name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1
    },
    "first_name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1
    },
    "company_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "country_code": {
      "type": "string",
      "pattern": "^[A-Za-z]{2}$"
    }
  }
}

bookingmood_get_booking

One booking with everything attached: its calendar events (dates, product, status, occupancy, notes), line items, payments, invoices and the guest contacts linked to it. Five or six read requests. The guest contacts come from the booking-contact link table; if that lookup fails the reply says so instead of failing. GET /bookings, /calendar_events, /line_items, /payments, /invoices, /contact_bookings, /contacts.

read-only

Argument	Type	Description
booking_id*	string	Bookingmood booking id (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "booking_id"
  ],
  "properties": {
    "booking_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Bookingmood booking id (UUID)."
    }
  }
}

bookingmood_get_contact

One contact by id. GET /contacts?id=eq.{id}.

read-only

Argument	Type	Description
contact_id*	string	Bookingmood contact id (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "contact_id"
  ],
  "properties": {
    "contact_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Bookingmood contact id (UUID)."
    }
  }
}

bookingmood_get_organization

The Bookingmood organization this API key belongs to: name, company, plan (tier, subscription type, expiry), languages, country, VAT number, custom domain and contact details. Payment-provider ids and secrets are not returned. GET /organizations.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

bookingmood_get_product

One product by id with its capacities (guest-group min/max limits) embedded. GET /products?id=eq.{id}&select=*,capacities(*).

read-only

Argument	Type	Description
product_id*	string	Bookingmood product id (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id"
  ],
  "properties": {
    "product_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Bookingmood product id (UUID)."
    }
  }
}

bookingmood_list_bookings

List bookings, newest first: reference, method (request or book), currency, confirmed_at (null = not confirmed yet), created_at. A booking's dates and guests are on its calendar events (bookingmood_list_calendar_events) and contacts. Filter by creation date, confirmation state or reference text. The guest access secret is never returned. GET /bookings.

read-only

Argument	Type	Description
limit	integer	Rows per page, 1-100 (default 25).
method	string	'request' = booking request awaiting approval, 'book' = instant booking.
offset	integer	Rows to skip (default 0). Pass the previous reply's next_offset.
confirmed	boolean	true = only confirmed bookings, false = only unconfirmed ones.
reference	string	Text contained in the booking reference.
created_to	string	Only bookings created on or before this date.
created_from	string	Only bookings created on or after this date.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "method": {
      "enum": [
        "request",
        "book"
      ],
      "type": "string",
      "description": "'request' = booking request awaiting approval, 'book' = instant booking."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Rows to skip (default 0). Pass the previous reply's next_offset."
    },
    "confirmed": {
      "type": "boolean",
      "description": "true = only confirmed bookings, false = only unconfirmed ones."
    },
    "reference": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Text contained in the booking reference."
    },
    "created_to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Only bookings created on or before this date."
    },
    "created_from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Only bookings created on or after this date."
    }
  }
}

bookingmood_list_calendar_events

List calendar events: bookings (type 'booking'), blocked periods and notes, with product_id, booking_id, start_date, end_date, status (TENTATIVE, CONFIRMED, CANCELLED), occupancy, title and notes. Use the date filters for arrivals/departures (e.g. start_date_from = start_date_to = today lists today's arrivals) or active_on for who is in the property on a day. Ordered by start date. GET /calendar_events.

read-only

Argument	Type	Description
type	string
limit	integer	Rows per page, 1-100 (default 25).
offset	integer	Rows to skip (default 0). Pass the previous reply's next_offset.
status	string
active_on	string	Only events that cover this date (start_date <= date <= end_date).
booking_id	string	Only events of this booking.
product_id	string	Only events of this product.
end_date_to	string	end_date on or before this date (departures until).

bookingmood_list_contacts

List contacts (guests and customers): name, email, phone, company, address, language, notes. Search by name, email or company (case-insensitive, contains). Newest first. GET /contacts.

read-only

Argument	Type	Description
name	string	Text contained in the contact name.
email	string	Text contained in the email address.
limit	integer	Rows per page, 1-100 (default 25).
offset	integer	Rows to skip (default 0). Pass the previous reply's next_offset.
company	string	Text contained in the company name.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Text contained in the contact name."
    },
    "email": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Text contained in the email address."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Rows to skip (default 0). Pass the previous reply's next_offset."
    },
    "company": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Text contained in the company name."
    }
  }
}

bookingmood_list_coupons

List discount coupons: code, description, definition, quota, scope (global, product, service, rent), stackable. Deleted coupons are left out. GET /coupons.

read-only

Argument	Type	Description
limit	integer	Rows per page, 1-100 (default 25).
offset	integer	Rows to skip (default 0). Pass the previous reply's next_offset.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Rows to skip (default 0). Pass the previous reply's next_offset."
    }
  }
}

bookingmood_list_invoices

List invoices: reference, booking_id, attachment (a custom uploaded file URL, if any), created_at. Filter by booking or creation date. Newest first. GET /invoices.

read-only

Argument	Type	Description
limit	integer	Rows per page, 1-100 (default 25).
offset	integer	Rows to skip (default 0). Pass the previous reply's next_offset.
reference	string	Text contained in the invoice reference.
booking_id	string	Only invoices of this booking.
created_to	string	Created on or before this date.
created_from	string	Created on or after this date.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Rows to skip (default 0). Pass the previous reply's next_offset."
    },
    "reference": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Text contained in the invoice reference."
    },
    "booking_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Only invoices of this booking."
    },
    "created_to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Created on or before this date."
    },
    "created_from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Created on or after this date."
    }
  }
}

bookingmood_list_line_items

List invoice/booking line items: name (per language), amount and quantity (integers; the API reference does not state the unit), item_type (rent, fee...), fee_type (fee or deposit), booking_id, event_id, invoice_id. GET /line_items.

read-only

Argument	Type	Description
limit	integer	Rows per page, 1-100 (default 25).
offset	integer	Rows to skip (default 0). Pass the previous reply's next_offset.
event_id	string	Only line items of this calendar event.
booking_id	string	Only line items of this booking.
invoice_id	string	Only line items of this invoice.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Rows to skip (default 0). Pass the previous reply's next_offset."
    },
    "event_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Only line items of this calendar event."
    },
    "booking_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Only line items of this booking."
    },
    "invoice_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Only line items of this invoice."
    }
  }
}

bookingmood_list_messages

List the e-mails and SMS Bookingmood sent or scheduled to guests: subject, body, type (email or sms), status (sent, manually-scheduled, scheduled-around-arrival, scheduled-around-departure), send_at, booking_id. The rendered HTML is not returned. Latest first. GET /messages.

read-only

Argument	Type	Description
type	string
limit	integer	Rows per page, 1-100 (default 25).
offset	integer	Rows to skip (default 0). Pass the previous reply's next_offset.
status	string
booking_id	string	Only messages of this booking.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "type": {
      "enum": [
        "email",
        "sms"
      ],
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Rows to skip (default 0). Pass the previous reply's next_offset."
    },
    "status": {
      "enum": [
        "sent",
        "manually-scheduled",
        "scheduled-around-arrival",
        "scheduled-around-departure"
      ],
      "type": "string"
    },
    "booking_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Only messages of this booking."
    }
  }
}

bookingmood_list_payments

List payments (deposits, balances, offline payments): booking_id, invoice_id, amount and paid (integers; the API reference does not state the unit, normally the smallest currency unit), currency, due_at, completed_at (null = not paid), status, offline. Filter to unpaid payments, a booking or a due date. Ordered by due date, latest first. GET /payments.

read-only

Argument	Type	Description
limit	integer	Rows per page, 1-100 (default 25).
due_to	string	due_at on or before this date.
offset	integer	Rows to skip (default 0). Pass the previous reply's next_offset.
offline	boolean	true = only offline (manual) payments.
due_from	string	due_at on or after this date.
completed	boolean	true = only completed payments, false = only open ones.
booking_id	string	Only payments of this booking.
invoice_id	string	Only payments of this invoice.

Input schema (JSON)

bookingmood_list_products

List the rentable products (apartments, rooms, boats, bikes...) with name, currency, timezone, rent period (daily/nightly), booking interaction, fee and deposit. Names and descriptions are objects keyed by language ('default', 'nl-NL', ...). Images are not returned. GET /products.

read-only

Argument	Type	Description
limit	integer	Rows per page, 1-100 (default 25).
offset	integer	Rows to skip (default 0). Pass the previous reply's next_offset.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Rows to skip (default 0). Pass the previous reply's next_offset."
    }
  }
}

bookingmood_list_services

List services: the extras, fees and form fields guests can add to a booking, with label, type, fee, deposit and description. GET /services.

read-only

Argument	Type	Description
limit	integer	Rows per page, 1-100 (default 25).
offset	integer	Rows to skip (default 0). Pass the previous reply's next_offset.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Rows to skip (default 0). Pass the previous reply's next_offset."
    }
  }
}

bookingmood_list_tasks

List housekeeping/operations tasks attached to calendar events: label, due_at, completed_at (null = open), schedule (manual, arrival, departure), calendar_event_id. Filter to open tasks or a due-date window. Earliest due first. GET /tasks.

read-only

Argument	Type	Description
limit	integer	Rows per page, 1-100 (default 25).
due_to	string	due_at on or before this date.
offset	integer	Rows to skip (default 0). Pass the previous reply's next_offset.
due_from	string	due_at on or after this date.
completed	boolean	true = only completed tasks, false = only open ones.
calendar_event_id	string	Only tasks of this calendar event.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "due_to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "due_at on or before this date."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Rows to skip (default 0). Pass the previous reply's next_offset."
    },
    "due_from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "due_at on or after this date."
    },
    "completed": {
      "type": "boolean",
      "description": "true = only completed tasks, false = only open ones."
    },
    "calendar_event_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Only tasks of this calendar event."
    }
  }
}

bookingmood_search_products

Which products can be booked for a stay: for each product whether it matches the dates, guest numbers and options, its availability and a price range {min, max}. Read-only (a search; nothing is booked). occupancy maps a capacity-group id (from bookingmood_get_product capacities) to a number of guests. POST /search.

read-only

Argument	Type	Description
end	string	Departure date.
start	string	Arrival date.
occupancy	object	Map of capacity-group id (UUID) to the number of guests of that group, e.g. adults.
option_ids	array	Attribute option ids (UUIDs) the product must have.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "end": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Departure date."
    },
    "start": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Arrival date."
    },
    "occupancy": {
      "type": "object",
      "description": "Map of capacity-group id (UUID) to the number of guests of that group, e.g. adults.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      },
      "additionalProperties": {
        "type": "integer",
        "maximum": 1000,
        "minimum": 0
      }
    },
    "option_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      },
      "maxItems": 50,
      "description": "Attribute option ids (UUIDs) the product must have."
    }
  }
}

bookingmood_set_event_status

WRITE: change the status of ONE calendar event to CONFIRMED, TENTATIVE or CANCELLED. This changes what the calendar shows as available and can trigger Bookingmood's own automations for the booking (guest e-mails, tasks, payment reminders), so confirm with the user before cancelling or confirming. PATCH /calendar_events?id=eq.{id}.

destructive

Argument	Type	Description
status*	string	The new status.
event_id*	string	Calendar event id (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "event_id",
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "TENTATIVE",
        "CONFIRMED",
        "CANCELLED"
      ],
      "type": "string",
      "description": "The new status."
    },
    "event_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Calendar event id (UUID)."
    }
  }
}

bookingmood_update_contact

WRITE: change fields of ONE existing contact (only the fields you pass are changed; others stay). No message is sent to the contact. PATCH /contacts?id=eq.{id}.

destructive

Argument	Type	Description
zip	string
city	string
email	string
notes	string
phone	string
state	string
street	string
street2	string
language	string	Contact language, e.g. en-US or nl-NL.
province	string
last_name	string

bookingmood_update_event_notes

WRITE: replace the internal notes of ONE calendar event (the whole notes text is overwritten, so include the existing text if you want to keep it - read it first with bookingmood_list_calendar_events). Notes are internal; no guest is notified. PATCH /calendar_events?id=eq.{id}.

destructive

Argument	Type	Description
notes*	string	The new notes text (an empty string clears the notes).
event_id*	string	Calendar event id (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "event_id",
    "notes"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "maxLength": 5000,
      "description": "The new notes text (an empty string clears the notes)."
    },
    "event_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Calendar event id (UUID)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "type": {
      "enum": [
        "booking",
        "blocked-period",
        "blocked period",
        "note"
      ],
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Rows to skip (default 0). Pass the previous reply's next_offset."
    },
    "status": {
      "enum": [
        "TENTATIVE",
        "CONFIRMED",
        "CANCELLED"
      ],
      "type": "string"
    },
    "active_on": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Only events that cover this date (start_date <= date <= end_date)."
    },
    "booking_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Only events of this booking."
    },
    "product_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Only events of this product."
    },
    "end_date_to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "end_date on or before this date (departures until)."
    },
    "end_date_from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "end_date on or after this date (departures from)."
    },
    "start_date_to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "start_date on or before this date (arrivals until)."
    },
    "start_date_from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "start_date on or after this date (arrivals from)."
    }
  }
}

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "due_to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "due_at on or before this date."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Rows to skip (default 0). Pass the previous reply's next_offset."
    },
    "offline": {
      "type": "boolean",
      "description": "true = only offline (manual) payments."
    },
    "due_from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "due_at on or after this date."
    },
    "completed": {
      "type": "boolean",
      "description": "true = only completed payments, false = only open ones."
    },
    "booking_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Only payments of this booking."
    },
    "invoice_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "Only payments of this invoice."
    }
  }
}