Skip to main content

Daily Summary

Overview​

Provides a single-day operational snapshot for the property on the requested report_date. The response includes room and guest statistics (rooms sold and available, occupancy percentage, pax counts, complimentary rooms), a room revenue summary (average room rate and RevPAR with commission adjustments where applicable), and a breakdown of rooms sold and room revenue by reservation source/agent.

Request Endpoint​

  • Method: POST
  • Path: {{base_url}}/api/reports/daily-summary

Payload Construction and Schema Definition​

The request payload is submitted as form-data fields.

Request Body Fields​

FieldTypeRequiredDescription
report_datestringYesDate for the report (YYYY-MM-DD).

Response Body Fields​

FieldTypeAlways presentDescription
errorbooleanYesIndicates whether the request failed.
statusstringYesStatus string. On success returns e.g. "ok".
messagestringYesHuman-readable message. Often empty on success.
dataobjectYes (on success)Daily summary object.

Response data Fields​

FieldTypeDescriptionExample
datestringReport date (YYYY-MM-DD).2023-01-17
statisticsobjectRoom and guest statistics (see below).{...}
roomRevenueobjectRoom revenue summary (see below).{...}
reservationAgentarray of objectsBreakdown by reservation agent (see below).[...]

Response data.statistics Fields​

FieldTypeDescriptionExample
totalRoomnumberTotal number of rooms.16
roomSoldnumberNumber of rooms sold.3
roomSoldPercentobjectOccupancy percent (see below).{...}
roomAvailablenumberNumber of rooms available.12
noOfAdultnumberNumber of adult guests.8
noOfChildrennumberNumber of child guests.2
noOfPaxnumberTotal number of guests (adults + children).10
complimentarynumberNumber of complimentary rooms.1

Response data.statistics.roomSoldPercent Fields​

FieldTypeDescriptionExample
valuenumberFractional value (0-1).0.19
formattedStringstringFormatted percent string.18.75%
percentValuenumberPercent value (0-100).18.75

Response data.roomRevenue Fields​

FieldTypeDescriptionExample
codestringRevenue code.RR
namestringRevenue name.Room Revenue
averageRoomRatenumberAverage room rate.782369.15
averageRoomRateLessCommissionnumberAvg. room rate after commission.782369.15
revParnumberRevenue per available room.146694.21
revParLessCommissionnumberRevPAR after commission.146694.21
commissionnumberTotal commission.0
amountnumberTotal room revenue.3500000
amountLessCommissionnumberRoom revenue after commission.3500000

Response data.reservationAgent Fields​

FieldTypeDescriptionExample
codestringReservation source code.S4
namestringReservation source name.Online Travel Agent
roomRevenuenumberRoom revenue for this agent.2347107.44
roomRevenueLessCommissionnumberRoom revenue after commission.2347107.44
commissionnumberCommission for this agent.0
roomSoldstring/numberNumber of rooms sold by this agent.3

Expected System Responses​

The system responds with HTTP 200 OK.

{
"error": false,
"status": "ok",
"message": "",
"data": {
"date": "2023-01-17",
"statistics": {
"totalRoom": 16,
"roomSold": 3,
"roomSoldPercent": {
"value": 0.19,
"formattedString": "18.75%",
"percentValue": 18.75
},
"roomAvailable": 12,
"noOfAdult": 8,
"noOfChildren": 2,
"noOfPax": 10,
"complimentary": 1
},
"roomRevenue": {
"code": "RR",
"name": "Room Revenue",
"averageRoomRate": 782369.1460055095,
"averageRoomRateLessCommission": 782369.1460055095,
"revPar": 146694.21,
"revParLessCommission": 146694.21,
"commission": 0,
"amount": 3500000,
"amountLessCommission": 3500000
},
"reservationAgent": [
{
"code": "S4",
"name": "Online Travel Agent",
"roomRevenue": 2347107.4380165287,
"roomRevenueLessCommission": 2347107.4380165287,
"commission": 0,
"roomSold": "3"
},
{
"code": "S9",
"name": "Complimentary",
"roomRevenue": 375000,
"roomRevenueLessCommission": 375000,
"commission": 0,
"roomSold": "1"
},
{
"code": "S1",
"name": "Walk In",
"roomRevenue": -1652.892561983471,
"roomRevenueLessCommission": -1652.892561983471,
"commission": 0,
"roomSold": "0"
}
]
}
}