Operation
The result of this operation gives us the total amount of daily revenue produced throughout a time period
GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property{propertyId}/revenue/detail
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 | |
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/detail
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": 1770, "offset": 0, "limit": 2, "list": [ { "date": "2020-04-03", "product": { "id": 71, "code":"MR", "name": "Meeting Room", "productType": { "id": 2, "code": "SER", "name": "Service" } }, "quantity": 2, "adults": 2, "juniors": 0, "children": 0, "infants": 0, "amountAfterTax": 20.000000, "amountBeforeTax": 18.181818, "amountDiscount": 0.000000, "amountTax": 1.818182, "amountCommission": 0.000000, "segment": { "id": 23, "code": "SPO", "name": "Sport Teams" }, "source": { "id": 12, "code": "EMA", "name": "Email" }, "channel": { "id": 9, "code": "IDS", "name": "IDS" }, "rate": { "id": 2, "code": "BAR", "name": "Best Available Rate" }, "offer": null, "promotion": null, "booker": { "id": 680, "name": "Lazzy", "code": null, "taxId": "75074669", "iataId": null, "companyEmailList": [ { "id": 680, "primary": true, "emailAddressType": { "id": 1, "code": "1", "name": "Personal" }, "email": "jbowmanik@alexa.com", "remark": null } ], "companyAddressList": [ { "id": 680, "primary": true, "communicationLocationType": { "id": 1, "code": "1", "name": "Home" }, "street": "82 High Crossing Drive", "city": "Plano", "stateProvName": "Texas", "stateProvCode": null, "postalCode": "75074", "countryCode": "GA", "remark": "Address Remark" } ], "companyPhoneList": [ { "id": 680, "primary": true, "phoneLocationType": { "id": 6, "code": "6", "name": "Home" }, "phoneTechType": { "id": 1, "code": "1", "name": "Voice" }, "countryAccessCode": "+34", "areaCityCode": "B", "phoneNumber": "1-(214)123-7392", "extension": "1", "remark": "Phone Remark" } ], "companyTaxAddress": { "id": 670, "communicationLocationType": null, "street": "82 High Crossing Drive", "city": "Plano", "stateProvName": "Texas", "stateProvCode": null, "postalCode": "75074", "countryCode": "BY", "remark": "Address Remark" }, "remark": "Company Remarks" }, "billTo": null, "central": null, "company": null, "countryCode": "MM" }, { "date": "2020-04-03", "product": { "id": 72, "code":"HST", "name": "Hostess", "productType": { "id": 2, "code": "SER", "name": "Service" } }, "quantity": 1, "adults": 1, "juniors": 0, "children": 0, "infants": 0, "amountAfterTax": 10.000000, "amountBeforeTax": 9.090909, "amountDiscount": 0.000000, "amountTax": 0.909091, "amountCommission": 0.000000, "segment": { "id": 23, "code": "SPO", "name": "Sport Teams" }, "source": { "id": 12, "code": "EMA", "name": "Email" }, "channel": { "id": 9, "code": "IDS", "name": "IDS" }, "rate": { "id": 2, "code": "BAR", "name": "Best Available Rate" }, "offer": null, "promotion": null, "booker": { "id": 680, "name": "Lazzy", "code": null, "taxId": "75074669", "iataId": null, "companyEmailList": [ { "id": 680, "primary": true, "emailAddressType": { "id": 1, "code": "1", "name": "Personal" }, "email": "jbowmanik@alexa.com", "remark": null } ], "companyAddressList": [ { "id": 680, "primary": true, "communicationLocationType": { "id": 1, "code": "1", "name": "Home" }, "street": "82 High Crossing Drive", "city": "Plano", "stateProvName": "Texas", "stateProvCode": null, "postalCode": "75074", "countryCode": "GA", "remark": "Address Remark" } ], "companyPhoneList": [ { "id": 680, "primary": true, "phoneLocationType": { "id": 6, "code": "6", "name": "Home" }, "phoneTechType": { "id": 1, "code": "1", "name": "Voice" }, "countryAccessCode": "+34", "areaCityCode": "B", "phoneNumber": "1-(214)123-7392", "extension": "1", "remark": "Phone Remark" } ], "companyTaxAddress": { "id": 670, "communicationLocationType": null, "street": "82 High Crossing Drive", "city": "Plano", "stateProvName": "Texas", "stateProvCode": null, "postalCode": "75074", "countryCode": "BY", "remark": "Address Remark" }, "remark": "Company Remarks" }, "billTo": null, "central": null, "company": null, "countryCode": "MM" }, { "date": "2020-04-03", "product": { "id": 647, "code":"S", "name": "Single", "productType": { "id": 1, "code": "ACC", "name": "Accommodation" } }, "quantity": 1, "adults": 1, "juniors": 0, "children": 0, "infants": 0, "amountAfterTax": 160.000000, "amountBeforeTax": 145.454545, "amountDiscount": 0.000000, "amountTax": 14.545455, "amountCommission": 36.800000, "segment": { "id": 23, "code": "SPO", "name": "Sport Teams" }, "source": { "id": 12, "code": "EMA", "name": "Email" }, "channel": { "id": 9, "code": "IDS", "name": "IDS" }, "rate": { "id": 2, "code": "BAR", "name": "Best Available Rate" }, "offer": null, "promotion": null, "booker": { "id": 680, "name": "Lazzy", "code": null, "taxId": "75074669", "iataId": null, "companyEmailList": [ { "id": 680, "primary": true, "emailAddressType": { "id": 1, "code": "1", "name": "Personal" }, "email": "jbowmanik@alexa.com", "remark": null } ], "companyAddressList": [ { "id": 680, "primary": true, "communicationLocationType": { "id": 1, "code": "1", "name": "Home" }, "street": "82 High Crossing Drive", "city": "Plano", "stateProvName": "Texas", "stateProvCode": null, "postalCode": "75074", "countryCode": "GA", "remark": "Address Remark" } ], "companyPhoneList": [ { "id": 680, "primary": true, "phoneLocationType": { "id": 6, "code": "6", "name": "Home" }, "phoneTechType": { "id": 1, "code": "1", "name": "Voice" }, "countryAccessCode": "+34", "areaCityCode": "B", "phoneNumber": "1-(214)123-7392", "extension": "1", "remark": "Phone Remark" } ], "companyTaxAddress": { "id": 670, "communicationLocationType": null, "street": "82 High Crossing Drive", "city": "Plano", "stateProvName": "Texas", "stateProvCode": null, "postalCode": "75074", "countryCode": "BY", "remark": "Address Remark" }, "remark": "Company Remarks" }, "billTo": null, "central": null, "company": null, "countryCode": "MM" }, { "date": "2020-04-03", "product": { "id": 63, "code":"BR", "name": "Breakfast", "productType": { "id": 2, "code": "SER", "name": "Service" } }, "quantity": 2, "adults": 2, "juniors": 0, "children": 0, "infants": 0, "amountAfterTax": 81.333334, "amountBeforeTax": 73.939394, "amountDiscount": 0.000000, "amountTax": 7.393940, "amountCommission": 0.000000, "segment": { "id": 23, "code": "SPO", "name": "Sport Teams" }, "source": { "id": 12, "code": "EMA", "name": "Email" }, "channel": { "id": 11, "code": "WEB", "name": "Booking Engine" }, "rate": { "id": 2, "code": "BAR", "name": "Best Available Rate" }, "offer": null, "promotion": null, "booker": { "id": 470, "name": "Livetube", "code": null, "taxId": "20310459", "iataId": null, "companyEmailList": [ { "id": 470, "primary": true, "emailAddressType": { "id": 1, "code": "1", "name": "Personal" }, "email": "bcoopercq@com.com", "remark": null } ], "companyAddressList": [ { "id": 470, "primary": true, "communicationLocationType": { "id": 1, "code": "1", "name": "Home" }, "street": "28 Stephen Crossing", "city": "Washington", "stateProvName": "District of Columbia", "stateProvCode": null, "postalCode": "20310", "countryCode": "TN", "remark": "Address Remark" } ], "companyPhoneList": [ { "id": 470, "primary": true, "phoneLocationType": { "id": 6, "code": "6", "name": "Home" }, "phoneTechType": { "id": 1, "code": "1", "name": "Voice" }, "countryAccessCode": "+34", "areaCityCode": "B", "phoneNumber": "1-(202)612-3912", "extension": "1", "remark": "Phone Remark" } ], "companyTaxAddress": { "id": 460, "communicationLocationType": null, "street": "28 Stephen Crossing", "city": "Washington", "stateProvName": "District of Columbia", "stateProvCode": null, "postalCode": "20310", "countryCode": "FM", "remark": "Address Remark" }, "remark": "Company Remarks" }, "billTo": null, "central": null, "company": null, "countryCode": "LU" }, { "date": "2020-04-03", "product": { "id": 67, "code":"LN", "name": "Lunch", "productType": { "id": 2, "code": "SER", "name": "Service" } }, "quantity": 2, "adults": 2, "juniors": 0, "children": 0, "infants": 0, "amountAfterTax": 81.333334, "amountBeforeTax": 73.939394, "amountDiscount": 0.000000, "amountTax": 7.393940, "amountCommission": 0.000000, "segment": { "id": 23, "code": "SPO", "name": "Sport Teams" }, "source": { "id": 12, "code": "EMA", "name": "Email" }, "channel": { "id": 11, "code": "WEB", "name": "Booking Engine" }, "rate": { "id": 2, "code": "BAR", "name": "Best Available Rate" }, "offer": null, "promotion": null, "booker": { "id": 470, "name": "Livetube", "code": null, "taxId": "20310459", "iataId": null, "companyEmailList": [ { "id": 470, "primary": true, "emailAddressType": { "id": 1, "code": "1", "name": "Personal" }, "email": "bcoopercq@com.com", "remark": null } ], "companyAddressList": [ { "id": 470, "primary": true, "communicationLocationType": { "id": 1, "code": "1", "name": "Home" }, "street": "28 Stephen Crossing", "city": "Washington", "stateProvName": "District of Columbia", "stateProvCode": null, "postalCode": "20310", "countryCode": "TN", "remark": "Address Remark" } ], "companyPhoneList": [ { "id": 470, "primary": true, "phoneLocationType": { "id": 6, "code": "6", "name": "Home" }, "phoneTechType": { "id": 1, "code": "1", "name": "Voice" }, "countryAccessCode": "+34", "areaCityCode": "B", "phoneNumber": "1-(202)612-3912", "extension": "1", "remark": "Phone Remark" } ], "companyTaxAddress": { "id": 460, "communicationLocationType": null, "street": "28 Stephen Crossing", "city": "Washington", "stateProvName": "District of Columbia", "stateProvCode": null, "postalCode": "20310", "countryCode": "FM", "remark": "Address Remark" }, "remark": "Company Remarks" }, "billTo": null, "central": null, "company": null, "countryCode": "LU" }, { "date": "2020-04-03", "product": { "id": 68, "code":"DIN", "name": "Dinner", "productType": { "id": 2, "code": "SER", "name": "Service" } }, "quantity": 2, "adults": 2, "juniors": 0, "children": 0, "infants": 0, "amountAfterTax": 81.333332, "amountBeforeTax": 73.939392, "amountDiscount": 0.000000, "amountTax": 7.393940, "amountCommission": 0.000000, "segment": { "id": 23, "code": "SPO", "name": "Sport Teams" }, "source": { "id": 12, "code": "EMA", "name": "Email" }, "channel": { "id": 11, "code": "WEB", "name": "Booking Engine" }, "rate": { "id": 2, "code": "BAR", "name": "Best Available Rate" }, "offer": null, "promotion": null, "booker": { "id": 470, "name": "Livetube", "code": null, "taxId": "20310459", "iataId": null, "companyEmailList": [ { "id": 470, "primary": true, "emailAddressType": { "id": 1, "code": "1", "name": "Personal" }, "email": "bcoopercq@com.com", "remark": null } ], "companyAddressList": [ { "id": 470, "primary": true, "communicationLocationType": { "id": 1, "code": "1", "name": "Home" }, "street": "28 Stephen Crossing", "city": "Washington", "stateProvName": "District of Columbia", "stateProvCode": null, "postalCode": "20310", "countryCode": "TN", "remark": "Address Remark" } ], "companyPhoneList": [ { "id": 470, "primary": true, "phoneLocationType": { "id": 6, "code": "6", "name": "Home" }, "phoneTechType": { "id": 1, "code": "1", "name": "Voice" }, "countryAccessCode": "+34", "areaCityCode": "B", "phoneNumber": "1-(202)612-3912", "extension": "1", "remark": "Phone Remark" } ], "companyTaxAddress": { "id": 460, "communicationLocationType": null, "street": "28 Stephen Crossing", "city": "Washington", "stateProvName": "District of Columbia", "stateProvCode": null, "postalCode": "20310", "countryCode": "FM", "remark": "Address Remark" }, "remark": "Company Remarks" }, "billTo": null, "central": null, "company": null, "countryCode": "LU" }, { "date": "2020-04-03", "product": { "id": 752, "code":"JS", "name": "Junior Suite", "productType": { "id": 1, "code": "ACC", "name": "Accommodation" } }, "quantity": 1, "adults": 2, "juniors": 0, "children": 0, "infants": 0, "amountAfterTax": 275.000000, "amountBeforeTax": 250.000000, "amountDiscount": 3.000000, "amountTax": 25.000000, "amountCommission": 0.000000, "segment": { "id": 23, "code": "SPO", "name": "Sport Teams" }, "source": { "id": 12, "code": "EMA", "name": "Email" }, "channel": { "id": 11, "code": "WEB", "name": "Booking Engine" }, "rate": { "id": 2, "code": "BAR", "name": "Best Available Rate" }, "offer": null, "promotion": null, "booker": { "id": 470, "name": "Livetube", "code": null, "taxId": "20310459", "iataId": null, "companyEmailList": [ { "id": 470, "primary": true, "emailAddressType": { "id": 1, "code": "1", "name": "Personal" }, "email": "bcoopercq@com.com", "remark": null } ], "companyAddressList": [ { "id": 470, "primary": true, "communicationLocationType": { "id": 1, "code": "1", "name": "Home" }, "street": "28 Stephen Crossing", "city": "Washington", "stateProvName": "District of Columbia", "stateProvCode": null, "postalCode": "20310", "countryCode": "TN", "remark": "Address Remark" } ], "companyPhoneList": [ { "id": 470, "primary": true, "phoneLocationType": { "id": 6, "code": "6", "name": "Home" }, "phoneTechType": { "id": 1, "code": "1", "name": "Voice" }, "countryAccessCode": "+34", "areaCityCode": "B", "phoneNumber": "1-(202)612-3912", "extension": "1", "remark": "Phone Remark" } ], "companyTaxAddress": { "id": 460, "communicationLocationType": null, "street": "28 Stephen Crossing", "city": "Washington", "stateProvName": "District of Columbia", "stateProvCode": null, "postalCode": "20310", "countryCode": "FM", "remark": "Address Remark" }, "remark": "Company Remarks" }, "billTo": null, "central": null, "company": null, "countryCode": "LU" }, { "date": "2020-04-03", "product": { "id": 797, "code":"CTM", "name": "City Tax Mallorca", "productType": { "id": 6, "code": "FEE", "name": "Fee" } }, "quantity": 2, "adults": 2, "juniors": 0, "children": 0, "infants": 0, "amountAfterTax": 10.000000, "amountBeforeTax": 10.000000, "amountDiscount": 0.000000, "amountTax": 0.000000, "amountCommission": 0.000000, "segment": { "id": 23, "code": "SPO", "name": "Sport Teams" }, "source": { "id": 12, "code": "EMA", "name": "Email" }, "channel": { "id": 11, "code": "WEB", "name": "Booking Engine" }, "rate": { "id": 2, "code": "BAR", "name": "Best Available Rate" }, "offer": null, "promotion": null, "booker": { "id": 470, "name": "Livetube", "code": null, "taxId": "20310459", "iataId": null, "companyEmailList": [ { "id": 470, "primary": true, "emailAddressType": { "id": 1, "code": "1", "name": "Personal" }, "email": "bcoopercq@com.com", "remark": null } ], "companyAddressList": [ { "id": 470, "primary": true, "communicationLocationType": { "id": 1, "code": "1", "name": "Home" }, "street": "28 Stephen Crossing", "city": "Washington", "stateProvName": "District of Columbia", "stateProvCode": null, "postalCode": "20310", "countryCode": "TN", "remark": "Address Remark" } ], "companyPhoneList": [ { "id": 470, "primary": true, "phoneLocationType": { "id": 6, "code": "6", "name": "Home" }, "phoneTechType": { "id": 1, "code": "1", "name": "Voice" }, "countryAccessCode": "+34", "areaCityCode": "B", "phoneNumber": "1-(202)612-3912", "extension": "1", "remark": "Phone Remark" } ], "companyTaxAddress": { "id": 460, "communicationLocationType": null, "street": "28 Stephen Crossing", "city": "Washington", "stateProvName": "District of Columbia", "stateProvCode": null, "postalCode": "20310", "countryCode": "FM", "remark": "Address Remark" }, "remark": "Company Remarks" }, "billTo": null, "central": null, "company": null, "countryCode": "LU" }, { "date": "2020-04-03", "product": { "id": 63, "code":"BR", "name": "Breakfast", "productType": { "id": 2, "code": "SER", "name": "Service" } }, "quantity": 2, "adults": 2, "juniors": 0, "children": 0, "infants": 0, "amountAfterTax": 81.333334, "amountBeforeTax": 73.939394, "amountDiscount": 0.000000, "amountTax": 7.393940, "amountCommission": 0.000000, "segment": { "id": 23, "code": "SPO", "name": "Sport Teams" }, "source": { "id": 12, "code": "EMA", "name": "Email" }, "channel": { "id": 12, "code": "WEBM", "name": "Booking Engine Mobile" }, "rate": { "id": 2, "code": "BAR", "name": "Best Available Rate" }, "offer": null, "promotion": null, "booker": { "id": 406, "name": "Trunyx", "code": null, "taxId": "50362395", "iataId": null, "companyEmailList": [ { "id": 406, "primary": true, "emailAddressType": { "id": 1, "code": "1", "name": "Personal" }, "email": "criceay@simplemachines.org", "remark": null } ], "companyAddressList": [ { "id": 406, "primary": true, "communicationLocationType": { "id": 1, "code": "1", "name": "Home" }, "street": "9 Chinook Junction", "city": "Des Moines", "stateProvName": "Lugo", "stateProvCode": "ES-LU", "postalCode": "50362", "countryCode": "ES", "remark": "Address Remark" } ], "companyPhoneList": [ { "id": 406, "primary": true, "phoneLocationType": { "id": 6, "code": "6", "name": "Home" }, "phoneTechType": { "id": 1, "code": "1", "name": "Voice" }, "countryAccessCode": "+34", "areaCityCode": "B", "phoneNumber": "1-(515)746-4886", "extension": "1", "remark": "Phone Remark" } ], "companyTaxAddress": { "id": 396, "communicationLocationType": null, "street": "9 Chinook Junction", "city": "Des Moines", "stateProvName": "Cáceres", "stateProvCode": "ES-CC", "postalCode": "50362", "countryCode": "ES", "remark": "Address Remark" }, "remark": "Company Remarks" }, "billTo": null, "central": null, "company": null, "countryCode": "AN" }, { "date": "2020-04-03", "product": { "id": 63, "code":"BR", "name": "Breakfast", "productType": { "id": 2, "code": "SER", "name": "Service" } }, "quantity": 2, "adults": 2, "juniors": 0, "children": 0, "infants": 0, "amountAfterTax": 80.000000, "amountBeforeTax": 72.727272, "amountDiscount": 0.000000, "amountTax": 7.272728, "amountCommission": 0.000000, "segment": { "id": 27, "code": "CONL", "name": "Company Online" }, "source": { "id": 12, "code": "EMA", "name": "Email" }, "channel": { "id": 7, "code": "CRS", "name": "CRS" }, "rate": { "id": 2, "code": "BAR", "name": "Best Available Rate" }, "offer": { "id": 2, "code": "NR", "name": "Non Refundable" }, "promotion": null, "booker": { "id": 169, "name": "Skyble", "code": null, "taxId": "27690158", "iataId": null, "companyEmailList": [ { "id": 169, "primary": true, "emailAddressType": { "id": 1, "code": "1", "name": "Personal" }, "email": "kparker4d@hubpages.com", "remark": null } ], "companyAddressList": [ { "id": 169, "primary": true, "communicationLocationType": { "id": 1, "code": "1", "name": "Home" }, "street": "8 7th Trail", "city": "Raleigh", "stateProvName": "La Coruña", "stateProvCode": "ES-C", "postalCode": "27690", "countryCode": "ES", "remark": "Address Remark" } ], "companyPhoneList": [ { "id": 169, "primary": true, "phoneLocationType": { "id": 6, "code": "6", "name": "Home" }, "phoneTechType": { "id": 1, "code": "1", "name": "Voice" }, "countryAccessCode": "+34", "areaCityCode": "B", "phoneNumber": "1-(919)222-7211", "extension": "1", "remark": "Phone Remark" } ], "companyTaxAddress": { "id": 159, "communicationLocationType": null, "street": "8 7th Trail", "city": "Raleigh", "stateProvName": "Soria", "stateProvCode": "ES-SO", "postalCode": "27690", "countryCode": "ES", "remark": "Address Remark" }, "remark": "Company Remarks" }, "billTo": null, "central": null, "company": null, "countryCode": "MM" } ] }