Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Current »

Operation


This endpoint will give as a result the booking forecast for a given date compared against the same day the previous year
GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/propertyManagement/bookingForecast


Request


PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
property identificator.
datedatefalsepath parameter

revenuePriceModelTypeId

Boolean
falserequest parameter
1 GROSS
2 NET
3 MIX

Example request

GET https://publicapi-providers.ulysescloud.com/public/api/v1/con/chain/1/property/2/propertyManagement/bookingForecast?date=2020-01-01&revenuePriceModelTypeId=1


Response

Entity

Field

Type

Required

Description

chainRoomType

ChainRoomType

combined

Boolean

physicalRoomDay

Integer

outOfOrderDay

Integer

arrivalDay

Integer

departureDay

Integer

reservedDay

Integer

availableDay

Integer

noShowDay

Integer

noShowArrivalDay

Integer

reservedHouseUseDay

Integer

arrivalAdultDay

Integer

departureAdultDay

Integer

reservedAdultDay

Integer

noShowAdultDay

Integer

reservedHouseUseAdultDay

Integer

revenueAmountBeforeTaxDay

BigDecimal

occupancyPercentageDay

BigDecimal

adrDay

BigDecimal

revparDay

BigDecimal

previousYearPhysicalRoomDay

Integer

previousYearOutOfOrderDay

Integer

previousYearArrivalDay

Integer

previousYearDepartureDay

Integer

previousYearReservedDay

Integer

previousYearAvailableDay

Integer

previousYearNoShowDay

Integer

previousYearNoShowArrivalDay

Integer

previousYearReservedHouseUseDay

Integer

previousYearArrivalAdultDay

Integer

previousYearDepartureAdultDay

Integer

previousYearReservedAdultDay

Integer

previousYearNoShowAdultDay

Integer

previousYearReservedHouseUseAdultDay

Integer

previousYearRevenueAmountBeforeTaxDay

BigDecimal

previousYearOccupancyPercentageDay

BigDecimal

previousYearAdrDay

BigDecimal

previousYearRevparDay

BigDecimal

differencePreviousYearPhysicalRoomDay

Integer

differencePreviousYearOutOfOrderDay

Integer

differencePreviousYearArrivalDay

Integer

differencePreviousYearDepartureDay

Integer

differencePreviousYearReservedDay

Integer

differencePreviousYearAvailableDay

Integer

differencePreviousYearNoShowDay

Integer

differencePreviousYearNoShowArrivalDay

Integer

differencePreviousYearReservedHouseUseDay

Integer

differencePreviousYearArrivalAdultDay

Integer

differencePreviousYearDepartureAdultDay

Integer

differencePreviousYearReservedAdultDay

Integer

differencePreviousYearNoShowAdultDay

Integer

differencePreviousYearReservedHouseUseAdultDay

Integer

differencePreviousYearRevenueAmountBeforeTaxDay

BigDecimal

differencePreviousYearOccupancyPercentageDay

BigDecimal

differencePreviousYearAdrDay

BigDecimal

differencePreviousYearRevparDay

BigDecimal

physicalRoomMonth

Integer

outOfOrderMonth

Integer

arrivalMonth

Integer

departureMonth

Integer

reservedMonth

Integer

availableMonth

Integer

noShowMonth

Integer

noShowArrivalMonth

Integer

reservedHouseUseMonth

Integer

arrivalAdultMonth

Integer

departureAdultMonth

Integer

reservedAdultMonth

Integer

noShowAdultMonth

Integer

reservedHouseUseAdultMonth

Integer

revenueAmountBeforeTaxMonth

BigDecimal

occupancyPercentageMonth

BigDecimal

adrMonth

BigDecimal

revparMonth

BigDecimal

previousYearPhysicalRoomMonth

Integer

previousYearOutOfOrderMonth

Integer

previousYearArrivalMonth

Integer

previousYearDepartureMonth

Integer

previousYearReservedMonth

Integer

previousYearAvailableMonth

Integer

previousYearNoShowMonth

Integer

