Operation

Get a single element of ReservationSummary by its id of Reservation

GET

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/reservation/{reservationId}/summary

Request

Property	Type	Required	Type parameter	Description
chainId	String	true	path parameter	Unique identificator of the chain.
propertyId	Integer	true	path parameter	Unique identificator of the property.
reservationId	Integer	true	path parameter	Unique identificator of the reservation.

Example request

GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/reservation/1/summary

Response

The response is an entity of type ReservationSummary or an error if it's not found.

Entity

Field	Type	Required	Description
id	Integer	true	Unique identifier for the ReservationSummary.
reservationId	Integer	true	The Id of the related Reservation.
reservationGroup	ReservationGroup	false
reservationGroupId	Integer	false
pmsLocator	String		The locator assigned by the PMS.
crsLocator	String		The locator assigned by the CRS.
otaLocator	String		The locator assigned by the OTA.
cmLocator	String		The locator assigned by the CM.
holder	String		Holder name.
holderEmail	String
arrival	LocalDate
departure	LocalDate
roomStay	Integer
nights	Integer
productAccommodation	Accommodation		The room that is going to be charged to the client.
adult	Integer
junior	Integer
child	Integer
infant	Integer
booker	Company
billTo	Company
company	Company
central	Company
board	Board
guest	String
allotment	Allotment
rate	Rate
offer	Offer
promotion	Promotion
accommodationAmount	BigDecimal		Price of the accommodation products.
boardAmount	BigDecimal		Price of the boards.
serviceAmount	BigDecimal		Price of the services.
totalAmount	BigDecimal		Total price.
totalPaid	BigDecimal		Total paid.
balance	BigDecimal		balance.
currency	Currency
booker	Company
billTo	Company
company	Company
central	Company
room	Room
propertyPolicy	Policy
propertySource	Source
propertyChannel	Channel
propertySegment	Segment
reservationStatusType	ReservationStatusType
expiredDate	LocalDate
limitCreditAmount	BigDecimal
hasCredit	Boolean
creditAvailable	BigDecimal		In case there's a limit of credit for the roomStays, this is the subtraction of the limit minus the amount of credit spent on the folios related to this reservation's roomStays.

Example response

{
    "id": 3,
    "reservationId": 3,
    "reservationGroup": null,
    "reservationGroupId": null,
    "pmsLocator": "ALI00000003",
    "crsLocator": null,
    "otaLocator": null,
    "cmLocator": null,
    "holder": "Marie-hélène Perez, Joan",
    "holderEmail": "jperezmd@skyrock.com",
    "arrival": "2021-10-11",
    "departure": "2021-10-14",
    "roomStay": 3,
    "nights": 9,
    "productAccommodation": {
        "id": 677,
        "code": "SGL",
        "name": "Single",
        "productType": {
            "id": 1,
            "code": "ACC",
            "name": "Accommodation",
            "nameI18n": "Accommodation"
        }
    },
    "adult": 4,
    "junior": 0,
    "child": 0,
    "infant": 0,
    "booker": null,
    "billTo": null,
    "central": null,
    "company": {
        "id": 417,
        "name": "Trunyx",
        "code": "TRUNY3",
        "taxId": "50362395",
        "companyEmailList": [
            {
                "id": 417,
                "primary": true,
                "emailAddressType": {
                    "id": 1,
                    "code": "1",
                    "name": "Personal",
                    "nameI18n": "Personal"
                },
                "email": "criceay@simplemachines.org",
                "remark": null
            }
        ],
        "companyAddressList": [
            {
                "id": 417,
                "primary": true,
                "communicationLocationType": {
                    "id": 1,
                    "code": "1",
                    "name": "Home",
                    "nameI18n": "Home"
                },
                "street": "9 Chinook Junction",
                "city": "Des Moines",
                "stateProvName": "Iowa",
                "stateProvCode": null,
                "postalCode": "50362",
                "countryCode": "GW",
                "remark": "Address Remark"
            }
        ],
        "companyPhoneList": [
            {
                "id": 417,
                "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-(515)746-4886",
                "extension": "1",
                "remark": "Phone Remark"
            }
        ],
        "companyTaxAddress": {
            "id": 398,
            "communicationLocationType": null,
            "street": "9 Chinook Junction",
            "city": "Des Moines",
            "stateProvName": "Iowa",
            "stateProvCode": null,
            "postalCode": "50362",
            "countryCode": "PH",
            "remark": "Address Remark"
        },
        "remark": "Company Remarks",
        "assignedUser": null,
        "profileType": {
            "id": 2,
            "code": "2",
            "name": "Company",
            "nameI18n": "Company",
            "colorCode": "#00ACC1"
        },
        "companyCustomFieldValueList": null
    },
    "board": {
        "id": 5,
        "code": "RO",
        "name": "Room Only",
        "serviceList": null
    },
    "propertyPolicy": {
        "id": 7,
        "code": "NR",
        "name": "Non Refundable"
    },
    "propertySource": {
        "id": 12,
        "code": "EMA",
        "name": "Email"
    },
    "propertyChannel": {
        "id": 12,
        "code": "WEBM",
        "name": "Booking Engine Mobile"
    },
    "propertySegment": {
        "id": 23,
        "code": "SPO",
        "name": "Sport Teams"
    },
    "guest": "Françoise Kennedy, Willie",
    "currency": {
        "id": 1,
        "code": "EUR",
        "name": "Euro",
        "nameI18n": "Euro",
        "symbol": "€",
        "decimalPlaces": 2
    },
    "room": {
        "id": 6,
        "code": "106",
        "name": "106",
        "roomSpaceStatusType": {
            "id": 2,
            "code": "DI",
            "name": "Dirty",
            "nameI18n": "Dirty"
        },
        "reservationRoomStay": null,
        "roomSituationType": {
            "id": 2,
            "code": "OC",
            "name": "Occupied",
            "nameI18n": "Occupied"
        }
    },
    "accommodationAmount": 1011.000000,
    "boardAmount": 464.100000,
    "serviceAmount": 0.000000,
    "totalAmount": 1475.100000,
    "totalPaid": 1375.100000,
    "balance": 100.000000,
    "reservationStatusType": {
        "id": 5,
        "code": "CO",
        "name": "CheckedOut",
        "nameI18n": "CheckedOut",
        "colorCode": "#757575"
    },
	"reservationType" : {
        "id": 2,
        "chainId": 1,
        "propertyId": 2,
        "code": "PREVIEW",
        "name": "Pending Review",
        "colorCode": "#FDD835",
        "active": true
    },
    "expiredDate": null,
    "limitCreditAmount": null,
    "hasCredit": true,
    "creditAvailable": null
}

Browser not supported