Operation
Information of the operation
GET
https://{environment}.ulysescloud.com/public/api/{version}/chain/{chainId}/property/{propertyId}/folio/{folioId}
Request
| Property | Type | Required | Default value | Description |
|---|---|---|---|---|
| chainId | Integer | true | Unique identificator of the chain. | |
| propertyId | Integer | true | Unique identificator of the property. | |
| folioId | Integer | true | Unique identificator of the folio. |
Example request
GET https://prod.ulysescloud.com/public/api/v1/chain/1/property/1/folio/1
Response
| Property | Type | Required | Description |
|---|---|---|---|
| folio | Folio | The Folio requested by its Id. |
Entity
ReservationRoomStaySummaryField Type Required Description id int true Unique identifier for the Product. code string false Code of the folio sequence int true Sequence of the folio serie int true Numbered serie of the Folio. name string true Name of the Folio. folioType string true Type of the Folio. room Room false Room where the Folio is linked to. reservationRoomStaySummary ReservationRoomStaySummary false ReservationRoomStay where the Folio is linked to. reservationSummary ReservationSummary false reservationGroup ReservationGroup false company Company false customer Customer false travelAgent TravelAgent false deposit Deposit false paidAmount BigDecimal false balanceAmount BigDecimal false totalAmount BigDecimal false
Example response
{
"id": 31,
"serie": 1,
"name": "Gregory Bénédicte Ferguson",
"folioType": {
"id": 1,
"code": "M",
"name": "Main"
},
"roomModel": {
"id": 9,
"code": "109",
"name": "109",
"roomSpaceStatusType": {
"id": 1,
"code": "CL",
"name": "Clean"
},
"reservationRoomStay": null
},
"reservationRoomStayModel": {
"id": 20,
"reservationStatusType": {
"id": 4,
"code": "IH",
"name": "InHouse"
},
"arrival": "2020-01-18",
"departure": "2020-01-19",
"arrivalTime": null,
"departureTime": null,
"quantity": 1,
"accommodation": {
"id": 632,
"name": "Single"
},
"room": {
"id": 9,
"code": "109",
"name": "109",
"roomSpaceStatusType": {
"id": 1,
"code": "CL",
"name": "Clean"
},
"reservationRoomStay": null
},
"adult": 1,
"junior": 0,
"child": 0,
"infant": 0,
"productFee": {
"id": 767,
"name": "City Tax Barcelona"
},
"adultFee": 0,
"juniorFee": 0,
"childFee": 0,
"infantFee": 0,
"pmsLocator": "ALI00000020/25",
"crsLocator": null,
"otaLocator": null,
"cmLocator": null,
"remark": null,
"mainBoard": {
"id": 6,
"code": null,
"name": "Bed And Breakfast",
"serviceList": [
{
"id": 61,
"name": "Breakfast"
}
]
},
"reservationRoomStayGuests": [
{
"id": 35,
"documentType": {
"id": 2,
"code": "2",
"name": "Passport"
},
"documentNumber": "cagdROWL",
"givenName": "Gregory",
"middleName": "Bénédicte",
"surName": "Ferguson",
"genderType": {
"id": 1,
"code": "M",
"name": "Male"
},
"birthDate": "2002-02-13",
"birthCountryCode": "CF",
"birthPlace": "Van Nuys",
"effectiveDate": "2019-02-13",
"expireDate": "2019-02-13",
"street": "9417 Buena Vista Terrace",
"city": "Van Nuys",
"stateProvName": "California",
"stateProvCode": null,
"countryCode": "CF",
"postalCode": "91411",
"nationalityCountryCode": "CF",
"ocr": null,
"email": "alongf4@seesaa.net",
"phoneNumber": "1-(661)969-2605"
}
],
"reservationRoomStayDaily": [
{
"id": 65,
"date": "2020-01-18",
"room": {
"id": 9,
"code": "109",
"name": "109",
"roomSpaceStatusType": {
"id": 1,
"code": "CL",
"name": "Clean"
},
"reservationRoomStay": null
},
"allotment": null,
"rate": {
"id": 1,
"code": "BAR",
"name": "Best Available Rate"
},
"price": 124.200000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"offer": {
"id": 1,
"code": "NR",
"name": "Non Refundable"
},
"offerAmountDiscount": 0.000000,
"offerPercentDiscount": 10.000000,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"board": {
"id": 6,
"code": null,
"name": "Bed And Breakfast",
"serviceList": [
{
"id": 61,
"name": "Breakfast"
}
]
},
"boardPriceAdult": 22.000000,
"boardPriceJunior": 49.000000,
"boardPriceChild": 0.000000,
"boardPriceInfant": 0.000000,
"paymentType": {
"id": 1,
"code": "G",
"name": "Pay Guest"
},
"propertyPolicy": {
"id": 7,
"code": "NR",
"name": "Non Refundable"
},
"propertySource": {
"id": 12,
"code": "EMA",
"name": "Email"
},
"propertySegment": {
"id": 25,
"code": "CAGE",
"name": "Company Agent"
},
"propertyChannel": {
"id": 8,
"code": "GDS",
"name": "GDS"
},
"booker": null,
"billTo": {
"id": 121,
"name": "Jaxnation",
"code": null,
"taxId": "78230110",
"iataId": null,
"companyEmailList": [
{
"id": 121,
"primary": true,
"emailAddressType": {
"id": 1,
"code": "1",
"name": "Personal"
},
"email": "wpeters31@ning.com",
"remark": null
}
],
"companyAddressList": [
{
"id": 121,
"primary": true,
"communicationLocationType": {
"id": 1,
"code": "1",
"name": "Home"
},
"street": "29 Farmco Drive",
"city": "San Antonio",
"stateProvName": "Pontevedra",
"stateProvCode": "ES-PO",
"postalCode": "78230",
"countryCode": "ES",
"remark": "Address Remark"
}
],
"companyPhoneList": [
{
"id": 121,
"primary": true,
"phoneLocationType": {
"id": 6,
"code": "6",
"name": "Home"
},
"phoneTechType": {
"id": 1,
"code": "1",
"name": "Voice"
},
"countryAccessCode": "+34",
"areaCityCode": "B",
"phoneNumber": "1-(830)708-5101",
"extension": "1",
"remark": "Phone Remark"
}
],
"companyTaxAddress": {
"id": 111,
"communicationLocationType": null,
"street": "29 Farmco Drive",
"city": "San Antonio",
"stateProvName": "Zamora",
"stateProvCode": "ES-ZA",
"postalCode": "78230",
"countryCode": "ES",
"remark": "Address Remark"
},
"remark": "Company Remarks"
},
"central": null,
"company": {
"id": 997,
"name": "Oozz",
"code": null,
"taxId": "87110986",
"iataId": null,
"companyEmailList": [
{
"id": 997,
"primary": true,
"emailAddressType": {
"id": 1,
"code": "1",
"name": "Personal"
},
"email": "ldayrd@phpbb.com",
"remark": null
}
],
"companyAddressList": [
{
"id": 997,
"primary": true,
"communicationLocationType": {
"id": 1,
"code": "1",
"name": "Home"
},
"street": "8581 Delladonna Trail",
"city": "Albuquerque",
"stateProvName": "Albacete",
"stateProvCode": "ES-AB",
"postalCode": "87110",
"countryCode": "ES",
"remark": "Address Remark"
}
],
"companyPhoneList": [
{
"id": 997,
"primary": true,
"phoneLocationType": {
"id": 6,
"code": "6",
"name": "Home"
},
"phoneTechType": {
"id": 1,
"code": "1",
"name": "Voice"
},
"countryAccessCode": "+34",
"areaCityCode": "B",
"phoneNumber": "1-(505)216-1400",
"extension": "1",
"remark": "Phone Remark"
}
],
"companyTaxAddress": {
"id": 987,
"communicationLocationType": null,
"street": "8581 Delladonna Trail",
"city": "Albuquerque",
"stateProvName": "Barcelona",
"stateProvCode": "ES-B",
"postalCode": "87110",
"countryCode": "ES",
"remark": "Address Remark"
},
"remark": "Company Remarks"
}
}
],
"reservationRoomStayServiceList": [
{
"id": 27,
"service": {
"id": 74,
"name": "Parking"
},
"startDate": "2020-01-18",
"endDate": "2020-01-19",
"quantity": 1,
"reservationRoomStayServiceDailyList": [
{
"id": 72,
"date": "2020-01-18",
"rate": null,
"price": 10.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"postingDate": "2020-02-13"
}
]
},
{
"id": 28,
"service": {
"id": 74,
"name": "Parking"
},
"startDate": "2020-01-18",
"endDate": "2020-01-19",
"quantity": 1,
"reservationRoomStayServiceDailyList": [
{
"id": 73,
"date": "2020-01-18",
"rate": null,
"price": 10.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"postingDate": "2020-02-13"
}
]
}
]
}
}