Overview

Introduction Changelog Requirements Libraries Authorization Testing the Authorization Enumerables

Endpoints

Accounts Amenities Applications Availabilities Bathrooms Bedrooms Booking Discount Codes Booking Discount Code Usages Bookings Booking Comments Bookings Fees Bookings Payments Bookings Tags Bookings Taxes Change Overs Clients Contacts Destinations Fees Fees Taxes Hosts Inbox Attachments Inbox Conversations Inbox Messages Inbox Participants Inquiries Living Rooms LOS Records Me Mid Term Rate Maps Nightly Rate Maps Payment Gateways Payments Periods Photos Rates Rates Rules Rates Tables Rentals Rental Contacts Rental Agreements Rental Cancelation Policies Rental Cancelation Policy Items Rentals Amenities ! Rentals Contents Overrides Rentals Fees Rental Link Groups Rental Links Rentals Tags Rentals Taxes Rental URLs Reviews Seasons Sources Special Offers Taxes Tax Rules

Rates

  1. Overview
  2. List rates
  3. Search rates
  4. Get a single rate

Overview

This resource represents Rates which are are pre-computed cache of the “static” pricing for a given period (defined via start_date and end_date). The are computed by applying Rates Rules on top of nightly rates that are derived either from Nightly Rate Map or a combination of Rental’s base_rate, Seasons and Periods.

The “static” means that they don’t have reference to the current day so not all Rates Rules can be applied.

For “dynamic” rates, check LOS Records endpoint.

To learn more about pricing concepts in general, check this guide.

Parameters

Name Type Read/Write Description
id Integer Read Rate’s id.
currency String Read Rate’s currency code, list of codes described in enums section.
initial_nightly_rate Decimal Read Rate’s initial nightly rate.
initial_weekly_rate Decimal Read Rate’s initial weekly rate.
initial_monthly_rate Decimal Read Rate’s initial monthly rate.
final_nightly_rate Decimal Read Rate’s final nightly rate.
final_weekly_rate Decimal Read Rate’s final weekly rate.
final_monthly_rate Decimal Read Rate’s final monthly rate.
minimum_stay Integer Read Rate’s minimum stay in days.
created_at Time Read Rate’s create time.
updated_at Time Read Rate’s update time.
start_date Date Read Rate’s start date.
end_date Date Read Rate’s end date.

Definitions

Initial rate: Rate computed before any discount.
Final rate: Rate after discounts have been applied.

List rates

List all rates for a given account(s).

GET /rates

Response

{
  "links": {
    "rates.rental": "https://www.bookingsync.com/api/v3/rentals/{rates.rental}"
  },
  "rates": [
    {
      "id": 2,
      "currency": "EUR",
      "final_monthly_rate": "2500.0",
      "final_nightly_rate": "100.0",
      "final_weekly_rate": "650.0",
      "initial_monthly_rate": "3000.0",
      "initial_nightly_rate": "100.0",
      "initial_weekly_rate": "700.0",
      "minimum_stay": 7,
      "created_at": "2023-12-11T08:26:25Z",
      "updated_at": "2023-12-11T08:26:25Z",
      "start_date": "2023-12-18",
      "end_date": "2024-08-23",
      "links": {
        "rental": 14
      }
    }
  ]
}

Search rates

Search parameters allow to filter rates by specified fields.

Example:

GET /rates?rental_id=1

Search Parameters

Name Type Default Description
rental_id String   List of comma separated IDs. Returns only rates for this rental(s)

Get a single rate

Returns a single rate identified by ID.

GET /rates/:rate_id

Response

{
  "links": {
    "rates.rental": "https://www.bookingsync.com/api/v3/rentals/{rates.rental}"
  },
  "rates": [
    {
      "id": 2,
      "currency": "EUR",
      "final_monthly_rate": "2500.0",
      "final_nightly_rate": "100.0",
      "final_weekly_rate": "650.0",
      "initial_monthly_rate": "3000.0",
      "initial_nightly_rate": "100.0",
      "initial_weekly_rate": "700.0",
      "minimum_stay": 7,
      "created_at": "2023-12-11T08:26:25Z",
      "updated_at": "2023-12-11T08:26:25Z",
      "start_date": "2023-12-18",
      "end_date": "2024-08-23",
      "links": {
        "rental": 14
      }
    }
  ]
}