Versions Compared

Version Old Version 14 New Version Current
Changes made by

Jordi Artal

Jordi Artal

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.revenue


Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}


.separator{
margin: 5px 0;
}



Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GETGET Single property request



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

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



Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GET Multiproperty request



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

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


Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
fromLocalDatetruerequest parameter
Start of date range
toLocalDatetruerequest parameter
End of date range
productIdIntegerfalserequest parameter
Filter by only one product
productTypeIdListList of Integerfalserequest parameter
Filter by a type of Product
offsetIntegerfalserequest parameter0Offset of the array of results.
limitIntegerfalserequest parameter10Limit of results.


Example Single Property request

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

Example Multiproperty request

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



Response

PropertyTypeRequiredDescription
PagePagetrue

Entity


Insert excerpt
Revenue
Revenue
nopaneltrue

Example response

Code Block
themeDJango
{
      "countdate": 1,"2020-05-10",
      "offsetproduct": 0, {
        "limitid": 10,56,
        "listcode": [
  "DEPRE",
 {       "datename": "2020-05-10Deposit Receipt",
        "productproductType": {
          "id": 564,
          "code": "DEPREDEP",
          "name": "Deposit Receipt",
          "productTypenameI18n": { "Deposit"
        }
      },
      "idquantity": 4,
      "adults": 4,
      "codejuniors": 0,
"DEP"      "children": 0,
      "infants": 0,
      "nameamountAfterTax": 110.666667,
      "DepositamountBeforeTax": 100.606060,
      "amountFoodBreakdownAfterTax": 55.333333,
      "nameI18namountFoodBreakdownBeforeTax": 50.303030,
      "DepositamountBeverageBreakdownAfterTax": 55.333333,
       }"amountBeverageBreakdownBeforeTax": 50.303030,
       }"amountOtherBreakdownAfterTax": 0.000000,
      "quantityamountOtherBreakdownBeforeTax": 0.000000,
      "amountNetAfterTax": 110.666667,
      "adults"amountNetBeforeTax": 100.606060,
      "amountFoodBreakdownNetAfterTax": 055.333333,
      "juniorsamountFoodBreakdownNetBeforeTax": 050.303030,
      "childrenamountBeverageBreakdownNetAfterTax": 055.333333,
      "infantsamountBeverageBreakdownNetBeforeTax": 050.303030,
      "amountAfterTaxamountOtherBreakdownNetAfterTax": 0.000000,
      "amountBeforeTaxamountOtherBreakdownNetBeforeTax": 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
    }
  ]
}