Guest Ledger [GET]

Operation

This endpoint will give as a result the collection of folios opened that will help to calculate the total amount due for a given date

GET

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/propertyManagement/guestLedger

Request

Property	Type	Required	Type parameter	Default value	Description
chainId	Integer	true	path parameter		Unique identificator of the chain.
propertyId	Integer	true	path parameter		property identificator.

Example request

GET https://publicapi-providers.ulysescloud.com/public/api/v1/con/chain/1/property/2/propertyManagement/guestLedger

Response

Entity

Field	Type	Required	Description
propertyCode	String
folioId	Integer
roomId	Integer
folioName	String
roomCode	String
reservationRoomStaySummaryId	Integer
arrival	LocalDate
departure	LocalDate
adult	Integer
bookerName	String
totalAccommodationAmountAfterTax	BigDecimal
totalBoardAmountAfterTax	BigDecimal
totalServiceAmountAfterTax	BigDecimal
totalFeeAmountAfterTax	BigDecimal
totalAmountAfterTax	BigDecimal
paidAmountAfterTax	BigDecimal
balanceAmountAfterTax	BigDecimal

Example response

[
    {
        "propertyCode": "ALI",
        "folioId": 210,
        "roomId": 1,
        "folioName": "Loïs Powell, Matthew",
        "roomCode": "101",
        "reservationRoomStaySummaryId": 98,
        "arrival": "2020-11-09",
        "departure": "2020-11-19",
        "adult": 2,
        "bookerName": null,
        "totalAccommodationAmountAfterTax": 758.550000,
        "totalBoardAmountAfterTax": 0.000000,
        "totalServiceAmountAfterTax": 600.000000,
        "totalFeeAmountAfterTax": 18.000000,
        "totalAmountAfterTax": 1376.550000,
        "paidAmountAfterTax": 0.000000,
        "balanceAmountAfterTax": 1376.550000,
        "creditLimitExceeded": false
    },
...
]