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
FoliofolioFolio
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,
		}"reservation": null,
		"arrivalreservationId": "2019-04-29"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"
		},
		"adultFee": 1,
		"juniorFeenameI18n": 0, 		"childFeeSuite": 0,
		"infantFee": 0,
		"pmsLocatormainImage": "0000000024/32",
		"crsLocator": null,
		"otaLocator": null,
		"cmLocator": null,
		"remark": null1/2/propertyroomtypeimages/07aabe64-2724-42ac-8161-29d612d6e17c.jpg"
			}
		},
		"mainProductBoardproductAccommodationUpgrade": null,
		"reservationRoomStayGuestsroomType": [{
			"id": 4877,
			"documentTypename": { 				"idSuite": 5,
				"codenameI18n": "5Suite",
				"namemainImage": "National identity document1/2/propertyroomtypeimages/07aabe64-2724-42ac-8161-29d612d6e17c.jpg"
			},
			"documentNumberadult": 2,
		"hcHieiOTjunior": 0,
			"givenNamechild": 0,
		"Richardinfant": 0,
			"middleNameextraBed": "Réjane"0,
			"surNameextraCot": "Wells"0,
			"genderTypeboard": {
				"id": 28,
				"code": "FFB",
				"name": "FemaleFullBoard"
			},
			"birthDateserviceList": "2001-04-30",[{
			"birthCountry": {
				"id": 19963,
					"code": "ESPBRK",
					"name": "SPAINBreakfast"
				},
			"birthPlace	{
					"id": "Peoria"67,
					"effectiveDatecode": "2018-04-30LUNCH",
					"expireDatename": "2018-04-30Lunch",
			"street": "9101 Portage Street",
			"city": "Peoria",
			"stateProvName": null,
			"stateProv": {
				"id": 1,
				"code": "ES-C",
				"name": "La Coruña",
				"country				},
				{
					"id": 68,
					"code": "DINNER",
					"name": "Dinner"
				}
			]
		},
		"guest": "Måns Woods, James",
		"allotment": null,
		"rate": {
			"id": 2,
			"code": "BAR",
			"name": "Best Available Rate"
		},
		"offer": null,
		"promotion": null,
		"accommodationAmount": 4620.000000,
		"boardAmount": 2730.000000,
		"serviceAmount": 0.000000,
		"totalAmount": 7350.000000,
		"totalPaid": 7250.000000,
		"balance": 100.000000,
		"currency": {
			"id": 1,
			"code": "EUR",
			"name": "Euro",
			"nameI18n": "Euro"
		},
		"booker": {
			"id": 860,
			"name": "Tagchat",
			"code": "TAGCH",
			"taxId": "49510847",
			"companyEmailList": [{
				"id": 860,
				"primary": true,
				"emailAddressType": {
					"id": 1,
					"code": "1",
					"name": "Personal",
					"nameI18n": "Personal"
				},
				"email": "rpattersonni@state.gov",
				"remark": null
			}],
			"companyAddressList": [{
				"id": 860,
				"primary": true,
				"communicationLocationType": {
					"id": 1,
					"code": "1",
					"name": "Home",
					"nameI18n": "Home"
				},
				"street": "4796 Iowa Crossing",
				"city": "Grand Rapids",
				"stateProvName": "Huesca",
				"stateProvCode": "ES-HU",
				"postalCode": "49510",
				"countryCode": "ES",
				"remark": "Address Remark"
			}],
			"companyPhoneList": [{
				"id": 860,
				"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-(616)551-2913",
				"extension": "1",
				"remark": "Phone Remark"
			}],
			"companyTaxAddress": {
				"id": 850,
				"communicationLocationType": null,
				"street": "4796 Iowa Crossing",
				"city": "Grand Rapids",
				"stateProvName": "Madrid",
				"stateProvCode": "ES-M",
				"postalCode": "49510",
				"countryCode": "ES",
				"remark": "Address Remark"
			},
			"remark": "Company Remarks",
			"assignedUser": null
		},
		"billTo": {
			"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
		},
		"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": 1995,
					"code": "ESP105",
					"name": "SPAIN"
				}
			}105",
			"countryroomSpaceStatusType": {
				"id": 1992,
				"code": "ESPDI",
				"name": "SPAINDirty",
				"nameI18n": "Dirty"
			},
			"postalCodereservationRoomStay": "85383"null,
			"nationalityCountryroomSituationType": {
				"id": 1992,
				"code": "ESPOC",
				"name": "SPAINOccupied"
			},
			"ocr": null,
			"emailnameI18n": "jbailey6n@berkeley.eduOccupied",
			"phoneNumber": "1-(928)620-1967"	}
		}],
		"reservationRoomStayDailypaymentType": [{
				"id": 784,
				"datecode": "2019-04-29AA",
				"allotmentname": null "Pay Agency Agency",
				"ratenameI18n": { "Pay Agency Agency"
			},
		"idpropertyPolicy": 1,{
					"codeid": "BAR"12,
					"namecode": "Best Rate Available"
				}"24H",
				"pricename": 358,"24 Hours 1 Night"
		},
		"currencypropertySource": {
					"id": 19,
					"code": "EURCOM",
					"name": "EuroCompany"
				},
				"offerpropertyChannel": null,{
				"offerAmountDiscountid": null9,
				"offerPercentDiscountcode": null"IDS",
				"promotionname": null,
				"promotionAmountDiscount": null,"Internet Distribution System"
		},
		"promotionPercentDiscountpropertySegment": null,{
				"productBoardid": {21,
					"idcode": 112"CONV",
					"name": "HalfBoardConventions"
				},
				"boardPriceAdultreservationStatusType": 20,{
				"boardPriceJuniorid": null4,
				"boardPriceChildcode": null,
				"boardPriceInfant": null"IH",
				"paymentTypename": { 					"id": 5"InHouse",
					"codenameI18n": "AGInHouse",
					"namecolorCode": "Pay Agency Guest#64b5f6"
				},
				"propertyPolicyexpiredDate": {null,
					"idhasCredit": 57true,
					"codecreditAvailable": "24H"null
	},
					"namereservation": {
"24 Hours Before Arrival"
				},
				"id": 1,
		"propertySourcereservationHolder": {
					"id": 21,
			"documentNumber": null,
			"codegivenName": "AGEChristine",
					"namesurName": "AgencyRuò",
				}"secondSurName": "Castillo",
				"propertySegmentstreet": {null,
					"idcity": 101null,
					"codestateProvName": "EMP"null,
					"namestateProvCode": "Employee"null,
				}"postalCode": null,
				"propertyChannelcountryCode": {"IN",
					"idemail": 24"ccastilloqp@livejournal.com",
					"codephoneNumber": "IDS1-(713)318-2646",
			"language": null,
			"namedocumentType": "IDS"null
				},
				"postingDatepmsLocator": "2019-04-30ALI00000001",
			}"crsLocator": null,
			{
		"otaLocator": null,
		"idcmLocator": 2061null,
				"dateremark": "2019-04-30ReservationRoomStay remarks",
		"reservationRoomStayList": null
	},
	"allotmentreservationGroup": null,
				"ratecompany": {
					"id": 1789,
			"name": "Skinder",
		"code": "BARSKIND1",
					"nametaxId": "28215776"Best Rate Available",
		"companyEmailList": [{
				}"id": 789,
				"priceprimary": 358true,
				"currencyemailAddressType": {
					"id": 1,
					"code": "EUR1",
					"name": "Euro"
				}Personal",
				"offernameI18n": null"Personal"
			},
				"offerAmountDiscountemail": null"sjacksonlj@rakuten.co.jp",
				"offerPercentDiscountremark": null,
		}],
		"promotioncompanyAddressList": null,[{
				"promotionAmountDiscountid": null789,
				"promotionPercentDiscountprimary": nulltrue,
				"productBoardcommunicationLocationType": {
					"id": 1121,
					"namecode": "HalfBoard1",
				}"name": "Home",
				"boardPriceAdultnameI18n": 20"Home"
			},
				"boardPriceJuniorstreet": null"231 Oneill Way",
				"boardPriceChildcity": null"Charlotte",
				"boardPriceInfantstateProvName": null"North Carolina",
				"paymentTypestateProvCode": {null,
					"idpostalCode": 5"28215",
					"codecountryCode": "AGMT",
					"nameremark": "PayAddress Agency GuestRemark"
				}],
				"propertyPolicycompanyPhoneList": [{
					"id": 57789,
					"codeprimary": "24H"true,
					"namephoneLocationType": "24 Hours Before Arrival"{
				},
				"propertySource"id": {6,
					"idcode": 2"6",
					"codename": "AGEHome",
					"namenameI18n": "AgencyHome"
				},
				"propertySegmentphoneTechType": {
					"id": 1011,
					"code": "EMP1",
					"name": "EmployeeVoice",
				"nameI18n": "Voice"
			},
				"propertyChannelcountryAccessCode": {"+34",
					"idareaCityCode": 24"B",
					"codephoneNumber": "IDS1-(704)134-5395",
					"nameextension": "IDS"
				}1",
				"postingDateremark": "2019-05-01Phone Remark"
			}],
			{
				"id"companyTaxAddress": 2062,{
				"dateid": "2019-05-01"779,
				"allotmentcommunicationLocationType": null,
				"ratestreet": {
					"id": 1,
	"231 Oneill Way",
				"codecity": "BARCharlotte",
					"namestateProvName": "BestNorth Rate Available"
				}Carolina",
				"pricestateProvCode": 358null,
				"currencypostalCode": {
		"28215",
			"idcountryCode": 1"KE",
					"coderemark": "EURAddress Remark",
			},
		"nameremark": "EuroCompany Remarks",
			"assignedUser": null
	},
			"customer": null,
	"offertravelAgent": null,
	"folioInvoiceOwner": {
			"offerAmountDiscountreservation": 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
	}
}