Retrieve City Tax Category For Property Settings

This endpoint allows you to retrieve the city tax categories applicable for a specific property (for example, a hotel or other accommodation type). The response will provide a list of categories and their descriptions, which can be used to classify the property's city tax settings.

---

Endpoint

GET

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/settings/retrieveCityTaxCategory

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.
Content-Type	string	Yes	Must be set to application/json.

---

Response

Sample Success Response

{
  "Status": "Success",
  "Message": "Successfully fetch details",
  "Warnings": "",
  "Ruid": "UmFuZG9tSVYkc2RlIyh9YePGU+P+RxoVI7asFZsleukKRRHktUbxQEzd9B2kzNzHxqcpbgl9fZLIvod7IhHtvTOWNBCtgUioSc601Hojiyc=",
  "Data": {
    "categories": [
      {
        "id": "11",
        "value": "Palaces"
      },
      {
        "id": "12",
        "value": "Hôtels de tourisme 5 étoiles, résidences de tourisme 5 étoiles, meublés de tourisme 5 étoiles"
      },
      {
        "id": "13",
        "value": "Hôtels de tourisme 4 étoiles, résidences de tourisme 4 étoiles, meublés de tourisme 4 étoiles"
      },
      {
        "id": "14",
        "value": "Hôtels de tourisme 3 étoiles, résidences de tourisme 3 étoiles, meublés de tourisme 3 étoiles"
      },
      {
        "id": "15",
        "value": "Hôtels de tourisme 2 étoiles, résidences de tourisme 2 étoiles, meublés de tourisme 2 étoiles, villages de vacances 4 et 5 étoiles"
      },
      {
        "id": "16",
        "value": "Hôtels de tourisme 1 étoile, résidences de tourisme 1 étoile, meublés de tourisme 1 étoile, villages de vacances 1,2 et 3 étoiles, chambres d'hôtes, emplacements dans des aires de camping-cars et des parcs de stationnement touristiques par tranche de 24 heures"
      },
      {
        "id": "17",
        "value": "Terrains de camping et terrains de caravanage classés en 3,4 et 5 étoiles"
      },
      {
        "id": "18",
        "value": "Terrains de camping et terrains de caravanage classés en 1 et 2 étoiles, ports de plaisance"
      },
      {
        "id": "19",
        "value": "Hébergements en attente de classement ou sans classement"
      }
    ],
    "nature_categories": [
      {
        "id": "1",
        "value": "Palace"
      },
      {
        "id": "2",
        "value": "Hôtel de tourisme"
      },
      {
        "id": "3",
        "value": "Résidence de tourisme"
      },
      {
        "id": "4",
        "value": "Meublé de tourisme"
      },
      {
        "id": "5",
        "value": "Village de vacances"
      },
      {
        "id": "6",
        "value": "Chambre d'hôtes"
      },
      {
        "id": "7",
        "value": "Emplacement dans des aires de camping-cars et des parcs de stationnement touristiques par tranche de 24 heures"
      },
      {
        "id": "8",
        "value": "Terrain de camping ou terrain de caravanage classé en 3,4 et 5 étoiles et tout autre terrain d’hébergement de plein air de caractéristiques équivalentes"
      },
      {
        "id": "9",
        "value": "Port de plaisance"
      }
    ]
  }
}

Success Response Body Elements

Status string

Indicates the overall status of the request. In this case, "Success" means the operation was completed successfully.

---

Message string

Provides a brief message about the outcome. Here, it states "Successfully fetch details," confirming that the requested information was retrieved.

---

Data string

This is the main body of the response and contains the data returned by the API, specifically related to the city tax categories and their nature-based classifications.

categories array

This array contains the different city tax categories with their corresponding IDs and descriptions. These categories are used to classify properties according to the type of city tax that applies to them.

Each object within the categories array contains:

id string

A unique identifier for each city tax category.

value string

The description or name of the category. It usually defines the type of property or accommodation type that the category applies to.

---

Ruid string

A unique identifier for tracking the request.

---

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 Required",
   "Ruid": "aaf7c18d-67b2-48ee-a9d5-8af526ed186c",
   "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

A unique identifier for tracking the request.