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
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property{propertyId}/revenue
Request
Property | Type | Required | Default value | Description |
---|---|---|---|---|
chainId | Integer | true | Unique identificator of the chain. | |
propertyId | Integer | true | Unique identificator of the property. | |
from | LocalDate | true | Start of date range | |
to | LocalDate | true | End of date range | |
productId | Integer | false | Filter by only one product | |
productTypeIdList | List of Integer | false | Filter by a type of Product | |
offset | Integer | false | 0 | Offset of the array of results. |
limit | Integer | false | 10 | Limit of results. |
Example request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/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 | |||
source | |||
channel | |||
rate | |||
offer | |||
promotion | |||
booker | |||
billTo | |||
central | |||
company | |||
countryCode | String |
Example response
{ "count": 58, "offset": 0, "limit": 3, "list": [ { "date": "2019-04-20", "product": { "id": 24, "name": "Double", "productType": { "id": 7, "code": "ACC", "name": "Accommodation" } }, "quantity": 1, "adults": 2, "juniors": 0, "children": 0, "infants": 0, "amountAfterTax": 146, "amountBeforeTax": 132.727273, "amountDiscount": 0, "amountTax": 13.272727, "amountCommission": 0 }, { "date": "2019-04-20", "product": { "id": 541, "name": "City Tax Barcelona", "productType": { "id": 11, "code": "FEE", "name": "Fee" } }, "quantity": 2, "adults": 2, "juniors": 0, "children": 0, "infants": 0, "amountAfterTax": 3, "amountBeforeTax": 3, "amountDiscount": 0, "amountTax": 0, "amountCommission": 0 }, { "date": "2019-04-21", "product": { "id": 310, "name": "Parking", "productType": { "id": 1, "code": "SER", "name": "Service" } }, "quantity": 4, "adults": 4, "juniors": 0, "children": 0, "infants": 0, "amountAfterTax": 20, "amountBeforeTax": 16.528926, "amountDiscount": 0, "amountTax": 3.471074, "amountCommission": 0 } ] }