Get Taxes for a Hotel

Read back tax configuration for a hotel, in the same shape as the write payload.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Get Taxes for a Hotel

POST /push/getTaxes

Returns the tax configuration for a hotel, in the same shape Taxes accepts so a response can be edited and posted straight back.

Try it (curl)

curl -sS -X POST "https://ari-dev.thehotelplanet.com/v1/push/getTaxes" \
  -H "x-api-key: YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"hotelId":"TEST001"}'

Request

FieldTypeDescription
hotelIdstringYour property code

Success response

{
  "code": "200",
  "hotelId": "HOTEL_001",
  "taxes": [
    {
      "type": "VAT",
      "valueType": "%",
      "value": 20,
      "appliedOn": "net",
      "appliedPer": "per_room_per_stay",
      "included": true,
      "payNow": true
    }
  ],
  "products": [
    {
      "roomId": "ROOM_001",
      "taxes": [
        {
          "type": "CITY_TAX",
          "valueType": "fixed",
          "value": 5,
          "appliedOn": "net",
          "appliedPer": "per_person_per_night",
          "included": false,
          "payNow": false
        }
      ]
    },
    {
      "rateId": "RATE_001",
      "taxes": [
        {
          "type": "GOV_TAX",
          "valueType": "fixed",
          "value": 3,
          "appliedOn": "net",
          "appliedPer": "per_room_per_stay",
          "included": false,
          "payNow": true
        }
      ]
    }
  ]
}

Each products entry carries only the IDs that are actually set a rate-scoped tax has no roomId.

Common errors

MessageCauseFix
hotelId is requiredMissing hotelIdInclude your property code
Hotel not foundUnknown hotelIdCheck the code, or send Hotels list first
Body Params
string
required

Supplier hotel ID

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json