previousYearNoShowArrivalMonth

Integer

previousYearReservedHouseUseMonth

Integer

previousYearArrivalAdultMonth

Integer

previousYearDepartureAdultMonth

Integer

previousYearReservedAdultMonth

Integer

previousYearNoShowAdultMonth

Integer

previousYearReservedHouseUseAdultMonth

Integer

previousYearRevenueAmountBeforeTaxMonth

BigDecimal

previousYearOccupancyPercentageMonth

BigDecimal

previousYearAdrMonth

BigDecimal

previousYearRevparMonth

BigDecimal

differencePreviousYearPhysicalRoomMonth

Integer

differencePreviousYearOutOfOrderMonth

Integer

differencePreviousYearArrivalMonth

Integer

differencePreviousYearDepartureMonth

Integer

differencePreviousYearReservedMonth

Integer

differencePreviousYearAvailableMonth

Integer

differencePreviousYearNoShowMonth

Integer

differencePreviousYearNoShowArrivalMonth

Integer

differencePreviousYearReservedHouseUseMonth

Integer

differencePreviousYearArrivalAdultMonth

Integer

differencePreviousYearDepartureAdultMonth

Integer

differencePreviousYearReservedAdultMonth

Integer

differencePreviousYearNoShowAdultMonth

Integer

differencePreviousYearReservedHouseUseAdultMonth

Integer

differencePreviousYearRevenueAmountBeforeTaxMonth

BigDecimal

differencePreviousYearOccupancyPercentageMonth

BigDecimal

differencePreviousYearAdrMonth

BigDecimal

differencePreviousYearRevparMonth

BigDecimal

physicalRoomYear

Integer

outOfOrderYear

Integer

arrivalYear

Integer

departureYear

Integer

reservedYear

Integer

availableYear

Integer

noShowYear

Integer

noShowArrivalYear

Integer

reservedHouseUseYear

Integer

arrivalAdultYear

Integer

departureAdultYear

Integer

reservedAdultYear

Integer

noShowAdultYear

Integer

reservedHouseUseAdultYear

Integer

revenueAmountBeforeTaxYear

BigDecimal

occupancyPercentageYear

BigDecimal

adrYear

BigDecimal

revparYear

BigDecimal

previousYearPhysicalRoomYear

Integer

previousYearOutOfOrderYear

Integer

previousYearArrivalYear

Integer

previousYearDepartureYear

Integer

previousYearReservedYear

Integer

previousYearAvailableYear

Integer

previousYearNoShowYear

Integer

previousYearNoShowArrivalYear

Integer

previousYearReservedHouseUseYear

Integer

previousYearArrivalAdultYear

Integer

previousYearDepartureAdultYear

Integer

previousYearReservedAdultYear

Integer

previousYearNoShowAdultYear

Integer

previousYearReservedHouseUseAdultYear

Integer

previousYearRevenueAmountBeforeTaxYear

BigDecimal

previousYearOccupancyPercentageYear

BigDecimal

previousYearAdrYear

BigDecimal

previousYearRevparYear

BigDecimal

differencePreviousYearPhysicalRoomYear

Integer

differencePreviousYearOutOfOrderYear

Integer

differencePreviousYearArrivalYear

Integer

differencePreviousYearDepartureYear

Integer

differencePreviousYearReservedYear

Integer

differencePreviousYearAvailableYear

Integer

differencePreviousYearNoShowYear

Integer

differencePreviousYearNoShowArrivalYear

Integer

differencePreviousYearReservedHouseUseYear

Integer

differencePreviousYearArrivalAdultYear

Integer

differencePreviousYearDepartureAdultYear

Integer

differencePreviousYearReservedAdultYear

Integer

differencePreviousYearNoShowAdultYear

Integer

differencePreviousYearReservedHouseUseAdultYear

Integer

differencePreviousYearRevenueAmountBeforeTaxYear

BigDecimal

differencePreviousYearOccupancyPercentageYear

BigDecimal

differencePreviousYearAdrYear

BigDecimal

differencePreviousYearRevparYear

