---
title: "getReservationsWithRateDetails"
method: GET
path: "/getReservationsWithRateDetails"
tags: ["Reservation"]
---

# getReservationsWithRateDetails

`GET /getReservationsWithRateDetails`

Returns a list of reservations with added information regarding booked rates and sources.<br /> Please note that some reservations modification may not be reflected in this timestamp.

## Query parameters

- `propertyID` string
- `resultsFrom` string, date-time
- `resultsTo` string, date-time
- `modifiedFrom` string, date-time
- `modifiedTo` string, date-time
- `sortByRecent` boolean
- `reservationID` string
- `reservationCheckOutFrom` string, date
- `reservationCheckOutTo` string, date
- `includeDeleted` boolean
- `excludeStatuses` string
- `includeGuestsDetails` boolean
- `includeGuestRequirements` boolean
- `includeCustomFields` boolean
- `guestID` string
- `pageNumber` integer
- `pageSize` integer

## Response `200`

200 Response

- GetReservationsWithRateDetailsResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object[] — Details for the reservations returned
    - `propertyID` string — Properties identifier
    - `reservationID` string — Reservation's unique identifier
    - `isDeleted` boolean
    - `dateCreated` string, date-time
    - `dateCreatedUTC` string, date-time
    - `dateModified` string, date-time
    - `dateModifiedUTC` string, date-time
    - `dateCancelled` string, date-time, nullable — Will be displayed only if "status = 'canceled'"
    - `dateCancelledUTC` string, date-time, nullable — Will be displayed only if "status = 'canceled'"
    - `status` 'confirmed' | 'not_confirmed' | 'canceled' | 'checked_in' | 'checked_out' | 'no_show' — Reservation status<br /> 'not_confirmed' - Reservation is pending confirmation<br /> 'confirmed' - Reservation is confirmed<br /> 'canceled' - Reservation is canceled<br /> 'checked_in' - Guest is in hotel<br /> 'checked_out' - Guest already left hotel<br /> 'no_show' - Guest didn't showed up on check-in date
    - `reservationCheckIn` string, date-time
    - `reservationCheckOut` string, date-time
    - `guestID` string — Main guest ID
    - `profileID` string — Main guest profile ID
    - `guestCountry` string — Main guest Country
    - `sourceName` string — Reservation source
    - `source` object
      - `name` string — Reservation source
      - `paymentCollect` 'hotel' | 'collect' — Reservation payment collect source
      - `sourceID` string — Booking source unique id
      - `category` string — Reservation source category
    - `sourceCategory` string, nullable — Reservation source category
    - `sourceReservationID` string, nullable — Reservation ID on the source
    - `propertyCurrency` string, nullable — Property currency ISO-formatted (3 characters)
    - `balanceDetailed` object — Reservation balance detailed with the information available on MyFrontdesk, describing the financial items calculated
      - `suggestedDeposit` string — Suggested deposit value, calculated according to the hotel policies. Does not mean that it was effectively paid
      - `subTotal` number — Sum of the room prices on the reservation
      - `additionalItems` number — Sum of the additional items recorded on the reservation
      - `taxesFees` number — Sum of the taxes and fees calculated on the reservation
      - `grandTotal` number — Sum of sub.Total + additionalItems + taxesFees
      - `paid` number — Amount paid (reservation deposit + any other extra payment)
    - `detailedRates` object — Associative object, where key is the date, and value is the total rate for that date.
    - `rooms` object[] — Array with rooms information
      - `roomTypeID` string — Room Type ID
      - `roomTypeIsVirtual` boolean — If room is virtual (true) or physical (false)
      - `roomTypeName` string — Room Type Name
      - `subReservationID` string — sub Reservation ID (specific to each room)
      - `isRoomLocked` boolean — Whether the reservation room assignment is locked. Locked reservations cannot be reassigned via the calendar UI.
      - `guestID` string — ID of the main guest assigned to the room
      - `guestName` string — Name of the main guest assigned to the room
      - `rateID` string — ID of the rate used for the booking room
      - `rateName` string — Name of the rate used for the booking room
      - `adults` string — Number of adults in the room
      - `children` string — Number of children in the room
      - `reservationRoomID` string — Reservation room ID
      - `roomID` string — Room ID (null if the reservation has not been assigned a specific room yet).
      - `roomName` string, nullable — Name of the room, if roomID=null it does not exist.
      - `roomCheckIn` string — Check-in date for the room
      - `roomCheckOut` string — Check-out date for the room
      - `roomStatus` 'cancelled' | 'in_house' | 'checked_out' | 'not_checked_in'
      - `detailedRoomRates` object — A map of dates to rates (key is date). It contains an entry for each reserved date.
      - `marketName` string — Market segmentation name
      - `marketCode` string — Market segmentation code
    - `origin` string — Reservation origin
    - `mealPlans` string — Reservation meal plans
    - `guestList` object, nullable — A map of guest IDs to guest objects (key is the Guest ID). It contains an entry for each guest included on the reservation. Only returned if "includeGuestsDetails" is true
    - `thirdPartyIdentifier` string
    - `customFields` object[], nullable — List of reservation custom fields. Only returned if "includeCustomFields" is true
      - `customFieldID` string, nullable — Unique identifier of the custom field definition (matches /getCustomFields.customFieldID).
      - `shortcode` string, nullable — Stable internal code of the custom field (matches /getCustomFields.shortcode).
      - `isActive` boolean, nullable — Whether the custom field definition is active (true) or archived (false).
      - `customFieldName` string, nullable — Custom Field Name
      - `customFieldValue` string, nullable — Custom Field Value
    - `estimatedArrivalTime` string, time, nullable — Estimated arrival time, 24-hour format.
    - `total` number — Total price of the booking
    - `balance` number — Balance currently owed
    - `dateImported` string — Date when the reservation was imported
  - `count` integer — Number of results returned
  - `total` integer — Total number of results

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/revisions/2faa857793e8/schema)