avirato_list_reservations
List reservations between dates
Reservations of the establishment between two dates (reservation id, channel booking id, room, rate, guest name and document, check-in/out, price, paid and outstanding, status, notes) plus a summary of counts by status. Dates are whole days (yyyy-mm-dd) or exact date-times. GET /reservation/betweenDates.
輸入參數end_date必填start_date必填
avirato_get_reservation
Get a reservation
One reservation by the hotel's own booking id, or by a channel's booking id together with the channel (operator) id. Returns the booking(s) with guest, room, rate, dates, price, paid and outstanding amounts and status. Card data is never returned. GET /reservation/{bookingId}.
輸入參數booking_id必填operator_id
avirato_get_reservation_details
Get reservation details
Extended information of one reservation by its booking id (the reservationInfo view). Card data is never returned. GET /reservation/reservationInfo.
輸入參數booking_id必填
avirato_get_related_reservations
Get related reservations
A reservation with the other reservations of the same group (master booking and its related rooms). Card data is never returned. GET /reservation/related/{reservationId}.
輸入參數reservation_id必填
avirato_list_all_reservations
List all reservations
Every reservation of the establishment in the PMS (can be a very large list for an old hotel; prefer avirato_list_reservations with a date range). Returns `limit` entries from `offset` (default the first 100), the total count and next_offset. Card data is never returned. GET /reservation/allReservations.
輸入參數limitoffset
avirato_list_booking_channels
List booking channels
The sales channels (operators: OTAs, own website, ...) that book into the establishment, with their operator ids (used by avirato_get_reservation). GET /reservation/operators.
無需輸入參數。
avirato_check_availability
Check availability
Availability of rooms for a stay: which room types and rooms are free between check-in and check-out, optionally limited to a room category, rooms, room types or zones. GET /availability.
輸入參數zone_idsspace_idsonline_onlycheck_in_date必填space_type_idcheck_out_date必填space_subtype_idswith_valid_space_ids
avirato_list_available_spaces
List available rooms
The free rooms (spaces) of one room category between two dates. GET /availability/availableSpaces.
輸入參數end_date必填start_date必填space_type_id必填
avirato_get_unavailable_dates
Get unavailable dates of a room
The dates a room (space) is not free from a start date on, ignoring the given booking (useful to check whether a booking can be extended or moved). GET /availability/unavailable-dates.
輸入參數space_id必填booking_id必填start_date必填
avirato_get_booking_engine_overview
Get rooms, diets, extras and availability overview
The booking-engine start data between two dates: room types with descriptions and availability, meal plans (diets), taxes, extras and billing configuration. The quickest way to learn the room type, space type and rate ids of the establishment. GET /rate/init.
輸入參數end_date必填start_date必填
avirato_list_rates
List rates
The rates of the establishment (name, minimum/maximum stay, refundable, linked rate and percentage, release days, room category), optionally only some rate ids and one rate mode. GET /rate.
輸入參數moderate_ids
avirato_list_rates_by_room_category
List rates by room category
All rates of the establishment, optionally limited to some rate ids and room categories (space types). GET /rate/all.
輸入參數rate_idsspace_type_ids
avirato_get_rate
Get a rate
One rate by id: name, stay limits, refundable, linked and master rate, release days and mode. GET /rate/{rateId}.
輸入參數rate_id必填
avirato_get_price
Get the price of a stay
The final price of a stay for one room type and rate, with discounts and increments applied, for a number of adults, children, meal plan and rooms. GET /rate/getPrice.
輸入參數dietadultsrate_id必填childrenend_date必填num_roomsstart_date必填space_subtype_id必填
avirato_get_prices_map
Get a price calendar
Prices per room type and rate for each day of a period, with the establishment's taxes. GET /rate/getPricesMap.
輸入參數end_date必填rate_ids必填start_date必填space_subtype_ids必填
avirato_get_discounts
Get discounts
The discounts and increments that apply to room types and rates for a period and a number of rooms. GET /rate/discounts.
輸入參數end_date必填rate_ids必填num_roomsstart_date必填space_subtype_ids必填
avirato_list_diets
List meal plans
The meal plans (diets) of the establishment with their ids, as used by the price tools. GET /rate/diets.
無需輸入參數。
avirato_list_rate_releases
List rate release days
The release (minimum advance booking) days of each rate. GET /rate/release.
無需輸入參數。
avirato_get_minimum_stay
Get minimum stay restrictions
The minimum-stay restrictions per day for room types and rates over a period. GET /restrictions/minimum-stay.
輸入參數rate_idsfinal_date必填initial_datespace_subtype_ids
avirato_get_daily_prices
Get daily prices of a rate
The daily prices of one rate on one date (per room type and occupancy). GET /dailyPrice.
輸入參數date必填rate_id必填
avirato_list_promotional_packages
List promotional packages
The promotional packages of the establishment with their extras. GET /payment/promotionalPackages.
無需輸入參數。
avirato_add_booking_cash_payment
Record a cash payment on a booking
WRITE: records a cash payment on an existing booking in the hotel's PMS (it changes the booking's paid and outstanding amounts and cannot be undone through this server). Not idempotent: calling it twice records two payments. Confirm the booking id and the amount with the user first, then pass confirm: true. If the call fails with a network error or timeout the payment may still have been recorded: read the booking (avirato_get_reservation) and check its payments before trying again. Card payments are not supported. POST /payment/addBookingPayment.
輸入參數amount必填confirm必填datetimebooking_id必填