Room Revenue

Overview

Returns detailed room revenue records for the requested date range, providing a clear view of revenue generated from room sales. Each row links room charges, discounts, taxes, service charges, commissions, and net room revenue to the related reservation, folio, room, rate plan, guest, and stay dates. The response supports revenue reconciliation, financial reporting, and performance analysis, while optional filters allow the dataset to be narrowed by agent, room, guest, market segment, reservation source, and geographic area.

Request Endpoint

• Method: POST
• Path: {{base_url}}/api/reports/room-revenue

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-24

Response Body Fields

Field	Type	Always present	Description
error	boolean	Yes	Indicates whether the request failed.
status	string	Yes	Status string. On success returns e.g. "ok".
message	string	Yes	Human-readable message. Often empty on success.
data	array of object	Yes (on success)	List of room revenue rows.

Response data[] Fields

Field	Type	Description	Example
reservation_detail_id	string	Reservation_detail_id.	a7caa090-...
main_folio	string	Main folio ID.	a7caa960-...
folio_no	number	Folio number.	1742
dates	string	Date of room revenue (YYYY-MM-DD).	2026-07-02
room_name	string	Room name.	Room Family1
room_type_name	string	Room type name (nullable).	Family Suite
company_name	string	Company name.	Aditya Villas
room_id	string	Room ID.	4fd8e320-...
room_type_id	string	Room type ID (nullable).	bab17430-...
na_status	number	Night audit	1
name	string	Guest name.	kocong
account_id	string	Account ID	7a821c40-...
agent_name	string	Agent name..	Aditya Agent
arrival_date	string	Arrival date (YYYY-MM-DD).	2026-07-02
departure_date	string	Departure date (YYYY-MM-DD).	2026-07-03
extended_date	string	Extended departure date (YYYY-MM-DD).	2026-07-03
person	number	Number of persons.	1
account_name	string	Account name.	4.1.01.05 - Aditya Revenue
remark	string	Transaction type.	Room Charge
company_id	string	Company ID.	757beb40-...
eom_id	number	ID period.	null
created_by	string	User who created the record.	gusadi
total_amount	number	Total room charge amount.	2840000
price_amount	number	Total room charge amount.	2840000
service_amount	number	Total service charge amount.	ef084830-...
taxes_amount	number	Total taxes on room charge.	258181-...
commission_amount	number	Total commission on room charge.	0
discount_amount	number	Empty.	0
revenue	number	Total room charge equals taxes service equals total commission.	2347107-...
reservation_rates_type	string	Reservation rate transaction type.	room charge

Expected System Responses

The system responds with HTTP 200 OK.

{
  "error": false,
  "status": "ok",
  "message": "",
  "data": [
    {
      "reservation_detail_id": "a7caa090-75f4-11f1",
      "main_folio": "a7caa960-75f4-11f1",
      "folio_no": 1742,
      "dates": "2026-07-02",
      "room_name": "Room Family1",
      "room_type_name": "Family Suite",
      "company_name": "Aditya Villas",
      "room_id": "4fd8e320-366b-11ea",
      "room_type_id": "bab17430-c4df-11ea",
      "na_status": 1,
      "name": " kocong ",
      "account_id": "7a821c40-c5a3-11ea",
      "agent_id": "418fc520-bbc6-11ec",
      "agent_name": "Aditya Agent",
      "arrival_date": "2026-07-02",
      "departure_date": "2026-07-03",
      "extended_date": "2026-07-03",
      "person": 1,
      "account_name": "4.1.01.05 - Aditya Revenue",
      "remark": "Room Charge",
      "company_id": "757beb40-3669-11ea",
      "eom_id": null,
      "created_by": "gusadi",
      "total_amount": 2840000,
      "price_amount": 2840000 ,
      "service_amount": 234710.74380165292,
      "taxes_amount": 258181.8181818182,
      "commission_amount": 0,
      "discount_amount": 0,
      "revenue": 2347107.4380165287,
      "reservation_rates_type": "room charge"
      } 
   ]
}