Rates

Overview

This resource represents Rates - a resource for storing the price-related data for Rentals. Rates are generated based on the price-related resources (such as Rates Rules, Seasons, Periods) for Rentals. They 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.

Initial Rate

The initial rate is the base rate before any discounts or adjustments are applied.

Final Rate

The final rate is the rate after all discounts and adjustments have been applied.

Parameters

OAuth Scopes:

public

Name	Type	Read/Write	Description	Constraints
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

OAuth Scopes:

public

response.json

{
  "links": {
    "rates.rental": "https://www.bookingsync.com/api/v3/rentals/{rates.rental}"
  },
  "rates": [
    {
      "links": {
        "rental": 14
      },
      "id": 2,
      "currency": "EUR",
      "start_date": "2025-04-21",
      "end_date": "2025-04-28",
      "initial_nightly_rate": "100.0",
      "initial_weekly_rate": "700.0",
      "initial_monthly_rate": "3000.0",
      "final_nightly_rate": "100.0",
      "final_weekly_rate": "650.0",
      "final_monthly_rate": "2500.0",
      "minimum_stay": 7,
      "created_at": "2025-03-31T17:52:11.747Z",
      "updated_at": "2025-04-07T17:52:11.747Z"
    }
  ]
}

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

OAuth Scopes:

public

response.json

{
  "links": {
    "rates.rental": "https://www.bookingsync.com/api/v3/rentals/{rates.rental}"
  },
  "rates": [
    {
      "links": {
        "rental": 14
      },
      "id": 2,
      "currency": "EUR",
      "start_date": "2025-04-21",
      "end_date": "2025-04-28",
      "initial_nightly_rate": "100.0",
      "initial_weekly_rate": "700.0",
      "initial_monthly_rate": "3000.0",
      "final_nightly_rate": "100.0",
      "final_weekly_rate": "650.0",
      "final_monthly_rate": "2500.0",
      "minimum_stay": 7,
      "created_at": "2025-03-31T17:52:11.750Z",
      "updated_at": "2025-04-07T17:52:11.750Z"
    }
  ]
}