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": 31155,
	"code": "105",
	"serie": 1,
  	"name": "Gregory Bénédicte FergusonSkinder",
  	"folioType": {
    		"id": 1,
    		"code": "M",
    		"name": "Main",
		"nameI18n": "Main"
	},
  	"roomModelroom": {
    		"id": 95,
    		"code": "109105",
    		"name": "109105",
    		"roomSpaceStatusType": {
      			"id": 12,
      			"code": "CLDI",
      			"name": "Clean"
    },
    Dirty",
			"nameI18n": "Dirty"
		},
		"reservationRoomStay": null
  },
  		"reservationRoomStayModelroomSituationType": {
    			"id": 202,
    "reservationStatusType			"code": {       "id": 4,
      "code"OC",
			"name": "IHOccupied",
      "name			"nameI18n": "InHouseOccupied"
    		}
	},
	"reservationRoomStaySummary": {
		"id": 70,
		"arrivalreservationRoomStay": "2020-01-18",
    "departure": "2020-01-19",
    "arrivalTimenull,
		"reservationRoomStayId": 70,
		"reservation": null,
		"reservationId": 48,
		"pmsLocator": "ALI00000048/70",
		"crsLocator": null,
    "departureTime		"otaLocator": null,
    "quantity		"cmLocator": 1null,
		"holder": "Salomé Olson, Phyllis",
		"accommodationarrival": {
      "2020-10-31",
		"departure": "2020-11-15",
		"nights": 15,
		"productAccommodation": {
			"id": 632767,
      			"name": "SingleSuite"
    },
    "room,
			"roomType": {
      				"id": 977,
      "code				"name": "109Suite",
      "name				"nameI18n": "109Suite",
      "roomSpaceStatusType				"mainImage": {         "id": 1,
        "code": "CL",
        1/2/propertyroomtypeimages/07aabe64-2724-42ac-8161-29d612d6e17c.jpg"
			}
		},
		"productAccommodationUpgrade": null,
		"roomType": {
			"id": 77,
			"name": "Clean"
      },
      "reservationRoomStay": null
    },
    Suite",
			"nameI18n": "Suite",
			"mainImage": "1/2/propertyroomtypeimages/07aabe64-2724-42ac-8161-29d612d6e17c.jpg"
		},
		"adult": 12,
    		"junior": 0,
    		"child": 0,
    		"infant": 0,
    "productFee		"extraBed": {
      "id0,
		"extraCot": 7670,
		"board": {
			"id":    "name8,
			"code": "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"
          }
        ]
      }
    ]
  FB",
			"name": "FullBoard",
			"serviceList": [{
					"id": 63,
					"code": "BRK",
					"name": "Breakfast"
				},
				{
					"id": 67,
					"code": "LUNCH",
					"name": "Lunch"
				},
				{
					"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": 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,
		"reservationRoomStay": null,
		"reservationGroup": null,
		"deposit": null,
		"customer": null,
		"company": {
			"id": 22,
			"name": "Tesipro MAD",
			"code": "TESMA",
			"taxId": "ABCDE",
			"companyEmailList": null,
			"companyAddressList": [{
				"id": 22,
				"primary": true,
				"communicationLocationType": {
					"id": 1,
					"code": "1",
					"name": "Home",
					"nameI18n": "Home"
				},
				"street": "9 Weeping Birch Crossing",
				"city": "Orange",
				"stateProvName": "Soria",
				"stateProvCode": "ES-SO",
				"postalCode": "92862",
				"countryCode": "ES",
				"remark": "Address Remark"
			}],
			"companyPhoneList": null,
			"companyTaxAddress": {
				"id": 3,
				"communicationLocationType": null,
				"street": "9 Weeping Birch Crossing",
				"city": "Orange",
				"stateProvName": "Cáceres",
				"stateProvCode": "ES-CC",
				"postalCode": "92862",
				"countryCode": "ES",
				"remark": "Address Remark"
			},
			"remark": "Company Remarks",
			"assignedUser": null,
			"profileType": null
		},
		"travelAgent": null
	}
}