Rates

Overview

The rates module synchronizes rate master data for a company. This module depends on company. The referenced company_id must already exist, so the corresponding company must be synchronized first.

Request

• Method: POST
• Path: {{base_url}}/api/sync-master-data

Request Envelope

The Rates module uses the standard Open API request envelope with rates as the module and an array of rate objects as data.

{
  "module": "rates",
  "data": [
    {}
  ],
  "chunk_metadata": {}
}

Request Body Fields

Field	Type	Required	Description	Example
id	string	Yes	Rate identifier.	RATE-01
company_id	string	Yes	Identifier of the company the rate belongs to. The company must already exist.	HTL-001
name	string	Yes	Rate name.	Best Available Rate
start_date	string	Yes	Start date of the rate in YYYY-MM-DD format.	2026-09-01
end_date	string	Yes	End date of the rate in YYYY-MM-DD format.	2026-12-31
taxes_pct	number	Yes	Tax percentage applied to the rate.	10
service_pct	number	Yes	Service percentage applied to the rate.	5
include_extra_bed	boolean	Yes	Boolean-ish value indicating whether an extra bed is included.	false
include_breakfast	boolean	Yes	Boolean-ish value indicating whether breakfast is included.	true
minimum_night	number	Yes	Minimum night requirement for the rate.	1
maximum_stay	number	Yes	Maximum stay allowed for the rate.	30
guest_include_in_rate	number	Yes	Number of guests included in the rate.	2
guests_max_in_rate	number	Yes	Maximum number of guests allowed in the rate.	4
type	string	Yes	Rate type.	ROOM_ONLY
is_package	boolean	Yes	Boolean-ish value indicating whether the rate is a package.	false
is_active	boolean	Yes	Boolean-ish value indicating whether the rate is active.	true
open_rate	boolean	Yes	Boolean-ish value indicating whether the rate is open rate.	true

Request Example

{
  "module": "rates", 
  "data": [
    {
      "id": "RATE-01",
      "company_id": "HTL-001",
      "name": "Best Available Rate",
      "start_date": "2026-09-01",
      "end_date": "2026-12-31",
      "taxes_pct": 10,
      "service_pct": 5,
      "include_extra_bed": false,
      "include_breakfast": true,
      "minimum_night": 1,
      "maximum_stay": 30,
      "guest_include_in_rate": 2,
      "guest_max_in_rate": 4,
      "type": "ROOM_ONLY",
      "is_package": false,
      "is_active": true,
      "open_rate": true
    }
  ],
  "chunk_metadata": {
    "process_id": "sync-htl001-2026-08-30",
    "chunk_sequence": 1,
    "is_last_chunk": true,
    "total_records_in_chunk": 1
  }
}