Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operation

Get a single element of ReservationRoomStay by its id

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.reservation


Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
}



Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GET



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/reservationRoomStay/{reservationRoomStayId}



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdStringtruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
reservationRoomStayIdIntegertruepath parameter
Unique identificator of the reservationRoomStay.


Example request

Code Block
languagepowershell
themeDJango
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/reservationRoomStay/1



Response

The response is an entity of type ReservationRoomStay or an error if it's not found.

Entity

Insert excerpt
ReservationRoomStay
ReservationRoomStay
nopaneltrue


Example response

Code Block
themeDJango
{
	"id": 691511766,
	"reservationHolderreservationStatusType": {
		"id": 69151,
		"documentNumbercode": null"RES",
		"givenNamename": "MarinaReserved",
		"surNamenameI18n": "GarcíaReserved",
		"secondSurNamecolorCode": null"#43a047"
	},
		"streetarrival": null"2021-08-01",
		"citydeparture": null"2021-08-02",
		"stateProvNamearrivalTime": null,
		"stateProvCodedepartureTime": null,
		"postalCodequantity": null1,
		"countryCodeaccommodation": "ES",{
		"emailid": null707,
		"phoneNumbername": null"Double",
		"languageroomType": {
			"id": 117,
			"codename": "ESDouble",
			"namenameI18n": "SpanishDouble",
			"nameI18nmainImage": "Spanish1/2/propertyroomtypeimages/6e8184e4-ecc6-4d86-a56d-24d3776688df.jpg"
		}
	},
		"documentTyperoom": null
	},
	"pmsLocatoradult": "ALI00006915"2,
	"crsLocatorjunior": null0,
	"otaLocatorchild": null0,
	"cmLocatorinfant": null0,
	"accommodationAmount": 0.000000null,
	"boardAmount": 0.000000null,
	"serviceAmount": 1792.000000null,
	"totalAmount": 1792.000000null,
	"remarkproductFee": null,{
		"createdDateid": "2021-06-24T15:54:16.827Z"812,
		"modifiedDatename": "2021-06-24T16:32:29.219Z"City Tax Barcelona"
	},
	"reservationRoomStayListpmsLocator": [{
		"id"ALI00006915/11766",
	"crsLocator": null,
	"otaLocator": null,
	"cmLocator": 11766null,
	"remark": null,
	"reservationStatusTypereservationRoomStayGuests": [{
			"id": 122045,
			"codedocumentType": "RES"null,
			"namedocumentNumber": "Reserved"null,
			"nameI18ngivenName": "Reservedtest",
			"colorCodesurName": "#43a047test",
		}"secondSurName": null,
		"arrivalgenderType": "2021-08-01"null,
		"departurebirthDate": "2021-08-02"null,
		"arrivalTimebirthCountryCode": null,
		"departureTimebirthPlace": null,
		"quantityeffectiveDate": 1null,
		"accommodationexpireDate": {null,
			"idstreet": 707null,
			"namecity": "Double"null,
			"roomTypestateProvName": {null,
				"idstateProvCode": 17null,
				"namecountryCode": "DoubleES",
				"nameI18npostalCode": "Double"null,
				"mainImagenationalityCountryCode": "1/2/propertyroomtypeimages/6e8184e4-ecc6-4d86-a56d-24d3776688df.jpg"
			}
		}null,
		"roomcountryOfIssuanceCode": null,
		"adultocr": 2null,
		"junioremail": 0null,
		"childphoneNumber": 0null,
		"infantallowMarketing": 0null,
		"accommodationAmountallowThirdParty": null,
		"boardAmountlanguage": null,{
			"serviceAmountid": null1,
			"totalAmountcode": null"ES",
			"productFeename": { 			"idSpanish": 812,
			"namenameI18n": "City Tax BarcelonaSpanish"
		}
	}],
		"pmsLocatormainBoard": "ALI00006915/11766",{
		"crsLocatorid": null5,
		"otaLocatorcode": null"RO",
		"cmLocatorname": null"Room Only",
		"remarkserviceList": null,
	},
	"reservationRoomStayGuestsreservationRoomStayDaily": [{
			"id": 2204556374,
			"documentTypedate": null"2021-08-01",
			"documentNumberroom": null,
			"givenNameallotment": "test"null,
			"surNamerate": "test"null,
			"secondSurNameamountBeforeTax": null0.000000,
			"genderTypeamountAfterTax": null0.000000,
			"birthDateamountNetAfterTax": null0.000000,
			"birthCountryCodeamountNetBeforeTax": null0.000000,
			"birthPlaceamountInvoiceAfterTax": null0.000000,
			"effectiveDateamountInvoiceBeforeTax": null0.000000,
			"expireDateaccommodationAmount": null0.000000,
			"streetaccommodationAmountAfterDiscount": null0.000000,
			"cityaccommodationAmountAfterTax": null0.000000,
			"stateProvNameaccommodationAmountBeforeTax": null0.000000,
			"stateProvCodeaccommodationAmountNetAfterTax": null0.000000,
			"countryCodeaccommodationAmountNetBeforeTax": "ES"0.000000,
			"postalCodeaccommodationAmountInvoiceAfterTax": null0.000000,
			"nationalityCountryCodeaccommodationAmountInvoiceBeforeTax": null0.000000,
			"countryOfIssuanceCodecentralAccommodationPercentageCommission": null,
			"ocrcentralAccommodationAmountCommission": null,
			"emailcentralBoardPercentageCommission": null,
			"phoneNumbercentralBoardAmountCommission": null,
			"allowMarketingcompanyAccommodationPercentageCommission": null,
			"allowThirdPartycompanyAccommodationAmountCommission": null,
			"languagecompanyBoardPercentageCommission": {null,
				"idcompanyBoardAmountCommission": 1null,
				"codebookerAccommodationPercentageCommission": "ES"null,
				"namebookerAccommodationAmountCommission": "Spanish"null,
				"nameI18nbookerBoardPercentageCommission": "Spanish"null,
			}
		}]"bookerBoardAmountCommission": null,
		"mainBoardbillToAccommodationPercentageCommission": {null,
			"idbillToAccommodationAmountCommission": 5null,
			"codebillToBoardPercentageCommission": null,
		"RObillToBoardAmountCommission": null,
			"namebillToAccommodationPercentageDiscount": null,
		"billToAccommodationAmountDiscount"Room: Only"null,
			"serviceListbillToBoardPercentageDiscount": null,
		}"billToBoardAmountDiscount": null,
		"reservationRoomStayDailycurrency": [{
			"id": 563741,
			"datecode": "2021-08-01EUR",
			"roomname": null"Euro",
			"allotmentnameI18n": null"Euro",
			"ratesymbol": null"€",
			"amountBeforeTaxdecimalPlaces": 0.000000 2
		},
			"amountAfterTaxoffer": 0.000000null,
			"amountNetAfterTaxofferAmountDiscount": 0.000000null,
			"amountNetBeforeTaxofferPercentDiscount": 0.000000null,
			"amountInvoiceAfterTaxpromotion": 0.000000null,
			"amountInvoiceBeforeTaxpromotionAmountDiscount": 0.000000null,
			"accommodationAmountpromotionPercentDiscount": 0.000000null,
			"accommodationAmountAfterDiscountboard": {
0.000000,
			"accommodationAmountAfterTaxid": 0.0000005,
			"accommodationAmountBeforeTaxcode": 0.000000"RO",
			"accommodationAmountNetAfterTaxname": 0.000000"Room Only",
			"accommodationAmountNetBeforeTaxserviceList": 0.000000 null
		},
			"accommodationAmountInvoiceAfterTaxboardAmountAfterDiscountAdult": 0.000000,
			"accommodationAmountInvoiceBeforeTaxboardAmountAdult": 0.000000,
			"centralAccommodationPercentageCommissionboardAmountAfterTaxAdult": null0.000000,
			"centralAccommodationAmountCommissionboardAmountBeforeTaxAdult": null0.000000,
			"centralBoardPercentageCommissionboardAmountNetAfterTaxAdult": null0.000000,
			"centralBoardAmountCommissionboardAmountNetBeforeTaxAdult": null0.000000,
			"companyAccommodationPercentageCommissionboardAmountInvoiceAfterTaxAdult": null0.000000,
			"companyAccommodationAmountCommissionboardAmountInvoiceBeforeTaxAdult": null0.000000,
			"companyBoardPercentageCommissionboardAmountAfterDiscountJunior": null0.000000,
			"companyBoardAmountCommissionboardAmountJunior": null0.000000,
			"bookerAccommodationPercentageCommissionboardAmountAfterTaxJunior": null0.000000,
			"bookerAccommodationAmountCommissionboardAmountBeforeTaxJunior": null0.000000,
			"bookerBoardPercentageCommissionboardAmountNetAfterTaxJunior": null0.000000,
			"bookerBoardAmountCommissionboardAmountNetBeforeTaxJunior": null0.000000,
			"billToAccommodationPercentageCommissionboardAmountInvoiceAfterTaxJunior": null0.000000,
			"billToAccommodationAmountCommissionboardAmountInvoiceBeforeTaxJunior": null0.000000,
			"billToBoardPercentageCommissionboardAmountAfterDiscountChild": null0.000000,
			"billToBoardAmountCommissionboardAmountChild": null0.000000,
			"billToAccommodationPercentageDiscountboardAmountAfterTaxChild": null0.000000,
			"billToAccommodationAmountDiscountboardAmountBeforeTaxChild": null0.000000,
			"billToBoardPercentageDiscountboardAmountNetAfterTaxChild": null0.000000,
			"billToBoardAmountDiscountboardAmountNetBeforeTaxChild": null0.000000,
			"currencyboardAmountInvoiceAfterTaxChild": {0.000000,
				"idboardAmountInvoiceBeforeTaxChild": 10.000000,
				"codeboardAmountAfterDiscountInfant": "EUR"0.000000,
				"nameboardAmountInfant": "Euro"0.000000,
				"nameI18nboardAmountAfterTaxInfant": "Euro"0.000000,
				"symbolboardAmountBeforeTaxInfant": "€"0.000000,
				"decimalPlacesboardAmountNetAfterTaxInfant": 2
			}0.000000,
			"offerboardAmountNetBeforeTaxInfant": null0.000000,
			"offerAmountDiscountboardAmountInvoiceAfterTaxInfant": null0.000000,
			"offerPercentDiscountboardAmountInvoiceBeforeTaxInfant": null0.000000,
		"paymentType": {
			"promotionid": null1,
			"promotionAmountDiscountcode": null"G",
			"promotionPercentDiscountname": null,
			"board"Pay Guest",
			"nameI18n": "Pay Guest"
		},
		"propertyPolicy": {
				"id": 512,
				"code": "RO24H",
				"name": "Room Only",24 Hours 1 Night"
		},
		"serviceListpropertySource": null{
			},
			"boardAmountAfterDiscountAdult"id": 0.00000013,
			"boardAmountAdultcode": 0.000000"PHO",
			"boardAmountAfterTaxAdultname": 0.000000,"Phone"
			"boardAmountBeforeTaxAdult": 0.000000},
			"boardAmountNetAfterTaxAdultpropertySegment": 0.000000,{
			"boardAmountNetBeforeTaxAdultid": 0.00000019,
			"boardAmountInvoiceAfterTaxAdultcode": 0.000000"HACC",
			"boardAmountInvoiceBeforeTaxAdultname": 0.000000"Home Account"
		},
			"boardAmountAfterDiscountJuniorpropertyChannel": 0.000000,{
			"boardAmountJuniorid": 0.00000011,
			"boardAmountAfterTaxJuniorcode": 0.000000"WEB",
			"boardAmountBeforeTaxJuniorname": 0.000000"Booking Engine"
		},
			"boardAmountNetAfterTaxJuniorbooker": 0.000000null,
			"boardAmountNetBeforeTaxJuniorbillTo": 0.000000null,
			"boardAmountInvoiceAfterTaxJuniorcentral": 0.000000null,
			"boardAmountInvoiceBeforeTaxJuniorcompany": 0.000000null,
			"boardAmountAfterDiscountChildreservationGroup": 0.000000null
	}],
			"boardAmountChildreservationRoomStayServiceList": 0.000000,
	[{
		"boardAmountAfterTaxChildid": 0.00000017477,
			"boardAmountBeforeTaxChildservice": 0.000000,{
			"boardAmountNetAfterTaxChildid": 0.00000064,
			"boardAmountNetBeforeTaxChildcode": 0.000000"COT",
			"boardAmountInvoiceAfterTaxChildname": 0.000000"Cot"
		},
			"boardAmountInvoiceBeforeTaxChildstartDate": 0.000000"2021-08-01",
			"boardAmountAfterDiscountInfantendDate": 0.000000"2021-08-05",
			"boardAmountInfantquantity": 0.0000007,
			"boardAmountAfterTaxInfanttotalAmountAfterTax": 0128.000000,
			"boardAmountBeforeTaxInfanttotalAmountBeforeTax": 0160.000000,
			"boardAmountNetAfterTaxInfantreservationRoomStayServiceDailyList": 0.000000,[{
				"boardAmountNetBeforeTaxInfantid": 0.00000083330,
				"boardAmountInvoiceAfterTaxInfantdate": 0.000000,
"2021-08-04",
				"rate": null,
				"amountBeforeTax": 29.090909,
				"boardAmountInvoiceBeforeTaxInfantamountAfterTax": 032.000000,
				"paymentTypecurrency": {
					"id": 1,
					"code": "GEUR",
					"name": "Pay GuestEuro",
					"nameI18n": "Pay GuestEuro",
			},
			"propertyPolicysymbol": {"€",
					"iddecimalPlaces": 122
				},
				"codeoffer": "24H"null,
				"nameofferAmountDiscount": "24 Hours 1 Night"
null,
			},
			"propertySourceofferPercentDiscount": {null,
				"idpromotion": 13null,
				"codepromotionAmountDiscount": "PHO"null,
				"namepromotionPercentDiscount": "Phone"null,
			},
			"propertySegmentbookerPercentageCommission": {null,
				"idbookerAmountCommission": 19null,
				"codebillToPercentageCommission": "HACC"null,
				"namebillToAmountCommission": "Home Account"
			},
null,
				"propertyChannelbillToPercentageDiscount": {null,
				"idbillToAmountDiscount": 11null,
				"codecentralPercentageCommission": "WEB"null,
				"namecentralAmountCommission": "Booking Engine"null,
			},
			"bookercompanyPercentageCommission": null,
				"billTocompanyAmountCommission": null,
				"centralpostingDate": null,
			"company": null},
			"reservationGroup{
				"id": 83334,
				"date": null
		}]"2021-08-03",
				"rate": null,
				"reservationRoomStayServiceListamountBeforeTax": [{
29.090909,
				"idamountAfterTax": 1747732.000000,
				"servicecurrency": {
					"id": 641,
					"code": "COTEUR",
					"name": "CotEuro",
			},
				"startDatenameI18n": "2021-08-01Euro",
					"endDatesymbol": "2021-08-05",
					"quantitydecimalPlaces": 7 2
				},
				"totalAmountAfterTaxoffer": 128.000000null,
				"totalAmountBeforeTaxofferAmountDiscount": 160.000000null,
				"reservationRoomStayServiceDailyListofferPercentDiscount": [{null,
					"idpromotion": 83330null,
					"datepromotionAmountDiscount": "2021-08-04",
	null,
				"ratepromotionPercentDiscount": null,
					"amountBeforeTaxbookerPercentageCommission": 29.090909null,
					"amountAfterTaxbookerAmountCommission": 32.000000null,
					"currencybillToPercentageCommission": {null,
						"idbillToAmountCommission": 1null,
						"codebillToPercentageDiscount": "EUR"null,
						"namebillToAmountDiscount": "Euro"null,
						"nameI18ncentralPercentageCommission": "Euro"null,
						"symbolcentralAmountCommission": "€"null,
						"companyPercentageCommission"decimalPlaces": 2
					}null,
					"offercompanyAmountCommission": null,
					"offerAmountDiscountpostingDate": null
			},
			{
				"offerPercentDiscountid": null83335,
					"promotiondate": null"2021-08-02",
					"promotionAmountDiscountrate": null,
					"promotionPercentDiscountamountBeforeTax": null29.090909,
					"bookerPercentageCommissionamountAfterTax": null32.000000,
					"bookerAmountCommissioncurrency": null,{
					"billToPercentageCommissionid": null1,
					"billToAmountCommissioncode": null"EUR",
					"billToPercentageDiscountname": null"Euro",
					"billToAmountDiscountnameI18n": null"Euro",
					"centralPercentageCommissionsymbol": null"€",
					"centralAmountCommissiondecimalPlaces": null 2
				},
					"companyPercentageCommissionoffer": null,
					"companyAmountCommissionofferAmountDiscount": null,
					"postingDateofferPercentDiscount": null,
				}"promotion": null,
				{
	"promotionAmountDiscount": null,
				"idpromotionPercentDiscount": 83334null,
					"datebookerPercentageCommission": "2021-08-03"null,
					"ratebookerAmountCommission": null,
					"amountBeforeTaxbillToPercentageCommission": 29.090909null,
					"amountAfterTaxbillToAmountCommission": 32.000000null,
					"currencybillToPercentageDiscount": {null,
						"idbillToAmountDiscount": 1null,
						"codecentralPercentageCommission": "EUR"null,
						"namecentralAmountCommission": "Euro"null,
						"nameI18ncompanyPercentageCommission": "Euro"null,
						"symbolcompanyAmountCommission": "€"null,
						"decimalPlacespostingDate": 2null
					},
			{
				"offerid": null83336,
					"offerAmountDiscountdate": null"2021-08-01",
					"offerPercentDiscountrate": null,
					"promotionamountBeforeTax": null29.090909,
					"promotionAmountDiscountamountAfterTax": null32.000000,
					"promotionPercentDiscountcurrency": null,{
					"bookerPercentageCommissionid": null1,
					"bookerAmountCommissioncode": null"EUR",
					"billToPercentageCommissionname": null"Euro",
					"billToAmountCommissionnameI18n": null"Euro",
					"billToPercentageDiscountsymbol": null"€",
					"billToAmountDiscountdecimalPlaces": null 2
				},
					"centralPercentageCommissionoffer": null,
					"centralAmountCommissionofferAmountDiscount": null,
					"companyPercentageCommissionofferPercentDiscount": null,
					"companyAmountCommissionpromotion": null,
					"postingDatepromotionAmountDiscount": null,
				},
				{"promotionPercentDiscount": null,
					"idbookerPercentageCommission": 83335null,
					"datebookerAmountCommission": "2021-08-02"null,
					"ratebillToPercentageCommission": null,
					"amountBeforeTaxbillToAmountCommission": 29.090909null,
					"amountAfterTaxbillToPercentageDiscount": 32.000000null,
					"currencybillToAmountDiscount": {null,
						"idcentralPercentageCommission": 1null,
						"codecentralAmountCommission": "EUR"null,
						"namecompanyPercentageCommission": "Euro"null,
						"nameI18ncompanyAmountCommission": "Euro"null,
						"symbolpostingDate": "€",null
			}
			"decimalPlaces": 2
					},
					"offer": null,
					"offerAmountDiscount": null,
					"offerPercentDiscount": null,
					"promotion": null,
					"promotionAmountDiscount": null,
					"promotionPercentDiscount": null,
					"bookerPercentageCommission": null,
					"bookerAmountCommission": null,
					"billToPercentageCommission": null,
					"billToAmountCommission": null,
					"billToPercentageDiscount": null,
					"billToAmountDiscount": null,
					"centralPercentageCommission": null,
					"centralAmountCommission": null,
					"companyPercentageCommission": null,
					"companyAmountCommission": null,
					"postingDate": null
				},
				{
					"id": 83336,
					"date": "2021-08-01",
					"rate": null,
					"amountBeforeTax": 29.090909,
					"amountAfterTax": 32.000000,
					"currency": {
						"id": 1,
						"code": "EUR",
						"name": "Euro",
						"nameI18n": "Euro",
						"symbol": "€",
						"decimalPlaces": 2
					},
					"offer": null,
					"offerAmountDiscount": null,
					"offerPercentDiscount": null,
					"promotion": null,
					"promotionAmountDiscount": null,
					"promotionPercentDiscount": null,
					"bookerPercentageCommission": null,
					"bookerAmountCommission": null,
					"billToPercentageCommission": null,
					"billToAmountCommission": null,
					"billToPercentageDiscount": null,
					"billToAmountDiscount": null,
					"centralPercentageCommission": null,
					"centralAmountCommission": null,
					"companyPercentageCommission": null,
					"companyAmountCommission": null,
					"postingDate": null
				}
			]
		}],
		"createdDate": "2021-06-24T15:54:16.890Z",
		"modifiedDate": "2021-06-24T16:32:29.219Z"
	}]]
	}],
	"createdDate": "2021-06-24T15:54:16.890Z",
	"modifiedDate": "2021-06-24T16:32:29.219Z",
	"deposit": {
    	"productPayment" : {
	        "code" : "VI"
	    },
	    "amount" : 100,
	    "productDeposit" : {
	        "code" : "DEPRE"
	    },
	    "chargeId":"ch_3MA9wDGjGBQ6ROtO0Rm9mtudss"
	},
	"reservationType" : {
   		"id": 2,
        "chainId": 1,
        "propertyId": 2,
        "code": "PREVIEW",
        "name": "Pending Review",
        "colorCode": "#FDD835",
        "active": true
	}
}