View Source

Operation

The result of this operation gives us the total amount of daily revenue produced throughout a time period

Only accessible with permission of pms.integration.revenue

table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
}

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

Example response

{
  "count": 910,
  "offset": 0,
  "limit": 10,
  "list": [
    {
      "date": "2020-06-27",
      "product": {
        "id": 68,
        "code": "DINNER",
        "name": "Dinner",
        "productType": {
          "id": 2,
          "code": "SER",
          "name": "Service",
          "nameI18n": "Service"
        }
      },
      "quantity": 1,
      "adults": 1,
      "juniors": 0,
      "children": 0,
      "infants": 0,
      "amountAfterTax": 45.000000,
      "amountBeforeTax": 40.909091,
      "amountFoodBreakdownAfterTax": 40.500000,
      "amountFoodBreakdownBeforeTax": 36.818182,
      "amountBeverageBreakdownAfterTax": 2.250000,
      "amountBeverageBreakdownBeforeTax": 2.045455,
      "amountOtherBreakdownAfterTax": 2.250000,
      "amountOtherBreakdownBeforeTax": 2.045455,
      "amountNetAfterTax": 42.096774,
      "amountNetBeforeTax": 38.269795,
      "amountFoodBreakdownNetAfterTax": 37.887097,
      "amountFoodBreakdownNetBeforeTax": 34.442816,
      "amountBeverageBreakdownNetAfterTax": 2.104839,
      "amountBeverageBreakdownNetBeforeTax": 1.913490,
      "amountOtherBreakdownNetAfterTax": 2.104839,
      "amountOtherBreakdownNetBeforeTax": 1.913490,
      "amountDiscount": 0.000000,
      "amountTax": 4.090909,
      "amountCommission": 4.000000,
      "amountCommissionApplied": 0.000000,
      "segment": {
        "id": 27,
        "code": "CONL",
        "name": "Company Online"
      },
      "source": {
        "id": 14,
        "code": "WAL",
        "name": "Walk-In"
      },
      "channel": {
        "id": 11,
        "code": "WEB",
        "name": "Booking Engine"
      },
      "rate": {
        "id": 2,
        "code": "BAR",
        "name": "Best Available Rate"
      },
      "offer": null,
      "promotion": null,
      "booker": {
        "id": 847,
        "name": "Youfeed",
        "code": "YOUFE",
        "taxId": "62711834",
        "companyEmailList": [
          {
            "id": 847,
            "primary": true,
            "emailAddressType": {
              "id": 1,
              "code": "1",
              "name": "Personal",
              "nameI18n": "Personal"
            },
            "email": "cfreemann5@biblegateway.com",
            "remark": null
          }
        ],
        "companyAddressList": [
          {
            "id": 847,
            "primary": true,
            "communicationLocationType": {
              "id": 1,
              "code": "1",
              "name": "Home",
              "nameI18n": "Home"
            },
            "street": "232 Kim Way",
            "city": "Springfield",
            "stateProvName": "León",
            "stateProvCode": "ES-LE",
            "postalCode": "62711",
            "countryCode": "ES",
            "remark": "Address Remark"
          }
        ],
        "companyPhoneList": [
          {
            "id": 847,
            "primary": true,
            "phoneLocationType": {
              "id": 6,
              "code": "6",
              "name": "Home",
              "nameI18n": "Home"
            },
            "phoneTechType": {
              "id": 1,
              "code": "1",
              "name": "Voice",
              "nameI18n": "Voice"
            },
            "countryAccessCode": "+34",
            "areaCityCode": "B",
            "phoneNumber": "1-(217)690-1739",
            "extension": "1",
            "remark": "Phone Remark"
          }
        ],
        "companyTaxAddress": {
          "id": 837,
          "communicationLocationType": null,
          "street": "232 Kim Way",
          "city": "Springfield",
          "stateProvName": "Valladolid",
          "stateProvCode": "ES-VA",
          "postalCode": "62711",
          "countryCode": "ES",
          "remark": "Address Remark"
        },
        "remark": "Company Remarks"
      },
      "billTo": null,
      "central": null,
      "company": null,
      "countryCode": "TD"
    },
	...
  ]
}