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://publicapi-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" : 11155,
  	"code" : "110105",
  	"serie" : 1,
  	"name" : "Nancy Léana MorrisonSkinder",
  	"folioType" : {
    		"id" : 1,
    		"code" : "M",
    		"name" : "Main"
  },
  		"roomnameI18n" : {
    "Main"
	},
	"room": {
		"id" : 105,
    		"code" : "110105",
    		"name" : "110105",
    		"roomSpaceStatusType" : {
      			"id" : 2,
      			"code" : "DI",
			"name":      "name" "Dirty",
			"nameI18n": "Dirty"
    		},
    		"reservationRoomStay" : null
  },
  		"reservationRoomStaySummaryroomSituationType" : {
    			"id" : 112,
    "reservationRoomStay" : null,
    "reservationRoomStayId" : 11,
    "reservation" : null,
    "reservationId" : 7,
    "pmsLocator" : "ALI00000007/11",
    "crsLocator" : null,
    "otaLocator" : null,
    "cmLocator" : null,
    "holder" : null,
    "arrival" : "2020-02-04",
    "departure" : "2020-02-07",
    "nights" : 3,
    "productAccommodation" : {
      "id" : 632,
      "name" : "Single"
    },
    "productAccommodationUpgrade" : null,
    "roomType" : null,
    "adult" : 1,
    "junior" : 0,
    "child" : 0,
    "infant" : 0,
    "extraBed" : 0,
    "extraCot" : 0,
    "board" : {
      "id" : 7,
      "code" : null,
      "name" : "HalfBoard",
      "serviceList" : [ {
        "id" : 61,
        "name" : "Breakfast"
      }, {
        "id" : 66,
        "name" : "Dinner"
      } ]
    },
    "guest" : "Nancy Léana Morrison",
    "allotment" : null,
    "rate" : {
      "id" : 2,
      "code" : "BAR",
      "name" : "Best Available Rate"
    },
    "offer" : {
      "id" : 2,
      "code" : "NR",
      "name" : "Non Refundable"
    },
    "promotion" : null,
    "accommodationAmount" : 467.700000,
    "boardAmount" : 156.000000,
    "serviceAmount" : 120.000000,
    "totalAmount" : 743.700000,
    "currency" : {
      "id" : 1,
      "code" : "EUR",
      "name" : "Euro"
    },
    "booker" : {
      "id" : 911,
      "name" : "Wordtune",
      "code" : null,
      "taxId" : "34233900",
      "iataId" : null,
      "companyEmailList" : [ {
        "id" : 911,
        "primary" : true,
        "emailAddressType" : {
          "id" : 1,
          "code" : "1",
          "name" : "Personal"
        },
        "email" : "nmorrisonoz@ehow.com",
        "remark" : null
      } ],
      "companyAddressList" : [ {
        "id" : 911,
        "primary" : true,
        "communicationLocationType" : {
          "id" : 1,
          "code" : "1",
          "name" : "Home"
        },
        "street" : "8 Glendale Place",
        "city" : "Sarasota",
        "stateProvName" : "Álava",
        "stateProvCode" : "ES-VI",
        "postalCode" : "34233",
        "countryCode" : "ES",
        "remark" : "Address Remark"
      } ],
      "companyPhoneList" : [ {
        "id" : 911,
        "primary" : true,
        "phoneLocationType" : {
          "id" : 6,
          "code" : "6",
          "name" : "Home"
        },
        "phoneTechType" : {
          "id" : 1,
          "code" : "1",
          "name" : "Voice"
        },
        "countryAccessCode" : "+34",
        "areaCityCode" : "B",
        "phoneNumber" : "1-(941)176-0996",
        "extension" : "1",
        "remark" : "Phone Remark"
      } ],
      "companyTaxAddress" : {
        "id" : 901,
        "communicationLocationType" : null,
        "street" : "8 Glendale Place",
        "city" : "Sarasota",
        "stateProvName" : "Pontevedra",
        "stateProvCode" : "ES-PO",
        "postalCode" : "34233",
        "countryCode" : "ES",
        "remark" : "Address Remark"
      },
      "remark" : "Company Remarks"
    },
    "billTo" : {
      "id" : 836,
      "name" : "Dabtype",
      "code" : null,
      "taxId" : "40293825",
      "iataId" : null,
      "companyEmailList" : [ {
        "id" : 836,
        "primary" : true,
        "emailAddressType" : {
          "id" : 1,
          "code" : "1",
          "name" : "Personal"
        },
        "email" : "jfoxmw@sfgate.com",
        "remark" : null
      } ],
      "companyAddressList" : [ {
        "id" : 836,
        "primary" : true,
        "communicationLocationType" : {
          "id" : 1,
          "code" : "1",
          "name" : "Home"
        },
        "street" : "52865 Main Drive",
        "city" : "Louisville",
        "stateProvName" : "Kentucky",
        "stateProvCode" : null,
        "postalCode" : "40293",
        "countryCode" : "LA",
        "remark" : "Address Remark"
      } ],
      "companyPhoneList" : [ {
        "id" : 836,
        "primary" : true,
        "phoneLocationType" : {
          "id" : 6,
          "code" : "6",
          "name" : "Home"
        },
        "phoneTechType" : {
          "id" : 1,
          "code" : "1",
          "name" : "Voice"
        },
        "countryAccessCode" : "+34",
        "areaCityCode" : "B",
        "phoneNumber" : "1-(502)141-5836",
        "extension" : "1",
        "remark" : "Phone Remark"
      } ],
      "companyTaxAddress" : {
        "id" : 826,
        "communicationLocationType" : null,
        "street" : "52865 Main Drive",
        "city" : "Louisville",
        "stateProvName" : "Kentucky",
        "stateProvCode" : null,
        "postalCode" : "40293",
        "countryCode" : "ET",
        "remark" : "Address Remark"
      },
      "remark" : "Company Remarks"
    },
    "central" : null,
    "company" : null,
    "room" : {
      "id" : 10,
      "code" : "110",
      "name" : "110",
      "roomSpaceStatusType" : {
        "id" : 2,
        "code" : "DI",
        "name" : "Dirty"
      },
      "reservationRoomStay" : null
    },
    "paymentType" : {
      "id" : 1,
      "code" : "G",
      "name" : "Pay Guest"
    },
    "propertyPolicy" : {
      "id" : 7,
      "code" : "NR",
      "name" : "Non Refundable"
    },
    "propertySource" : {
      "id" : 9,
      "code" : "COM",
      "name" : "Company"
    },
    "propertyChannel" : {
      "id" : 7,
      "code" : "CRS",
      "name" : "CRS"
    },
    "propertySegment" : {
      "id" : 25,
      "code" : "CAGE",
      "name" : "Company Agent"
    },
    "reservationStatusType" : {
      "id" : 4,
      "code" : "IH",
      "name" : "InHouse"
    },
    "expiredDate" : null,
	"hasCredit": true,
	"creditAvailable": 80.000000
  			"code": "OC",
			"name": "Occupied",
			"nameI18n": "Occupied"
		}
	},
	"reservationRoomStaySummary": {
		"id": 70,
		"reservationRoomStay": null,
		"reservationRoomStayId": 70,
		"reservation": null,
		"reservationId": 48,
		"pmsLocator": "ALI00000048/70",
		"crsLocator": null,
		"otaLocator": null,
		"cmLocator": null,
		"holder": "Salomé Olson, Phyllis",
		"arrival": "2020-10-31",
		"departure": "2020-11-15",
		"nights": 15,
		"productAccommodation": {
			"id": 767,
			"name": "Suite",
			"roomType": {
				"id": 77,
				"name": "Suite",
				"nameI18n": "Suite",
				"mainImage": "1/2/propertyroomtypeimages/07aabe64-2724-42ac-8161-29d612d6e17c.jpg"
			}
		},
		"productAccommodationUpgrade": null,
		"roomType": {
			"id": 77,
			"name": "Suite",
			"nameI18n": "Suite",
			"mainImage": "1/2/propertyroomtypeimages/07aabe64-2724-42ac-8161-29d612d6e17c.jpg"
		},
		"adult": 2,
		"junior": 0,
		"child": 0,
		"infant": 0,
		"extraBed": 0,
		"extraCot": 0,
		"board": {
			"id": 8,
			"code": "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
	}
}