Revenue by Segment [GET]
- Jordi Artal
- Ricardo Vargas (Unlicensed)
Operation
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. | |
| date | date | false | path parameter | ||
| revenuePriceModelTypeId | Integer | false | request parameter | 1 | 1 GROSS 2 NET 3 MIX |
| chainProductGroupIdList | List<Integer> | false | request parameter | 1-Accommodation 2-Food & Beverage 3-Conventions 4-Others | |
| sumAsAccommodationRevenue | Boolean | false | request parameter | Adds to the revenue the service-type products that they specify it add up in the room |
Example request
GET https://publicapi-providers.ulysescloud.com/public/api/v1/con/chain/1/property/2/propertyManagement/revenueSegment?date=2020-01-01&chainProductGroupIdList=1,2,3
Response
Entity
Field Type Required Description segment Segment revenueDay BigDecimal quantityDay Integer paxDay Integer avgRevenueByQuantityDay BigDecimal avgRevenueByPaxDay BigDecimal previousYearRevenueDay BigDecimal previousYearQuantityDay Integer previousYearPaxDay Integer previousYearAvgRevenueByQuantityDay BigDecimal previousYearAvgRevenueByPaxDay BigDecimal differencePreviousYearRevenueDay BigDecimal differencePreviousYearQuantityDay Integer differencePreviousYearPaxDay Integer differencePreviousYearAvgRevenueByQuantityDay BigDecimal differencePreviousYearAvgRevenueByPaxDay BigDecimal budgetRevenueDay BigDecimal budgetQuantityDay Integer budgetPaxDay Integer budgetAvgRevenueByQuantityDay BigDecimal budgetAvgRevenueByPaxDay BigDecimal differenceBudgetRevenueDay BigDecimal differenceBudgetQuantityDay Integer differenceBudgetPaxDay Integer differenceBudgetAvgRevenueByQuantityDay BigDecimal differenceBudgetAvgRevenueByPaxDay BigDecimal revenueMonth BigDecimal quantityMonth Integer paxMonth Integer avgRevenueByQuantityMonth BigDecimal avgRevenueByPaxMonth BigDecimal previousYearRevenueMonth BigDecimal previousYearQuantityMonth Integer previousYearPaxMonth Integer previousYearAvgRevenueByQuantityMonth BigDecimal previousYearAvgRevenueByPaxMonth BigDecimal differencePreviousYearRevenueMonth BigDecimal differencePreviousYearQuantityMonth Integer differencePreviousYearPaxMonth Integer differencePreviousYearAvgRevenueByQuantityMonth BigDecimal differencePreviousYearAvgRevenueByPaxMonth BigDecimal budgetRevenueMonth BigDecimal budgetQuantityMonth Integer budgetPaxMonth Integer budgetAvgRevenueByQuantityMonth BigDecimal budgetAvgRevenueByPaxMonth BigDecimal differenceBudgetRevenueMonth BigDecimal differenceBudgetQuantityMonth Integer differenceBudgetPaxMonth Integer differenceBudgetAvgRevenueByQuantityMonth BigDecimal differenceBudgetAvgRevenueByPaxMonth BigDecimal revenueYear BigDecimal quantityYear Integer paxYear Integer avgRevenueByQuantityYear BigDecimal avgRevenueByPaxYear BigDecimal previousYearRevenueYear BigDecimal previousYearQuantityYear Integer previousYearPaxYear Integer previousYearAvgRevenueByQuantityYear BigDecimal previousYearAvgRevenueByPaxYear BigDecimal differencePreviousYearRevenueYear BigDecimal differencePreviousYearQuantityYear Integer differencePreviousYearPaxYear Integer differencePreviousYearAvgRevenueByQuantityYear BigDecimal differencePreviousYearAvgRevenueByPaxYear BigDecimal budgetRevenueYear BigDecimal budgetQuantityYear Integer budgetPaxYear Integer budgetAvgRevenueByQuantityYear BigDecimal budgetAvgRevenueByPaxYear BigDecimal differenceBudgetRevenueYear BigDecimal differenceBudgetQuantityYear Integer differenceBudgetPaxYear Integer differenceBudgetAvgRevenueByQuantityYear BigDecimal differenceBudgetAvgRevenueByPaxYear BigDecimal
Example response
[
{
"segment": {
"id": 1,
"code": "TAGE",
"name": "Travel Agent"
},
"revenueDay": 0.000000,
"quantityDay": 0,
"paxDay": 0,
"avgRevenueByQuantityDay": 0.000000,
"avgRevenueByPaxDay": 0.000000,
"previousYearRevenueDay": 0.000000,
"previousYearQuantityDay": 0,
"previousYearPaxDay": 0,
"previousYearAvgRevenueByQuantityDay": 0.000000,
"previousYearAvgRevenueByPaxDay": 0.000000,
"differencePreviousYearRevenueDay": 0.000000,
"differencePreviousYearQuantityDay": 0,
"differencePreviousYearPaxDay": 0,
"differencePreviousYearAvgRevenueByQuantityDay": 0.000000,
"differencePreviousYearAvgRevenueByPaxDay": 0.000000,
"budgetRevenueDay": 632.483870,
"budgetQuantityDay": 0,
"budgetPaxDay": 3,
"budgetAvgRevenueByQuantityDay": 0.000000,
"budgetAvgRevenueByPaxDay": 210.827957,
"differenceBudgetRevenueDay": -632.483870,
"differenceBudgetQuantityDay": 0,
"differenceBudgetPaxDay": -3,
"differenceBudgetAvgRevenueByQuantityDay": 0.000000,
"differenceBudgetAvgRevenueByPaxDay": -210.827957,
"revenueMonth": 0.000000,
"quantityMonth": 0,
"paxMonth": 0,
"avgRevenueByQuantityMonth": 0.000000,
"avgRevenueByPaxMonth": 0.000000,
"previousYearRevenueMonth": 0.000000,
"previousYearQuantityMonth": 0,
"previousYearPaxMonth": 0,
"previousYearAvgRevenueByQuantityMonth": 0.000000,
"previousYearAvgRevenueByPaxMonth": 0.000000,
"differencePreviousYearRevenueMonth": 0.000000,
"differencePreviousYearQuantityMonth": 0,
"differencePreviousYearPaxMonth": 0,
"differencePreviousYearAvgRevenueByQuantityMonth": 0.000000,
"differencePreviousYearAvgRevenueByPaxMonth": 0.000000,
"budgetRevenueMonth": 632.483870,
"budgetQuantityMonth": 0,
"budgetPaxMonth": 3,
"budgetAvgRevenueByQuantityMonth": 0.000000,
"budgetAvgRevenueByPaxMonth": 210.827957,
"differenceBudgetRevenueMonth": -632.483870,
"differenceBudgetQuantityMonth": 0,
"differenceBudgetPaxMonth": -3,
"differenceBudgetAvgRevenueByQuantityMonth": 0.000000,
"differenceBudgetAvgRevenueByPaxMonth": -210.827957,
"revenueYear": 0.000000,
"quantityYear": 0,
"paxYear": 0,
"avgRevenueByQuantityYear": 0.000000,
"avgRevenueByPaxYear": 0.000000,
"previousYearRevenueYear": 0.000000,
"previousYearQuantityYear": 0,
"previousYearPaxYear": 0,
"previousYearAvgRevenueByQuantityYear": 0.000000,
"previousYearAvgRevenueByPaxYear": 0.000000,
"differencePreviousYearRevenueYear": 0.000000,
"differencePreviousYearQuantityYear": 0,
"differencePreviousYearPaxYear": 0,
"differencePreviousYearAvgRevenueByQuantityYear": 0.000000,
"differencePreviousYearAvgRevenueByPaxYear": 0.000000,
"budgetRevenueYear": 632.483870,
"budgetQuantityYear": 0,
"budgetPaxYear": 3,
"budgetAvgRevenueByQuantityYear": 0.000000,
"budgetAvgRevenueByPaxYear": 210.827957,
"differenceBudgetRevenueYear": -632.483870,
"differenceBudgetQuantityYear": 0,
"differenceBudgetPaxYear": -3,
"differenceBudgetAvgRevenueByQuantityYear": 0.000000,
"differenceBudgetAvgRevenueByPaxYear": -210.827957
}
...
]