Skip to main content

CreateRoomTypeInput

Defines the input details for creating a new room type.

input CreateRoomTypeInput {
  additionalPaymentStatuses: [AdditionalPaymentStatus!]
  alternateCurrencyDepositFixedAmount: [MoneyInput!]
  beddingConfiguration: String
  cancelationTaxes: [TaxItemInput!]
  customFields: [CustomFieldInput!]
  depositFixedAmount: Float
  depositPercentageAmount: Float
  description: String
  eventId: ID!
  hotelId: ID!
  incomeAccountId: ID
  inventoryAndRates: RoomTypeInventoryRateInput
  itineraryInformation: String
  maximumOccupancy: NonNegativeInt
  name: String!
  paymentOption: RoomTypePaymentOption
  photos: [CreateRoomTypePhotoInput!]
  taxes: [TaxItemInput!]
  uniqueCode: String
}

Fields​

CreateRoomTypeInput.additionalPaymentStatuses ● [AdditionalPaymentStatus!] list enum​

The additional valid payment statuses for this room type. Optional.

CreateRoomTypeInput.alternateCurrencyDepositFixedAmount ● [MoneyInput!] list input​

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

Ignored unless the paymentOption is set to FIXED_AMOUNT_DEPOSIT

CreateRoomTypeInput.beddingConfiguration ● String scalar​

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

CreateRoomTypeInput.cancelationTaxes ● [TaxItemInput!] list input​

The collection of taxes for cancelation amounts for the room type. Optional.

Defaults to the default taxes for the event.

CreateRoomTypeInput.customFields ● [CustomFieldInput!] list input​

The custom fields to create for the room type. Optional.

CreateRoomTypeInput.depositFixedAmount ● Float scalar​

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

If paymentOption is set to FIXED_AMOUNT_DEPOSIT this field is required.

CreateRoomTypeInput.depositPercentageAmount ● Float scalar​

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

If paymentOption is set to PERCENTAGE_DEPOSIT this field is required.

CreateRoomTypeInput.description ● String scalar​

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

CreateRoomTypeInput.eventId ● ID! non-null scalar​

The identifier of the event the room type is associated with.

CreateRoomTypeInput.hotelId ● ID! non-null scalar​

The identifier of the hotel the room type is associated with.

CreateRoomTypeInput.incomeAccountId ● ID scalar​

The identifier of the income account for the room type. Optional.

The value will default to the ID of the first income account in account number order.

CreateRoomTypeInput.inventoryAndRates ● RoomTypeInventoryRateInput input​

The inventory and rates for the room type. Optional.

The default value for inventoryType is UNLIMITED, the default value for rateType is FIXED, the default value for fixedDailyRoomRate is 0 the default value for fixedDailyRoomCost is 0 and the default value for numberOfNightsForMinimumStay is 0.

CreateRoomTypeInput.itineraryInformation ● String scalar​

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

CreateRoomTypeInput.maximumOccupancy ● NonNegativeInt scalar​

The maximum occupancy for the room type. Optional.

The default value is 0. If set to 0, maximum occupancy is not applicable.

CreateRoomTypeInput.name ● String! non-null scalar​

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

CreateRoomTypeInput.paymentOption ● RoomTypePaymentOption enum​

The payment option for this room type. Optional.

The default value is FULL_PAYMENT.

CreateRoomTypeInput.photos ● [CreateRoomTypePhotoInput!] list input​

A collection of photos to create with the room type. Optional.

CreateRoomTypeInput.taxes ● [TaxItemInput!] list input​

The collection of taxes for the room type. Optional.

Defaults to the default taxes for the event.

CreateRoomTypeInput.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 a hotel.

Member Of​

createRoomType mutation