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. | |
reservartionRoomStayId | Integer | true | path parameter | Unique identificator of the reservationRoomStay. | |
consumptionModeId | Integer | true | request parameter | consumption mode: 1- Total amount of stay and the detail of expenses what it's been generated by a given stay regardless who pays the reservation. 2-Total amount of stay and the detail of expenses within all invoices generated by a stay. For example, in a group reservation, charges contained in a Master invoice wont be returned. 3-Total amount and the detail of my expenses in my invoices and that have been generated in a given stay. Transferred charges won't be returned. | |
sourceCodeList | List | false | request parameter | Filter code of the source. | |
segmentCodeList | List | false | request parameter | Filter code of the segment. | |
channelCodeList | List | false | request parameter | Filter code of the channel. |
Example request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/reservationRoomStay/1/expenses
Response
The response is a ExpensesRevenue
Entity
Field Type Required Description totalAccommodationRevenue BigDecimal false Total of the product accommodation totalServiceRevenue BigDecimal false Total of the product service totalRevenue BigDecimal false Total accommadation + service totalAccommodationRevenueBeforeTax BigDecimal false Total of the product accommodation before tax totalServiceRevenueBeforeTax BigDecimal false Total of the product service before tax totalRevenueBeforeTax BigDecimal false Total accommadation + service before tax expensesProductList List of ExpensesProduct. false The products associated to this Expenses.
Example response
{
"totalAccommodationRevenue": 318,
"totalServiceRevenue": 50,
"totalRevenue": 368,
"totalAccommodationRevenueBeforeTax": 289.090909,
"totalServiceRevenueBeforeTax": 45.454545,
"totalRevenueBeforeTax": 334.545454,
"expensesProductList": [
{
"postingDate": "2020-09-02",
"productionDate": "2020-09-02",
"quantity": 1,
"product": {
"id": 752,
"code": "JSUI",
"name": "Junior Suite",
"productType": {
"id": 1,
"code": "ACC",
"name": "Accommodation",
"nameI18n": "Accommodation"
}
},
"name": "Junior Suite",
"amountAfterTax": 318,
"amountBeforeTax": 289.090909,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro"
},
"amountTax": 28.909091,
"amountDiscount": 0,
"amountCommission": 0,
"rate": {
"id": 2,
"code": "BAR",
"name": "Best Available Rate"
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"channel": {
"id": 10,
"code": "OTA",
"name": "Online Travel Agency"
},
"source": {
"id": 13,
"code": "PHO",
"name": "Phone"
},
"segment": {
"id": 21,
"code": "CONV",
"name": "Conventions"
},
"remark": null,
"expensesProductTaxList": [
{
"quantity": 1,
"product": {
"id": 46,
"code": "TAX10",
"name": "Tax 10%",
"productType": {
"id": 5,
"code": "TAX",
"name": "Tax",
"nameI18n": "Tax"
}
},
"name": "Tax 10%",
"price": 28.909091,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro"
},
"amount": 0,
"percentage": 10
}
],
"expensesProductCommissionList": null,
"expensesProductDiscountList": null
}
]
}