Skip to main content

RoomType

A specific room type in a hotel.

type RoomType {
  alternateCurrencyDepositFixedAmount: [Money!]!
  beddingConfiguration: String
  createdAt: DateTime!
  createdBy: String
  customFields(
    input: CustomFieldSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomField!]!
  depositFixedAmount: Float
  depositPercentageAmount: Float
  description: String
  hotel: Hotel!
  id: ID!
  incomeAccount: Account!
  inventoryAndRates: RoomTypeInventoryRates!
  itineraryInformation: String
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  maximumOccupancy: NonNegativeInt!
  name: String!
  paymentOption: RoomTypePaymentOption!
  paymentStatuses: [PaymentStatus!]!
  photos: [RoomTypePhoto!]!
  uniqueCode: String
}

Fields

`RoomType.alternateCurrencyDepositFixedAmount` ● `[Money!]!` non-null object

The fixed amount required for the deposit for this room type in alternate currencies.

`RoomType.beddingConfiguration` ● `String` scalar

A UTF-8 string representing the bedding configuration of the room type. Optional.

`RoomType.createdAt` ● `DateTime!` non-null scalar

The date and time the record was created.

`RoomType.createdBy` ● `String` scalar

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

`RoomType.customFields` ● `[CustomField!]!` non-null object

A list of custom field values associated with this room type.

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).

`RoomType.customFields.input` ● `CustomFieldSearchFilterInput!` non-null input

`RoomType.customFields.limit` ● `PaginationLimit!` non-null scalar

`RoomType.customFields.offset` ● `NonNegativeInt!` non-null scalar

`RoomType.depositFixedAmount` ● `Float` scalar

The fixed amount required for the deposit for this room type in the default currency. Optional.

Use this field if paymentOption is set to FIXED_AMOUNT_DEPOSIT.

`RoomType.depositPercentageAmount` ● `Float` scalar

The percentage required for the deposit for this room type. Optional.

Use this field if paymentOption is set to PERCENTAGE_DEPOSIT.

`RoomType.description` ● `String` scalar

A UTF-8 string representing the description of the room type. Optional.

`RoomType.hotel` ● `Hotel!` non-null object

The hotel of the room type.

`RoomType.id` ● `ID!` non-null scalar

The unique identifier for the room type.

`RoomType.incomeAccount` ● `Account!` non-null object

The income account for the room type.

`RoomType.inventoryAndRates` ● `RoomTypeInventoryRates!` non-null object

The inventory and rates for the room type.

`RoomType.itineraryInformation` ● `String` scalar

A UTF-8 string representing the itinerary information for room type. Optional.

`RoomType.lastModifiedAt` ● `DateTime!` non-null scalar

The date and time the record was last modified.

`RoomType.lastModifiedBy` ● `String` scalar

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

`RoomType.maximumOccupancy` ● `NonNegativeInt!` non-null scalar

The maximum number of people allowed in rooms of this type.

`RoomType.name` ● `String!` non-null scalar

A UTF-8 string representing the name of the room type.

`RoomType.paymentOption` ● `RoomTypePaymentOption!` non-null enum

The payment option for this room type.

`RoomType.paymentStatuses` ● `[PaymentStatus!]!` non-null enum

A list of valid payment statuses for this room type.

`RoomType.photos` ● `[RoomTypePhoto!]!` non-null object

A collection of photos for the room type.

`RoomType.uniqueCode` ● `String` scalar

A customer supplied, UTF-8 string value that represents a unique code for the room type. Optional.

The value must be unique across all room types for an event.

Member Of

CreateRoomTypePayload object ● Hotel object ● HotelBooking object ● RoomTypeInventoryRates object

Fields
Member Of