Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Taxes

Get actual taxes of unit type (parent unit level)

Get actual taxes of unit type (parent unit level)

get/taxes/unit-type/{id}/actual

Path parameters

idstring required
Example:df7hf01cnduhdb2125854dj8

The unit type id

Response

The taxes of the given unitTypeId according to its configuration level.

_idstring
unitTypeIdstring
accountIdstring required
type'LOCAL_TAX' | 'CITY_TAX' | 'VAT' | 'GOODS_AND_SERVICES_TAX' | 'TOURISM_TAX' | 'OTHER' | 'STATE_TAX' | 'COUNTY_TAX' | 'OCCUPANCY_TAX' | 'TRANSIENT_OCCUPANCY_TAX' | 'HOME_SHARING_TAX' | 'HARMONIZED_SALES_TAX' | 'MINIMUM_ALTERNATE_TAX' required
units'PERCENTAGE' | 'FIXED' required
quantifier'PER_NIGHT' | 'PER_GUEST' | 'PER_GUEST_PER_NIGHT' | 'PER_STAY' required
appliedOnFeesstring[] required
appliedByDefaultOnChannelsstring[] required
isDeletedboolean
amountnumber required
namestring
appliedToAllFeesboolean required
isAppliedByDefaultboolean required
isInclusiveboolean

Example response

[
  {
    "_id": "df7hf01cnduhdb2125854dj8",
    "unitTypeId": "623892d57f4f56afcb25587c",
    "accountId": "623892d57f4f56afcb25587c",
    "appliedOnFees": [
      "AF"
    ],
    "channelOverrides": [
      {
        "isAppliedByDefault": true,
        "appliedByDefaultOnChannels": [
          "manual"
        ]
      }
    ],
    "conditionalOverrides": {
      "rules": [
        {
          "dateRange": {
            "from": "12-31",
            "to": "02-01"
          }
        }
      ]
    }
  }
]