bookingmood_get_organization
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.
無需輸入參數。
bookingmood_list_products
List products (rentals)
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.
輸入參數limitoffset
bookingmood_get_product
Get product
One product by id with its capacities (guest-group min/max limits) embedded. GET /products?id=eq.{id}&select=*,capacities(*).
輸入參數product_id必填
bookingmood_list_bookings
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.
輸入參數limitmethodoffsetconfirmedreferencecreated_tocreated_from
bookingmood_get_booking
Get booking with details
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.
輸入參數booking_id必填
bookingmood_list_calendar_events
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.
輸入參數typelimitoffsetstatusactive_onbooking_idproduct_idend_date_toend_date_fromstart_date_tostart_date_from
bookingmood_check_availability
Check availability
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_ids必填show_pending_as
bookingmood_search_products
Search available 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.
輸入參數endstartoccupancyoption_ids
bookingmood_list_contacts
List contacts (guests)
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.
輸入參數nameemaillimitoffsetcompany
bookingmood_get_contact
Get contact
One contact by id. GET /contacts?id=eq.{id}.
輸入參數contact_id必填
bookingmood_list_payments
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.
輸入參數limitdue_tooffsetofflinedue_fromcompletedbooking_idinvoice_id
bookingmood_list_invoices
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.
輸入參數limitoffsetreferencebooking_idcreated_tocreated_from
bookingmood_list_line_items
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.
輸入參數limitoffsetevent_idbooking_idinvoice_id
bookingmood_list_coupons
List coupons
List discount coupons: code, description, definition, quota, scope (global, product, service, rent), stackable. Deleted coupons are left out. GET /coupons.
輸入參數limitoffset
bookingmood_list_services
List services (extras and fees)
List services: the extras, fees and form fields guests can add to a booking, with label, type, fee, deposit and description. GET /services.
輸入參數limitoffset
bookingmood_list_tasks
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.
輸入參數limitdue_tooffsetdue_fromcompletedcalendar_event_id
bookingmood_list_messages
List guest 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.
輸入參數typelimitoffsetstatusbooking_id
bookingmood_update_event_notes
Set calendar 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}.
輸入參數notes必填event_id必填
bookingmood_set_event_status
Set calendar event status (confirm / cancel)
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}.
輸入參數status必填event_id必填
bookingmood_create_contact
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.
輸入參數zipcityemailnotesphonestatestreetstreet2languageprovincelast_namefirst_name另有 2 個
bookingmood_update_contact
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}.
輸入參數zipcityemailnotesphonestatestreetstreet2languageprovincelast_namecontact_id必填另有 3 個