Overview

This endpoint allows the <<glossary:Agent>> to create a new rate set for a unit. A rate set defines the pricing and availability settings for specific periods within a unit's calendar. With the Create Rate Set endpoint, API Users can easily define customized rate sets as agreed upon with the supplier.

Endpoints Available

Body Parameters

📘

weekly_daily_monthly

This parameter determines the interval type to be used within the Rate Set. The values to be used are:

0: Weekly
1: Daily
2: Monthly

"rate_Bands" Object Body Parameters

📘

Arrival/Departure Day Restrictions - Bitwise Representation

In this specific representation, Monday serves as the starting point, and each day of the week is assigned a unique bit position as follows:

Day	Bit Position	Byte
Monday	0	1
Tuesday	1	2
Wednesday	2	4
Thursday	3	8
Friday	4	16
Saturday	5	32
Sunday	6	64

To determine the arrival/departure day restrictions for a property, the relevant bit positions are set to 1 to indicate the allowed days and 0 to indicate the restricted days.

Examples:

1. If a property allows arrival and departure on Monday, Wednesday, and Sunday, the bitwise representation would be 1 + 4 + 64 = 69
2. If a property allows arrival and departures on Tuesday, Wednesday, and Sunday, the bitwise representation would be 2 + 4 + 64 = 70
3. For a property that restricts arrivals and departures on Monday, Friday, and Saturday, the bitwise representation would be 2 + 4 + 8 + 64 = 78
4. If a property allows check-ins and check-outs on all days, the bitwise representation would be
   1 + 2 + 4 + 8 + 16 + 32 + 64 = 127

Sample Request

curl --request POST \
     --url 'https://api.ciiruspartners.com/v2024.07.31/ratesets' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Basic {APIUsername:APIPassword}' \
     --data '{
  "rate_set_id": 72024,
  "management_company_user_id": 42330,
  "set_name": "3-bedroom standard",
  "weekly_daily_monthly": 1,
  "includes_tax": false,
  "days_in_month": 30,
  "based_on_arrival_date_band_only": false,
  "currency": "USD",
  "minimum_nightly_rate": 0,
  "rate_bands": [
    {
      "rate_band_id": 348421989,
      "property_id": 219264,
      "date_from": "2018-01-01T00:00:00",
      "date_to": "2029-12-31T00:00:00",
      "us_rate": 0,
      "rate_set_id": 72024,
      "minimum_nights_stay": 3,
      "arrival_days": 127,
      "floor_rate": 120,
      "daily_rate": 100,
      "monthly_rate": 0,
      "departure_days": 127,
      "season_name": "Standard Season",
      "maximum_nights_stay": 0
    }
  ]
}'

Sample Response

{
  "id": 72024,
  "set_name": "3-bedroom standard",
  "management_company_user_id": 42330,
  "created_at": "2024-07-31T12:00:00Z",
  "status": "created"
}