Skip to main content

Daily Summary - Reservation Agent

Overview

Provides a daily summary aggregated by reservation source/agent for the requested report_date. Each entry in the response represents one agent/source and includes rooms sold, pax counts (adults, children, total), complimentary rooms, and room revenue values including commission and revenue after commission.

Request Endpoint

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

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
reservationAgentarray of objectsList of agent/source summary objects (see below).[...]

Response data.reservationAgent Fields

FieldTypeDescriptionExample
reservationSourceNamestringReservation source/agent name.Walkin
roomSoldstring/numberNumber of rooms sold by this agent.3
complimentarynumberNumber of complimentary rooms.0
noOfAdultstring/numberNumber of adult guests.7
noOfChildrenstring/numberNumber of child guests.2
noOfPaxstring/numberTotal number of guests (adults + children).9
roomRevenueAmountnumberRoom revenue for this agent.2347107.44
roomRevenueCommissionnumberCommission for this agent.0
roomRevenueLessCommissionnumberRoom revenue after commission.2347107.44

Expected System Responses

The system responds with HTTP 200 OK.

{
"error": false,
"status": "ok",
"message": "",
"data": {
"date": "2023-01-17",
"reservationAgent": [
{
"reservationSourceName": "Aditya Agent",
"roomSold": "3",
"complimentary": 0,
"noOfAdult": "7",
"noOfChildren": "2",
"noOfPax": "9",
"roomRevenueAmount": 2347107.4380165287,
"roomRevenueCommission": 0,
"roomRevenueLessCommission": 2347107.4380165287
},
{
"reservationSourceName": "Complimentary",
"roomSold": "1",
"complimentary": 1,
"noOfAdult": "1",
"noOfChildren": "0",
"noOfPax": "1",
"roomRevenueAmount": 375000,
"roomRevenueCommission": 0,
"roomRevenueLessCommission": 375000
},
{
"reservationSourceName": "Walkin",
"roomSold": "0",
"complimentary": 0,
"noOfAdult": "1",
"noOfChildren": "0",
"noOfPax": "1",
"roomRevenueAmount": -1652.892561983471,
"roomRevenueCommission": 0,
"roomRevenueLessCommission": -1652.892561983471
}
]
}
}