Versions Compared

Key

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

Operation

Information of the operationReturns a single folio with the provided ID and adds also the owner.

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.folio


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}/folio/{folioId}



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
folioIdIntegertruepath parameter
Unique identificator of the folio.


Example request

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



Response

PropertyTypeRequiredDescription
folioFolio
The Folio requested by its Id.

Entity

Insert excerpt
Folio
Folio
nopaneltrue


Example response

Code Block
themeDJango
{
	"id": 155,
	"code": 14"105",
	"serie": 1,
	"name": "EireSkinder",
	"folioType": {
		"id": 1,
		"code": "M",
		"name": "Main",
		"nameI18n": "Main"
	},
	"roomModelroom": {
		"id": 15,
		"code": "101105",
		"name": "R101105",
		"roomModuleStatusTyperoomSpaceStatusType": {
			"id": 2,
			"code": "DI",
			"name": "Dirty",
		}	"nameI18n": "Dirty"
		},
		"reservationRoomStayModelreservationRoomStay": {null,
		"idroomSituationType": 24,{
			"reservationStatusTypeid": {2,
			"idcode": 4"OC",
			"codename": "COMOccupied",
			"namenameI18n": "CommittedOccupied"
		}
	},
		"reservationSituationTypereservationRoomStaySummary": {
			"id": 370,
			"codereservationRoomStay": "IH"null,
			"namereservationRoomStayId": "InHouse"
		}70,
		"arrivalreservation": "2019-04-29"null,
		"reservationId": 48,
		"departurepmsLocator": "2019-05-02ALI00000048/70",
		"arrivalTimecrsLocator": null,
		"departureTimeotaLocator": null,
		"quantitycmLocator": 1null,
		"accommodationholder": {
	"Salomé Olson, Phyllis",
		"idarrival": 79"2020-10-31",
			"namedeparture": "Junior Suite"
		}2020-11-15",
		"adultnights": 115,
		"juniorproductAccommodation": 0,{
			"childid": 0767,
			"infantname": 0"Suite",
			"productFeeroomType": {
				"id": 7977,
				"name": "Junior Suite",
		},
		"adultFeenameI18n": 1"Suite",
				"juniorFeemainImage": 0,
		"childFee": 0"1/2/propertyroomtypeimages/07aabe64-2724-42ac-8161-29d612d6e17c.jpg"
			}
		},
		"infantFeeproductAccommodationUpgrade": 0null,
		"pmsLocatorroomType": "0000000024/32",{
			"crsLocatorid": null77,
			"otaLocatorname": null"Suite",
			"cmLocatornameI18n": null"Suite",
			"remarkmainImage": null"1/2/propertyroomtypeimages/07aabe64-2724-42ac-8161-29d612d6e17c.jpg"
		},
		"mainProductBoardadult": null2,
		"reservationRoomStayGuestsjunior": [{0,
			"idchild": 480,
			"documentTypeinfant": {
				"id": 50,
				"codeextraBed": "5"0,
				"nameextraCot": "National identity document"
			}0,
			"documentNumberboard": "hcHieiOT",{
			"givenNameid": "Richard"8,
			"middleNamecode": "RéjaneFB",
			"surNamename": "WellsFullBoard",
			"genderTypeserviceList": [{
					"id": 263,
					"code": "FBRK",
					"name": "FemaleBreakfast"
				},
			"birthDate": "2001-04-30",
			"birthCountry": {
					"id": 19967,
					"code": "ESPLUNCH",
					"name": "SPAINLunch"
				},
				"birthPlace{
					"id": "Peoria"68,
					"effectiveDatecode": "2018-04-30DINNER",
					"expireDatename": "2018-04-30Dinner",
				"street": "9101 Portage Street",
	}
			]
		},
		"cityguest": "PeoriaMåns Woods, James",
			"stateProvNameallotment": null,
			"stateProvrate": {
				"id": 12,
				"code": "ES-CBAR",
				"name": "LaBest Available CoruñaRate",
		},
		"countryoffer": {null,
					"idpromotion": 199null,
					"codeaccommodationAmount": "ESP"4620.000000,
		"boardAmount": 2730.000000,
			"nameserviceAmount": "SPAIN"0.000000,
		"totalAmount": 7350.000000,
		"totalPaid": 7250.000000,
		}
			}"balance": 100.000000,
			"countrycurrency": {
				"id": 1991,
				"code": "ESPEUR",
				"name": "SPAINEuro"
			},
			"postalCodenameI18n": "85383Euro",
		},
		"nationalityCountrybooker": {
				"id": 199860,
				"codename": "ESPTagchat",
				"namecode": "SPAINTAGCH",
			}"taxId": "49510847",
			"ocrcompanyEmailList": null,[{
				"emailid": "jbailey6n@berkeley.edu"860,
				"phoneNumberprimary": "1-(928)620-1967"true,
		}],
		"reservationRoomStayDailyemailAddressType": [{
					"id": 781,
					"datecode": "2019-04-291",
					"allotmentname": null"Personal",
					"ratenameI18n": {"Personal"
				},
				"idemail": 1"rpattersonni@state.gov",
					"coderemark": "BAR",null
			}],
			"namecompanyAddressList": "Best Rate Available"[{
				}"id": 860,
				"priceprimary": 358true,
				"currencycommunicationLocationType": {
					"id": 1,
					"code": "EUR1",
					"name": "EuroHome",
				},
				"offernameI18n": null,"Home"
				"offerAmountDiscount": null},
				"offerPercentDiscountstreet": null "4796 Iowa Crossing",
				"promotioncity": "Grand nullRapids",
				"promotionAmountDiscountstateProvName": null"Huesca",
				"promotionPercentDiscountstateProvCode": null"ES-HU",
				"productBoardpostalCode": {"49510",
					"idcountryCode": 112"ES",
					"nameremark": "HalfBoardAddress Remark"
				}],
				"boardPriceAdultcompanyPhoneList": 20,[{
				"boardPriceJuniorid": null860,
				"boardPriceChildprimary": nulltrue,
				"boardPriceInfantphoneLocationType": null,{
					"paymentTypeid": {6,
					"idcode": 5"6",
					"codename": "AGHome",
					"namenameI18n": "Pay Agency GuestHome"
				},
				"propertyPolicyphoneTechType": {
					"id": 571,
					"code": "24H1",
					"name": "Voice"24 Hours Before Arrival,
					"nameI18n": "Voice"
				},
				"propertySourcecountryAccessCode": {"+34",
				"areaCityCode": "B",
				"idphoneNumber": 2"1-(616)551-2913",
					"codeextension": "AGE1",
					"nameremark": "AgencyPhone Remark"
				}],
				"propertySegmentcompanyTaxAddress": {
					"id": 101850,
					"codecommunicationLocationType": "EMP"null,
					"namestreet": "Employee4796 Iowa Crossing",
				}"city": "Grand Rapids",
				"propertyChannelstateProvName": {"Madrid",
					"idstateProvCode": 24"ES-M",
					"codepostalCode": "IDS49510",
					"namecountryCode": "IDS"
				}ES",
				"postingDateremark": "2019-04-30Address Remark"
			},
			{
	"remark": "Company Remarks",
			"idassignedUser": 2061,null
		},
		"datebillTo": "2019-04-30",{
				"allotmentid": null789,
				"ratename": {"Skinder",
					"idcode": 1"SKIND1",
					"codetaxId": "BAR28215776",
					"namecompanyEmailList": "Best Rate Available"
[{
				}"id": 789,
				"priceprimary": 358true,
				"currencyemailAddressType": {
					"id": 1,
					"code": "EUR1",
					"name": "EuroPersonal",
				},
				"offer": null	"nameI18n": "Personal"
				},
				"offerAmountDiscountemail": null"sjacksonlj@rakuten.co.jp",
				"offerPercentDiscountremark": null
			}],
				"promotioncompanyAddressList": null,[{
				"promotionAmountDiscountid": null789,
				"promotionPercentDiscountprimary": nulltrue,
				"productBoardcommunicationLocationType": {
					"id": 1121,
					"namecode": "HalfBoard1",
				},
				"boardPriceAdultname": 20"Home",
					"boardPriceJuniornameI18n": null"Home"
				},
				"boardPriceChildstreet": null"231 Oneill Way",
				"boardPriceInfantcity": null"Charlotte",
				"paymentTypestateProvName": { "North Carolina",
				"stateProvCode": null,
				"idpostalCode": 5"28215",
					"codecountryCode": "AGMT",
					"nameremark": "PayAddress Agency GuestRemark"
				}],
				"propertyPolicycompanyPhoneList": [{
					"id": 57789,
					"codeprimary": "24H"true,
					"namephoneLocationType": "24 Hours Before Arrival"
{
				},
				"propertySourceid": {6,
					"idcode": 2"6",
					"codename": "AGEHome",
					"namenameI18n": "AgencyHome"
				},
				"propertySegmentphoneTechType": {
					"id": 1011,
					"code": "EMP1",
					"name": "EmployeeVoice",
				},
				"propertyChannelnameI18n": {"Voice"
				},
				"idcountryAccessCode": 24"+34",
					"codeareaCityCode": "IDSB",
					"namephoneNumber": "IDS"1-(704)134-5395",
				}"extension": "1",
				"postingDateremark": "2019-05-01Phone Remark"
			}],
			"companyTaxAddress": {
				"id": 2062779,
				"datecommunicationLocationType": "2019-05-01"null,
				"allotmentstreet": null"231 Oneill Way",
				"ratecity": {"Charlotte",
					"idstateProvName": 1"North Carolina",
					"codestateProvCode": "BAR"null,
					"namepostalCode": "Best Rate Available"
				}28215",
				"pricecountryCode": 358"KE",
				"currencyremark": "Address {Remark"
					"id": 1},
					"coderemark": "EURCompany Remarks",
					"name": "Euro"
				},
				"offer": null,
				"offerAmountDiscountassignedUser": null
		},
		"central": {
			"id": 443,
			"name": "Dynava",
			"code": "DYNAV5",
			"taxId": "93386430",
			"companyEmailList": [{
				"id": 443,
				"primary": true,
				"emailAddressType": {
					"id": 1,
					"code": "1",
					"name": "Personal",
					"nameI18n": "Personal"
				},
				"email": "blewisbx@lulu.com",
				"remark": null
			}],
			"companyAddressList": [{
				"id": 443,
				"primary": true,
				"communicationLocationType": {
					"id": 1,
					"code": "1",
					"name": "Home",
					"nameI18n": "Home"
				},
				"street": "69 Morningstar Drive",
				"city": "Bakersfield",
				"stateProvName": "California",
				"stateProvCode": null,
				"postalCode": "93386",
				"countryCode": "SZ",
				"remark": "Address Remark"
			}],
			"companyPhoneList": [{
				"id": 443,
				"primary": true,
				"phoneLocationType": {
					"id": 6,
					"code": "6",
					"name": "Home",
					"nameI18n": "Home"
				},
				"phoneTechType": {
					"id": 1,
					"code": "1",
					"name": "Voice",
					"nameI18n": "Voice"
				},
				"countryAccessCode": "+34",
				"areaCityCode": "B",
				"phoneNumber": "1-(661)147-6366",
				"extension": "1",
				"remark": "Phone Remark"
			}],
			"companyTaxAddress": {
				"id": 433,
				"communicationLocationType": null,
				"street": "69 Morningstar Drive",
				"city": "Bakersfield",
				"stateProvName": "California",
				"stateProvCode": null,
				"postalCode": "93386",
				"countryCode": "TM",
				"remark": "Address Remark"
			},
			"remark": "Company Remarks",
			"assignedUser": null
		},
		"company": {
			"id": 1151,
			"name": "Jumia Travel",
			"code": "JUMTR",
			"taxId": "475b6dca-bffc-42c2-8c55-4d47bb5d7c1d",
			"companyEmailList": [{
				"id": 1151,
				"primary": true,
				"emailAddressType": {
					"id": 1,
					"code": "1",
					"name": "Personal",
					"nameI18n": "Personal"
				},
				"email": "cfoxit@apple.com",
				"remark": null
			}],
			"companyAddressList": [{
				"id": 1151,
				"primary": true,
				"communicationLocationType": {
					"id": 1,
					"code": "1",
					"name": "Home",
					"nameI18n": "Home"
				},
				"street": "02 Hayes Pass",
				"city": "Charlotte",
				"stateProvName": "North Carolina",
				"stateProvCode": null,
				"postalCode": "28220",
				"countryCode": "TJ",
				"remark": "Address Remark"
			}],
			"companyPhoneList": [{
				"id": 1151,
				"primary": true,
				"phoneLocationType": {
					"id": 6,
					"code": "6",
					"name": "Home",
					"nameI18n": "Home"
				},
				"phoneTechType": {
					"id": 1,
					"code": "1",
					"name": "Voice",
					"nameI18n": "Voice"
				},
				"countryAccessCode": "+34",
				"areaCityCode": "B",
				"phoneNumber": "1-(704)295-6820",
				"extension": "1",
				"remark": "Phone Remark"
			}],
			"companyTaxAddress": null,
			"remark": "Company Agency",
			"assignedUser": null
		},
		"room": {
			"id": 5,
			"code": "105",
			"name": "105",
			"roomSpaceStatusType": {
				"id": 2,
				"code": "DI",
				"name": "Dirty",
				"nameI18n": "Dirty"
			},
			"reservationRoomStay": null,
			"roomSituationType": {
				"id": 2,
				"code": "OC",
				"name": "Occupied",
				"nameI18n": "Occupied"
			}
		},
		"paymentType": {
			"id": 4,
			"code": "AA",
			"name": "Pay Agency Agency",
			"nameI18n": "Pay Agency Agency"
		},
		"propertyPolicy": {
			"id": 12,
			"code": "24H",
			"name": "24 Hours 1 Night"
		},
		"propertySource": {
			"id": 9,
			"code": "COM",
			"name": "Company"
		},
		"propertyChannel": {
			"id": 9,
			"code": "IDS",
			"name": "Internet Distribution System"
		},
		"propertySegment": {
			"id": 21,
			"code": "CONV",
			"name": "Conventions"
		},
		"reservationStatusType": {
			"id": 4,
			"code": "IH",
			"name": "InHouse",
			"nameI18n": "InHouse",
			"colorCode": "#64b5f6"
		},
		"expiredDate": null,
		"hasCredit": true,
		"creditAvailable": null
	},
	"reservation": {
		"id": 1,
		"reservationHolder": {
			"id": 1,
			"documentNumber": null,
			"givenName": "Christine",
			"surName": "Ruò",
			"secondSurName": "Castillo",
			"street": null,
			"city": null,
			"stateProvName": null,
			"stateProvCode": null,
			"postalCode": null,
			"countryCode": "IN",
			"email": "ccastilloqp@livejournal.com",
			"phoneNumber": "1-(713)318-2646",
			"language": null,
			"documentType": null
		},
		"pmsLocator": "ALI00000001",
		"crsLocator": null,
		"otaLocator": null,
		"cmLocator": null,
		"remark": "ReservationRoomStay remarks",
		"reservationRoomStayList": null
	},
	"reservationGroup": null,
	"company": {
		"id": 789,
		"name": "Skinder",
		"code": "SKIND1",
		"taxId": "28215776",
		"companyEmailList": [{
			"id": 789,
			"primary": true,
			"emailAddressType": {
				"id": 1,
				"code": "1",
				"name": "Personal",
				"nameI18n": "Personal"
			},
			"email": "sjacksonlj@rakuten.co.jp",
			"remark": null
		}],
		"companyAddressList": [{
			"id": 789,
			"primary": true,
			"communicationLocationType": {
				"id": 1,
				"code": "1",
				"name": "Home",
				"nameI18n": "Home"
			},
			"street": "231 Oneill Way",
			"city": "Charlotte",
			"stateProvName": "North Carolina",
			"stateProvCode": null,
			"postalCode": "28215",
			"countryCode": "MT",
			"remark": "Address Remark"
		}],
		"companyPhoneList": [{
			"id": 789,
			"primary": true,
			"phoneLocationType": {
				"id": 6,
				"code": "6",
				"name": "Home",
				"nameI18n": "Home"
			},
			"phoneTechType": {
				"id": 1,
				"code": "1",
				"name": "Voice",
				"nameI18n": "Voice"
			},
			"countryAccessCode": "+34",
			"areaCityCode": "B",
			"phoneNumber": "1-(704)134-5395",
			"extension": "1",
			"remark": "Phone Remark"
		}],
		"companyTaxAddress": {
			"id": 779,
			"communicationLocationType": null,
			"street": "231 Oneill Way",
			"city": "Charlotte",
			"stateProvName": "North Carolina",
			"stateProvCode": null,
			"postalCode": "28215",
			"countryCode": "KE",
			"remark": "Address Remark"
		},
		"remark": "Company Remarks",
		"assignedUser": null
	},
	"customer": null,
	"travelAgent": null,
	"folioInvoiceOwner": {
		"reservation": null,
				"offerPercentDiscountreservationRoomStay": null,
				"promotionreservationGroup": null,
				"promotionAmountDiscountdeposit": null,
				"promotionPercentDiscountcustomer": null,
				"productBoardcompany": {
					"id": 11222,
					"name": "HalfBoardTesipro MAD",
				}"code": "TESMA",
				"boardPriceAdulttaxId": 20"ABCDE",
				"boardPriceJuniorcompanyEmailList": null,
			"companyAddressList": [{
				"boardPriceChildid": null22,
				"boardPriceInfantprimary": nulltrue,
				"paymentTypecommunicationLocationType": {
					"id": 51,
					"code": "AG1",
					"name": "Pay Agency GuestHome",
					"nameI18n": "Home"
				},
				"propertyPolicystreet": {
	"9 Weeping Birch Crossing",
				"idcity": 57"Orange",
					"codestateProvName": "24HSoria",
					"namestateProvCode": "24 Hours Before Arrival"
				}ES-SO",
				"propertySourcepostalCode": {"92862",
					"idcountryCode": 2"ES",
					"coderemark": "AGEAddress Remark",
			}],
			"namecompanyPhoneList": "Agency"
null,
			"companyTaxAddress": {
				}"id": 3,
				"propertySegmentcommunicationLocationType": {null,
					"idstreet": 101 "9 Weeping Birch Crossing",
					"codecity": "EMPOrange",
					"namestateProvName": "Employee"
				}Cáceres",
				"propertyChannelstateProvCode": {"ES-CC",
					"idpostalCode": 24"92862",
					"codecountryCode": "IDSES",
					"nameremark": "IDSAddress Remark"
				},
				"postingDateremark": "Company Remarks",
"2019-05-02"
			"assignedUser": null,
			}"profileType": null
		]},
		"reservationRoomStayServiceListtravelAgent": null
	}
}