GUguesty
Taxes

Get unit type (parent unit) level taxes

Get unit type (parent unit) level taxes

get/taxes/unit-type/{id}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/taxes/unit-type/{id}
  • Auth
    API key in header authorization

Path parameters

idstring required
Example:df7hf01cnduhdb2125854dj8

The unit type id

Response

The unit type level taxes.

_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
  1. The tax type.
  2. Multiple taxes of the same type are allowed on the same account/listing level, each represented as a distinct tax entity, but they must have distinct names.
  3. All taxes sharing a type must agree on whether they are inclusive: an inclusive tax cannot be mixed with an exclusive tax of the same type.
  4. Multiple inclusive taxes can share a type only if each has non-overlapping 'appliedOnFees'; 'appliedToAllFees' cannot be 'true' when more than one tax shares the type.
units'PERCENTAGE' | 'FIXED' required
quantifier'PER_NIGHT' | 'PER_GUEST' | 'PER_GUEST_PER_NIGHT' | 'PER_STAY' required
appliedOnFeesstring[] required
appliedByDefaultOnChannelsstring[] required
isInclusiveboolean
  1. When 'true', the tax amount is included in the accommodation fare rather than added on top.
  2. Cannot be 'true' together with 'isAppliedByDefault', 'appliedByDefaultOnChannels', or 'conditionalOverrides'.
isDeletedboolean
amountnumber required
namestring
appliedToAllFeesboolean required
isAppliedByDefaultboolean required

Example response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.