get Reservations For Billing

GET {{HostName}}/fof/v1/hotels/{{HotelId}}/billingReservations

Request Params

KeyDatatypeRequiredDescription
offsetstringIndex or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
searchTypestring
arrivalEndstringThe ending value of the date range
departureStartstringThe starting value of the date range
departureEndstringThe ending value of the date range
stayOnStartnull
stayOnEndnull
createOnStartnull
createOnEndnull
limitstringIndicates maximum number of records a Web Service should return
multipleHotelsSearchListstring
superSearchstringFree form text field for searching all reservation fields
reservationIdstringunique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation
reservationIdContextstringUsed to identify the source of the identifier (e.g., IATA, ABTA)
reservationIdTypestringA reference to the type of object defined by the UniqueID element
nightsstringThe number of nights on a reservation
arrivalStartstringThe starting value of the date range
reservationProfileTypestring
reservationProfileTypestring
reservationProfileTypestring
reservationProfileTypestring
reservationProfileTypestring
reservationProfileTypestring
reservationProfileTypestring
reservationProfileTypestring
attachedProfileNamestringAttached profile name
attachedProfileIdstringA unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation
attachedProfileIdContextstringUsed to identify the source of the identifier (e.g., IATA, ABTA)
attachedProfileIdTypestringA reference to the type of object defined by the UniqueID element
resGuestIdstringA unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation
resGuestIdContextstringUsed to identify the source of the identifier (e.g., IATA, ABTA)
resGuestIdTypestringA reference to the type of object defined by the UniqueID element
membershipIdstringMembership ID criteria
membershipLevelCodesstring
membershipTypeCodesstring
surnamestringFamily name, last name
givenNamestringGiven name, first name or names
cityNamestringCity (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address)
postalCodestringPost Office Code number
statestringState or Province name (e.g., Texas)
countryCodestringCode for a country or a nationality
streetAddressstringFirst Line of Street Address. For profile search it matches the first Address line.
bookingChannelCodestringBooking Channel Code
blockHotelIdstringThe Hotel Code of the Block
blockIdstringA unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation
blockIdContextstringUsed to identify the source of the identifier (e.g., IATA, ABTA)
blockIdTypestringA reference to the type of object defined by the UniqueID element
recordLocatorstringGDS Record Locator for reservation
orderByAttributeNamestring
orderTypestring
roomIdstringRoom number of the reservation to search by
roomTypestring
fetchInstructionsstringInstruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.
fetchInstructionsstringInstruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.
fetchInstructionsstringInstruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.
fetchInstructionsstringInstruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.
fetchInstructionsstringInstruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.
fetchInstructionsstringInstruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.
fetchInstructionsstringInstruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.
fetchInstructionsstringInstruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.
fetchInstructionsstringInstruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.
fetchInstructionsstringInstruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.
fetchInstructionsstringInstruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.
fetchInstructionsstringInstruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.
excludeNoPoststringIndicates that reservations with No Post flag should not be expected from the result
excludePMRoomsstringIndicates that reservations with PM room type should not be expected from the result
hasOpenFoliostringIndicates that only reservations with open folio should be expected from the result.
excludedReservationIdsstringA unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation
excludedReservationIdsContextstringUsed to identify the source of the identifier (e.g., IATA, ABTA)
excludedReservationIdsTypestringA reference to the type of object defined by the UniqueID element
advanceCheckedInstringIndicates to exclude Advance Checked In Reservations from search result
searchTypesSearchTypestringRepresents Reservation search type Player Snapshot
"Any", "DayUse", "Arrival", "Arrived", "Departure", "WaitList", "Cancellation", "CheckedOut", "NoShow", "Complimentary", "InHouse", "PostStayPendingBalance", "PreRegistered", "PostToRoom", "OpenFolio", "ScheduledCheckOut", "Queued", "MobileCheckout", "RegisteredAndInHouse", "ResvBlockTraces", "GuestMessages", "MassCancellation", "Operator", "Turndown", "WalkIn", "AdvanceCheckedIn", "OpenBalance", "AutoFolioSettlement", "Routing", "PlayerSnapshot"
reservationStatusstringReservation status type for reservations search

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
x-hotelidstring
x-app-keystring