Folio List POS [GET]

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": 1,
    "offset": 0,
    "limit": 10,
    "list": [
        {
            "id": 48,
            "sequence": 124,
            "code": "109",
            "serie": 1,
            "name": "Maëlle Diaz, Katherine",
            "folioType": {
                "id": 1,
                "code": "M",
                "name": "Main",
                "nameI18n": "Main"
            },
            "room": {
                "id": 9,
                "code": "109"
            },
            "reservationRoomStaySummary": {
                "id": 19,
                "arrival": "2023-12-24",
                "departure": "2024-01-11",
                "adult": 4,
                "board": {
                    "id": 5,
                    "chainBoardId": 1,
                    "code": "RO",
                    "name": "Room Only",
                    "nameI18n": "Room Only",
                    "serviceList": null
                },
                "guest": "Maëlle Diaz, Katherine",
                "hasCredit": true,
                "creditAvailable": null,
                "customerPreference": null,
                "reservationRoomStayGuestList": [
                    {
                        "id": 44,
                        "profileId": 1338,
                        "documentType": {
                            "id": 5,
                            "code": "D",
                            "name": "National identity document",
                            "nameI18n": "National identity document"
                        },
                        "documentNumber": "sZuPwCRi",
                        "givenName": "Katherine",
                        "surName": "Maëlle",
                        "secondSurName": "Diaz",
                        "genderType": {
                            "id": 1,
                            "code": "M",
                            "name": "Male",
                            "nameI18n": "Male"
                        },
                        "birthDate": "2006-01-16",
                        "birthCountryCode": "ES",
                        "birthPlace": "Cincinnati",
                        "effectiveDate": "2023-01-16",
                        "expireDate": "2026-01-16",
                        "street": "9490 Manufacturers Alley",
                        "city": "Cincinnati",
                        "stateProvName": null,
                        "stateProvCode": "ES-BI",
                        "countryCode": "ES",
                        "postalCode": "45203",
                        "nationalityCountryCode": "ES",
                        "countryOfIssuanceCode": "ES",
                        "ocr": null,
                        "email": "dphillips6y@sciencedirect.com",
                        "phoneNumber": "1-(513)398-3146",
                        "allowMarketing": null,
                        "allowThirdParty": null,
                        "language": null,
                        "registrationNumber": 39,
                        "reservationRoomStayGuestCustomFieldValueSet": null
                    }
                ]
            }
        }
	]
}