HotelBooking

The details of a hotel booking for a contact.

type HotelBooking {
  cancelationTaxes: [AppliedTax!]!
  checkInDate: LocalDate!
  checkInEstimatedTime: LocalTime
  checkOutDate: LocalDate!
  checkOutEstimatedTime: LocalTime
  comment: String
  contact: Contact!
  createdAt: DateTime!
  createdBy: String
  customFields(
    input: CustomFieldSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomField!]! @deprecated
  customFieldsPaged(
    filterInput: CustomFieldAdvancedSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): CustomFieldPage!
  groupBookingAllocations: [GroupBookingAllocation!]
  hotel: Hotel!
  hotelNotificationStatus: HotelNotificationStatus!
  id: ID!
  isGroupInventory: Boolean!
  itinerary: String
  itineraryOrder: Int!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  numberOfRooms: PositiveInt!
  paymentDetails: HotelBookingPaymentDetail!
  paymentSchedule: [AppliedPaymentScheduleItem!]
  paymentScheduleSource: PaymentScheduleSource!
  paymentStatus: PaymentStatus! @deprecated
  replaceStandardItinerary: Boolean!
  roomNumber: String
  roomType: RoomType!
  sharingWith: String
  specialRequests: String
  subBlock: SubBlock
  taxes: [AppliedTax!]!
  transferFromHotel: TransferFromHotel
  transferToHotel: TransferToHotel
}

Fields

HotelBooking.cancelationTaxes ● [AppliedTax!]! non-null object

The list of cancelation taxes that apply to the hotel booking.

HotelBooking.checkInDate ● LocalDate! non-null scalar

The check-in date of the hotel booking.

HotelBooking.checkInEstimatedTime ● LocalTime scalar

The estimated check-in time of the hotel booking. Optional.

HotelBooking.checkOutDate ● LocalDate! non-null scalar

The check-out date of the hotel booking.

HotelBooking.checkOutEstimatedTime ● LocalTime scalar

The estimated check-out time of the hotel booking. Optional.

HotelBooking.comment ● String scalar

A UTF-8 string representing the comments for this hotel booking. Optional.

HotelBooking.contact ● Contact! non-null object

The contact who the booking is made for.

HotelBooking.createdAt ● DateTime! non-null scalar

The date and time the record was created.

HotelBooking.createdBy ● String scalar

UTF-8 string value that represents the username of the user who created the record. Optional.

HotelBooking.customFields ● [CustomField!]! deprecated non-null object

DEPRECATED

Use customFieldsPaged instead. It returns the same custom fields together with pagination metadata (total count, has-next-page) and exposes a richer filter input supporting both inclusion and exclusion semantics (eq, ne, in, notIn). This field will be removed in a future release.

A list of custom field values associated with this hotel booking.

CustomFields and CustomFieldDefinitions can be matched through the definitionId and id fields, respectively.

See CustomFieldSearchFilterInput for details on how the optional input argument can be used to filter custom fields.

Optionally, the offset and limit arguments can be used to page through multiple items:

• offset must be a non-negative integer (defaults to 0).
• limit must be a positive integer from 1 to 2000 (defaults to 100).

HotelBooking.customFields.input ● CustomFieldSearchFilterInput! non-null input

HotelBooking.customFields.limit ● PaginationLimit! non-null scalar

HotelBooking.customFields.offset ● NonNegativeInt! non-null scalar

HotelBooking.customFieldsPaged ● CustomFieldPage! non-null object

Custom fields associated with this record that match the filter criteria specified in the optional filterInput argument, returned together with pagination metadata.

See CustomFieldAdvancedSearchFilterInput for details on how the filterInput argument can be used. The filter supports both inclusion and exclusion semantics (eq, ne, in, notIn).

Optionally, the offset and limit arguments can be used to page through multiple items:

• offset must be a non-negative integer (defaults to 0).
• limit must be a positive integer from 1 to 2000 (defaults to 100).

Throws an error with code:

• BAD_USER_INPUT if all fields in the filterInput argument have a combined total number of values exceeding 1,000.

HotelBooking.customFieldsPaged.filterInput ● CustomFieldAdvancedSearchFilterInput! non-null input

HotelBooking.customFieldsPaged.limit ● PaginationLimit! non-null scalar

HotelBooking.customFieldsPaged.offset ● NonNegativeInt! non-null scalar

HotelBooking.groupBookingAllocations ● [GroupBookingAllocation!] list object

The group booking allocations for this hotel booking when isGroupInventory is true. Optional.

HotelBooking.hotel ● Hotel! non-null object

The hotel in which the booking is made.

HotelBooking.hotelNotificationStatus ● HotelNotificationStatus! non-null enum

The hotel notification status of the hotel booking.

HotelBooking.id ● ID! non-null scalar

The unique identifier for the hotel booking.

HotelBooking.isGroupInventory ● Boolean! non-null scalar

A flag indicating whether the hotel booking is inventory being held for a group on a Group Co-ordinator.

HotelBooking.itinerary ● String scalar

A UTF-8 string representing the itinerary for the hotel booking. Optional.

HotelBooking.itineraryOrder ● Int! non-null scalar

The order for the itinerary for the hotel booking.

HotelBooking.lastModifiedAt ● DateTime! non-null scalar

The date and time the record was last modified.

HotelBooking.lastModifiedBy ● String scalar

UTF-8 string value that represents the username of the user who last modified the record. Optional.

HotelBooking.numberOfRooms ● PositiveInt! non-null scalar

The number of rooms for the hotel booking.

HotelBooking.paymentDetails ● HotelBookingPaymentDetail! non-null object

The payment details for the hotel booking.

HotelBooking.paymentSchedule ● [AppliedPaymentScheduleItem!] list object

The list of payment schedule items that apply to the hotel booking. Optional.

HotelBooking.paymentScheduleSource ● PaymentScheduleSource! non-null enum

The source of the payment schedule for the hotel booking.

HotelBooking.paymentStatus ● PaymentStatus! deprecated non-null enum

DEPRECATED

Use paymentDetails.paymentStatus instead. This field will be removed in a future release.

The payment status of the hotel booking.

HotelBooking.replaceStandardItinerary ● Boolean! non-null scalar

A flag indicating whether the itinerary should replace the standard itinerary.

HotelBooking.roomNumber ● String scalar

A UTF-8 string representing the room number for this hotel booking. Optional.

HotelBooking.roomType ● RoomType! non-null object

The room type against which the booking is made.

HotelBooking.sharingWith ● String scalar

The name(s) of the person/people the contact is sharing this hotel booking with. Optional.

HotelBooking.specialRequests ● String scalar

A UTF-8 string representing the special request for this hotel booking. Optional.

HotelBooking.subBlock ● SubBlock object

The sub block against which the booking is made. Optional.

HotelBooking.taxes ● [AppliedTax!]! non-null object

The list of taxes that apply to the hotel booking.

HotelBooking.transferFromHotel ● TransferFromHotel object

The transfer details from the hotel for the hotel booking. Optional.

HotelBooking.transferToHotel ● TransferToHotel object

The transfer details to the hotel for the hotel booking. Optional.

Member Of

CancelHotelBookingPayload object ● ConfirmHotelBookingNotificationStatusPayload object ● Contact object ● CreateGroupHotelBookingPayload object ● CreateHotelBookingPayload object ● Event object ● HotelBookingPage object ● RestoreHotelBookingPayload object ● UpdateGroupHotelBookingPayload object ● UpdateHotelBookingPayload object ● UpdateHotelBookingStatusPayload object