PMS REST API
Online documentation
SetReservationRequest
Inheritance: HotelRequestBase
Request for to make a new reservation or update the reservation that referenced by ReservationID
| Property Name | Type | Description |
| ReservationID | long? | Unique id of reservation |
| Arrival | DateTime? | Date of arrival |
| Departure | DateTime? | Date of departure |
| NumberOfRooms | int? | Number of rooms |
| NumberOfAdults | int? | Number of adults |
| ChildCount | int? | Child count for DefaultChildCategory |
| RoomTypeCode | string | Unique id of room type |
| RoomTypeCodeDaily | List< DailyString > |
Only for Suite8 Unique id of room type daily |
| RateCode | string | Unique id of rate |
| RateCodeDaily | List< DailyString > |
Only for Suite8 Unique id of rate daily |
| BlockCode | string | Unique id of block |
| IsManualPrice | bool | If IsManualPrice is true, amount given by RateAmount (-DiscountAmount) field will be the daily 1 room reservation price. Otherwise Fidelio calculates the total reservation price. |
| RateAmount | decimal |
It is used if IsManualPrice is true. It is the Rate Amount. If IsManualPrice is true then, Total Price is calculated by the following formula: (RateAmount - DiscountAmount) * NightCount * RoomCount |
| RateNetAmountDaily | List< DailyDecimal > |
Only for Suite8 It is used if IsManualPrice is true. Daily Net Amount, field DiscountAmount has no effect on RateNetAmountDaily |
| DiscountAmount | decimal |
It is used if IsManualPrice is true. If IsManualPrice is true then, Total Price is calculated by the following formula: (RateAmount - DiscountAmount) * NightCount * RoomCount |
| CurrencyCode | string | If IsManualPrice to true, it holds the Currency of RateAmount. |
| Profile | Profile | Profile data of guest. it is used only if ProfileRef is not specified |
| ProfileRef | ProfileRef | Profile Reference of guest. |
| BookerRef | ProfileRef | Unique id of booker |
| CompanyRef | ProfileRef | Unique id of company |
| TravelAgentRef | ProfileRef | Unique id of travel agent |
| SourceRef | ProfileRef | Unique id of Source |
| BillingInfo | string |
A note field that some pms systems (eg Suite8) can see this information on their main reservation window. On Suite8 systems, this field is written to BillingInfo of the reservation. On Opera, this is added as a note to the Notes list with prefix "BillingInfo: " in the text. |
| Remarks | string |
A note field that some pms systems (eg Suite8) can see this information on their main reservation window. On Suite8, this field is written to Reservation Remarks. On Opera, this is added as a note to the Notes list with prefix "Remarks: " in the text. |
| ReservationNote | string * [Deprecated] Use Notes list, BillingInfo or Remarks fields instead |
Reservation Note 1. This field is obsolete and written as a note into notes list for now. Please use Notes list, BillingInfo or Remarks instead. |
| ReservationNote2 | string * [Deprecated] Use Notes list, BillingInfo or Remarks fields instead |
Reservation Note 2. This field is obsolete and written as a note into notes list for now. Please use Notes list, BillingInfo or Remarks instead. |
| IsPaymentNeeded | bool * [Deprecated] Use PaymentOption property | If true, amount given by CCPaymentPriceInBaseCurrency will be withdrawn from credit card. |
| PaymentOption | PaymentOptionType ? | How the payment will be handled |
| CCPaymentPriceInBaseCurrency | decimal * [Deprecated] Use CCPaymentPrice property | Payment amount with credit card in base currency. |
| PayPalInfo | PayPalPaymentInfo | PayPal payment information |
| CCPaymentPrice | decimal | Payment amount with credit card. Currency type is in CurrencyCode |
| CCPaymentApprovalCode | string | Credit Card Payment Approval Code. Should be set if payment processed externally |
| CreditCardData | CreditCardData | Credit card data |
| BankCode | string | Unique id of bank that will be used as virtual pos for credit card payment |
| InstallmentCount | int | Number of installments for credit card payment |
| CustomerIP | string | IP of client that user interface is running on |
| CrsResNumber | string | Unique ID coming from CRS System, linked to CrsSystem in order to support multiple CRS systems. It is only for Suite8. (Insert Only) |
| ChildOption | List< ChildOption > | Child option for the reservation |
| Packages | List< PackageItem > |
Reservation packages (these are extra, their price are not included with room price). If this is a reservation insert call, all the packages will be inserted. If this is a reservation update call, all the existing packages (web only or not) will be replaced by this list. |
| PackagesDaily | List< DailyPackageItemForInsertUpdate > |
Only for Suite8 For reservation Insert\Update only fill one of Packages or PackagesDaily parameter Reservation packages (these are extra, their price are not included with room price). WARNING: Delete package is not daily based. Removes package from all days WARNING: To delete and then add "the same package", do deletion with one request, and add package with another(second) request If this is a reservation insert call, all package actions should be Insert (if action ise null it will be executed as insert) If this is a reservation update call, no package action added automatically, only actions given by PackagesDaily are executed If this is a reservation select call, all linked packages (web only or not) will be returned |
| Attributes | List< AttributeLink > | Reservation attributes/preferences |
| Notes | List< NoteItem > | List of guest viewable reservation notes (internal or non guest viewable notes do not to be fetched) |
| MultiGuests | List< MultiGuestLink > |
Reservation multiguest links MultiGuest profiles can be attached to a reservation by only id references or full profile objects, fill in the proper field how you want. |
| TotalPrice | decimal? | This info is only used for confirmation/notification emails, there is no other functionality. |
| PostingSource | PostingSourceType ? |
Default value is CreditCard if the PayPalInfo is null, else it's PayPal. This value overrides the default value if filled in. |
| GuaranteeCode | string |
Only for Suite8 Unique id of Guarantee |
| PaymentTypeCode | string |
Only for Suite8 Unique id of Payment Type |
| RateRoomType | string |
Only for Suite8 Unique id of RateRoomType |
| RebateCodeCode | string |
Unique code of Rebate Only for Suite8 |
| RebateCodeName | string |
Name of Rebate Only for Suite8 |
| MarketCode | string | Unique id of Market |
| MarketCodeDaily | List< DailyString > |
Only for Suite8 Unique id of Market daily |
| SourceCode | string | Unique id of Source |
| ChannelCode | string |
Unique id of Channel Only for Suite8 |
| BookingDate | DateTime? | Date of sale |
| AllowOverBookingForInsert | bool |
Only for Suite8 Only for Insert Reservation if True forces a reservation insert in the event that the House or room type is overbooked |
| HotelCode | string | Destination hotel id or code. |
| Language | string | If specified, response will be translated based on the language code. |
| AuthData | AuthData | Request authentication info. If Http header authentication data is specified, this data is overridden |