BigDecimal

Example response

[
    {
        "chainRoomType": {
            "code": "SGL",
            "name": "Single",
            "chainRoomTypeGroupId": 1,
            "order": 1
        },
        "combined": null,
        "physicalRoomDay": 0,
        "outOfOrderDay": 0,
        "arrivalDay": 0,
        "departureDay": 0,
        "reservedDay": 0,
        "availableDay": 0,
        "noShowDay": 0,
        "reservedHouseUseDay": 0,
        "arrivalAdultDay": 0,
        "departureAdultDay": 0,
        "reservedAdultDay": 0,
        "noShowAdultDay": 0,
        "reservedHouseUseAdultDay": 0,
        "revenueAmountBeforeTaxDay": 0.000000,
        "occupancyPercentageDay": 0.000000,
        "adrDay": 0.000000,
        "revparDay": 0.000000,
        "previousYearPhysicalRoomDay": 0,
        "previousYearOutOfOrderDay": 0,
        "previousYearArrivalDay": 0,
        "previousYearDepartureDay": 0,
        "previousYearReservedDay": 0,
        "previousYearAvailableDay": 0,
        "previousYearNoShowDay": 0,
        "previousYearReservedHouseUseDay": 0,
        "previousYearArrivalAdultDay": 0,
        "previousYearDepartureAdultDay": 0,
        "previousYearReservedAdultDay": 0,
        "previousYearNoShowAdultDay": 0,
        "previousYearReservedHouseUseAdultDay": 0,
        "previousYearRevenueAmountBeforeTaxDay": 0.000000,
        "previousYearOccupancyPercentageDay": 0.000000,
        "previousYearAdrDay": 0.000000,
        "previousYearRevparDay": 0.000000,
        "differencePreviousYearPhysicalRoomDay": 0,
        "differencePreviousYearOutOfOrderDay": 0,
        "differencePreviousYearArrivalDay": 0,
        "differencePreviousYearDepartureDay": 0,
        "differencePreviousYearReservedDay": 0,
        "differencePreviousYearAvailableDay": 0,
        "differencePreviousYearNoShowDay": 0,
        "differencePreviousYearReservedHouseUseDay": 0,
        "differencePreviousYearArrivalAdultDay": 0,
        "differencePreviousYearDepartureAdultDay": 0,
        "differencePreviousYearReservedAdultDay": 0,
        "differencePreviousYearNoShowAdultDay": 0,
        "differencePreviousYearReservedHouseUseAdultDay": 0,
        "differencePreviousYearRevenueAmountBeforeTaxDay": 0.000000,
        "differencePreviousYearOccupancyPercentageDay": 0.000000,
        "differencePreviousYearAdrDay": 0.000000,
        "differencePreviousYearRevparDay": 0.000000,
        "physicalRoomMonth": 0,
        "outOfOrderMonth": 0,
        "arrivalMonth": 0,
        "departureMonth": 0,
        "reservedMonth": 0,
        "availableMonth": 0,
        "noShowMonth": 0,
        "reservedHouseUseMonth": 0,
        "arrivalAdultMonth": 0,
        "departureAdultMonth": 0,
        "reservedAdultMonth": 0,
        "noShowAdultMonth": 0,
        "reservedHouseUseAdultMonth": 0,
        "revenueAmountBeforeTaxMonth": 0.000000,
        "occupancyPercentageMonth": 0.000000,
        "adrMonth": 0.000000,
        "revparMonth": 0.000000,
        "previousYearPhysicalRoomMonth": 0,
        "previousYearOutOfOrderMonth": 0,
        "previousYearArrivalMonth": 0,
        "previousYearDepartureMonth": 0,
        "previousYearReservedMonth": 0,
        "previousYearAvailableMonth": 0,
        "previousYearNoShowMonth": 0,
        "previousYearReservedHouseUseMonth": 0,
        "previousYearArrivalAdultMonth": 0,
        "previousYearDepartureAdultMonth": 0,
        "previousYearReservedAdultMonth": 0,
        "previousYearNoShowAdultMonth": 0,
        "previousYearReservedHouseUseAdultMonth": 0,
        "previousYearRevenueAmountBeforeTaxMonth": 0.000000,
        "previousYearOccupancyPercentageMonth": 0.000000,
        "previousYearAdrMonth": 0.000000,
        "previousYearRevparMonth": 0.000000,
        "differencePreviousYearPhysicalRoomMonth": 0,
        "differencePreviousYearOutOfOrderMonth": 0,
        "differencePreviousYearArrivalMonth": 0,
        "differencePreviousYearDepartureMonth": 0,
        "differencePreviousYearReservedMonth": 0,
        "differencePreviousYearAvailableMonth": 0,
        "differencePreviousYearNoShowMonth": 0,
        "differencePreviousYearReservedHouseUseMonth": 0,
        "differencePreviousYearArrivalAdultMonth": 0,
        "differencePreviousYearDepartureAdultMonth": 0,
        "differencePreviousYearReservedAdultMonth": 0,
        "differencePreviousYearNoShowAdultMonth": 0,
        "differencePreviousYearReservedHouseUseAdultMonth": 0,
        "differencePreviousYearRevenueAmountBeforeTaxMonth": 0.000000,
        "differencePreviousYearOccupancyPercentageMonth": 0.000000,
        "differencePreviousYearAdrMonth": 0.000000,
        "differencePreviousYearRevparMonth": 0.000000,
        "physicalRoomYear": 0,
        "outOfOrderYear": 0,
        "arrivalYear": 0,
        "departureYear": 0,
        "reservedYear": 0,
        "availableYear": 0,
        "noShowYear": 0,
        "reservedHouseUseYear": 0,
        "arrivalAdultYear": 0,
        "departureAdultYear": 0,
        "reservedAdultYear": 0,
        "noShowAdultYear": 0,
        "reservedHouseUseAdultYear": 0,
        "revenueAmountBeforeTaxYear": 0.000000,
        "occupancyPercentageYear": 0.000000,
        "adrYear": 0.000000,
        "revparYear": 0.000000,
        "previousYearPhysicalRoomYear": 0,
        "previousYearOutOfOrderYear": 0,
        "previousYearArrivalYear": 0,
        "previousYearDepartureYear": 0,
        "previousYearReservedYear": 0,
        "previousYearAvailableYear": 0,
        "previousYearNoShowYear": 0,
        "previousYearReservedHouseUseYear": 0,
        "previousYearArrivalAdultYear": 0,
        "previousYearDepartureAdultYear": 0,
        "previousYearReservedAdultYear": 0,
        "previousYearNoShowAdultYear": 0,
        "previousYearReservedHouseUseAdultYear": 0,
        "previousYearRevenueAmountBeforeTaxYear": 0.000000,
        "previousYearOccupancyPercentageYear": 0.000000,
        "previousYearAdrYear": 0.000000,
        "previousYearRevparYear": 0.000000,
        "differencePreviousYearPhysicalRoomYear": 0,
        "differencePreviousYearOutOfOrderYear": 0,
        "differencePreviousYearArrivalYear": 0,
        "differencePreviousYearDepartureYear": 0,
        "differencePreviousYearReservedYear": 0,
        "differencePreviousYearAvailableYear": 0,
        "differencePreviousYearNoShowYear": 0,
        "differencePreviousYearReservedHouseUseYear": 0,
        "differencePreviousYearArrivalAdultYear": 0,
        "differencePreviousYearDepartureAdultYear": 0,
        "differencePreviousYearReservedAdultYear": 0,
        "differencePreviousYearNoShowAdultYear": 0,
        "differencePreviousYearReservedHouseUseAdultYear": 0,
        "differencePreviousYearRevenueAmountBeforeTaxYear": 0.000000,
        "differencePreviousYearOccupancyPercentageYear": 0.000000,
        "differencePreviousYearAdrYear": 0.000000,
        "differencePreviousYearRevparYear": 0.000000
    }
...
]
  • No labels