Room Statistic

Overview

The statistic module synchronizes room inventory, occupancy, arrival, departure, and revenue statistics for an existing company. The company must already exist before statistic data is synchronized.

Request

• Method: POST
• Path: {{base_url}}/api/sync-room-inventory

Request Envelope

The Statistic module uses the standard Open API request envelope with statistic as the module and an array of statistic records as data.

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

For details on when to use sync modules versus initialization_* modules, see Module Behavior.

Request Body Fields

Field	Type	Required	Description	Example
company_id	string	Yes	Company identifier.	COMP-001
transaction_date	date	yes	Date the statistic applies to.	2026-08-01
room_type_id	string	yes	Room type identifier.	RT-DELUXE
room_type_name	string	Optional	Room type name.	Deluxe Room
total_room	number	Yes	Total rooms.	20
total_os	number	Yes	Rooms out of service.	1
total_oo	number	Yes	Rooms out of order.	0
total_hu	number	Yes	House-use rooms.	0
total_complimentary	number	Yes	Complimentary rooms.	0
total_room_sold	number	Yes	Total rooms sold.	14
no_of_complimentary	number	Optional	Number of complimentary rooms.	0
total_arrival	number	Yes	Total arrivals.	5
total_departure	number	Yes	Total departures.	3
total_arr	number	Optional	Average room rate.	892857.14
total_revpar	number	Optional	Revenue per available room.	625000
total_revenue	number	Optional	Total revenue.	12500000
total_person	number	Optional	Total guests.	24
total_adult	number	Optional	Total adults.	20
total_child	number	Optional	Total children.	4
total_occ	number	Optional	Occupancy.	70
double_occupancy	number	Optional	Double occupancy.	4
total_arrival_adult	number	Optional	Adult arrivals.	8
total_arrival_child	number	Optional	Child arrivals.	2
total_departure_adult	number	Optional	Adult departures.	6
total_departure_child	number	Optional	Child departures.	1
total_cancel	number	Optional	Total cancellations.	1
total_no_show	number	Optional	Total no-shows.	0
total_reservation	number	Optional	Total reservations.	12

Request Example

{
  "module": "statistic", 
  "data": [
    {
      "company_id": "COMP-001",
      "room_type_id": "RT-DELUXE",
      "transaction_date": "2026-08-01",
      "total_room": 20,
      "total_room_sold": 14,
      "total_os": 1,
      "total_oo": 0,
      "total_hu": 0,
      "total_complimentary": 0,
      "total_arrival": 5,
      "total_departure": 3,
      "total_revenue": 12500000,
      "total_reservation": 12
    }
  ],
  "chunk_metadata": {
    "process_id": "sync-comp001-2026-08-01",
    "chunk_sequence": 1,
    "is_last_chunk": true,
    "total_records_in_chunk": 1
  }
}