Versions Compared

Version Old Version 4 New Version 5
Changes made by

Ricardo Vargas (Unlicensed)

Jordi Artal

Saved on

Key

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

Operation

Get  ExpensesRevenue from invoices of a type consumtion mode of the ReservationRoomStay. 

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.reservation


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;

GET



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}/reservationRoomStay/{reservationRoomStayId}/expenses



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
reservartionRoomStayIdIntegertruepath parameter
Unique identificator of the reservationRoomStay.
consumptionModeIdIntegertruerequest parameter

consumption mode:

1- Total amount of stay and the detail of expenses what it's been generated by a given stay regardless who pays the reservation. 

2-Total amount of stay and the detail of expenses within all invoices generated by a stay. For example, in a group reservation, charges contained in a Master invoice wont be returned.

3-Total amount and the detail of my expenses in my invoices and that have been generated in a given stay. Transferred charges won't be returned.


Example request

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



Response

The response is a ExpensesRevenue

Entity

Insert excerpt
ExpensesRevenue
ExpensesRevenue
nopaneltrue


Example response

Code Block
themeDJango
{
  "totalAccommodationRevenue": 143.1,
  "totalServiceRevenue": 0,
  "totalRevenue": 143.1,
  "expensesProductList": [
    {
      "postingDate": "2020-06-16",
      "quantity": 1,
      "product": {
        "id": 647,
        "code": "SGL",
        "name": "Single",
        "productType": {
          "id": 1,
          "code": "ACC",
          "name": "Accommodation",
          "nameI18n": "Accommodation"
        }
      },
      "name": "Single",
      "amountAfterTax": 143.1,
      "amountBeforeTax": 130.090909,
      "currency": {
        "id": 1,
        "code": "EUR",
        "name": "Euro",
        "nameI18n": "Euro"
      },
      "amountTax": 13.009091,
      "amountDiscount": 0,
      "amountCommission": 0,
      "rate": {
        "id": 2,
        "code": "BAR",
        "name": "Best Available Rate"
      },
      "offer": {
        "id": 2,
        "code": "NR",
        "name": "Non Refundable"
      },
      "offerAmountDiscount": 0,
      "offerPercentDiscount": 10,
      "promotion": null,
      "promotionAmountDiscount": null,
      "promotionPercentDiscount": null,
      "channel": {
        "id": 11,
        "code": "WEB",
        "name": "Booking Engine"
      },
      "source": {
        "id": 14,
        "code": "WAL",
        "name": "Walk-In"
      },
      "segment": {
        "id": 20,
        "code": "CONG",
        "name": "Congress"
      },
      "remark": null,
      "expensesProductTaxList": [
        {
          "quantity": 1,
          "product": {
            "id": 46,
            "code": "TAX10",
            "name": "Tax 10%",
            "productType": {
              "id": 5,
              "code": "TAX",
              "name": "Tax",
              "nameI18n": "Tax"
            }
          },
          "name": "Tax 10%",
          "price": 13.009091,
          "currency": {
            "id": 1,
            "code": "EUR",
            "name": "Euro",
            "nameI18n": "Euro"
          },
          "amount": 0,
          "percentage": 10
        }
      ],
      "expensesProductCommissionList": null,
      "expensesProductDiscountList": null
    }
  ]
}