/
Folio List [GET]
Folio List [GET]
- David Garcerán
- Jordi Artal
- Ricardo Vargas (Unlicensed)
- Javier Sanchez
Owned by David Garcerán
Last updated: Dec 12, 2024 by Jordi Artal
Operation
Get a list of Folios
GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/folio
Request
| Property | Type | Required | Type parameter | Default value | Description |
|---|---|---|---|---|---|
| chainId | Integer | true | path parameter | Unique identificator of the chain. | |
| propertyId | Integer | true | path parameter | Unique identificator of the property. | |
| onlyExtras | Boolean | false | request parameter | false | Only gets extra folios for each reservationRoomStay, and if there are not any of that kind, it gets the first main folio. |
| roomId | Integer | false | request parameter | ||
| roomCode | String | false | request parameter | ||
| roomName | String | false | request parameter | ||
| folioCode | String | false | request parameter | we can put sql parameter '%' with codification '%25' for url endpoint use. | |
| reservationStatusTypeId | Integer | false | request parameter | This parameter will return folios of reservations that were marked in a specific status If value is: 1- Status is Reserved 2- Status is Cancelled 3- Status is NoShow 4- Status is inHouse 5- Status is Checkedout | |
| offset | Integer | false | request parameter | 0 | Offset of the array of results. |
| limit | Integer | false | request parameter | 10 | Limit of results. |
| sort | string | false | request parameter | id | Property of the entity to sort by. |
| sortMode | string | false | request parameter | Asc | Mode of sorting. |
Example request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/folio
Response
| Property | Type | Required | Description |
|---|---|---|---|
| Page | Page | true | Description of the response of the success operation |
Entity
The entity returned is a Page with a list of Folios. Description of the Folio entity:
ReservationRoomStaySummary
| Field | 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
{
"count": 13,
"offset": 0,
"limit": 10,
"list": [
{
"id": 155,
"code": "105",
"serie": 1,
"name": "Skinder",
"folioType": {
"id": 1,
"code": "M",
"name": "Main",
"nameI18n": "Main"
},
"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"
}
},
"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,
"profileType": {
"code": "2",
"name": "Company",
"nameI18n": "Company",
"colorCode": "#00ACC1"
}
},
"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,
"profileType": {
"code": "2",
"name": "Company",
"nameI18n": "Company",
"colorCode": "#00ACC1"
}
},
"customer": null,
"travelAgent": null
}
]
}
, multiple selections available,
Related content
Folio List POS [GET]
Folio List POS [GET]
Read with this
Source List [GET]
Source List [GET]
Read with this
Folio
Read with this
List of Room [GET]
List of Room [GET]
More like this
Channel List [GET]
Channel List [GET]
Read with this
Reservation List [GET]
Reservation List [GET]
Read with this