Rates Calendar

Overview

The Rates Calendar endpoint returns room rate information for the requested date range. The response is grouped by room type and includes details such as the room type ID, name, company ID, and code. Each room type contains a list of room rates with their identifiers, names, rate values, and associated date records.

Each date record includes an index, date, and price value, which may be null when no price is available. This endpoint is commonly used to review room rates across multiple dates and support rate calendar and pricing management.

Request Endpoint

• HTTP Method: POST
• Secure URL Path: {{base_url}}/api/reservation/rates_calendar

Payload Construction and Schema Definition

The request payload is submitted as form-data fields.

Request Body Fields

Field	Type	Required	Description	Example
start_date	string	Yes	Start date (YYYY-MM-DD) for the report.	2026-07-01
end_date	string	Yes	End date (YYYY-MM-DD) for the report.	2026-07-01

Response Body Fields

Field	Type	Always present	Description
error	boolean	Yes	Indicates whether the request failed. false means success.
status	string	Yes	Status string. On success the example returns "ok".
message	string	Yes	Human-readable message. Often empty on success.
data	array<object>	Yes (on success)	Array of rates calendar objects.

Response data Fields

Field	Type	Description	Example
id	string	Id of room type.	02186030-...
name	string	Name of room type.	Superior One Bedroom Garden Villa With Private Hea
company_id	string	Company ID.	88f4e090-...
code	string	Code of room type.	Superior One Bedroom Garden Villa With Private Heated Pool
room_rate	array of object	List of room rate object (see below)	[ ... ]

Response data.room_rate Fields

Field	Type	Description	Example
id	string	Id of room rate.	0803d680-...
name	string	Name of room rate.	every tommorow night ( package ) ( Superior One Bedroom Garden Villa With Private Hea )
rates_id	string	Rates ID.	08036300-...
rates	number	Rates of room rate.	0
dates	array of object	List of dates object (see below)	[ ... ]

Response data.room_rate.dates Fields

Field	Type	Description	Example
index	number	Position.	0
date	string	Date.	2026-07-01
price	string	Price (nullable)..	null

Expected System Responses

The system responds with HTTP 200 OK.

{
    "error": false,
    "status": "ok",
    "message": "",
    "data": [
        {
            "id": "02186030-434c",
            "name": "Superior One Bedroom Garden Villa With Private Hea",
            "company_id": "88f4e090-b33f",
            "code": "Superior One Bedroom Garden Villa With Private Heated Pool",
            "room_rate": [
                {
                    "id": "0803d680-927f",
                    "name": "every tommorow night ( package ) ( Superior One Bedroom Garden Villa With Private Hea )",
                    "rates_id": "08036300-927f",
                    "rates": 0,
                    "dates": [
                        {
                            "index": 0,
                            "date": "2026-07-01",
                            "price": null
                        }
                    ]
                }
            ]
        }
    ]
}