Revenue list [GET]

Operation

The result of this operation gives us the total amount of daily revenue produced by an specific product or product category throughout a time period

GET Single property request

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

GET Multiproperty request

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

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.
from	LocalDate	true	request parameter		Start of date range
to	LocalDate	true	request parameter		End of date range
productId	Integer	false	request parameter		Filter by only one product
productTypeIdList	List of Integer	false	request parameter		Filter by a type of Product
offset	Integer	false	request parameter	0	Offset of the array of results.
limit	Integer	false	request parameter	10	Limit of results.

Example Single Property request

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

Example Multiproperty request

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

Response

Property	Type	Required	Description
Page	Page	true

Entity

Field	Type	Required	Description
date	LocalDate	true	Date of the revenue calculus
product	Product	true	Product that groups the values
quantity	Integer	true
adults	Integer	true
juniors	Integer	true
children	Integer	true
infants	Integer	true
amountAfterTax	BigDecimal	true
amountBeforeTax	BigDecimal	true
amountDiscount	BigDecimal	true
amountTax	BigDecimal	true
amountCommission	BigDecimal	true
amountCommissionApplied	BigDecimal	true
amountFoodBreakdownAfterTax	BigDecimal
amountFoodBreakdownBeforeTax	BigDecimal
amountBeverageBreakdownAfterTax	BigDecimal
amountBeverageBreakdownBeforeTax	BigDecimal
amountOtherBreakdownAfterTax	BigDecimal
amountOtherBreakdownBeforeTax	BigDecimal
amountNetAfterTax	BigDecimal	true
amountNetBeforeTax	BigDecimal	true
amountFoodBreakdownNetAfterTax	BigDecimal
amountFoodBreakdownNetBeforeTax	BigDecimal
amountBeverageBreakdownNetAfterTax	BigDecimal
amountBeverageBreakdownNetBeforeTax	BigDecimal
amountOtherBreakdownNetAfterTax	BigDecimal
amountOtherBreakdownNetBeforeTax	BigDecimal
amountInvoiceAfterTax	BigDecimal
amountInvoiceBeforeTax	BigDecimal
segment	Segment
source	Source
channel	Channel
rate	Rate
offer	Offer
promotion	Promotion
booker	Company
billTo	Company
central	Company
company	Company
countryCode	String

Example response

{
      "date": "2020-05-10",
      "product": {
        "id": 56,
        "code": "DEPRE",
        "name": "Deposit Receipt",
        "productType": {
          "id": 4,
          "code": "DEP",
          "name": "Deposit",
          "nameI18n": "Deposit"
        }
      },
      "quantity": 4,
      "adults": 4,
      "juniors": 0,
      "children": 0,
      "infants": 0,
      "amountAfterTax": 110.666667,
      "amountBeforeTax": 100.606060,
      "amountFoodBreakdownAfterTax": 55.333333,
      "amountFoodBreakdownBeforeTax": 50.303030,
      "amountBeverageBreakdownAfterTax": 55.333333,
      "amountBeverageBreakdownBeforeTax": 50.303030,
      "amountOtherBreakdownAfterTax": 0.000000,
      "amountOtherBreakdownBeforeTax": 0.000000,
      "amountNetAfterTax": 110.666667,
      "amountNetBeforeTax": 100.606060,
      "amountFoodBreakdownNetAfterTax": 55.333333,
      "amountFoodBreakdownNetBeforeTax": 50.303030,
      "amountBeverageBreakdownNetAfterTax": 55.333333,
      "amountBeverageBreakdownNetBeforeTax": 50.303030,
      "amountOtherBreakdownNetAfterTax": 0.000000,
      "amountOtherBreakdownNetBeforeTax": 0.000000,
      "amountDiscount": 0.000000,
      "amountTax": 0.000000,
      "amountCommission": 0.000000,
      "amountCommissionBeforeTax": null,
      "amountCommissionApplied": 0.000000,
      "amountCommissionAppliedBeforeTax": null,
      "amountCommissionFoodBreakdown": null,
      "amountCommissionFoodBreakdownBeforeTax": null,
      "amountCommissionFoodBreakdownApplied": null,
      "amountCommissionFoodBreakdownAppliedBeforeTax": null,
      "amountCommissionBeverageBreakdown": null,
      "amountCommissionBeverageBreakdownBeforeTax": null,
      "amountCommissionBeverageBreakdownApplied": null,
      "amountCommissionBeverageBreakdownAppliedBeforeTax": null,
      "amountCommissionOtherBreakdown": null,
      "amountCommissionOtherBreakdownBeforeTax": null,
      "amountCommissionOtherBreakdownApplied": null,
      "amountCommissionOtherBreakdownAppliedBeforeTax": null,
      "amountInvoiceAfterTax": 110.666667,
      "amountInvoiceBeforeTax": 100.606060,
      "segment": null,
      "source": null,
      "channel": null,
      "rate": null,
      "offer": null,
      "promotion": null,
      "booker": null,
      "billTo": null,
      "central": null,
      "company": null,
      "countryCode": null
}