Retrieve Property Charges

This endpoint allows clients to request and retrieve charge information associated with a specific property. This API provides detailed data about the property's charges, facilitating effective management and visibility of fees.

---

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/charges/retrieve

Header

-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/json

Header	Type	Required	Description
app-id	string	Yes	Your application ID. Required for authentication.
Authorization	string	Yes	Your API key. for authorization. Required for authentication.
Content-Type	string	Yes	Must be set to application/json.

---

Attributes

hotel_id string (Required)

The unique property ID as assigned by the provider upon creation of the property.

---

channel_hotel_id string (Required)

The unique id for the hotel on the specific channel.

---

Sample Request

{
   "hotel_id": "AWSTEST",
   "channel_hotel_id": "12837615"
}

---

Response

Sample Success Response

{
  "Status": "Success",
  "Message": "Successfully fetch details",
  "Warnings": "",
  "Ruid": "e7b60060-c3fa-4893-b6b9-996201041398",
  "Data": {
    "property_charges": [
      {
        "charge_key": {
          "type": "CLEANINGFEE",
          "guest_origin": "ANY",
          "travel_purpose": "ANY"
        },
        "charge_periods": [
          {
            "applicable": {
              "from": "2024-10-18"
            },
            "configuration": {
              "amount": {
                "value": 15,
                "base": [],
                "mode": "PER_STAY"
              },
              "excluded": false
            }
          }
        ]
      },
      {
        "charge_key": {
          "type": "VAT",
          "guest_origin": "ANY",
          "travel_purpose": "ANY"
        },
        "charge_periods": [
          {
            "applicable": {
              "from": "2024-10-18"
            },
            "configuration": {
              "amount": {
                "value": 12,
                "base": [
                  "NET_ROOM_PRICE"
                ],
                "mode": "PERCENTAGE"
              },
              "excluded": true
            }
          }
        ]
      },
      {
        "charge_key": {
          "type": "CITYTAX",
          "guest_origin": "ANY",
          "travel_purpose": "ANY"
        },
        "charge_periods": [
          {
            "applicable": {
              "from": "2024-10-18"
            },
            "configuration": {
              "amount": {
                "value": 8,
                "base": [],
                "mode": "PER_PERSON_PER_STAY"
              },
              "excluded": true
            }
          }
        ]
      }
    ]
  }
}

Success Response Body Elements

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.

---

Message string

A message receives within the response body. This will generally be an empty string if no additional information is needed.

---

Ruid string

Specifies the unique request ID.

You can share this ID with Booking.com customer support when you run into an issue. This can help in understanding what went wrong.

---

Data array

An array of charge data, each item containing details about charge types, categories, and other associated information (for example, tax types, legacy codes).

---

property_chargesarray of objects

Charges that apply across the property. Update requests must contain at least one charge between property and room arrays.

---

charge_key object

Indicates the attributes that uniquely identify a charge.

---

type string

The type of charge. For a mapping between OTA/legacy and the new codes please use the meta endpoint.

---

guest_origin string

The guest origin as specified when they make the booking.

---

travel_purpose string

The travel purpose as specified by the guest when they make the booking.

---

charge_periods array of objects

Indicates the timeline of various configurations for the charge through time.

---

applicable object

The date range for this charge period. Dates are inclusive and must not overlap.

---

from date

The start date for this charge period.

---

to date

The end date for this charge period (inclusive).

---

configuration object

The charge configuration for this period.

---

amount object

Indicates details about the charge price.

---

value number

Value of the charge.

---

mode string

The mode used for this charge.

---

excluded boolean

Specifies if the charge is included or excluded from the calendar rate.

---

Errors

Sample Error Response 1

{
   "Errors": [
       {
           "Code": "400",
           "ShortText": "HotelCode: Invalid HotelCode ('AWSTEST')"
       }
   ],
   "Status": "Fail"
}

Sample Error Response 2

{
   "Errors": [
       {
           "Code": "573",
           "ShortText": "channel-mapping not found for this property!"
       }
   ],
   "Status": "Fail"
}

Sample Error Response 3

{
   "Status": "Fail",
   "Errors": [],
   "Message": "Authorization error: UNAUTHORIZED",
   "Ruid": "8949f840-7dff-4f69-b71c-fafea0870feb",
   "Data": {}
}

---

Error Response Body Elements

Status string

Indicates the result of the API call, which will be always "Fail" in case of an error response.

---

Error array

Array that contains details about any errors that occurred during the API call. Each object in the Errors array contains the following properties:

Code string

Specific error code that helps identify the type of error.

For example: "400" indicates a bad request.

ShortText string

A short description of the error.

---

Message string

A message providing more information about the error.

---

Ruid string

Specifies the unique request ID.

You can share this ID with Booking.com customer support when you run into an issue. This can help in understanding what went wrong.

In the case where a RUID (Request Unique Identifier) is provided by Booking.com, it will be displayed in the response. If no RUID is received, the field will be left blank.