Skip to main content

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

FieldTypeRequiredDescriptionExample
company_idstringYesCompany identifier.COMP-001
transaction_datedateOptionalDate the statistic applies to.2026-08-01
room_type_idstringOptionalRoom type identifier.RT-DELUXE
room_type_namestringOptionalRoom type name.Deluxe Room
total_roomnumberYesTotal rooms.20
total_osnumberYesRooms out of service.1
total_oonumberYesRooms out of order.0
total_hunumberYesHouse-use rooms.0
total_complimentarynumberYesComplimentary rooms.0
total_room_soldnumberYesTotal rooms sold.14
no_of_complimentarynumberOptionalNumber of complimentary rooms.0
total_arrivalnumberYesTotal arrivals.5
total_departurenumberYesTotal departures.3
total_arrnumberOptionalAverage room rate.892857.14
total_revparnumberOptionalRevenue per available room.625000
total_revenuenumberOptionalTotal revenue.12500000
total_personnumberOptionalTotal guests.24
total_adultnumberOptionalTotal adults.20
total_childnumberOptionalTotal children.4
total_occnumberOptionalOccupancy.70
double_occupancynumberOptionalDouble occupancy.4
total_arrival_adultnumberOptionalAdult arrivals.8
total_arrival_childnumberOptionalChild arrivals.2
total_departure_adultnumberOptionalAdult departures.6
total_departure_childnumberOptionalChild departures.1
total_cancelnumberOptionalTotal cancellations.1
total_no_shownumberOptionalTotal no-shows.0
total_reservationnumberOptionalTotal 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
}
}