Operation
Version minifield of the list folio, use for POS.
GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/folio/pos
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 | ||
| 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/pos
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 | RoomPOS | false | Room where the Folio is linked to. |
| reservationRoomStaySummary | ReservationRoomStaySummaryPOS | false | ReservationRoomStay where the Folio is linked to. |
{
"count": 4,
"offset": 0,
"limit": 10,
"list": [ {
"id" : 87,
"sequence" : 28727,
"code" : "ATRX",
"serie" : 1,
"name" : "ATRAPALO.COM S.L.",
"folioType" : {
"id" : 1,
"code" : "M",
"name" : "Main",
"nameI18n" : "Main"
},
"room" : null,
"reservationRoomStaySummary" : null
}, {
"id" : 89,
"sequence" : 37095,
"code" : "CAF ",
"serie" : 1,
"name" : " , CAFETERIA",
"folioType" : {
"id" : 1,
"code" : "M",
"name" : "Main",
"nameI18n" : "Main"
},
"room" : null,
"reservationRoomStaySummary" : null
}, {
"id" : 96,
"sequence" : 36711,
"code" : "DESA",
"serie" : 1,
"name" : " , CONTADOS/TARJETAS DESAYUNOS",
"folioType" : {
"id" : 1,
"code" : "M",
"name" : "Main",
"nameI18n" : "Main"
},
"room" : null,
"reservationRoomStaySummary" : null
},
{
"id" : 15520,
"sequence" : 37550,
"code" : "413",
"serie" : 2,
"name" : "BLOKZIJL BLOKZIJL, SEBASTIAAN",
"folioType" : {
"id" : 2,
"code" : "E",
"name" : "Extra",
"nameI18n" : "Extra"
},
"room" : {
"id" : 201,
"code" : "413"
},
"reservationRoomStaySummary" : {
"id" : 11661,
"arrival" : "2022-03-16",
"departure" : "2022-03-17",
"adult" : 3,
"board" : {
"id" : 1,
"code" : "SA",
"name" : "Sólo Alojamiento",
"serviceList" : null
},
"guest" : "BLOKZIJL BLOKZIJL, SEBASTIAAN",
"hasCredit" : false,
"creditAvailable" : -91.340000,
"customerPreference" : "Fumador, Mascotas, Spa incluido"
}
} ]
}